Package: at
Version: 3.2.5-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 ' $' -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")
* 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 at depends on:
ii libc6 2.40-7
ii libpam-runtime 1.7.0-3
ii libpam0g 1.7.0-3
ii libselinux1 3.7-3.1
ii lsb-base 11.6
ii sysvinit-utils [lsb-base] 3.14-1
Versions of packages at recommends:
ii exim4-daemon-light [mail-transport-agent] 4.98-3+b1
at suggests no packages.
-- Configuration Files:
/etc/at.deny [Errno 13] Permission denied: '/etc/at.deny'
-- no debconf information
Input file is atd.8
Output from "mandoc -T lint atd.8": (shortened list)
1 skipping paragraph macro: PP empty
-.-.
Output from "test-groff -mandoc -t -ww -z atd.8": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 Use macro '.I' for one argument or split argument.
1 .BR is for at least 2 arguments, got 1
1 .IR is for at least 2 arguments, got 1
-.-.
Split a punctuation mark from a single argument for a two-font macro
26:.IR n\-1.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
atd.8:30:batch jobs (60 default).
-.-.
Section headings (.SH and .SS) do not need quoting.
70:.SH "SEE ALSO"
-.-.
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")
an.tmac:<stdin>:26: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:40: 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.
--- atd.8 2025-02-22 08:42:53.382657003 +0000
+++ atd.8.new 2025-02-22 08:57:10.629461820 +0000
@@ -14,7 +14,6 @@ atd \- run jobs queued for later executi
.B atd
runs jobs queued by
.BR at (1) .
-.PP
.SH OPTIONS
.TP 8
.B \-l
@@ -23,11 +22,12 @@ not be run, instead of the compile-time
For an SMP system with
.I n
CPUs, you will probably want to set this higher than
-.IR n\-1.
+.IR n\-1 .
.TP 8
.B \-b
Specify the minimum interval in seconds between the start of two
-batch jobs (60 default).
+batch jobs
+(60 default).
.TP 8
.B \-d
Debug; print error messages to standard error instead of using
@@ -37,7 +37,7 @@ This option also implies
.TP
.B \-f
Run
-.BR atd
+.B atd
in the foreground.
.TP 8
.B \-s
@@ -67,7 +67,7 @@ daemon.
determine who can use the
.B at
system.
-.SH "SEE ALSO"
+.SH SEE ALSO
.BR at (1),
.BR at.deny (5),
.BR at.allow (5),
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)
-.-
