Package: libpaper-utils
Version: 2.2.5-0.3+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 ' $' -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>:18: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:41: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:56: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
* 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 libpaper-utils depends on:
ii libc6 2.40-7
ii libpaper2 2.2.5-0.3+b1
ii sensible-utils 0.0.24
libpaper-utils recommends no packages.
libpaper-utils suggests no packages.
-- no debconf information
Input file is paperconfig.8
Output from "mandoc -T lint paperconfig.8": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z paperconfig.8": (shortened list)
3 Use macro '.B' for one argument or split argument.
3 .BR is for at least 2 arguments, got 1
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
41:.BR "\-v\fP, \fB\-\-version"
46:.BR "\-h\fP, \fB\-\-help"
56:.BR "\-c\fP, \fB\-\-choose"
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
N.B.
The number of lines affected can be too large to be in a patch.
Lines with only one (or two) space(s) between sentences could be split,
so latter sentences begin on a new line.
Use
#!/usr/bin/sh
sed -e '/^\./n' \
-e 's/\([[:alpha:]]\)\. */\1.\n/g' $1
to split lines after a sentence period.
Check result with the difference between the formatted outputs.
See also the attachment "general.bugs"
27:be used by tools using the \fBpapersize\fR file. It can either ask
52:if possible. If
64:is used to run the scripts. Therefore their names must comply
-.-.
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 23, length 95
\fBpaperconfig\fR [\fB\-\-version\fR|\fB\-\-help\fR|\fB\-\-paper
\fIpapername\fR|\fB\-\-choose]
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
71:paper(1), runparts(8)
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:18: style: .TH missing fourth argument; consider
package/project name and version (e.g., "groff 1.23.0")
an.tmac:<stdin>:41: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:56: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- paperconfig.8 2025-02-24 22:54:59.282703439 +0000
+++ paperconfig.8.new 2025-02-24 23:38:36.416330759 +0000
@@ -20,13 +20,14 @@
.B paperconfig
\- configure the system default paper size
.SH SYNOPSIS
-\fBpaperconfig\fR [\fB\-\-version\fR|\fB\-\-help\fR|\fB\-\-paper
\fIpapername\fR|\fB\-\-choose]
+\fBpaperconfig\fR [\fB\-\-version\fR|\fB\-\-help\fR|\fB\-\-paper
+\fIpapername\fR|\fB\-\-choose]
.SH DESCRIPTION
.B paperconfig
queries the current paper size, and sets the system default paper to
-be used by tools using the \fBpapersize\fR file. It can either ask
-interactively for the paper to use or be called non-interactively by
-scripts.
+be used by tools using the \fBpapersize\fR file.
+It can either ask interactively for the paper to use
+or be called non-interactively by scripts.
.PP
When the paper size has been changed,
.B paperconfig
@@ -38,22 +39,23 @@ When no paper is specified, \fBpaperconf
current system paper size.
.SH OPTIONS
.TP
-.BR "\-v\fP, \fB\-\-version"
+.BR \-v ", " \-\-version
Print the version of
.B paperconfig
and exit.
.TP
-.BR "\-h\fP, \fB\-\-help"
+.BR \-h ", " \-\-help
Print help about usage and exit.
.TP
-.BI "\-p\fP, \fB\-\-paper" " papername"
+.BR \-p ", " \-\-paper " \fIpapername\fP"
Use
.I papername
-if possible. If
+if possible.
+If
.I papername
is not a valid paper, print an error message and exit.
.TP
-.BR "\-c\fP, \fB\-\-choose"
+.BR \-c ", " \-\-choose
Choose system paper interactively.
.SH FILES
.TP
@@ -61,11 +63,11 @@ Choose system paper interactively.
Directory of scripts to run after the paper size has been changed.
This package puts no scripts here, but other packages may.
.B run-parts
-is used to run the scripts. Therefore their names must comply
-with
+is used to run the scripts.
+Therefore their names must comply with
.BR run-part 's
naming requirements.
.SH AUTHOR
Yves Arrouye <arro...@debian.org>, Reuben Thomas <r...@sc3d.org>
.SH SEE ALSO
-paper(1), runparts(8)
+.BR paper "(1), " runparts (8)
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)
-.-
