doc/lxc-info.sgml.in

   1 <!--
   2
   3 (C) Copyright Canonical Ltd. 2013
   4
   5 Authors:
   6 Stéphane Graber <stgraber@ubuntu.com>
   7
   8 This library is free software; you can redistribute it and/or
   9 modify it under the terms of the GNU Lesser General Public
  10 License as published by the Free Software Foundation; either
  11 version 2.1 of the License, or (at your option) any later version.
  12
  13 This library is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 Lesser General Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public
  19 License along with this library; if not, write to the Free Software
  20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21
  22 -->
  23
  24 <!DOCTYPE refentry PUBLIC @docdtd@ [
  25
  26 <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  27 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  28 ]>
  29
  30 <refentry>
  31
  32   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  33
  34   <refmeta>
  35     <refentrytitle>lxc-info</refentrytitle>
  36     <manvolnum>1</manvolnum>
  37   </refmeta>
  38
  39   <refnamediv>
  40     <refname>lxc-info</refname>
  41
  42     <refpurpose>
  43       query information about a container
  44     </refpurpose>
  45   </refnamediv>
  46
  47   <refsynopsisdiv>
  48     <cmdsynopsis>
  49       <command>lxc-info</command>
  50       <arg choice="req">-n <replaceable>name</replaceable></arg>
  51       <arg choice="opt">-c <replaceable>KEY</replaceable></arg>
  52       <arg choice="opt">-s</arg>
  53       <arg choice="opt">-p</arg>
  54       <arg choice="opt">-t <replaceable>state</replaceable></arg>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60     <para>
  61       <command>lxc-info</command> queries and shows information about a
  62       container.
  63     </para>
  64   </refsect1>
  65
  66   <refsect1>
  67     <title>Options</title>
  68     <variablelist>
  69
  70       <varlistentry>
  71         <term>
  72           <option>-n <replaceable>name</replaceable></option>
  73         </term>
  74         <listitem>
  75           <para>
  76             The container name.
  77           </para>
  78         </listitem>
  79       </varlistentry>
  80
  81       <varlistentry>
  82         <term>
  83           <option><optional>-c <replaceable>KEY</replaceable></optional></option>
  84         </term>
  85         <listitem>
  86           <para>
  87             Print a configuration key from the running container. This option
  88             may be given mulitple times to print out multiple key = value pairs.
  89           </para>
  90         </listitem>
  91       </varlistentry>
  92
  93       <varlistentry>
  94         <term>
  95           <option><optional>-s</optional></option>
  96         </term>
  97         <listitem>
  98           <para>
  99             Just print the container's state.
 100           </para>
 101         </listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term>
 106           <option><optional>-p</optional></option>
 107         </term>
 108         <listitem>
 109           <para>
 110             Just print the container's pid.
 111           </para>
 112         </listitem>
 113       </varlistentry>
 114
 115       <varlistentry>
 116         <term>
 117           <option><optional>-t <replaceable>state</replaceable></optional></option>
 118         </term>
 119         <listitem>
 120           <para>
 121             Check whether the container is in the provided state.
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125     </variablelist>
 126   </refsect1>
 127
 128   &commonoptions;
 129
 130   <refsect1>
 131     <title>Examples</title>
 132     <variablelist>
 133       <varlistentry>
 134         <term>lxc-info -n foo</term>
 135         <listitem>
 136           <para>
 137             Show information for foo.
 138           </para>
 139         </listitem>
 140       </varlistentry>
 141
 142       <varlistentry>
 143         <term>lxc-info -n foo -t RUNNING</term>
 144         <listitem>
 145           <para>
 146             exits 0 if foo is RUNNING, 1 otherwise.
 147           </para>
 148         </listitem>
 149       </varlistentry>
 150
 151       <varlistentry>
 152         <term>lxc-info -n foo -c lxc.network.0.veth.pair</term>
 153         <listitem>
 154           <para>
 155             prints the veth pair name of foo.
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159
 160     </variablelist>
 161   </refsect1>
 162
 163   &seealso;
 164
 165   <refsect1>
 166     <title>Author</title>
 167     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 168   </refsect1>
 169 </refentry>
 170
 171 <!-- Keep this comment at the end of the file
 172 Local variables:
 173 mode: sgml
 174 sgml-omittag:t
 175 sgml-shorttag:t
 176 sgml-minimize-attributes:nil
 177 sgml-always-quote-attributes:t
 178 sgml-indent-step:2
 179 sgml-indent-data:t
 180 sgml-parent-document:nil
 181 sgml-default-dtd-file:nil
 182 sgml-exposed-tags:nil
 183 sgml-local-catalogs:nil
 184 sgml-local-ecat-files:nil
 185 End:
 186 -->