aboutsummaryrefslogtreecommitdiff
blob: bb7b5a6591489ca274f623c8e1a11f4bae1767b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
<!-- 

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 <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:
-->