cgtop: optionally show CPU usage as time and become stdout sensitive

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

diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml
index ad1f0f8c4d7efd4b095ef2a3f61d303acced5719..c5bb489869fe6cbc3fb7c4a6f9fb2dedc5679d46 100644 (file)
--- a/man/systemd-cgtop.xml
+++ b/man/systemd-cgtop.xml
@@ -49,7 +49,8 @@
 
         <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>
 
@@ -58,10 +59,14 @@
 
                 <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
-                <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