From 7b5fa011ac7a9544fe68a9abb2f8ef940d9845f7 Mon Sep 17 00:00:00 2001 From: William Hubbs Date: Wed, 11 Dec 2013 17:39:38 -0600 Subject: Rename the rc binary to openrc Debian requested this rename due to the "rc" binary conflicting with the "rc" binary from the plan 9 shell. We also add a deprecation warning to the binary when it is run as rc to encourage users to switch to openrc instead. X-Gentoo-Bug: 493958 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=493958 --- man/Makefile | 2 +- man/openrc.8 | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++ man/rc-service.8 | 2 +- man/rc-status.8 | 2 +- man/rc-update.8 | 2 +- man/rc.8 | 87 ---------------------------------------------------- man/rc_plugin_hook.3 | 2 +- man/runscript.8 | 4 +-- 8 files changed, 94 insertions(+), 94 deletions(-) create mode 100644 man/openrc.8 delete mode 100644 man/rc.8 (limited to 'man') diff --git a/man/Makefile b/man/Makefile index 4110c8f7..04862da2 100644 --- a/man/Makefile +++ b/man/Makefile @@ -1,7 +1,7 @@ MAN3= einfo.3 \ rc_config.3 rc_deptree.3 rc_find_pids.3 rc_plugin_hook.3 \ rc_runlevel.3 rc_service.3 rc_stringlist.3 -MAN8= rc-service.8 rc-status.8 rc-update.8 rc.8 runscript.8 \ +MAN8= rc-service.8 rc-status.8 rc-update.8 openrc.8 runscript.8 \ service.8 start-stop-daemon.8 # Handy macro to create symlinks diff --git a/man/openrc.8 b/man/openrc.8 new file mode 100644 index 00000000..35e21a74 --- /dev/null +++ b/man/openrc.8 @@ -0,0 +1,87 @@ +.\" Copyright (c) 2007-2009 Roy Marples +.\" +.\" 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 May 2, 2009 +.Dt OPENRC 8 SMM +.Os OpenRC +.Sh NAME +.Nm openrc +.Nd stops and starts services for the specified runlevel +.Sh SYNOPSIS +.Nm +.Op Fl n , -no-stop +.Op Fl o , -override +.Op Ar runlevel +.Sh DESCRIPTION +.Nm +first stops any services that are not in the specified runlevel unless +--no-stop is specified, then starts any services in the runlevel and +stacked runlevels added by +.Nm rc-update +that are not currently started. +If no runlevel is specified, we use the current runlevel. +.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 systems. It also mounts +.Pa /lib/rc/init.d +as a ramdisk using tmpfs where available unless / is mounted rw at boot. +.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. +Hotplugged services are added to the boot runlevel by the system. +All services in the boot and sysinit runlevels are automatically included +in all other runlevels except for those listed here. +.It Ar single +Stops all services except for those in the sysinit runlevel. +.It Ar reboot +Changes to the shutdown runlevel and then reboots the host. +.It Ar shutdown +Changes to the shutdown runlevel and then halts the host. +.El +.Pp +You should not call any of these runlevels yourself. +Instead you should use +.Xr init 8 +and +.Xr shutdown 8 +and let them call these special runlevels. +.Sh SEE ALSO +.Xr rc-status 8 , +.Xr rc-update 8 , +.Xr init 8 , +.Xr shutdown 8 +.Sh AUTHORS +.An Roy Marples Aq roy@marples.name diff --git a/man/rc-service.8 b/man/rc-service.8 index c40c7478..5ed5ce5c 100644 --- a/man/rc-service.8 +++ b/man/rc-service.8 @@ -63,7 +63,7 @@ otherwise -1. .Fl r , -resolve does the same and also prints the full path of the service to stdout. .Sh SEE ALSO -.Xr rc 8 , +.Xr openrc 8 , .Xr stdout 3 .Sh AUTHORS .An Roy Marples diff --git a/man/rc-status.8 b/man/rc-status.8 index 90f26038..48f51a35 100644 --- a/man/rc-status.8 +++ b/man/rc-status.8 @@ -66,7 +66,7 @@ exits 0, except when checking for crashed services and it doesn't find any. tries to list services within each runlevel in the presently resolved dependency order if the dependency tree is available. .Sh SEE ALSO -.Xr rc 8 , +.Xr openrc 8 , .Xr rc-update 8 .Sh AUTHORS .An Roy Marples diff --git a/man/rc-update.8 b/man/rc-update.8 index 088b5fea..459f0693 100644 --- a/man/rc-update.8 +++ b/man/rc-update.8 @@ -86,7 +86,7 @@ If the option is given then we either add or remove the runlevel from the runlevel. This allows inheritance of runlevels. .Sh SEE ALSO -.Xr rc 8 , +.Xr openrc 8 , .Xr rc-status 8 .Sh AUTHORS .An Roy Marples diff --git a/man/rc.8 b/man/rc.8 deleted file mode 100644 index dd457888..00000000 --- a/man/rc.8 +++ /dev/null @@ -1,87 +0,0 @@ -.\" Copyright (c) 2007-2009 Roy Marples -.\" -.\" 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 May 2, 2009 -.Dt RC 8 SMM -.Os OpenRC -.Sh NAME -.Nm rc -.Nd stops and starts services for the specified runlevel -.Sh SYNOPSIS -.Nm -.Op Fl n , -no-stop -.Op Fl o , -override -.Op Ar runlevel -.Sh DESCRIPTION -.Nm -first stops any services that are not in the specified runlevel unless ---no-stop is specified, then starts any services in the runlevel and -stacked runlevels added by -.Nm rc-update -that are not currently started. -If no runlevel is specified, we use the current runlevel. -.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 systems. It also mounts -.Pa /lib/rc/init.d -as a ramdisk using tmpfs where available unless / is mounted rw at boot. -.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. -Hotplugged services are added to the boot runlevel by the system. -All services in the boot and sysinit runlevels are automatically included -in all other runlevels except for those listed here. -.It Ar single -Stops all services except for those in the sysinit runlevel. -.It Ar reboot -Changes to the shutdown runlevel and then reboots the host. -.It Ar shutdown -Changes to the shutdown runlevel and then halts the host. -.El -.Pp -You should not call any of these runlevels yourself. -Instead you should use -.Xr init 8 -and -.Xr shutdown 8 -and let them call these special runlevels. -.Sh SEE ALSO -.Xr rc-status 8 , -.Xr rc-update 8 , -.Xr init 8 , -.Xr shutdown 8 -.Sh AUTHORS -.An Roy Marples Aq roy@marples.name diff --git a/man/rc_plugin_hook.3 b/man/rc_plugin_hook.3 index ab83b4c2..22a1c589 100644 --- a/man/rc_plugin_hook.3 +++ b/man/rc_plugin_hook.3 @@ -44,7 +44,7 @@ is set to the name of the runlevel or name of the service. Plugins can affect the parent environment by writing NULL separated strings to .Va rc_environ_fd . .Sh SEE ALSO -.Xr rc 8 , +.Xr openrc 8 , .Xr runscript 8 .Sh AUTHORS .An Roy Marples diff --git a/man/runscript.8 b/man/runscript.8 index 7a0b79ed..e0d7cf02 100644 --- a/man/runscript.8 +++ b/man/runscript.8 @@ -343,7 +343,7 @@ sets the following environment variables for use in the service scripts: .It Va RC_SVCNAME Name of the service. .It Va RC_RUNLEVEL -Current runlevel that rc is in. Note that, in OpenRC, the reboot +Current runlevel that OpenRC is in. Note that, in OpenRC, the reboot runlevel is mapped to the shutdown runlevel. This was done because most services do not need to know if a system is shutting down or rebooting. If you are writing a service that does need to know this, see the @@ -536,7 +536,7 @@ Instead we return 1 to be compliant with Gentoo baselayout. Users are encouraged to use the is_newer_than function which returns correctly. .Sh SEE ALSO .Xr einfo 3 , -.Xr rc 8 , +.Xr openrc 8 , .Xr rc-status 8 , .Xr rc-update 8 , .Xr rc_plugin_hook 3 , -- cgit v1.2.3