]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-cgtop.xml
man: standarize on one-line license header
[thirdparty/systemd.git] / man / systemd-cgtop.xml
index c76f6469843fe4da091a5c071621363994252dda..6bd06a1785de27c712c96e3471d83e36c2cf7db7 100644 (file)
@@ -1,25 +1,7 @@
-<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
+<?xml version='1.0'?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-
-<!--
-  This file is part of systemd.
-
-  Copyright 2012 Lennart Poettering
-
-  systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation; either version 2.1 of the License, or
-  (at your option) any later version.
-
-  systemd is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
-
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
--->
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
 
 <refentry id="systemd-cgtop"
     xmlns:xi="http://www.w3.org/2001/XInclude">
@@ -27,15 +9,6 @@
   <refentryinfo>
     <title>systemd-cgtop</title>
     <productname>systemd</productname>
-
-    <authorgroup>
-      <author>
-        <contrib>Developer</contrib>
-        <firstname>Lennart</firstname>
-        <surname>Poettering</surname>
-        <email>lennart@poettering.net</email>
-      </author>
-    </authorgroup>
   </refentryinfo>
 
   <refmeta>
@@ -52,6 +25,7 @@
     <cmdsynopsis>
       <command>systemd-cgtop</command>
       <arg choice="opt" rep="repeat">OPTIONS</arg>
+      <arg choice="opt">GROUP</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
 
@@ -62,7 +36,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 I/O metrics)
-       with raw numeric values rather than human-readable
+        <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>
 
         indefinitely.</para></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>-1</option></term>
+
+        <listitem><para>A shortcut for <option>--iterations=1</option>.</para></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><option>-d</option></term>
         <term><option>--delay=</option></term>
 
         <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" />