common_options.sgml.in revision 67e571de63a8e465dc8f1b17e16744a1d3fb552c
2454dfa32c93c20a8522c6ed42fe057baaac9f9aStephan Bosch<!--
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainenlxc: linux Container library
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen(C) Copyright IBM Corp. 2007, 2008
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenAuthors:
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenDaniel Lezcano <dlezcano at fr.ibm.com>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenThis library is free software; you can redistribute it and/or
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainenmodify it under the terms of the GNU Lesser General Public
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenLicense as published by the Free Software Foundation; either
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainenversion 2.1 of the License, or (at your option) any later version.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenThis library is distributed in the hope that it will be useful,
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainenbut WITHOUT ANY WARRANTY; without even the implied warranty of
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenLesser General Public License for more details.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenYou should have received a copy of the GNU Lesser General Public
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenLicense along with this library; if not, write to the Free Software
0dffa25d211be541ee3c953b23566a1a990789dfTimo SirainenFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0dffa25d211be541ee3c953b23566a1a990789dfTimo Sirainen
0dffa25d211be541ee3c953b23566a1a990789dfTimo Sirainen-->
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen<refsect1>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <title>Common Options</title>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen These options are common to most of lxc commands.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
6307d76096764e66bddc63d4a3e5a1aa19cc528fJosef 'Jeff' Sipek
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <variablelist>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>-?, -h, --help</option></term>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen Print a longer usage message than normal.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
d28179fd78550a58be44dcb1e3e830ab7d33172dTimo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>--usage</option></term>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen Give the usage message
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>-q, --quiet</option></term>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <listitem>
573424407a2d3c1453638a643583a7cf10c129e1Phil Carmody <para>
573424407a2d3c1453638a643583a7cf10c129e1Phil Carmody mute on
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>-P, --lxcpath=<replaceable>PATH</replaceable></option></term>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen Use an alternate container path. The default is @LXCPATH@.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>-o, --logfile=<replaceable>FILE</replaceable></option></term>
b9e830a81455faf3c0dadfc9dbf0c7dc8aca955cJosef 'Jeff' Sipek <listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen Output to an alternate log
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <replaceable>FILE</replaceable>. The default is no log.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>-l, --logpriority=<replaceable>LEVEL</replaceable></option></term>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen Set log priority to
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <replaceable>LEVEL</replaceable>. The default log
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen priority is <literal>ERROR</literal>. Possible values are :
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <literal>FATAL</literal>, <literal>CRIT</literal>,
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <literal>WARN</literal>, <literal>ERROR</literal>,
e05039894bb8fa68d6e5bc2c36fd870463bcd09fTimo Sirainen <literal>NOTICE</literal>, <literal>INFO</literal>,
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <literal>DEBUG</literal>.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen Note that this option is setting the priority of the events
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen log in the alternate log file. It do not have effect on the
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen ERROR events log on stderr.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
d868a04630bd7bfe9c1543a7c3f68703b3e276e4Timo Sirainen
d868a04630bd7bfe9c1543a7c3f68703b3e276e4Timo Sirainen <varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen <para>
131b0d222ad89b2c5d2b03b865b45cae9e290d68Timo Sirainen Use container identifier <replaceable>NAME</replaceable>.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen The container identifier format is an alphanumeric string.
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </para>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </listitem>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </varlistentry>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen </variablelist>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen</refsect1>
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen<!-- Keep this comment at the end of the file
b9e830a81455faf3c0dadfc9dbf0c7dc8aca955cJosef 'Jeff' SipekLocal variables:
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainenmode: sgml
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-omittag:t
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-shorttag:t
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-minimize-attributes:nil
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-always-quote-attributes:t
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-indent-step:2
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-indent-data:t
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-parent-document:nil
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-default-dtd-file:nil
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-exposed-tags:nil
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-local-catalogs:nil
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainensgml-local-ecat-files:nil
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo SirainenEnd:
9184983183ae28fb543695c54c85bc5396c07e42Phil Carmody-->
a49d1c2ca3c134c0c62b37a94936c78e9849e044Timo Sirainen