Guy Harris <guy@xxxxxxxxxx> writes:
> On Mon, Mar 18, 2002 at 01:09:03PM -0500, Andrew C. Feren wrote:
> > Currently the .html version of the man pages are only build during the
> > winows build. I added targets to doc/Makefile.am to build them on
> > other platforms as well.
>
> If I try that, it gives me a bunch of noise about not being able to
> resolve references to other man pages.
>
> Is there some way to suppress that noise?
OK there are actually two flavors of noise.
The first flavor only occurs when running pod2html on ethereal.pod.
This noise looks like:
/usr/perl5/bin/pod2html: ethereal.pod: unknown pod directive 'item' in paragraph 134. ignoring.
/usr/perl5/bin/pod2html: ethereal.pod: unknown pod directive 'item' in paragraph 136. ignoring.
/usr/perl5/bin/pod2html: ethereal.pod: unknown pod directive 'item' in paragraph 141. ignoring.
/usr/perl5/bin/pod2html: ethereal.pod: unexpected =item directive in paragraph 144. ignoring.
This appears to be the result of either an incorrect use of =item.
I'm not really an expert in POD or pod2html so I am guessing a little
bit here. The attached patch is a swag at formatting this correctly.
The output looks reasonable to me, but you might want to verify that I
didn't miss the point.
Index: ethereal.pod.template
===================================================================
RCS file: /cvsroot/ethereal/doc/ethereal.pod.template,v
retrieving revision 1.273
diff -u -r1.273 ethereal.pod.template
--- ethereal.pod.template 2002/03/18 00:45:11 1.273
+++ ethereal.pod.template 2002/03/18 20:09:54
@@ -445,28 +445,21 @@
ENTER in the display filter text box, thereby invoking your old display
filter (or resetting it back to no display filter).
-The window in which the data stream is displayed lets you select whether
-to display:
+The window in which the data stream is displayed lets you:
=over 4
-=item
+=item *
-whether to display the entire conversation, or one or the other side of
+select whether to display the entire conversation, or one or the other side of
it;
-=item
+=item *
-whether the data being displayed is to be treated as ASCII or EBCDIC
+select whether the data being displayed is to be treated as ASCII or EBCDIC
text or as raw hex data;
-=back
-
-=back
-
-=over 4
-
-=item
+=item *
and lets you print what's currently being displayed, using the same
print options that are used for the I<File:Print Packet> menu item, or
The second flavor of noise is the one you noted earlier about not
being able to resolve references to man pages.
There seem to be several ways to supress this noise
Solution a)
use one or both of the following to find all the ethereal man pages
(html formated ethereal man pages really)
--podroot=name
--podpath=name:...:name
This will make pod2html be quieter, but you will still get errors for
pcap and tcpdump. You will also get links to where ever you said the
ethereal man pages were located.
Solution b)
Same as above, but try to point to pcap and tcpdump pages as well. It
isn't clear to me that this makes sense.
Solution c)
redirect the output to /dev/null. This doesn't really "solve"
anything, but it does eliminate the noise. ;-)
The document still formats fine. You just don't get any links to the
"See Also" pages.
Solution d)
To be filled in by someone who knows more about this than I do.
--
-Andrew Feren
Cetacean Networks, Inc.
Portsmouth, NH
