doc/lxc.conf.sgml.in

   1 <!--
   2
   3 lxc: linux Container library
   4
   5 (C) Copyright Canonical Ltd. 2014
   6
   7 Authors:
   8 Stéphane Graber <stgraber@ubuntu.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23
  24 -->
  25
  26 <!DOCTYPE refentry PUBLIC @docdtd@ [
  27
  28 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  29 ]>
  30
  31 <refentry>
  32
  33   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  34
  35   <refmeta>
  36     <refentrytitle>lxc.conf</refentrytitle>
  37     <manvolnum>5</manvolnum>
  38   </refmeta>
  39
  40   <refnamediv>
  41     <refname>lxc.conf</refname>
  42
  43     <refpurpose>
  44       Configuration files for LXC.
  45     </refpurpose>
  46   </refnamediv>
  47
  48   <refsect1>
  49     <title>Description</title>
  50
  51     <para>
  52       LXC configuration is split in two parts. Container configuration
  53       and system configuration.
  54     </para>
  55
  56     <refsect2>
  57       <title>Container configuration</title>
  58       <para>
  59           The container configuration is held in the
  60           <filename>config</filename> stored in the container's
  61           directory.
  62       </para>
  63
  64       <para>
  65           A basic configuration is generated at container creation time
  66           with the default's recommended for the chosen template as well
  67           as extra default keys coming from the
  68           <filename>default.conf</filename> file.
  69       </para>
  70
  71       <para>
  72           That <filename>default.conf</filename> file is either located
  73           at <filename>@LXC_DEFAULT_CONFIG@</filename> or for
  74           unprivileged containers at
  75           <filename>~/.config/lxc/default.conf</filename>.
  76       </para>
  77
  78       <para>
  79           Details about the syntax of this file can be found in:
  80           <citerefentry>
  81             <refentrytitle><command>lxc.container.conf</command></refentrytitle>
  82             <manvolnum>5</manvolnum>
  83           </citerefentry>
  84       </para>
  85     </refsect2>
  86
  87     <refsect2>
  88       <title>System configuration</title>
  89       <para>
  90           The system configuration is located at
  91           <filename>@LXC_GLOBAL_CONF@</filename> or
  92           <filename>~/.config/lxc/lxc.conf</filename> for unprivileged
  93           containers.
  94       </para>
  95
  96       <para>
  97           This configuration file is used to set values such as default
  98           lookup paths and storage backend settings for LXC.
  99       </para>
 100
 101       <para>
 102           Details about the syntax of this file can be found in:
 103           <citerefentry>
 104             <refentrytitle><command>lxc.system.conf</command></refentrytitle>
 105             <manvolnum>5</manvolnum>
 106           </citerefentry>
 107       </para>
 108     </refsect2>
 109   </refsect1>
 110
 111   <refsect1>
 112     <title>See Also</title>
 113     <simpara>
 114       <citerefentry>
 115         <refentrytitle><command>lxc</command></refentrytitle>
 116         <manvolnum>1</manvolnum>
 117       </citerefentry>,
 118       <citerefentry>
 119         <refentrytitle><command>lxc.container.conf</command></refentrytitle>
 120         <manvolnum>5</manvolnum>
 121       </citerefentry>,
 122       <citerefentry>
 123         <refentrytitle><command>lxc.system.conf</command></refentrytitle>
 124         <manvolnum>5</manvolnum>
 125       </citerefentry>,
 126       <citerefentry>
 127         <refentrytitle><command>lxc-usernet</command></refentrytitle>
 128         <manvolnum>5</manvolnum>
 129       </citerefentry>
 130     </simpara>
 131   </refsect1>
 132
 133   <refsect1>
 134     <title>Author</title>
 135     <para>Stéphane Graber <email>stgraber@ubuntu.com</email></para>
 136   </refsect1>
 137 </refentry>
 138
 139 <!-- Keep this comment at the end of the file
 140 Local variables:
 141 mode: sgml
 142 sgml-omittag:t
 143 sgml-shorttag:t
 144 sgml-minimize-attributes:nil
 145 sgml-always-quote-attributes:t
 146 sgml-indent-step:2
 147 sgml-indent-data:t
 148 sgml-parent-document:nil
 149 sgml-default-dtd-file:nil
 150 sgml-exposed-tags:nil
 151 sgml-local-catalogs:nil
 152 sgml-local-ecat-files:nil
 153 End:
 154 -->