summaryrefslogtreecommitdiff
path: root/doc/s6-linux-init-shutdownd.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/s6-linux-init-shutdownd.html')
-rw-r--r--doc/s6-linux-init-shutdownd.html72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/s6-linux-init-shutdownd.html b/doc/s6-linux-init-shutdownd.html
new file mode 100644
index 0000000..8889a9e
--- /dev/null
+++ b/doc/s6-linux-init-shutdownd.html
@@ -0,0 +1,72 @@
+<html>
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>s6-linux-init: the s6-linux-init-shutdownd program</title>
+ <meta name="Description" content="s6-linux-init: the s6-linux-init-shutdownd program" />
+ <meta name="Keywords" content="s6 linux init administration root utilities shutdown halt poweroff reboot daemon shutdownd" />
+ <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">s6-linux-init</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The <tt>s6-linux-init-shutdownd</tt> program </h1>
+
+<p>
+<tt>s6-linux-init-shutdownd</tt> is the daemon that manages the shutdown
+procedure for a s6-linux-init installation. It is not meant to be called
+directly by the user.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-linux-init-shutdownd [ -c <em>basedir</em> ] [ -g <em>gracetime</em> ] <em>fifo</em>
+</pre>
+
+<ul>
+ <li> <tt>s6-linux-init-shutdownd</tt> opens the <em>fifo</em> named pipe
+and listens to it. This is where programs such as
+<a href="s6-linux-init-shutdown.html">s6-linux-init-shutdown</a> send their
+commands when they are told to trigger the shutdown procedure.</li>
+ <li> When it receives a command to shut down, <tt>s6-linux-init-shutdownd</tt>
+first spawns the <em>rc.shutdown</em> script defined by the
+<a href="s6-linux-init-maker.html">s6-linux-init-maker</a> invocation that
+created the shutdownd service. </li>
+ <li> When this script exits, <tt>s6-linux-init-shutdownd</tt> kills all
+processes, first with a SIGTERM, then (after the grace time specified by
+the shutdown command) with a SIGKILL. </li>
+ <li> It then runs an automatically-generated script (called <em>stage 4</em>),
+which unmounts the file systems and halts, powers off or reboots the
+machine. </li>
+</ul>
+
+<h2> Options </h2>
+
+<ul>
+ <li> <tt>-c&nbsp;<em>basedir</em></tt>&nbsp;: look for the
+<em>rc.shutdown</em> script in the <em>basedir</em><tt>/scripts</tt>
+directory. Default is <tt>/etc/s6-linux-init/current</tt>. </li>
+ <li> <tt>-g&nbsp;<em>gracetime</em></tt>&nbsp;: if the shutdown command
+does not specify a grace time between the SIGTERM and the SIGKILL, use
+<em>gracetime</em> milliseconds. Default is 3000. </li>
+</ul>
+
+<h2> Notes </h2>
+
+<ul>
+ <li> The <a href="s6-linux-init-shutdownd.html">s6-linux-init-shutdownd</a>
+binary is not meant to be called directly by administrators. It is run
+by a <a href="//skarnet.org/software/s6/">s6</a> service that is automatically
+generated by
+<a href="s6-linux-init-maker.html">s6-linux-init-maker</a>. </li>
+</ul>
+
+</body>
+</html>