Package: mtools
Version: 4.0.48-1
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 ' $' -e '\\~$' <file>" to find obvious 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>:13: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:30: 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.17-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 mtools depends on:
ii libc6 2.41-4
mtools recommends no packages.
Versions of packages mtools suggests:
pn floppyd <none>
-- no debconf information
Input file is lz.1
Output from "mandoc -T lint lz.1": (shortened list)
4 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-nroff -mandoc -t -ww -z lz.1": (shortened list)
1 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
4
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
27:.B tar -tzf
-.-.
Put a subordinate sentence (after a comma) on a new line.
lz.1:22:provides a listing of a gzip'd tar'd archive, that is a \fBtar\fR(1)
archive
lz.1:24:It is not strictly necessary on Debian GNU/Linux, because the GNU
-.-.
Space character after a macro call.
18:.B lz
39:.BR mtools (1),
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
38:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:13: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
troff:<stdin>:30: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- lz.1 2025-03-18 02:50:37.246533023 +0000
+++ lz.1.new 2025-03-18 02:57:56.883257142 +0000
@@ -9,13 +9,13 @@
.\" package
.\"
.\" Fri Dec 1 01:50:54 EST 2000 Robert A.R. King
(robert.k...@mailbox.gu.edu.au)
-.\"
+.\"
.TH LZ 1 "Wed Feb 23 00:00:00 EET 2000" "" "Mtools Users Manual"
.SH NAME
lz \- gunzips and shows a listing of a gzip'd tar'd archive
.SH SYNOPSIS
.\" The command line
-.B lz
+.B lz
.I file
.SH DESCRIPTION
.B lz
@@ -24,10 +24,10 @@ compressed with the \fBgzip\fR(1) utilit
It is not strictly necessary on Debian GNU/Linux, because the GNU
\fBtar\fR(1) program provides the same capability with the command
-.B tar -tzf
+.B tar \-tzf
.I file
-but this utility is provided in the mtools package for other platforms and
+but this utility is provided in the mtools package for other platforms and
is retained here for completeness.
.SH AUTHOR
@@ -35,8 +35,8 @@ Robert King (robert.k...@mailbox.gu.edu.
.I Debian/GNU
mtools package.
-.SH "SEE ALSO"
-.BR mtools (1),
+.SH SEE ALSO
+.BR mtools (1),
.BR gzip (1),
.BR tar (1),
.BR uz (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
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
"git" has a "tool" to point out whitespace,
see for example "git-apply(1)" and git-config(1)")
Not beginning each input sentence on a new line.
Line length and patch size should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
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 -d -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 from 'diff -d -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)
-.-
