man: document sd_pid_get_slice() call of libsystemd-login

[elogind.git] / man / systemd.cgroup.xml

diff --git a/man/systemd.cgroup.xml b/man/systemd.cgroup.xml
index 504c9685a56bc82c3ffebb95a43d69a43d735cc0..c2a823eba51cd34eb17aa2102b24359cdb68813c 100644 (file)
--- a/man/systemd.cgroup.xml
+++ b/man/systemd.cgroup.xml
@@ -78,7 +78,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     and
     <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     for more information on the specific unit configuration files. The
     and
     <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
     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.</para>
   </refsect1>
     [Slice], [Scope], [Service], [Socket], [Mount], or [Swap]
     sections, depending on the unit type.</para>
   </refsect1>


@@ -90,34 +90,19 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
     for cgroup configuration:</para>
 
     <variablelist class='unit-directives'>
     for cgroup configuration:</para>
 
     <variablelist class='unit-directives'>

-      <varlistentry>
-        <term><varname>CPUAccounting=</varname></term>
-
-        <listitem>
-          <para>Turn on the CPU usage accounting for this
-          unit.</para>
-        </listitem>
-      </varlistentry>

 
       <varlistentry>
 
       <varlistentry>

-        <term><varname>BlockIOAccounting=</varname></term>
-
-        <listitem>
-          <para>Turn on the Block IO bandwidth accounting
-          for this unit.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>MemoryAccounting=</varname></term>
+        <term><varname>CPUAccounting=</varname></term>

 
         <listitem>
 
         <listitem>

-          <para>Turn on the process and kernel memory
-          accounting for this unit.</para>
+          <para>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.</para>

         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 

-

       <varlistentry>
         <term><varname>CPUShares=<replaceable>weight</replaceable></varname></term>
 
       <varlistentry>
         <term><varname>CPUShares=<replaceable>weight</replaceable></varname></term>
 


@@ -126,13 +111,25 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           the processes executed. Takes an integer value. This
           controls the <literal>cpu.shares</literal> control group
           attribute, which defaults to 1024. For details about this
           the processes executed. Takes an integer value. This
           controls the <literal>cpu.shares</literal> control group
           attribute, which defaults to 1024. For details about this

-          control group attribute see <ulink
-          url="http://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
+          control group attribute, see <ulink
+          url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>

 
           <para>Implies <literal>CPUAccounting=true</literal>.</para>
         </listitem>
       </varlistentry>
 
 
           <para>Implies <literal>CPUAccounting=true</literal>.</para>
         </listitem>
       </varlistentry>
 

+      <varlistentry>
+        <term><varname>MemoryAccounting=</varname></term>
+
+        <listitem>
+          <para>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.</para>
+        </listitem>
+      </varlistentry>
+

       <varlistentry>
         <term><varname>MemoryLimit=<replaceable>bytes</replaceable></varname></term>
         <term><varname>MemorySoftLimit=<replaceable>bytes</replaceable></varname></term>
       <varlistentry>
         <term><varname>MemoryLimit=<replaceable>bytes</replaceable></varname></term>
         <term><varname>MemorySoftLimit=<replaceable>bytes</replaceable></varname></term>


@@ -145,19 +142,31 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           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
           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
           <literal>memory.limit_in_bytes</literal> and
           <literal>memory.soft_limit_in_bytes</literal> control group
           Megabytes, Gigabytes, or Terabytes (with the base 1024),
           respectively. This controls the
           <literal>memory.limit_in_bytes</literal> and
           <literal>memory.soft_limit_in_bytes</literal> control group

-          attributes. For details about these control group attributes
+          attributes. For details about these control group attributes,

           see <ulink
           see <ulink

-          url="http://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>.</para>
+          url="https://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>.</para>

 
           <para>Implies <literal>MemoryAccounting=true</literal>.</para>
         </listitem>
       </varlistentry>
 
 
           <para>Implies <literal>MemoryAccounting=true</literal>.</para>
         </listitem>
       </varlistentry>
 

+      <varlistentry>
+        <term><varname>BlockIOAccounting=</varname></term>
+
+        <listitem>
+          <para>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.</para>
+        </listitem>
+      </varlistentry>
+

       <varlistentry>
         <term><varname>BlockIOWeight=<replaceable>weight</replaceable></varname></term>
 
       <varlistentry>
         <term><varname>BlockIOWeight=<replaceable>weight</replaceable></varname></term>
 


@@ -170,9 +179,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <literal>blkio.weight</literal>
         control group attribute, which
         defaults to 1000. For details about
         <literal>blkio.weight</literal>
         control group attribute, which
         defaults to 1000. For details about

-        this control group attribute see
+        this control group attribute, see

         <ulink
         <ulink

