Debian Codegraph @

doc/lxc.conf.sgml.in

raw
1 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
2
3 <!DOCTYPE refentry PUBLIC @docdtd@ [
4
5 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
6 ]>
7
8 <refentry>
9
10 <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
11
12 <refmeta>
13 <refentrytitle>lxc.conf</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>lxc.conf</refname>
19
20 <refpurpose>
21 Configuration files for LXC.
22 </refpurpose>
23 </refnamediv>
24
25 <refsect1>
26 <title>Description</title>
27
28 <para>
29 LXC configuration is split in two parts. Container configuration
30 and system configuration.
31 </para>
32
33 <refsect2>
34 <title>Container configuration</title>
35 <para>
36 The container configuration is held in the
37 <filename>config</filename> stored in the container's
38 directory.
39 </para>
40
41 <para>
42 A basic configuration is generated at container creation time
43 with the default's recommended for the chosen template as well
44 as extra default keys coming from the
45 <filename>default.conf</filename> file.
46 </para>
47
48 <para>
49 That <filename>default.conf</filename> file is either located
50 at <filename>@LXC_DEFAULT_CONFIG@</filename> or for
51 unprivileged containers at
52 <filename>~/.config/lxc/default.conf</filename>.
53 </para>
54
55 <para>
56 Details about the syntax of this file can be found in:
57 <citerefentry>
58 <refentrytitle><command>lxc.container.conf</command></refentrytitle>
59 <manvolnum>5</manvolnum>
60 </citerefentry>
61 </para>
62 </refsect2>
63
64 <refsect2>
65 <title>System configuration</title>
66 <para>
67 The system configuration is located at
68 <filename>@LXC_GLOBAL_CONF@</filename> or
69 <filename>~/.config/lxc/lxc.conf</filename> for unprivileged
70 containers.
71 </para>
72
73 <para>
74 This configuration file is used to set values such as default
75 lookup paths and storage backend settings for LXC.
76 </para>
77
78 <para>
79 Details about the syntax of this file can be found in:
80 <citerefentry>
81 <refentrytitle><command>lxc.system.conf</command></refentrytitle>
82 <manvolnum>5</manvolnum>
83 </citerefentry>
84 </para>
85 </refsect2>
86 </refsect1>
87
88 <refsect1>
89 <title>See Also</title>
90 <simpara>
91 <citerefentry>
92 <refentrytitle><command>lxc</command></refentrytitle>
93 <manvolnum>1</manvolnum>
94 </citerefentry>,
95 <citerefentry>
96 <refentrytitle><command>lxc.container.conf</command></refentrytitle>
97 <manvolnum>5</manvolnum>
98 </citerefentry>,
99 <citerefentry>
100 <refentrytitle><command>lxc.system.conf</command></refentrytitle>
101 <manvolnum>5</manvolnum>
102 </citerefentry>,
103 <citerefentry>
104 <refentrytitle><command>lxc-usernet</command></refentrytitle>
105 <manvolnum>5</manvolnum>
106 </citerefentry>
107 </simpara>
108 </refsect1>
109 </refentry>
110
111 <!-- Keep this comment at the end of the file
112 Local variables:
113 mode: sgml
114 sgml-omittag:t
115 sgml-shorttag:t
116 sgml-minimize-attributes:nil
117 sgml-always-quote-attributes:t
118 sgml-indent-step:2
119 sgml-indent-data:t
120 sgml-parent-document:nil
121 sgml-default-dtd-file:nil
122 sgml-exposed-tags:nil
123 sgml-local-catalogs:nil
124 sgml-local-ecat-files:nil
125 End:
126 -->