Package: expect
Version: 5.45.4-3+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 -ww -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?
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:36: warning: trailing space in the line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:36: 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.10-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 expect depends on:
ii libc6 2.40-4
ii libtcl8.6 8.6.15+dfsg-2
ii tcl-expect 5.45.4-3+b1
ii tcl8.6 8.6.15+dfsg-2
expect recommends no packages.
Versions of packages expect suggests:
ii tk8.6 8.6.15-1
-- no debconf information
Input file is expect_mkpasswd.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 expect_mkpasswd.1": (shortened list)
3 input text line longer than 80 bytes
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z expect_mkpasswd.1": (shortened list)
1 trailing space in the line
-.-.
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 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.
39: mkpasswd -l 20
47: mkpasswd -d 3
85: mkpasswd -l 15 -d 3 -C 5
-.-.
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 51, length 96
flag defines the minimum number of lowercase alphabetic characters that must be
in the password.
Line 56, length 96
flag defines the minimum number of uppercase alphabetic characters that must be
in the password.
Line 61, length 83
flag defines the minimum number of special characters that must be in the
password.
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
Not considered in a patch, too many lines.
expect_mkpasswd.1:72:right and left hands (qwerty-style), making it harder for
anyone
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
an.tmac:<stdin>:1: style: .TH missing fourth argument; consider package/project
name and version (e.g., "groff 1.23.0")
troff:<stdin>:36: warning: trailing space in the line
-.-.
Remove an excessive '.I' line
-,-
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them
as such and not as an end of a sentence.
--- expect_mkpasswd.1 2024-12-18 03:47:44.238954406 +0000
+++ expect_mkpasswd.1.new 2024-12-18 04:01:33.729501638 +0000
@@ -3,7 +3,6 @@
mkpasswd \- generate new password, optionally apply it to a user
.SH SYNOPSIS
.B mkpasswd
-.I
[
.I args
]
@@ -33,10 +32,11 @@ The passwords are randomly generated acc
.SH FLAGS
The
.B \-l
-flag defines the length of the password. The default is 9.
+flag defines the length of the password.
+The default is 9.
The following example creates a 20 character password.
- mkpasswd -l 20
+ mkpasswd \-l 20
The
.B \-d
@@ -44,21 +44,24 @@ flag defines the minimum number of digit
The default is 2. The following example creates a password with at least
3 digits.
- mkpasswd -d 3
+ mkpasswd \-d 3
The
.B \-c
-flag defines the minimum number of lowercase alphabetic characters that must
be in the password.
+flag defines the minimum number of lowercase alphabetic characters
+that must be in the password.
The default is 2.
The
.B \-C
-flag defines the minimum number of uppercase alphabetic characters that must
be in the password.
+flag defines the minimum number of uppercase alphabetic characters
+that must be in the password.
The default is 2.
The
.B \-s
-flag defines the minimum number of special characters that must be in the
password.
+flag defines the minimum number of special characters
+that must be in the password.
The default is 1.
The
@@ -69,9 +72,10 @@ By default, /etc/yppasswd is used if pre
The
.B \-2
flag causes characters to be chosen so that they alternate between
-right and left hands (qwerty-style), making it harder for anyone
-watching passwords being entered. This can also make it easier for
-a password-guessing program.
+right and left hands
+(qwerty-style),
+making it harder for anyone watching passwords being entered.
+This can also make it easier for a password-guessing program.
The
.B \-v
@@ -82,7 +86,7 @@ By default, it is suppressed.
The following example creates a 15-character password
that contains at least 3 digits and 5 uppercase characters.
- mkpasswd -l 15 -d 3 -C 5
+ mkpasswd \-l 15 \-d 3 \-C 5
.SH SEE ALSO
.I
