]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-cgtop.xml
util-lib: kill duplicate slashes in lookup paths
[thirdparty/systemd.git] / man / systemd-cgtop.xml
index 1c90c0a6595a4231f722e331dac66eebafde5968..d7ad08ec373cfd6b4013f4f2c7954889c83df2aa 100644 (file)
@@ -3,6 +3,8 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
+  SPDX-License-Identifier: LGPL-2.1+
+
   This file is part of systemd.
 
   Copyright 2012 Lennart Poettering
@@ -52,6 +54,7 @@
     <cmdsynopsis>
       <command>systemd-cgtop</command>
       <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt">GROUP</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -62,7 +65,9 @@
     groups of the local Linux control group 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 project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para>
+    <citerefentry project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
+    If a control group path is specified, shows only the services of
+    the specified control group.</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
         <term><option>-r</option></term>
         <term><option>--raw</option></term>
 
-       <listitem><para>Format byte counts (as in memory usage and IO metrics)
+       <listitem><para>Format byte counts (as in memory usage and I/O metrics)
        with raw numeric values rather than human-readable
         numbers.</para></listitem>
       </varlistentry>
         <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 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>
         <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
+        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
         <term><option>-k</option></term>
 
         <listitem><para>Count only userspace processes and kernel
-        threads instead of all tasks. By default all tasks are
+        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
+        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>
         <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
+        boolean argument, which 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
 
         <listitem><para>Limit control groups shown to the part
         corresponding to the container
-        <replaceable>MACHINE</replaceable>.</para></listitem>
+        <replaceable>MACHINE</replaceable>.
+        This option may not be used when a control group path is specified.</para></listitem>
       </varlistentry>
 
       <xi:include href="standard-options.xml" xpointer="help" />
         <term><keycap>i</keycap></term>
 
         <listitem><para>Sort the control groups by path, number of
-        tasks, CPU load, memory usage, or IO load, respectively.  This
+        tasks, CPU load, memory usage, or I/O load, respectively.  This
         setting may also be controlled using the
         <option>--order=</option> command line
         switch.</para></listitem>
         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
+        not available if 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>