diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile | 5 | ||||
| -rw-r--r-- | man/rc-depend.8 | 73 | ||||
| -rw-r--r-- | man/rc-status.8 | 37 | ||||
| -rw-r--r-- | man/rc-update.8 | 43 | ||||
| -rw-r--r-- | man/start-stop-daemon.8 | 212 |
5 files changed, 370 insertions, 0 deletions
diff --git a/man/Makefile b/man/Makefile new file mode 100644 index 00000000..8c6b3cf8 --- /dev/null +++ b/man/Makefile @@ -0,0 +1,5 @@ +DIR = /usr/share/man +MANS = rc-depend.8 rc-status.8 rc-update.8 start-stop-daemon.8 + +TOPDIR = .. +include $(TOPDIR)/default.mk diff --git a/man/rc-depend.8 b/man/rc-depend.8 new file mode 100644 index 00000000..62aa9592 --- /dev/null +++ b/man/rc-depend.8 @@ -0,0 +1,73 @@ +.TH "BASELAYOUT" "8" "March 2007" "baselayout" "baselayout" +.SH NAME +rc-depend \ - resolve init script dependencies +.SH SYNOPSIS +\fBrc-depend\fR \fI-ineed\fR \fI-iuse\fR \fIservice\fR ... +.br +\fBrc-depend\fR \fI--notrace\fR \fI-iprovide\fR \fIservice\fR ... +.br +\fBrc-depend\fR \fI-needsme\fR \fIservice\fR ... +.br +\fBrc-depend\fR \fI--update\fR +.SH DESCRIPTION +Gentoos init system uses service dependencies to depend on other services. +Rather than just starting in a set order, we start and stop in the order +defined by the services themselves. +For example, most services require local disks to be mounted and as such can +depend on the localmount service. Others depend on and net and dns and will +only start when those dependencies have been satisfied. + +One issue of note is that a service can provide another service, which is more +generic. A good example of this is that net.lo and any service linked to it +provide "net", which a few services depend on. You can of course have a few +network interfaces: modern laptops have 3 being loopback, wired and wireless. +What makes this more interesting is that it could be setup so that both wired +and wireless are optional. So we work out provided services like so :- + +1) Always use any services in the runlevel. +.br +2) If no services are defined in the runlevel then use any running services +that satisfy the provide. +.br +3) Append any services in the boot runlevel. + +\fBrc-order\fR is primarily used internally by Gentoo and is not meant as an +end-user or admin tool. This man page is purely to describe its function. +.SH OPTIONS +.TP +\fB--deptree \fIdeptree\fR +Use this \fIdeptree\fR instead of the default one, +\fI/lib/rcscripts/init.d/deptree\fR. +.TP +\fB--notrace\fR +Just show the dependencies for the specified services without working out +anything extra. +.TP +\fB--strict\fR +For provided services, depend on all of them in the runlevel instead of just +ones that are started. +.TP +\fB--update\fR +Force an update of the dependency tree. Normally this is not needed as we +automatically update the dependency tree if any files in /etc/init.d or +/etc/conf.d are newer than the tree. +.TP +\fB-dependency_type\fR +Work with the specified dependency type, such as \fIineed\fR, \fIiafter\fR, +\fIneedsme\fR. +If none are supplied we default to \fIineed\fR and \fIiuse\fR. +.SH NOTES +When needsme depends on a provided service, like net, we don't do any +mapping to an actual service unless it's the last one up. So if net.lo and +net.eth0 are started then neither are returned. If net.eth0 then stops then +every service that needs net then has net.lo in its needsme list so that +we net.lo stops it brings down all services that depend on net. +.SH BUGS +Provided services are calculated at runtime. The current downside of this +approach means that if you do "after net; before net.lo" and net.lo provides +net then you can get into an sticky loop where services hang. +.SH "REPORTING BUGS" +Please report bugs via http://bugs.gentoo.org/ +.SH "SEE ALSO" +.BR rc-update (8), +.BR rc-status (8) diff --git a/man/rc-status.8 b/man/rc-status.8 new file mode 100644 index 00000000..d78e4469 --- /dev/null +++ b/man/rc-status.8 @@ -0,0 +1,37 @@ +.TH "BASELAYOUT" "8" "May 2004" "baselayout" "baselayout" +.SH NAME +rc-status \- show status info about runlevels +.SH SYNOPSIS +\fBrc-status\fR \fI[command [runlevel]]\fR +.SH DESCRIPTION +\fBrc-status\fR gathers and displays information about the status of init +scripts in different runlevels. The default behavior is to show information +about the current runlevel, but any runlevel can be quickly examined. +directory. They must also conform to the Gentoo runscript standard. +.SH OPTIONS +.TP +\fB\-\-all (\-a)\fR +Show all runlevels and their services +.TP +\fB\-\-list (\-l)\fR +List all defined runlevels +.TP +\fB\-\-nocolor (\-nc)\fR +Disable color output +.TP +\fB\-\-servicelist (\-s)\fR +Show all services +.TP +\fB\-\-unused (\-u)\fR +Show services not assigned to any runlevel +.TP +\fB[runlevel]\fR +Show information only for the named \fBrunlevel\fR +.SH "REPORTING BUGS" +Please report bugs via http://bugs.gentoo.org/ +.SH "SEE ALSO" +.BR rc-update (8) + +http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2&chap=4 +.SH AUTHORS +Mike Frysinger <vapier@gentoo.org> diff --git a/man/rc-update.8 b/man/rc-update.8 new file mode 100644 index 00000000..03e79c84 --- /dev/null +++ b/man/rc-update.8 @@ -0,0 +1,43 @@ +.TH "BASELAYOUT" "8" "May 2004" "baselayout" "baselayout" +.SH NAME +rc-update \- add and remove init scripts to a runlevel +.SH SYNOPSIS +\fBrc-update\fR \fIadd\fR \fIscript\fR \fI<runlevels>\fR +.br +\fBrc-update\fR \fIdel\fR \fIscript\fR \fI[runlevels]\fR +.br +\fBrc-update\fR \fIshow\fR \fI[\-\-verbose]\fR \fI[runlevels]\fR +.SH DESCRIPTION +Gentoo's init system uses named runlevels. Rather than editing some obscure +file or managing a directory of symlinks, \fBrc-update\fR exists to quickly +add or delete init scripts from different runlevels. + +All scripts specified with this utility must reside in the \fI/etc/init.d\fR +directory. They must also conform to the Gentoo runscript standard. +.SH OPTIONS +.TP +\fBadd (\-a)\fR \fIscript\fR \fI<runlevels>\fR +Add the specified \fIinit script\fR to the specified \fIrunlevels\fR. You +must specify at least one runlevel. + +Example: rc-update add net.eth0 default +.TP +\fBdel (\-d)\fR \fIscript\fR \fI[runlevels]\fR +Delete the specified \fIinit script\fR from the specified \fIrunlevels\fR. +If you do not specify the \fIrunlevels\fR from which to delete, the script +will be removed from all exists runlevels. + +Example: rc-update del sysklogd +.TP +\fBshow (\-s)\fR \fI[\-v|\-\-verbose]\fR \fI[runlevels]\fR +Show all enabled scripts and the runlevels they belong to. If you specify +\fIrunlevels\fR to show, then only those will be included in the output. To +view all init scripts, run with the \fI\-\-verbose\fR option. + +Example: rc-update show +.SH "REPORTING BUGS" +Please report bugs via http://bugs.gentoo.org/ +.SH "SEE ALSO" +.BR rc-status (8) + +http://www.gentoo.org/doc/en/handbook/handbook-x86.xml?part=2&chap=4 diff --git a/man/start-stop-daemon.8 b/man/start-stop-daemon.8 new file mode 100644 index 00000000..5ec29f2e --- /dev/null +++ b/man/start-stop-daemon.8 @@ -0,0 +1,212 @@ +.TH "BASELAYOUT" "8" "March 2007" "baselayout" "baselayout" +.SH NAME +start\-stop\-daemon \- start and stop system daemon programs +.SH SYNOPSIS +.B start-stop-daemon +.BR -S | --start +.IR options +.RB [ \-\- ] +.IR arguments +.HP +.B start-stop-daemon +.BR -K | --stop +.IR options +.HP +.B start-stop-daemon +.BR -H | --help +.HP +.B start-stop-daemon +.BR -V | --version +.SH DESCRIPTION +.B start\-stop\-daemon +is used to control the creation and termination of system-level processes. +Using the +.BR --exec ", " --pidfile ", " --user ", and " --name " options," +.B start\-stop\-daemon +can be configured to find existing instances of a running process. + +With +.BR --start , +.B start\-stop\-daemon +checks for the existence of a specified process. +If such a process exists, +.B start\-stop\-daemon +does nothing, and exits with error status 1. +If such a process does not exist, it starts an +instance, using the executable specified by +.BR --exec . +Any arguments given after +.BR -- +on the command line are passed unmodified to the program being +started. +.B start\-stop\-daemon +pauses for a little bit then checks the daemon is still running as badly +written ones like to fork early and then bail on a error in their config. +As such it may be necessary to use the --name parameter if the daemon in +question is not a C program, ie a script. Once started, we store how we +are called in \fBrc\fR if called from an init script. + +With +.BR --stop , +.B start\-stop\-daemon +also checks for the existence of a specified process. +If such a process exists, +.B start\-stop\-daemon +sends it the signal specified by +.BR --signal , +and exits with error status 0. +If such a process does not exist, or there was an error stopping it +.B start\-stop\-daemon +exits with error status 1. If +.BR --test +is specified then we just send the signal and not the schedule. If +.BR --oknodo +is specified then we don't remove the daemon information from +.BR rc. + +.SH OPTIONS + +.TP +\fB-x\fP|\fB--exec\fP \fIexecutable\fP +Check for processes that are instances of this executable. +.TP +\fB-p\fP|\fB--pidfile\fP \fIpid-file\fP +Check for processes whose process-id is specified in +.I pid-file. +.TP +\fB-u\fP|\fB--user\fP \fIusername\fP|\fIuid\fP +Check for processes owned by the user specified by +.I username +or +.I uid. +.TP +\fB-n\fP|\fB--name\fP \fIprocess-name\fP +Check for processes with the name +.I process-name +.TP +\fB-s\fP|\fB--signal\fP \fIsignal\fP +With +.BR --stop +, specifies the signal to send to processes being stopped (default SIGTERM). +.TP +\fB-R\fP|\fB--retry\fP \fItimeout\fP|\fIschedule\fP +With +.BR --stop , +specifies that +.B start-stop-daemon +is to check whether the process(es) +do finish. It will check repeatedly whether any matching processes +are running, until none are. If the processes do not exit it will +then take further action as determined by the schedule. + +If +.I timeout +is specified instead of +.I schedule +then the schedule +.IB signal / timeout +is used, where +.I signal +is the signal specified with +.BR --signal . + +.I schedule +is a list of at least two items separated by slashes +.RB ( / ); +each item may be +.BI - signal-number +or [\fB\-\fP]\fIsignal-name\fP, +which means to send that signal, +or +.IR timeout , +which means to wait that many seconds for processes to +exit, +or +.BR forever , +which means to repeat the rest of the schedule forever if +necessary. + +If the end of the schedule is reached and +.BR forever +is not specified, then +.B start-stop-daemon +exits with error status 2. +If a schedule is specified, then any signal specified +with +.B --signal +is ignored. +.TP +.BR -t | --test +Print actions that would be taken and set appropriate return value, +but take no action. +.TP +.BR -o | --oknodo +Used for sending signals to a running daemon but not expecting it to stop. +.TP +.BR -q | --quiet +Do not print informational messages; only display error messages. +.TP +\fB-c\fP|\fB--chuid\fP \fIusername\fR|\fIuid\fP +Change to this username/uid before starting the process. You can also +specify a group by appending a +.BR : , +then the group or gid in the same way +as you would for the `chown' command (\fIuser\fP\fB:\fP\fIgroup\fP). +When using this option +you must realize that the primary and supplemental groups are set as well, +even if the +.B --group +option is not specified. The +.B --group +option is only for +groups that the user isn't normally a member of (like adding per/process +group membership for generic users like +.BR nobody ). +.TP +\fB-r\fP|\fB--chroot\fP \fIroot\fP +Chdir and chroot to +.I root +before starting the process. Please note that the pidfile is also written +after the chroot. +.TP +.BR -b | --background +Typically used with programs that don't detach on their own. This option +will force +.B start-stop-daemon +to fork before starting the process, and force it into the background. +.TP +\fB-1\fP|\fB--stdout\fP \fIlogfile\fP +Redirect the standard output of the process to \fIlogfile\fP when started with \fB--background\fP. +Must be an absolute pathname, but relative to the \fIpath\fP optionally given with +\fB--chroot\fP. +Hint: The \fIlogfile\fP can also be a named pipe. +.TP +\fB-2\fP|\fB--stderr\fP \fIlogfile\fP +The same thing as \fB--stdout\fP but with the standard error output. +.TP +.BR -N | --nicelevel +This alters the prority of the process before starting it. +.TP +.BR -m | --make-pidfile +Used when starting a program that does not create its own pid file. This +option will make +.B start-stop-daemon +create the file referenced with +.B --pidfile +and place the pid into it just before executing the process. Note, it will +not be removed when stopping the program. +.B NOTE: +This feature may not work in all cases. Most notably when the program +being executed forks from its main process. Because of this it is usually +only useful when combined with the +.B --background +option. +.TP +.BR -v | --verbose +Print verbose informational messages. +.TP +.BR -H | --help +Print help information; then exit. +.TP +.BR -V | --version +Print version information; then exit. |