Package: net-tools
Version: 2.10-1.1
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>':23
troff:<stdin>:23: 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.5-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 net-tools depends on:
ii libc6 2.40-3
ii libselinux1 3.7-3+b1
net-tools recommends no packages.
net-tools suggests no packages.
-- no debconf information
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 plipconfig.8": (shortened list)
3 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -b -z plipconfig.8": (shortened list)
3 trailing space in the 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:plipconfig \- fine tune PLIP device parameters
23:If the single
38:Values which are too low may cause excess use of CPU, poor interrupt
-.-.
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.
19:timing parameters used by the PLIP protocol. Results are dependent on
32:Sets the nibble wait value in microseconds. Default is 3000.
35:Sets the trigger wait value in microseconds. Default is 500.
40:of PLIP packets. Changing the plip MTU can also affect PLIP speed.
43:setting with ifconfig. The few cases where the default parameters will
44:be too fast are those using very long cables. Something you should
-.-.
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.
Line 1, length 82
.TH PLIPCONFIG 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's
Manual"
-.-.
Two or more space charaters between printable characters
28:only. Otherwise, it will try to set the options.
-.-.
Space after an end of sentence.
19:timing parameters used by the PLIP protocol. Results are dependent on
28:only. Otherwise, it will try to set the options.
32:Sets the nibble wait value in microseconds. Default is 3000.
35:Sets the trigger wait value in microseconds. Default is 500.
40:of PLIP packets. Changing the plip MTU can also affect PLIP speed.
43:setting with ifconfig. The few cases where the default parameters will
44:be too fast are those using very long cables. Something you should
-.-.
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>':23
troff:<stdin>:23: warning: trailing space in the line
troff: backtrace: file '<stdin>':38
troff:<stdin>:38: warning: trailing space in the line
-.-
General (see man-pages(7)).
Variable parameters are typeset in Italic.
--- plipconfig.8 2024-11-15 16:39:58.918077486 +0000
+++ plipconfig.8.new 2024-11-15 16:41:15.541028971 +0000
@@ -1,8 +1,9 @@
-.TH PLIPCONFIG 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's
Manual"
+.TH PLIPCONFIG 8 "2008\-10\-03" "net\-tools" "Linux System Administrator's \
+Manual"
.SH NAME
-plipconfig \- fine tune PLIP device parameters
+plipconfig \- fine tune PLIP device parameters
.SH SYNOPSIS
-.B plipconfig interface
+.BI plipconfig " interface"
.RB [ nibble
.IR NN ]
.RB [ trigger
@@ -16,34 +17,41 @@ plipconfig \- fine tune PLIP device para
.SH DESCRIPTION
.B Plipconfig
is used to (hopefully) improve PLIP performance by changing the default
-timing parameters used by the PLIP protocol. Results are dependent on
-the parallel port hardware, cable, and the CPU speed of each machine
-on each end of the PLIP link.
+timing parameters used by the PLIP protocol.
+Results are dependent on the parallel port hardware,
+cable, and the CPU speed of each machine on each end of the PLIP link.
.LP
-If the single
-.B interface
+If the single
+.I interface
argument is given,
.B plipconfig
displays the status of the given interface
only. Otherwise, it will try to set the options.
.SH OPTIONS
.TP
-.B "nibble NN"
-Sets the nibble wait value in microseconds. Default is 3000.
+.BI nibble " NN"
+Sets the nibble wait value in microseconds.
+Default is 3000.
.TP
-.B "trigger NN"
-Sets the trigger wait value in microseconds. Default is 500.
+.BI trigger " NN"
+Sets the trigger wait value in microseconds.
+Default is 500.
.LP
PLIP speed can in some cases be improved by lowering the default values.
-Values which are too low may cause excess use of CPU, poor interrupt
-response time resulting in serial ports dropping characters, or in dropping
-of PLIP packets. Changing the plip MTU can also affect PLIP speed.
+Values which are too low may cause excess use of CPU,
+poor interrupt response time resulting in serial ports dropping characters,
+or in dropping of PLIP packets.
+Changing the plip MTU can also affect PLIP speed.
.SH NOTE
-If you get no response it is far more likely the irq is wrong and needs
-setting with ifconfig. The few cases where the default parameters will
-be too fast are those using very long cables. Something you should
-never do as the parallel port is not specified or designed for driving
-long cable runs.
+If you get no response
+it is far more likely the irq is wrong
+and needs setting with ifconfig.
+The few cases
+where the default parameters will be too fast
+are those using very long cables.
+Something you should never do
+as the parallel port is not specified or
+designed for driving long cable runs.
.SH SEE ALSO
.BR ifconfig (8)
.SH BUGS
