X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd-cgtop.xml;h=8ee552a012a205f7160b256418aa5ac23350ddd0;hp=2d67ae5ef4a7ed03a625c29eaeabd483ef5ca423;hb=9700d6980f7c212b10a69399e6430b82a6f45587;hpb=caa94887002de8596c69f578dbdb684dfb368240 diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index 2d67ae5ef..8ee552a01 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -8,20 +8,21 @@ Copyright 2012 Lennart Poettering systemd is free software; you can redistribute it and/or modify it - under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + 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 - General Public License for more details. + Lesser General Public License for more details. - You should have received a copy of the GNU General Public License + You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> - + systemd-cgtop @@ -49,7 +50,8 @@ - systemd-cgtop OPTIONS + systemd-cgtop + OPTIONS @@ -58,40 +60,37 @@ systemd-cgtop 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 - top1. + top1. + If systemd-cgtop is not connected + to a tty, only one iteration is performed and no + columns headers are printed. This mode is suitable for + scripting. Resource usage is only accounted for control groups in the relevant hierarchy, i.e. CPU usage is only accounted for control groups in the cpuacct hierarchy, memory usage only for those in memory and disk - I/O usage for those in - blkio. systemd1 - by default places all services in their own control - group in the cpuacct hierarchy, but - not in memory nor - blkio. If resource monitoring for - these resources is required it is recommended to add - blkio and memory - to the DefaultControllers= setting - in /etc/systemd/system.conf (see - systemd.conf5 - for details). Alternatively, it is possible to enable - resource accounting individually for services, by - making use of the ControlGroup= - option in the unit files (See - systemd.exec5 - for details). + I/O usage for those in blkio. If + resource monitoring for these resources is required, + it is recommended to add the + CPUAccounting=1, + MemoryAccounting=1 and + BlockIOAccounting=1 settings in the + unit files in question. See + systemd.resource-control5 + for details. To emphasize this: unless - blkio and memory - are enabled for the services in question with either - of the options suggested above no resource accounting - will be available for system services and the data shown - by systemd-cgtop will be + CPUAccounting=1, + MemoryAccounting=1 and + BlockIOAccounting=1 are enabled for + the services in question, no resource accounting will + be available for system services and the data shown by + systemd-cgtop will be incomplete. @@ -101,14 +100,6 @@ The following options are understood: - - - - - Prints a short help - text and exits. - - @@ -142,6 +133,29 @@ Order by disk I/O load. + + + + + Run in "batch" mode: + do not accept input and run until the + iteration limit set with + is + exhausted or until killed. This mode + could be useful for sending output + from systemd-cgtop + to other programs or to a + file. + + + + + + + Perform only this many + iterations. + + @@ -162,13 +176,15 @@ tree traversal depth. Specifies how deep systemd-cgtop shall traverse the control group - hierarchies. If 0 is specified only - the root group is monitored, for 1 + hierarchies. If 0 is specified, only + the root group is monitored. For 1, only the first level of control groups is monitored, and so on. Defaults to - 2. + 3. + + @@ -208,19 +224,26 @@ m i - Change ordering of control groups + Sort the control groups by path, number of tasks, CPU load, - memory usage resp. IO - load. + memory usage, or IO + load, respectively. + + + + % + + Toggle between showing CPU time as + time or percentage. + - - Increase, - resp. decrease refresh - delay. + Increase + or decrease refresh + delay, respectively. @@ -229,7 +252,7 @@ Exit status - On success 0 is returned, a non-zero failure + On success, 0 is returned, a non-zero failure code otherwise. @@ -239,7 +262,8 @@ systemd1, systemctl1, systemd-cgls1, - top1 + systemd.resource-control5, + top1