summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2020-08-20 14:12:21 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2020-08-20 14:12:21 +0000
commita1b139e5d448b260b3f7849a5b24f45da45241a1 (patch)
tree586de8ab8a63aade7913746af9e1b9914f54e52a /doc
parentb8941152d21047e2e4fb3a1f2533c9b8512d8e2c (diff)
downloads6-rc-a1b139e5d448b260b3f7849a5b24f45da45241a1.tar.xz
Add the notion of essential service
Diffstat (limited to 'doc')
-rw-r--r--doc/s6-rc-compile.html5
-rw-r--r--doc/s6-rc.html11
2 files changed, 15 insertions, 1 deletions
diff --git a/doc/s6-rc-compile.html b/doc/s6-rc-compile.html
index d931b91..b429e8e 100644
--- a/doc/s6-rc-compile.html
+++ b/doc/s6-rc-compile.html
@@ -143,6 +143,11 @@ is ignored, but trailing whitespace is not. Lines starting with a <tt>#</tt>
character are ignored. The file defines the <em>direct dependencies</em> of
<em>service</em>, i.e. the services that must be up in order for
<em>service</em> to work properly. </li>
+ <li> An optional regular file named <tt>flag-essential</tt>. The contents of this
+file are irrelevant, only its presence is tested. If this file exists, the service
+will be marked as essential, which means that a <tt>s6-rc -d change <em>foo</em></tt>
+command will not stop the service. Only a <tt>s6-rc -D change <em>foo</em></tt>
+command will. </li>
</ul>
<p>
diff --git a/doc/s6-rc.html b/doc/s6-rc.html
index 85a223e..bccc1b5 100644
--- a/doc/s6-rc.html
+++ b/doc/s6-rc.html
@@ -50,7 +50,7 @@ root privileges.
s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] list <em>servicenames...</em>
s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] listall <em>servicenames...</em>
s6-rc [ -l live ] [ -b ] diff
- s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d ] [ -p ] [ -v <em>verbosity</em> ] [ -n <em>dryrunthrottle</em> ] [ -t timeout ] change [ <em>servicenames...</em> ]
+ s6-rc [ -l live ] [ -b ] [ -a ] [ -u | -d | -D ] [ -p ] [ -v <em>verbosity</em> ] [ -n <em>dryrunthrottle</em> ] [ -t timeout ] change [ <em>servicenames...</em> ]
</pre>
<ul>
@@ -122,8 +122,17 @@ Default is <em>up</em>.
<ul>
<li> <tt>-u</tt>&nbsp;: up. </li>
<li> <tt>-d</tt>&nbsp;: down. </li>
+ <li> <tt>-D</tt>&nbsp;: force down. </li>
</ul>
+<p>
+ The <tt>-d</tt> option is what should normally be used to down a set of services.
+If a service is marked as <em>essential</em> (there is a <tt>flag-essential</tt> file
+in its service definition directory), then s6-rc will refuse to stop that service.
+The <tt>-D</tt> option will still force that service to shut down; that option should
+only be used when the machine is going to be stopped.
+</p>
+
<h3> <tt>s6-rc change</tt> control </h3>
<ul>