[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Problems in several man pages you maintain
From: |
esr |
Subject: |
Problems in several man pages you maintain |
Date: |
Tue, 12 Jun 2018 15:16:14 -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 preconv.1:
--- preconv.1-unpatched 2016-03-05 18:21:47.805225539 -0500
+++ preconv.1 2016-03-05 18:22:03.697188765 -0500
@@ -251,7 +251,7 @@
.RS
.PP
.EX
-\&.\[rs]" \-*\- mode: troff; coding: latin-2 \-*\-\""
+\&.\[rs]" \-*\- mode: troff; coding: latin-2 \-*\-
.EE
.RE
.
Problems with afmtodit.1:
Misspelled macro name.
--- afmtodit.1-unpatched 2016-02-19 06:55:36.565695067 -0500
+++ afmtodit.1 2016-02-19 06:55:52.437647964 -0500
@@ -239,7 +239,7 @@
rather than the default
.BR DESC .
.
-If not found in the current directory, the \[oq]devps\[qc]
+If not found in the current directory, the \[oq]devps\[cq]
subdirectory of the default font directory is searched (this is true
for both the default device description file and a file given with
option
Problems with gtbl.1:
.EX/.EE around tables is unnecessary and confuses doclifter.
--- gtbl.1-unpatched 2016-03-05 08:25:36.018977278 -0500
+++ gtbl.1 2016-03-05 08:26:12.986887432 -0500
@@ -179,13 +179,11 @@
.P
The result is
.RS
-.EX
.TS
c c c .
This is centered
Well, this also
.TE
-.EE
.RE
.
.
@@ -224,7 +222,6 @@
.
The result is
.RS
-.EX
.TS
tab(@);
c s s
@@ -233,7 +230,6 @@
address@hidden@123
address@hidden@75
.TE
-.EE
.RE
.
Here
Problems with grn.1:
Ambiguous or invalid backslash. This doesn't cause groff a problem.
but it confuses doclifter and may confuse older troff implementations.
--- grn.1-unpatched 2016-03-03 08:57:30.925162277 -0500
+++ grn.1 2016-03-03 08:57:48.341105793 -0500
@@ -751,7 +751,7 @@
For horizontal pictures, x-values range from 0 to 511 and y-values
range from 0 to 367.
.
-Although you needn\[aq]t absolutely stick to this range, you\[aq]\ll
+Although you needn\[aq]t absolutely stick to this range, you\[aq]ll
get best results if you at least stay in this vicinity.
.
Also, point lists are terminated by a point of (\-1, \-1), so you
Problems with gropdf.1:
--- gropdf.1-unpatched 2016-02-29 04:23:30.563698607 -0500
+++ gropdf.1 2016-02-29 04:23:48.999656326 -0500
@@ -994,7 +994,7 @@
Foo-Bar-Bold.pfa is \[oq]XY-Foo-Bar-Bold\[cq] (the PS font name is
stored in the
.B internalname
-field in the \[oq]FBB\[cq] file) and belongs to foundry \[oq]F\[]cq]
+field in the \[oq]FBB\[cq] file) and belongs to foundry \[oq]F\[cq]
thus the following line should be added to \[oq]download\[cq]:
.
.RS
Problems with tbl.1:
.EX/.EE around tables is unnecessary and confuses doclifter.
--- tbl.1-unpatched 2016-03-05 08:25:36.018977278 -0500
+++ tbl.1 2016-03-05 08:26:12.986887432 -0500
@@ -179,13 +179,11 @@
.P
The result is
.RS
-.EX
.TS
c c c .
This is centered
Well, this also
.TE
-.EE
.RE
.
.
@@ -224,7 +222,6 @@
.
The result is
.RS
-.EX
.TS
tab(@);
c s s
@@ -233,7 +230,6 @@
address@hidden@123
address@hidden@75
.TE
-.EE
.RE
.
Here
Problems with groff_char.7:
--- groff_char.7-unpatched 2016-02-29 04:41:04.637145153 -0500
+++ groff_char.7 2016-02-29 04:42:04.720991734 -0500
@@ -768,10 +768,10 @@
.nf
.RS
.ft C
-\&.\e" Make a pile centered vertically 0.5em\""
-\&.\e" above the baseline.\""
-\&.\e" The first argument is placed at the top.\""
-\&.\e" The pile is returned in string `pile'\""
+\&.\e" Make a pile centered vertically 0.5em
+\&.\e" above the baseline.
+\&.\e" The first argument is placed at the top.
+\&.\e" The pile is returned in string `pile'
\&.eo
\&.de pile-make
\&. nr pile-wd 0
@@ -782,16 +782,16 @@
\&. while \en[pile-#] \e{\e
\&. nr pile-wd (\en[pile-wd] >? \ew'\e$[\en[pile-#]]')
\&. nr pile-ht +(\en[rst] - \en[rsb])
-\&. as pile-args \ev'\en[rsb]u'\e"\""
-\&. as pile-args \eZ'\e$[\en[pile-#]]'\e"\""
-\&. as pile-args \ev'-\en[rst]u'\e"\""
+\&. as pile-args \ev'\en[rsb]u'\e"
+\&. as pile-args \eZ'\e$[\en[pile-#]]'\e"
+\&. as pile-args \ev'-\en[rst]u'\e"
\&. nr pile-# -1
\&. \e}
\&.
-\&. ds pile \ev'(-0.5m + (\en[pile-ht]u / 2u))'\e"\""
-\&. as pile \e*[pile-args]\e"\""
-\&. as pile \ev'((\en[pile-ht]u / 2u) + 0.5m)'\e"\""
-\&. as pile \eh'\en[pile-wd]u'\e"\""
+\&. ds pile \ev'(-0.5m + (\en[pile-ht]u / 2u))'\e"
+\&. as pile \e*[pile-args]\e"
+\&. as pile \ev'((\en[pile-ht]u / 2u) + 0.5m)'\e"
+\&. as pile \eh'\en[pile-wd]u'\e"
\&..
\&.ec
.ft
@@ -808,7 +808,7 @@
glyphs.
.
For this reason, the four glyphs \[oq]lf\[cq], \[oq]rf\[cq],
-\[o]lc\[cq], and \[oq]rc\[cq] are not unified with similarly looking
+\[oq]lc\[cq], and \[oq]rc\[cq] are not unified with similarly looking
bracket pieces.
.
In
Problems with groff_tmac.5:
--- groff_tmac.5-unpatched 2016-03-05 07:51:28.195728719 -0500
+++ groff_tmac.5 2016-03-05 07:51:37.183709371 -0500
@@ -35,7 +35,7 @@
.
.de au
This file was written by
-.ME address@hidden
+.MT address@hidden
Bernd Warken
.ME
and
Problems with eqn.1:
(Identical patches should apply to: geqn.1)
--- eqn.1-unpatched 2016-03-05 14:02:14.691951378 -0500
+++ eqn.1 2016-03-05 14:02:24.619936183 -0500
@@ -36,10 +36,6 @@
. el .TP "\\$1"
..
.
-.\" The BSD man macros can't handle " in arguments to font change macros,
-.\" so use \(ts instead of ".
-.tr \(ts"\""
-.
.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
@@ -313,8 +309,7 @@
.
.RS
.TP \w'punctuation'u+2n
-ordinary an ordinary character such as \[oq]1\[cq] or \[oq]\c
-.IR x \[cq];
+ordinary an ordinary character such as \[oq]1\[cq] or \[oq]\fIx\fP\[cq];
.
.TP
operator
@@ -341,7 +336,7 @@
.
.TP
punctuation
-a punctuation character such as \[oq],\[cl];
+a punctuation character such as \[oq],\[cq];
.
.TP
inner
@@ -468,7 +463,7 @@
about the math axis.
.
The math axis is the vertical position about which characters such as
-\[oq]\[pl]\[]cq and \[oq]\[mi]\[cq] are centered; also it is the
+\[oq]\[pl]\[cq] and \[oq]\[mi]\[cq] are centered; also it is the
vertical position used for the bar of fractions.
.
For example,
@@ -537,7 +532,7 @@
as a tilde accent below the baseline.
.
.TP
-.BI split\ \(ts text \(ts
+.BI split\ \[dq] text \[dq]
This has the same effect as simply
.
.RS
@@ -558,7 +553,7 @@
.
.RS
.IP
-.BI \(ts text \(ts
+.BI \[dq] text \[dq]
.RE
.
.IP
@@ -1154,9 +1149,9 @@
is not recognized if called with arguments.
.
.TP
-.BI include\ \(ts file \(ts
+.BI include\ \[dq] file \[dq]
.TQ
-.BI copy\ \(ts file \(ts
+.BI copy\ \[dq] file \[dq]
Include the contents of
.I file
.RB ( include
Problems with pdfroff.1:
Unknown or invalid macro. That is, one that does not fit in the
macro set that the man page seems to be using. This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.
--- pdfroff.1-unpatched 2016-02-28 18:54:52.506018728 -0500
+++ pdfroff.1 2016-02-28 18:55:23.809925096 -0500
@@ -618,7 +618,7 @@
searches the process
.BR PATH ,
looking for any of the preferred programs, \[oq]gawk\[cq],
-\[oq]mawk\[cq], \[oq]nawk\[cq], and \[ok]awk\[cq], in this order; if
+\[oq]mawk\[cq], \[oq]nawk\[cq], and \[oq]awk\[cq], in this order; if
none of these are found,
.B pdfroff
issues a warning message, and continue processing;
@@ -778,7 +778,7 @@
An intermediate
.I PostScript
file,
-in which \*[lq]Table of Contents\*[rq] entries are collected,
+in which \[lq]Table of Contents\[rq] entries are collected,
to facilitate relocation before the body text,
on ultimate output to the
.I GhostScript
Problems with groff_man.7:
--- groff_man.7-unpatched 2016-03-01 05:34:54.762635429 -0500
+++ groff_man.7 2016-03-01 05:36:26.718382055 -0500
@@ -1107,7 +1107,7 @@
.
.PP
.RS
-.BI '\e"\ word\""
+.BI '\e"\ word
.RE
.
.
Problems with roff.7:
--- roff.7-unpatched 2016-03-08 13:42:22.792967604 -0500
+++ roff.7 2016-03-08 13:42:37.404939862 -0500
@@ -1040,9 +1040,9 @@
.RS
.IP
.EX
-\&.\[rs]" Local Variables:\""
-\&.\[rs]" mode: nroff\""
-\&.\[rs]" End:\""
+\&.\[rs]" Local Variables:
+\&.\[rs]" mode: nroff
+\&.\[rs]" End:
.EE
.RE
.
Problems with refer.1:
--- refer.1-unpatched 2016-03-05 15:06:09.657029548 -0500
+++ refer.1 2016-03-05 15:06:52.112938813 -0500
@@ -43,11 +43,6 @@
. el .TP "\\$1"
..
.
-.\" The BSD man macros can't handle " in arguments to font change macros,
-.\" so use \(ts instead of ".
-.tr \(ts"\""
-.
-.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
.\" --------------------------------------------------------------------
@@ -807,29 +802,29 @@
Words are separated by spaces or tabs.
.
A word that begins with
-.B \(ts
+.B \[dq]
extends to the next
-.B \(ts
+.B \[dq]
that is not followed by another
-.BR \(ts .
+.BR \[dq] .
.
If there is no such
-.B \(ts
+.B \[dq]
the word extends to the end of the line.
.
Pairs of
-.B \(ts
+.B \[dq]
in a word beginning with
-.B \(ts
+.B \[dq]
collapse to a single
-.BR \(ts .
+.BR \[dq] .
.
Neither
.B #
nor
.B ;
are recognized inside
-.BR \(ts s.
+.BR \[dq] s.
.
A line can be continued by ending it with
.BR \e ;
Problems with gdiffmk.1:
Missing or garbled name section. The most common form of garbling
is a missing - or extra -. Or your manual page may have been generated
by a tool that doesn't emit a NAME section as it should. Or your page
may add running text such as a version or authorship banner. These
problems make it impossible to lift the page to DocBook. They
can also confuse third-party manpage browsers and some implementations
of man -k.
Misspelled macro name.
--- gdiffmk.1-unpatched 2016-03-05 12:56:11.794107909 -0500
+++ gdiffmk.1 2016-03-05 12:56:24.314072740 -0500
@@ -1,8 +1,7 @@
.\"-*- nroff -*-
.TH GDIFFMK 1 "04 November 2014" "Groff Version 1.22.3"
.SH NAME
-.
-.\" gdiffmk \- mark differences between groff/nroff/troff files
+gdiffmk \- mark differences between groff/nroff/troff files
.
.
.\" --------------------------------------------------------------------
@@ -33,7 +32,7 @@
This document was written and is maintained by
.MT address@hidden
Mike Bianchi
-.MT .
+.ME .
..
.
.\" --------------------------------------------------------------------
Problems with groffer.1:
--- groffer.1-unpatched 2016-03-05 08:40:45.796751105 -0500
+++ groffer.1 2016-03-05 08:42:36.844417781 -0500
@@ -238,7 +238,7 @@
.OP \-\-ps\-viewer prog
.OP \-\-tty\-viewer prog
.OP \-\-www\-viewer prog
-.OP \-\-x\-viewer\~\fR|\fB\~\-\-X\-viewer prog
+.OP \-\-x\-viewer\~\fR|\fB\~\-\-X\-viewer prog\fR
..
.
.
Problems with groff.1:
--- groff.1-unpatched 2016-03-05 14:48:31.663194970 -0500
+++ groff.1 2016-03-05 14:48:41.355176696 -0500
@@ -1866,7 +1866,7 @@
.
The actual version can be found at the
.
-.UR http://\:www.lunabase.org/\:\|\s+2~\s0faber/\:Vault/\:software/\:grap/
+.UR http://\:www.lunabase.org/\:\|~faber/\:Vault/\:software/\:grap/
grap website
.UE .
This is the only grap version supported by
Problems with grog.1:
--- grog.1-unpatched 2016-03-05 14:30:21.713178240 -0500
+++ grog.1 2016-03-05 14:32:09.956989371 -0500
@@ -52,12 +52,6 @@
.el .ds EL \&.\|.\|.\&\
.\" called with \*(EL
.
-.\" Bullet
-.ie t .ds BU \[bu]
-.el .ds BU *
-.\" used in `.IP \*(BU 2m' (former .Topic)
-.
-.
.\" --------------------------------------------------------------------
.SH SYNOPSIS
.\" --------------------------------------------------------------------
@@ -341,24 +335,19 @@
.SH EXAMPLES
.\" --------------------------------------------------------------------
.
-.IP \*(BU 2m
Calling
.RS
-.IP
.EX
grog meintro.me
.EE
.RE
-.IP
results in
.RS
.EX
-.IP
groff \-me meintro.me
.EE
.RE
.
-.IP
So
.B grog
recognized that the file
@@ -369,26 +358,21 @@
.RE
.
.
-.IP \*(BU 2m
On the other hand,
.RS
-.IP
.EX
grog pic.ms
.EE
.RE
.
-.IP
outputs
.
.RS
-.IP
.EX
groff \-p \-t \-e \-ms pic.ms
.EE
.RE
.
-.IP
Besides determining the macro package
.BR \-ms ,
.B grog
@@ -410,54 +394,44 @@
.RE
.
.
-.IP \*(BU 2m
If both of the former example files are combined by the command
.
.RS
-.IP
.EX
grog meintro.me pic.ms
.EE
.RE
.
-.IP
an error message is sent to standard error because
.B groff
cannot work with two different macro packages:
.
.RS
-.IP
.ft CR
grog: error: there are several macro packages: \-me \-ms
.ft
.RE
.
-.IP
Additionally the corresponding output with the wrong options is printed
to standard output:
.
.RS
-.IP
.EX
groff \-pte \-me \-ms meintro.me pic.ms
.EE
.RE
.
-.IP
But the program is terminated with an error code.
.
.
-.IP \*(BU 2m
The call of
.
.RS
-.IP
.EX
grog \-ksS \-Tdvi grnexmpl.g
.EE
.RE
.
-.IP
contains several
.B groff
options that are just passed on the output without any interface to
@@ -476,13 +450,11 @@
The output is
.
.RS
-.IP
.EX
groff \-k \-s \-S \-Tdvi grnexmpl.g
.EE
.RE
.
-.IP
so no additional option was added by
.BR grog .
As no option
- Problems in several man pages you maintain,
esr <=