networkd: tuntap - default to no packet information

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

diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml
index 48c6e726d3d1ee93b3d6a7dd56d9169473c0ba2e..c90bd8f98c13520e57d20753bf799d56e375fd90 100644 (file)
--- a/man/systemd.netdev.xml
+++ b/man/systemd.netdev.xml
@@ -163,8 +163,8 @@
                                                 <literal>macvlan</literal>, <literal>vxlan</literal>,
                                                 <literal>ipip</literal>, <literal>gre</literal>,
                                                 <literal>sit</literal>, <literal>vti</literal>,
-                                                <literal>veth</literal> are supported. This option
-                                                is compulsory.</para>
+                                                <literal>veth</literal>, and <literal>dummy</literal>
+                                                are supported. This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
@@ -339,6 +339,61 @@
                                 </varlistentry>
                         </variablelist>
         </refsect1>
+        <refsect1>
+                <title>[Tun] Section Options</title>
+
+                        <para>The <literal>[Tun]</literal> section only applies for netdevs of kind
+                        <literal>tun</literal>, and accepts the following keys:</para>
+
+                        <variablelist class='network-directives'>
+                                <varlistentry>
+                                        <term><varname>OneQueue=</varname></term>
+                                        <listitem><para>Takes a boolean argument. Configures whether
+                                        all packets are queued at the device (enabled), or a fixed number
+                                        of packets are queued at the device and the rest at the
+                                        <literal>qdisc</literal>. Defaults to <literal>no</literal>.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>MultiQueue=</varname></term>
+                                        <listitem><para>Takes a boolean argument. Configures whether to
+                                        use multiple file descriptors (queues) to parallelize packets
+                                        sending and receiving. Defaults to <literal>no</literal>.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>PacketInfo=</varname></term>
+                                        <listitem><para>Takes a boolean argument. Configures whether packets
+                                        should be prepened with four extra bytes (two flag bytes and two
+                                        protocol bytes). If disabled it indicates that the packets will be
+                                        pure IP packets. Defaults to <literal>no</literal>.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>User=</varname></term>
+                                        <listitem><para>User to grant access to the <filename>/dev/net/tun</filename>
+                                        device.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Group=</varname></term>
+                                        <listitem><para>Group to grant access to the <filename>/dev/net/tun</filename>
+                                        device.</para>
+                                        </listitem>
+                                </varlistentry>
+
+                        </variablelist>
+
+        </refsect1>
+
+        <refsect1>
+                <title>[Tap] Section Options</title>
+
+                        <para>The <literal>[Tap]</literal> section only applies for netdevs of kind
+                        <literal>tap</literal>, and accepts the same keys as the
+                        <literal>[Tun]</literal> section.</para>
+        </refsect1>
+
         <refsect1>
                 <title>Example</title>
                 <example>
@@ -374,6 +429,15 @@ Local=192.168.223.238
 Remote=192.169.224.239
 TTL=64</programlisting>
                 </example>
+                <example>
+                  <title>/etc/systemd/network/tap.netdev</title>
+                  <programlisting>[NetDev]
+Name=tap-test
+Kind=tap
+
+[Tap]
+MultiQueue=true
+PacketInfo=true</programlisting> </example>
 
                 <example>
                         <title>/etc/systemd/network/sit.netdev</title>
@@ -422,6 +486,14 @@ Kind=veth
 Name=veth-peer</programlisting>
                 </example>
 
+                <example>
+                        <title>/etc/systemd/network/dummy.netdev</title>
+                        <programlisting>[NetDev]
+Name=dummy-test
+Kind=dummy
+MACAddress=12:34:56:78:9a:bc</programlisting>
+                </example>
+
         </refsect1>
         <refsect1>
                 <title>See Also</title>