aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoy Marples <roy@marples.name>2007-12-20 15:54:19 +0000
committerRoy Marples <roy@marples.name>2007-12-20 15:54:19 +0000
commite4575849bee50b0cd7bb6a18bc41071b1b05138a (patch)
treea205800fa2aa7836d135890a14eb3ffce0daa3b3
parentf1d1281c0438003c65056c1235d28b34f786fb82 (diff)
Add a manpage for rc.8
-rw-r--r--man/Makefile2
-rw-r--r--man/rc.877
2 files changed, 78 insertions, 1 deletions
diff --git a/man/Makefile b/man/Makefile
index f6c77129..ddc38a9b 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -1,5 +1,5 @@
DIR = /usr/share/man/man8
-INC = rc-status.8 rc-update.8 start-stop-daemon.8
+INC = $(CONTENTS)
TOPDIR = ..
include $(TOPDIR)/default.mk
diff --git a/man/rc.8 b/man/rc.8
new file mode 100644
index 00000000..2f43840d
--- /dev/null
+++ b/man/rc.8
@@ -0,0 +1,77 @@
+.\" Copyright 2007 Roy Marples
+.\" All rights reserved
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.Dd Dec 20, 2007
+.Dt RC 8 SMM
+.Os OpenRC
+.Sh NAME
+.Nm rc
+.Nd stops and starts services for the specified runlevel
+.Sh SYNOPSIS
+.Nm
+.Op Fl o , -override
+.Op Ar runlevel
+.Sh DESCRIPTION
+.Nm
+first stops any services that are not for the runlevel and then starts any
+services added by
+.Nm rc-update
+that are not currently started. If no runlevel is specified then we use the
+current runlevel the system is currently in.
+.Pp
+There are some special runlevels that you should be aware of:
+.Bl -tag -width "shutdown"
+.It Ar sysinit
+Brings up any system specific stuff such as
+.Pa /dev ,
+.Pa /proc
+and optionally
+.Pa /sys
+for Linux based sysems. It also mounts
+.Pa /lib/rc/init.d
+as a ramdisk using tmpfs where available.
+.Nm
+uses
+.Pa /lib/rc/init.d
+to hold state information about the services it runs.
+sysinit always runs when the host first starts should not be run again.
+.It Ar boot
+Generally the only services you should add to the boot runlevel are those
+which deal with the mounting of filesystems, set the initial state of attached
+peripherals and logging.
+Coldplugged services are added to the boot runlevel by the system.
+All services in the boot runlevel are automatically included in all other
+runlevels except for those listed here.
+.It Ar single
+Stops all services and enters single user mode.
+.It Ar reboot
+Changes to the single runlevel and then reboots the host.
+.It Ar shutdown
+Changes to the single runlevel and then halts the host.
+.El
+.Sh SEE ALSO
+.Xr rc-status 8 ,
+.Xr rc-update 8
+.Sh AUTHORS
+.An "Roy Marples" Aq roy@marples.name