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   This file is part of systemd.
   9
  10   Copyright 2010 Lennart Poettering
  11
  12   systemd is free software; you can redistribute it and/or modify it
  13   under the terms of the GNU Lesser General Public License as published by
  14   the Free Software Foundation; either version 2.1 of the License, or
  15   (at your option) any later version.
  16
  17   systemd is distributed in the hope that it will be useful, but
  18   WITHOUT ANY WARRANTY; without even the implied warranty of
  19   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20   Lesser General Public License for more details.
  21
  22   You should have received a copy of the GNU Lesser General Public License
  23   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  24 -->
  25
  26 <refentry id="systemd-cgls"
  27     xmlns:xi="http://www.w3.org/2001/XInclude">
  28
  29   <refentryinfo>
  30     <title>systemd-cgls</title>
  31     <productname>systemd</productname>
  32
  33     <authorgroup>
  34       <author>
  35         <contrib>Developer</contrib>
  36         <firstname>Lennart</firstname>
  37         <surname>Poettering</surname>
  38         <email>lennart@poettering.net</email>
  39       </author>
  40     </authorgroup>
  41   </refentryinfo>
  42
  43   <refmeta>
  44     <refentrytitle>systemd-cgls</refentrytitle>
  45     <manvolnum>1</manvolnum>
  46   </refmeta>
  47
  48   <refnamediv>
  49     <refname>systemd-cgls</refname>
  50     <refpurpose>Recursively show control group contents</refpurpose>
  51   </refnamediv>
  52
  53   <refsynopsisdiv>
  54     <cmdsynopsis>
  55       <command>systemd-cgls</command>
  56       <arg choice="opt" rep="repeat">OPTIONS</arg>
  57       <arg choice="opt" rep="repeat">CGROUP</arg>
  58     </cmdsynopsis>
  59     <cmdsynopsis>
  60       <command>systemd-cgls</command>
  61       <arg choice="opt" rep="repeat">OPTIONS</arg>
  62       <arg choice="plain"><option>--unit</option>|<option>--user-unit</option></arg>
  63       <arg choice="opt" rep="repeat">UNIT</arg>
  64     </cmdsynopsis>
  65   </refsynopsisdiv>
  66
  67   <refsect1>
  68     <title>Description</title>
  69
  70     <para><command>systemd-cgls</command> recursively shows the
  71     contents of the selected Linux control group hierarchy in a tree.
  72     If arguments are specified, shows all member processes of the
  73     specified control groups plus all their subgroups and their
  74     members. The control groups may either be specified by their full
  75     file paths or are assumed in the systemd control group hierarchy.
  76     If no argument is specified and the current working directory is
  77     beneath the control group mount point
  78     <filename>/sys/fs/cgroup</filename>, shows the contents of the
  79     control group the working directory refers to. Otherwise, the full
  80     systemd control group hierarchy is shown.</para>
  81
  82     <para>By default, empty control groups are not shown.</para>
  83   </refsect1>
  84
  85   <refsect1>
  86     <title>Options</title>
  87
  88     <para>The following options are understood:</para>
  89
  90     <variablelist>
  91       <varlistentry>
  92         <term><option>--all</option></term>
  93
  94         <listitem><para>Do not hide empty control groups in the
  95         output.</para></listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>-l</option></term>
 100         <term><option>--full</option></term>
 101
 102         <listitem><para>Do not ellipsize process tree members.</para>
 103         </listitem>
 104       </varlistentry>
 105
 106       <varlistentry>
 107         <term><option>-u</option></term>
 108         <term><option>--unit</option></term>
 109
 110         <listitem><para>Show cgroup subtrees for the specified units.</para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term><option>--user-unit</option></term>
 116
 117         <listitem><para>Show cgroup subtrees for the specified user units.</para>
 118         </listitem>
 119       </varlistentry>
 120
 121       <varlistentry>
 122         <term><option>-k</option></term>
 123
 124         <listitem><para>Include kernel threads in output.
 125         </para></listitem>
 126       </varlistentry>
 127
 128       <varlistentry>
 129         <term><option>-M <replaceable>MACHINE</replaceable></option></term>
 130         <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
 131
 132         <listitem><para>Limit control groups shown to the part
 133         corresponding to the container
 134         <replaceable>MACHINE</replaceable>.</para></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>