Package: sensible-utils
Version: 0.0.24
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 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>:6: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:7: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' 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.6-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)
-- no debconf information
Input file is sensible-pager.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
-.-
So any 'generator' should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
This is just a simple quality control measure.
The 'generator' may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Input text line longer than 80 bytes.
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.
Lines should thus be shorter.
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 of '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)
-.-.
Output from "mandoc -T lint sensible-pager.1": (shortened list)
-.-.
Output from "test-groff -mandoc -t -ww -z sensible-pager.1": (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 .RI 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.
6:.BR sensible-pager
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
sensible-pager.1:23:/usr/share/doc/debian-policy (you might need to install
debian-policy)
-.-.
Put a subordinate sentence (after a comma) on a new line.
12:as their default pager, or emulate their behavior.
-.-.
Remove quotes when there is no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
2:.TH SENSIBLE-PAGER 1 "12 Jan 2020" "Debian"
18:.SH "STANDARD"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:6: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:7: misuse, warning: .RI is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
--- sensible-pager.1 2025-01-08 14:25:14.096586990 +0000
+++ sensible-pager.1.new 2025-01-08 14:29:27.417073785 +0000
@@ -1,23 +1,25 @@
.\" -*- nroff -*-
-.TH SENSIBLE-PAGER 1 "12 Jan 2020" "Debian"
+.TH SENSIBLE-PAGER 1 "12 Jan 2020" Debian
.SH NAME
sensible-pager \- sensible paging
.SH SYNOPSIS
-.BR sensible-pager
-.RI [OPTIONS...]
+.B sensible-pager
+.RI [ OPTIONS ...]
.SH DESCRIPTION
.B sensible-pager
makes sensible decisions on which pager to call.
Programs in Debian can use this script
-as their default pager, or emulate their behavior.
+as their default pager,
+or emulate their behavior.
.SH "SEE ALSO"
Documentation of the
.B PAGER
variable in
.BR environ (7)
-.SH "STANDARD"
+.SH STANDARD
Documentation of behavior of
.B sensible-utils
under a debian system is available under
section 11.4 of debian-policy usually installed under
-/usr/share/doc/debian-policy (you might need to install debian-policy)
+/usr/share/doc/debian-policy
+(you might need to install debian-policy)
