| 1 |
<!-- SPDX-License-Identifier: LGPL-2.1+ --> |
| 2 |
|
| 3 |
<!DOCTYPE refentry PUBLIC @docdtd@ [ |
| 4 |
<!ENTITY commonoptions SYSTEM "@builddir@/common_options.sgml"> |
| 5 |
<!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> |
| 6 |
]> |
| 7 |
|
| 8 |
<refentry> |
| 9 |
<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo> |
| 10 |
<refmeta> |
| 11 |
<refentrytitle>lxc-update-config</refentrytitle> |
| 12 |
<manvolnum>1</manvolnum> |
| 13 |
</refmeta> |
| 14 |
|
| 15 |
<refnamediv> |
| 16 |
<refname>lxc-update-config</refname> |
| 17 |
|
| 18 |
<refpurpose> |
| 19 |
update a legacy pre LXC 2.1 configuration file |
| 20 |
</refpurpose> |
| 21 |
</refnamediv> |
| 22 |
|
| 23 |
<refsynopsisdiv> |
| 24 |
<cmdsynopsis> |
| 25 |
<command>lxc-update-config</command> |
| 26 |
<arg choice="req">-c <replaceable>config</replaceable></arg> |
| 27 |
</cmdsynopsis> |
| 28 |
</refsynopsisdiv> |
| 29 |
|
| 30 |
<refsect1> |
| 31 |
<title>Description</title> |
| 32 |
|
| 33 |
<para> |
| 34 |
<command>lxc-update-config</command> detects any legacy |
| 35 |
configuration keys in the given <replaceable>config</replaceable> |
| 36 |
file and will replace them with the appropriate new configuration |
| 37 |
keys. |
| 38 |
</para> |
| 39 |
<para> |
| 40 |
<command>lxc-update-config</command> will first create a backup of |
| 41 |
the old <replaceable>config</replaceable> file in the same directory |
| 42 |
and name it <replaceable>config.backup</replaceable> and then update |
| 43 |
the original <replaceable>config</replaceable> file in place. In |
| 44 |
case the update fails to apply or leads to an invalid |
| 45 |
<replaceable>config</replaceable> file that cannot be used to start |
| 46 |
a container users can either compare |
| 47 |
<replaceable>config</replaceable> with |
| 48 |
<replaceable>config.backup</replaceable> and try to manually repair |
| 49 |
any the invalid configuration keys or simply rollback to the legacy |
| 50 |
configuration file by copying |
| 51 |
<replaceable>config.backup</replaceable> to |
| 52 |
<replaceable>config</replaceable>. |
| 53 |
</para> |
| 54 |
<para> |
| 55 |
Any failures for <command>lxc-update-config</command> to generate a |
| 56 |
useable <replaceable>config</replaceable> file are a bug and should |
| 57 |
be reported upstream. |
| 58 |
</para> |
| 59 |
</refsect1> |
| 60 |
|
| 61 |
<refsect1> |
| 62 |
<title>Options</title> |
| 63 |
<variablelist> |
| 64 |
<varlistentry> |
| 65 |
<term> |
| 66 |
<option>-c, --config</option> |
| 67 |
</term> |
| 68 |
<listitem> |
| 69 |
<para> |
| 70 |
Path to the configuration file to update. |
| 71 |
</para> |
| 72 |
</listitem> |
| 73 |
</varlistentry> |
| 74 |
|
| 75 |
<varlistentry> |
| 76 |
<term> |
| 77 |
<option>-h, --help</option> |
| 78 |
</term> |
| 79 |
<listitem> |
| 80 |
<para> |
| 81 |
</para> |
| 82 |
</listitem> |
| 83 |
</varlistentry> |
| 84 |
</variablelist> |
| 85 |
</refsect1> |
| 86 |
|
| 87 |
&seealso; |
| 88 |
</refentry> |
| 89 |
|
| 90 |
<!-- Keep this comment at the end of the file |
| 91 |
Local variables: |
| 92 |
mode: sgml |
| 93 |
sgml-omittag:t |
| 94 |
sgml-shorttag:t |
| 95 |
sgml-minimize-attributes:nil |
| 96 |
sgml-always-quote-attributes:t |
| 97 |
sgml-indent-step:2 |
| 98 |
sgml-indent-data:t |
| 99 |
sgml-parent-document:nil |
| 100 |
sgml-default-dtd-file:nil |
| 101 |
sgml-exposed-tags:nil |
| 102 |
sgml-local-catalogs:nil |
| 103 |
sgml-local-ecat-files:nil |
| 104 |
End: |
| 105 |
--> |