man/systemd-cgls.xml

   1 <?xml version='1.0'?> <!--*-nxml-*-->
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   5
   6 <refentry id="systemd-cgls"
   7     xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-cgls</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-cgls</refentrytitle>
  16     <manvolnum>1</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-cgls</refname>
  21     <refpurpose>Recursively show control group contents</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <cmdsynopsis>
  26       <command>systemd-cgls</command>
  27       <arg choice="opt" rep="repeat">OPTIONS</arg>
  28       <arg choice="opt" rep="repeat">CGROUP</arg>
  29     </cmdsynopsis>
  30     <cmdsynopsis>
  31       <command>systemd-cgls</command>
  32       <arg choice="opt" rep="repeat">OPTIONS</arg>
  33       <arg choice="plain"><option>--unit</option>|<option>--user-unit</option></arg>
  34       <arg choice="opt" rep="repeat">UNIT</arg>
  35     </cmdsynopsis>
  36   </refsynopsisdiv>
  37
  38   <refsect1>
  39     <title>Description</title>
  40
  41     <para><command>systemd-cgls</command> recursively shows the
  42     contents of the selected Linux control group hierarchy in a tree.
  43     If arguments are specified, shows all member processes of the
  44     specified control groups plus all their subgroups and their
  45     members. The control groups may either be specified by their full
  46     file paths or are assumed in the systemd control group hierarchy.
  47     If no argument is specified and the current working directory is
  48     beneath the control group mount point
  49     <filename>/sys/fs/cgroup/</filename>, shows the contents of the
  50     control group the working directory refers to. Otherwise, the full
  51     systemd control group hierarchy is shown.</para>
  52
  53     <para>By default, empty control groups are not shown.</para>
  54   </refsect1>
  55
  56   <refsect1>
  57     <title>Options</title>
  58
  59     <para>The following options are understood:</para>
  60
  61     <variablelist>
  62       <varlistentry>
  63         <term><option>--all</option></term>
  64
  65         <listitem><para>Do not hide empty control groups in the
  66         output.</para></listitem>
  67       </varlistentry>
  68
  69       <varlistentry>
  70         <term><option>-l</option></term>
  71         <term><option>--full</option></term>
  72
  73         <listitem><para>Do not ellipsize process tree members.</para>
  74
  75         <xi:include href="version-info.xml" xpointer="v198"/>
  76         </listitem>
  77       </varlistentry>
  78
  79       <varlistentry>
  80         <term><option>-u</option></term>
  81         <term><option>--unit</option></term>
  82
  83         <listitem><para>Show cgroup subtrees for the specified units.</para>
  84
  85         <xi:include href="version-info.xml" xpointer="v233"/>
  86         </listitem>
  87       </varlistentry>
  88
  89       <varlistentry>
  90         <term><option>--user-unit</option></term>
  91
  92         <listitem><para>Show cgroup subtrees for the specified user units.</para>
  93
  94         <xi:include href="version-info.xml" xpointer="v233"/>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>-k</option></term>
 100
 101         <listitem><para>Include kernel threads in output.
 102         </para></listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><option>-M <replaceable>MACHINE</replaceable></option></term>
 107         <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
 108
 109         <listitem><para>Limit control groups shown to the part
 110         corresponding to the container
 111         <replaceable>MACHINE</replaceable>.</para>
 112
 113         <xi:include href="version-info.xml" xpointer="v203"/></listitem>
 114       </varlistentry>
 115
 116       <varlistentry>
 117         <term><option>-x</option></term>
 118         <term><option>--xattr=</option></term>
 119
 120         <listitem><para>Controls whether to include information about extended attributes of the listed
 121         control groups in the output. With the long option, expects a boolean value. Defaults to no.
 122         </para>
 123
 124         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term><option>-c</option></term>
 129         <term><option>--cgroup-id=</option></term>
 130
 131         <listitem><para>Controls whether to include the numeric ID of the listed control groups in the
 132         output. With the long option, expects a boolean value. Defaults to no.</para>
 133
 134         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
 135       </varlistentry>
 136
 137       <xi:include href="standard-options.xml" xpointer="help" />
 138       <xi:include href="standard-options.xml" xpointer="version" />
 139       <xi:include href="standard-options.xml" xpointer="no-pager" />
 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 code
 148     otherwise.</para>
 149   </refsect1>
 150
 151   <refsect1>
 152     <title>See Also</title>
 153     <para>
 154       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 155       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 156       <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 157       <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 158       <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 159     </para>
 160   </refsect1>
 161
 162 </refentry>