Subject: Problems in chroot.2, ln.1, ptx.1, test.1, [.1

From: [email-masked]
Date: Tue, 18 Jun 2013 01:14:03 -0400 (EDT)

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

See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated.  Feel free to email me with any
questions.  Note: These patches do not change the modification date of
any manual page.  You may wish to do that by hand.

I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.

--
                             Eric S. Raymond
Problems with ln.1:

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

--- ln.1-unpatched	2012-06-28 19:08:11.104797083 -0400
+++ ln.1	2012-06-28 19:08:38.520796573 -0400
@@ -4,16 +4,16 @@
 ln \- make links between files
 .SH SYNOPSIS
 .B ln
-[\fIOPTION\fR]... [\fI-T\fR] \fITARGET LINK_NAME   (1st form)\fR
+[\fIOPTION\fR]... [\fI-T\fR] \fITARGET LINK_NAME
 .br
 .B ln
-[\fIOPTION\fR]... \fITARGET                  (2nd form)\fR
+[\fIOPTION\fR]... \fITARGET
 .br
 .B ln
-[\fIOPTION\fR]... \fITARGET\fR... \fIDIRECTORY     (3rd form)\fR
+[\fIOPTION\fR]... \fITARGET\fR... \fIDIRECTORY
 .br
 .B ln
-[\fIOPTION\fR]... \fI-t DIRECTORY TARGET\fR...  \fI(4th form)\fR
+[\fIOPTION\fR]... \fI-t DIRECTORY TARGET\fR...
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP
Problems with chroot.2:

My translator trips over a useless command in list markup.

List syntax error. This means .IP, .TP or .RS/.RE markup is garbled.
Common causes include .TP just before a section header, .TP entries
with tags but no bodies, and mandoc lists with no trailing .El.
These confuse doclifter, and may also mess up stricter man-page
browsers like Xman and Rosetta.

--- chroot.2-unpatched	2012-06-30 16:40:34.828017118 -0400
+++ chroot.2	2012-06-30 16:41:39.536015957 -0400
@@ -46,15 +46,12 @@
 .BR chroot ():
 .ad l
 .RS 4
-.PD 0
-.TP 4
 Since glibc 2.2.2:
 .nf
 _BSD_SOURCE ||
     (_XOPEN_SOURCE\ >=\ 500 ||
         _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED) &&
     !(_POSIX_C_SOURCE\ >=\ 200112L || _XOPEN_SOURCE\ >=\ 600)
-.TP 4
 .fi
 Before glibc 2.2.2: none
 .PD
Problems with ptx.1:

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

--- ptx.1-unpatched	2010-07-22 16:30:37.000000000 -0400
+++ ptx.1	2010-07-22 16:31:32.000000000 -0400
@@ -4,7 +4,7 @@
 ptx \- produce a permuted index of file contents
 .SH SYNOPSIS
 .B ptx
-[\fIOPTION\fR]... [\fIINPUT\fR]...   \fI(without -G)\fR
+[\fIOPTION\fR]... [\fIINPUT\fR]...
 .br
 .B ptx
 \fI-G \fR[\fIOPTION\fR]... [\fIINPUT \fR[\fIOUTPUT\fR]]
Problems with test.1:

(Identical patches should apply to: [.1)

--- test.1-unpatched	2012-06-30 11:52:03.264340869 -0400
+++ test.1	2012-06-30 11:53:49.460338879 -0400
@@ -7,16 +7,13 @@
 \fIEXPRESSION\fR
 .br
 .B test
-
-.br
-.B [
-\fIEXPRESSION \fR]
-.br
-.B [
+[
+--help
+] [
+--version
+] [
+\fIEXPRESSION
 ]
-.br
-.B [
-\fIOPTION\fR
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP