]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: use include directive for Parent= or friends 15095/head
authorYu Watanabe <watanabe.yu+github@gmail.com>
Thu, 12 Mar 2020 09:33:15 +0000 (18:33 +0900)
committerYu Watanabe <watanabe.yu+github@gmail.com>
Thu, 12 Mar 2020 09:33:15 +0000 (18:33 +0900)
man/systemd.network.xml
man/tc.xml [new file with mode: 0644]

index f1625dfde478d2e7d5b1dcb1edaab0e093d0d946..a174a1fb248246dc96c53b0414839b73cfa0aa69 100644 (file)
         </listitem>
       </varlistentry>
 
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
     </variablelist>
   </refsect1>
 
     simulate internet connections.</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>DelaySec=</varname></term>
     token bucket filter (tbf).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>LatencySec=</varname></term>
     (qdisc) of Proportional Integral controller-Enhanced (PIE).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
     (qdisc) of stochastic fair blue (sfb).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
     (qdisc) of stochastic fairness queueing (sfq).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PerturbPeriodSec=</varname></term>
     Byte limited Packet First In First Out (bfifo).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>LimitSize=</varname></term>
     Packet First In First Out (pfifo).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
     Packet First In First Out Head Drop (pfifo_head_drop).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>As in <literal>[PFIFO]</literal> section.</para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>As in <literal>[PFIFO]</literal> section..</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
      Packet First In First Out Fast (pfifo_fast).</para>
 
      <variablelist class='network-directives'>
-       <varlistentry>
-         <term><varname>Parent=</varname></term>
-         <listitem>
-           <para>As in <literal>[PFIFO]</literal> section.</para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-         <term><varname>Handle=</varname></term>
-         <listitem>
-           <para>As in <literal>[PFIFO]</literal> section..</para>
-         </listitem>
-       </varlistentry>
+       <xi:include href="tc.xml" xpointer="qdisc-parent" />
+       <xi:include href="tc.xml" xpointer="qdisc-handle" />
      </variablelist>
   </refsect1>
 
     Common Applications Kept Enhanced (CAKE).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
-
-       <varlistentry>
         <term><varname>Overhead=</varname></term>
         <listitem>
           <para>Specifies that bytes to be addeded to the size of each packet. Bytes may be negative.
           Takes an integer ranges -64 to 256. Defaults to unset and kernel's default is used.</para>
         </listitem>
-       </varlistentry>
+      </varlistentry>
 
       <varlistentry>
         <term><varname>Bandwidth=</varname></term>
     controlled delay (CoDel).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
     Deficit Round Robin Scheduler (DRR).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
     </variablelist>
   </refsect1>
 
     Deficit Round Robin Scheduler (DRR).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>ClassId=</varname></term>
-        <listitem>
-          <para>Specifies the major and minur number of unique identifier of the class, known as the
-          class ID. Each number is in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="tclass-parent" />
+      <xi:include href="tc.xml" xpointer="tclass-classid" />
 
       <varlistentry>
         <term><varname>Quantum=</varname></term>
     (qdisc) of Generic Random Early Detection (GRED).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>VirtualQueues=</varname></term>
     (qdisc) of fair queuing controlled delay (FQ-CoDel).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
     (qdisc) of fair queue traffic policing (FQ).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
     trivial link equalizer (teql).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>Id=</varname></term>
     hierarchy token bucket (htb).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
-          major and minor number in hexadecimal ranges 1 to ffff separated with a colon
-          (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>DefaultClass=</varname></term>
     hierarchy token bucket (htb).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          or a qdisc id. The qdisc id takes the major and minor number in hexadecimal ranges 1 to ffff
-          separated with a colon (<literal>major:minor</literal>). Defaults to <literal>root</literal>.
-          </para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>ClassId=</varname></term>
-        <listitem>
-          <para>Specifies the major and minur number of unique identifier of the class, known as the
-          class ID. Each number is in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="tclass-parent" />
+      <xi:include href="tc.xml" xpointer="tclass-classid" />
 
       <varlistentry>
         <term><varname>Priority=</varname></term>
     (qdisc) of Heavy Hitter Filter (hhf).</para>
 
     <variablelist class='network-directives'>
-      <varlistentry>
-        <term><varname>Parent=</varname></term>
-        <listitem>
-          <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
-          <literal>clsact</literal> or <literal>ingress</literal>. Defaults to <literal>root</literal>.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><varname>Handle=</varname></term>
-        <listitem>
-          <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
-          Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
-        </listitem>
-      </varlistentry>
+      <xi:include href="tc.xml" xpointer="qdisc-parent" />
+      <xi:include href="tc.xml" xpointer="qdisc-handle" />
 
       <varlistentry>
         <term><varname>PacketLimit=</varname></term>
diff --git a/man/tc.xml b/man/tc.xml
new file mode 100644 (file)
index 0000000..1711915
--- /dev/null
@@ -0,0 +1,46 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
+
+<!--
+  SPDX-License-Identifier: LGPL-2.1+
+-->
+
+<refsect1>
+  <variablelist class='network-directives'>
+    <varlistentry id='qdisc-parent'>
+      <term><varname>Parent=</varname></term>
+      <listitem>
+        <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
+        <literal>clsact</literal>, <literal>ingress</literal> or a class id. The class id takes the
+        major and minor number in hexadecimal ranges 1 to ffff separated with a colon
+        (<literal>major:minor</literal>). Defaults to <literal>root</literal>.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry id='qdisc-handle'>
+      <term><varname>Handle=</varname></term>
+      <listitem>
+        <para>Specifies the major number of unique identifier of the qdisc, known as the handle.
+        Takes a number in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry id='tclass-parent'>
+      <term><varname>Parent=</varname></term>
+      <listitem>
+        <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>root</literal>,
+        or a qdisc id. The qdisc id takes the major and minor number in hexadecimal ranges 1 to ffff
+        separated with a colon (<literal>major:minor</literal>). Defaults to <literal>root</literal>.
+        </para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry id='tclass-classid'>
+      <term><varname>ClassId=</varname></term>
+      <listitem>
+        <para>Specifies the major and minur number of unique identifier of the class, known as the
+        class ID. Each number is in hexadecimal ranges 1 to ffff. Defaults to unset.</para>
+      </listitem>
+    </varlistentry>
+  </variablelist>
+</refsect1>