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