[Pkg-sysvinit-commits] r1607 - sysvinit/trunk/debian/sysv-rc/man8
Petter Reinholdtsen
pere at alioth.debian.org
Thu Aug 13 18:38:35 UTC 2009
Author: pere
Date: 2009-08-13 18:38:35 +0000 (Thu, 13 Aug 2009)
New Revision: 1607
Modified:
sysvinit/trunk/debian/sysv-rc/man8/update-rc.d.8
Log:
Process manual page using man-edit.
Modified: sysvinit/trunk/debian/sysv-rc/man8/update-rc.d.8
===================================================================
--- sysvinit/trunk/debian/sysv-rc/man8/update-rc.d.8 2009-08-08 08:04:07 UTC (rev 1606)
+++ sysvinit/trunk/debian/sysv-rc/man8/update-rc.d.8 2009-08-13 18:38:35 UTC (rev 1607)
@@ -1,35 +1,35 @@
.\" Hey, Emacs! This is an -*- nroff -*- source file.
.\" Authors: Ian Jackson, Miquel van Smoorenburg
-.TH UPDATE\-RC.D 8 "14 November 2005" "Debian Project" "sysv-rc"
-.SH NAME
-update\-rc.d \- install and remove System-V style init script links
-.SH SYNOPSIS
+.TH "UPDATE\-RC.D" "8" "14 November 2005" "Debian Project" "sysv-rc"
+.SH "NAME"
+update\-rc.d \- install and remove System\-V style init script links
+.SH "SYNOPSIS"
.B update\-rc.d
-.RI [ -n ]
-.RI [ -f ]
-.IB name " remove"
+.RI [ \-n ]
+.RI [ \-f ]
+.I B name " remove"
.HP
-.B update-rc.d
-.RI [ -n ]
-.IB name " defaults"
+.B update\-rc.d
+.RI [ \-n ]
+.I B name " defaults"
.RI [ NN " | " SS " " KK ]
.HP
-.B update-rc.d
-.RI [ -n ]
+.B update\-rc.d
+.RI [ \-n ]
.I name
.BR start | stop
-.IR "NN runlevel" " [" runlevel "]..."
+.I R "NN runlevel" " [" runlevel "]..."
.B .
.BR start | stop
-.IR "NN runlevel" " [" runlevel "]..."
+.I R "NN runlevel" " [" runlevel "]..."
.BR . " ..."
.HP
-.B update-rc.d
-.RI [ -n ]
-.IB name " disable|enable "
+.B update\-rc.d
+.RI [ \-n ]
+.I B name " disable|enable "
.RI [ " S|2|3|4|5 " ]
-.SH DESCRIPTION
-.B update-rc.d
+.SH "DESCRIPTION"
+.B update\-rc.d
updates the System V style init script links
.BI /etc/rc runlevel .d/ NNname
whose target is the script
@@ -42,23 +42,23 @@
is one of the runlevels supported by
.BR init ", namely, " 0123456789S ", and "
.I NN
-is the two-digit sequence number that determines where in the sequence
+is the two\-digit sequence number that determines where in the sequence
.B init
will run the scripts.
This manpage documents only the usage and behaviour of
-.BR update-rc.d .
+.BR update\-rc.d .
For a discussion of the System V style init script arrangements please
see
.BR init (8)
and the
-.IR "Debian Policy Manual" .
+.I R "Debian Policy Manual" .
-.SH INSTALLING INIT SCRIPT LINKS
+.SH "INSTALLING INIT SCRIPT LINKS"
When run with either the
.BR defaults ", " start ", or " stop
options,
-.B update-rc.d
+.B update\-rc.d
makes links
.BI /etc/rc runlevel .d/[SK] NNname
that point to the script
@@ -67,7 +67,7 @@
If any files
.BI /etc/rc runlevel .d/[SK]?? name
already exist then
-.B update-rc.d
+.B update\-rc.d
does nothing.
The program was written this way so that it will never
change an existing configuration, which may have been
@@ -83,7 +83,7 @@
the package is upgraded, the package's
.I postinst
script will run
-.B update-rc.d
+.B update\-rc.d
again and this will reinstall links at their factory default locations.
The correct way to disable services is to configure the
service as stopped in all runlevels in which it is started by default.
@@ -97,7 +97,7 @@
If
.B defaults
is used then
-.B update-rc.d
+.B update\-rc.d
will make links to start the service in runlevels
.B 2345
and to stop the service in runlevels
@@ -120,7 +120,7 @@
compatibility but is discouraged, as it may lead to inconsistent
settings. As a rule of thumb, if you increase the start sequence
number you should also decrease the stop sequence number, and
-vice-versa.
+vice\-versa.
.P
As a rule of thumb, the sequence number of the stop link
should be 100 minus the sequence number of the start link;
@@ -129,7 +129,7 @@
Obviously, therefore, the default stop sequence number
should be 80.
Defaulting to 20, as
-.B update-rc.d
+.B update\-rc.d
does, is an old bug that cannot be fixed because
of the risk of breaking things.
.P
@@ -140,7 +140,7 @@
Each of these sets of arguments starts with the keyword
.BR start " or " stop
and a sequence number
-.IR NN ,
+.I R NN ,
followed by one or more runlevel numbers.
The set is terminated by a solitary full stop character.
When explicit specification, rather than
@@ -166,22 +166,22 @@
The script
.BI /etc/init.d/ name
must exist before
-.B update-rc.d
+.B update\-rc.d
is run to create the links.
-.SH REMOVING SCRIPTS
+.SH "REMOVING SCRIPTS"
When invoked with the
.I remove
-option, update-rc.d removes any links in the
+option, update\-rc.d removes any links in the
.BI /etc/rc runlevel .d
directories to the script
.BI /etc/init.d/ name\fR.
The script must have been deleted already.
If the script is still present then
-.B update-rc.d
+.B update\-rc.d
aborts with an error message.
.P
-.B update-rc.d
-is usually called from a package's post-removal script when that
+.B update\-rc.d
+is usually called from a package's post\-removal script when that
script is given the
.B purge
argument.
@@ -190,11 +190,11 @@
directories that are not symbolic links to the script
.BI /etc/init.d/ name
will be left untouched.
-.SH DISABLING INIT SCRIPT START LINKS
+.SH "DISABLING INIT SCRIPT START LINKS"
When run with the
.BR disable " [ " S|2|3|4|5 " ] "
options,
-.B update-rc.d
+.B update\-rc.d
modifies existing runlevel links for the script
.BR /etc/init.d/ \fIname\fR
by renaming start links to stop links with a sequence number equal
@@ -203,7 +203,7 @@
When run with the
.BR enable " [ " S|2|3|4|5 " ] "
options,
-.B update-rc.d
+.B update\-rc.d
modifies existing runlevel links for the script
.BR /etc/init.d/ \fIname\fR
by renaming stop links to start links with a sequence number equal
@@ -215,86 +215,86 @@
3, 4 or 5. If no start runlevel is specified after the disable or enable
keywords, the script will attempt to modify links in all start runlevels.
-.SH OPTIONS
-.TP
-.I -n
+.SH "OPTIONS"
+.TP
+.I \-n
Don't do anything, just show what we would do.
-.TP
-.I -f
+.TP
+.I \-f
Force removal of symlinks even if
.BI /etc/init.d/ name
still exists.
-.SH EXAMPLES
+.SH "EXAMPLES"
Insert links using the defaults:
-.nf
-.B " update-rc.d foobar defaults"
-.fi
+.nf
+.B " update\-rc.d foobar defaults"
+.fi
Equivalent command using explicit argument sets:
-.nf
-.B " update-rc.d foobar start 20 2 3 4 5 . stop 20 0 1 6 ."
-.fi
+.nf
+.B " update\-rc.d foobar start 20 2 3 4 5 . stop 20 0 1 6 ."
+.fi
More typical command using explicit argument sets:
-.nf
-.B " update-rc.d foobar start 30 2 3 4 5 . stop 70 0 1 6 ."
-.fi
+.nf
+.B " update\-rc.d foobar start 30 2 3 4 5 . stop 70 0 1 6 ."
+.fi
Insert links at default runlevels when B requires A
-.nf
-.B " update-rc.d script_for_A defaults 80 20"
-.B " update-rc.d script_for_B defaults 90 10"
-.fi
+.nf
+.B " update\-rc.d script_for_A defaults 80 20"
+.B " update\-rc.d script_for_B defaults 90 10"
+.fi
Insert a link to a service that (presumably) will not be
needed by any other daemon
-.nf
-.B " update-rc.d top_level_app defaults 98 02"
-.fi
+.nf
+.B " update\-rc.d top_level_app defaults 98 02"
+.fi
Insert links for a script that requires services that
start/stop at sequence number 20
-.nf
-.B " update-rc.d script_depends_on_svc20 defaults 21 19"
-.fi
+.nf
+.B " update\-rc.d script_depends_on_svc20 defaults 21 19"
+.fi
Remove all links for a script (assuming foobar has been deleted
already):
-.nf
-.B " update-rc.d foobar remove"
-.fi
+.nf
+.B " update\-rc.d foobar remove"
+.fi
Example of disabling a service:
-.nf
-.B " update-rc.d -f foobar remove"
-.B " update-rc.d foobar stop 20 2 3 4 5 ."
-.fi
-Example of a command for installing a system initialization-and-shutdown script:
-.nf
-.B " update-rc.d foobar start 45 S . stop 31 0 6 ."
-.fi
-Example of a command for disabling a system initialization-and-shutdown script:
-.nf
-.B " update-rc.d -f foobar remove"
-.B " update-rc.d foobar stop 45 S ."
-.fi
+.nf
+.B " update\-rc.d \-f foobar remove"
+.B " update\-rc.d foobar stop 20 2 3 4 5 ."
+.fi
+Example of a command for installing a system initialization\-and\-shutdown script:
+.nf
+.B " update\-rc.d foobar start 45 S . stop 31 0 6 ."
+.fi
+Example of a command for disabling a system initialization\-and\-shutdown script:
+.nf
+.B " update\-rc.d \-f foobar remove"
+.B " update\-rc.d foobar stop 45 S ."
+.fi
-.SH BUGS
-See http://bugs.debian.org/sysv-rc.
-.SH FILES
-.TP
+.SH "BUGS"
+See http://bugs.debian.org/sysv\-rc.
+.SH "FILES"
+.TP
.B /etc/init.d/
The directory containing the actual init scripts.
-.TP
+.TP
.B /etc/rc?.d/
The directories containing the links used by
.BR init
and managed by
-.BR update-rc.d .
-.TP
+.BR update\-rc.d .
+.TP
.B /etc/init.d/skeleton
Model for use by writers of
.B init.d
scripts.
-.SH SEE ALSO
-.IR "Debian Policy Manual" ,
-.br
+.SH "SEE ALSO"
+.I R "Debian Policy Manual" ,
+.br
.BR /etc/init.d/skeleton ,
-.br
+.br
.BR insserv (8),
-.BR sysv-rc-conf (8),
+.BR sysv\-rc\-conf (8),
.BR bum (8),
.BR init (8).
More information about the Pkg-sysvinit-commits
mailing list