doc/lxc-config.sgml.in

   1 <!--
   2
   3 lxc-config
   4
   5 (C) Copyright 2014 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-config</refentrytitle>
  35         <manvolnum>1</manvolnum>
  36     </refmeta>
  37
  38     <refnamediv>
  39         <refname>lxc-config</refname>
  40
  41         <refpurpose>
  42             query LXC system configuration
  43         </refpurpose>
  44     </refnamediv>
  45
  46     <refsynopsisdiv>
  47         <cmdsynopsis>
  48             <command>lxc-config</command>
  49             <arg choice="opt">-l</arg>
  50             <arg choice="opt"><replaceable>item</replaceable></arg>
  51         </cmdsynopsis>
  52     </refsynopsisdiv>
  53
  54     <refsect1>
  55         <title>Description</title>
  56
  57         <para>
  58             <command>lxc-config</command> queries the lxc system
  59             configuration and lets you list all valid keys or query
  60             individual keys for their value.
  61         </para>
  62     </refsect1>
  63
  64     <refsect1>
  65         <title>Options</title>
  66         <variablelist>
  67             <varlistentry>
  68                 <term>
  69                     <option>-l</option>
  70                 </term>
  71                 <listitem>
  72                     <para>
  73                         List all supported keys.
  74                     </para>
  75                 </listitem>
  76             </varlistentry>
  77
  78             <varlistentry>
  79                 <term>
  80                     <option>item</option>
  81                 </term>
  82                 <listitem>
  83                     <para>
  84                         Query the value of the specified key.
  85                     </para>
  86                 </listitem>
  87             </varlistentry>
  88         </variablelist>
  89     </refsect1>
  90
  91     &seealso;
  92
  93     <refsect1>
  94         <title>Author</title>
  95         <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
  96     </refsect1>
  97 </refentry>
  98
  99 <!-- Keep this comment at the end of the file
 100 Local variables:
 101 mode: sgml
 102 sgml-omittag:t
 103 sgml-shorttag:t
 104 sgml-minimize-attributes:nil
 105 sgml-always-quote-attributes:t
 106 sgml-indent-step:2
 107 sgml-indent-data:t
 108 sgml-parent-document:nil
 109 sgml-default-dtd-file:nil
 110 sgml-exposed-tags:nil
 111 sgml-local-catalogs:nil
 112 sgml-local-ecat-files:nil
 113 End:
 114 -->