mirror_lxc/doc/lxc-autostart.sgml.in

<!--

lxc-autostart

(C) Copyright 2013 Canonical Ltd.

Authors:
Stéphane Graber <stgraber@ubuntu.com>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [
    <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
    <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>
    <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
    <refmeta>
        <refentrytitle>lxc-autostart</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>lxc-autostart</refname>

        <refpurpose>
            start/stop/kill auto-started containers
        </refpurpose>
    </refnamediv>

    <refsynopsisdiv>
        <cmdsynopsis>
            <command>lxc-autostart</command>
            <arg choice="opt">-k</arg>
            <arg choice="opt">-L</arg>
            <arg choice="opt">-r</arg>
            <arg choice="opt">-s</arg>
            <arg choice="opt">-a</arg>
            <arg choice="opt">-g <replaceable>groups</replaceable></arg>
            <arg choice="opt">-t <replaceable>timeout</replaceable></arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            <command>lxc-autostart</command> processes containers
            with lxc.start.auto set. It lets the user start, shutdown,
            kill, restart containers in the right order, waiting the
            right time. Supports filtering by lxc.group or just run
            against all defined containers. It can also be used by
            external tools in list mode where no action will be performed
            and the list of affected containers (and if relevant, delays)
            will be shown.
        </para>

        <para>
            The <optional>-r</optional>, <optional>-s</optional>
            and <optional>-k</optional> options specify the action to perform.
            If none is specified, then the containers will be started.
            <optional>-a</optional> and <optional>-g</optional> are used to
            specify which containers will be affected. By default only
            containers without a lxc.group set will be affected.
            <optional>-t TIMEOUT</optional> specifies the maximum amount
            of time to wait for the container to complete the shutdown
            or reboot.
        </para>
    </refsect1>

    <refsect1>
        <title>Options</title>
        <variablelist>
            <varlistentry>
                <term>
                    <option>-r,--reboot </option>
                </term>
                <listitem>
                    <para>
                        Request a reboot of the container.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-s,--shutdown </option>
                </term>
                <listitem>
                    <para>
                        Request a clean shutdown. If a
                        <optional>-t timeout</optional> greater than 0 is
                        given and the container has not shut down within
                        this period, it will be killed as with the
                        <optional>-k kill</optional> option.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-k,--kill </option>
                </term>
                <listitem>
                    <para>
                        Rather than requesting a clean shutdown of the
                        container, explicitly kill all tasks in the container.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-L,--list </option>
                </term>
                <listitem>
                    <para>
                        Rather than performing the action, just print
                        the container name.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-t,--timeout <replaceable>TIMEOUT</replaceable></option>
                </term>
                <listitem>
                    <para>
                        Wait TIMEOUT seconds before hard-stopping the container.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    &seealso;

    <refsect1>
        <title>Author</title>
        <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
    </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->