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   </refsynopsisdiv>
  58
  59   <refsect1>
  60     <title>Description</title>
  61
  62     <para><command>systemd-cgls</command> recursively shows the
  63     contents of the selected Linux control group hierarchy in a tree.
  64     If arguments are specified, shows all member processes of the
  65     specified control groups plus all their subgroups and their
  66     members. The control groups may either be specified by their full
  67     file paths or are assumed in the systemd control group hierarchy.
  68     If no argument is specified and the current working directory is
  69     beneath the control group mount point
  70     <filename>/sys/fs/cgroup</filename>, shows the contents of the
  71     control group the working directory refers to. Otherwise, the full
  72     systemd control group hierarchy is shown.</para>
  73
  74     <para>By default, empty control groups are not 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>--all</option></term>
  85
  86         <listitem><para>Do not hide empty control groups in the
  87         output.</para></listitem>
  88       </varlistentry>
  89
  90       <varlistentry>
  91         <term><option>-l</option></term>
  92         <term><option>--full</option></term>
  93
  94         <listitem><para>Do not ellipsize process tree members.</para>
  95         </listitem>
  96       </varlistentry>
  97
  98       <varlistentry>
  99         <term><option>-k</option></term>
 100
 101         <listitem><para>Include kernel threads in output.
 102         </para></listitem>
 103       </varlistentry>
 104
 105       <varlistentry>
 106         <term><option>-M <replaceable>MACHINE</replaceable></option></term>
 107         <term><option>--machine=<replaceable>MACHINE</replaceable></option></term>
 108
 109         <listitem><para>Limit control groups shown to the part
 110         corresponding to the container
 111         <replaceable>MACHINE</replaceable>.</para></listitem>
 112       </varlistentry>
 113
 114       <xi:include href="standard-options.xml" xpointer="help" />
 115       <xi:include href="standard-options.xml" xpointer="version" />
 116       <xi:include href="standard-options.xml" xpointer="no-pager" />
 117     </variablelist>
 118
 119   </refsect1>
 120
 121   <refsect1>
 122     <title>Exit status</title>
 123
 124     <para>On success, 0 is returned, a non-zero failure code
 125     otherwise.</para>
 126   </refsect1>
 127
 128   <refsect1>
 129     <title>See Also</title>
 130     <para>
 131       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 132       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 133       <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 134       <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
 135       <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 136     </para>
 137   </refsect1>
 138
 139 </refentry>