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 <dlezcano at fr.ibm.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., 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>-o, --logfile=<replaceable>FILE</replaceable></option></term>
  62       <listitem>
  63         <para>
  64           Output to an alternate log
  65           <replaceable>FILE</replaceable>. The default is no log.
  66         </para>
  67       </listitem>
  68     </varlistentry>
  69
  70     <varlistentry>
  71       <term><option>-l, --logpriority=<replaceable>LEVEL</replaceable></option></term>
  72       <listitem>
  73         <para>
  74           Set log priority to
  75           <replaceable>LEVEL</replaceable>. The default log
  76           priority is <literal>ERROR</literal>. Possible values are :
  77           <literal>FATAL</literal>, <literal>CRIT</literal>,
  78           <literal>WARN</literal>, <literal>ERROR</literal>,
  79           <literal>NOTICE</literal>, <literal>INFO</literal>,
  80           <literal>DEBUG</literal>.
  81         </para>
  82         <para>
  83         Note that this option is setting the priority of the events
  84         log in the alternate log file. It do not have effect on the
  85         ERROR events log on stderr.
  86         </para>
  87       </listitem>
  88     </varlistentry>
  89
  90     <varlistentry>
  91       <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
  92       <listitem>
  93         <para>
  94           Use container identifier <replaceable>NAME</replaceable>.
  95           The container identifier format is an alphanumeric string.
  96         </para>
  97       </listitem>
  98     </varlistentry>
  99   </variablelist>
 100
 101 </refsect1>
 102
 103 <!-- Keep this comment at the end of the file
 104 Local variables:
 105 mode: sgml
 106 sgml-omittag:t
 107 sgml-shorttag:t
 108 sgml-minimize-attributes:nil
 109 sgml-always-quote-attributes:t
 110 sgml-indent-step:2
 111 sgml-indent-data:t
 112 sgml-parent-document:nil
 113 sgml-default-dtd-file:nil
 114 sgml-exposed-tags:nil
 115 sgml-local-catalogs:nil
 116 sgml-local-ecat-files:nil
 117 End:
 118 -->