Package: ghostscript
Version: 10.04.0~dfsg-2+b1
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>:14: 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.17-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 ghostscript depends on:
ii libc6 2.41-4
ii libgs10 10.04.0~dfsg-2+b1
ghostscript recommends no packages.
Versions of packages ghostscript suggests:
ii texlive-binaries 2024.20240313.70630+ds-5+b1
-- no debconf information
Input file is gslp.1
Output from "mandoc -T lint gslp.1": (shortened list)
1 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-nroff -mandoc -t -ww -z gslp.1": (shortened list)
1 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
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
1
-.-.
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 "\-\-".
gslp.1:66:.IP "--add-to-space <units>"
gslp.1:69:.IP "--add-to-width <units>"
gslp.1:72:.IP "--columns <n>"
gslp.1:74:.IP "--detect"
gslp.1:76:.IP "--first-page <n>"
gslp.1:78:.IP "--kern <file.afm>"
gslp.1:80:.IP "--last-page <n>"
gslp.1:82:.IP "--(heading|footing)-(left|center|right) <string>"
gslp.1:84:.IP "--margin-(top|bottom|left|right) <inches>"
gslp.1:86:.IP "--no-eject-(file|formfeed)"
gslp.1:88:.IP "--spacing <n>"
-.-.
Change - to \- if it shall be printed as a minus sign.
gslp.1:59:-12BclqRr -b<header> -f<font> -F<hfont> -L<lines> -p<outfile>
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
1:.TH GSLP 1 "18 Sept 2024" 10.04.0 Ghostscript \" -*- nroff -*-
59:-12BclqRr -b<header> -f<font> -F<hfont> -L<lines> -p<outfile>
61:-T<n> set tab width
63:-GghKkmow -# -C -d -J -n -P -S -s -t -v
66:.IP "--add-to-space <units>"
69:.IP "--add-to-width <units>"
72:.IP "--columns <n>"
74:.IP "--detect"
76:.IP "--first-page <n>"
78:.IP "--kern <file.afm>"
80:.IP "--last-page <n>"
82:.IP "--(heading|footing)-(left|center|right) <string>"
83:set the heading/footing fields; use -B first to clear
84:.IP "--margin-(top|bottom|left|right) <inches>"
86:.IP "--no-eject-(file|formfeed)"
88:.IP "--spacing <n>"
-.-.
Change QUATION MARK (") to "\ in" if it means an inch, or to "\ inches" in a
running text.
67:add the given number of 1/72" units to the width of each
70:add the given number of 1/72" units to the width of each
-.-.
Wrong distance (not two spaces) 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"
[List of affected lines removed.]
89:use double (n=2), triple (n=3), etc. spacing
97:Artifex Software, Inc. are the
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
gslp.1:68:space (may be negative)
gslp.1:71:character (may be negative)
-.-.
Only one space character after a possible end of sentence
(after a punctuation, that can end a sentence).
gslp.1:89:use double (n=2), triple (n=3), etc. spacing
gslp.1:97:Artifex Software, Inc. are the
-.-.
Put a subordinate sentence (after a comma) on a new line.
gslp.1:42:It currently handles tabs and formfeeds, but not backspaces.
gslp.1:87:end-of-file/FF only starts a new column, not a new sheet
gslp.1:89:use double (n=2), triple (n=3), etc. spacing
gslp.1:91:Also, the string %# in a heading or footing is replaced with the page
#.
gslp.1:97:Artifex Software, Inc. are the
-.-.
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.
gslp.1:74:.IP "--detect"
gslp.1:86:.IP "--no-eject-(file|formfeed)"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:14: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- gslp.1 2025-03-14 13:32:28.507749492 +0000
+++ gslp.1.new 2025-03-14 14:54:24.282214914 +0000
@@ -1,4 +1,4 @@
-.TH GSLP 1 "18 Sept 2024" 10.04.0 Ghostscript \" -*- nroff -*-
+.TH GSLP 1 "18 Sept 2024" 10.04.0 Ghostscript\" -*- nroff -*-
.SH NAME
gslp \- Format and print text using ghostscript
.br
@@ -11,7 +11,7 @@ gsdj500 \- Format and print text for Des
gslj \- Format and print text for LaserJet printer using ghostscript
.SH SYNOPSIS
.na
-\fBgslp\fB
+\fBgslp\fB
\-12BclqRr \-b<header> \-f<font> \-F<hfont> \-L<lines> \-p<outfile>
\-T<n>
\-\-add\-to\-space\ <units>
@@ -56,37 +56,39 @@ The default device (\-sDEVICE=) and reso
By default the current date is formatted as the center header.
.SH OPTIONS
.IP "Standard switches implemented:"
--12BclqRr -b<header> -f<font> -F<hfont> -L<lines> -p<outfile>
+\-12BclqRr \-b<header> \-f<font> \-F<hfont> \-L<lines> \-p<outfile>
.IP "Sun switches implemented:"
--T<n> set tab width
+\-T<n> set tab width
.IP "Switches ignored:"
--GghKkmow -# -C -d -J -n -P -S -s -t -v
+\-GghKkmow \-# \-C \-d \-J \-n \-P \-S \-s \-t \-v
.IP "Switches added:"
.RS
-.IP "--add-to-space <units>"
-add the given number of 1/72" units to the width of each
-space (may be negative)
-.IP "--add-to-width <units>"
-add the given number of 1/72" units to the width of each
-character (may be negative)
-.IP "--columns <n>"
+.IP "\-\-add-to-space <units>"
+add the given number of 1/72\~inches units to the width of each
+space
+(may be negative)
+.IP "\-\-add-to-width <units>"
+add the given number of 1/72\~inches units to the width of each
+character
+(may be negative)
+.IP "\-\-columns <n>"
print in <n> columns
-.IP "--detect"
+.IP \-\-detect
treat the file as PostScript if it starts with %!
-.IP "--first-page <n>"
+.IP "\-\-first-page <n>"
start printing at page <n>
-.IP "--kern <file.afm>"
+.IP "\-\-kern <file.afm>"
kern using information from the given .AFM file
-.IP "--last-page <n>"
+.IP "\-\-last-page <n>"
stop printing after page <n>
-.IP "--(heading|footing)-(left|center|right) <string>"
-set the heading/footing fields; use -B first to clear
-.IP "--margin-(top|bottom|left|right) <inches>"
+.IP "\-\-(heading|footing)\-(left|center|right) <string>"
+set the heading/footing fields; use \-B first to clear
+.IP "\-\-margin-(top|bottom|left|right) <inches>"
set a margin
-.IP "--no-eject-(file|formfeed)"
+.IP \-\-no-eject-(file|formfeed)
end-of-file/FF only starts a new column, not a new sheet
-.IP "--spacing <n>"
-use double (n=2), triple (n=3), etc. spacing
+.IP "\-\-spacing <n>"
+use double (n=2), triple (n=3), etc.\& spacing
.RE
Also, the string %# in a heading or footing is replaced with the page #.
.SH SEE ALSO
@@ -94,6 +96,6 @@ Also, the string %# in a heading or foot
.SH VERSION
This document was last revised for Ghostscript version 10.04.0.
.SH AUTHOR
-Artifex Software, Inc. are the
+Artifex Software, Inc.\& are the
primary maintainers of Ghostscript.
This manpage by George Ferguson.
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)
-.-
