Package: ncurses-bin
Version: 6.5-2+b1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' <file>" to find trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
an.tmac:<stdin>:154: style: 4 leading space(s) on input line
an.tmac:<stdin>:177: style: 4 leading space(s) on input line
troff:<stdin>:448: warning: trailing space in the line
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.9-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages ncurses-bin depends on:
ii libc6 2.40-5
ii libtinfo6 6.5-2+b1
ncurses-bin recommends no packages.
ncurses-bin suggests no packages.
-- no debconf information
Input file is tset.1
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Lines should thus be shorter.
See man-pages(7), item 'semantic newline'.
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - "
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output of 'diff -u' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -b -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint tset.1": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z tset.1": (shortened list)
1 trailing space in the line
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 56, length 151
\fBtset\fP [\fB\-IQVcqrsw\fP] [\fB\-\fP] [\fB\-e\fP \fIch\fP] [\fB\-i\fP
\fIch\fP] [\fB\-k\fP \fIch\fP] [\fB\-m\fP \fImapping\fP] [\fIterminal-type\fP]
Line 58, length 152
\fBreset\fP [\fB\-IQVcqrsw\fP] [\fB\-\fP] [\fB\-e\fP \fIch\fP] [\fB\-i\fP
\fIch\fP] [\fB\-k\fP \fIch\fP] [\fB\-m\fP \fImapping\fP] [\fIterminal-type\fP]
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
tset.1:86:3. (BSD systems only.) The terminal type associated with the standard
tset.1:127:and \fBtset\fP waits one second (in case a hardware reset was
issued).
tset.1:197:string (delimited by either the operator or the colon character).
tset.1:208:of the standard error output (which should be the control terminal).
tset.1:315:system port name to terminal type mapping database (BSD versions
only).
tset.1:324:The AT&T \fBtput\fP utility (AIX, HP-UX, Solaris)
tset.1:353:\*(``TSET\*('' (or via any other name beginning with an upper-case
letter)
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:154: style: 4 leading space(s) on input line
an.tmac:<stdin>:177: style: 4 leading space(s) on input line
troff:<stdin>:448: warning: trailing space in the line
-.-
Additionally:
No trailing space (at any stage of writing).
No trailing space (at any stage of processing).
Thus remove space in front of '\"' (if not to make the space a permanent
part of the last argument).
--- tset.1 2025-01-19 03:15:58.411565085 +0000
+++ tset.1.new 2025-01-19 03:30:04.144421009 +0000
@@ -445,7 +445,7 @@ to use logic copied from the 3BSD \*(``r
invoked as \fB\%reset\fP.
.\" https://minnie.tuhs.org/cgi-bin/utree.pl?file=2.9BSD/usr/src/ucb/\
.\" tset/tset.c
-This version appeared in 4.1cBSD, \" and backported to 2.9BSD
+This version appeared in 4.1cBSD,\" and backported to 2.9BSD
late in 1982.
Other developers such as Keith Bostic and Jim Bloom continued to modify
\fBtset\fP until 4.4BSD was released in 1993.
