[Pkg-sysvinit-devel] Bug#890041: init(8): Some corrections to the manual
Bjarni Ingi Gislason
bjarniig at rhi.hi.is
Sat Feb 10 11:57:08 UTC 2018
Package: sysvinit-core
Version: 2.88dsf-59.10
Severity: minor
Tags: patch
Dear Maintainer,
Test nr. 1: Remove space at end of lines.
122:it is signaled by \fBtelinit\fP to change the system's runlevel.
177:tell \fBinit\fP to re-execute itself (preserving the state). No re-examining of
#####
Test nr. 2: Fix warning from man/groff
<standard input>:330 (macro BR): only 1 argument, but more are expected
#####
Test nr. 5: Change <number>-<number> to <number>\(en<number> if it is
a numeric range
83:Runlevels 7-9 are also valid, though not really documented. This is
226:.B 1-5
#####
Test nr. 8: Protect . if not end of sentence
59:\fB0\(en6\fP and \fBS\fP (a.k.a. \fBs\fP). The runlevel is
246:line a bit, so that it takes some more space on the stack. \fBInit\fP
#####
Test nr. 25: Change a HYPHEN-MINUS (code 0x55, 2D) to a dash (minus) if it
matches " -[:alpha:]" or \(aq-[:alpha:] (for options)
184:is 5 seconds, but this can be changed with the \fB-t\fP option.
186:\fBtelinit -e\fP tells \fBinit\fP to change the environment
188:The argument of \fB-e\fP is either of the form \fIVAR\fP=\fIVAL\fP
245:The argument to \fB-z\fP is ignored. You can use this to expand the command
#####
Additionally:
Sentences in the first patch, that showed a wrong amount of space
between them, were separated ("man-pages(7)"), and a new patch created.
Patch:
--- init.8 2017-09-08 19:18:37.000000000 +0000
+++ init.8.new 2018-02-09 01:44:20.000000000 +0000
@@ -56,7 +56,7 @@ A \fIrunlevel\fP is a software configura
only a selected group of processes to exist. The processes spawned by
\fBinit\fP for each of these runlevels are defined in the
\fB/etc/inittab\fP file. \fBInit\fP can be in one of eight runlevels:
-\fB0\(en6\fP and \fBS\fP (a.k.a. \fBs\fP). The runlevel is
+\fB0\(en6\fP and \fBS\fP (a.k.a.\& \fBs\fP). The runlevel is
changed by having a privileged user run \fBtelinit\fP, which sends
appropriate signals to \fBinit\fP, telling it which runlevel to change
to.
@@ -80,8 +80,8 @@ the administrator performs maintenance a
For more information,
see the manpages for \fBshutdown\fP(8) and \fBinittab\fP(5).
.PP
-Runlevels 7-9 are also valid, though not really documented. This is
-because "traditional" Unix variants don't use them.
+Runlevels 7\(en9 are also valid, though not really documented.
+This is because "traditional" Unix variants don't use them.
.PP
Runlevels \fIS\fP and \fIs\fP are the same.
Internally they are aliases for the same runlevel.
@@ -119,7 +119,7 @@ provided that these files exist.
.SH CHANGING RUNLEVELS
After it has spawned all of the processes specified, \fBinit\fP waits
for one of its descendant processes to die, a powerfail signal, or until
-it is signaled by \fBtelinit\fP to change the system's runlevel.
+it is signaled by \fBtelinit\fP to change the system's runlevel.
When one of the above three conditions occurs, it re-examines
the \fB/etc/inittab\fP file. New entries can be added to this file at
any time. However, \fBinit\fP still waits for one of the above three
@@ -174,18 +174,18 @@ tell \fBinit\fP to re-examine the \fB/et
.IP "\fBS\fP or \fBs\fP"
tell \fBinit\fP to switch to single user mode.
.IP "\fBU\fP or \fBu\fP"
-tell \fBinit\fP to re-execute itself (preserving the state). No re-examining of
-\fB/etc/inittab\fP file happens. Run level should be one of
-\fBSs0123456\fP
-otherwise request would be silently ignored.
+tell \fBinit\fP to re-execute itself (preserving the state).
+No re-examining of \fB/etc/inittab\fP file happens.
+Run level should be one of \fBSs0123456\fP otherwise request would be
+silently ignored.
.PP
\fBtelinit\fP can tell \fBinit\fP how long it should wait
between sending processes the SIGTERM and SIGKILL signals. The default
-is 5 seconds, but this can be changed with the \fB-t\fP option.
+is 5 seconds, but this can be changed with the \fB\-t\fP option.
.PP
-\fBtelinit -e\fP tells \fBinit\fP to change the environment
+\fBtelinit \-e\fP tells \fBinit\fP to change the environment
for processes it spawns.
-The argument of \fB-e\fP is either of the form \fIVAR\fP=\fIVAL\fP
+The argument of \fB\-e\fP is either of the form \fIVAR\fP=\fIVAL\fP
which sets variable \fIVAR\fP to value \fIVAL\fP,
or of the form \fIVAR\fP
(without an equality sign)
@@ -215,15 +215,16 @@ The system console. This is really inher
if it is not set \fBinit\fP will set it to \fB/dev/console\fP by default.
.SH BOOTFLAGS
It is possible to pass a number of flags to \fBinit\fP from the
-boot monitor (eg. LILO). \fBInit\fP accepts the following flags:
+boot monitor (e.g.\& LILO).
+\fBInit\fP accepts the following flags:
.TP 0.5i
.B -s, S, single
-Single user mode boot. In this mode \fI/etc/inittab\fP is
-examined and the bootup rc scripts are usually run before
-the single user mode shell is started.
+Single user mode boot.
+In this mode \fI/etc/inittab\fP is examined and the bootup rc scripts
+are usually run before the single user mode shell is started.
.PP
.TP 0.5i
-.B 1-5
+.B 1\(en5
Runlevel to boot into.
.PP
.TP 0.5i
@@ -236,23 +237,24 @@ other startup scripts.
The LILO boot loader adds the word "auto" to the command line if it
booted the kernel with the default command line (without user intervention).
If this is found \fBinit\fP sets the "AUTOBOOT" environment
-variable to "yes". Note that you cannot use this for any security
-measures - of course the user could specify "auto" or \-a on the
-command line manually.
+variable to "yes".
+Note that you cannot use this for any security measures \(en of course
+the user could specify "auto" or \-a on the command line manually.
.PP
.TP 0.5i
-.BI "-z " xxx
-The argument to \fB-z\fP is ignored. You can use this to expand the command
-line a bit, so that it takes some more space on the stack. \fBInit\fP
-can then manipulate the command line so that \fBps\fP(1) shows
-the current runlevel.
+.BI "\-z " xxx
+The argument to \fB\-z\fP is ignored.
+You can use this to expand the command line a bit, so that it takes
+some more space on the stack.
+\fBInit\fP can then manipulate the command line so that \fBps\fP(1)
+shows the current runlevel.
.PP
.SH INTERFACE
Init listens on a \fIfifo\fP in /run, \fI/run/initctl\fP, for messages.
-\fBTelinit\fP uses this to communicate with init. The interface is not
-very well documented or finished. Those interested should study the
-\fIinitreq.h\fP file in the \fIsrc/\fP subdirectory of the \fBinit\fP
-source code tar archive.
+\fBTelinit\fP uses this to communicate with init.
+The interface is not very well documented or finished.
+Those interested should study the \fIinitreq.h\fP file in the
+\fIsrc/\fP subdirectory of the \fBinit\fP source code tar archive.
.SH SIGNALS
Init reacts to several signals:
.TP 0.5i
@@ -327,7 +329,7 @@ page by Michael Haardt (u31b3hs at pool.inf
.BR login (1),
.BR sh (1),
.BR runlevel (8),
-.BR shutdown(8),
+.BR shutdown (8),
.BR kill (1),
.BR inittab (5),
.BR initscript (5),
-- 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.65-3u2 (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 sysvinit-core depends on:
ii debconf [debconf-2.0] 1.5.65
ii debianutils 4.8.4
ii initscripts 2.88dsf-59.10
ii libc6 2.26-4
ii libselinux1 2.7-2+b1
ii libsepol1 2.7-1
ii sysv-rc 2.88dsf-59.10
ii sysvinit-utils 2.88dsf-59.10
sysvinit-core recommends no packages.
Versions of packages sysvinit-core suggests:
ii bootlogd 2.88dsf-59.10
-- debconf information excluded
--
Bjarni I. Gislason
More information about the Pkg-sysvinit-devel
mailing list