]>
Commit | Line | Data |
---|---|---|
fa776d8e LP |
1 | <?xml version='1.0'?> <!--*-nxml-*--> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2010 Lennart Poettering | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
5430f7f2 LP |
11 | under the terms of the GNU Lesser General Public License as published by |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
fa776d8e LP |
13 | (at your option) any later version. |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
5430f7f2 | 18 | Lesser General Public License for more details. |
fa776d8e | 19 | |
5430f7f2 | 20 | You should have received a copy of the GNU Lesser General Public License |
fa776d8e LP |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. |
22 | --> | |
23 | ||
24 | <refentry id="systemd-cgls"> | |
25 | ||
26 | <refentryinfo> | |
27 | <title>systemd-cgls</title> | |
28 | <productname>systemd</productname> | |
29 | ||
30 | <authorgroup> | |
31 | <author> | |
32 | <contrib>Developer</contrib> | |
33 | <firstname>Lennart</firstname> | |
34 | <surname>Poettering</surname> | |
35 | <email>lennart@poettering.net</email> | |
36 | </author> | |
37 | </authorgroup> | |
38 | </refentryinfo> | |
39 | ||
40 | <refmeta> | |
41 | <refentrytitle>systemd-cgls</refentrytitle> | |
42 | <manvolnum>1</manvolnum> | |
43 | </refmeta> | |
44 | ||
45 | <refnamediv> | |
46 | <refname>systemd-cgls</refname> | |
47 | <refpurpose>Recursively show control group contents</refpurpose> | |
48 | </refnamediv> | |
49 | ||
50 | <refsynopsisdiv> | |
51 | <cmdsynopsis> | |
38158b92 ZJS |
52 | <command>systemd-cgls</command> |
53 | <arg choice="opt" rep="repeat">OPTIONS</arg> | |
54 | <arg choice="opt" rep="repeat">CGROUP</arg> | |
fa776d8e LP |
55 | </cmdsynopsis> |
56 | </refsynopsisdiv> | |
57 | ||
58 | <refsect1> | |
59 | <title>Description</title> | |
60 | ||
61 | <para><command>systemd-cgls</command> recursively | |
62 | shows the contents of the selected Linux control group | |
63 | hierarchy in a tree. If arguments are specified shows | |
64 | all member processes of the specified control groups | |
65 | plus all their subgroups and their members. The | |
66 | control groups may either be specified by their full | |
67 | file paths or are assumed in the systemd control group | |
68 | hierarchy. If no argument is specified and the current | |
69 | working directory is beneath the control group mount | |
77d5f105 | 70 | point <filename>/sys/fs/cgroup</filename> shows the contents |
fa776d8e LP |
71 | of the control group the working directory refers |
72 | to. Otherwise the full systemd control group hierarchy | |
73 | is shown.</para> | |
c3175a7f | 74 | |
bb31a4ac | 75 | <para>By default empty control groups are not |
c3175a7f | 76 | shown.</para> |
fa776d8e LP |
77 | </refsect1> |
78 | ||
79 | <refsect1> | |
80 | <title>Options</title> | |
81 | ||
82 | <para>The following options are understood:</para> | |
83 | ||
84 | <variablelist> | |
85 | <varlistentry> | |
caa94887 | 86 | <term><option>-h</option></term> |
fa776d8e LP |
87 | <term><option>--help</option></term> |
88 | ||
89 | <listitem><para>Prints a short help | |
90 | text and exits.</para></listitem> | |
91 | </varlistentry> | |
92 | ||
c3175a7f LP |
93 | <varlistentry> |
94 | <term><option>--version</option></term> | |
95 | ||
96 | <listitem><para>Prints a short version | |
97 | string and exits.</para></listitem> | |
98 | </varlistentry> | |
99 | ||
1e5678d0 LP |
100 | <varlistentry> |
101 | <term><option>--no-pager</option></term> | |
102 | ||
0e25e94e KS |
103 | <listitem><para>Do not pipe output into a |
104 | pager.</para></listitem> | |
105 | </varlistentry> | |
1e5678d0 | 106 | |
c3175a7f LP |
107 | <varlistentry> |
108 | <term><option>--all</option></term> | |
109 | ||
0e25e94e KS |
110 | <listitem><para>Don't hide empty |
111 | control groups in the | |
bb31a4ac | 112 | output.</para></listitem> |
0e25e94e | 113 | </varlistentry> |
c3175a7f | 114 | |
9bdbc2e2 LN |
115 | <varlistentry> |
116 | <term><option>--full</option></term> | |
117 | ||
118 | <listitem><para>Do not ellipsize cgroup | |
119 | members.</para> | |
120 | </listitem> | |
121 | </varlistentry> | |
122 | ||
1e5678d0 LP |
123 | <varlistentry> |
124 | <term><option>-k</option></term> | |
125 | ||
caa94887 | 126 | <listitem><para>Include kernel |
1e5678d0 LP |
127 | threads in output.</para></listitem> |
128 | </varlistentry> | |
129 | ||
38158b92 ZJS |
130 | <varlistentry> |
131 | <term><option>-m <replaceable>MACHINE</replaceable></option></term> | |
132 | <term><option>--machine=<replaceable>MACHINE</replaceable></option></term> | |
133 | ||
134 | <listitem><para>Limit cgroups shown to | |
135 | the part corresponding to the | |
136 | container <replaceable>MACHINE</replaceable>. | |
137 | </para></listitem> | |
138 | </varlistentry> | |
139 | ||
fa776d8e LP |
140 | </variablelist> |
141 | ||
142 | </refsect1> | |
143 | ||
144 | <refsect1> | |
145 | <title>Exit status</title> | |
146 | ||
147 | <para>On success 0 is returned, a non-zero failure | |
148 | code otherwise.</para> | |
149 | </refsect1> | |
150 | ||
151 | <refsect1> | |
152 | <title>See Also</title> | |
153 | <para> | |
154 | <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
caa94887 LP |
155 | <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
156 | <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
38158b92 | 157 | <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, |
caa94887 | 158 | <citerefentry><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> |
fa776d8e LP |
159 | </para> |
160 | </refsect1> | |
161 | ||
162 | </refentry> |