mirror_lxc/doc/lxc-ps.sgml.in

<!-- 

lxc: linux Container library

(C) Copyright IBM Corp. 2007, 2008

Authors:
Daniel Lezcano <dlezcano at fr.ibm.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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

-->

<!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [

<!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 <optional>--name name</optional>
        <optional>--lxc</optional>
	<optional>ps option</optional>
      </command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <command>lxc-ps</command> is a wrapper tp 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 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>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>

      <varlistentry>
	<term>
	  <option><replaceable>--name 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><replaceable>--lxc</replaceable></option>
	</term>
	<listitem>
	  <para>
	    limit the output to the processes belonging 
	    to all lxc containers.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>
	  <option><optional>ps options</optional></option>
	</term>
	<listitem>
	  <para>
	    The option passed to <command>lxc-ps</command> are the
	    same as the <command>ps</command> command.
	  </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:
-->