-            url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para></listitem>
+            url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
+
+        <para>Implies
+        <literal>BlockIOAccounting=true</literal>.</para>
+        </listitem>

       </varlistentry>
 
       <varlistentry>
       </varlistentry>
 
       <varlistentry>


@@ -190,8 +203,11 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <literal>blkio.weight_device</literal> control group
           attribute, which defaults to 1000. Use this option multiple
           times to set weights for multiple devices. For details about
           <literal>blkio.weight_device</literal> 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 <ulink
-          url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
+          this control group attribute, see <ulink
+          url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.</para>
+
+          <para>Implies
+          <literal>BlockIOAccounting=true</literal>.</para>

         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 


@@ -206,7 +222,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           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
           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
           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 +230,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           <literal>blkio.write_bps_device</literal> control group
           attributes. Use this option multiple times to set bandwidth
           limits for multiple devices. For details about these control
           <literal>blkio.write_bps_device</literal> control group
           attributes. Use this option multiple times to set bandwidth
           limits for multiple devices. For details about these control

-          group attributes see
-          <ulink url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.
+          group attributes, see
+          <ulink url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.

           </para>
           </para>

+
+          <para>Implies
+          <literal>BlockIOAccounting=true</literal>.</para>

         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 


@@ -230,13 +249,13 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           followed by a combination of <constant>r</constant>,
           <constant>w</constant>, <constant>m</constant> to control
           <emphasis>r</emphasis>eading, <emphasis>w</emphasis>riting,
           followed by a combination of <constant>r</constant>,
           <constant>w</constant>, <constant>m</constant> to control
           <emphasis>r</emphasis>eading, <emphasis>w</emphasis>riting,

-          or creating of the specific device node by the unit
+          or creation of the specific device node by the unit

           (<emphasis>m</emphasis>knod), respectively. This controls
           the <literal>devices.allow</literal> and
           <literal>devices.deny</literal> control group
           (<emphasis>m</emphasis>knod), respectively. This controls
           the <literal>devices.allow</literal> and
           <literal>devices.deny</literal> control group

-          attributes. For details about these control group attributes
+          attributes. For details about these control group attributes,

           see <ulink
           see <ulink

-          url="http://www.kernel.org/doc/Documentation/cgroups/devices.txt">devices.txt</ulink>.</para>
+          url="https://www.kernel.org/doc/Documentation/cgroups/devices.txt">devices.txt</ulink>.</para>

         </listitem>
       </varlistentry>
 
         </listitem>
       </varlistentry>
 


@@ -259,7 +278,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
             <varlistentry>
               <term><option>closed</option></term>
               <listitem>
             <varlistentry>
               <term><option>closed</option></term>
               <listitem>

-                <para>in addition allows access to standard pseudo
+                <para>in addition, allows access to standard pseudo

                 devices including
                 <filename>/dev/null</filename>,
                 <filename>/dev/zero</filename>,
                 devices including
                 <filename>/dev/null</filename>,
                 <filename>/dev/zero</filename>,


@@ -274,7 +293,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
               <term><option>auto</option></term>
               <listitem>
                 <para>
               <term><option>auto</option></term>
               <listitem>
                 <para>

-                  in addition allows access to all devices if no
+                  in addition, allows access to all devices if no

                   explicit <varname>DeviceAllow=</varname> is present.
                   This is the default.
                 </para>
                   explicit <varname>DeviceAllow=</varname> is present.
                   This is the default.
                 </para>


@@ -283,6 +302,29 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
           </variablelist>
         </listitem>
       </varlistentry>
           </variablelist>
         </listitem>
       </varlistentry>

+
+      <varlistentry>
+        <term><varname>Slice=</varname></term>
+
+        <listitem>
+          <para>The name of the slice unit to place the unit
+          in. Defaults to <filename>system.slice</filename> 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 <filename>system.slice</filename>
+          that is named after the template name.</para>
+
+          <para>This option may be used to arrange systemd units in a
+          hierarchy of slices each of which might have resource
+          settings applied.</para>
+
+          <para>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.</para>
+        </listitem>
+      </varlistentry>
+

     </variablelist>
   </refsect1>
 
     </variablelist>
   </refsect1>
 


@@ -298,11 +340,12 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

+      <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>,

       The documentation for control groups and specific controllers in the Linux kernel:
       The documentation for control groups and specific controllers in the Linux kernel:

-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>,
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/cpuacct.txt">cpuacct.txt</ulink>,
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>,
-      <ulink url="http://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/cgroups.txt">cgroups.txt</ulink>,
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/cpuacct.txt">cpuacct.txt</ulink>,
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/memory.txt">memory.txt</ulink>,
+      <ulink url="https://www.kernel.org/doc/Documentation/cgroups/blkio-controller.txt">blkio-controller.txt</ulink>.

     </para>
   </refsect1>
 </refentry>
     </para>
   </refsect1>
 </refentry>