Ethereal-dev: Re: [Ethereal-dev] ethereal man page

Note: This archive is from the project's previous web site, ethereal.com. This list is no longer active.

Date Index Thread Index Other Months All Mailing Lists
Date Prev Date Next Thread Prev Thread Next
From: Guy Harris <gharris@xxxxxxxxx>
Date: Tue, 25 May 2004 10:47:59 -0700
On Tue, May 25, 2004 at 08:57:58AM -0400, Carlos Pignataro wrote:
> There's 2 small issues with ethereal man page:
> 
> 1. Since now ethereal.1 is made from pod2man $(srcdir)/ethereal-tmp.pod, the man title
>    now displays "ETHEREAL-TMP 1" instead of "ETHEREAL 1":
> 
> man ethereal | head
> ETHEREAL-TMP(1)          The Ethereal Network Analyzer         ETHEREAL-TMP(1)

We might want to rename "ethereal.pod" back to to "ethereal.pod.in" and
generate "ethereal.pod" from it and from AUTHORS-SHORT.

> 2. Since make-authors-short.pl is making AUTHORS-SHORT with all lines starting without
>    space or tab, pod is treating the paragraphs as `Ordinary Paragraph' instead of 
>    `Verbatim Paragraph' [check man perlpod] and misaligning:

	...

> The following patch fixes #2 by prepending a space into all non empty lines.

Unfortunately, that appears to cause *all* the stuff from the AUTHORS
file to be turned into verbatim text, including the paragraphs after the
list of authors.

It also means that every line in AUTHORS-SHORT begins with a space; that
causes a space before every line in the "Authors" page of the "About"
dialog if Ethereal is built with GTK+ 1.3[.x] or 2.x.  That might be OK,
but....