<!--

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:

Daniel Lezcano <daniel.lezcano at free.fr>

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 seealso SYSTEM "@builddir@/see_also.sgml">

]>

<refentry>

<docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>

<refmeta>

<refentrytitle>lxc-ps</refentrytitle>

<manvolnum>1</manvolnum>

</refmeta>

<refnamediv>

<refname>lxc-ps</refname>

<refpurpose>

list the processes belonging to a specific container.

</refpurpose>

</refnamediv>

<refsynopsisdiv>

<cmdsynopsis>

<command>lxc-ps</command>

<arg choice="opt">--name <replaceable>name</replaceable></arg>

<arg choice="opt">--lxc</arg>

<arg choice="opt">--host</arg>

<arg choice="opt">-- <replaceable>ps options</replaceable></arg>

</cmdsynopsis>

</refsynopsisdiv>

<refsect1>

<title>Description</title>

<para>

<command>lxc-ps</command> is a wrapper to the ps command

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 additional specified <replaceable>ps options</replaceable> 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>

</refsect1>

<refsect1>

<title>Options</title>

<variablelist>

<varlistentry>

<term>

<option>-n, --name <replaceable>name</replaceable></option>

</term>

<listitem>

<para>

specify the container <replaceable>name</replaceable>

to limit the output to the processes belonging

to this container name.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>--lxc</option>

</term>

<listitem>

<para>

limit the output to the processes belonging

to all lxc containers.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option>--host</option>

</term>

<listitem>

<para>

limit the output to the processes belonging

to the host.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>

<option><optional><replaceable>ps options</replaceable></optional></option>

</term>

<listitem>

<para>

The <command>ps</command> options must be separated

from <command>lxc-ps</command> options by

the <option>--</option> parameter.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>Example</title>

<variablelist>

<varlistentry>

<term>lxc-ps --name foo -- --forest</term>

<listitem>

<para>

list all the processes belonging to container 'foo' and show

dependencies.

</para>

</listitem>

</varlistentry>

</variablelist>

</refsect1>

<refsect1>

<title>See Also</title>

<simpara>

<citerefentry>

<refentrytitle>ps</refentrytitle>

<manvolnum>1</manvolnum>

</citerefentry>,

</simpara>

</refsect1>

&seealso;

<refsect1>

<title>Author</title>

<para>Daniel Lezcano <email>daniel.lezcano@free.fr</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:

-->