doc/lxc-update-config.sgml.in

   1 <!--
   2
   3 lxc-update-config
   4
   5 (C) Copyright 2017 Canonical Ltd.
   6
   7 Authors:
   8 Christian Brauner <christian.brauner@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     <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
  28     <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  29 ]>
  30
  31 <refentry>
  32     <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  33     <refmeta>
  34         <refentrytitle>lxc-update-config</refentrytitle>
  35         <manvolnum>1</manvolnum>
  36     </refmeta>
  37
  38     <refnamediv>
  39         <refname>lxc-update-config</refname>
  40
  41         <refpurpose>
  42             update a legacy pre LXC 2.1 configuration file
  43         </refpurpose>
  44     </refnamediv>
  45
  46     <refsynopsisdiv>
  47         <cmdsynopsis>
  48             <command>lxc-update-config</command>
  49             <arg choice="req">-c <replaceable>config</replaceable></arg>
  50         </cmdsynopsis>
  51     </refsynopsisdiv>
  52
  53     <refsect1>
  54         <title>Description</title>
  55
  56         <para>
  57             <command>lxc-update-config</command> detects any legacy
  58             configuration keys in the given <replaceable>config</replaceable>
  59             file and will replace them with the appropriate new configuration
  60             keys.
  61         </para>
  62         <para>
  63             <command>lxc-update-config</command> will first create a backup of
  64             the old <replaceable>config</replaceable> file in the same directory
  65             and name it <replaceable>config.backup</replaceable> and then update
  66             the original <replaceable>config</replaceable> file in place. In
  67             case the update fails to apply or leads to an invalid
  68             <replaceable>config</replaceable> file that cannot be used to start
  69             a container users can either compare
  70             <replaceable>config</replaceable> with
  71             <replaceable>config.backup</replaceable> and try to manually repair
  72             any the invalid configuration keys or simply rollback to the legacy
  73             configuration file by copying
  74             <replaceable>config.backup</replaceable> to
  75             <replaceable>config</replaceable>.
  76         </para>
  77         <para>
  78             Any failures for <command>lxc-update-config</command> to generate a
  79             useable <replaceable>config</replaceable> file are a bug and should
  80             be reported upstream.
  81         </para>
  82     </refsect1>
  83
  84     <refsect1>
  85         <title>Options</title>
  86         <variablelist>
  87             <varlistentry>
  88                 <term>
  89                     <option>-c, --config</option>
  90                 </term>
  91                 <listitem>
  92                     <para>
  93                         Path to the configuration file to update.
  94                     </para>
  95                 </listitem>
  96             </varlistentry>
  97
  98             <varlistentry>
  99                 <term>
 100                     <option>-h, --help</option>
 101                 </term>
 102                 <listitem>
 103                     <para>
 104                     </para>
 105                 </listitem>
 106             </varlistentry>
 107         </variablelist>
 108     </refsect1>
 109
 110     &seealso;
 111
 112     <refsect1>
 113         <title>Author</title>
 114         <para>Christian Brauner <email>christian.brauner@ubuntu.com</email></para>
 115     </refsect1>
 116 </refentry>
 117
 118 <!-- Keep this comment at the end of the file
 119 Local variables:
 120 mode: sgml
 121 sgml-omittag:t
 122 sgml-shorttag:t
 123 sgml-minimize-attributes:nil
 124 sgml-always-quote-attributes:t
 125 sgml-indent-step:2
 126 sgml-indent-data:t
 127 sgml-parent-document:nil
 128 sgml-default-dtd-file:nil
 129 sgml-exposed-tags:nil
 130 sgml-local-catalogs:nil
 131 sgml-local-ecat-files:nil
 132 End:
 133 -->