openrc/man/rc-update.8

.\" Copyright (c) 2007-2015 The OpenRC Authors.
.\" See the Authors file at the top-level directory of this distribution and
.\" https://github.com/OpenRC/openrc/blob/HEAD/AUTHORS
.\"
.\" This file is part of OpenRC. It is subject to the license terms in
.\" the LICENSE file found in the top-level directory of this
.\" distribution and at https://github.com/OpenRC/openrc/blob/HEAD/LICENSE
.\" This file may not be copied, modified, propagated, or distributed
.\"    except according to the terms contained in the LICENSE file.
.\"
.Dd Jan 13, 2014
.Dt RC-UPDATE 8 SMM
.Os OpenRC
.Sh NAME
.Nm rc-update
.Nd add and remove services to and from a runlevel
.Sh SYNOPSIS
.Nm
.Op Fl s , -stack
.Ar add
.Ar service
.Op Ar runlevel ...
.Nm
.Op Fl s , -stack
.Op Fl a , -all
.Ar delete
.Ar service
.Op Ar runlevel ...
.Nm
.Op Fl u , -update
.Op Fl v , -verbose
.Ar show
.Op Ar runlevel ...
.Sh DESCRIPTION
OpenRC uses named runlevels.  Rather than editing some obscure
file or managing a directory of symlinks,
.Nm
exists to quickly add or delete services to and from different runlevels.
All services must reside in the
.Pa /etc/init.d
or
.Pa /usr/local/etc/init.d
directories.
They must also be standard OpenRC scripts, meaning they must use
openrc-run.
.Pp
.Bl -tag -width "Fl a , -delete service"
.It Ar add Ar service
Add the
.Ar service
to the
.Ar runlevel
or the current one if none given.
Services added to the boot runlevel must exist in
.Pa /etc/init.d .
.It Ar delete Ar service
Delete the
.Ar service
from the
.Ar runlevel
or the current one if none given.
.It Ar show
Show all enabled services and the runlevels they belong to.  If you specify
runlevels to show, then only those will be included in the output.
.It Fl v , -verbose
Show all services.
.It Fl u , -update
Forces an update of the dependency tree cache.
This may be needed in the event of clock skew (a file in /etc is newer than the
system clock).
.El
.Pp
If the
.Fl s , -stack
option is given then we either add or remove the runlevel from the runlevel.
This allows inheritance of runlevels.
.Pp
If the
.Fl a, -all
option is given, we remove the service from all runlevels. This is
useful, for example, to clean up the dangling symlinks after a service
is removed.
.Sh SEE ALSO
.Xr openrc 8 ,
.Xr openrc-run 8 ,
.Xr rc-status 8
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
.An The OpenRC Team <openrc@gentoo.org>
Convert OpenRC to a centralized copyright/license structure In the past, OpenRC was a hybrid of a centralized and file-scope license/copyright structure. I followed the instructions from the Software Freedom Law Center [1] to convert to a Centralized structure where possible, for easier future maintenance. [1] https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html 2015-12-05 04:22:19 +05:30			`.\" Copyright (c) 2007-2015 The OpenRC Authors.`
			`.\" See the Authors file at the top-level directory of this distribution and`
use HEAD in git URIs to point to the default branch This makes the URIs shorter and dynamic: whatever the default branch the repo uses will be used. 2021-12-21 06:37:00 +05:30			`.\" https://github.com/OpenRC/openrc/blob/HEAD/AUTHORS`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.\"`
Convert OpenRC to a centralized copyright/license structure In the past, OpenRC was a hybrid of a centralized and file-scope license/copyright structure. I followed the instructions from the Software Freedom Law Center [1] to convert to a Centralized structure where possible, for easier future maintenance. [1] https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html 2015-12-05 04:22:19 +05:30			`.\" This file is part of OpenRC. It is subject to the license terms in`
			`.\" the LICENSE file found in the top-level directory of this`
use HEAD in git URIs to point to the default branch This makes the URIs shorter and dynamic: whatever the default branch the repo uses will be used. 2021-12-21 06:37:00 +05:30			`.\" distribution and at https://github.com/OpenRC/openrc/blob/HEAD/LICENSE`
Convert OpenRC to a centralized copyright/license structure In the past, OpenRC was a hybrid of a centralized and file-scope license/copyright structure. I followed the instructions from the Software Freedom Law Center [1] to convert to a Centralized structure where possible, for easier future maintenance. [1] https://softwarefreedom.org/resources/2012/ManagingCopyrightInformation.html 2015-12-05 04:22:19 +05:30			`.\" This file may not be copied, modified, propagated, or distributed`
			`.\" except according to the terms contained in the LICENSE file.`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.\"`
rc-update: add option to remove a service from all runlevels The -a option,which only applies to the del command, is used to remove a service from all runlevels. X-Gentoo-Bug: 497740 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=497740 2014-01-13 20:48:40 +05:30			`.Dd Jan 13, 2014`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Dt RC-UPDATE 8 SMM`
			`.Os OpenRC`
			`.Sh NAME`
			`.Nm rc-update`
Whitespace 2012-01-22 05:47:42 +05:30			`.Nd add and remove services to and from a runlevel`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Sh SYNOPSIS`
			`.Nm`
