chiark / gitweb /
main: add a few more useful diagnostic log messages
[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 General Public License as published by
12   the Free Software Foundation; either version 2 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   General Public License for more details.
19
20   You should have received a copy of the GNU General Public License
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>
52                         <command>systemd-cgls <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">CGROUP</arg></command>
53                 </cmdsynopsis>
54         </refsynopsisdiv>
55
56         <refsect1>
57                 <title>Description</title>
58
59                 <para><command>systemd-cgls</command> recursively
60                 shows the contents of the selected Linux control group
61                 hierarchy in a tree. If arguments are specified shows
62                 all member processes of the specified control groups
63                 plus all their subgroups and their members. The
64                 control groups may either be specified by their full
65                 file paths or are assumed in the systemd control group
66                 hierarchy. If no argument is specified and the current
67                 working directory is beneath the control group mount
68                 point <filename>/cgroup</filename> shows the contents
69                 of the control group the working directory refers
70                 to. Otherwise the full systemd control group hierarchy
71                 is shown.</para>
72         </refsect1>
73
74         <refsect1>
75                 <title>Options</title>
76
77                 <para>The following options are understood:</para>
78
79                 <variablelist>
80                         <varlistentry>
81                                 <term><option>--help</option></term>
82
83                                 <listitem><para>Prints a short help
84                                 text and exits.</para></listitem>
85                         </varlistentry>
86
87                 </variablelist>
88
89         </refsect1>
90
91         <refsect1>
92                 <title>Exit status</title>
93
94                 <para>On success 0 is returned, a non-zero failure
95                 code otherwise.</para>
96         </refsect1>
97
98         <refsect1>
99                 <title>See Also</title>
100                 <para>
101                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
102                         <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
103                 </para>
104         </refsect1>
105
106 </refentry>