doc/lxc-autostart.sgml.in

   1 <!--
   2
   3 lxc-autostart
   4
   5 (C) Copyright 2013 Canonical Ltd.
   6
   7 Authors:
   8 Stéphane Graber <stgraber@ubuntu.com>
   9
  10 This library is free software; you can redistribute it and/or
  11 modify it under the terms of the GNU Lesser General Public
  12 License as published by the Free Software Foundation; either
  13 version 2.1 of the License, or (at your option) any later version.
  14
  15 This library is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 Lesser General Public License for more details.
  19
  20 You should have received a copy of the GNU Lesser General Public
  21 License along with this library; if not, write to the Free Software
  22 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  27     <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  28     <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  29 ]>
  30
  31 <refentry>
  32     <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  33     <refmeta>
  34         <refentrytitle>lxc-autostart</refentrytitle>
  35         <manvolnum>1</manvolnum>
  36     </refmeta>
  37
  38     <refnamediv>
  39         <refname>lxc-autostart</refname>
  40
  41         <refpurpose>
  42             start/stop/kill auto-started containers
  43         </refpurpose>
  44     </refnamediv>
  45
  46     <refsynopsisdiv>
  47         <cmdsynopsis>
  48             <command>lxc-autostart</command>
  49             <arg choice="opt">-k</arg>
  50             <arg choice="opt">-L</arg>
  51             <arg choice="opt">-r</arg>
  52             <arg choice="opt">-s</arg>
  53             <arg choice="opt">-a</arg>
  54             <arg choice="opt">-g <replaceable>groups</replaceable></arg>
  55             <arg choice="opt">-t <replaceable>timeout</replaceable></arg>
  56         </cmdsynopsis>
  57     </refsynopsisdiv>
  58
  59     <refsect1>
  60         <title>Description</title>
  61
  62         <para>
  63             <command>lxc-autostart</command> processes containers
  64             with lxc.start.auto set. It lets the user start, shutdown,
  65             kill, restart containers in the right order, waiting the
  66             right time. Supports filtering by lxc.group or just run
  67             against all defined containers. It can also be used by
  68             external tools in list mode where no action will be performed
  69             and the list of affected containers (and if relevant, delays)
  70             will be shown.
  71         </para>
  72
  73         <para>
  74             The <optional>-r</optional>, <optional>-s</optional>
  75             and <optional>-k</optional> options specify the action to perform.
  76             If none is specified, then the containers will be started.
  77             <optional>-a</optional> and <optional>-g</optional> are used to
  78             specify which containers will be affected. By default only
  79             containers without a lxc.group set will be affected.
  80             <optional>-t TIMEOUT</optional> specifies the maximum amount
  81             of time to wait for the container to complete the shutdown
  82             or reboot.
  83         </para>
  84     </refsect1>
  85
  86     <refsect1>
  87         <title>Options</title>
  88         <variablelist>
  89             <varlistentry>
  90                 <term>
  91                     <option>-r,--reboot </option>
  92                 </term>
  93                 <listitem>
  94                     <para>
  95                         Request a reboot of the container.
  96                     </para>
  97                 </listitem>
  98             </varlistentry>
  99
 100             <varlistentry>
 101                 <term>
 102                     <option>-s,--shutdown </option>
 103                 </term>
 104                 <listitem>
 105                     <para>
 106                         Only request a clean shutdown, do not kill the
 107                         container tasks if the clean shutdown fails.
 108                     </para>
 109                 </listitem>
 110             </varlistentry>
 111
 112             <varlistentry>
 113                 <term>
 114                     <option>-k,--kill </option>
 115                 </term>
 116                 <listitem>
 117                     <para>
 118                         Rather than requesting a clean shutdown of the
 119                         container, explicitly kill all tasks in the container.
 120                     </para>
 121                 </listitem>
 122             </varlistentry>
 123
 124             <varlistentry>
 125                 <term>
 126                     <option>-L,--list </option>
 127                 </term>
 128                 <listitem>
 129                     <para>
 130                         Rather than performing the action, just print
 131                         the container name.
 132                     </para>
 133                 </listitem>
 134             </varlistentry>
 135
 136             <varlistentry>
 137                 <term>
 138                     <option>-t,--timeout <replaceable>TIMEOUT</replaceable></option>
 139                 </term>
 140                 <listitem>
 141                     <para>
 142                         Wait TIMEOUT seconds before hard-stopping the container.
 143                     </para>
 144                 </listitem>
 145             </varlistentry>
 146         </variablelist>
 147     </refsect1>
 148
 149     &seealso;
 150
 151     <refsect1>
 152         <title>Author</title>
 153         <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 154     </refsect1>
 155 </refentry>
 156
 157 <!-- Keep this comment at the end of the file
 158 Local variables:
 159 mode: sgml
 160 sgml-omittag:t
 161 sgml-shorttag:t
 162 sgml-minimize-attributes:nil
 163 sgml-always-quote-attributes:t
 164 sgml-indent-step:2
 165 sgml-indent-data:t
 166 sgml-parent-document:nil
 167 sgml-default-dtd-file:nil
 168 sgml-exposed-tags:nil
 169 sgml-local-catalogs:nil
 170 sgml-local-ecat-files:nil
 171 End:
 172 -->