aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Hubbs <w.d.hubbs@gmail.com>2013-08-13 12:12:43 -0500
committerWilliam Hubbs <w.d.hubbs@gmail.com>2013-08-13 12:12:43 -0500
commitb2f8ac9382d5dad70181ef803a37f43896f5cb91 (patch)
treef12b270ef37f923d3f82777e6b3dcf541d24b2f9
parent6b0ffd31035ddf6907dcf513afda9975ef425d02 (diff)
Clarify the documentation about the restart function
Restart has never been able to be overridden in OpenRc, but there is a way to make your service script behave differently when restart is being executed. X-Gentoo-Bug: 480866 X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=480866
-rw-r--r--man/runscript.88
1 files changed, 6 insertions, 2 deletions
diff --git a/man/runscript.8 b/man/runscript.8
index 72775465..ddce662c 100644
--- a/man/runscript.8
+++ b/man/runscript.8
@@ -60,7 +60,10 @@ First we ensure that any services that depend on us are stopped. If any
services that need us fail to stop then we exit with a suitable error,
otherwise call the supplied stop function if it exists.
.It Ar restart
-Stop and start the service, including dependencies.
+Stop and start the service, including dependencies. This cannot be
+overridden. See the description of the RC_CMD variable below for the
+method to make your service behave differently when restart is being
+executed.
.It Ar status
Show the status of the service. The return code matches the status, with the
exception of "started" returning 0 to match standard command behaviour.
@@ -362,7 +365,8 @@ offset. Otherwise it is undefined.
The result of `uname -s`.
.It Va RC_CMD
This contains the name of the command the service script is executing, such
-as start, stop, restart etc.
+as start, stop, restart etc. One example of using this is to make a
+service script behave differently when restart is being executed.
.El
.Sh FILES
.Pp