chiark / gitweb /
hashmap: return more information from resize_buckets()
[elogind.git] / man / systemd-cgls.xml
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
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
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
18   Lesser General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public License
21   along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 -->
23
24 <refentry id="systemd-cgls"
25           xmlns:xi="http://www.w3.org/2001/XInclude">
26
27         <refentryinfo>
28                 <title>systemd-cgls</title>
29                 <productname>systemd</productname>
30
31                 <authorgroup>
32                         <author>
33                                 <contrib>Developer</contrib>
34                                 <firstname>Lennart</firstname>
35                                 <surname>Poettering</surname>
36                                 <email>lennart@poettering.net</email>
37                         </author>
38                 </authorgroup>
39         </refentryinfo>
40
41         <refmeta>
42                 <refentrytitle>systemd-cgls</refentrytitle>
43                 <manvolnum>1</manvolnum>
44         </refmeta>
45
46         <refnamediv>
47                 <refname>systemd-cgls</refname>
48                 <refpurpose>Recursively show control group contents</refpurpose>
49         </refnamediv>
50
51         <refsynopsisdiv>
52                 <cmdsynopsis>
53                         <command>systemd-cgls</command>
54                         <arg choice="opt" rep="repeat">OPTIONS</arg>
55                         <arg choice="opt" rep="repeat">CGROUP</arg>
56                 </cmdsynopsis>
57         </refsynopsisdiv>
58
59         <refsect1>
60                 <title>Description</title>
61
62                 <para><command>systemd-cgls</command> recursively
63                 shows the contents of the selected Linux control group
64                 hierarchy in a tree. If arguments are specified, shows
65                 all member processes of the specified control groups
66                 plus all their subgroups and their members. The
67                 control groups may either be specified by their full
68                 file paths or are assumed in the systemd control group
69                 hierarchy. If no argument is specified and the current
70                 working directory is beneath the control group mount
71                 point <filename>/sys/fs/cgroup</filename>, shows the contents
72                 of the control group the working directory refers
73                 to. Otherwise, the full systemd control group hierarchy
74                 is shown.</para>
75
76                 <para>By default, empty control groups are not
77                 shown.</para>
78         </refsect1>
79
80         <refsect1>
81                 <title>Options</title>
82
83                 <para>The following options are understood:</para>
84
85                 <variablelist>
86                         <varlistentry>
87                                 <term><option>--all</option></term>
88
89                                 <listitem><para>Do not hide empty
90                                 control groups in the
91                                 output.</para></listitem>
92                         </varlistentry>
93
94                         <varlistentry>
95                                 <term><option>-l</option></term>
96                                 <term><option>--full</option></term>
97
98                                 <listitem><para>Do not ellipsize
99                                 process tree members.</para>
100                                 </listitem>
101                         </varlistentry>
102
103                         <varlistentry>
104                                 <term><option>-k</option></term>
105
106                                 <listitem><para>Include kernel
107                                 threads in output.</para></listitem>
108                         </varlistentry>
109
110                         <varlistentry>
111                                 <term><option>-M <replaceable>MACHINE</replaceable></option></term>
112                                 <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
113
114                                 <listitem><para>Limit control groups shown to
115                                 the part corresponding to the
116                                 container <replaceable>MACHINE</replaceable>.
117                                 </para></listitem>
118                         </varlistentry>
119
120                         <xi:include href="standard-options.xml" xpointer="help" />
121                         <xi:include href="standard-options.xml" xpointer="version" />
122                         <xi:include href="standard-options.xml" xpointer="no-pager" />
123                 </variablelist>
124
125         </refsect1>
126
127         <refsect1>
128                 <title>Exit status</title>
129
130                 <para>On success, 0 is returned, a non-zero failure
131                 code otherwise.</para>
132         </refsect1>
133
134         <refsect1>
135                 <title>See Also</title>
136                 <para>
137                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
138                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
139                         <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
140                         <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
141                         <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
142                 </para>
143         </refsect1>
144
145 </refentry>