From: Stéphane Graber <stgraber@ubuntu.com>
Date: Thu, 23 Jan 2014 16:38:47 +0000 (-0500)
Subject: doc: Add manpage for lxc-config
X-Git-Tag: lxc-1.0.0.beta3~45
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ff5e27510540a2ee3c66d8496996313d01bb848f;p=thirdparty%2Flxc.git

doc: Add manpage for lxc-config

Signed-off-by: Stéphane Graber <stgraber@ubuntu.com>
Acked-by: Serge Hallyn <serge.hallyn@ubuntu.com>
---

diff --git a/configure.ac b/configure.ac
index 297e760f9..e5bfbe552 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 9ddf53f75..bfe887ed6 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 000000000..1bd642080
--- /dev/null
+++ b/doc/lxc-config.sgml.in
@@ -0,0 +1,114 @@
+<!--
+
+lxc-config
+
+(C) Copyright 2014 Canonical Ltd.
+
+Authors:
+Stéphane Graber <stgraber@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@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:
+-->