system/systemd
system/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd synced 2024-07-22 18:55:10 +00:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

man: improve the explanation of "Defaults to unset"

Browse source
This commit is contained in:
Yu Watanabe 2018-11-27 14:40:25 +09:00
parent 79411bbcce
commit 025314d97d
3 changed files with 38 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
man/systemd.link.xml
View file

@ -367,8 +367,7 @@
<para>Enables or disables automatic negotiation of transmission parameters.
Autonegotiation is a procedure by which two connected ethernet devices choose
common transmission parameters, such as speed, duplex mode, and flow control.
Takes a boolean value. Unset by default, which means that the kernel default
will be used.</para>
Takes a boolean value. When unset, the kernel's default will be used.</para>
<para>Note that if autonegotiation is enabled, speed, duplex and advertise settings are
read-only. If autonegotation is disabled, speed, duplex and advertise settings are writable
@ -554,7 +553,7 @@
<listitem>
<para>The TCP Segmentation Offload (TSO) when true enables
TCP segmentation offload. Takes a boolean value.
Defaults to "unset".</para>
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -562,7 +561,7 @@
<listitem>
<para>The TCP6 Segmentation Offload (tx-tcp6-segmentation) when true enables
TCP6 segmentation offload. Takes a boolean value.
Defaults to "unset".</para>
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -570,7 +569,7 @@
<listitem>
<para>The Generic Segmentation Offload (GSO) when true enables
generic segmentation offload. Takes a boolean value.
Defaults to "unset".</para>
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -578,7 +577,7 @@
<listitem>
<para>The Generic Receive Offload (GRO) when true enables
generic receive offload. Takes a boolean value.
Defaults to "unset".</para>
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -586,7 +585,7 @@
<listitem>
<para>The Large Receive Offload (LRO) when true enables
large receive offload. Takes a boolean value.
Defaults to "unset".</para>
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>

28
man/systemd.netdev.xml
View file

@ -372,7 +372,7 @@
If enabled, the kernel will send general ICMP queries from a zero source address.
This feature should allow faster convergence on startup, but it causes some
multicast-aware switches to misbehave and disrupt forwarding of multicast packets.
When unset, the kernel's default setting applies.
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -381,7 +381,7 @@
<listitem>
<para>A boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel.
If enabled, IGMP snooping monitors the Internet Group Management Protocol (IGMP) traffic
between hosts and multicast routers. When unset, the kernel's default setting applies.
between hosts and multicast routers. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -389,16 +389,15 @@
<term><varname>VLANFiltering=</varname></term>
<listitem>
<para>A boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel.
If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's
default setting applies.
If enabled, the bridge will be started in VLAN-filtering mode. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>STP=</varname></term>
<listitem>
<para>A boolean. This enables the bridge's Spanning Tree Protocol (STP). When unset,
the kernel's default setting applies.
<para>A boolean. This enables the bridge's Spanning Tree Protocol (STP).
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -424,8 +423,9 @@
<term><varname>GVRP=</varname></term>
<listitem>
<para>The Generic VLAN Registration Protocol (GVRP) is a protocol that
allows automatic learning of VLANs on a network. A boolean. When unset,
the kernel's default setting applies.</para>
allows automatic learning of VLANs on a network. A boolean.
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
@ -434,8 +434,8 @@
<para>Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN
Registration Protocol (GVRP) is a standards-based Layer 2 network protocol,
for automatic configuration of VLAN information on switches. It was defined
in the 802.1ak amendment to 802.1Q-2005. A boolean. When unset, the kernel's
default setting applies.</para>
in the 802.1ak amendment to 802.1Q-2005. A boolean. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
@ -443,14 +443,14 @@
<listitem>
<para>The VLAN loose binding mode, in which only the operational state is passed
from the parent to the associated VLANs, but the VLAN device state is not changed.
A boolean. When unset, the kernel's default setting applies.</para>
A boolean. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>ReorderHeader=</varname></term>
<listitem>
<para>The VLAN reorder header is set VLAN interfaces behave like physical interfaces.
A boolean. When unset, the kernel's default setting applies.</para>
A boolean. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
</variablelist>
@ -884,7 +884,7 @@
<term><varname>AllowLocalRemote=</varname></term>
<listitem>
<para>A boolean. When true allows tunnel traffic on <varname>ip6tnl</varname> devices where the remote endpoint is a local host address.
Defaults to unset.
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -928,7 +928,7 @@
<term><varname>SerializeTunneledPackets=</varname></term>
<listitem>
<para>Takes a boolean value. If set to yes, then packets are serialized. Only applies for ERSPAN tunnel.
Defaults to unset.
When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>

37
man/systemd.network.xml
View file

