chiark / gitweb /
man: fix references to .pc files which aren't separate anymore
[elogind.git] / man / systemd-networkd.service.xml
index e5499d66d7a3b89c097e1e96c3f63f640fc08d61..04fedc56d05aa3c4e56cced46135e187894296ae 100644 (file)
                 network devices as they appear, as well as creating virtual
                 network devices.</para>
 
+                <para>To configure low-level link settings independently of
+                networks, see
+                <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                .</para>
+
                 <para>Network configurations applied before networkd is started
-                are not removed, and configuration applied by networkd are not
-                removed when networkd exits. This ensures restarting networkd
-                does not cut the network connection, and, in particular, that
-                it is safe to transition between the initrd and the real root,
+                are not removed, and static configuration applied by networkd
+                are not removed when networkd exits. This ensures restarting
+                networkd does not cut the network connection, and, in particular,
+                that it is safe to transition between the initrd and the real root,
                 and back.</para>
         </refsect1>
 
                                 <varlistentry>
                                         <term><varname>Kind</varname></term>
                                         <listitem>
-                                                <para>The netdev kind. Currently, 'bridge', 'bond' and 'vlan'
+                                                <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 'vlan',
-                        and accepts the following keys:</para>
+                        <para>The <literal>[VLAN]</literal> section only applies for netdevs of kind <literal>vlan</literal>,
+                        and accepts the following key:</para>
 
                         <variablelist class='network-directives'>
                                 <varlistentry>
                                         <term><varname>Id</varname></term>
                                         <listitem>
-                                                <para>The VLAN ID to use. This option is compulsory.</para>
+                                                <para>The VLAN ID to use. An integer in the range 0–4094.
+                                                This option is compulsory.</para>
                                         </listitem>
                                 </varlistentry>
                         </variablelist>
                                         <term><varname>Driver</varname></term>
                                         <listitem>
                                                 <para>The driver currently bound to the device, as
-                                                exposed by the udev property <literal>DRIVER</literal>.
+                                                exposed by the udev property <literal>DRIVER</literal>
+                                                of its parent device.
                                                 </para>
                                         </listitem>
                                 </varlistentry>
                                 <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>
                                 <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 configured link to.</para>
+                                                <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>
                                                 <para>As in the <literal>[Network]</literal> section. This key is mandatory.</para>
                                         </listitem>
                                 </varlistentry>
+                                <varlistentry>
+                                        <term><varname>Broadcast</varname></term>
+                                        <listitem>
+                                                <para>The broadcast address, which must be in the format described in
+                                                <citerefentry><refentrytitle>inet_pton</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                                                . This key only applies to IPv4 addresses. If it is not given, it is
+                                                derived from the <literal>Address</literal> key.</para>
+                                        </listitem>
+                                </varlistentry>
                                 <varlistentry>
                                         <term><varname>Label</varname></term>
                                         <listitem>
                                 <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
+                                                <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>