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