doc/common_options.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright IBM Corp. 2007, 2008
   6
   7 Authors:
   8 Daniel Lezcano <daniel.lezcano at free.fr>
   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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23
  24 -->
  25
  26 <refsect1>
  27   <title>Common Options</title>
  28
  29   <para>
  30     These options are common to most of lxc commands.
  31   </para>
  32
  33   <variablelist>
  34     <varlistentry>
  35       <term><option>-?, -h, --help</option></term>
  36       <listitem>
  37         <para>
  38           Print a longer usage message than normal.
  39         </para>
  40       </listitem>
  41     </varlistentry>
  42     <varlistentry>
  43       <term><option>--usage</option></term>
  44       <listitem>
  45         <para>
  46           Give the usage message
  47         </para>
  48       </listitem>
  49     </varlistentry>
  50
  51     <varlistentry>
  52       <term><option>-q, --quiet</option></term>
  53       <listitem>
  54         <para>
  55           mute on
  56         </para>
  57       </listitem>
  58     </varlistentry>
  59
  60     <varlistentry>
  61       <term><option>-P, --lxcpath=<replaceable>PATH</replaceable></option></term>
  62       <listitem>
  63         <para>
  64           Use an alternate container path.  The default is @LXCPATH@.
  65         </para>
  66       </listitem>
  67     </varlistentry>
  68
  69     <varlistentry>
  70       <term><option>-o, --logfile=<replaceable>FILE</replaceable></option></term>
  71       <listitem>
  72         <para>
  73           Output to an alternate log
  74           <replaceable>FILE</replaceable>. The default is no log.
  75         </para>
  76       </listitem>
  77     </varlistentry>
  78
  79     <varlistentry>
  80       <term><option>-l, --logpriority=<replaceable>LEVEL</replaceable></option></term>
  81       <listitem>
  82         <para>
  83           Set log priority to
  84           <replaceable>LEVEL</replaceable>. The default log
  85           priority is <literal>ERROR</literal>. Possible values are :
  86           <literal>FATAL</literal>, <literal>CRIT</literal>,
  87           <literal>WARN</literal>, <literal>ERROR</literal>,
  88           <literal>NOTICE</literal>, <literal>INFO</literal>,
  89           <literal>DEBUG</literal>.
  90         </para>
  91         <para>
  92         Note that this option is setting the priority of the events
  93         log in the alternate log file. It do not have effect on the
  94         ERROR events log on stderr.
  95         </para>
  96       </listitem>
  97     </varlistentry>
  98
  99     <varlistentry>
 100       <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
 101       <listitem>
 102         <para>
 103           Use container identifier <replaceable>NAME</replaceable>.
 104           The container identifier format is an alphanumeric string.
 105         </para>
 106       </listitem>
 107     </varlistentry>
 108   </variablelist>
 109
 110 </refsect1>
 111
 112 <!-- Keep this comment at the end of the file
 113 Local variables:
 114 mode: sgml
 115 sgml-omittag:t
 116 sgml-shorttag:t
 117 sgml-minimize-attributes:nil
 118 sgml-always-quote-attributes:t
 119 sgml-indent-step:2
 120 sgml-indent-data:t
 121 sgml-parent-document:nil
 122 sgml-default-dtd-file:nil
 123 sgml-exposed-tags:nil
 124 sgml-local-catalogs:nil
 125 sgml-local-ecat-files:nil
 126 End:
 127 -->