Skip to content

L
lxc
Commit 8f0024d8 by Michel Normand Committed by Daniel Lezcano
Options

update the lxc-ps man page after previous code change

this is the man page update following the previous git commit 7cbfc4e4Signed-off-by: 's avatarMichel Normand <normand@fr.ibm.com> Signed-off-by: 's avatarDaniel Lezcano <dlezcano@fr.ibm.com>
parent 8e9d7710
Showing with 34 additions and 18 deletions
doc/lxc-ps.sgml.in
...@@ -48,7 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -48,7 +48,8 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>lxc-ps <replaceable>-n name</replaceable> <command>lxc-ps <optional>--name name</optional>
<optional>--lxc</optional>
<optional>ps option</optional> <optional>ps option</optional>
</command> </command>
</cmdsynopsis> </cmdsynopsis>
...@@ -57,8 +58,20 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -57,8 +58,20 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<refsect1> <refsect1>
<title>Description</title> <title>Description</title>
<para> <para>
<command>lxc-ps</command> list the processes belonging to a <command>lxc-ps</command> is a wrapper tp ps command
specific container. to report the name of lxc container associated
to reported processes.
</para>
<para>
The cgroup fs must be mounted before container creation,
to be able to have <command>lxc-ps</command> to find
the container associated to processes.
</para>
<para>
The additionnal specified ps options must not
remove the default ps header and the pid information,
to be able to have the <command>lxc-ps</command> to find
the container associated to processes.
</para> </para>
</refsect1> </refsect1>
...@@ -68,12 +81,25 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -68,12 +81,25 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
<varlistentry> <varlistentry>
<term> <term>
<option><replaceable>-n name</replaceable></option> <option><replaceable>--name NAME</replaceable></option>
</term> </term>
<listitem> <listitem>
<para> <para>
specify the container <replaceable>name</replaceable> to specify the container <replaceable>NAME</replaceable>
list the processes. to limit the output to the processes belonging
to this container name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option><replaceable>--lxc</replaceable></option>
</term>
<listitem>
<para>
limit the output to the processes belonging
to all lxc containers.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
...@@ -95,10 +121,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -95,10 +121,10 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</refsect1> </refsect1>
<refsect1> <refsect1>
<title>Examples</title> <title>Example</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>lxc-ps -n foo --forest</term> <term>lxc-ps --name foo --forest</term>
<listitem> <listitem>
<para> <para>
list all the processes belonging to container 'foo' and show list all the processes belonging to container 'foo' and show
...@@ -106,16 +132,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA ...@@ -106,16 +132,6 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term>lxc-ps -n foo -o pid=</term>
<listitem>
<para>
list all the containers and display the list in one column.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment