From 6d3eefd28e653c42bc4a6e0e58dfd9581b5c6e0a Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Sun, 30 Aug 2015 16:38:52 +0200
Subject: man: document relationship between keys and switches of cgtop

---
 man/systemd-cgtop.xml | 71 ++++++++++++++++++++++++++++++---------------------
 1 file changed, 42 insertions(+), 29 deletions(-)

(limited to 'man/systemd-cgtop.xml')

diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml
index fe17165544..0e0ea3ba7a 100644
--- a/man/systemd-cgtop.xml
+++ b/man/systemd-cgtop.xml
@@ -165,7 +165,8 @@
 
         <listitem><para>Controls whether the CPU usage is shown as
         percentage or time. By default the CPU usage is shown as
-        percentage.</para></listitem>
+        percentage. This setting may also be toggled at runtime by
+        pressing the <keycap>%</keycap> key.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -173,7 +174,8 @@
 
         <listitem><para>Include kernel threads when counting tasks in
         control groups. By default, kernel threads are not included in
-        the count.</para></listitem>
+        the count. This setting may also be toggled at runtime by
+        pressing the <keycap>k</keycap> key.</para></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -184,16 +186,18 @@
         any of the child control groups as well. Takes a boolean
         argument, defaults to <literal>yes</literal>. If enabled the
         tasks in child control groups are included, if disabled only
-        the tasks in the control group itself are
-        counted.</para></listitem>
+        the tasks in the control group itself are counted. This
+        setting may also be toggled at runtime by pressing the
+        <keycap>r</keycap> key.</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>
@@ -201,10 +205,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>
@@ -232,64 +237,72 @@
 
     <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>k</term>
+        <term><keycap>k</keycap></term>
 
         <listitem><para>Toggle between including or excluding kernel
-        threads in control group task counts.</para></listitem>
+        threads in control group task counts. This setting may also be
+        controlled using the <option>-k</option> command line
+        switch.</para></listitem>
       </varlistentry>
 
       <varlistentry>
-        <term>r</term>
+        <term><keycap>r</keycap></term>
 
         <listitem><para>Toggle between recursively including or
         excluding tasks in child control groups in control group task
-        counts.</para></listitem>
+        counts. This setting may also be controlled using the
+        <option>--recursive=</option> command line
+        switch.</para></listitem>
       </varlistentry>
 
     </variablelist>
-- 
cgit v1.2.3-54-g00ecf