Package: adduser
Version: 3.137
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with
[test-][gn]roff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z < "man page"
[test-groff is a script in the repository for "groff"] (local copy and
"troff" slightly changed by me).
* What was the outcome of this action?
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':60
troff:<stdin>:60: warning: [page 1, 2.8i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':61
troff:<stdin>:61: warning: [page 1, 2.9i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':62
troff:<stdin>:62: warning: [page 1, 3.1i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':63
troff:<stdin>:63: warning: [page 1, 3.3i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':64
troff:<stdin>:64: warning: [page 1, 3.4i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':65
troff:<stdin>:65: warning: [page 1, 3.6i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':66
troff:<stdin>:66: warning: [page 1, 3.8i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':67
troff:<stdin>:67: warning: [page 1, 3.9i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':68
troff:<stdin>:68: warning: [page 1, 4.1i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':237
troff:<stdin>:237: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':239
troff:<stdin>:239: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':241
troff:<stdin>:241: warning: trailing space in the line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':237
troff:<stdin>:237: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':239
troff:<stdin>:239: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':241
troff:<stdin>:241: 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.10.9-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 adduser depends on:
ii passwd 1:4.16.0-4
adduser recommends no packages.
Versions of packages adduser suggests:
ii cron 3.0pl1-189
ii liblocale-gettext-perl 1.07-7
ii perl 5.38.2-5
pn quota <none>
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <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 outputs 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 deluser.8": (possibly shortened list)
mandoc: deluser.8:13:15: WARNING: missing date, using "": TH
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended. An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (end of options) then use "\-\-".
deluser.8:198:Synonymous to --stdoutmsglevel=debug. Deprecated.
deluser.8:211:Valid Modes: \fBdeluser --group\fP, \fBdelgroup\fP,
deluser.8:214:Synonymous to --stdoutmsglevel=warn. Deprecated.
deluser.8:235:Synonymous to --stdoutmsglevel=info. Deprecated.
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
198:Synonymous to --stdoutmsglevel=debug. Deprecated.
211:Valid Modes: \fBdeluser --group\fP, \fBdelgroup\fP,
214:Synonymous to --stdoutmsglevel=warn. Deprecated.
235:Synonymous to --stdoutmsglevel=info. Deprecated.
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
180:.BR "\-\-backup\-suffix "str
186:.BI "\-\-backup\-to "dir
192:.BR "\-\-conf \fIfile\fP"
197:.BR \-\-debug
273:.IR /etc/deluser.conf
276:.IR /usr/local/sbin/deluser.local
-.-.
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.
198:Synonymous to --stdoutmsglevel=debug. Deprecated.
211:Valid Modes: \fBdeluser --group\fP, \fBdelgroup\fP,
214:Synonymous to --stdoutmsglevel=warn. Deprecated.
235:Synonymous to --stdoutmsglevel=info. Deprecated.
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7)).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
136:to any suffix supported by \fBtar \-\-auto\-compress\fP (e.g. .gz, .bz2,
.xz).
-.-.
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.
136:to any suffix supported by \fBtar \-\-auto\-compress\fP (e.g. .gz, .bz2,
.xz).
198:Synonymous to --stdoutmsglevel=debug. Deprecated.
214:Synonymous to --stdoutmsglevel=warn. Deprecated.
235:Synonymous to --stdoutmsglevel=info. Deprecated.
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':60
troff:<stdin>:60: warning: [page 1, 2.8i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':61
troff:<stdin>:61: warning: [page 1, 2.9i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':62
troff:<stdin>:62: warning: [page 1, 3.1i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':63
troff:<stdin>:63: warning: [page 1, 3.3i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':64
troff:<stdin>:64: warning: [page 1, 3.4i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':700: macro 'RB'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':769: macro 'OP'
troff: backtrace: file '<stdin>':65
troff:<stdin>:65: warning: [page 1, 3.6i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':66
troff:<stdin>:66: warning: [page 1, 3.8i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':67
troff:<stdin>:67: warning: [page 1, 3.9i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':715: macro 'RI'
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':767: macro 'OP'
troff: backtrace: file '<stdin>':68
troff:<stdin>:68: warning: [page 1, 4.1i]: cannot break line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':237
troff:<stdin>:237: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':239
troff:<stdin>:239: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':241
troff:<stdin>:241: warning: trailing space in the line
Output from "test-nroff -mandoc -t -K utf8 -rF0 -rHY=0 -ww -b -z ":
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':237
troff:<stdin>:237: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':239
troff:<stdin>:239: warning: trailing space in the line
troff: backtrace: '/home/bg/git/groff/build/s-tmac/an.tmac':640: macro 'BI'
troff: backtrace: file '<stdin>':241
troff:<stdin>:241: warning: trailing space in the line
-.-.
Additionally (general):
Abbreviations get a '\&' added after their final full stop (.) to mark them as
such and not as an end of sentence.
There is no need to add a '\&' before a full stop (.) if it has a character
before it!
--- deluser.8 2024-09-26 01:54:35.727322323 +0000
+++ deluser.8.new 2024-09-26 02:20:26.889032932 +0000
@@ -29,6 +29,7 @@ deluser, delgroup \- remove a user or gr
.OP \-\-logmsglevel prio
.B user
.YS
+
.SY deluser
.OP \-\-system
.OP \-\-backup
@@ -45,6 +46,7 @@ deluser, delgroup \- remove a user or gr
.OP \-\-logmsglevel prio
.B user
.YS
+
.SY deluser
.B \-\-group
.OP \-\-conf file
@@ -56,6 +58,8 @@ deluser, delgroup \- remove a user or gr
.OP \-\-stderrmsglevel prio
.OP \-\-logmsglevel prio
.B group
+.YS
+
.SY delgroup
.OP \-\-system
.OP \-\-conf file
@@ -68,6 +72,7 @@ deluser, delgroup \- remove a user or gr
.OP \-\-logmsglevel prio
.B group
.YS
+
.SY deluser
.OP \-\-conf file
.OP \-\-debug
@@ -79,9 +84,11 @@ deluser, delgroup \- remove a user or gr
.B user
.B group
.YS
+
.SY deluser
.B \-\-help
.YS
+
.SY deluser
.B \-\-version
.YS
@@ -133,7 +140,7 @@ By default,
the backup archive is compressed with \fBgzip\fP(1).
To change this,
the \fB\-\-backup\-suffix\fP option can be set
-to any suffix supported by \fBtar \-\-auto\-compress\fP (e.g. .gz, .bz2, .xz).
+to any suffix supported by \fBtar \-\-auto\-compress\fP (e.g., .gz, .bz2, .xz).
.PP
\fBdeluser\fP will refuse to remove the root account.
.PP
@@ -177,25 +184,26 @@ Backup all files contained in the userho
to a file named \fIusername.tar.bz2\fP or \fIusername.tar.gz\fP.
Valid Modes: \fBdeluser\fP, \fBdeluser \-\-system\fP,
.TP
-.BR "\-\-backup\-suffix "str
+.BR "\-\-backup\-suffix " str
Select compression algorithm for a home directory backup.
Can be set to any suffix recognized by \fBtar \-\-auto\-compress\fP.
Defaults to \fI.gz\fP.
Valid Modes: \fBdeluser\fP, \fBdeluser \-\-system\fP,
.TP
-.BI "\-\-backup\-to "dir
+.BI "\-\-backup\-to " dir
Place the backup files not in the current directory but in \fIdir\fP.
This implicitly sets \fB\-\-backup\fP also.
(defaulting to the current working directory).
Valid Modes: \fBdeluser\fP, \fBdeluser \-\-system\fP,
.TP
-.BR "\-\-conf \fIfile\fP"
+.B "\-\-conf \fIfile\fP"
Use \fIfile\fP instead of the default files
\fI/etc/deluser.conf\fP and \fI/etc/adduser.conf\fP.
Multiple \-\-conf options may be given.
.TP
-.BR \-\-debug
-Synonymous to --stdoutmsglevel=debug. Deprecated.
+.B \-\-debug
+Synonymous to \-\-stdoutmsglevel=debug.
+Deprecated.
.TP
.B \-\-group
Remove a group.
@@ -208,10 +216,11 @@ Display brief instructions.
.TP
.B \-\-only\-if\-empty
Only remove if no members are left.
-Valid Modes: \fBdeluser --group\fP, \fBdelgroup\fP,
+Valid Modes: \fBdeluser \-\-group\fP, \fBdelgroup\fP,
.TP
.B \-\-quiet
-Synonymous to --stdoutmsglevel=warn. Deprecated.
+Synonymous to \-\-stdoutmsglevel=warn.
+Deprecated.
.TP
.B \-\-remove\-all\-files
Remove all files from the system owned by this user.
@@ -232,13 +241,14 @@ If the user does not exist, no error val
Valid Modes: \fBdeluser\fP, \fBdeluser \-\-system\fP,
.TP
.B \-\-verbose
-Synonymous to --stdoutmsglevel=info. Deprecated.
+Synonymous to \-\-stdoutmsglevel=info.
+Deprecated.
.TP
-.BI \-\-stdoutmsglevel " prio "
+.BI \-\-stdoutmsglevel " prio"
.TQ
-.BI \-\-stderrmsglevel " prio "
+.BI \-\-stderrmsglevel " prio"
.TQ
-.BI \-\-logmsglevel " prio "
+.BI \-\-logmsglevel " prio"
Minimum priority for messages logged to syslog/journal and the console,
respectively.
Values are
@@ -270,10 +280,10 @@ consider writing your own wrapper script
and giving privileges to execute that script.
.SH FILES
-.IR /etc/deluser.conf
+.I /etc/deluser.conf
Default configuration file for \fBdeluser\fP(8) and \fBdelgroup\fP(8)
.TP
-.IR /usr/local/sbin/deluser.local
+.I /usr/local/sbin/deluser.local
Optional custom add-ons, see
.BR deluser.local (8)
.
