openrc/man/rc-service.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 May 1, 2009
.Dt RC-SERVICE 8 SMM
.Os OpenRC
.Sh NAME
.Nm rc-service
.Nd locate and run an OpenRC service with the given arguments
.Sh SYNOPSIS
.Nm
.Op Fl c , -ifcrashed
.Ar service cmd
.Op Ar ...
.Nm
.Fl d , -debug
.Ar service cmd
.Op Ar ...
.Nm
.Fl D , -nodeps
.Ar service cmd
.Op Ar ...
.Nm
.Op Fl i , -ifexists
.Ar service cmd
.Op Ar ...
.Nm
.Op Fl I , -ifinactive
.Ar service cmd
.Op Ar ...
.Nm
.Op Fl N , -ifnotstarted
.Ar service cmd
.Op Ar ...
.Nm
.Op Fl s , -ifstarted
.Ar service cmd
.Op Ar ...
.Nm
.Op Fl S , -ifstopped
.Ar service cmd
.Op Ar ...
.Nm
.Fl e , -exists
.Ar service
.Nm
.Fl Z , -dry-run
.Ar service cmd
.Op Ar ...
.Nm
.Fl l , -list
.Nm
.Fl r , -resolve
.Ar service
.Sh DESCRIPTION
Service scripts could be in different places on different systems.
.Nm
locates the specified service and runs it with the given arguments.
If
.Fl i , -ifexists
is given then
.Nm
returns 0 even if the service does not exist.
If
.Fl I , -ifinactive
or
.Fl N , -ifnotstarted
is given then
.Nm
returns 0 if the service exists but is in the wrong state.
.Pp
If given the
.Fl l , -list
argument then
.Nm
will list all available services.
.Pp
.Fl e , -exists
return 0 if it can find
.Ar service ,
otherwise -1.
.Fl r , -resolve
does the same and also prints the full path of the service to stdout.
.Pp
.Fl d , -debug
sets -x when running the service script(s).
.Pp
.Fl D , -nodeps
ignores dependencies when running the service.
.Pp
.Fl Z , -dry-run
displays commands rather than executing them.
.Sh SEE ALSO
.Xr openrc 8 ,
.Xr stdout 3
.Sh AUTHORS
.An Roy Marples <roy@marples.name>
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-04 16:52:19 -06:00			`.\" 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-20 20:07:00 -05:00			`.\" https://github.com/OpenRC/openrc/blob/HEAD/AUTHORS`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.\"`
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-04 16:52:19 -06:00			`.\" 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-20 20:07:00 -05:00			`.\" 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-04 16:52:19 -06:00			`.\" This file may not be copied, modified, propagated, or distributed`
			`.\" except according to the terms contained in the LICENSE file.`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.\"`
Add -i, --ifexists so that we can do this rc-sercice -i foo -- restart instead of this rc-service -e foo && rc-service foo -- restart 2009-05-01 08:38:57 +01:00			`.Dd May 1, 2009`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.Dt RC-SERVICE 8 SMM`
			`.Os OpenRC`
			`.Sh NAME`
			`.Nm rc-service`
Whitespace 2012-01-22 01:17:42 +01:00			`.Nd locate and run an OpenRC service with the given arguments`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.Sh SYNOPSIS`
			`.Nm`
rc-service: add --ifcrashed option This works like the other --if options. If the service is crashed, run the command. This fixes #154. 2017-12-04 17:17:17 -06:00			`.Op Fl c , -ifcrashed`
			`.Ar service cmd`
			`.Op Ar ...`
			`.Nm`
rc-service: add -d/--debug and -D/--nodeps options 2018-05-15 16:59:21 -05:00			`.Fl d , -debug`
			`.Ar service cmd`
			`.Op Ar ...`
			`.Nm`
			`.Fl D , -nodeps`
			`.Ar service cmd`
			`.Op Ar ...`
			`.Nm`
