Bug#919610: insserv.8: Corrections of formatting and macro use in the manual
Bjarni Ingi Gislason
bjarniig at rhi.hi.is
Fri Jan 18 01:31:18 GMT 2019
Package: insserv
Version: 1.18.0-1
Severity: minor
Tags: patch
Dear Maintainer,
Input file is insserv.8
mandoc: insserv.8:104:28: STYLE: whitespace at end of input line
mandoc: insserv.8:127:46: STYLE: whitespace at end of input line
mandoc: insserv.8:21:15: STYLE: normalizing date format to: July 29, 2008
mandoc: insserv.8:52:2: WARNING: skipping paragraph macro: PP empty
mandoc: insserv.8:331:2: WARNING: empty block: RS
#######
<insserv.8>:291 (macro IR): only 1 argument, but more are expected
<insserv.8>:304 (macro IR): only 1 argument, but more are expected
<insserv.8>:306 (macro IR): only 1 argument, but more are expected
<insserv.8>:335 (macro BR): only 1 argument, but more are expected
####
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
insserv.8:410:2000\-2009 Werner Fink,
insserv.8:414:2000\-2003 SuSE GmbH Nuernberg, Germany,
insserv.8:416:2007\-2009 SuSE Linux Products GmbH Nuernberg, Germany.
insserv.8:418:2018\- Jesse Smith
#####
Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).
360: $.#%_+-\\*[]^:()~
#####
Split a punctuation mark from a single argument for a two-fonts marco
335:.BR insserv:
#####
Do'nt use ".in +7", as the default indent is different in nroff and groff.
The default unit is 'm', while 'n' is used in the man-macros.
#####
Adjust space between sentences to two space characters (default in
roff). This space can be changed in the output with the '.ss' request
in "groff".
Patch:
--- insserv.8 2018-12-12 22:32:47.000000000 +0000
+++ insserv.8.new 2019-01-17 22:50:06.000000000 +0000
@@ -18,7 +18,7 @@
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\"
-.TH INSSERV 8 "Jul 29, 2008" "Version 1.11"
+.TH INSSERV 8 "July 29, 2008" "Version 1.11"
.UC 8
.SH NAME
insserv \- boot sequence organizer using LSB init.d script dependency information
@@ -32,11 +32,15 @@ insserv \- boot sequence organizer using
.RB [ \-f ]
.RI [[ / ] path/to/init.d/ ] script \ ...
.PP
+.\" avoid excessive space between words in troff caused by a long text string
+.nr AD \n(.j
+.ad l
.B insserv
.RB [ \-v ]
.RB [ \-c\ <config> ]
.RB [ \-p\ <path> ]
.RI [[ / ] path/to/init.d/ ] script [ ,start=<lvl1,lvl2,...>,stop=<lvl1,lvl2,...> ]
+.ad \n(AD
.PP
.B insserv
.RB [ \-v ]
@@ -49,7 +53,6 @@ insserv \- boot sequence organizer using
.PP
.B insserv
.B \-h
-.PP
.SH DESCRIPTION
.B insserv
is a low level tool used by
@@ -76,7 +79,7 @@ init script (`boot script') by reading t
.fi
.in -1l
.sp 1
-and calculating the dependencies between all scripts. It is not recommended to
+and calculating the dependencies between all scripts. It is not recommended to
execute insserv directly unless you know exactly what you're doing, doing so
may render your boot system inoperable.
.B update\-rc.d
@@ -101,9 +104,9 @@ tag. Same holds true for
.in -1l
.sp 1
which declares facilities which should be available during shutdown of
-the service declared in the
+the service declared in the
.B Provides
-tag. In both cases the script system should avoid stopping services
+tag. In both cases the script system should avoid stopping services
which are declared by these two Stop tags until the script including
these tags is stopped.
.PP
@@ -123,8 +126,8 @@ Whereas the optional
keyword implies that the script using this keyword
should be stopped
.B after
-the specified service names. Both implies that those
-services now depend on the specifying script.
+the specified service names. Both implies that those
+services now depend on the specifying script.
With known dependencies and runlevel(s)
.B insserv
sets and reorders the corresponding symbolic links
@@ -184,7 +187,7 @@ and ending with
are keywords. Currently
.B <interactive>
is the only know keyword for marking a service
-as an interactive one, e.g. a service which requires
+as an interactive one, e.g., a service which requires
a passphrase or password input during boot
or runlevel change. The special facility
.B $null
@@ -228,7 +231,7 @@ Specify path to init.d directory. Usefu
Do not update symlinks.
.TP
.BR \-s ,\ \-\-showall, \ \-\-show\-all
-Output runlevel and sequence information. Do not update symlinks.
+Output runlevel and sequence information. Do not update symlinks.
.TP
.BR \-r ,\ \-\-remove
Remove the listed scripts from all runlevels.
@@ -238,7 +241,7 @@ Use default runlevels as defined in the
This may restore an edited runlevel link scheme.
.TP
.BR \-f ,\ \-\-force
-Ignore if a required service is missed. Beside this if start and or
+Ignore if a required service is missed. Beside this if start and or
stop levels are specified on the command line the default levels of
the script will be ignored.
.TP
@@ -271,7 +274,7 @@ has to be called from the root directory
.TP
.RI [[ / ] path/to/init.d/ ] script\ ...
List of scripts which have to be added to
-the runlevels. If a path is used it
+the runlevels. If a path is used it
should point to the absolute or relative
location of the boot scripts.
.B insserv
@@ -288,12 +291,12 @@ Note that
.BR lvl1 ,\ lvl2 ,\ ...
are the known runlevels explained above.
The extension
-.IR ,stop=<lvl1,lvl2,...>
+.I ,stop=<lvl1,lvl2,...>
is also possible.
.TP
.RI \fB\-r\fR\ [[ / ] path/to/init.d/ ] script\ ...
List of scripts which should be removed from
-the runlevels. If a path is used it
+the runlevels. If a path is used it
should point to the absolute or relative
location of the boot scripts.
.B insserv
@@ -301,9 +304,9 @@ checks for the existence of these script
.\"
.SH OVERRIDES
Beside using the extensions
-.IR ,start=<lvl1,lvl2,...>
+.I ,start=<lvl1,lvl2,...>
and
-.IR ,stop=<lvl1,lvl2,...>
+.I ,stop=<lvl1,lvl2,...>
it is possible to use override files replace a LSB comment header
or simple provide a missing LSB comment header. This can be done
by placing a file with the new LSB comment header using the same
@@ -328,11 +331,10 @@ Service was successfully installed or re
.IP 1 5
Service was not installed or removed
.RE
-.RS 5
.SH NOTE
Please be aware that the following patterns of
boot script file names will be not accepted by
-.BR insserv:
+.BR insserv :
.sp 1
.in +1l
.nf
@@ -357,13 +359,13 @@ of the following characters
.sp 1
.in +1l
.nf
- $.#%_+-\\*[]^:()~
+ $.#%_+-\e*[]^:()~
.fi
.in -1l
.sp 1
will be ignored.
.SH BUGS
-Boot scripts sometimes lack a LSB comment header. Contact a package
+Boot scripts sometimes lack a LSB comment header. Contact a package
maintainer or developer of the software which provides the script to
have a LSB comment header added to it.
.SH FILES
@@ -390,8 +392,8 @@ required by the Linux Standard Base Spec
.br
.IR /etc/init.d/.depend.start ,
.br
-.I /etc/init.d/.depend.stop
-.in +7
+.I /etc/init.d/.depend.stop
+.in +\n(INu
The
.BR make (1)
like dependency files produced by
@@ -400,22 +402,22 @@ for
.IR booting ", " starting ", and " stopping
with the help of
.BR startpar (8).
-.in -7
+.in -\n(INu
.\"
.SH SEE ALSO
.BR init (8),
.BR startpar (8),
.BR update\-rc.d (8).
.SH COPYRIGHT
-2000\-2009 Werner Fink,
+2000\(en2009 Werner Fink,
.br
2009 SuSE Linux Products GmbH Nuernberg, Germany.
.br
-2000\-2003 SuSE GmbH Nuernberg, Germany,
+2000\(en2003 SuSE GmbH Nuernberg, Germany,
.br
-2007\-2009 SuSE Linux Products GmbH Nuernberg, Germany.
+2007\(en2009 SuSE Linux Products GmbH Nuernberg, Germany.
.br
-2018\- Jesse Smith
+2018\(en Jesse Smith
.SH AUTHOR
Werner Fink <feedback at suse.de>
.SH CONTRIBUTORS
-- System Information:
Debian Release: buster/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 'testing'), (500, 'stable')
Architecture: amd64 (x86_64)
Kernel: Linux 4.9.144-1 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages insserv depends on:
ii libc6 2.28-5
insserv recommends no packages.
Versions of packages insserv suggests:
pn bootchart2 <none>
-- no debconf information
--
Bjarni I. Gislason
More information about the Debian-init-diversity
mailing list