Package: libnss3-tools
Version: 2:3.114-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
grep -n -e ' $' -e '\\~$' -e ' \\f.$' -e ' \\"' <file>
to find (most) 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?
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:281: warning: trailing space in the line
troff:<stdin>:294: warning: trailing space in the line
troff:<stdin>:307: warning: trailing space in the line
troff:<stdin>:320: warning: trailing space in the line
troff:<stdin>:346: warning: trailing space in the line
troff:<stdin>:359: 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: 13.0
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.38+deb13-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 libnss3-tools depends on:
ii libc6 2.41-12
ii libnspr4 2:4.36-1
ii libnss3 2:3.114-1
ii zlib1g 1:1.3.dfsg+really1.3.1-1+b1
libnss3-tools recommends no packages.
libnss3-tools suggests no packages.
-- no debconf information
Input file is crlutil.1
Output from "mandoc -T lint crlutil.1": (shortened list)
40 STYLE: input text line longer than 80 bytes:
9 WARNING: skipping paragraph macro: PP after SH
1 WARNING: skipping paragraph macro: PP empty
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Output from
test-nroff -mandoc -t -ww -z crlutil.1: (shortened list)
6 line(s) with a trailing space
Find most trailing spaces with:
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
-.-.
Show if docman-to-man created this.
4:.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.-.
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
13
-.-.
Strings longer than 3/4 of a standard line length (80).
Use "\:" to split the string at the end of an output line, for example a
long URL (web address).
This is a groff extension.
371 \m[blue]\fBhttp://www\&.mozilla\&.org/projects/security/pki/nss/\fR\m[]\&;.
The NSS site relates directly to NSS code changes and releases\&.
-.-.
Wrong distance (not two spaces) 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.
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.
[List of affected lines removed.]
Longest line is number 196 with 300 characters
range: two integer values separated by dash: range of certificates that will be
added by this command\&. dash is used as a delimiter\&. Only one cert will be
added if there is no delimiter\&. date: revocation date of a cert\&. Date
should be represented in GeneralizedTime format (YYYYMMDDhhmmssZ)\&.
-.-.
The name of a man page is typeset in bold and the section in roman
(see man-pages(7)).
367:certutil(1)
-.-.
Name of a manual is set in bold, the section in roman.
See man-pages(7).
367:certutil(1)
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
crlutil.1:44:The key and certificate management process generally begins with
creating keys in the key database, then generating and managing certificates in
the certificate database(see certutil tool) and continues with certificates
expiration or revocation\&.
crlutil.1:116:Specify the database directory containing the certificate and key
database files\&. On Unix the Certificate Database Tool defaults to
$HOME/\&.netscape (that is, ~/\&.netscape)\&. On Windows NT the default is the
current directory\&.
crlutil.1:148:Specify the prefix used on the NSS security database files (for
example, my_cert8\&.db and my_key3\&.db)\&. This option is provided as a
special case\&. Changing the names of the certificate and key databases is not
recommended\&.
crlutil.1:230:The issuer alternative names extension allows additional
identities to be associated with the issuer of the CRL\&. Defined options
include an rfc822 name (electronic mail address), a DNS name, an IP address,
and a URI\&.
crlutil.1:370:For information about NSS and other tools related to NSS (like
JSS), check out the NSS project wiki at
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\(.\)\\&\./\1./g'".
[List of affected lines removed.]
-.-.
Only one space character is after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
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.
crlutil.1:10:.TH "CRLUTIL" "1" "19 May 2021" "nss-tools" "NSS Security Tools"
crlutil.1:30:.SH "NAME"
crlutil.1:32:.SH "SYNOPSIS"
crlutil.1:35:.SH "STATUS"
crlutil.1:39:.SH "DESCRIPTION"
crlutil.1:269:.SH "USAGE"
crlutil.1:376:.SH "AUTHORS"
crlutil.1:381:.SH "LICENSE"
crlutil.1:384:.SH "NOTES"
-.-.
Remove excessive "\&" when it has no functional purpose.
38:\m[blue]\fBMozilla NSS bug 836477\fR\m[]\&\s-2\u[1]\d\s+2
-.-.
Use "\-" instead of "-" in web addresses.
16:.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
-.-.
Put a (long) web address on a new output line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
371:\m[blue]\fBhttp://www\&.mozilla\&.org/projects/security/pki/nss/\fR\m[]\&;.
The NSS site relates directly to NSS code changes and releases\&.
373:Mailing lists: https://lists\&.mozilla\&.org/listinfo/dev\-tech\-crypto
383:Licensed under the Mozilla Public License, v\&. 2\&.0\&. If a copy of the
MPL was not distributed with this file, You can obtain one at
http://mozilla\&.org/MPL/2\&.0/\&;.
388:\%https://bugzilla.mozilla.org/show_bug.cgi?id=836477
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=0 -ww -z ":
troff:<stdin>:281: warning: trailing space in the line
troff:<stdin>:294: warning: trailing space in the line
troff:<stdin>:307: warning: trailing space in the line
troff:<stdin>:320: warning: trailing space in the line
troff:<stdin>:346: warning: trailing space in the line
troff:<stdin>:359: warning: trailing space in the line
-.-
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
--- crlutil.1 2025-08-12 23:09:42.822802969 +0000
+++ crlutil.1.new 2025-08-12 23:17:26.653233728 +0000
@@ -278,7 +278,7 @@ See "Implemented extensions" for more in
.RS 4
.\}
.nf
-crlutil \-G|\-M \-c crl\-gen\-file \-n nickname [\-i crl] [\-u url] [\-d
keydir] [\-P dbprefix] [\-l alg] [\-a] [\-B]
+crlutil \-G|\-M \-c crl\-gen\-file \-n nickname [\-i crl] [\-u url] [\-d
keydir] [\-P dbprefix] [\-l alg] [\-a] [\-B]
.fi
.if n \{\
@@ -291,7 +291,7 @@ crlutil \-G|\-M \-c crl\-gen\-file \-n n
.RS 4
.\}
.nf
- crlutil \-L [\-n crl\-name] [\-d krydir]
+ crlutil \-L [\-n crl\-name] [\-d krydir]
.fi
.if n \{\
@@ -304,7 +304,7 @@ crlutil \-G|\-M \-c crl\-gen\-file \-n n
.RS 4
.\}
.nf
- crlutil \-D \-n nickname [\-d keydir] [\-P dbprefix]
+ crlutil \-D \-n nickname [\-d keydir] [\-P dbprefix]
.fi
.if n \{\
@@ -317,7 +317,7 @@ crlutil \-G|\-M \-c crl\-gen\-file \-n n
.RS 4
.\}
.nf
- crlutil \-E [\-d keydir] [\-P dbprefix]
+ crlutil \-E [\-d keydir] [\-P dbprefix]
.fi
.if n \{\
@@ -343,7 +343,7 @@ crlutil \-G|\-M \-c crl\-gen\-file \-n n
.RS 4
.\}
.nf
- crlutil \-E [\-d keydir] [\-P dbprefix]
+ crlutil \-E [\-d keydir] [\-P dbprefix]
.fi
.if n \{\
@@ -356,7 +356,7 @@ crlutil \-G|\-M \-c crl\-gen\-file \-n n
.RS 4
.\}
.nf
- crlutil \-I \-i crl [\-t crlType] [\-u url] [\-d keydir] [\-P
dbprefix] [\-B]
+ crlutil \-I \-i crl [\-t crlType] [\-u url] [\-d keydir] [\-P
dbprefix] [\-B]
.fi
.if n \{\
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>
To find trailing space use
grep -n -e ' $' -e ' \\f.$' -e ' \\"' <man page>
The same goes for man pages that are used as an input.
-.-
For a style guide use
mandoc -T lint
-.-
For general input conventions consult the man page "nroff(7)" (item
"Input conventions") or the Texinfo manual about the same item.
-.-
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)
-.-
