diff options
Diffstat (limited to 'man/systemd-cgtop.xml')
| -rw-r--r-- | man/systemd-cgtop.xml | 164 |
1 files changed, 134 insertions, 30 deletions
diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index d4b041a1f9..1c90c0a659 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -1,4 +1,4 @@ -<?xml version='1.0'?> <!--*-nxml-*--> +<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> @@ -64,10 +64,10 @@ regular intervals (by default every 1s), similar in style to <citerefentry project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> - <para>If <command>systemd-cgtop</command> is not connected to a tty, no - column headers are printed and the default is to only run one iteration. - The <varname>--iterations</varname> argument, if given, is still honored. - This mode is suitable for scripting.</para> + <para>If <command>systemd-cgtop</command> is not connected to a + tty, no column headers are printed and the default is to only run + one iteration. The <varname>--iterations=</varname> argument, if + given, is honored. 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 only accounted for control @@ -104,6 +104,7 @@ <variablelist> <varlistentry> <term><option>-p</option></term> + <term><option>--order=path</option></term> <listitem><para>Order by control group path name.</para></listitem> @@ -111,25 +112,28 @@ <varlistentry> <term><option>-t</option></term> + <term><option>--order=tasks</option></term> - <listitem><para>Order by number of tasks in control group - (i.e. threads and processes).</para></listitem> + <listitem><para>Order by number of tasks/processes in the control group.</para></listitem> </varlistentry> <varlistentry> <term><option>-c</option></term> + <term><option>--order=cpu</option></term> <listitem><para>Order by CPU load.</para></listitem> </varlistentry> <varlistentry> <term><option>-m</option></term> + <term><option>--order=memory</option></term> <listitem><para>Order by memory usage.</para></listitem> </varlistentry> <varlistentry> <term><option>-i</option></term> + <term><option>--order=io</option></term> <listitem><para>Order by disk I/O load.</para></listitem> </varlistentry> @@ -140,7 +144,7 @@ <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. + <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> @@ -156,11 +160,67 @@ </varlistentry> <varlistentry> + <term><option>--cpu=percentage</option></term> + <term><option>--cpu=time</option></term> + + <listitem><para>Controls whether the CPU usage is shown as + percentage or time. By default the CPU usage is shown as + percentage. This setting may also be toggled at runtime by + pressing the <keycap>%</keycap> key.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-P</option></term> + + <listitem><para>Count only userspace processes instead of all + tasks. By default all tasks are counted: each kernel thread + and each userspace thread individually. With this setting + kernel threads are excluded from the counting and each + userspace process only counts as one, regardless how many + threads it consists of. This setting may also be toggled at + runtime by pressing the <keycap>P</keycap> key. This option + may not be combined with + <option>-k</option>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>-k</option></term> + + <listitem><para>Count only userspace processes and kernel + threads instead of all tasks. By default all tasks are + counted: each kernel thread and each userspace thread + individually. With this setting kernel threads are included in + the counting and each userspace process only counts as on one, + regardless how many threads it consists of. This setting may + also be toggled at runtime by pressing the <keycap>k</keycap> + key. This option may not be combined with + <option>-P</option>.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>--recursive=</option></term> + + <listitem><para>Controls whether the number of processes shown + for a control group shall include all processes that are + contained in any of the child control groups as well. Takes a + boolean argument, defaults to <literal>yes</literal>. If + enabled the processes in child control groups are included, if + disabled only the processes in the control group itself are + counted. This setting may also be toggled at runtime by + pressing the <keycap>r</keycap> key. Note that this setting + only applies to process counting, i.e. when the + <option>-P</option> or <option>-k</option> options are + used. It has not effect if all tasks are counted, in which + case the counting is always recursive.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>-n</option></term> <term><option>--iterations=</option></term> - <listitem><para>Perform only this many iterations. A value of 0 - indicates that the program should run indefinitely.</para></listitem> + <listitem><para>Perform only this many iterations. A value of + 0 indicates that the program should run + indefinitely.</para></listitem> </varlistentry> <varlistentry> @@ -168,10 +228,11 @@ <term><option>--delay=</option></term> <listitem><para>Specify refresh delay in seconds (or if one of - <literal>ms</literal>, - <literal>us</literal>, + <literal>ms</literal>, <literal>us</literal>, <literal>min</literal> is specified as unit in this time - unit).</para></listitem> + unit). This setting may also be increased and decreased at + runtime by pressing the <keycap>+</keycap> and + <keycap>-</keycap> keys.</para></listitem> </varlistentry> <varlistentry> @@ -185,13 +246,21 @@ 3.</para></listitem> </varlistentry> + <varlistentry> + <term><option>-M <replaceable>MACHINE</replaceable></option></term> + <term><option>--machine=<replaceable>MACHINE</replaceable></option></term> + + <listitem><para>Limit control groups shown to the part + corresponding to the container + <replaceable>MACHINE</replaceable>.</para></listitem> + </varlistentry> + <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> </variablelist> </refsect1> - <refsect1> <title>Keys</title> @@ -200,49 +269,84 @@ <variablelist> <varlistentry> - <term>h</term> + <term><keycap>h</keycap></term> <listitem><para>Shows a short help text.</para></listitem> </varlistentry> <varlistentry> - <term>SPACE</term> + <term><keycap function="space"/></term> <listitem><para>Immediately refresh output.</para></listitem> </varlistentry> <varlistentry> - <term>q</term> + <term><keycap>q</keycap></term> <listitem><para>Terminate the program.</para></listitem> </varlistentry> - <varlistentry> - <term>p</term> - <term>t</term> - <term>c</term> - <term>m</term> - <term>i</term> + <term><keycap>p</keycap></term> + <term><keycap>t</keycap></term> + <term><keycap>c</keycap></term> + <term><keycap>m</keycap></term> + <term><keycap>i</keycap></term> <listitem><para>Sort the control groups by path, number of - tasks, CPU load, memory usage, or IO load, respectively. - </para></listitem> + tasks, CPU load, memory usage, or IO load, respectively. This + setting may also be controlled using the + <option>--order=</option> command line + switch.</para></listitem> </varlistentry> <varlistentry> - <term>%</term> + <term><keycap>%</keycap></term> <listitem><para>Toggle between showing CPU time as time or - percentage.</para></listitem> + percentage. This setting may also be controlled using the + <option>--cpu=</option> command line switch.</para></listitem> </varlistentry> <varlistentry> - <term>+</term> - <term>-</term> + <term><keycap>+</keycap></term> + <term><keycap>-</keycap></term> <listitem><para>Increase or decrease refresh delay, - respectively.</para></listitem> + respectively. This setting may also be controlled using the + <option>--delay=</option> command line + switch.</para></listitem> + </varlistentry> + + <varlistentry> + <term><keycap>P</keycap></term> + + <listitem><para>Toggle between counting all tasks, or only + userspace processes. This setting may also be controlled using + the <option>-P</option> command line switch (see + above).</para></listitem> + </varlistentry> + + <varlistentry> + <term><keycap>k</keycap></term> + + <listitem><para>Toggle between counting all tasks, or only + userspace processes and kernel threads. This setting may also + be controlled using the <option>-k</option> command line + switch (see above).</para></listitem> + </varlistentry> + + <varlistentry> + <term><keycap>r</keycap></term> + + <listitem><para>Toggle between recursively including or + excluding processes in child control groups in control group + process counts. This setting may also be controlled using the + <option>--recursive=</option> command line switch. This key is + not available of all tasks are counted, it is only available + if processes are counted, as enabled with the + <keycap>P</keycap> or <keycap>k</keycap> + keys.</para></listitem> </varlistentry> </variablelist> |