mirror_lxc/doc/lxc-update-config.sgml.in
Stéphane Graber 8e67eb07c8
doc: Add SPDX headers and remove Author field
Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
2024-04-02 20:23:13 -04:00

106 lines
3.1 KiB
Plaintext

<!-- SPDX-License-Identifier: LGPL-2.1+ -->
<!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;
</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:
-->