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)
an.tmac:<stdin>:36: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:40: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:43: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' 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)
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 t1mac.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 t1mac.1": (shortened list)
1 missing date, using ""
1 skipping paragraph macro
-.-.
Output from "test-groff -mandoc -t -ww -z t1mac.1": (shortened list)
4 Use macro '.B' for one argument or split argument.
4 .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.
36:.BR \-\-macbinary
40:.BR \-\-applesingle
43:.BR \-\-appledouble
46:.BR \-\-binhex
-.-.
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 "\&".
17:generates an equivalent Macintosh Type 1 font file. The output file can be
19:raw resource fork. The default is MacBinary II; use an option to choose a
20:different format. If the
27:fonts. You will need to create a font suitcase containing bitmap fonts if
37:Indicates that output should be in MacBinary I or II format. This is the
50:Sets the Macintosh filename of the output font to \fIname\fR. The default
52:Macintosh conventions. This option is not useful when output is a raw
-.-.
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>:36: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:40: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:43: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
an.tmac:<stdin>:46: misuse, warning: .BR is for at least 2 arguments, got 1
Use macro '.B' for one argument or split argument.
--- t1mac.1 2025-01-16 00:06:00.301007285 +0000
+++ t1mac.1.new 2025-01-16 00:18:49.449415027 +0000
@@ -13,19 +13,27 @@ t1mac \- translate a PFA or PFB PostScri
\%[\fIinput\fR [\fIoutput\fR]]
.SH DESCRIPTION
.B t1mac
-reads a PFA (hexadecimal) or PFB (binary) PostScript Type 1 font file and
-generates an equivalent Macintosh Type 1 font file. The output file can be
-in MacBinary II, AppleSingle, AppleDouble, or BinHex format, or it can be a
-raw resource fork. The default is MacBinary II; use an option to choose a
-different format. If the
+reads a PFA
+(hexadecimal)
+or PFB
+(binary)
+PostScript Type 1 font file
+and generates an equivalent Macintosh Type 1 font file.
+The output file can be in MacBinary II, AppleSingle, AppleDouble,
+or BinHex format,
+or it can be a raw resource fork.
+The default is MacBinary II;
+use an option to choose a different format.
+If the
.I output
file is not specified output goes to the standard output.
.PP
WARNING: The output of
.B t1mac
-is not sufficient to use the font, since Macintoshes can't read raw Type 1
-fonts. You will need to create a font suitcase containing bitmap fonts if
-you do not have such a suitcase for the font already.
+is not sufficient to use the font,
+since Macintoshes can't read raw Type 1 fonts.
+You will need to create a font suitcase containing bitmap fonts
+if you do not have such a suitcase for the font already.
.B t1mac
cannot help you do this.
.SH OPTIONS
@@ -33,26 +41,26 @@ cannot help you do this.
.BR \-\-raw ", " \-r
Indicates that output should be a raw resource fork.
.TP 5
-.BR \-\-macbinary
-Indicates that output should be in MacBinary I or II format. This is the
-default.
+.B \-\-macbinary
+Indicates that output should be in MacBinary I or II format.
+This is the default.
.TP 5
-.BR \-\-applesingle
+.B \-\-applesingle
Indicates that output should be in AppleSingle format.
.TP 5
-.BR \-\-appledouble
+.B \-\-appledouble
Indicates that output should be in AppleDouble format.
.TP 5
-.BR \-\-binhex
+.B \-\-binhex
Indicates that output should be in BinHex 4.0 format.
.TP 5
.BR \-\-filename "=\fIname\fR, " \-n " \fIname\fR"
-Sets the Macintosh filename of the output font to \fIname\fR. The default
-is to construct the filename from the font's name using established
-Macintosh conventions. This option is not useful when output is a raw
-resource fork.
+Sets the Macintosh filename of the output font to \fIname\fR.
+The default is to construct the filename from the font's name using
+established Macintosh conventions.
+This option is not useful
+when output is a raw resource fork.
.SH "SEE ALSO"
-.LP
.M t1unmac 1 ,
.M t1ascii 1 ,
.M t1binary 1 ,
