[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

problems in one or more man pages you maintain

From: esr
Subject: problems in one or more man pages you maintain
Date: Fri, 16 Jul 2004 20:15:49 -0400

This is automatically generated email about problems in a man page for which
you appear to be responsible.  If you are not the right person or list, tell
me and I will attempt to correct my database.

See http://catb.org/~esr/doclifter/problems.html for details on how and
why these patches were generated.  Feel free to email me with any questions.

Note: This patch does not change the mod date of the manual page.  You
may wish to do that by hand.

Problems with ptx.1:

1. Parenthesized comments in command synopsis.  This is impossible
to translate to DocBook.

--- ptx.1       2003-02-16 16:40:22.000000000 -0500
+++ ptx.1       2003-02-16 16:40:53.000000000 -0500
@@ -4,7 +4,7 @@
 ptx \- produce a permuted index of file contents
 .B ptx
-[\fIOPTION\fR]... [\fIINPUT\fR]...   \fI(without -G)\fR
+[\fIOPTION\fR]... [\fIINPUT\fR]...
 .B ptx
 \fI-G \fR[\fIOPTION\fR]... [\fIINPUT \fR[\fIOUTPUT\fR]]
Problems with tar.1:

1. Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but it's impossible
to translate into DocBook markup).

--- tar.1       2003-02-16 18:17:59.000000000 -0500
+++ tar.1       2003-02-16 18:26:19.000000000 -0500
@@ -143,12 +143,9 @@
 .B --block-compress
-.B -[0-7][lmh] 
 .I filename1 [ filename2, ... filenameN ] 
 .I directory1 [ directory2, ...directoryN ]
@@ -334,3 +331,6 @@
 .B --use-compress-program PROG
 filter the archive through PROG (which must accept -d)
+The option -[0-7][lmh] does what it did under Version 7 Unix.  If you
+don't already know what this was, please use the -f option instead.
Problems with uuencode.1:

1. There are multiple name lines.  This makes it impossible to translate
the page to DocBook.  It may also confuse some implementations
of man -k.

--- uuencode.1  2003-02-16 13:49:29.000000000 -0500
+++ uuencode.1  2003-02-16 13:50:17.000000000 -0500
@@ -34,9 +34,7 @@
 .TH uuencode 1
-uuencode \- encode a binary file
-uudecode \- decode a file created by uuencode
+uuencode, uudecode \- encode and decode binary files
 .B uuencode
 [\-m] [ file ] name

                             Eric S. Raymond

reply via email to

[Prev in Thread] Current Thread [Next in Thread]