common_options.sgml.in revision 9afe19d634946d50eab30e3b90cb5cebcde39eea
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano<!--
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanolxc: linux Container library
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano(C) Copyright IBM Corp. 2007, 2008
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoAuthors:
9afe19d634946d50eab30e3b90cb5cebcde39eeaDaniel LezcanoDaniel Lezcano <daniel.lezcano at free.fr>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoThis library is free software; you can redistribute it and/or
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanomodify it under the terms of the GNU Lesser General Public
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoLicense as published by the Free Software Foundation; either
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanoversion 2.1 of the License, or (at your option) any later version.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoThis library is distributed in the hope that it will be useful,
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanobut WITHOUT ANY WARRANTY; without even the implied warranty of
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoLesser General Public License for more details.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoYou should have received a copy of the GNU Lesser General Public
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoLicense along with this library; if not, write to the Free Software
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoFoundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano-->
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano<refsect1>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <title>Common Options</title>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano These options are common to most of lxc commands.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <variablelist>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <term><option>-?, -h, --help</option></term>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano Print a longer usage message than normal.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <term><option>--usage</option></term>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano Give the usage message
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <term><option>-q, --quiet</option></term>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano mute on
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber <varlistentry>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber <term><option>-P, --lxcpath=<replaceable>PATH</replaceable></option></term>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber <listitem>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber <para>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber Use an alternate container path. The default is @LXCPATH@.
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber </para>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber </listitem>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber </varlistentry>
67e571de63a8e465dc8f1b17e16744a1d3fb552cStéphane Graber
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <term><option>-o, --logfile=<replaceable>FILE</replaceable></option></term>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano Output to an alternate log
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <replaceable>FILE</replaceable>. The default is no log.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <term><option>-l, --logpriority=<replaceable>LEVEL</replaceable></option></term>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano Set log priority to
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <replaceable>LEVEL</replaceable>. The default log
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano priority is <literal>ERROR</literal>. Possible values are :
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <literal>FATAL</literal>, <literal>CRIT</literal>,
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <literal>WARN</literal>, <literal>ERROR</literal>,
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <literal>NOTICE</literal>, <literal>INFO</literal>,
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <literal>DEBUG</literal>.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
7115cb787d20da6368e3392a97069894ec5d19d6Michel Normand <para>
7115cb787d20da6368e3392a97069894ec5d19d6Michel Normand Note that this option is setting the priority of the events
7115cb787d20da6368e3392a97069894ec5d19d6Michel Normand log in the alternate log file. It do not have effect on the
7115cb787d20da6368e3392a97069894ec5d19d6Michel Normand ERROR events log on stderr.
7115cb787d20da6368e3392a97069894ec5d19d6Michel Normand </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano <para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano Use container identifier <replaceable>NAME</replaceable>.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano The container identifier format is an alphanumeric string.
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </para>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </listitem>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </varlistentry>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano </variablelist>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano</refsect1>
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano<!-- Keep this comment at the end of the file
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoLocal variables:
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanomode: sgml
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-omittag:t
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-shorttag:t
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-minimize-attributes:nil
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-always-quote-attributes:t
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-indent-step:2
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-indent-data:t
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-parent-document:nil
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-default-dtd-file:nil
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-exposed-tags:nil
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-local-catalogs:nil
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcanosgml-local-ecat-files:nil
1490112767ea6e06ea78e80d905b9dad41051798Daniel LezcanoEnd:
1490112767ea6e06ea78e80d905b9dad41051798Daniel Lezcano-->