cgroup: get rid of MemorySoftLimit=

[elogind.git] / man / systemd-cgtop.xml

diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml
index 9322fb0920cbddb7777480256c314d2a561f5a38..0e9e5e611aa898fe9a8ebc2959675862a40fde4d 100644 (file)
--- a/man/systemd-cgtop.xml
+++ b/man/systemd-cgtop.xml
@@ -49,7 +49,8 @@
 
         <refsynopsisdiv>
                 <cmdsynopsis>
 
         <refsynopsisdiv>
                 <cmdsynopsis>

-                        <command>systemd-cgtop <arg choice="opt" rep="repeat">OPTIONS</arg></command>
+                        <command>systemd-cgtop</command>
+                        <arg choice="opt" rep="repeat">OPTIONS</arg>

                 </cmdsynopsis>
         </refsynopsisdiv>
 
                 </cmdsynopsis>
         </refsynopsisdiv>
 


@@ -58,10 +59,14 @@
 
                 <para><command>systemd-cgtop</command> shows the top
                 control groups of the local Linux control group
 
                 <para><command>systemd-cgtop</command> shows the top
                 control groups of the local Linux control group

-                hierarchy, ordered by their CPU, memory and disk I/O load. The
+                hierarchy, ordered by their CPU, memory, or disk I/O load. The

                 display is refreshed in regular intervals (by default
                 every 1s), similar in style to
                 display is refreshed in regular intervals (by default
                 every 1s), similar in style to

-                <citerefentry><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
+                <citerefentry><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+                If <command>systemd-cgtop</command> is not connected
+                to a tty, only one iteration is performed and no
+                columns headers are printed. This mode is suitable for
+                scripting.</para>

 
                 <para>Resource usage is only accounted for control
                 groups in the relevant hierarchy, i.e. CPU usage is
 
                 <para>Resource usage is only accounted for control
                 groups in the relevant hierarchy, i.e. CPU usage is


@@ -74,11 +79,11 @@
                 group in the <literal>cpuacct</literal> hierarchy, but
                 not in <literal>memory</literal> nor
                 <literal>blkio</literal>. If resource monitoring for
                 group in the <literal>cpuacct</literal> hierarchy, but
                 not in <literal>memory</literal> nor
                 <literal>blkio</literal>. If resource monitoring for

-                these resources is required it is recommended to add
+                these resources is required, it is recommended to add

                 <literal>blkio</literal> and <literal>memory</literal>
                 to the <varname>DefaultControllers=</varname> setting
                 in <filename>/etc/systemd/system.conf</filename> (see
                 <literal>blkio</literal> and <literal>memory</literal>
                 to the <varname>DefaultControllers=</varname> setting
                 in <filename>/etc/systemd/system.conf</filename> (see

-                <citerefentry><refentrytitle>systemd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>

                 for details). Alternatively, it is possible to enable
                 resource accounting individually for services, by
                 making use of the <varname>ControlGroup=</varname>
                 for details). Alternatively, it is possible to enable
                 resource accounting individually for services, by
                 making use of the <varname>ControlGroup=</varname>


@@ -109,6 +114,13 @@
                                 text and exits.</para></listitem>
                         </varlistentry>
 
                                 text and exits.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>--version</option></term>
+
+                                <listitem><para>Prints a version string and
+                                exits.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>-p</option></term>
 
                         <varlistentry>
                                 <term><option>-p</option></term>
 


@@ -142,6 +154,29 @@
                                 <listitem><para>Order by disk I/O load.</para></listitem>
                         </varlistentry>
 
                                 <listitem><para>Order by disk I/O load.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><option>-b</option></term>
+                                <term><option>--batch</option></term>
+
+                                <listitem><para>Run in "batch" mode:
+                                do not accept input and run until the
+                                iteration limit set with
+                                <option>--iterations</option> is
+                                exhausted or until killed. This mode
+                                could be useful for sending output
+                                from <command>systemd-cgtop</command>
+                                to other programs or to a
+                                file.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><option>-n</option></term>
+                                <term><option>--iterations=</option></term>
+
+                                <listitem><para>Perform only this many
+                                iterations.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><option>-d</option></term>
                                 <term><option>--delay=</option></term>
                         <varlistentry>
                                 <term><option>-d</option></term>
                                 <term><option>--delay=</option></term>


@@ -162,11 +197,11 @@
                                 tree traversal depth. Specifies how
                                 deep <command>systemd-cgtop</command>
                                 shall traverse the control group
                                 tree traversal depth. Specifies how
                                 deep <command>systemd-cgtop</command>
                                 shall traverse the control group

-                                hierarchies. If 0 is specified only
-                                the root group is monitored, for 1
+                                hierarchies. If 0 is specified, only
+                                the root group is monitored. For 1,

                                 only the first level of control groups
                                 is monitored, and so on. Defaults to
                                 only the first level of control groups
                                 is monitored, and so on. Defaults to

-                                2.</para></listitem>
+                                3.</para></listitem>

                         </varlistentry>
 
                 </variablelist>
                         </varlistentry>
 
                 </variablelist>


@@ -208,19 +243,26 @@
                                 <term>m</term>
                                 <term>i</term>
 
                                 <term>m</term>
                                 <term>i</term>
 

-                                <listitem><para>Change ordering of control groups
+                                <listitem><para>Sort the control groups

                                 by path, number of tasks, CPU load,
                                 by path, number of tasks, CPU load,

-                                memory usage resp. IO
-                                load.</para></listitem>
+                                memory usage, or IO
+                                load, respectively.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term>%</term>
+
+                                <listitem><para>Toggle between showing CPU time as
+                                time or percentage.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                                 <term>+</term>
                                 <term>-</term>
 
                         </varlistentry>
 
                         <varlistentry>
                                 <term>+</term>
                                 <term>-</term>
 

-                                <listitem><para>Increase,
-                                resp. decrease refresh
-                                delay.</para></listitem>
+                                <listitem><para>Increase
+                                or decrease refresh
+                                delay, respectively.</para></listitem>

                         </varlistentry>
 
                 </variablelist>
                         </varlistentry>
 
                 </variablelist>