Ethereal-dev: [Ethereal-dev] Patch for making ethereal documentation

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

From: Graeme Hewson <ghewson@xxxxxxxxxxxxxxxxxxx>
Date: Sun, 08 Aug 2004 21:02:30 +0100
The list of authors in the ethereal man page and html file is wrapped. The attached patches correct that, and also correct the title in the man page. (I changed [\s\r] to [\s] in the perl script since \s includes \r.)

This also requires the 0xefbbbf string at the top of AUTHORS to be removed. I don't know why it's there, but if it remains there, for some reason pod2man and pod2html continue to wrap instead of treating the text as verbatim paragraphs.

A couple of minor points. Some of the text in the notes at the end goes past column 80 in the man page since it's shifted to start in column 8. Some of the email addresses aren't aligned properly. I also note that accented characters are mangled by nroff, though I don't suppose there's much we can do about that.


Graeme
--- make-authors-short.pl.orig	Sun Aug  1 07:52:37 2004
+++ make-authors-short.pl	Sun Aug  8 18:08:28 2004
@@ -16,12 +16,13 @@
 		print "$1\n";
 	} elsif (/}/) {
 		$subinfo = 0;
-		if (($nextline = <>) !~ /^[\s\r]*$/) {
+		if (($nextline = <>) !~ /^[\s]*$/) {
 			print $nextline;
 		}
 	} elsif ($subinfo == 1) {
 		next;
 	} else {
+		s/^$/ /;	# Make it a verbatim paragraph
 		print;
 	}
 }
--- Makefile.am.orig	Thu Jul 29 16:16:08 2004
+++ Makefile.am	Sun Aug  8 20:08:35 2004
@@ -31,7 +31,7 @@
 	$(POD2MAN)                     \
 	--center="The Ethereal Network Analyzer" \
 	--release=$(VERSION)			 \
-	ethereal-tmp.pod > ../ethereal.1
+	ethereal-tmp.pod | sed 's/ETHEREAL-TMP/ETHEREAL/' > ../ethereal.1
 
 ../ethereal.html: ethereal-tmp.pod ../config.h
 	$(POD2HTML)                    \