summary refs log tree commit diff
path: root/doc/s6-halt.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/s6-halt.html')
-rw-r--r--doc/s6-halt.html34
1 files changed, 26 insertions, 8 deletions
diff --git a/doc/s6-halt.html b/doc/s6-halt.html
index 5a2e45c..4837b86 100644
--- a/doc/s6-halt.html
+++ b/doc/s6-halt.html
@@ -5,7 +5,7 @@
     <meta http-equiv="Content-Language" content="en" />
     <title>s6-linux-utils: the s6-halt program</title>
     <meta name="Description" content="s6-linux-utils: the s6-halt program" />
-    <meta name="Keywords" content="s6 linux administration root utilities halt" />
+    <meta name="Keywords" content="s6 linux administration root utilities shutdown halt poweroff reboot" />
     <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
   </head>
 <body>
@@ -19,19 +19,37 @@
 <h1> The <tt>s6-halt</tt> program </h1>
 
 <p>
-<tt>s6-halt</tt> syncs the filesystems and halts the machine
-immediately, without switching the power off.
-<br /> This is different from the sysvinit <tt>halt</tt>
-command, which is an alias for <tt>shutdown -h</tt>. The
-s6-linux-utils <tt>s6-halt</tt> command is more or less equivalent to
-sysvinit's <tt>halt -f</tt>.
+<tt>s6-halt</tt> sends a signal to process 1 in order to halt the machine;
+or, with the <tt>-f</tt> option, it performs an immediate hard shutdown.
 </p>
 
 <h2> Interface </h2>
 
 <pre>
-     s6-halt
+     s6-halt [ -h | -p | -r ] [ -f ]
 </pre>
 
+<ul>
+ <li> s6-halt sends a signal to process 1. </li>
+ <li> It then exits 0. </li>
+</ul>
+
+<h2> Options </h2>
+
+<ul>
+ <li> <tt>-h</tt>&nbsp;: halt. The command will order a halt (i.e. the system will
+be shut down, but the power will remain up), which means
+sending a SIGUSR2 to process 1. This is the default. </li>
+ <li> <tt>-p</tt>&nbsp;: poweroff. The command will order a power off, which means
+sending a SIGUSR1 to process 1. </li>
+ <li> <tt>-r</tt>&nbsp;: reboot. The command will order a reboot, which means
+sending a SIGINT to process 1. </li>
+ <li> <tt>-f</tt>&nbsp;: force. The command will not send any signal to process 1;
+it will just sync the filesystems then tell the kernel to halt, poweroff or reboot.
+<tt>s6-reboot -f</tt> or <tt>s6-poweroff -f</tt> should be the last program
+executed in the lifetime of a machine, at the end of the shutdown script called
+by process 1 when it receives a signal telling it to shut down. </li>
+</ul>
+
 </body>
 </html>