af_unix: add lxc_abstract_unix_send_fds_iov

[mirror_lxc.git] / doc / lxc-stop.sgml.in

diff --git a/doc/lxc-stop.sgml.in b/doc/lxc-stop.sgml.in
index 09ea5d6be022a534dc6a97a3dcfdc9c20c68aa8b..09db5f6215ee461ad40a5f1fbcaa1228e5c5ce4c 100644 (file)
--- a/doc/lxc-stop.sgml.in
+++ b/doc/lxc-stop.sgml.in
@@ -54,7 +54,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
       <arg choice="opt">-r</arg>
       <arg choice="opt">-t <replaceable>timeout</replaceable></arg>
       <arg choice="opt">-k</arg>
-      <arg choice="opt">-s</arg>
+      <arg choice="opt">--nokill</arg>
+      <arg choice="opt">--nolock</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -64,15 +65,19 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
     <para>
       <command>lxc-stop</command> reboots, cleanly shuts down, or kills
       all the processes inside the container.  By default, it will
-      request a clean shutdown of the container (by sending SIGPWR to
-      the container), wait 60 seconds for the container to exit, and
-      returns.  If the container fails to cleanly exit, then after 60
-      seconds the container will be sent the
-      <command>lxc.stopsignal</command> to force it to shut down.
+      request a clean shutdown of the container by sending
+      <command>lxc.signal.halt</command> (defaults to SIGPWR) to
+      the container's init process, waiting up to 60 seconds for the container
+      to exit, and then returning. If the container fails to cleanly exit in
+      60 seconds, it will be sent the <command>lxc.signal.stop</command>
+      (defaults to SIGKILL) to force it to shut down. A request to reboot will
+      send the <command>lxc.signal.reboot</command> (defaults to SIGINT) to the
+      container's init process.
     </para>
        <para>
-       The <optional>-W</optional>, <optional>-r</optional>, <optional>-s</optional>
-       and <optional>-k</optional> options specify the action to perform.
+       The <optional>-W</optional>, <optional>-r</optional>,
+       <optional>-k</optional> and <optional>--nokill</optional>
+       options specify the action to perform.
        <optional>-W</optional> indicates that after performing the specified
        action, <command>lxc-stop</command> should immediately exit, while
        <optional>-t TIMEOUT</optional> specifies the maximum amount of time
@@ -97,25 +102,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
     <varlistentry>
        <term>
-         <option>-s,--shutdown </option>
+         <option>-k,--kill </option>
        </term>
        <listitem>
          <para>
-           Only request a clean shutdown, do not kill the container tasks if the
-               clean shutdown fails.
+        Rather than requesting a clean shutdown of the container, explicitly
+        kill all tasks in the container.  This is the legacy
+        <command>lxc-stop</command> behavior.
          </para>
        </listitem>
        </varlistentry>
 
     <varlistentry>
        <term>
-         <option>-k,--kill </option>
+         <option>--nokill</option>
        </term>
        <listitem>
          <para>
-        Rather than requesting a clean shutdown of the container, explicitly
-        kill all tasks in the container.  This is the legacy
-        <command>lxc-stop</command> behavior.
+           Only request a clean shutdown, do not kill the container tasks if the
+               clean shutdown fails.
          </para>
        </listitem>
        </varlistentry>
@@ -159,6 +164,41 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
   </variablelist>
   </refsect1>
 
+  <refsect1>
+    <title>Exit value</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>0</term>
+        <listitem>
+          <para>
+           The container was successfully stopped.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>1</term>
+        <listitem>
+          <para>
+           An error occurred while stopping the container.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>2</term>
+        <listitem>
+          <para>
+           The specified container exists but was not running.
+          </para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
   <refsect1>
     <title>Diagnostic</title>