Package: texlive-base
Version: 2024.20241115-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?
troff:<stdin>:13: 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.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 texlive-base depends on:
ii debconf [debconf-2.0] 1.5.89
ii libpaper-utils 2.2.5-0.3
ii sensible-utils 0.0.24
ii tex-common 6.18
ii texlive-binaries 2024.20240313.70630+ds-5+b1
ii ucf 3.0049
ii xdg-utils 1.2.1-2
Versions of packages texlive-base recommends:
ii lmodern 2.005-1
Versions of packages texlive-base suggests:
ii ghostscript [postscript-viewer] 10.04.0~dfsg-2+b1
ii gv [postscript-viewer] 1:3.7.4-2+b2
ii mupdf [pdf-viewer] 1.24.10+ds1-1
pn perl-tk <none>
ii xpdf [pdf-viewer] 3.04+git20250103-1+b1
pn xzdec <none>
Versions of packages tex-common depends on:
ii ucf 3.0049
Versions of packages tex-common suggests:
pn debhelper <none>
Versions of packages texlive-base is related to:
ii tex-common 6.18
ii texlive-binaries 2024.20240313.70630+ds-5+b1
-- debconf information excluded
Input file is fmtutil.cnf.5
Output from "mandoc -T lint fmtutil.cnf.5": (shortened list)
1 input text line longer than 80 bytes: is used by that form...
5 skipping paragraph macro: PP after SH
8 skipping paragraph macro: PP empty
31 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z fmtutil.cnf.5": (shortened list)
1 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
20
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
" \(em " creates a too big gap in the text (in "troff").
An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".
fmtutil.cnf.5:20:\fI--showhyphen\fP and \fI--byhyphen\fP\&.
-.-.
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.
28:for these formats\&. Therefore, the pattern-file field for the
33:\fIplain\&.tex\fP (b for the \fIBabel\fP system). See, for example,
40:are generated by the \fBtexlinks\fP(8) script\&. Remember to run
70:This manual page was written by C\&.M\&. Connelly for the Debian
71:GNU/Linux system\&. It is now maintained as part of TeX Live.
-.-.
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 11, length 82
is used by that format (e\&.g\&., ``tex\'\', ``etex\'\', ``omega\'\'), the
pattern
-.-.
Do not use more than two space characters between sentences or (better)
only a new line character.
40:are generated by the \fBtexlinks\fP(8) script\&. Remember to run
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
fmtutil.cnf.5:11:is used by that format (e\&.g\&., ``tex\'\', ``etex\'\',
``omega\'\'), the pattern
fmtutil.cnf.5:12:file (e\&.g\&., \fIlanguage\&.dat\fP, \fIlanguage\&.def\fP),
and any
fmtutil.cnf.5:13:arguments (name of an \fI\&.ini\fP file)\&.
fmtutil.cnf.5:18:It tells \fBfmtutil\fP which files (separated by commas) the
fmtutil.cnf.5:33:\fIplain\&.tex\fP (b for the \fIBabel\fP system). See, for
example,
fmtutil.cnf.5:39:Symbolic links to the correct engines (e\&.g\&., bplain -> tex)
fmtutil.cnf.5:64:Email bug reports to <https://lists.tug.org/tex-k> (public
mailing list).
-.-.
No need for "\&" to be in front of a period (.),
if there is a character in front of it
1:.TH "fmtutil\&.cnf" "5" "8 March 2022" "TeX Live"
4:fmtutil\&.cnf \- configuration file for fmtutil
8:The \fIfmtutil\&.cnf\fP file contains the configuration information
9:for \fBfmtutil\fP(8)\&. Each line contains the name of the format
10:(e\&.g\&., ``tex\'\', ``latex\'\', ``omega\'\'), the name of the engine that
11:is used by that format (e\&.g\&., ``tex\'\', ``etex\'\', ``omega\'\'), the
pattern
12:file (e\&.g\&., \fIlanguage\&.dat\fP, \fIlanguage\&.def\fP), and any
13:arguments (name of an \fI\&.ini\fP file)\&.
16:out with ``#\'\'\&. The ``pattern file\'\' field cannot be used to
17:define a file that is used while building the format\&.
20:\fI--showhyphen\fP and \fI--byhyphen\fP\&.
22:customize hyphenation, a ``-\'\' can be used to indicate this\&.
27:\fIhyphen\&.tex\fP\&. No customization by a pattern file is available
28:for these formats\&. Therefore, the pattern-file field for the
29:\fBtex\fP and \fBamstex\fP is usually indicated to be empty (``-\'\')\&.
32:\fBtex\fP(1) or \fBamstex\fP(1) by using \fIbplain\&.tex\fP instead of
33:\fIplain\&.tex\fP (b for the \fIBabel\fP system). See, for example,
34:the \fIbplain\&.ini\fP file for the bplain format)\&.
36:\fBetex\fP(1) loads \fIlanguage\&.def\fP, not
37:\fIlanguage\&.dat\fP\&.
39:Symbolic links to the correct engines (e\&.g\&., bplain -> tex)
40:are generated by the \fBtexlinks\fP(8) script\&. Remember to run
42:than using the FORMATS option in \fBtexconfig\fP(8)\&.
46:.IP "\fIfmtutil\&.cnf\fP"
48:.IP "\fIlanguage\&.dat\fP"
50:.IP "\fIlanguage\&.def\fP"
52:.IP "\fIlanguage\&.dat.lua\fP"
58:\fBtex\fP(1), \fBtexconfig\fP(8), \fBtexlinks\fP(8)\&.
68:\fBfmtutil\fP and \fIfmtutil\&.cnf\fP was originally written by Thomas Esser.
70:This manual page was written by C\&.M\&. Connelly for the Debian
71:GNU/Linux system\&. It is now maintained as part of TeX Live.
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
1:.TH "fmtutil\&.cnf" "5" "8 March 2022" "TeX Live"
3:.SH "NAME"
6:.SH "DESCRIPTION"
24:.SH "NOTES"
44:.SH "FILES"
46:.IP "\fIfmtutil\&.cnf\fP"
48:.IP "\fIlanguage\&.dat\fP"
50:.IP "\fIlanguage\&.def\fP"
52:.IP "\fIlanguage\&.dat.lua\fP"
62:.SH "BUGS"
66:.SH "AUTHOR"
-.-.
Space character after a macro call.
2:.PP
5:.PP
7:.PP
14:.PP
23:.PP
25:.PP
30:.PP
35:.PP
38:.PP
43:.PP
45:.PP
54:.PP
56:.PP
59:.PP
61:.PP
63:.PP
65:.PP
67:.PP
69:.PP
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:13: warning: trailing space in the line
--- fmtutil.cnf.5 2025-02-10 03:35:51.185933436 +0000
+++ fmtutil.cnf.5.new 2025-02-10 04:04:21.108579007 +0000
@@ -1,71 +1,70 @@
-.TH "fmtutil\&.cnf" "5" "8 March 2022" "TeX Live"
-.PP
-.SH "NAME"
-fmtutil\&.cnf \- configuration file for fmtutil
-.PP
-.SH "DESCRIPTION"
-.PP
-The \fIfmtutil\&.cnf\fP file contains the configuration information
-for \fBfmtutil\fP(8)\&. Each line contains the name of the format
-(e\&.g\&., ``tex\'\', ``latex\'\', ``omega\'\'), the name of the engine that
-is used by that format (e\&.g\&., ``tex\'\', ``etex\'\', ``omega\'\'), the
pattern
-file (e\&.g\&., \fIlanguage\&.dat\fP, \fIlanguage\&.def\fP), and any
-arguments (name of an \fI\&.ini\fP file)\&.
-.PP
+.TH fmtutil.cnf 5 "8 March 2022" "TeX Live"
+.SH NAME
+fmtutil.cnf \- configuration file for fmtutil
+.SH DESCRIPTION
+The \fIfmtutil.cnf\fP file contains the configuration information
+for \fBfmtutil\fP(8). Each line contains the name of the format
+(e.g., ``tex\'\', ``latex\'\', ``omega\'\'), the name of the engine that
+is used by that format
+(e.g., ``tex\'\', ``etex\'\', ``omega\'\'),
+the pattern file
+(e.g., \fIlanguage.dat\fP, \fIlanguage.def\fP),
+and any arguments
+(name of an \fI.ini\fP file).
+.PP
Fields are separated by whitespace\& and complete lines can be commented
-out with ``#\'\'\&. The ``pattern file\'\' field cannot be used to
-define a file that is used while building the format\&.
-It tells \fBfmtutil\fP which files (separated by commas) the
-format creation procedure reads\& and it has an effect to the options
-\fI--showhyphen\fP and \fI--byhyphen\fP\&.
+out with ``#\'\'. The ``pattern file\'\' field cannot be used to
+define a file that is used while building the format.
+It tells \fBfmtutil\fP which files
+(separated by commas)
+the format creation procedure reads
+and it has an effect to the options
+\fI\-\-showhyphen\fP and \fI\-\-byhyphen\fP.
If the format has no way to
-customize hyphenation, a ``-\'\' can be used to indicate this\&.
-.PP
-.SH "NOTES"
-.PP
+customize hyphenation, a ``\-\'\' can be used to indicate this.
+.SH NOTES
The \fBtex\fP(1) and \fBamstex\fP(1) formats always load
-\fIhyphen\&.tex\fP\&. No customization by a pattern file is available
-for these formats\&. Therefore, the pattern-file field for the
-\fBtex\fP and \fBamstex\fP is usually indicated to be empty (``-\'\')\&.
-.PP
+\fIhyphen.tex\fP. No customization by a pattern file is available
+for these formats.
+Therefore, the pattern-file field for the
+\fBtex\fP and \fBamstex\fP is usually indicated to be empty (``\-\'\').
+.PP
You can, however, build customized formats on top of plain
-\fBtex\fP(1) or \fBamstex\fP(1) by using \fIbplain\&.tex\fP instead of
-\fIplain\&.tex\fP (b for the \fIBabel\fP system). See, for example,
-the \fIbplain\&.ini\fP file for the bplain format)\&.
-.PP
-\fBetex\fP(1) loads \fIlanguage\&.def\fP, not
-\fIlanguage\&.dat\fP\&.
-.PP
-Symbolic links to the correct engines (e\&.g\&., bplain -> tex)
-are generated by the \fBtexlinks\fP(8) script\&. Remember to run
+\fBtex\fP(1) or \fBamstex\fP(1) by using \fIbplain.tex\fP instead of
+\fIplain.tex\fP
+(b for the \fIBabel\fP system).
+See, for example,
+the \fIbplain.ini\fP file for the bplain format).
+.PP
+\fBetex\fP(1) loads \fIlanguage.def\fP, not
+\fIlanguage.dat\fP.
+.PP
+Symbolic links to the correct engines
+(e.g., bplain \(-> tex)
+are generated by the \fBtexlinks\fP(8) script.
+Remember to run
\fBtexlinks\fP(8) if you run \fBfmtutil\fP(8) yourself, rather
-than using the FORMATS option in \fBtexconfig\fP(8)\&.
-.PP
-.SH "FILES"
-.PP
-.IP "\fIfmtutil\&.cnf\fP"
+than using the FORMATS option in \fBtexconfig\fP(8).
+.SH FILES
+.IP \fIfmtutil.cnf\fP
default configuration file
-.IP "\fIlanguage\&.dat\fP"
+.IP \fIlanguage.dat\fP
hyphenation pattern file
-.IP "\fIlanguage\&.def\fP"
+.IP \fIlanguage.def\fP
hyphenation pattern file
-.IP "\fIlanguage\&.dat.lua\fP"
+.IP \fIlanguage.dat.lua\fP
hyphenation pattern file
-.PP
-.SH "SEE ALSO"
-.PP
+.SH SEE ALSO
\fBamstex\fP(1), \fBetex\fP(1), \fBfmtutil\fP(8),
-\fBtex\fP(1), \fBtexconfig\fP(8), \fBtexlinks\fP(8)\&.
-.PP
+\fBtex\fP(1), \fBtexconfig\fP(8), \fBtexlinks\fP(8).
+.PP
<https://tug.org/texlive/scripts-sys-user.html>
-.PP
-.SH "BUGS"
-.PP
-Email bug reports to <https://lists.tug.org/tex-k> (public mailing list).
-.PP
-.SH "AUTHOR"
-.PP
-\fBfmtutil\fP and \fIfmtutil\&.cnf\fP was originally written by Thomas Esser.
-.PP
-This manual page was written by C\&.M\&. Connelly for the Debian
-GNU/Linux system\&. It is now maintained as part of TeX Live.
+.SH BUGS
+Email bug reports to <https://lists.tug.org/tex-k>
+(public mailing list).
+.SH AUTHOR
+\fBfmtutil\fP and \fIfmtutil.cnf\fP was originally written by Thomas Esser.
+.PP
+This manual page was written by C.M.\& Connelly for the Debian
+GNU/Linux system.
+It is now maintained as part of TeX Live.
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 -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)
-.-
