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+ -->
   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         </listitem>
  75       </varlistentry>
  76
  77       <varlistentry>
  78         <term><option>-u</option></term>
  79         <term><option>--unit</option></term>
  80
  81         <listitem><para>Show cgroup subtrees for the specified units.</para>
  82         </listitem>
  83       </varlistentry>
  84
  85       <varlistentry>
  86         <term><option>--user-unit</option></term>
  87
  88         <listitem><para>Show cgroup subtrees for the specified user units.</para>
  89         </listitem>
  90       </varlistentry>
  91
  92       <varlistentry>
  93         <term><option>-k</option></term>
  94
  95         <listitem><para>Include kernel threads in output.
  96         </para></listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term><option>-M <replaceable>MACHINE</replaceable></option></term>
 101         <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
 102
 103         <listitem><para>Limit control groups shown to the part
 104         corresponding to the container
 105         <replaceable>MACHINE</replaceable>.</para></listitem>
 106       </varlistentry>
 107
 108       <xi:include href="standard-options.xml" xpointer="help" />
 109       <xi:include href="standard-options.xml" xpointer="version" />
 110       <xi:include href="standard-options.xml" xpointer="no-pager" />
 111     </variablelist>
 112
 113   </refsect1>
 114
 115   <refsect1>
 116     <title>Exit status</title>
 117
 118     <para>On success, 0 is returned, a non-zero failure code
 119     otherwise.</para>
 120   </refsect1>
 121
 122   <refsect1>
 123     <title>See Also</title>
 124     <para>
 125       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 126       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 127       <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 128       <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 129       <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 130     </para>
 131   </refsect1>
 132
 133 </refentry>