lxc-info.sgml.in revision 211e51e81e7c6ab670d1d282d78e5ef26d039a79
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr<!--
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr(C) Copyright Canonical Ltd. 2013
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frAuthors:
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frStéphane Graber <stgraber@ubuntu.com>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frThis library is free software; you can redistribute it and/or
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frmodify it under the terms of the GNU Lesser General Public
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frLicense as published by the Free Software Foundation; either
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frversion 2.1 of the License, or (at your option) any later version.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frThis library is distributed in the hope that it will be useful,
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frbut WITHOUT ANY WARRANTY; without even the implied warranty of
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane GraberLesser General Public License for more details.
c63c04fcaf1c3a78c70500eae253d72fa9c8358aTAMUKI Shoichi
96283b546081e7ff709968378fca25cb44f1ab6cStéphane GraberYou should have received a copy of the GNU Lesser General Public
96283b546081e7ff709968378fca25cb44f1ab6cStéphane GraberLicense along with this library; if not, write to the Free Software
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane GraberFoundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane Graber
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane Graber-->
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane Graber
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane Graber<!DOCTYPE refentry PUBLIC @docdtd@ [
8ec981fc8b0105da5f071e40811e0c2472a6c3c9Stéphane Graber
207bf0e475f1dc6e9a2dac2cee3a209b56427855Stéphane Graber<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
207bf0e475f1dc6e9a2dac2cee3a209b56427855Stéphane Graber<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
207bf0e475f1dc6e9a2dac2cee3a209b56427855Stéphane Graber]>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr<refentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
cae3584efccc63f544c8748bd13d80e11bc79aefgza <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
cae3584efccc63f544c8748bd13d80e11bc79aefgza
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refmeta>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refentrytitle>lxc-info</refentrytitle>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <manvolnum>1</manvolnum>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refmeta>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refnamediv>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refname>lxc-info</refname>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refpurpose>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr query information about a container
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refpurpose>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refnamediv>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refsynopsisdiv>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <cmdsynopsis>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <command>lxc-info</command>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <arg choice="req">-n <replaceable>name</replaceable></arg>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <arg choice="opt">-s</arg>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <arg choice="opt">-p</arg>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <arg choice="opt">-i</arg>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <arg choice="opt">-t <replaceable>state</replaceable></arg>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </cmdsynopsis>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refsynopsisdiv>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <title>Description</title>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <command>lxc-info</command> queries and shows information about a
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr container.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <title>Options</title>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <variablelist>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <option>-n <replaceable>name</replaceable></option>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr The container name.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <option><optional>-c <replaceable>KEY</replaceable></optional></option>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr Print a configuration key from the running container. This option
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr may be given mulitple times to print out multiple key = value pairs.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <option><optional>-s</optional></option>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr Just print the container's state.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <option><optional>-p</optional></option>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr Just print the container's pid.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <option><optional>-i</optional></option>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr Just print the container's IP addresses.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <option><optional>-t <replaceable>state</replaceable></optional></option>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
3a74e9097a932729d9eff9ce562288e89731b177Guillaume ZITTA <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr Check whether the container is in the provided state.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </variablelist>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr &commonoptions;
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <title>Examples</title>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <variablelist>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>lxc-info -n foo</term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr Show information for foo.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>lxc-info -n foo -t RUNNING</term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr exits 0 if foo is RUNNING, 1 otherwise.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <term>lxc-info -n foo -c lxc.network.0.veth.pair</term>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr prints the veth pair name of foo.
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </listitem>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </varlistentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </variablelist>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr &seealso;
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <title>Author</title>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr </refsect1>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr</refentry>
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr<!-- Keep this comment at the end of the file
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frLocal variables:
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frmode: sgml
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-omittag:t
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-shorttag:t
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-minimize-attributes:nil
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-always-quote-attributes:t
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-indent-step:2
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-indent-data:t
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-parent-document:nil
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-default-dtd-file:nil
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-exposed-tags:nil
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-local-catalogs:nil
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frsgml-local-ecat-files:nil
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.frEnd:
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr-->
f8d0243a78c65ea3c46eb60fbeef799c3f6e9a5blxc@zitta.fr