Add -i, --ifexists so that we can do this rc-sercice -i foo -- restart instead of this rc-service -e foo && rc-service foo -- restart 2009-05-01 08:38:57 +01:00			`.Op Fl i , -ifexists`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.Ar service cmd`
			`.Op Ar ...`
Add --list to rc-service to list all available services. 2008-03-21 09:10:59 +00:00			`.Nm`
rc-service: add --ifinactive and --ifnotstarted flags X-Gentoo-Bug: 523174 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=523174 2014-09-21 13:54:51 -05:00			`.Op Fl I , -ifinactive`
			`.Ar service cmd`
			`.Op Ar ...`
			`.Nm`
			`.Op Fl N , -ifnotstarted`
			`.Ar service cmd`
			`.Op Ar ...`
rc-service: add --ifstarted and --ifstopped options 2018-05-16 13:25:22 -05:00			`.Nm`
			`.Op Fl s , -ifstarted`
			`.Ar service cmd`
			`.Op Ar ...`
			`.Nm`
			`.Op Fl S , -ifstopped`
			`.Ar service cmd`
			`.Op Ar ...`
rc-service: add --ifinactive and --ifnotstarted flags X-Gentoo-Bug: 523174 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=523174 2014-09-21 13:54:51 -05:00			`.Nm`
Add --exists and --resolve to rc-service. 2008-03-26 08:08:47 +00:00			`.Fl e , -exists`
			`.Ar service`
			`.Nm`
rc-service: add a --dry-run option This is for #225. 2018-05-14 19:00:04 -05:00			`.Fl Z , -dry-run`
Man: rc-service man page cleanups 2018-05-15 17:09:56 -05:00			`.Ar service cmd`
			`.Op Ar ...`
rc-service: add a --dry-run option This is for #225. 2018-05-14 19:00:04 -05:00			`.Nm`
Add -i, --ifexists so that we can do this rc-sercice -i foo -- restart instead of this rc-service -e foo && rc-service foo -- restart 2009-05-01 08:38:57 +01:00			`.Fl l , -list`
			`.Nm`
Add --exists and --resolve to rc-service. 2008-03-26 08:08:47 +00:00			`.Fl r , -resolve`
			`.Ar service`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.Sh DESCRIPTION`
Whitespace 2012-01-22 01:17:42 +01:00			`Service scripts could be in different places on different systems.`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.Nm`
			`locates the specified service and runs it with the given arguments.`
Add -i, --ifexists so that we can do this rc-sercice -i foo -- restart instead of this rc-service -e foo && rc-service foo -- restart 2009-05-01 08:38:57 +01:00			`If`
			`.Fl i , -ifexists`
			`is given then`
			`.Nm`
			`returns 0 even if the service does not exist.`
rc-service: add --ifinactive and --ifnotstarted flags X-Gentoo-Bug: 523174 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=523174 2014-09-21 13:54:51 -05:00			`If`
			`.Fl I , -ifinactive`
			`or`
			`.Fl N , -ifnotstarted`
			`is given then`
			`.Nm`
			`returns 0 if the service exists but is in the wrong state.`
Add --list to rc-service to list all available services. 2008-03-21 09:10:59 +00:00			`.Pp`
			`If given the`
			`.Fl l , -list`
			`argument then`
			`.Nm`
			`will list all available services.`
Add --exists and --resolve to rc-service. 2008-03-26 08:08:47 +00:00			`.Pp`
Add -i, --ifexists so that we can do this rc-sercice -i foo -- restart instead of this rc-service -e foo && rc-service foo -- restart 2009-05-01 08:38:57 +01:00			`.Fl e , -exists`
Add --exists and --resolve to rc-service. 2008-03-26 08:08:47 +00:00			`return 0 if it can find`
			`.Ar service ,`
			`otherwise -1.`
Add -i, --ifexists so that we can do this rc-sercice -i foo -- restart instead of this rc-service -e foo && rc-service foo -- restart 2009-05-01 08:38:57 +01:00			`.Fl r , -resolve`
Add --exists and --resolve to rc-service. 2008-03-26 08:08:47 +00:00			`does the same and also prints the full path of the service to stdout.`
rc-service: add a --dry-run option This is for #225. 2018-05-14 19:00:04 -05:00			`.Pp`
rc-service: add -d/--debug and -D/--nodeps options 2018-05-15 16:59:21 -05:00			`.Fl d , -debug`
			`sets -x when running the service script(s).`
			`.Pp`
			`.Fl D , -nodeps`
			`ignores dependencies when running the service.`
			`.Pp`
rc-service: add a --dry-run option This is for #225. 2018-05-14 19:00:04 -05:00			`.Fl Z , -dry-run`
Man: rc-service man page cleanups 2018-05-15 17:09:56 -05:00			`displays commands rather than executing them.`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.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-11 17:39:38 -06:00			`.Xr openrc 8 ,`
Add --exists and --resolve to rc-service. 2008-03-26 08:08:47 +00:00			`.Xr stdout 3`
Add rc-service and update all softlevel refs to runlevel. 2008-03-19 17:11:50 +00:00			`.Sh AUTHORS`
Typo. 2008-12-30 19:08:51 +00:00			`.An Roy Marples <roy@marples.name>`