File: lxc-update-config.sgml.in

package info (click to toggle)
lxc 1%3A5.0.2-1%2Bdeb12u3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,416 kB
  • sloc: ansic: 68,763; sh: 4,118; python: 135; makefile: 53
file content (133 lines) | stat: -rw-r--r-- 4,071 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<!--

lxc-update-config

(C) Copyright 2017 Canonical Ltd.

Authors:
Christian Brauner <christian.brauner@ubuntu.com>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

-->

<!DOCTYPE refentry PUBLIC @docdtd@ [
    <!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml">
    <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
]>

<refentry>
    <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
    <refmeta>
        <refentrytitle>lxc-update-config</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>lxc-update-config</refname>

        <refpurpose>
            update a legacy pre LXC 2.1 configuration file
        </refpurpose>
    </refnamediv>

    <refsynopsisdiv>
        <cmdsynopsis>
            <command>lxc-update-config</command>
            <arg choice="req">-c <replaceable>config</replaceable></arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
	    <command>lxc-update-config</command> detects any legacy
	    configuration keys in the given <replaceable>config</replaceable>
	    file and will replace them with the appropriate new configuration
	    keys.
        </para>
	<para>
	    <command>lxc-update-config</command> will first create a backup of
	    the old <replaceable>config</replaceable> file in the same directory
	    and name it <replaceable>config.backup</replaceable> and then update
	    the original <replaceable>config</replaceable> file in place. In
	    case the update fails to apply or leads to an invalid
	    <replaceable>config</replaceable> file that cannot be used to start
	    a container users can either compare
	    <replaceable>config</replaceable> with
	    <replaceable>config.backup</replaceable> and try to manually repair
	    any the invalid configuration keys or simply rollback to the legacy
	    configuration file by copying
	    <replaceable>config.backup</replaceable> to
	    <replaceable>config</replaceable>.
        </para>
	<para>
	    Any failures for <command>lxc-update-config</command> to generate a
	    useable <replaceable>config</replaceable> file are a bug and should
	    be reported upstream.
        </para>
    </refsect1>

    <refsect1>
        <title>Options</title>
        <variablelist>
            <varlistentry>
                <term>
                    <option>-c, --config</option>
                </term>
                <listitem>
                    <para>
			Path to the configuration file to update.
                    </para>
                </listitem>
            </varlistentry>

            <varlistentry>
                <term>
                    <option>-h, --help</option>
                </term>
                <listitem>
                    <para>
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsect1>

    &seealso;

    <refsect1>
        <title>Author</title>
        <para>Christian Brauner <email>christian.brauner@ubuntu.com</email></para>
    </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->