Package: dictionaries-common
Version: 1.30.1
Severity: minor
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -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?
troff: backtrace: '<stdin>':11: macro 'Vb'
troff: backtrace: file '<stdin>':67
troff:<stdin>:67: warning: font name 'CW' is deprecated
* 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.11.7-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 dictionaries-common depends on:
ii debconf [debconf-2.0] 1.5.87
ii emacsen-common 3.0.5
ii libtext-iconv-perl 1.7-8+b4
dictionaries-common recommends no packages.
Versions of packages dictionaries-common suggests:
ii aspell 0.60.8.1-1+b2
ii hunspell 1.7.2+really1.7.2-10+b3
ii ispell 3.4.06-1
ii miscfiles [wordlist] 1.5+dfsg-5
ii wamerican [wordlist] 2020.12.07-3
ii wbritish [wordlist] 2020.12.07-3
ii wngerman [wordlist] 20161207-14
-- debconf information excluded
Input file is update-default-ispell.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
-.-
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 update-default-ispell.8 ": (shortened list)
1 input text line longer than 80 bytes
-.-.
Output from "test-groff -mandoc -t -ww -b -z update-default-ispell.8 ":
(shortened list)
1 font name 'CW' is deprecated
-.-.
Output from "mandoc -T lint update-default-ispell.8 ":
mandoc: update-default-ispell.8:72:91: STYLE: input text line longer than 80
bytes: WARNING: Not to be u...
-.-.
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.
Line 72, length 91
WARNING: Not to be used from the command line unless you know very well what
you are doing.
Line 103, length 83
\& \-\-skip\-symlinks Do not try to set symlinks at /etc/dictionaries\-common
dir.
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
7:.if t .sp .5v
-.-.
No space is needed before a quote (") at the end of a line
58:.TH UPDATE-DEFAULT-ISPELL 8 2024-10-14 1.30.1 " "
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: '<stdin>':11: macro 'Vb'
troff: backtrace: file '<stdin>':67
troff:<stdin>:67: warning: font name 'CW' is deprecated
