Package: libnss3-tools
Version: 2:3.109-1
Severity: minor
* 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?
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:349: warning: trailing space in the line
[...]
troff:<stdin>:879: 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.17-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-4
ii libnspr4 2:4.36-1
ii libnss3 2:3.109-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 modutil.1
Output from "mandoc -T lint modutil.1": (shortened list)
1 input text line longer than 80 bytes: (required) Gives a l...
1 input text line longer than 80 bytes: (required) gives the...
1 input text line longer than 80 bytes: (required) lists the...
1 input text line longer than 80 bytes: (required) names the...
1 input text line longer than 80 bytes: Add a new PKCS #11 m...
1 input text line longer than 80 bytes: Adding a PKCS #11 mo...
1 input text line longer than 80 bytes: Authors: Elio Maldon...
1 input text line longer than 80 bytes: Be sure that the app...
1 input text line longer than 80 bytes: Before any operation...
1 input text line longer than 80 bytes: BerkeleyDB has perfo...
1 input text line longer than 80 bytes: Both the install scr...
1 input text line longer than 80 bytes: Change the password ...
1 input text line longer than 80 bytes: Each module has info...
1 input text line longer than 80 bytes: Enable (true) or dis...
1 input text line longer than 80 bytes: For an engineering d...
1 input text line longer than 80 bytes: For example, the PKC...
1 input text line longer than 80 bytes: For information abou...
1 input text line longer than 80 bytes: Give a directory loc...
1 input text line longer than 80 bytes: In 2009, NSS introdu...
1 input text line longer than 80 bytes: Licensed under the M...
1 input text line longer than 80 bytes: Listing the modules ...
1 input text line longer than 80 bytes: Modules, and specifi...
1 input text line longer than 80 bytes: Multiple security mo...
1 input text line longer than 80 bytes: NSS originally used ...
1 input text line longer than 80 bytes: PKCS #11 modules can...
1 input text line longer than 80 bytes: Quotes and backslash...
1 input text line longer than 80 bytes: Some platforms may n...
1 input text line longer than 80 bytes: Specify a path to a ...
2 input text line longer than 80 bytes: Specify a text file ...
1 input text line longer than 80 bytes: Specify the database...
1 input text line longer than 80 bytes: Specify the root ins...
3 input text line longer than 80 bytes: Specify the security...
1 input text line longer than 80 bytes: The JAR installation...
1 input text line longer than 80 bytes: The NSS tools were w...
1 input text line longer than 80 bytes: The NSS wiki has inf...
1 input text line longer than 80 bytes: The module becomes a...
1 input text line longer than 80 bytes: The script is basic ...
1 input text line longer than 80 bytes: The script must defi...
1 input text line longer than 80 bytes: The tasks associated...
1 input text line longer than 80 bytes: This documentation i...
1 input text line longer than 80 bytes: always requires one ...
1 input text line longer than 80 bytes: arguments\&. The JAR...
1 input text line longer than 80 bytes: can add and delete P...
1 input text line longer than 80 bytes: can be used to creat...
1 input text line longer than 80 bytes: command with a colon...
1 input text line longer than 80 bytes: command with either ...
1 input text line longer than 80 bytes: command, only a modu...
1 input text line longer than 80 bytes: command, the passwor...
1 input text line longer than 80 bytes: command\&. For the c...
1 input text line longer than 80 bytes: command\&. This key ...
1 input text line longer than 80 bytes: command\&. This key\...
1 input text line longer than 80 bytes: database contains in...
1 input text line longer than 80 bytes: database type\&. The...
1 input text line longer than 80 bytes: directly or by runni...
1 input text line longer than 80 bytes: directory argument t...
1 input text line longer than 80 bytes: directory is created...
1 input text line longer than 80 bytes: displays detailed in...
1 input text line longer than 80 bytes: gives a list of plat...
2 input text line longer than 80 bytes: is a colon\-delimite...
1 input text line longer than 80 bytes: is not used, then th...
1 input text line longer than 80 bytes: is replaced at run t...
1 input text line longer than 80 bytes: is to hold executabl...
1 input text line longer than 80 bytes: list is checked for ...
1 input text line longer than 80 bytes: modutil \- Manage PK...
1 input text line longer than 80 bytes: must be specified\&....
1 input text line longer than 80 bytes: my_cert9\&.db\&. Thi...
1 input text line longer than 80 bytes: option\&. If no temp...
1 input text line longer than 80 bytes: option\&. This direc...
1 input text line longer than 80 bytes: pkcs11\&.txt, which ...
1 input text line longer than 80 bytes: returns details info...
1 input text line longer than 80 bytes: returns information ...
1 input text line longer than 80 bytes: sets permissions on ...
1 input text line longer than 80 bytes: specifies ciphers th...
1 input text line longer than 80 bytes: specifies mechanisms...
1 input text line longer than 80 bytes: specifies that the a...
1 input text line longer than 80 bytes: specifies that the f...
1 input text line longer than 80 bytes: specifies the destin...
1 input text line longer than 80 bytes: supports several mec...
10 skipping paragraph macro: PP after SH
-.-.
Output from "test-nroff -mandoc -t -ww -z modutil.1": (shortened list)
67 trailing space in the line
Remove trailing space with: sed -e 's/ *$//'
-.-.
Show if docman-to-man created this.
Who is actually creating this man page? Debian or upstream?
Is the generating software out of date?
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
67
-.-.
Move a full stop (period) and a comma outside of a quoted text, if it is
at the end of the quote and does not end a quoted sentence.
425:Organization, OU="VeriSign, Inc\&.", O=VeriSign Trust Network **ISSUER
428:OU="VeriSign, Inc\&.", O=VeriSign Trust Network
-.-.
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)
417
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
429
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
511
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
518 uri:
pkcs11:token=NSS%20Generic%20Crypto%20Services;manufacturer=Mozilla%20Foundation;serial=0000000000000000;model=NSS%203
522 uri:
pkcs11:token=NSS%20Certificate%20DB;manufacturer=Mozilla%20Foundation;serial=0000000000000000;model=NSS%203
523
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
539
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
598 name="NSS Internal PKCS #11 Module" parameters="configdir=\&. certPrefix=
keyPrefix= secmod=secmod\&.db flags=readOnly " NSS="trustOrder=75
cipherOrder=100
slotParams={0x00000001=[slotFlags=RSA,RC4,RC2,DES,DH,SHA1,MD5,MD2,SSL,TLS,AES,RANDOM
askpw=any timeout=30 ] } Flags=internal,critical"
1431 \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.
Longest line is: 473 characters.
Longest line is number 140 with 473 characters
arguments\&. The JAR file uses the NSS PKCS #11 JAR format to identify all the
files to be installed, the module\*(Aqs name, the mechanism flags, and the
cipher flags, as well as any files to be installed on the target machine,
including the PKCS #11 module library file and other files such as
documentation\&. This is covered in the JAR installation file section in the
man page, which details the special script needed to perform an installation
through a server or with
-.-.
Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".
modutil.1:53:always requires one (and only one) option to specify the type of
module operation\&. Each option may take arguments, anywhere from none to
multiple arguments\&.
modutil.1:234:supports several mechanisms: RSA, DSA, RC2, RC4, RC5, AES, DES,
DH, SHA1, SHA256, SHA512, SSL, TLS, MD5, MD2, RANDOM (for random number
generation), and FRIENDLY (meaning certificates are publicly readable)\&.
modutil.1:563: Login Type: Public (no login required)
modutil.1:606:Multiple security modules may provide support for the same
security mechanisms\&. It is possible to set a specific security module as the
default provider for a specific security mechanism (or, conversely, to prohibit
a provider from supplying those mechanisms)\&.
modutil.1:701:command with either a true or false flag (it doesn\*(Aqt matter
which)\&. The tool returns the current FIPS setting\&.
modutil.1:885:Quotes and backslashes must be escaped with a backslash\&. A
complex string must not include newlines or carriage returns\&.Outside of
complex strings, all white space (for example, spaces, tabs, and carriage
returns) is considered equal and is used only to delimit tokens\&.
modutil.1:963:LINUX (ppc, alpha, x86)
modutil.1:1196:specifies ciphers that this module provides that NSS does not
provide (so that the module enables those ciphers for NSS)\&. This is
equivalent to the
modutil.1:1229:is to hold executable files (such as setup programs) or files
that are used by these programs\&. Files destined for the temporary directory
are guaranteed to be in place before any executable file is run; they are not
deleted until all executable files have finished\&.
modutil.1:1430:For information about NSS and other tools related to NSS (like
JSS), check out the NSS project wiki at
-.-.
Use a character "\(->" instead of plain "->" or "\->".
862:\-\-> valuelist
864:valuelist \-\-> value valuelist
867:value \-\-\-> key_value_pair
870:key_value_pair \-\-> key { valuelist }
872:key \-\-> string
874:string \-\-> simple_string
877:simple_string \-\-> [^ \et\en\e""{""}"]+
879:complex_string \-\-> ([^\e"\e\e\er\en]|(\e\e\e")|(\e\e\e\e))+
-.-.
No need for '\&' to be in front of a period (.),
if there is a character in front of it.
Remove with "sed -e 's/\\&\././g'".
[List of affected lines removed.]
-.-.
Only one space character after a possible end of sentence
(after a punctuation, that can end a sentence).
[List of affected lines removed.]
-.-.
Put a subordinate sentence (after a comma) on a new line.
[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.
modutil.1:10:.TH "MODUTIL" "1" "19 May 2021" "nss-tools" "NSS Security Tools"
-.-.
Use ".na" (no adjustment) instead of ".ad l" (and ".ad" to begin the
same adjustment again as before).
26:.ad l
-.-.
Section headings (.SH and .SS) do not need quoting their arguments.
30:.SH "NAME"
32:.SH "SYNOPSIS"
35:.SH "STATUS"
39:.SH "DESCRIPTION"
49:.SH "OPTIONS"
321:.SH "USAGE AND EXAMPLES"
745:.SH "JAR INSTALLATION FILE FORMAT"
1259:.SH "NSS DATABASE TYPES"
1397:.SH "SEE ALSO"
1428:.SH "ADDITIONAL RESOURCES"
1436:.SH "AUTHORS"
1441:.SH "LICENSE"
1444:.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 line to reduce the posibility of
splitting the address between two output lines.
Or inhibit hyphenation with "\%" in front of the name.
1382:https://wiki\&.mozilla\&.org/NSS_Shared_DB_Howto
1395:https://wiki\&.mozilla\&.org/NSS_Shared_DB
1415:https://wiki\&.mozilla\&.org/NSS_Shared_DB_Howto
1426:https://wiki\&.mozilla\&.org/NSS_Shared_DB
1431:\m[blue]\fBhttp://www\&.mozilla\&.org/projects/security/pki/nss/\fR\m[]\&;.
The NSS site relates directly to NSS code changes and releases\&.
1433:Mailing lists: https://lists\&.mozilla\&.org/listinfo/dev\-tech\-crypto
1443: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/\&;.
1448:\%https://bugzilla.mozilla.org/show_bug.cgi?id=836477
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:349: warning: trailing space in the line
troff:<stdin>:361: warning: trailing space in the line
troff:<stdin>:363: warning: trailing space in the line
troff:<stdin>:381: warning: trailing space in the line
troff:<stdin>:382: warning: trailing space in the line
troff:<stdin>:383: warning: trailing space in the line
troff:<stdin>:384: warning: trailing space in the line
troff:<stdin>:385: warning: trailing space in the line
troff:<stdin>:386: warning: trailing space in the line
troff:<stdin>:387: warning: trailing space in the line
troff:<stdin>:388: warning: trailing space in the line
troff:<stdin>:389: warning: trailing space in the line
troff:<stdin>:390: warning: trailing space in the line
troff:<stdin>:391: warning: trailing space in the line
troff:<stdin>:392: warning: trailing space in the line
troff:<stdin>:393: warning: trailing space in the line
troff:<stdin>:394: warning: trailing space in the line
troff:<stdin>:395: warning: trailing space in the line
troff:<stdin>:396: warning: trailing space in the line
troff:<stdin>:397: warning: trailing space in the line
troff:<stdin>:398: warning: trailing space in the line
troff:<stdin>:399: warning: trailing space in the line
troff:<stdin>:400: warning: trailing space in the line
troff:<stdin>:416: warning: trailing space in the line
troff:<stdin>:417: warning: trailing space in the line
troff:<stdin>:419: warning: trailing space in the line
troff:<stdin>:428: warning: trailing space in the line
troff:<stdin>:429: warning: trailing space in the line
troff:<stdin>:431: warning: trailing space in the line
troff:<stdin>:432: warning: trailing space in the line
troff:<stdin>:433: warning: trailing space in the line
troff:<stdin>:434: warning: trailing space in the line
troff:<stdin>:435: warning: trailing space in the line
troff:<stdin>:437: warning: trailing space in the line
troff:<stdin>:438: warning: trailing space in the line
troff:<stdin>:439: warning: trailing space in the line
troff:<stdin>:440: warning: trailing space in the line
troff:<stdin>:442: warning: trailing space in the line
troff:<stdin>:476: warning: trailing space in the line
troff:<stdin>:496: warning: trailing space in the line
troff:<stdin>:508: warning: trailing space in the line
troff:<stdin>:516: warning: trailing space in the line
troff:<stdin>:520: warning: trailing space in the line
troff:<stdin>:542: warning: trailing space in the line
troff:<stdin>:543: warning: trailing space in the line
troff:<stdin>:549: warning: trailing space in the line
troff:<stdin>:551: warning: trailing space in the line
troff:<stdin>:556: warning: trailing space in the line
troff:<stdin>:557: warning: trailing space in the line
troff:<stdin>:558: warning: trailing space in the line
troff:<stdin>:566: warning: trailing space in the line
troff:<stdin>:568: warning: trailing space in the line
troff:<stdin>:573: warning: trailing space in the line
troff:<stdin>:574: warning: trailing space in the line
troff:<stdin>:575: warning: trailing space in the line
troff:<stdin>:612: warning: trailing space in the line
troff:<stdin>:626: warning: trailing space in the line
troff:<stdin>:657: warning: trailing space in the line
troff:<stdin>:723: warning: trailing space in the line
troff:<stdin>:733: warning: trailing space in the line
troff:<stdin>:735: warning: trailing space in the line
troff:<stdin>:736: warning: trailing space in the line
troff:<stdin>:737: warning: trailing space in the line
troff:<stdin>:738: warning: trailing space in the line
troff:<stdin>:739: warning: trailing space in the line
troff:<stdin>:877: warning: trailing space in the line
troff:<stdin>:879: warning: trailing space in the line
-.-.
Generally:
Split (sometimes) lines after a punctuation mark; before a conjunction.
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)
-.-
