[lxc-devel] [PATCH] doc: Add manpage for lxc-config

[Serge Hallyn]

Quoting Stéphane Graber (stgraber at ubuntu.com):
> Signed-off-by: Stéphane Graber <stgraber at ubuntu.com>

Acked-by: Serge E. Hallyn <serge.hallyn at ubuntu.com>

> ---
>  configure.ac           |   1 +
>  doc/Makefile.am        |   1 +
>  doc/lxc-config.sgml.in | 114 +++++++++++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 116 insertions(+)
>  create mode 100644 doc/lxc-config.sgml.in
> 
> diff --git a/configure.ac b/configure.ac
> index 297e760..e5bfbe5 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -587,6 +587,7 @@ AC_CONFIG_FILES([
>  	doc/lxc-cgroup.sgml
>  	doc/lxc-checkconfig.sgml
>  	doc/lxc-clone.sgml
> +	doc/lxc-config.sgml
>  	doc/lxc-console.sgml
>  	doc/lxc-create.sgml
>  	doc/lxc-destroy.sgml
> diff --git a/doc/Makefile.am b/doc/Makefile.am
> index 9ddf53f..bfe887e 100644
> --- a/doc/Makefile.am
> +++ b/doc/Makefile.am
> @@ -21,6 +21,7 @@ man_MANS = \
>  	lxc-cgroup.1 \
>  	lxc-checkconfig.1 \
>  	lxc-clone.1 \
> +	lxc-config.1 \
>  	lxc-console.1 \
>  	lxc-create.1 \
>  	lxc-destroy.1 \
> diff --git a/doc/lxc-config.sgml.in b/doc/lxc-config.sgml.in
> new file mode 100644
> index 0000000..1bd6420
> --- /dev/null
> +++ b/doc/lxc-config.sgml.in
> @@ -0,0 +1,114 @@
> +<!--
> +
> +lxc-config
> +
> +(C) Copyright 2014 Canonical Ltd.
> +
> +Authors:
> +Stéphane Graber <stgraber at 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-config</refentrytitle>
> +        <manvolnum>1</manvolnum>
> +    </refmeta>
> +
> +    <refnamediv>
> +        <refname>lxc-config</refname>
> +
> +        <refpurpose>
> +            query LXC system configuration
> +        </refpurpose>
> +    </refnamediv>
> +
> +    <refsynopsisdiv>
> +        <cmdsynopsis>
> +            <command>lxc-config</command>
> +            <arg choice="opt">-l</arg>
> +            <arg choice="opt"><replaceable>item</replaceable></arg>
> +        </cmdsynopsis>
> +    </refsynopsisdiv>
> +
> +    <refsect1>
> +        <title>Description</title>
> +
> +        <para>
> +            <command>lxc-config</command> queries the lxc system
> +            configuration and lets you list all valid keys or query
> +            individual keys for their value.
> +        </para>
> +    </refsect1>
> +
> +    <refsect1>
> +        <title>Options</title>
> +        <variablelist>
> +            <varlistentry>
> +                <term>
> +                    <option>-l</option>
> +                </term>
> +                <listitem>
> +                    <para>
> +                        List all supported keys.
> +                    </para>
> +                </listitem>
> +            </varlistentry>
> +
> +            <varlistentry>
> +                <term>
> +                    <option>item</option>
> +                </term>
> +                <listitem>
> +                    <para>
> +                        Query the value of the specified key.
> +                    </para>
> +                </listitem>
> +            </varlistentry>
> +        </variablelist>
> +    </refsect1>
> +
> +    &seealso;
> +
> +    <refsect1>
> +        <title>Author</title>
> +        <para>Stéphane Graber <email>stgraber at 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:
> +-->
> -- 
> 1.8.5.3
> 
> _______________________________________________
> lxc-devel mailing list
> lxc-devel at lists.linuxcontainers.org
> http://lists.linuxcontainers.org/listinfo/lxc-devel