Package: w3m
Version: 0.5.3+git20230121-2.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 ' $' <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>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:45: warning: trailing space in the line
troff:<stdin>:52: 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 w3m depends on:
ii libc6 2.40-5
ii libgc1 1:8.2.8-1
ii libgpm2 1.20.7-11+b2
ii libssl3t64 3.4.0-2
ii libtinfo6 6.5-2+b1
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
Versions of packages w3m recommends:
ii ca-certificates 20241223
Versions of packages w3m suggests:
pn brotli <none>
ii bzip2 1.0.8-6
pn cmigemo <none>
pn compface <none>
ii curl 8.11.1-1+b1
pn dict <none>
pn dict-wn <none>
pn dictd <none>
pn libsixel-bin <none>
ii mailcap 3.74
ii man-db 2.13.0-1
ii media-types 10.1.0
ii sensible-utils 0.0.24
pn w3m-el <none>
ii w3m-img 0.5.3+git20230121-2.1
ii wget 1.24.5-2+b1
ii xdg-utils 1.2.1-2
pn xsel <none>
-- no debconf information
Input file is w3mman.1
Output from "mandoc -T lint w3mman.1": (shortened list)
1 skipping paragraph macro: br at the end of SH
3 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z w3mman.1": (shortened list)
2 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
3
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
w3mman.1:78:for the Debian GNU/Linux system (but may be used by others).
-.-.
Use ".na" (no adjustment) instead of ".ad l" and then ".ad" to begin the
same adjustment again as before
7:.\" .ad l left justify
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:45: warning: trailing space in the line
troff:<stdin>:52: warning: trailing space in the line
--- w3mman.1 2025-01-25 03:52:00.021373924 +0000
+++ w3mman.1.new 2025-01-25 04:01:00.064405776 +0000
@@ -37,19 +37,18 @@ w3mman \- an interface to the on-line re
.br
.B w3mman
.BI \-l " file"
-.br
.SH DESCRIPTION
.\" mh 2016-07-04 text edited. This section shall deliver
-.\" more information than section NAME
+.\" more information than section NAME
.B w3mman
-is a Perl script that uses
+is a Perl script that uses
.BR w3m (1)
to serve as a pager for on-line reference manuals.
.SH OPTIONS
A summary of options is included below.
.TP
.BI \-M " path"
-Specify
+Specify
.I path
as alternative MANPATH to use.
.TP
@@ -75,4 +74,5 @@ manual page to HTML converter.
.BR w3m (1).
.SH AUTHOR
This manual page was written by Fumitoshi UKAI <u...@debian.or.jp>,
-for the Debian GNU/Linux system (but may be used by others).
+for the Debian GNU/Linux system
+(but may be used by others).
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 -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 -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)
-.-
