Package: net-tools
Version: 2.10-1.1
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>:53: warning: trailing space in the line
troff:<stdin>:62: warning: trailing space in the line
troff:<stdin>:75: 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.12-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-7
ii libselinux1 3.8-3
net-tools recommends no packages.
net-tools suggests no packages.
-- no debconf information
Input file is slattach.8
Output from "mandoc -T lint slattach.8": (shortened list)
1 input text line longer than 80 bytes: (a protocol used for...
2 skipping paragraph macro: br at the end of SH
3 whitespace at end of input line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Output from "test-groff -mandoc -t -ww -z slattach.8": (shortened list)
3 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
3
-.-.
Add a "\&" (or a comma (Oxford comma)) after "e.g." and "i.e.",
or use English words
(man-pages(7)).
Abbreviation points should be marked as such and protected against being
interpreted as an end of sentence, if they are not, and that independent
of the current place on the line.
60:i.e. compressed SLIP. Other possible values are
-.-.
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 "\&".
Some sentences (etc.) do not begin on a new line.
Split (sometimes) lines after a punctuation mark; before a conjunction.
N.B.
The number of lines affected can be too large to be in a patch.
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.]
-.-
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.
Add "\:" to split the string for the output, "\<newline>" in the source.
Line 69, length 86
(a protocol used for communicating with AX.25 packet radio terminal node
controllers).
-.-.
Use \(en (en-dash) for a dash at the beginning (end) of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
slattach.8:37:Operate in quiet mode - no messages at all.
-.-.
Use a hyphen between a number and the unit (name) "bit",
see "man-pages(7)", item "Terms to avoid".
46:Do \fBnot\fP initialize the line into 8 bits raw mode.
-.-.
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.
1:.TH SLATTACH 8 "2011\-12\-31" "net\-tools" "Linux System Administrator's
Manual"
25:.B "[\-d]"
29:.B "[\-h]"
33:.B "[\-v]"
36:.B "[\-q]"
39:.B "[\-l]"
42:.B "[\-n]"
45:.B "[\-m]"
48:.B "[\-e]"
52:.B "[\-L]"
59:.BR "cslip" ,
61:.B "slip"
63:.B "adaptive"
65:.B "ppp"
68:.B "kiss"
71:.B "tty"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:53: warning: trailing space in the line
troff:<stdin>:62: warning: trailing space in the line
troff:<stdin>:75: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- slattach.8 2025-02-27 17:34:17.044118496 +0000
+++ slattach.8.new 2025-02-27 18:13:05.433096814 +0000
@@ -1,9 +1,9 @@
-.TH SLATTACH 8 "2011\-12\-31" "net\-tools" "Linux System Administrator's
Manual"
+.TH SLATTACH 8 2011\-12\-31 net\-tools "Linux System Administrator's Manual"
.SH NAME
slattach \- attach a network interface to a serial line
.SH SYNOPSIS
-.B "slattach [\-dehlLmnqv] [\-c command] [\-p proto] [\-s speed] [tty]"
-.br
+.BR slattach " [" \-dehlLmnqv "] [" \-c " \fIcommand\fP] [" \-p \
+" \fIproto\fP] [" \-s " \fIspeed\fP] [" \fItty\fR]
.SH DESCRIPTION
.B Slattach
is a tiny little program that can be used to put a normal terminal
@@ -16,74 +16,75 @@ Path to a serial device like
.IR /dev/ttyS* ", " /dev/cua* " or " /dev/ptmx
to spawn a new pseudo tty.
.TP
-.B "[\-c command]"
+.RB [ \-c " \fIcommand\fR]"
Execute
-.B command
+.I command
when the line is hung up. This can be used to run scripts or re-establish
connections when a link goes down.
.TP
-.B "[\-d]"
+.RB [ \-d ]
Enable debugging output. Useful when determining why a given
setup doesn't work.
.TP
-.B "[\-h]"
+.RB [ \-h ]
Exit when the carrier is lost. This works on both /dev/tty and /dev/cua
devices by directly monitoring the carrier status every 15 seconds.
.TP
-.B "[\-v]"
+.RB [ \-v ]
Enable verbose output. Useful in shell scripts.
.TP
-.B "[\-q]"
-Operate in quiet mode - no messages at all.
+.RB [ \-q ]
+Operate in quiet mode \(en no messages at all.
.TP
-.B "[\-l]"
+.RB [ \-l ]
Create an UUCP-style lockfile for the device in /var/lock.
.TP
-.B "[\-n]"
+.RB [ \-n ]
Equivalent to the "mesg n" command.
.TP
-.B "[\-m]"
-Do \fBnot\fP initialize the line into 8 bits raw mode.
+.RB [ \-m ]
+Do \fBnot\fP initialize the line into 8-bit raw mode.
.TP
-.B "[\-e]"
+.RB [ \-e ]
Exit right after initializing device, instead of waiting for the
line to hang up.
.TP
-.B "[\-L]"
-Enable 3 wire operation. The terminal is moved into CLOCAL mode,
+.RB [ \-L ]
+Enable 3 wire operation. The terminal is moved into CLOCAL mode,
carrier watching is disabled.
.TP
-.B "[\-p proto]"
+.RB [ \-p " \fIproto\fR]"
Set a specific kind of protocol to use on the line. The default
is set to
-.BR "cslip" ,
-i.e. compressed SLIP. Other possible values are
-.B "slip"
-(normal SLIP),
-.B "adaptive"
+.BR cslip ,
+i.e.\& compressed SLIP. Other possible values are
+.B slip
+(normal SLIP),
+.B adaptive
(adaptive CSLIP/SLIP),
-.B "ppp"
+.B ppp
(Point-to-Point Protocol)
and
-.B "kiss"
-(a protocol used for communicating with AX.25 packet radio terminal node
controllers).
+.B kiss
+(a protocol used for communicating with AX.25 packet radio terminal node
+controllers).
The special argument
-.B "tty"
+.B tty
can be used to put the device back into normal serial operation.
Using 'ppp' mode is not normally useful as ppp requires an additional ppp
daemon
.B pppd
-to be active on the line. For kiss connections the
+to be active on the line. For kiss connections the
.B kissattach
program should be used.
.TP
-.B "[\-s speed]"
+.RB [ \-s " \fIspeed\fR]"
Set a specific line speed, other than the default.
.PP
If no arguments are given, the current terminal line (usually: the
login device) is used. Otherwise, an attempt is made to claim the
indicated terminal port, lock it, and open it.
.SH FILES
-.I /dev/cua* /var/lock/LCK.* /dev/ttyS* /dev/ptmx
+.IR /dev/cua* ", " /var/lock/LCK.* ", " /dev/ttyS* ", " /dev/ptmx
.SH BUGS
None known.
.SH SEE ALSO
@@ -92,7 +93,7 @@ None known.
.BR pppd (8),
.BR sliplogin (8)
.SH AUTHORS
-Fred N. van Kempen, <[email protected]>
+Fred N.\& van Kempen, <[email protected]>
.br
Alan Cox, <[email protected]>
.br
@@ -101,4 +102,3 @@ Miquel van Smoorenburg, <miquels@drinkel
George Shearer, <[email protected]>
.br
Yossi Gottlieb, <[email protected]>
-.br
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)
-.-
