Package: init-system-helpers
Version: 1.66
Severity: minor
Dear Maintainer,
here are some notes about fixes for the manual.
The man page is created be Man::Pod. The source file and the processing
command may need to be fixed.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
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 -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint deb-systemd-helper.1p": (possibly shortened list)
mandoc: deb-systemd-helper.1p:89:82: STYLE: input text line longer than 80
bytes: The \*(L"enable\*(R"...
mandoc: deb-systemd-helper.1p:90:86: STYLE: input text line longer than 80
bytes: package). On the fir...
mandoc: deb-systemd-helper.1p:93:85: STYLE: input text line longer than 80
bytes: The \*(L"mask\*(R" a...
mandoc: deb-systemd-helper.1p:96:87: STYLE: input text line longer than 80
bytes: The \*(L"was-enabled...
mandoc: deb-systemd-helper.1p:100:87: STYLE: input text line longer than 80
bytes: The \*(L"debian-inst...
mandoc: deb-systemd-helper.1p:109:86: STYLE: input text line longer than 80
bytes: systemd unit files. ...
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
104:\&\fBdeb-systemd-helper\fR's state file, removing obsolete entries (e.g.
service
-.-.
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.
104:\&\fBdeb-systemd-helper\fR's state file, removing obsolete entries (e.g.
service
105:files that are no longer shipped by the package) and adding new entries
(e.g.
-.-.
Wrong distance between sentences.
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.
90:package). On the first \*(L"enable\*(R", a state file is created which will
be deleted
98:updated service file. See http://bugs.debian.org/717603 for details.
100:The \*(L"debian-installed\*(R" action is also not present in systemctl. It
returns 0 if
103:The \*(L"update-state\*(R" action is also not present in systemctl. It
updates
104:\&\fBdeb-systemd-helper\fR's state file, removing obsolete entries (e.g.
service
109:systemd unit files. It is specifically \s-1NOT\s0 intended to be used
interactively by
110:users. Instead, users should run systemd and use systemctl, or not bother
about
117:messages to stderr (thus visible in dpkg runs). Please include these when
-.-.
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.
deb-systemd-helper.1p: line 83 length 161
\&\fBdeb-systemd-helper\fR enable | disable | purge | mask | unmask |
is-enabled | was-enabled | debian-installed | update-state | reenable \fIunitÂ
file\fRÂ ...
deb-systemd-helper.1p: line 86 length 81
\&\fBdeb-systemd-helper\fR is a Debian-specific helper script which
re-implements
deb-systemd-helper.1p: line 89 length 82
The \*(L"enable\*(R" action will only be performed once (when first installing
the
deb-systemd-helper.1p: line 90 length 86
package). On the first \*(L"enable\*(R", a state file is created which will be
deleted
deb-systemd-helper.1p: line 93 length 85
The \*(L"mask\*(R" action will keep state on whether the service was
enabled/disabled
deb-systemd-helper.1p: line 96 length 87
The \*(L"was-enabled\*(R" action is not present in systemctl, but is required
in Debian
deb-systemd-helper.1p: line 100 length 87
The \*(L"debian-installed\*(R" action is also not present in systemctl. It
returns 0 if
deb-systemd-helper.1p: line 109 length 86
systemd unit files. It is specifically \s-1NOT\s0 intended to be used
interactively by
-.-.
Do not use "\s0" in a string definition but an absolute number,
as the size of the string could be changed.
Then a situation of "\s+X...\s+Y...\s0...\s0" could emerge.
Type size changes have an effect in "groff", but not in "nroff".
25:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-.-.
Add a zero (0) in front of a decimal fraction that begins with a period
(.)
6:.if t .sp .5v
-.-.
Bad use of \s0 in a string definition, the string could be resized.
25:.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.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 init-system-helpers depends on:
ii usr-is-merged 39
ii usrmerge [usr-is-merged] 39
init-system-helpers recommends no packages.
init-system-helpers suggests no packages.
Versions of packages init-system-helpers is related to:
ii insserv 1.24.0-2
-- no debconf information