@ -222,7 +222,7 @@
<term><varname>ARP=</varname></term>
<listitem>
<para>A boolean. Enables or disables the ARP (low-level Address Resolution Protocol)
for this interface. Defaults to unset, which means that the kernel default will be used.</para>
for this interface. When unset, the kernel's default will be used.</para>
<para> For example, disabling ARP is useful when creating multiple MACVLAN or VLAN virtual
interfaces atop a single lower-level physical interface, which will then only serve as a
link/"bridge" device aggregating traffic to the same physical link and not participate in
@ -626,7 +626,7 @@
<varlistentry>
<term><varname>IPv6DuplicateAddressDetection=</varname></term>
<listitem><para>Configures the amount of IPv6 Duplicate
Address Detection (DAD) probes to send. Defaults to unset.
Address Detection (DAD) probes to send. When unset, the kernel's default will be used.
</para></listitem>
</varlistentry>
<varlistentry>
@ -634,7 +634,7 @@
<listitem><para>Configures IPv6 Hop Limit. For each router that
forwards the packet, the hop limit is decremented by 1. When the
hop limit field reaches zero, the packet is discarded.
Defaults to unset.
When unset, the kernel's default will be used.
</para></listitem>
</varlistentry>
<varlistentry>
@ -643,7 +643,7 @@
usually a router, answers ARP requests intended for another machine. By "faking" its identity,
the router accepts responsibility for routing packets to the "real" destination. (see <ulink
url="https://tools.ietf.org/html/rfc1027">RFC 1027</ulink>.
Defaults to unset.
When unset, the kernel's default will be used.
</para></listitem>
</varlistentry>
<varlistentry>
@ -658,7 +658,7 @@
which can also be shown by <command>ip -6 neighbour show proxy</command>.
systemd-networkd will control the per-interface `proxy_ndp` switch for each configured
interface depending on this option.
Defautls to unset.
When unset, the kernel's default will be used.
</para></listitem>
</varlistentry>
<varlistentry>
@ -667,7 +667,7 @@
proxied. This option may be specified more than once. systemd-networkd will add the
<option>IPv6ProxyNDPAddress=</option> entries to the kernel's IPv6 neighbor proxy table.
This option implies <option>IPv6ProxyNDP=yes</option> but has no effect if
<option>IPv6ProxyNDP</option> has been set to false. Defaults to unset.
<option>IPv6ProxyNDP</option> has been set to false. When unset, the kernel's default will be used.
</para></listitem>
</varlistentry>
<varlistentry>
@ -688,7 +688,7 @@
<varlistentry>
<term><varname>IPv6MTUBytes=</varname></term>
<listitem><para>Configures IPv6 maximum transmission unit (MTU).
An integer greater than or equal to 1280 bytes. Defaults to unset.
An integer greater than or equal to 1280 bytes. When unset, the kernel's default will be used.
</para></listitem>
</varlistentry>
<varlistentry>
@ -1102,7 +1102,7 @@
<para>The TCP initial congestion window is used during the start of a TCP connection. During the start of a TCP
session, when a client requests a resource, the server's initial congestion window determines how many data bytes
will be sent during the initial burst of data. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual
suffixes K, M, G are supported and are understood to the base of 1024. Defaults to unset.
suffixes K, M, G are supported and are understood to the base of 1024. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -1112,14 +1112,14 @@
<para>The TCP initial advertised receive window is the amount of receive data (in bytes) that can initally be buffered at one time
on a connection. The sending host can send only that amount of data before waiting for an acknowledgment and window update
from the receiving host. Takes a size in bytes between 1 and 4294967295 (2^32 - 1). The usual suffixes K, M, G are supported
and are understood to the base of 1024. Defaults to unset.
and are understood to the base of 1024. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>QuickAck=</varname></term>
<listitem>
<para>Takes a boolean argument. When true enables TCP quick ack mode for the route. Defaults to unset.
<para>Takes a boolean argument. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -1584,8 +1584,7 @@
<listitem><para>Configures the IPv6 router lifetime in seconds. If set,
this host also announces itself in Router Advertisements as an IPv6
router for the network link. Defaults to unset, which means the host is
not acting as a router.</para>
router for the network link. When unset, the host is not acting as a router.</para>
</listitem>
</varlistentry>
@ -1701,7 +1700,7 @@
<listitem>
<para>A boolean. Controls whether the bridge should flood
traffic for which an FDB entry is missing and the destination
is unknown through this port. Defaults to unset.
is unknown through this port. When unset, the kernel's default will be used.
</para>
</listitem>
</varlistentry>
@ -1709,16 +1708,16 @@
<term><varname>HairPin=</varname></term>
<listitem>
<para>A boolean. Configures whether traffic may be sent back
out of the port on which it was received. Defaults to unset. When this
flag is false, and the bridge will not forward traffic back
out of the receiving port.</para>
out of the port on which it was received. When this flag is false, and the bridge
will not forward traffic back out of the receiving port.
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>UseBPDU=</varname></term>
<listitem>
<para>A boolean. Configures whether STP Bridge Protocol Data Units will be
processed by the bridge port. Defaults to unset.</para>
processed by the bridge port. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -1726,7 +1725,7 @@
<listitem>
<para>A boolean. This flag allows the bridge to immediately stop multicast
traffic on a port that receives an IGMP Leave message. It is only used with
IGMP snooping if enabled on the bridge. Defaults to unset.</para>
IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -1734,7 +1733,7 @@
<listitem>
<para>A boolean. Configures whether a given port is allowed to
become a root port. Only used when STP is enabled on the bridge.
Defaults to unset.</para>
When unset, the kernel's default will be used.</para>
</listitem>
</varlistentry>
<varlistentry>