[lxc-devel] [PATCH] Adapt manpage for lxc-ls to new C implementation
Christian Brauner
christianvanbrauner at gmail.com
Mon Jan 18 23:39:10 UTC 2016
- explain new -r,--regex flag
- explain new numeric argument to --nesting
- include common options as lxc-ls now uses the standard lxc parser
- add history section and update authors
Signed-off-by: Christian Brauner <christian.brauner at mailbox.org>
---
doc/lxc-ls.sgml.in | 65 +++++++++++++++++++++++-------------------------------
1 file changed, 27 insertions(+), 38 deletions(-)
diff --git a/doc/lxc-ls.sgml.in b/doc/lxc-ls.sgml.in
index 41a23e6..9f901a0 100644
--- a/doc/lxc-ls.sgml.in
+++ b/doc/lxc-ls.sgml.in
@@ -1,12 +1,11 @@
-
<!--
lxc: linux Container library
-(C) Copyright IBM Corp. 2007, 2008
+(C) Copyright Canonical Inc. 2007, 2008
Authors:
-Daniel Lezcano <daniel.lezcano at free.fr>
+Christian Brauner <christian.brauner at mailbox.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
@@ -26,6 +25,7 @@ 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">
]>
@@ -50,7 +50,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<cmdsynopsis>
<command>lxc-ls</command>
<arg choice="opt">-1</arg>
- <arg choice="opt">-P <replaceable>lxcpath</replaceable></arg>
<arg choice="opt">--active</arg>
<arg choice="opt">--frozen</arg>
<arg choice="opt">--running</arg>
@@ -58,9 +57,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<arg choice="opt">-f</arg>
<arg choice="opt">-F <replaceable>format</replaceable></arg>
<arg choice="opt">-g <replaceable>groups</replaceable></arg>
- <arg choice="opt">--nesting</arg>
- <arg choice="opt">filter</arg>
- <arg choice="opt">--version</arg>
+ <arg choice="opt">--nesting=<replaceable>NUM</replaceable></arg>
+ <arg choice="opt">-r, --regex <replaceable>regex</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -88,17 +86,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<varlistentry>
<term>
- <option>-P, --lxcpath</option>
- </term>
- <listitem>
- <para>
- Use an alternate container path. The default is @LXCPATH at .
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
<option>--active</option>
</term>
<listitem>
@@ -143,7 +130,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<varlistentry>
<term>
- <option>-f, --fancy</option>
+ <option>-f,--fancy</option>
</term>
<listitem>
<para>
@@ -154,7 +141,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<varlistentry>
<term>
- <option>-F, --fancy-format <replaceable>format</replaceable></option>
+ <option>-F,--fancy-format <replaceable>format</replaceable></option>
</term>
<listitem>
<para>
@@ -166,7 +153,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<varlistentry>
<term>
- <option>-g, --groups <replaceable>groups</replaceable></option>
+ <option>-g,--groups <replaceable>groups</replaceable></option>
</term>
<listitem>
<para>
@@ -178,34 +165,25 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
<varlistentry>
<term>
- <option>--nesting</option>
- </term>
- <listitem>
- <para>
- Show nested containers.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>
- <option>filter</option>
+ <option>--nesting=<replaceable>NUM</replaceable></option>
</term>
<listitem>
<para>
- The filter passed to <command>lxc-ls</command> will be
- applied to the container name. The format is a regular expression.
+ Show nested containers. The number of nesting levels to be shown can
+ be specified by passing a number as argument.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <option>--version</option>
+ <option>-r,--regex</option>
</term>
<listitem>
<para>
- Show the version number.
+ The regular expression passed to <command>lxc-ls</command> will be
+ applied to the container name. The format is a POSIX extended
+ regular expression.
</para>
</listitem>
</varlistentry>
@@ -236,12 +214,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
</variablelist>
</refsect1>
+ &commonoptions;
+
&seealso;
<refsect1>
+ <title>History</title>
+ Written originally as a shell script by Daniel Lezcano and Serge Hallyn.
+ Later reimplemented and extended in Python by Stéphane Graber and then
+ reimplemented and extended in C by Christian Brauner.
+ </refsect1>
+
+ <refsect1>
<title>Author</title>
- <para>Stéphane Graber <email>stgraber at ubuntu.com</email></para>
+ <para>Christian Brauner <email>christian.brauner at mailbox.org</email>,
+ Stéphane Graber <email>stgraber at ubuntu.com</email></para>
</refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
--
2.7.0
More information about the lxc-devel
mailing list