Package: ghostscript
Version: 10.03.1~dfsg-1
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
[test-]groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
troff: backtrace: file '<standard input>':23
troff:<standard input>:23: warning: trailing space in the line
troff: backtrace: file '<standard input>':56
troff:<standard input>:56: warning: trailing space in the line
troff: backtrace: file '<standard input>':58
troff:<standard input>:58: warning: trailing space in the line
troff: backtrace: file '<standard input>':74
troff:<standard input>:74: warning: trailing space in the line
* What outcome did you expect instead?
No output (warnings).
-.-
General remarks and further material (declared as a "diff" file) are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.9.9-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.39-4
ii libgs10 10.03.1~dfsg-1
ghostscript recommends no packages.
Versions of packages ghostscript suggests:
ii texlive-binaries 2024.20240313.70630+ds-2
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <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' 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 errors:
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
(that is not confined to a markup)
in the first column.
Line length should thus be reduced.
-.-
The difference between the formatted outputs 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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint ps2pdf.1": (possibly shortened list)
mandoc: ps2pdf.1:5:94: STYLE: input text line longer than 80 bytes: ps2pdf12 \-
Convert ...
mandoc: ps2pdf.1:7:94: STYLE: input text line longer than 80 bytes: ps2pdf13 \-
Convert ...
mandoc: ps2pdf.1:9:94: STYLE: input text line longer than 80 bytes: ps2pdf14 \-
Convert ...
mandoc: ps2pdf.1:23:66: STYLE: whitespace at end of input line
mandoc: ps2pdf.1:56:69: STYLE: whitespace at end of input line
mandoc: ps2pdf.1:58:69: STYLE: whitespace at end of input line
mandoc: ps2pdf.1:65:2: WARNING: skipping paragraph macro: PP after SH
mandoc: ps2pdf.1:74:24: STYLE: whitespace at end of input line
mandoc: ps2pdf.1:79:19: STYLE: whitespace at end of input line
-.-.
Remove space characters at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
23:convert PostScript files to Portable Document Format (PDF) files.
56:conversion. See the HTML documentation for more information. A large
58:the conversion are also documented there, including instructions for
74:-dPDFSETTINGS=/prepress
79:.B make_report.pl
-.-.
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 PS2PDF 1 "06 May 2024" 10.03.1 Ghostscript \" -*- nroff -*-
11:\fBps2pdf\fR [options...] {input.[e]ps|-} [output.pdf|-]
13:\fBps2pdf12\fR [options...] {input.[e]ps|-} [output.pdf|-]
15:\fBps2pdf13\fR [options...] {input.[e]ps|-} [output.pdf|-]
17:\fBps2pdf14\fR [options...] {input.[e]ps|-} [output.pdf|-]
27:directory. Either the input filename or the output filename can be '-'
32:.IP -
35:.IP -
38:.IP -
41:.IP -
82:-dCompatibilityLevel=1.3 - - |
-.-.
Wrong distance between sentences.
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.
27:directory. Either the input filename or the output filename can be '-'
44:However, this may change in the future. If you care about
56:conversion. See the HTML documentation for more information. A large
94:Artifex Software, Inc. are the
-.-.
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.
ps2pdf12 \- Convert PostScript to PDF\ 1.2 (Acrobat\ 3-and-later compatible)
using ghostscript
Line 7, length 94
ps2pdf13 \- Convert PostScript to PDF\ 1.3 (Acrobat\ 4-and-later compatible)
using ghostscript
Line 9, length 94
ps2pdf14 \- Convert PostScript to PDF\ 1.4 (Acrobat\ 5-and-later compatible)
using ghostscript
-.-
Use \(en (en-dash) for a dash between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
ps2pdf.1:82:-dCompatibilityLevel=1.3 - - |
-.-.
Output from "test-groff -b -mandoc -rF0 -rHY=0 -K utf8 -t -ww -z ":
troff: backtrace: file '<stdin>':23
troff:<stdin>:23: warning: trailing space in the line
troff: backtrace: file '<stdin>':56
troff:<stdin>:56: warning: trailing space in the line
troff: backtrace: file '<stdin>':58
troff:<stdin>:58: warning: trailing space in the line
troff: backtrace: file '<stdin>':74
troff:<stdin>:74: warning: trailing space in the line
--- ps2pdf.1 2024-07-23 21:38:55.126779958 +0000
+++ ps2pdf.1.new 2024-07-23 22:04:10.788634852 +0000
@@ -2,47 +2,53 @@
.SH NAME
ps2pdf \- Convert PostScript to PDF using ghostscript
.br
-ps2pdf12 \- Convert PostScript to PDF\ 1.2 (Acrobat\ 3-and-later compatible)
using ghostscript
+ps2pdf12 \- Convert PostScript to PDF\ 1.2 (Acrobat\ 3-and-later compatible) \
+using ghostscript
.br
-ps2pdf13 \- Convert PostScript to PDF\ 1.3 (Acrobat\ 4-and-later compatible)
using ghostscript
+ps2pdf13 \- Convert PostScript to PDF\ 1.3 (Acrobat\ 4-and-later compatible) \
+using ghostscript
.br
-ps2pdf14 \- Convert PostScript to PDF\ 1.4 (Acrobat\ 5-and-later compatible)
using ghostscript
+ps2pdf14 \- Convert PostScript to PDF\ 1.4 (Acrobat\ 5-and-later compatible) \
+using ghostscript
.SH SYNOPSIS
-\fBps2pdf\fR [options...] {input.[e]ps|-} [output.pdf|-]
+\fBps2pdf\fR [options...] {input.[e]ps|\-} [output.pdf|\-]
.br
-\fBps2pdf12\fR [options...] {input.[e]ps|-} [output.pdf|-]
+\fBps2pdf12\fR [options...] {input.[e]ps|\-} [output.pdf|\-]
.br
-\fBps2pdf13\fR [options...] {input.[e]ps|-} [output.pdf|-]
+\fBps2pdf13\fR [options...] {input.[e]ps|\-} [output.pdf|\-]
.br
-\fBps2pdf14\fR [options...] {input.[e]ps|-} [output.pdf|-]
+\fBps2pdf14\fR [options...] {input.[e]ps|\-} [output.pdf|\-]
.SH DESCRIPTION
The
.B ps2pdf
scripts are work-alikes for nearly all the functionality (but not the
user interface) of Adobe's Acrobat(TM) Distiller(TM) product: they
-convert PostScript files to Portable Document Format (PDF) files.
+convert PostScript files to Portable Document Format (PDF) files.
.PP
If the output filename is not specified, the output is placed in a file
of the same name with a '.pdf' extension in the current working
-directory. Either the input filename or the output filename can be '-'
-to request reading from stdin or writing to stdout, respectively,
+directory.
+Either the input filename or the output filename can be '\-'
+to request reading from stdin or writing to stdout,
+respectively,
when used as a filter.
.PP
The three scripts differ as follows:
-.IP -
+.IP \(en
.B ps2pdf12
will always produce PDF 1.2 output (Acrobat 3-and-later compatible).
-.IP -
+.IP \(en
.B ps2pdf13
will always produce PDF 1.3 output (Acrobat 4-and-later compatible).
-.IP -
+.IP \(en
.B ps2pdf14
will always produce PDF 1.4 output (Acrobat 5-and-later compatible).
-.IP -
+.IP \(en
.B ps2pdf
per se currently produces PDF 1.4 output.
-However, this may change in the future. If you care about
-the compatibility level of the output, use
+However, this may change in the future.
+If you care about the compatibility level of the output,
+use
.BR ps2pdf12 ,
.B ps2pdf13
or
@@ -53,16 +59,17 @@ switch in the command line.
.PP
There are some limitations in
.BR ps2pdf 's
-conversion. See the HTML documentation for more information. A large
-number of Adobe Distiller(TM) parameters which can be used to control
-the conversion are also documented there, including instructions for
-generating PDF/X and PDF/A documents.
+conversion.
+See the HTML documentation for more information.
+A large number of Adobe Distiller(TM) parameters which can be used to
+control the conversion are also documented there,
+including instructions for generating PDF/X and PDF/A documents.
.SH OPTIONS
The
.B ps2pdf
-scripts use the same options as gs(1).
+scripts use the same options as
+.BR gs (1).
.SH EXAMPLES
-.LP
Converting a figure.ps to figure.pdf:
.IP
.B ps2pdf
@@ -71,18 +78,18 @@ Converting a figure.ps to figure.pdf:
A conversion with more specifics:
.IP
.B ps2pdf
--dPDFSETTINGS=/prepress
+\-dPDFSETTINGS=/prepress
.I figure.ps proof.pdf
.LP
Converting as part of a pipe:
.IP
-.B make_report.pl
--t ps |
+.B make_report.pl
+\-t ps |
.B ps2pdf
--dCompatibilityLevel=1.3 - - |
+\-dCompatibilityLevel=1.3 \- \- |
.B lpr
.SH SEE ALSO
-gs(1), ps2pdfwr(1),
+.BR gs "(1), " ps2pdfwr (1),
.br
VectorDevices.htm in the Ghostscript documentation
.SH BUGS
@@ -91,6 +98,6 @@ comp.lang.postscript.
.SH VERSION
This document was last revised for Ghostscript version 10.03.1.
.SH AUTHOR
-Artifex Software, Inc. are the
+Artifex Software, Inc.\& are the
primary maintainers of Ghostscript.
This manpage by George Ferguson.
