Merge pull request #17195 from keszybz/man-cleanups

Man page cleanups
This commit is contained in:
Lennart Poettering
2020-09-30 14:16:05 +02:00
committed by GitHub
30 changed files with 208 additions and 205 deletions
+35 -34
View File
@@ -1549,11 +1549,16 @@ IPv6Token=prefixstable:2002:da8:1::</programlisting></para>
<varlistentry>
<term><varname>MUDURL=</varname></term>
<listitem>
<para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the
DHCPv4 server. Takes an URL of length up to 255 characters. A superficial verification that
the string is a valid URL will be performed. DHCPv4 clients are intended to have at most one
MUD URL associated with them. See
<ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
<para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to the
DHCPv4 server. Takes a URL of length up to 255 characters. A superficial verification that the
string is a valid URL will be performed. DHCPv4 clients are intended to have at most one MUD URL
associated with them. See <ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.
</para>
<para>MUD is an embedded software standard defined by the IETF that allows IoT device makers to
advertise device specifications, including the intended communication patterns for their device
when it connects to the network. The network can then use this to author a context-specific
access policy, so the device functions only within those parameters.</para>
</listitem>
</varlistentry>
@@ -1848,18 +1853,18 @@ IPv6Token=prefixstable:2002:da8:1::</programlisting></para>
<varlistentry>
<term><varname>MUDURL=</varname></term>
<listitem>
<para>When configured, the Manufacturer Usage Descriptions (MUD) URL will be sent to the DHCPV6 server.
Takes an URL of length up to 255 characters. A superficial verification that the string is a valid URL
will be performed. DHCPv6 clients are intended to have at most one MUD URL associated with them. See
<ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink>.</para>
<para>When configured, the specified Manufacturer Usage Description (MUD) URL will be sent to
the DHCPV6 server. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
[DHCPv4] section described above.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>RequestOptions=</varname></term>
<listitem>
<para>When configured, allows to set arbitrary request options in the DHCPv6 request options list and will
sent to the DHCPV6 server. A whitespace-separated list of integers in the range 1..254. Defaults to unset.</para>
<para>When configured, allows to set arbitrary request options in the DHCPv6 request options list
that will be sent to the DHCPV6 server. A whitespace-separated list of integers in the range
1..254. Defaults to unset.</para>
</listitem>
</varlistentry>
@@ -2050,8 +2055,8 @@ IPv6Token=prefixstable:2002:da8:1::</programlisting></para>
<varlistentry>
<term><varname>UseOnLinkPrefix=</varname></term>
<listitem>
<para>When true (the default), the onlink prefix received in the Router Advertisement will be used and take
precedence over any statically configured ones.</para>
<para>When true (the default), the onlink prefix received in the Router Advertisement will be
used and takes precedence over any statically configured ones.</para>
</listitem>
</varlistentry>
@@ -2563,19 +2568,16 @@ IPv6Token=prefixstable:2002:da8:1::</programlisting></para>
<refsect1>
<title>[LLDP] Section Options</title>
<para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following
keys.</para>
keys:</para>
<variablelist class='network-directives'>
<varlistentry>
<term><varname>MUDURL=</varname></term>
<listitem>
<para>Controls support for Ethernet LLDP packet's Manufacturer Usage Description (MUD). MUD is an embedded software
standard defined by the IETF that allows IoT Device makers to advertise device specifications, including the intended
communication patterns for their device when it connects to the network. The network can then use this intent to author
a context-specific access policy, so the device functions only within those parameters. Takes an URL of length up to 255
characters. A superficial verification that the string is a valid URL
will be performed. See
<ulink url="https://tools.ietf.org/html/rfc8520">RFC 8520</ulink> for details. The MUD URL received
from the LLDP packets will be saved at the state files and can be read via
<para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in
LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the
[DHCPv4] section described above.</para>
<para>The MUD URLs received via LLDP packets are saved and can be read using the
<function>sd_lldp_neighbor_get_mud_url()</function> function.</para>
</listitem>
</varlistentry>
@@ -2893,11 +2895,11 @@ IPv6Token=prefixstable:2002:da8:1::</programlisting></para>
<varlistentry>
<term><varname>LimitBytes=</varname></term>
<listitem>
<para>Specifies the hard limit on the FIFO size in bytes. The size limit (a buffer size) to prevent
it from overflowing in case it is unable to dequeue packets as quickly as it receives them. When
this limit is reached, incoming packets are dropped. When suffixed with K, M, or G, the specified
size is parsed as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults
to unset and kernel's default is used.</para>
<para>Specifies the hard limit in bytes on the FIFO buffer size. The size limit prevents overflow
in case the kernel is unable to dequeue packets as quickly as it receives them. When this limit is
reached, incoming packets are dropped. When suffixed with K, M, or G, the specified size is parsed
as Kilobytes, Megabytes, or Gigabytes, respectively, to the base of 1024. Defaults to unset and
kernel default is used.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -3104,13 +3106,12 @@ IPv6Token=prefixstable:2002:da8:1::</programlisting></para>
<varlistentry>
<term><varname>PriorityMap=</varname></term>
<listitem>
<para>The priority map maps the priority of a packet to a band. The argument is a white-space
separated list of numbers. The first number indicates which band the packets with priority
0 should be put to, the second is for priority 1, and so on. There can be up to 16 numbers in
the list. If there are fewer, the default band that traffic with one of the unmentioned
priorities goes to is the last one. Each band number must be 0..255. This setting can be
specified multiple times. If an empty string is assigned, then the all previous assignments
are cleared.</para>
<para>The priority map maps the priority of a packet to a band. The argument is a whitespace
separated list of numbers. The first number indicates which band the packets with priority 0 should
be put to, the second is for priority 1, and so on. There can be up to 16 numbers in the list. If
there are fewer, the default band that traffic with one of the unmentioned priorities goes to is
the last one. Each band number must be in the range 0..255. This setting can be specified multiple
times. If an empty string is assigned, then the all previous assignments are cleared.</para>
</listitem>
</varlistentry>
</variablelist>