Package: mailcap
Version: 3.74
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>:17: style: 4 leading space(s) on input line
an.tmac:<stdin>:18: style: 4 leading space(s) on input line
an.tmac:<stdin>:19: style: 4 leading space(s) on input line
an.tmac:<stdin>:20: style: 4 leading space(s) on input line
an.tmac:<stdin>:21: style: 4 leading space(s) on input line
troff:<stdin>:26: warning: trailing space in the line
an.tmac:<stdin>:74: style: 2 leading space(s) on input 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.12-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 mailcap depends on:
ii media-types 10.1.0
ii perl 5.40.0-8
Versions of packages mailcap recommends:
ii bzip2 1.0.8-6
ii file 1:5.45-3+b1
ii xz-utils 5.6.3-1+b1
mailcap suggests no packages.
-- no debconf information
Input file is mailcap.order.5
Output from "mandoc -T lint mailcap.order.5": (shortened list)
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z mailcap.order.5": (shortened list)
1 trailing space in the line
-.-.
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
1
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
92:.BR mailcap "(5)"
93:.BR run-mailcap "(1)"
94:.BR update-mime "(8)"
-.-.
Section headings (.SH and .SS) do not need quoting.
91:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:17: style: 4 leading space(s) on input line
an.tmac:<stdin>:18: style: 4 leading space(s) on input line
an.tmac:<stdin>:19: style: 4 leading space(s) on input line
an.tmac:<stdin>:20: style: 4 leading space(s) on input line
an.tmac:<stdin>:21: style: 4 leading space(s) on input line
troff:<stdin>:26: warning: trailing space in the line
an.tmac:<stdin>:74: style: 2 leading space(s) on input line
--- mailcap.order.5 2025-02-13 10:04:18.287501181 +0000
+++ mailcap.order.5.new 2025-02-13 10:10:40.017845275 +0000
@@ -23,7 +23,7 @@ file. Entries that don't match will be
The above would make any entries provided by the
.B mime-support
package
-(as found in the
+(as found in the
.I /usr/lib/mime/packages
directory) take priority over everything else. The
.B gv
@@ -88,10 +88,10 @@ rule comes
the emacs
.I edit
rule.
-.SH "SEE ALSO"
-.BR mailcap "(5)"
-.BR run-mailcap "(1)"
-.BR update-mime "(8)"
+.SH SEE ALSO
+.BR mailcap (5),
+.BR run-mailcap (1),
+.BR update-mime (8).
.SH AUTHOR
The
.B mailcap.order
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.
Not beginning each input sentence on a new line.
Line length 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)
-.-
