]>
Commit | Line | Data |
---|---|---|
d823d5b9 | 1 | |
f79d43bb | 2 | <!-- |
d823d5b9 | 3 | |
4 | lxc: linux Container library | |
5 | ||
6 | (C) Copyright IBM Corp. 2007, 2008 | |
7 | ||
8 | Authors: | |
9afe19d6 | 9 | Daniel Lezcano <daniel.lezcano at free.fr> |
d823d5b9 | 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 | |
250b1eec | 23 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
d823d5b9 | 24 | |
25 | --> | |
26 | ||
7f951458 | 27 | <!DOCTYPE refentry PUBLIC @docdtd@ [ |
99e4008c MN |
28 | |
29 | <!ENTITY seealso SYSTEM "@builddir@/see_also.sgml"> | |
30 | ]> | |
d823d5b9 | 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> | |
b4578c5b DE |
51 | <command>lxc-ps</command> |
52 | <arg choice="opt">--name <replaceable>name</replaceable></arg> | |
53 | <arg choice="opt">--lxc</arg> | |
6e2faa37 | 54 | <arg choice="opt">--host</arg> |
1354f952 | 55 | <arg choice="opt">-- <replaceable>ps options</replaceable></arg> |
d823d5b9 | 56 | </cmdsynopsis> |
57 | </refsynopsisdiv> | |
58 | ||
59 | <refsect1> | |
60 | <title>Description</title> | |
61 | <para> | |
4019712d | 62 | <command>lxc-ps</command> is a wrapper to the ps command |
8f0024d8 MN |
63 | to report the name of lxc container associated |
64 | to reported processes. | |
65 | </para> | |
66 | <para> | |
67 | The cgroup fs must be mounted before container creation, | |
68 | to be able to have <command>lxc-ps</command> to find | |
69 | the container associated to processes. | |
70 | </para> | |
71 | <para> | |
1354f952 | 72 | The additional specified <replaceable>ps options</replaceable> must not |
8f0024d8 MN |
73 | remove the default ps header and the pid information, |
74 | to be able to have the <command>lxc-ps</command> to find | |
75 | the container associated to processes. | |
d823d5b9 | 76 | </para> |
77 | </refsect1> | |
78 | ||
79 | <refsect1> | |
80 | <title>Options</title> | |
81 | <variablelist> | |
82 | ||
83 | <varlistentry> | |
84 | <term> | |
c12e7752 | 85 | <option>-n, --name <replaceable>name</replaceable></option> |
d823d5b9 | 86 | </term> |
87 | <listitem> | |
88 | <para> | |
b4578c5b | 89 | specify the container <replaceable>name</replaceable> |
f79d43bb SG |
90 | to limit the output to the processes belonging |
91 | to this container name. | |
8f0024d8 MN |
92 | </para> |
93 | </listitem> | |
94 | </varlistentry> | |
95 | ||
96 | <varlistentry> | |
97 | <term> | |
b4578c5b | 98 | <option>--lxc</option> |
8f0024d8 MN |
99 | </term> |
100 | <listitem> | |
101 | <para> | |
f79d43bb | 102 | limit the output to the processes belonging |
8f0024d8 | 103 | to all lxc containers. |
d823d5b9 | 104 | </para> |
105 | </listitem> | |
106 | </varlistentry> | |
107 | ||
6e2faa37 JG |
108 | <varlistentry> |
109 | <term> | |
110 | <option>--host</option> | |
111 | </term> | |
112 | <listitem> | |
113 | <para> | |
114 | limit the output to the processes belonging | |
115 | to the host. | |
116 | </para> | |
117 | </listitem> | |
118 | </varlistentry> | |
119 | ||
d823d5b9 | 120 | <varlistentry> |
121 | <term> | |
1354f952 | 122 | <option><optional><replaceable>ps options</replaceable></optional></option> |
d823d5b9 | 123 | </term> |
124 | <listitem> | |
125 | <para> | |
c797dcc3 DL |
126 | The <command>ps</command> options must be separated |
127 | from <command>lxc-ps</command> options by | |
128 | the <option>--</option> parameter. | |
d823d5b9 | 129 | </para> |
130 | </listitem> | |
131 | </varlistentry> | |
132 | ||
133 | </variablelist> | |
134 | ||
135 | </refsect1> | |
136 | ||
137 | <refsect1> | |
8f0024d8 | 138 | <title>Example</title> |
d823d5b9 | 139 | <variablelist> |
140 | <varlistentry> | |
c797dcc3 | 141 | <term>lxc-ps --name foo -- --forest</term> |
d823d5b9 | 142 | <listitem> |
143 | <para> | |
144 | list all the processes belonging to container 'foo' and show | |
145 | dependencies. | |
146 | </para> | |
147 | </listitem> | |
148 | </varlistentry> | |
d823d5b9 | 149 | </variablelist> |
150 | </refsect1> | |
151 | ||
152 | <refsect1> | |
153 | <title>See Also</title> | |
154 | ||
f79d43bb | 155 | <simpara> |
d823d5b9 | 156 | <citerefentry> |
157 | <refentrytitle>ps</refentrytitle> | |
158 | <manvolnum>1</manvolnum> | |
159 | </citerefentry>, | |
160 | </simpara> | |
161 | ||
d823d5b9 | 162 | </refsect1> |
163 | ||
99e4008c MN |
164 | &seealso; |
165 | ||
d823d5b9 | 166 | <refsect1> |
167 | <title>Author</title> | |
168 | <para>Daniel Lezcano <email>daniel.lezcano@free.fr</email></para> | |
169 | </refsect1> | |
170 | ||
171 | </refentry> | |
172 | ||
173 | <!-- Keep this comment at the end of the file | |
174 | Local variables: | |
175 | mode: sgml | |
176 | sgml-omittag:t | |
177 | sgml-shorttag:t | |
178 | sgml-minimize-attributes:nil | |
179 | sgml-always-quote-attributes:t | |
180 | sgml-indent-step:2 | |
181 | sgml-indent-data:t | |
182 | sgml-parent-document:nil | |
183 | sgml-default-dtd-file:nil | |
184 | sgml-exposed-tags:nil | |
185 | sgml-local-catalogs:nil | |
186 | sgml-local-ecat-files:nil | |
187 | End: | |
188 | --> |