2012-01-24 23:12:47 +00:00
|
|
|
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
|
|
<!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
|
2012-04-11 22:20:58 +00:00
|
|
|
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
|
2012-01-24 23:12:47 +00:00
|
|
|
(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
|
2012-04-11 22:20:58 +00:00
|
|
|
Lesser General Public License for more details.
|
2012-01-24 23:12:47 +00:00
|
|
|
|
2012-04-11 22:20:58 +00:00
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
2012-01-24 23:12:47 +00:00
|
|
|
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
-->
|
|
|
|
|
2014-02-13 19:33:51 +00:00
|
|
|
<refentry id="systemd-cgtop"
|
|
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
2012-01-24 23:12:47 +00:00
|
|
|
|
|
|
|
<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>
|
|
|
|
<refentrytitle>systemd-cgtop</refentrytitle>
|
|
|
|
<manvolnum>1</manvolnum>
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
<refname>systemd-cgtop</refname>
|
|
|
|
<refpurpose>Show top control groups by their resource usage</refpurpose>
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
<cmdsynopsis>
|
2013-04-02 16:52:16 +00:00
|
|
|
<command>systemd-cgtop</command>
|
|
|
|
<arg choice="opt" rep="repeat">OPTIONS</arg>
|
2012-01-24 23:12:47 +00:00
|
|
|
</cmdsynopsis>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
|
|
|
<para><command>systemd-cgtop</command> shows the top
|
|
|
|
control groups of the local Linux control group
|
2013-04-02 16:52:16 +00:00
|
|
|
hierarchy, ordered by their CPU, memory, or disk I/O load. The
|
2012-01-24 23:12:47 +00:00
|
|
|
display is refreshed in regular intervals (by default
|
|
|
|
every 1s), similar in style to
|
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-07 22:25:54 +00:00
|
|
|
<citerefentry project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
|
2013-04-02 16:52:16 +00:00
|
|
|
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>
|
2012-01-24 23:12:47 +00:00
|
|
|
|
|
|
|
<para>Resource usage is only accounted for control
|
|
|
|
groups in the relevant hierarchy, i.e. CPU usage is
|
|
|
|
only accounted for control groups in the
|
|
|
|
<literal>cpuacct</literal> hierarchy, memory usage
|
|
|
|
only for those in <literal>memory</literal> and disk
|
2013-09-26 20:49:44 +00:00
|
|
|
I/O usage for those in <literal>blkio</literal>. If
|
|
|
|
resource monitoring for these resources is required,
|
|
|
|
it is recommended to add the
|
|
|
|
<varname>CPUAccounting=1</varname>,
|
|
|
|
<varname>MemoryAccounting=1</varname> and
|
|
|
|
<varname>BlockIOAccounting=1</varname> settings in the
|
2013-10-15 06:58:51 +00:00
|
|
|
unit files in question. See
|
2013-09-26 22:05:07 +00:00
|
|
|
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
2013-10-15 06:58:51 +00:00
|
|
|
for details.</para>
|
2012-01-24 23:12:47 +00:00
|
|
|
|
|
|
|
<para>To emphasize this: unless
|
2013-09-26 20:49:44 +00:00
|
|
|
<literal>CPUAccounting=1</literal>,
|
|
|
|
<literal>MemoryAccounting=1</literal> and
|
|
|
|
<literal>BlockIOAccounting=1</literal> are enabled for
|
2013-10-15 06:58:51 +00:00
|
|
|
the services in question, no resource accounting will
|
2013-09-26 20:49:44 +00:00
|
|
|
be available for system services and the data shown by
|
|
|
|
<command>systemd-cgtop</command> will be
|
2012-01-24 23:12:47 +00:00
|
|
|
incomplete.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Options</title>
|
|
|
|
|
|
|
|
<para>The following options are understood:</para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-p</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Order by control group
|
|
|
|
path name.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-t</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Order by number of
|
|
|
|
tasks in control
|
|
|
|
group (i.e. threads and processes).</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-c</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Order by CPU load.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-m</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Order by memory usage.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-i</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Order by disk I/O load.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2012-08-03 15:42:04 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-b</option></term>
|
|
|
|
<term><option>--batch</option></term>
|
|
|
|
|
|
|
|
<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. This mode
|
|
|
|
could be useful for sending output
|
|
|
|
from <command>systemd-cgtop</command>
|
|
|
|
to other programs or to a
|
|
|
|
file.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>-n</option></term>
|
|
|
|
<term><option>--iterations=</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Perform only this many
|
|
|
|
iterations.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2012-01-24 23:12:47 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term><option>-d</option></term>
|
|
|
|
<term><option>--delay=</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Specify refresh delay
|
|
|
|
in seconds (or if one of
|
|
|
|
<literal>ms</literal>,
|
|
|
|
<literal>us</literal>,
|
|
|
|
<literal>min</literal> is specified as
|
|
|
|
unit in this time
|
|
|
|
unit).</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><option>--depth=</option></term>
|
|
|
|
|
|
|
|
<listitem><para>Maximum control group
|
|
|
|
tree traversal depth. Specifies how
|
|
|
|
deep <command>systemd-cgtop</command>
|
|
|
|
shall traverse the control group
|
2013-09-12 19:12:49 +00:00
|
|
|
hierarchies. If 0 is specified, only
|
|
|
|
the root group is monitored. For 1,
|
2012-01-24 23:12:47 +00:00
|
|
|
only the first level of control groups
|
|
|
|
is monitored, and so on. Defaults to
|
2012-05-21 23:48:40 +00:00
|
|
|
3.</para></listitem>
|
2012-01-24 23:12:47 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
2014-02-13 19:33:51 +00:00
|
|
|
<xi:include href="standard-options.xml" xpointer="help" />
|
|
|
|
<xi:include href="standard-options.xml" xpointer="version" />
|
2012-01-24 23:12:47 +00:00
|
|
|
</variablelist>
|
|
|
|
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Keys</title>
|
|
|
|
|
|
|
|
<para><command>systemd-cgtop</command> is an
|
|
|
|
interactive tool and may be controlled via user input
|
|
|
|
using the following keys:</para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term>h</term>
|
|
|
|
|
|
|
|
<listitem><para>Shows a short help text.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>SPACE</term>
|
|
|
|
|
|
|
|
<listitem><para>Immediately refresh output.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term>q</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>
|
|
|
|
|
Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.
Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>
I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.
This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.
The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.
Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-15 18:59:12 +00:00
|
|
|
<listitem><para>Sort the control groups
|
2012-01-24 23:12:47 +00:00
|
|
|
by path, number of tasks, CPU load,
|
Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.
Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>
I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.
This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.
The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.
Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-15 18:59:12 +00:00
|
|
|
memory usage, or IO
|
|
|
|
load, respectively.</para></listitem>
|
2012-01-24 23:12:47 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
2013-04-02 18:55:36 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term>%</term>
|
|
|
|
|
|
|
|
<listitem><para>Toggle between showing CPU time as
|
|
|
|
time or percentage.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2012-01-24 23:12:47 +00:00
|
|
|
<varlistentry>
|
|
|
|
<term>+</term>
|
|
|
|
<term>-</term>
|
|
|
|
|
Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.
Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>
I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.
This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.
The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.
Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-15 18:59:12 +00:00
|
|
|
<listitem><para>Increase
|
|
|
|
or decrease refresh
|
|
|
|
delay, respectively.</para></listitem>
|
2012-01-24 23:12:47 +00:00
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
</variablelist>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Exit status</title>
|
|
|
|
|
2013-12-26 01:47:44 +00:00
|
|
|
<para>On success, 0 is returned, a non-zero failure
|
2012-01-24 23:12:47 +00:00
|
|
|
code otherwise.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
<para>
|
|
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
<citerefentry><refentrytitle>systemd-cgls</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
2013-09-26 22:05:07 +00:00
|
|
|
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-07 22:25:54 +00:00
|
|
|
<citerefentry project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
2012-01-24 23:12:47 +00:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|