doc: utilize the DocBook markup for some literals

[elogind.git] / man / systemd-networkd.service.xml

diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml
index 9f628d3b4ac21ceef497dd4b2f52d7f80f21410e..527742cea3db0a93f1e5e910fb177c677c7f942c 100644 (file)
--- a/man/systemd-networkd.service.xml
+++ b/man/systemd-networkd.service.xml
@@ -87,11 +87,11 @@
                 disables the configuration file entirely.</para>
 
                 <refsect2><title>Virtual Network Devices</title>
-                        <para>Netdev files must have the extension <filename>.netdev</filename>;
-                        other extensions are ignored. Virtual network devices are created as soon
-                        as networkd is started.</para>
+                        <para>Virtual Network Device files must have the extension
+                        <filename>.netdev</filename>; other extensions are ignored. Virtual
+                        network devices are created as soon as networkd is started.</para>
 
-                        <para>The <literal>[Bridge]</literal> section accepts the following
+                        <para>The <literal>[NetDev]</literal> section accepts the following
                         keys:</para>
 
                         <variablelist class='network-directives'>
@@ -102,7 +102,28 @@
                                                 bridge. This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Kind</varname></term>
+                                        <listitem>
+                                                <para>The netdev kind. Currently, <literal>bridge</literal>, <literal>bond</literal> and <literal>vlan</literal>
+                                                are supported. This option is compulsory.</para>
+                                        </listitem>
+                                </varlistentry>
                         </variablelist>
+
+                        <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind <literal>vlan</literal>,
+                        and accepts the following keys:</para>
+
+                        <variablelist class='network-directives'>
+                                <varlistentry>
+                                        <term><varname>Id</varname></term>
+                                        <listitem>
+                                                <para>The VLAN ID to use. An integer in the range 0–4094.
+                                                This option is compulsory.</para>
+                                        </listitem>
+                                </varlistentry>
+                        </variablelist>
+
                 </refsect2>
 
                 <refsect2><title>Networks</title>
@@ -171,14 +192,14 @@
                                 <varlistentry>
                                         <term><varname>DHCP</varname></term>
                                         <listitem>
-                                                <para>A boolean. When true enables basic DHCPv4 support.</para>
+                                                <para>A boolean. When true, enables basic DHCPv4 support.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>Address</varname></term>
                                         <listitem>
                                                 <para>A static IPv4 or IPv6 address and its prefix length,
-                                                separated by a '/' character. The format of the address must
+                                                separated by a <literal>/</literal> character. The format of the address must
                                                 be as described in
                                                 <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                                                 . This is a short-hand for an [Address] section only containing an Address key (see below).</para>
@@ -203,7 +224,20 @@
                                 <varlistentry>
                                         <term><varname>Bridge</varname></term>
                                         <listitem>
-                                                <para>The name of the bridge to add the configured link to.</para>
+                                                <para>The name of the bridge to add the link to.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Bond</varname></term>
+                                        <listitem>
+                                                <para>The name of the bond to add the link to.</para>
+                                        </listitem>
+                                </varlistentry>
+                                <varlistentry>
+                                        <term><varname>VLAN</varname></term>
+                                        <listitem>
+                                                <para>The name of a VLAN to create on the link. This option
+                                                may be specified more than once.</para>
                                         </listitem>
                                 </varlistentry>
                         </variablelist>
@@ -249,24 +283,32 @@
                                 <varlistentry>
                                         <term><varname>UseDNS</varname></term>
                                         <listitem>
-                                                <para>When true (the default) the DNS servers received from the DHCP server will
-                                                be used, and take precedence over any statically configured ones.</para>
+                                                <para>When true (the default), the DNS servers received from the DHCP server will
+                                                be used and take precedence over any statically configured ones.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>UseMTU</varname></term>
                                         <listitem>
-                                                <para>When true the interface maximum transmission unit from the DHCP server will
+                                                <para>When true, the interface maximum transmission unit from the DHCP server will
                                                 be used on the current link. Defaults to false.</para>
                                         </listitem>
                                 </varlistentry>
                                 <varlistentry>
                                         <term><varname>UseHostname</varname></term>
                                         <listitem>
-                                                <para>When true (the default) the hostname received from the DHCP server
+                                                <para>When true (the default), the hostname received from the DHCP server
                                                 will be used as the transient hostname.</para>
                                         </listitem>
                                 </varlistentry>
+                                <varlistentry>
+                                        <term><varname>CriticalConnection</varname></term>
+                                        <listitem>
+                                                <para>When true, the connection will never be torn down even if the DHCP lease
+                                                expires. This is contrary to the DHCP specification, but may be the best choice
+                                                if, say, the root filesystem relies on this connection. Defaults to false.</para>
+                                        </listitem>
+                                </varlistentry>
                        </variablelist>
 
                 </refsect2>