summaryrefslogtreecommitdiffstats
path: root/man/systemd-cgls.xml
blob: 3fa0a35770e35ca332b00db603f97ea6fb572b33 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->

<refentry id="systemd-cgls"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <refentryinfo>
    <title>systemd-cgls</title>
    <productname>systemd</productname>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-cgls</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-cgls</refname>
    <refpurpose>Recursively show control group contents</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>systemd-cgls</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="opt" rep="repeat">CGROUP</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>systemd-cgls</command>
      <arg choice="opt" rep="repeat">OPTIONS</arg>
      <arg choice="plain"><option>--unit</option>|<option>--user-unit</option></arg>
      <arg choice="opt" rep="repeat">UNIT</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><command>systemd-cgls</command> recursively shows the
    contents of the selected Linux control group hierarchy in a tree.
    If arguments are specified, shows all member processes of the
    specified control groups plus all their subgroups and their
    members. The control groups may either be specified by their full
    file paths or are assumed in the systemd control group hierarchy.
    If no argument is specified and the current working directory is
    beneath the control group mount point
    <filename>/sys/fs/cgroup/</filename>, shows the contents of the
    control group the working directory refers to. Otherwise, the full
    systemd control group hierarchy is shown.</para>

    <para>By default, empty control groups are not shown.</para>
  </refsect1>

  <refsect1>
    <title>Options</title>

    <para>The following options are understood:</para>

    <variablelist>
      <varlistentry>
        <term><option>--all</option></term>

        <listitem><para>Do not hide empty control groups in the
        output.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-l</option></term>
        <term><option>--full</option></term>

        <listitem><para>Do not ellipsize process tree members.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-u</option></term>
        <term><option>--unit</option></term>

        <listitem><para>Show cgroup subtrees for the specified units.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--user-unit</option></term>

        <listitem><para>Show cgroup subtrees for the specified user units.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-k</option></term>

        <listitem><para>Include kernel threads in output.
        </para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-M <replaceable>MACHINE</replaceable></option></term>
        <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>

        <listitem><para>Limit control groups shown to the part
        corresponding to the container
        <replaceable>MACHINE</replaceable>.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--xattr=</option></term>

        <listitem><para>Controls whether to include information about extended attributes of the listed
        control groups in the output. Expects a boolean value, defaults to yes.</para></listitem>
      </varlistentry>

      <varlistentry>
        <term><option>--cgroup-id=</option></term>

        <listitem><para>Controls whether to include the numeric ID of the listed control groups in the
        output. Expects a boolean value, defaults to yes.</para></listitem>
      </varlistentry>

      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Exit status</title>

    <para>On success, 0 is returned, a non-zero failure code
    otherwise.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>