about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2016-03-19 12:33:27 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2016-03-19 12:33:27 +0000
commitd18999790c462bc780bff457e6bb03cd88e488f3 (patch)
tree299f9b86d74b10d5b63195c56e3fd9ba75d8f93f /doc
parent96893711ec76b3c3b554313d7e97560b3cd62179 (diff)
downloads6-linux-utils-d18999790c462bc780bff457e6bb03cd88e488f3.tar.gz
s6-linux-utils-d18999790c462bc780bff457e6bb03cd88e488f3.tar.xz
s6-linux-utils-d18999790c462bc780bff457e6bb03cd88e488f3.zip
Changes to s6-halt/s6-reboot/s6-poweroff. Default behaviour changed.
 Major version bump: rc for 2.1.0.0
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html2
-rw-r--r--doc/s6-halt.html34
-rw-r--r--doc/s6-poweroff.html37
-rw-r--r--doc/s6-reboot.html36
-rw-r--r--doc/upgrade.html10
5 files changed, 89 insertions, 30 deletions
diff --git a/doc/index.html b/doc/index.html
index fca89fa..f8e24f1 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -48,7 +48,7 @@ library. </li>
 <h3> Download </h3>
 
 <ul>
- <li> The current released version of s6-linux-utils is <a href="s6-linux-utils-2.0.2.3.tar.gz">2.0.2.3</a>. </li>
+ <li> The current released version of s6-linux-utils is <a href="s6-linux-utils-2.1.0.0.tar.gz">2.1.0.0</a>. </li>
  <li> Alternatively, you can checkout a copy of the s6-linux-utils git repository:
 <pre> git clone git://git.skarnet.org/s6-linux-utils </pre> </li>
 </ul>
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>
diff --git a/doc/s6-poweroff.html b/doc/s6-poweroff.html
index 13af3e5..5b0a4fc 100644
--- a/doc/s6-poweroff.html
+++ b/doc/s6-poweroff.html
@@ -5,7 +5,7 @@
     <meta http-equiv="Content-Language" content="en" />
     <title>s6-linux-utils: the s6-poweroff program</title>
     <meta name="Description" content="s6-linux-utils: the s6-poweroff program" />
-    <meta name="Keywords" content="s6 linux administration root poweroff system halt power off" />
+    <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,22 +19,37 @@
 <h1> The <tt>s6-poweroff</tt> program </h1>
 
 <p>
-<tt>s6-poweroff</tt> syncs the filesystems and halts the machine
-immediately, switching the power off if possible.
-</p>
-
-<p>
- This is different from the sysvinit <tt>poweroff</tt>
-command, which performs <tt>shutdown</tt>. The
-s6-linux-utils <tt>s6-poweroff</tt> command is more or less equivalent to
-sysvinit's <tt>poweroff -f</tt>.
+<tt>s6-poweroff</tt> sends a signal to process 1 in order to power off the machine;
+or, with the <tt>-f</tt> option, it performs an immediate hard shutdown.
 </p>
 
 <h2> Interface </h2>
 
 <pre>
-     s6-poweroff
+     s6-poweroff [ -h | -p | -r ] [ -f ]
 </pre>
 
+<ul>
+ <li> s6-poweroff 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. </li>
+ <li> <tt>-p</tt>&nbsp;: poweroff. The command will order a power off, which means
+sending a SIGUSR1 to process 1. This is the default. </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>
diff --git a/doc/s6-reboot.html b/doc/s6-reboot.html
index f8e9ccd..7f01260 100644
--- a/doc/s6-reboot.html
+++ b/doc/s6-reboot.html
@@ -5,7 +5,7 @@
     <meta http-equiv="Content-Language" content="en" />
     <title>s6-linux-utils: the s6-reboot program</title>
     <meta name="Description" content="s6-linux-utils: the s6-reboot program" />
-    <meta name="Keywords" content="s6 linux administration root utilities reboot power shutdown" />
+    <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,21 +19,37 @@
 <h1> The <tt>s6-reboot</tt> program </h1>
 
 <p>
-<tt>s6-reboot</tt> syncs the filesystems and reboots the machine
-immediately.
-</p>
-
-<p> This is different from the sysvinit <tt>reboot</tt>
-command, which is an alias for <tt>shutdown -r</tt>. The
-s6-linux-utils <tt>s6-reboot</tt> command is more or less equivalent to
-sysvinit's <tt>reboot -f</tt>.
+<tt>s6-reboot</tt> sends a signal to process 1 in order to reboot the machine;
+or, with the <tt>-f</tt> option, it performs an immediate reboot.
 </p>
 
 <h2> Interface </h2>
 
 <pre>
-     s6-reboot
+     s6-reboot [ -h | -p | -r ] [ -f ]
 </pre>
 
+<ul>
+ <li> s6-reboot 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. </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. This is the default. </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>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index f8be8a8..e6930ed 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,16 @@
 
 <h1> What has changed in s6-linux-utils </h1>
 
+<h2> in 2.1.0.0 </h2>
+
+<ul>
+ <li> <a href="s6-halt.html">s6-halt</a>,
+<a href="s6-poweroff.html">s6-poweroff</a> and
+<a href="s6-reboot.html">s6-reboot</a> have changed behaviours.
+They now send a signal to process 1 by default; to make them
+perform a hard shutdown, add the <tt>-f</tt> option. </li>
+</ul>
+
 <h2> in 2.0.2.3 </h2>
 
 <ul>