Debian Codegraph @

doc/common_options.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <refsect1>
4 <title>Common Options</title>
5
6 <para>
7 These options are common to most of lxc commands.
8 </para>
9
10 <variablelist>
11 <varlistentry>
12 <term><option>-?, -h, --help</option></term>
13 <listitem>
14 <para>
15 Print a longer usage message than normal.
16 </para>
17 </listitem>
18 </varlistentry>
19 <varlistentry>
20 <term><option>--usage</option></term>
21 <listitem>
22 <para>
23 Give the usage message
24 </para>
25 </listitem>
26 </varlistentry>
27
28 <varlistentry>
29 <term><option>-q, --quiet</option></term>
30 <listitem>
31 <para>
32 mute on
33 </para>
34 </listitem>
35 </varlistentry>
36
37 <varlistentry>
38 <term><option>-P, --lxcpath=<replaceable>PATH</replaceable></option></term>
39 <listitem>
40 <para>
41 Use an alternate container path. The default is @LXCPATH@.
42 </para>
43 </listitem>
44 </varlistentry>
45
46 <varlistentry>
47 <term><option>-o, --logfile=<replaceable>FILE</replaceable></option></term>
48 <listitem>
49 <para>
50 Output to an alternate log
51 <replaceable>FILE</replaceable>. The default is no log.
52 </para>
53 </listitem>
54 </varlistentry>
55
56 <varlistentry>
57 <term><option>-l, --logpriority=<replaceable>LEVEL</replaceable></option></term>
58 <listitem>
59 <para>
60 Set log priority to
61 <replaceable>LEVEL</replaceable>. The default log
62 priority is <literal>ERROR</literal>. Possible values are :
63 <literal>FATAL</literal>, <literal>ALERT</literal>,
64 <literal>CRIT</literal>,
65 <literal>WARN</literal>, <literal>ERROR</literal>,
66 <literal>NOTICE</literal>, <literal>INFO</literal>,
67 <literal>DEBUG</literal>, <literal>TRACE</literal>.
68 </para>
69 <para>
70 Note that this option is setting the priority of the events
71 log in the alternate log file. It do not have effect on the
72 ERROR events log on stderr.
73 </para>
74 </listitem>
75 </varlistentry>
76
77 <varlistentry>
78 <term><option>-n, --name=<replaceable>NAME</replaceable></option></term>
79 <listitem>
80 <para>
81 Use container identifier <replaceable>NAME</replaceable>.
82 The container identifier format is an alphanumeric string.
83 </para>
84 </listitem>
85 </varlistentry>
86
87 <varlistentry>
88 <term><option>--rcfile=<replaceable>FILE</replaceable></option></term>
89 <listitem>
90 <para>
91 Specify the configuration file to configure the virtualization
92 and isolation functionalities for the container.
93 </para>
94 <para>
95 This configuration file if present will be used even if there is
96 already a configuration file present in the previously created
97 container (via lxc-create).
98 </para>
99 </listitem>
100 </varlistentry>
101
102 <varlistentry>
103 <term><option>--version</option></term>
104 <listitem>
105 <para>
106 Show the version number.
107 </para>
108 </listitem>
109 </varlistentry>
110 </variablelist>
111
112 </refsect1>
113
114 <!-- Keep this comment at the end of the file
115 Local variables:
116 mode: sgml
117 sgml-omittag:t
118 sgml-shorttag:t
119 sgml-minimize-attributes:nil
120 sgml-always-quote-attributes:t
121 sgml-indent-step:2
122 sgml-indent-data:t
123 sgml-parent-document:nil
124 sgml-default-dtd-file:nil
125 sgml-exposed-tags:nil
126 sgml-local-catalogs:nil
127 sgml-local-ecat-files:nil
128 End:
129 -->