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