Package: xfonts-utils
Version: 1:7.7+7
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>:15: misuse, warning: .IR 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.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 xfonts-utils depends on:
ii libc6 2.40-7
ii libfontenc1 1:1.1.8-1+b2
ii libfreetype6 2.13.3+dfsg-1
ii x11-common 1:7.7+24
ii xfonts-encodings 1:1.0.4-2.2
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
xfonts-utils recommends no packages.
xfonts-utils suggests no packages.
-- no debconf information
Input file is fonttosfnt.1
Output from "mandoc -T lint fonttosfnt.1": (shortened list)
-.-.
Output from "test-nroff -mandoc -t -ww -z fonttosfnt.1": (shortened list)
1 Use macro '.I' for one argument or split argument.
1 .IR is for at least 2 arguments, got 1
-.-.
Use the word (in)valid instead of (il)legal,
if not related to legal matters.
See "www.gnu.org/prep/standards".
Think about translations into other languages!
fonttosfnt.1:42:is 0, no scalable glyphs are written; this is legal but confuses
fonttosfnt.1:58:is 0, no scalable metrics are written, which may or may not be
legal.
-.-.
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.
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:Do not crop glyphs. This usually increases file size, but may
32:Write byte-aligned glyph data. By default, unaligned data is written,
36:Do not reencode fonts. By default, fonts are reencoded to Unicode
40:Set the type of scalable glyphs that we write. If
43:most current software. If
56:Set the type of scalable metrics that we write. If
62:sidebearing values are written for the other glyphs. If
65:file size and is not recommended. The default is 1.
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
73:X(7), Xserver(1), Xft(3).
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
74:.I Fonts in X11.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
fonttosfnt.1:29:cell fonts (terminal fonts).
fonttosfnt.1:45:is 1, a single scalable glyph (the undefined glyph) is written;
this
fonttosfnt.1:50:is 2 (the default), a sufficiently high number of blank glyphs
are
-.-.
Space after an end of sentence.
fonttosfnt.1:27:Do not crop glyphs. This usually increases file size, but may
fonttosfnt.1:32:Write byte-aligned glyph data. By default, unaligned data is
written,
fonttosfnt.1:36:Do not reencode fonts. By default, fonts are reencoded to
Unicode
fonttosfnt.1:40:Set the type of scalable glyphs that we write. If
fonttosfnt.1:43:most current software. If
fonttosfnt.1:56:Set the type of scalable metrics that we write. If
fonttosfnt.1:62:sidebearing values are written for the other glyphs. If
fonttosfnt.1:65:file size and is not recommended. The default is 1.
-.-.
Put a subordinate sentence (after a comma) on a new line.
fonttosfnt.1:20:If no font is specified, a BDF font is read from standard input
(stdin).
fonttosfnt.1:27:Do not crop glyphs. This usually increases file size, but may
fonttosfnt.1:32:Write byte-aligned glyph data. By default, unaligned data is
written,
fonttosfnt.1:36:Do not reencode fonts. By default, fonts are reencoded to
Unicode
fonttosfnt.1:42:is 0, no scalable glyphs are written; this is legal but confuses
fonttosfnt.1:45:is 1, a single scalable glyph (the undefined glyph) is written;
this
fonttosfnt.1:46:is recommended, but triggers a bug in current versions of
fonttosfnt.1:50:is 2 (the default), a sufficiently high number of blank glyphs
are
fonttosfnt.1:51:written, which works with
fonttosfnt.1:58:is 0, no scalable metrics are written, which may or may not be
legal.
fonttosfnt.1:61:is 1, full metrics for a single glyph are written, and only left
fonttosfnt.1:64:is 2, scalable metrics for all glyphs are written, which
increases
fonttosfnt.1:70:Some of the font-level values, notably sub- and superscript
positions,
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:15: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- fonttosfnt.1 2025-03-07 20:26:12.056402197 +0000
+++ fonttosfnt.1.new 2025-03-07 20:41:18.444681814 +0000
@@ -12,66 +12,92 @@ fonttosfnt \- Wrap a bitmap font in a sf
[
.B \-\-
] [
-.IR font
+.I font
] ...
.SH DESCRIPTION
-Wrap a bitmap font or a set of bitmap fonts in a sfnt (TrueType or
-OpenType) wrapper.
-If no font is specified, a BDF font is read from standard input (stdin).
+Wrap a bitmap font
+or a set of bitmap fonts in a sfnt
+(TrueType or OpenType)
+wrapper.
+If no font is specified,
+a BDF font is read from standard input (stdin).
.SH OPTIONS
.TP
.B \-v
Be verbose.
.TP
.B \-c
-Do not crop glyphs. This usually increases file size, but may
-sometimes yield a modest decrease in file size for small character
-cell fonts (terminal fonts).
+Do not crop glyphs.
+This usually increases file size,
+but may sometimes yield a modest decrease in file size for small
+character cell fonts
+(terminal fonts).
.TP
.B \-b
-Write byte-aligned glyph data. By default, unaligned data is written,
+Write byte-aligned glyph data.
+By default,
+unaligned data is written,
which yields a smaller file size.
.TP
.B \-r
-Do not reencode fonts. By default, fonts are reencoded to Unicode
-whenever possible.
+Do not reencode fonts.
+By default,
+fonts are reencoded to Unicode whenever possible.
.TP
.BI \-g " n"
-Set the type of scalable glyphs that we write. If
+Set the type of scalable glyphs that we write.
+If
.I n
-is 0, no scalable glyphs are written; this is legal but confuses
-most current software. If
+is 0,
+no scalable glyphs are written;
+this is valid but confuses most current software.
+If
.I n
-is 1, a single scalable glyph (the undefined glyph) is written; this
-is recommended, but triggers a bug in current versions of
+is 1,
+a single scalable glyph
+(the undefined glyph)
+is written;
+this is recommended,
+but triggers a bug in current versions of
.BR FreeType .
If
.I n
-is 2 (the default), a sufficiently high number of blank glyphs are
-written, which works with
+is 2
+(the default),
+a sufficiently high number of blank glyphs are written,
+which works with
.B FreeType
but increases file size.
.TP
.BI \-m " n"
-Set the type of scalable metrics that we write. If
+Set the type of scalable metrics that we write.
+If
.I n
-is 0, no scalable metrics are written, which may or may not be legal.
+is 0,
+no scalable metrics are written,
+which may or may not be valid.
If
.I n
-is 1, full metrics for a single glyph are written, and only left
-sidebearing values are written for the other glyphs. If
+is 1,
+full metrics for a single glyph are written,
+and only left sidebearing values are written for the other glyphs.
+If
.I n
-is 2, scalable metrics for all glyphs are written, which increases
-file size and is not recommended. The default is 1.
+is 2,
+scalable metrics for all glyphs are written,
+which increases file size
+and is not recommended.
+The default is 1.
.TP
.B \-\-
End of options.
.SH BUGS
-Some of the font-level values, notably sub- and superscript positions,
+Some of the font-level values,
+notably sub- and superscript positions,
are dummy values.
.SH SEE ALSO
-X(7), Xserver(1), Xft(3).
-.I Fonts in X11.
+.BR X "(7), " Xserver "(1), " Xft (3).
+.IR "Fonts in X11" .
.SH AUTHOR
The version of
.B Fonttosfnt
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)
-.-
