Skip to content
This repository has been archived by the owner on Sep 1, 2023. It is now read-only.

Commit

Permalink
man text cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
arsv committed Dec 31, 2015
1 parent 152a423 commit 17238cf
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 26 deletions.
2 changes: 1 addition & 1 deletion init.man
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The system remains running for as long as init process is alive.
.P
The primary role of init is to start other processes. Init keeps
a list of commands to spawn, which it executes sequentially.
Init tracks pids of the spawned processes and, if configured so,
Init tracks ids of the spawned processes and, if configured so,
respawns those that have died.
.P
Init also adopts all orphaned processes in the system,
Expand Down
11 changes: 5 additions & 6 deletions initdir.man
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Initdir entries are always \fBS\fR-type.
See \fBinittab\fR(5) for detailed description of entry types and runlevels.
'''
.SH SYNTAX
There are two slighly different flavors of service files.
There are two slightly different flavors of service files.
The first one is a plain file:
.P
.EX
Expand All @@ -49,20 +49,19 @@ Files or this kind must be executable, and init will use the full file
path as the command to run. Only \fIrunlevels\fR are parsed by init in this
case, the rest is left to \fIinterpreter\fR.
.P
In both cases, \fB#:\fIrunlevels\fR line may be omited.
In both cases, \fB#:\fIrunlevels\fR line may be omitted.
'''
.SH USAGE
Service files are meant primarily for package-managed systems as a easy
way to add managed init entries, vs. modifying inittab each time
way to add managed init entries, as opposed to modifying inittab each time
a package is installed or uninstalled.
.P
Scripts may also be useful for daemons that need external initialization code,
like creating/purging cache directories for squid.
Scripts may also be useful for daemons that need external initialization code.
.P
Whenever a script is used, it should typically end with an \fBexec\fR(3) call
or some equivalent thereof to replace \fIinterpreter\fR with the actual daemon
process. Leaving \fIinterpreter\fR running only makes sense if there is some
cleanup to do after the deamon dies.
cleanup to do after the daemon dies.
'''
.SH COMPATIBILITY
Service files used by {INIT} are not compatible with SysV \fBinitscript\fR(5)s.
Expand Down
30 changes: 15 additions & 15 deletions inittab.man
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
Inittab is a list of commands init should run.
.P
Each relevant line in inittab describes a single process (an entry)
to be run by init. Init records the pids of the processes it spawns
to be run by init. Init records the ids of the processes it spawns
and tracks them until processes die.
.P
At any point, init is in one of runlevels 0, 1, ... 9, with zero or more
sublevels a, b, ..., f activated. Each entry has its own runlevel mask,
with zero or more runlevels and zero or more sublevels.
.P
Init decides whether an entry should be running or not using current
runlevel and entry's runlevel mask. Subsequentry the entry is either
runlevel and entry's runlevel mask. Subsequently the entry is either
spawned, killed or skipped. Entries are always started in top-to-bottom
order, and killed bottom-to-top.
.P
Expand All @@ -28,7 +28,7 @@ Along with the entries itself, inittab may also contain environment
variables to be passed to the spawned processes via \fBexecve\fR(2).
'''
.SH SYNTAX
Inittab is a text file parsed in linewise manner.
Inittab is a text file parsed in line wise manner.
.IP "# \fIcomment\fR" 4
Lines starting with # are ignored by init
.IP "\fIvariable\fR=\fIvalue\fR" 4
Expand All @@ -53,9 +53,9 @@ messages. To make a unnamed entry, start a line with any whitespace character.
Non-empty names should be unique.
.P
During reconfiguration, init matches entries with the same name, and transfers
pids from the old configuration. For un-named entries, and in case names do not
match, the old process gets killed and the new one started. This is mostly
relevant for respawning entries.
process ids from the old configuration. For un-named entries, and in case names
do not match, the old process gets killed and the new one started.
This is mostly relevant for respawning entries.
'''
.SS Entry mode
The second field, \fImode\fR, describes how the entry should be handled by init.
Expand All @@ -76,7 +76,7 @@ initialization entries, like sysctl or non-root mounts or early network setup.
.IP "\fBW\fR" 4
Run once and wait for this process. Do not restart it, and do not proceed
further until it dies. Use this for critical initialization entries, like
mounting root. \fBW\fR-process will not be started until all preceeding
mounting root. \fBW\fR-process will not be started until all preceding
\fBR\fR-entries have exited, and no subsequent entries will be started until
it exits.
.IP "\fBX\fR" 4
Expand Down Expand Up @@ -119,7 +119,7 @@ Wherever necessary, init calls /bin/sh -c to execute the command.
.SH USAGE
The primary role of inittab is listing commands needed to bring the system up
after booting the kernel. Typically this involves run-once entries performing
runtime kernel configuration (filesystems, network) and respawning entries
runtime kernel configuration (file systems, network) and respawning entries
for system daemons and user interface.
.P
Transition to other system states (reboot, shutdown, sleep) may be described
Expand Down Expand Up @@ -165,7 +165,7 @@ Any process doing \fBdaemon\fR(3) style startup will confuse init if configured
as an \fBS\fR-type entry, since init has no way to track the daemonized child
process and will attemp to take action immediately after the parent exits.
.P
Whenever possible, processes must be intructed to run in foreground mode.
Whenever possible, processes must be instructed to run in foreground mode.
Most daemons allow this; check relevant man pages.
.P
.EX
Expand All @@ -181,7 +181,7 @@ services, must remain in inittab.
'''
.SS Slippery runlevels
Reaching any of runlevels \fB7\fR, \fB8\fR, \fB9\fR initiates immediate
switch back to preceeding non-slippery runlevel.
switch back to the original non-slippery runlevel.
For instance, running \fBtelinit 8\fR while on runlevel \fB3\fR makes
init switch \fB3\fR to \fB8\fR and back to \fB3\fR.
.P
Expand All @@ -198,20 +198,20 @@ and make post-sleep recovery \fBX\fR-entries:
.P
In case respawning processes that should be stopped when entering sleep mode,
remove relevant runlevels from their respective masks (\fBS3456\fR instead
of \fBS3+\fR).
of \fBS3*\fR).
'''
.SH COMPATIBILITY
This page describes inittab format for \fB{INIT}\fR package.
It is not compatible with the traditional SysVinit format.
It is not compatible with the traditional System V init format.
.P
Most features of SysV-style inittab features translate easily into those
understood by sninit. However, SysVinit-compatible implementations tend
Most features of System V style inittab features translate easily into those
understood by sninit. However, SysV-compatible implementations tend
to use initscripts system instead of \fBinitdir\fR(5), making automated
translation between two formats pointless.
Shutdown/reboot handling differs as well, and sleep modes are not typically
supported.
.P
Because of this, translating SysV-style inittab for use with {INIT}
Because of this, translating traditional inittab for use with {INIT}
rarely makes sense.
'''
.SH SEE ALSO
Expand Down
6 changes: 3 additions & 3 deletions run.man
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
\fBrun\fR [\fIoptions\fR] \fIcommand\fR \fIargs\fR ...
'''
.SH DESCRIPTION
\fBrun\fR allows configuring process atributes of a newly spawned
\fBrun\fR allows configuring process attributes of a newly spawned
command. All requested changes are applied before \fIcommand\fR is
started.
.P
\fBrun\fR is intended for priviledged users, as one of its main uses
is spawning commands with limited priviledges. Some of the options
\fBrun\fR is intended for privileged users, as one of its main uses
is spawning commands with limited privileges. Some of the options
may work for regular users, but most will not.
.P
Another use for \fBrun\fR is searching $PATH and doing output redirects
Expand Down
2 changes: 1 addition & 1 deletion telinit.man
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ exiting, and will show all configuration errors.
'''
.SH NOTES
This page describes {telinit} from \fB{INIT}\fR package.
Telinits from other init implementations may behave differently.
Other init implementations may behave differently.
.P
In particular, this version of {telinit} is not compatible with sysvinit.
Most sysvinit options are not supported. Runlevel change and configuration
Expand Down

0 comments on commit 17238cf

Please sign in to comment.