X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.cgroup.xml;h=cc0eb15abb901976db4a2641ab3c793489c7128f;hb=6e1452d6f015ebca6801e497d12bc6c7c114386d;hp=504c9685a56bc82c3ffebb95a43d69a43d735cc0;hpb=d868475ad62547f0a034dfaf038aff31b3d05372;p=elogind.git
diff --git a/man/systemd.cgroup.xml b/man/systemd.cgroup.xml
index 504c9685a..cc0eb15ab 100644
--- a/man/systemd.cgroup.xml
+++ b/man/systemd.cgroup.xml
@@ -44,7 +44,7 @@ along with systemd; If not, see .
systemd.cgroup
- Cgroup configuration unit settings
+ Control Group configuration unit settings
@@ -66,6 +66,10 @@ along with systemd; If not, see .
configuration options which configure the control group settings
for spawned processes.
+ Control Groups is a concept for organizing processes in a
+ hierarch tree of named groups for the purpose of resource
+ management.
+
This man page lists the configuration options shared by
those six unit types. See
systemd.unit5
@@ -78,7 +82,7 @@ along with systemd; If not, see .
and
systemd.swap5
for more information on the specific unit configuration files. The
- execution specific configuration options are configured in the
+ execution-specific configuration options are configured in the
[Slice], [Scope], [Service], [Socket], [Mount], or [Swap]
sections, depending on the unit type.
@@ -90,34 +94,19 @@ along with systemd; If not, see .
for cgroup configuration:
-
- CPUAccounting=
-
-
- Turn on the CPU usage accounting for this
- unit.
-
-
- BlockIOAccounting=
-
-
- Turn on the Block IO bandwidth accounting
- for this unit.
-
-
-
-
- MemoryAccounting=
+ CPUAccounting=
- Turn on the process and kernel memory
- accounting for this unit.
+ Turn on CPU usage accounting for this unit. Takes a
+ boolean argument. Note that turning on CPU accounting for
+ one unit might also implicitly turn it on for all units
+ contained in the same slice and for all its parent slices and
+ the units contained therein.
-
CPUShares=weight
@@ -126,13 +115,25 @@ along with systemd; If not, see .
the processes executed. Takes an integer value. This
controls the cpu.shares control group
attribute, which defaults to 1024. For details about this
- control group attribute see sched-design-CFS.txt.
+ control group attribute, see sched-design-CFS.txt.
Implies CPUAccounting=true.
+
+ MemoryAccounting=
+
+
+ Turn on process and kernel memory accounting for this
+ unit. Takes a boolean argument. Note that turning on memory
+ accounting for one unit might also implicitly turn it on for
+ all units contained in the same slice and for all its parent
+ slices and the units contained therein.
+
+
+
MemoryLimit=bytesMemorySoftLimit=bytes
@@ -145,19 +146,31 @@ along with systemd; If not, see .
detects memory contention, memory reclaim will be performed
until the memory usage is within the "soft" limit. Takes a
memory size in bytes. If the value is suffixed with K, M, G
- or T the specified memory size is parsed as Kilobytes,
+ or T, the specified memory size is parsed as Kilobytes,
Megabytes, Gigabytes, or Terabytes (with the base 1024),
respectively. This controls the
memory.limit_in_bytes and
memory.soft_limit_in_bytes control group
- attributes. For details about these control group attributes
+ attributes. For details about these control group attributes,
see memory.txt.
+ url="https://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt.
Implies MemoryAccounting=true.
+
+ BlockIOAccounting=
+
+
+ Turn on Block IO accounting for this unit. Takes a
+ boolean argument. Note that turning on block IO accounting
+ for one unit might also implicitly turn it on for all units
+ contained in the same slice and all for its parent slices and
+ the units contained therein.
+
+
+
BlockIOWeight=weight
@@ -170,9 +183,13 @@ along with systemd; If not, see .
blkio.weight
control group attribute, which
defaults to 1000. For details about
- this control group attribute see
+ this control group attribute, see
blkio-controller.txt.
+ url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt.
+
+ Implies
+ BlockIOAccounting=true.
+
@@ -190,8 +207,11 @@ along with systemd; If not, see .
blkio.weight_device control group
attribute, which defaults to 1000. Use this option multiple
times to set weights for multiple devices. For details about
- this control group attribute see blkio-controller.txt.
+ this control group attribute, see blkio-controller.txt.
+
+ Implies
+ BlockIOAccounting=true.
@@ -206,7 +226,7 @@ along with systemd; If not, see .
specify the device specific bandwidth. The file path may be
a path to a block device node, or as any other file in which
case the backing block device of the file system of the file
- is used. If the bandwidth is suffixed with K, M, G, or T
+ is used. If the bandwidth is suffixed with K, M, G, or T,
the specified bandwidth is parsed as Kilobytes, Megabytes,
Gigabytes, or Terabytes, respectively (Example:
"/dev/disk/by-path/pci-0000:00:1f.2-scsi-0:0:0:0 5M"). This
@@ -214,9 +234,12 @@ along with systemd; If not, see .
blkio.write_bps_device control group
attributes. Use this option multiple times to set bandwidth
limits for multiple devices. For details about these control
- group attributes see
- blkio-controller.txt.
+ group attributes, see
+ blkio-controller.txt.
+
+ Implies
+ BlockIOAccounting=true.
@@ -230,13 +253,13 @@ along with systemd; If not, see .
followed by a combination of r,
w, m to control
reading, writing,
- or creating of the specific device node by the unit
+ or creation of the specific device node by the unit
(mknod), respectively. This controls
the devices.allow and
devices.deny control group
- attributes. For details about these control group attributes
+ attributes. For details about these control group attributes,
see devices.txt.
+ url="https://www.kernel.org/doc/Documentation/cgroups/devices.txt">devices.txt.
@@ -259,7 +282,7 @@ along with systemd; If not, see .
- in addition allows access to standard pseudo
+ in addition, allows access to standard pseudo
devices including
/dev/null,
/dev/zero,
@@ -274,7 +297,7 @@ along with systemd; If not, see .
- in addition allows access to all devices if no
+ in addition, allows access to all devices if no
explicit DeviceAllow= is present.
This is the default.
@@ -283,6 +306,29 @@ along with systemd; If not, see .
+
+
+ Slice=
+
+
+ The name of the slice unit to place the unit
+ in. Defaults to system.slice for all
+ non-instantiated units of all unit types (except for slice
+ units themselves see below). Instance units are by default
+ placed in a subslice of system.slice
+ that is named after the template name.
+
+ This option may be used to arrange systemd units in a
+ hierarchy of slices each of which might have resource
+ settings applied.
+
+ For units of type slice, the only accepted value for
+ this setting is the parent slice. Since the name of a slice
+ unit implies the parent slice, it is hence redundant to ever
+ set this parameter directly for slice units.
+
+
+
@@ -298,11 +344,12 @@ along with systemd; If not, see .
systemd.mount5,
systemd.swap5,
systemd.directives7,
+ systemd.special7,
The documentation for control groups and specific controllers in the Linux kernel:
- cgroups.txt,
- cpuacct.txt,
- memory.txt,
- blkio-controller.txt.
+ cgroups.txt,
+ cpuacct.txt,
+ memory.txt,
+ blkio-controller.txt.