]> git.ipfire.org Git - thirdparty/systemd.git/blob - man/systemd-cgls.xml
Merge pull request #8822 from fbuihuu/rfc-tmpfiles-safe-upstream
[thirdparty/systemd.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 SPDX-License-Identifier: LGPL-2.1+
7 -->
8
9 <refentry id="systemd-cgls"
10 xmlns:xi="http://www.w3.org/2001/XInclude">
11
12 <refentryinfo>
13 <title>systemd-cgls</title>
14 <productname>systemd</productname>
15 </refentryinfo>
16
17 <refmeta>
18 <refentrytitle>systemd-cgls</refentrytitle>
19 <manvolnum>1</manvolnum>
20 </refmeta>
21
22 <refnamediv>
23 <refname>systemd-cgls</refname>
24 <refpurpose>Recursively show control group contents</refpurpose>
25 </refnamediv>
26
27 <refsynopsisdiv>
28 <cmdsynopsis>
29 <command>systemd-cgls</command>
30 <arg choice="opt" rep="repeat">OPTIONS</arg>
31 <arg choice="opt" rep="repeat">CGROUP</arg>
32 </cmdsynopsis>
33 <cmdsynopsis>
34 <command>systemd-cgls</command>
35 <arg choice="opt" rep="repeat">OPTIONS</arg>
36 <arg choice="plain"><option>--unit</option>|<option>--user-unit</option></arg>
37 <arg choice="opt" rep="repeat">UNIT</arg>
38 </cmdsynopsis>
39 </refsynopsisdiv>
40
41 <refsect1>
42 <title>Description</title>
43
44 <para><command>systemd-cgls</command> recursively shows the
45 contents of the selected Linux control group hierarchy in a tree.
46 If arguments are specified, shows all member processes of the
47 specified control groups plus all their subgroups and their
48 members. The control groups may either be specified by their full
49 file paths or are assumed in the systemd control group hierarchy.
50 If no argument is specified and the current working directory is
51 beneath the control group mount point
52 <filename>/sys/fs/cgroup</filename>, shows the contents of the
53 control group the working directory refers to. Otherwise, the full
54 systemd control group hierarchy is shown.</para>
55
56 <para>By default, empty control groups are not shown.</para>
57 </refsect1>
58
59 <refsect1>
60 <title>Options</title>
61
62 <para>The following options are understood:</para>
63
64 <variablelist>
65 <varlistentry>
66 <term><option>--all</option></term>
67
68 <listitem><para>Do not hide empty control groups in the
69 output.</para></listitem>
70 </varlistentry>
71
72 <varlistentry>
73 <term><option>-l</option></term>
74 <term><option>--full</option></term>
75
76 <listitem><para>Do not ellipsize process tree members.</para>
77 </listitem>
78 </varlistentry>
79
80 <varlistentry>
81 <term><option>-u</option></term>
82 <term><option>--unit</option></term>
83
84 <listitem><para>Show cgroup subtrees for the specified units.</para>
85 </listitem>
86 </varlistentry>
87
88 <varlistentry>
89 <term><option>--user-unit</option></term>
90
91 <listitem><para>Show cgroup subtrees for the specified user units.</para>
92 </listitem>
93 </varlistentry>
94
95 <varlistentry>
96 <term><option>-k</option></term>
97
98 <listitem><para>Include kernel threads in output.
99 </para></listitem>
100 </varlistentry>
101
102 <varlistentry>
103 <term><option>-M <replaceable>MACHINE</replaceable></option></term>
104 <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
105
106 <listitem><para>Limit control groups shown to the part
107 corresponding to the container
108 <replaceable>MACHINE</replaceable>.</para></listitem>
109 </varlistentry>
110
111 <xi:include href="standard-options.xml" xpointer="help" />
112 <xi:include href="standard-options.xml" xpointer="version" />
113 <xi:include href="standard-options.xml" xpointer="no-pager" />
114 </variablelist>
115
116 </refsect1>
117
118 <refsect1>
119 <title>Exit status</title>
120
121 <para>On success, 0 is returned, a non-zero failure code
122 otherwise.</para>
123 </refsect1>
124
125 <refsect1>
126 <title>See Also</title>
127 <para>
128 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
129 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
130 <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
131 <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
132 <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
133 </para>
134 </refsect1>
135
136 </refentry>