Package: t1utils
Version: 1.41-4
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>:5: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
* 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)
Versions of packages t1utils depends on:
ii libc6 2.40-5
t1utils recommends no packages.
t1utils suggests no packages.
-- no debconf information
Input file is t1ascii.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 t1ascii.1": (shortened list)
1 missing date, using ""
1 skipping paragraph macro
-.-.
Output from "test-groff -mandoc -t -ww -z t1ascii.1": (shortened list)
1 Use macro '.B' for one argument or split argument.
1 .BR 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.
13:.BR t1ascii
-.-.
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 "\&".
15:(hexadecimal) format. If the file
27:(These are the lines consisting wholly of hexadecimal digits.) The default
-.-.
Split a punctuation from a single argument, if a two-font macro is meant.
26:.I num.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:5: style: .TH missing third argument; consider document
modification date in ISO 8601 format (YYYY-MM-DD)
an.tmac:<stdin>:13: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
-.-
Additionally
Change a single "'" (single quote) to "." (period, normal control character) at
the
beginning of an otherwise empty line.
--- t1ascii.1 2025-01-15 23:28:19.723294642 +0000
+++ t1ascii.1.new 2025-01-15 23:37:52.158297002 +0000
@@ -10,31 +10,33 @@ t1ascii \- convert PostScript Type 1 fon
\%[\fB\-l\fR \fIlength\fR]
\%[\fIinput\fR [\fIoutput\fR]]
.SH DESCRIPTION
-.BR t1ascii
+.B t1ascii
converts Adobe Type 1 font programs in PFB (binary) format to PFA
-(hexadecimal) format. If the file
+(hexadecimal)
+format.
+If the file
.I output
is not specified output goes to the standard output.
If the file
.I input
is not specified input comes from the standard input.
-'
+.
.SH OPTIONS
.TP 5
.BI \-\-line\-length= "num\fR, " \-l " num"
Set the maximum length of encrypted lines in the output to
-.I num.
-(These are the lines consisting wholly of hexadecimal digits.) The default
-is 64.
-'
+.IR num .
+(These are the lines consisting wholly of hexadecimal digits.)
+The default is 64.
+.
.TP 5
.BR \-\-warnings ", " \-w
Warn when the input font contains lines longer than 255 characters.
Long lines don't strictly conform to Adobe's Document Structuring
-Conventions, and may cause problems with older software.
-'
+Conventions,
+and may cause problems with older software.
+.
.SH "SEE ALSO"
-.LP
.M t1binary 1 ,
.M t1unmac 1 ,
.M t1mac 1 ,
