doc/lxc-ps.sgml.in

   1
   2 <!--
   3
   4 lxc: linux Container library
   5
   6 (C) Copyright IBM Corp. 2007, 2008
   7
   8 Authors:
   9 Daniel Lezcano <dlezcano at fr.ibm.com>
  10
  11 This library is free software; you can redistribute it and/or
  12 modify it under the terms of the GNU Lesser General Public
  13 License as published by the Free Software Foundation; either
  14 version 2.1 of the License, or (at your option) any later version.
  15
  16 This library is distributed in the hope that it will be useful,
  17 but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19 Lesser General Public License for more details.
  20
  21 You should have received a copy of the GNU Lesser General Public
  22 License along with this library; if not, write to the Free Software
  23 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24
  25 -->
  26
  27 <!DOCTYPE refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
  28
  29 <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml">
  30 ]>
  31
  32 <refentry>
  33
  34   <docinfo><date>@LXC_GENERATE_DATE@</date></docinfo>
  35
  36   <refmeta>
  37     <refentrytitle>lxc-ps</refentrytitle>
  38     <manvolnum>1</manvolnum>
  39   </refmeta>
  40
  41   <refnamediv>
  42     <refname>lxc-ps</refname>
  43
  44     <refpurpose>
  45       list the processes belonging to a specific container.
  46     </refpurpose>
  47   </refnamediv>
  48
  49   <refsynopsisdiv>
  50     <cmdsynopsis>
  51       <command>lxc-ps</command>
  52       <arg choice="opt">--name <replaceable>name</replaceable></arg>
  53       <arg choice="opt">--lxc</arg>
  54       <arg choice="opt">-- ps option</arg>
  55     </cmdsynopsis>
  56   </refsynopsisdiv>
  57
  58   <refsect1>
  59     <title>Description</title>
  60     <para>
  61       <command>lxc-ps</command> is a wrapper tp ps command
  62         to report the name of lxc container associated
  63         to reported processes.
  64     </para>
  65     <para>
  66         The cgroup fs must be mounted before container creation,
  67         to be able to have <command>lxc-ps</command> to find
  68         the container associated to processes.
  69     </para>
  70     <para>
  71         The additionnal specified ps options must not
  72         remove the default ps header and the pid information,
  73         to be able to have the <command>lxc-ps</command> to find
  74         the container associated to processes.
  75     </para>
  76   </refsect1>
  77
  78   <refsect1>
  79     <title>Options</title>
  80     <variablelist>
  81
  82       <varlistentry>
  83         <term>
  84           <option>-n, --name <replaceable>name</replaceable></option>
  85         </term>
  86         <listitem>
  87           <para>
  88             specify the container <replaceable>name</replaceable>
  89             to limit the output to the processes belonging
  90             to this container name.
  91           </para>
  92         </listitem>
  93       </varlistentry>
  94
  95       <varlistentry>
  96         <term>
  97           <option>--lxc</option>
  98         </term>
  99         <listitem>
 100           <para>
 101             limit the output to the processes belonging
 102             to all lxc containers.
 103           </para>
 104         </listitem>
 105       </varlistentry>
 106
 107       <varlistentry>
 108         <term>
 109           <option><optional>ps options</optional></option>
 110         </term>
 111         <listitem>
 112           <para>
 113             The <command>ps</command> options must be separated
 114             from <command>lxc-ps</command> options by
 115             the <option>--</option> parameter.
 116           </para>
 117         </listitem>
 118       </varlistentry>
 119
 120     </variablelist>
 121
 122   </refsect1>
 123
 124   <refsect1>
 125     <title>Example</title>
 126     <variablelist>
 127       <varlistentry>
 128         <term>lxc-ps --name foo -- --forest</term>
 129         <listitem>
 130         <para>
 131           list all the processes belonging to container 'foo' and show
 132           dependencies.
 133         </para>
 134         </listitem>
 135       </varlistentry>
 136     </variablelist>
 137   </refsect1>
 138
 139   <refsect1>
 140     <title>See Also</title>
 141
 142     <simpara>
 143       <citerefentry>
 144         <refentrytitle>ps</refentrytitle>
 145         <manvolnum>1</manvolnum>
 146       </citerefentry>,
 147     </simpara>
 148
 149   </refsect1>
 150
 151   &seealso;
 152
 153   <refsect1>
 154     <title>Author</title>
 155     <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para>
 156   </refsect1>
 157
 158 </refentry>
 159
 160 <!-- Keep this comment at the end of the file
 161 Local variables:
 162 mode: sgml
 163 sgml-omittag:t
 164 sgml-shorttag:t
 165 sgml-minimize-attributes:nil
 166 sgml-always-quote-attributes:t
 167 sgml-indent-step:2
 168 sgml-indent-data:t
 169 sgml-parent-document:nil
 170 sgml-default-dtd-file:nil
 171 sgml-exposed-tags:nil
 172 sgml-local-catalogs:nil
 173 sgml-local-ecat-files:nil
 174 End:
 175 -->