Add runlevel stacking, #88 This implementation has the limitation that you cannot have a stacked runlevel and service of the same name in a runlevel. 2009-05-02 16:56:45 +05:30			`.Op Fl s , -stack`
We should not use options for rc-update, as add, delete and such are commands. 2008-01-15 15:20:14 +05:30			`.Ar add`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Ar service`
			`.Op Ar runlevel ...`
			`.Nm`
Add runlevel stacking, #88 This implementation has the limitation that you cannot have a stacked runlevel and service of the same name in a runlevel. 2009-05-02 16:56:45 +05:30			`.Op Fl s , -stack`
rc-update: add option to remove a service from all runlevels The -a option,which only applies to the del command, is used to remove a service from all runlevels. X-Gentoo-Bug: 497740 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=497740 2014-01-13 20:48:40 +05:30			`.Op Fl a , -all`
We should not use options for rc-update, as add, delete and such are commands. 2008-01-15 15:20:14 +05:30			`.Ar delete`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Ar service`
			`.Op Ar runlevel ...`
			`.Nm`
We now warn about clock skews rc-update -u will force a regen of the dep tree rc_newer_than and rc_olderthan now take another two parameters for newest/oldest file and mtime 2009-01-13 05:23:13 +05:30			`.Op Fl u , -update`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Op Fl v , -verbose`
We should not use options for rc-update, as add, delete and such are commands. 2008-01-15 15:20:14 +05:30			`.Ar show`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Op Ar runlevel ...`
			`.Sh DESCRIPTION`
Whitespace 2012-01-22 05:47:42 +05:30			`OpenRC uses named runlevels. Rather than editing some obscure`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`file or managing a directory of symlinks,`
			`.Nm`
multiple spelling and typo fixes This fixes #516. 2022-04-15 21:23:24 +05:30			`exists to quickly add or delete services to and from different runlevels.`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`All services must reside in the`
			`.Pa /etc/init.d`
			`or`
			`.Pa /usr/local/etc/init.d`
Add runlevel stacking, #88 This implementation has the limitation that you cannot have a stacked runlevel and service of the same name in a runlevel. 2009-05-02 16:56:45 +05:30			`directories.`
Rename runscript to openrc-run This was requested by Debian, because the minicom software, which is available on Debian and other distros, has a binary named runscript. We are keeping a backward compatibility symlink for now, but this allows Debian or any other distro to safely remove the symlink. X-Gentoo-Bug: 494220 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=494220 2013-12-22 02:21:11 +05:30			`They must also be standard OpenRC scripts, meaning they must use`
			`openrc-run.`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Pp`
			`.Bl -tag -width "Fl a , -delete service"`
We now warn about clock skews rc-update -u will force a regen of the dep tree rc_newer_than and rc_olderthan now take another two parameters for newest/oldest file and mtime 2009-01-13 05:23:13 +05:30			`.It Ar add Ar service`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`Add the`
			`.Ar service`
			`to the`
			`.Ar runlevel`
			`or the current one if none given.`
			`Services added to the boot runlevel must exist in`
			`.Pa /etc/init.d .`
We should not use options for rc-update, as add, delete and such are commands. 2008-01-15 15:20:14 +05:30			`.It Ar delete Ar service`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`Delete the`
			`.Ar service`
			`from the`
			`.Ar runlevel`
			`or the current one if none given.`
We should not use options for rc-update, as add, delete and such are commands. 2008-01-15 15:20:14 +05:30			`.It Ar show`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`Show all enabled services and the runlevels they belong to. If you specify`
			`runlevels to show, then only those will be included in the output.`
			`.It Fl v , -verbose`
			`Show all services.`
We now warn about clock skews rc-update -u will force a regen of the dep tree rc_newer_than and rc_olderthan now take another two parameters for newest/oldest file and mtime 2009-01-13 05:23:13 +05:30			`.It Fl u , -update`
			`Forces an update of the dependency tree cache.`
Typo, #150 Thanks to betelgeuse 2009-02-13 18:22:29 +05:30			`This may be needed in the event of clock skew (a file in /etc is newer than the`
We now warn about clock skews rc-update -u will force a regen of the dep tree rc_newer_than and rc_olderthan now take another two parameters for newest/oldest file and mtime 2009-01-13 05:23:13 +05:30			`system clock).`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.El`
Add runlevel stacking, #88 This implementation has the limitation that you cannot have a stacked runlevel and service of the same name in a runlevel. 2009-05-02 16:56:45 +05:30			`.Pp`
			`If the`
			`.Fl s , -stack`
			`option is given then we either add or remove the runlevel from the runlevel.`
			`This allows inheritance of runlevels.`
Fix mdoc warning for empty line in rc-update man page. X-Gentoo-Bug: 529374 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=529374 2014-11-22 23:11:10 +05:30			`.Pp`
rc-update: add option to remove a service from all runlevels The -a option,which only applies to the del command, is used to remove a service from all runlevels. X-Gentoo-Bug: 497740 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=497740 2014-01-13 20:48:40 +05:30			`If the`
			`.Fl a, -all`
			`option is given, we remove the service from all runlevels. This is`
			`useful, for example, to clean up the dangling symlinks after a service`
			`is removed.`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Sh SEE ALSO`
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 2013-12-12 05:09:38 +05:30			`.Xr openrc 8 ,`
Rename runscript to openrc-run This was requested by Debian, because the minicom software, which is available on Debian and other distros, has a binary named runscript. We are keeping a backward compatibility symlink for now, but this allows Debian or any other distro to safely remove the symlink. X-Gentoo-Bug: 494220 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=494220 2013-12-22 02:21:11 +05:30			`.Xr openrc-run 8 ,`
Rework the manpages into mdoc format for easier maintainence 2007-12-17 15:44:54 +05:30			`.Xr rc-status 8`
			`.Sh AUTHORS`
Typo. 2008-12-31 00:38:51 +05:30			`.An Roy Marples <roy@marples.name>`
rc-update: add option to remove a service from all runlevels The -a option,which only applies to the del command, is used to remove a service from all runlevels. X-Gentoo-Bug: 497740 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=497740 2014-01-13 20:48:40 +05:30			`.An The OpenRC Team <openrc@gentoo.org>`