a2ps-lpr-wrapper.1: Some remarks and editorial changes for this man page
Bjarni Ingi Gislason <[email protected]> Tue, 26 Nov 2024 00:30:29 +0000
| Newsgroups | gmane.comp.printing.a2ps.bugs |
|---|---|
| Message-ID | <173258076452.4946.10572183284744717177.reportbug@kassi.invalid.is> |
--9TrdPwCqq1RH6mEF
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Package: a2ps
Version: Upstream
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -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?
troff: backtrace: file '<stdin>':3
troff:<stdin>:3: warning: trailing space in the line
troff: backtrace: file '<stdin>':6
troff:<stdin>:6: warning: trailing space in the line
troff: backtrace: file '<stdin>':9
troff:<stdin>:9: warning: trailing space in the line
troff: backtrace: file '<stdin>':10
troff:<stdin>:10: warning: trailing space in the line
troff: backtrace: file '<stdin>':12
troff:<stdin>:12: warning: trailing space in the line
troff: backtrace: file '<stdin>':13
troff:<stdin>:13: warning: trailing space in the line
troff: backtrace: file '<stdin>':14
troff:<stdin>:14: warning: trailing space in the line
troff: backtrace: file '<stdin>':15
troff:<stdin>:15: warning: trailing space in the line
troff: backtrace: file '<stdin>':16
troff:<stdin>:16: warning: trailing space in the line
troff: backtrace: 'an.tmac':606: macro 'IP'
troff: backtrace: file '<stdin>':18
troff:<stdin>:18: warning: trailing space in the line
troff: backtrace: file '<stdin>':19
troff:<stdin>:19: warning: trailing space in the line
troff: backtrace: 'an.tmac':606: macro 'IP'
troff: backtrace: file '<stdin>':20
troff:<stdin>:20: warning: trailing space in the line
troff: backtrace: file '<stdin>':21
troff:<stdin>:21: warning: trailing space in the line
troff: backtrace: file '<stdin>':24
troff:<stdin>:24: warning: trailing space in the line
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':27
troff:<stdin>:27: warning: trailing space in the line
troff: backtrace: file '<stdin>':30
troff:<stdin>:30: warning: trailing space in the line
troff: backtrace: file '<stdin>':31
troff:<stdin>:31: warning: trailing space in the line
troff: backtrace: file '<stdin>':32
troff:<stdin>:32: warning: trailing space in the line
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: trailing space in the line
troff: backtrace: file '<stdin>':34
troff:<stdin>:34: warning: trailing space in the line
troff: backtrace: file '<stdin>':37
troff:<stdin>:37: warning: trailing space in the line
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: 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.11.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 a2ps depends on:
ii file 1:5.45-3+b1
ii libc6 2.40-3
ii libgc1 1:8.2.8-1
ii libpaper1 1.1.29+b2
ii psutils 1.17.dfsg-5
Versions of packages a2ps recommends:
ii bzip2 1.0.8-6
pn lpr | rlpr | cups-client <none>
ii wdiff 1.2.2-6
Versions of packages a2ps suggests:
ii emacsen-common 3.0.5
ii ghostscript 10.04.0~dfsg-1
ii groff 1.23.0-5
ii gv 1:3.7.4-2+b2
pn html2ps <none>
ii imagemagick 8:6.9.13.12+dfsg1-1+b1
ii imagemagick-6.q16 [imagemagick] 8:6.9.13.12+dfsg1-1+b1
pn t1-cyrillic <none>
ii texlive-binaries [texlive-base-bin] 2024.20240313.70630+ds-5
-- no debconf information
--9TrdPwCqq1RH6mEF
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="chk_man.err.a2ps-lpr-wrapper.1"
Input file is a2ps-lpr-wrapper.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 a2ps-lpr-wrapper.1 ": (shortened list)
1 missing date, using ""
4 skipping paragraph macro
38 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -b -z a2ps-lpr-wrapper.1 ": (shortened list)
23 trailing space in the line
-.-.
Output from "mandoc -T lint a2ps-lpr-wrapper.1 ":
mandoc: a2ps-lpr-wrapper.1:1:28: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:1:2: WARNING: missing date, using "": TH
mandoc: a2ps-lpr-wrapper.1:2:12: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:3:67: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:4:16: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:5:2: WARNING: skipping paragraph macro: PP after SH
mandoc: a2ps-lpr-wrapper.1:5:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:6:70: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:7:19: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:8:2: WARNING: skipping paragraph macro: PP after SH
mandoc: a2ps-lpr-wrapper.1:8:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:9:39: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:10:32: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:11:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:12:35: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:13:30: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:14:33: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:15:73: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:16:24: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:17:15: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:18:42: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:19:28: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:20:37: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:21:29: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:22:16: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:23:2: WARNING: skipping paragraph macro: PP after SH
mandoc: a2ps-lpr-wrapper.1:23:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:24:10: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:25:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:26:78: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:27:19: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:28:14: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:29:2: WARNING: skipping paragraph macro: PP after SH
mandoc: a2ps-lpr-wrapper.1:29:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:30:80: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:31:68: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:32:62: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:33:60: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:34:57: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:36:4: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:37:63: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:38:56: STYLE: whitespace at end of input line
mandoc: a2ps-lpr-wrapper.1:40:40: 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".
3:a2ps-lpr-wrapper \(em lp/lpr wrapper script for GNU a2ps on Debian
5:.PP
6:\fBa2ps-lpr-wrapper\fR [\fB-d \fIprinter\fR\fP] [\fB\fIfiles\fR\fP]
8:.PP
9:This manual page documents briefly the
10:\fBa2ps-lpr-wrapper\fR command.
11:.PP
12:\fBa2ps-lpr-wrapper\fR uses either
13:\fBlp\fP or \fBlpr\fP to send
14:\fIfiles\fR to \fIprinter\fR. It
15:determines which of the two programs is currently installed and adds the
16:appropriate parameters.
18:.IP "\fB-d \fIprinter\fR\fP " 10
19:Destination system printer.
20:.IP "\fB\fIfiles\fR\fP " 10
21:List of files to be printed.
23:.PP
24:a2ps (1).
25:.PP
26:The programs are documented fully by the a2ps documentation available via the
27:\fBInfo\fP system.
29:.PP
30:This manual page was written by Michael Tautschnig [email protected] for
31:the \fBDebian\fP system (but may be used by others). Permission is
32:granted to copy, distribute and/or modify this document under
33:the terms of the GNU General Public License, Version 2 any
34:later version published by the Free Software Foundation.
36:.PP
37:On Debian systems, the complete text of the GNU General Public
38:License can be found in /usr/share/common-licenses/GPL.
40:.\" created by instant / docbook-to-man
-.-.
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.
14:\fIfiles\fR to \fIprinter\fR. It
-.-.
Show if docman-to-man created this
40:.\" created by instant / docbook-to-man
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
a2ps-lpr-wrapper.1:31:the \fBDebian\fP system (but may be used by others). Permission is
-.-.
Two or more space charaters between printable characters.
When the distance is between sentences,
start the beginning of the second one on a separate line
("semantic newline").
6:\fBa2ps-lpr-wrapper\fR [\fB-d \fIprinter\fR\fP] [\fB\fIfiles\fR\fP]
18:.IP "\fB-d \fIprinter\fR\fP " 10
20:.IP "\fB\fIfiles\fR\fP " 10
31:the \fBDebian\fP system (but may be used by others). Permission is
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: file '<stdin>':3
troff:<stdin>:3: warning: trailing space in the line
troff: backtrace: file '<stdin>':6
troff:<stdin>:6: warning: trailing space in the line
troff: backtrace: file '<stdin>':9
troff:<stdin>:9: warning: trailing space in the line
troff: backtrace: file '<stdin>':10
troff:<stdin>:10: warning: trailing space in the line
troff: backtrace: file '<stdin>':12
troff:<stdin>:12: warning: trailing space in the line
troff: backtrace: file '<stdin>':13
troff:<stdin>:13: warning: trailing space in the line
troff: backtrace: file '<stdin>':14
troff:<stdin>:14: warning: trailing space in the line
troff: backtrace: file '<stdin>':15
troff:<stdin>:15: warning: trailing space in the line
troff: backtrace: file '<stdin>':16
troff:<stdin>:16: warning: trailing space in the line
troff: backtrace: 'an.tmac':606: macro 'IP'
troff: backtrace: file '<stdin>':18
troff:<stdin>:18: warning: trailing space in the line
troff: backtrace: file '<stdin>':19
troff:<stdin>:19: warning: trailing space in the line
troff: backtrace: 'an.tmac':606: macro 'IP'
troff: backtrace: file '<stdin>':20
troff:<stdin>:20: warning: trailing space in the line
troff: backtrace: file '<stdin>':21
troff:<stdin>:21: warning: trailing space in the line
troff: backtrace: file '<stdin>':24
troff:<stdin>:24: warning: trailing space in the line
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':27
troff:<stdin>:27: warning: trailing space in the line
troff: backtrace: file '<stdin>':30
troff:<stdin>:30: warning: trailing space in the line
troff: backtrace: file '<stdin>':31
troff:<stdin>:31: warning: trailing space in the line
troff: backtrace: file '<stdin>':32
troff:<stdin>:32: warning: trailing space in the line
troff: backtrace: file '<stdin>':33
troff:<stdin>:33: warning: trailing space in the line
troff: backtrace: file '<stdin>':34
troff:<stdin>:34: warning: trailing space in the line
troff: backtrace: file '<stdin>':37
troff:<stdin>:37: warning: trailing space in the line
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: warning: trailing space in the line
--9TrdPwCqq1RH6mEF
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="a2ps-lpr-wrapper.1.diff"
--- a2ps-lpr-wrapper.1 2024-11-25 23:50:01.255495702 +0000
+++ a2ps-lpr-wrapper.1.new 2024-11-26 00:18:38.050639786 +0000
@@ -1,40 +1,39 @@
-.TH "a2ps-lpr-wrapper" "1"
-.SH "NAME"
-a2ps-lpr-wrapper \(em lp/lpr wrapper script for GNU a2ps on Debian
-.SH "SYNOPSIS"
-.PP
-\fBa2ps-lpr-wrapper\fR [\fB-d \fIprinter\fR\fP] [\fB\fIfiles\fR\fP]
-.SH "DESCRIPTION"
-.PP
-This manual page documents briefly the
-\fBa2ps-lpr-wrapper\fR command.
-.PP
-\fBa2ps-lpr-wrapper\fR uses either
-\fBlp\fP or \fBlpr\fP to send
-\fIfiles\fR to \fIprinter\fR. It
-determines which of the two programs is currently installed and adds the
-appropriate parameters.
-.SH "OPTIONS"
-.IP "\fB-d \fIprinter\fR\fP " 10
-Destination system printer.
-.IP "\fB\fIfiles\fR\fP " 10
-List of files to be printed.
-.SH "SEE ALSO"
-.PP
-a2ps (1).
-.PP
-The programs are documented fully by the a2ps documentation available via the
-\fBInfo\fP system.
-.SH "AUTHOR"
-.PP
-This manual page was written by Michael Tautschnig [email protected] for
-the \fBDebian\fP system (but may be used by others). Permission is
-granted to copy, distribute and/or modify this document under
-the terms of the GNU General Public License, Version 2 any
-later version published by the Free Software Foundation.
-
-.PP
-On Debian systems, the complete text of the GNU General Public
-License can be found in /usr/share/common-licenses/GPL.
-
-.\" created by instant / docbook-to-man
+.TH "a2ps-lpr-wrapper" "1"
+.SH "NAME"
+a2ps-lpr-wrapper \(em lp/lpr wrapper script for GNU a2ps on Debian
+.SH "SYNOPSIS"
+.B a2ps-lpr-wrapper
+.RB [ \-d
+.IR printer "] [" files ]
+.SH "DESCRIPTION"
+This manual page documents briefly the
+\fBa2ps-lpr-wrapper\fR command.
+.PP
+\fBa2ps-lpr-wrapper\fR uses either
+\fBlp\fP or \fBlpr\fP to send
+\fIfiles\fR to \fIprinter\fR.
+It determines which of the two programs is currently installed
+and adds the appropriate parameters.
+.SH "OPTIONS"
+.IP "\fB\-d \fIprinter\fR\fP" 12
+Destination system printer.
+.IP "\fIfiles\fP" 12
+List of files to be printed.
+.SH "SEE ALSO"
+.BR a2ps (1).
+.PP
+The programs are documented fully by the a2ps documentation available via the
+\fBInfo\fP system.
+.SH "AUTHOR"
+This manual page was written by Michael Tautschnig [email protected] for
+the \fBDebian\fP system
+(but may be used by others).
+Permission is granted to copy, distribute and/or modify this document under
+the terms of the GNU General Public License, Version 2 any
+later version published by the Free Software Foundation.
+
+.PP
+On Debian systems, the complete text of the GNU General Public
+License can be found in /usr/share/common-licenses/GPL.
+
+.\" created by instant / docbook-to-man
--9TrdPwCqq1RH6mEF--