From 9b6ffef3727695fa6dc7a564c1a29e326e59bc0a Mon Sep 17 00:00:00 2001 From: Yu Watanabe Date: Tue, 27 Nov 2018 15:07:58 +0900 Subject: [PATCH] man: update explanation for boolean options --- man/systemd.link.xml | 19 +++----- man/systemd.netdev.xml | 74 ++++++++++++++--------------- man/systemd.network.xml | 102 +++++++++++++++++++--------------------- 3 files changed, 93 insertions(+), 102 deletions(-) diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 7a49cbcf1a..f74edd0186 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -364,10 +364,10 @@ AutoNegotiation= - Enables or disables automatic negotiation of transmission parameters. + Takes a boolean. If set to yes, automatic negotiation of transmission parameters is enabled. 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. When unset, the kernel's default will be used. + When unset, the kernel's default will be used. 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 @@ -551,40 +551,35 @@ TCPSegmentationOffload= - The TCP Segmentation Offload (TSO) when true enables - TCP segmentation offload. Takes a boolean value. + Takes a boolean. If set to true, the TCP Segmentation Offload (TSO) is enabled. When unset, the kernel's default will be used. TCP6SegmentationOffload= - The TCP6 Segmentation Offload (tx-tcp6-segmentation) when true enables - TCP6 segmentation offload. Takes a boolean value. + Takes a boolean. If set to true, the TCP6 Segmentation Offload (tx-tcp6-segmentation) is enabled. When unset, the kernel's default will be used. GenericSegmentationOffload= - The Generic Segmentation Offload (GSO) when true enables - generic segmentation offload. Takes a boolean value. + Takes a boolean. If set to true, the Generic Segmentation Offload (GSO) is enabled. When unset, the kernel's default will be used. GenericReceiveOffload= - The Generic Receive Offload (GRO) when true enables - generic receive offload. Takes a boolean value. + Takes a boolean. If set to true, the Generic Receive Offload (GRO) is enabled. When unset, the kernel's default will be used. LargeReceiveOffload= - The Large Receive Offload (LRO) when true enables - large receive offload. Takes a boolean value. + Takes a boolean. If set to true, the Large Receive Offload (LRO) is enabled. When unset, the kernel's default will be used. diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 65890aeefb..f17a6a9619 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -368,7 +368,7 @@ MulticastQuerier= - A boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel. + Takes a boolean. This setting controls the IFLA_BR_MCAST_QUERIER option in the kernel. 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. @@ -379,7 +379,7 @@ MulticastSnooping= - A boolean. This setting controls the IFLA_BR_MCAST_SNOOPING option in the kernel. + Takes 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 will be used. @@ -388,7 +388,7 @@ VLANFiltering= - A boolean. This setting controls the IFLA_BR_VLAN_FILTERING option in the kernel. + Takes 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 will be used. @@ -396,7 +396,7 @@ STP= - A boolean. This enables the bridge's Spanning Tree Protocol (STP). + Takes a boolean. This enables the bridge's Spanning Tree Protocol (STP). When unset, the kernel's default will be used. @@ -422,8 +422,8 @@ GVRP= - The Generic VLAN Registration Protocol (GVRP) is a protocol that - allows automatic learning of VLANs on a network. A boolean. + Takes a boolean. The Generic VLAN Registration Protocol (GVRP) is a protocol that + allows automatic learning of VLANs on a network. When unset, the kernel's default will be used. @@ -431,26 +431,26 @@ MVRP= - Multiple VLAN Registration Protocol (MVRP) formerly known as GARP VLAN + Takes a boolean. 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 will be used. + in the 802.1ak amendment to 802.1Q-2005. When unset, the kernel's default will be used. LooseBinding= - The VLAN loose binding mode, in which only the operational state is passed + Takes a boolean. 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 will be used. + When unset, the kernel's default will be used. ReorderHeader= - The VLAN reorder header is set VLAN interfaces behave like physical interfaces. - A boolean. When unset, the kernel's default will be used. + Takes a boolean. The VLAN reorder header is set VLAN interfaces behave like physical interfaces. + When unset, the kernel's default will be used. @@ -559,7 +559,7 @@ MacLearning= - A boolean. When true, enables dynamic MAC learning + Takes a boolean. When true, enables dynamic MAC learning to discover remote MAC addresses. @@ -579,7 +579,7 @@ ReduceARPProxy= - A boolean. When true, bridge-connected VXLAN tunnel + Takes a boolean. When true, bridge-connected VXLAN tunnel endpoint answers ARP requests from the local bridge on behalf of remote Distributed Overlay Virtual Ethernet @@ -589,58 +589,58 @@ L2MissNotification= - A boolean. When true, enables netlink LLADDR miss + Takes a boolean. When true, enables netlink LLADDR miss notifications. L3MissNotification= - A boolean. When true, enables netlink IP address miss + Takes a boolean. When true, enables netlink IP address miss notifications. RouteShortCircuit= - A boolean. When true, route short circuiting is turned + Takes a boolean. When true, route short circuiting is turned on. UDPChecksum= - A boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on. + Takes a boolean. When true, transmitting UDP checksums when doing VXLAN/IPv4 is turned on. UDP6ZeroChecksumTx= - A boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on. + Takes a boolean. When true, sending zero checksums in VXLAN/IPv6 is turned on. UDP6ZeroChecksumRx= - A boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on. + Takes a boolean. When true, receiving zero checksums in VXLAN/IPv6 is turned on. RemoteChecksumTx= - A boolean. When true, remote transmit checksum offload of VXLAN is turned on. + Takes a boolean. When true, remote transmit checksum offload of VXLAN is turned on. RemoteChecksumRx= - A boolean. When true, remote receive checksum offload in VXLAN is turned on. + Takes a boolean. When true, remote receive checksum offload in VXLAN is turned on. GroupPolicyExtension= - A boolean. When true, it enables Group Policy VXLAN extension security label mechanism + Takes a boolean. When true, it enables Group Policy VXLAN extension security label mechanism across network peers based on VXLAN. For details about the Group Policy VXLAN, see the VXLAN Group Policy document. Defaults to false. @@ -709,19 +709,19 @@ UDPChecksum= - A boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4. + Takes a boolean. When true, specifies if UDP checksum is calculated for transmitted packets over IPv4. UDP6ZeroChecksumTx= - A boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6. + Takes a boolean. When true, skip UDP checksum calculation for transmitted packets over IPv6. UDP6ZeroChecksumRx= - A boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field. + Takes a boolean. When true, allows incoming UDP packets over IPv6 with zero checksum field. @@ -792,7 +792,7 @@ DiscoverPathMTU= - A boolean. When true, enables Path MTU Discovery on + Takes a boolean. When true, enables Path MTU Discovery on the tunnel. @@ -812,7 +812,7 @@ CopyDSCP= - A boolean. When true, the Differentiated Service Code + Takes a boolean. When true, the Differentiated Service Code Point (DSCP) field will be copied to the inner header from outer header during the decapsulation of an IPv6 tunnel packet. DSCP is a field in an IP packet that enables different @@ -875,7 +875,7 @@ Independent= - A boolean. When true tunnel does not require .network file. Created as "tunnel@NONE". + Takes a boolean. When true tunnel does not require .network file. Created as "tunnel@NONE". Defaults to false. @@ -883,7 +883,7 @@ AllowLocalRemote= - A boolean. When true allows tunnel traffic on ip6tnl devices where the remote endpoint is a local host address. + Takes a boolean. When true allows tunnel traffic on ip6tnl devices where the remote endpoint is a local host address. When unset, the kernel's default will be used. @@ -891,7 +891,7 @@ FooOverUDP= - A boolean. Specifies whether FooOverUDP= tunnel is to be configured. + Takes a boolean. Specifies whether FooOverUDP= tunnel is to be configured. Defaults to false. For more detail information see Foo over UDP @@ -927,7 +927,7 @@ SerializeTunneledPackets= - Takes a boolean value. If set to yes, then packets are serialized. Only applies for ERSPAN tunnel. + Takes a boolean. If set to yes, then packets are serialized. Only applies for ERSPAN tunnel. When unset, the kernel's default will be used. @@ -1033,7 +1033,7 @@ OneQueue= - Takes a boolean argument. Configures whether + Takes a boolean. 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 qdisc. Defaults to @@ -1042,7 +1042,7 @@ MultiQueue= - Takes a boolean argument. Configures whether + Takes a boolean. Configures whether to use multiple file descriptors (queues) to parallelize packets sending and receiving. Defaults to no. @@ -1050,7 +1050,7 @@ PacketInfo= - Takes a boolean argument. Configures whether + Takes a boolean. Configures whether packets should be prepended 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 @@ -1059,7 +1059,7 @@ VNetHeader= - Takes a boolean argument. Configures + Takes a boolean. Configures IFF_VNET_HDR flag for a tap device. It allows sending and receiving larger Generic Segmentation Offload (GSO) packets. This may increase throughput significantly. @@ -1440,7 +1440,7 @@ AllSlavesActive= - A boolean. Specifies that duplicate frames (received on inactive ports) + Takes a boolean. Specifies that duplicate frames (received on inactive ports) should be dropped when false, or delivered when true. Normally, bonding will drop duplicate frames (received on inactive ports), which is desirable for most users. But there are some times it is nice to allow duplicate diff --git a/man/systemd.network.xml b/man/systemd.network.xml index db70a22ed0..1bffedd00c 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -221,8 +221,8 @@ ARP= - A boolean. Enables or disables the ARP (low-level Address Resolution Protocol) - for this interface. When unset, the kernel's default will be used. + Takes a boolean. If set to true, the ARP (low-level Address Resolution Protocol) + for this interface is enabled. When unset, the kernel's default will be used. 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 @@ -232,20 +232,20 @@ Multicast= - A boolean. Enables or disables the multicast flag on the device. + Takes a boolean. If set to true, the multicast flag on the device is enabled. AllMulticast= - A boolean. When this flag is set the driver retrieves all multicast packets from the network. + Takes a boolean. If set to true, the driver retrieves all multicast packets from the network. This happens when multicast routing is enabled. Unmanaged= - A boolean. When yes, no attempts are + Takes a boolean. When yes, no attempts are made to bring up or configure matching links, equivalent to when there are no matching network files. Defaults to no. @@ -257,7 +257,7 @@ RequiredForOnline= - A boolean. When yes, the network is deemed + Takes a boolean. When yes, the network is deemed required when determining whether the system is online when running systemd-networkd-wait-online. When no, the network is ignored when checking for @@ -311,7 +311,7 @@ DHCPServer= - A boolean. Enables DHCPv4 server support. Defaults + Takes a boolean. If set to yes, DHCPv4 server will be start. Defaults to no. Further settings for the DHCP server may be set in the [DHCPServer] section described below. @@ -329,7 +329,7 @@ IPv4LLRoute= - A boolean. When true, sets up the route needed for + Takes a boolean. If set to true, sets up the route needed for non-IPv4LL hosts to communicate with IPv4LL-only hosts. Defaults to false. @@ -348,7 +348,7 @@ LLMNR= - A boolean or resolve. When true, + Takes a boolean or resolve. When true, enables Link-Local Multicast Name Resolution on the link. When set to @@ -361,7 +361,7 @@ MulticastDNS= - A boolean or resolve. When true, + Takes a boolean or resolve. When true, enables Multicast DNS support on the link. When set to @@ -389,7 +389,7 @@ DNSSEC= - A boolean or + Takes a boolean. or allow-downgrade. When true, enables DNSSEC @@ -559,8 +559,8 @@ Configures IP packet forwarding for the system. If enabled, incoming packets on any network interface will be forwarded to any other interfaces - according to the routing table. Takes either a boolean - argument, or the values ipv4 or + according to the routing table. Takes a boolean, + or the values ipv4 or ipv6, which only enable IP packet forwarding for the specified address family. This controls the net.ipv4.ip_forward and @@ -608,9 +608,9 @@ IPv6AcceptRA= - Enable or disable IPv6 Router Advertisement (RA) reception support for the interface. Takes - a boolean parameter. If true, RAs are accepted; if false, RAs are ignored, independently of the local - forwarding state. When not set, the kernel default is used, and RAs are accepted only when local forwarding + Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the interface. + If true, RAs are accepted; if false, RAs are ignored, independently of the local forwarding state. + If unset, the kernel's default is used, and RAs are accepted only when local forwarding is disabled for that interface. When RAs are accepted, they may trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found on the link. @@ -639,7 +639,7 @@ IPv4ProxyARP= - A boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host, + Takes a boolean. Configures proxy ARP for IPv4. Proxy ARP is the technique in which one host, 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 RFC 1027. @@ -648,7 +648,7 @@ IPv6ProxyNDP= - A boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery + Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery Protocol) is a technique for IPv6 to allow routing of addresses to a different destination when peers expect them to be present on a certain physical link. In this case a router answers Neighbour Advertisement messages intended for @@ -758,7 +758,7 @@ ActiveSlave= - A boolean. Specifies the new active slave. The ActiveSlave= + Takes a boolean. Specifies the new active slave. The ActiveSlave= option is only valid for following modes: active-backup, balance-alb and @@ -769,7 +769,7 @@ PrimarySlave= - A boolean. Specifies which slave is the primary device. The specified + Takes a boolean. Specifies which slave is the primary device. The specified device will always be the active slave while it is available. Only when the primary is off-line will alternate devices be used. This is useful when one slave is preferred over another, e.g. when one slave has higher throughput @@ -784,7 +784,7 @@ ConfigureWithoutCarrier= - A boolean. Allows networkd to configure a specific link even if it has no carrier. + Takes a boolean. Allows networkd to configure a specific link even if it has no carrier. Defaults to false. @@ -856,7 +856,7 @@ HomeAddress= - Takes a boolean argument. Designates this address the "home address" as defined in + Takes a boolean. Designates this address the "home address" as defined in RFC 6275. Supported only on IPv6. Defaults to false. @@ -864,7 +864,7 @@ DuplicateAddressDetection= - Takes a boolean argument. Do not perform Duplicate Address Detection + Takes a boolean. Do not perform Duplicate Address Detection RFC 4862 when adding this address. Supported only on IPv6. Defaults to false. @@ -872,7 +872,7 @@ ManageTemporaryAddress= - Takes a boolean argument. If true the kernel manage temporary addresses created + Takes a boolean. If true the kernel manage temporary addresses created from this one as template on behalf of Privacy Extensions RFC 3041. For this to become active, the use_tempaddr sysctl setting has to be set to a value greater than zero. @@ -884,7 +884,7 @@ PrefixRoute= - Takes a boolean argument. When adding or modifying an IPv6 address, the userspace + Takes a boolean. When adding or modifying an IPv6 address, the userspace application needs a way to suppress adding a prefix route. This is for example relevant together with IFA_F_MANAGERTEMPADDR, where userspace creates autoconf generated addresses, but depending on on-link, no route for the prefix should be added. Defaults to false. @@ -893,7 +893,7 @@ AutoJoin= - Takes a boolean argument. Joining multicast group on ethernet level via + Takes a boolean. Joining multicast group on ethernet level via ip maddr command would not work if we have an Ethernet switch that does IGMP snooping since the switch would not replicate multicast packets on ports that did not have IGMP reports for the multicast addresses. Linux vxlan interfaces created via @@ -1011,10 +1011,10 @@ GatewayOnlink= - The GatewayOnlink option tells the kernel that it does not have + Takes a boolean. If set to true, the kernel does not have to check if the gateway is reachable directly by the current machine (i.e., the kernel does not need to check if the gateway is attached to the local network), so that we can insert the - route in the kernel table without it being complained about. A boolean, defaults to no. + route in the kernel table without it being complained about. Defaults to no. @@ -1119,7 +1119,7 @@ QuickAck= - Takes a boolean argument. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used. + Takes a boolean. When true enables TCP quick ack mode for the route. When unset, the kernel's default will be used. @@ -1175,7 +1175,7 @@ Anonymize= - Takes a boolean argument. When true, the options sent to the DHCP server will + Takes a boolean. When true, the options sent to the DHCP server will follow the RFC 7844 (Anonymity Profiles for DHCP Clients) to minimize disclosure of identifying information. Defaults to false. @@ -1221,7 +1221,7 @@ UseDomains= - Takes a boolean argument, or the special value route. When true, the domain name + Takes a boolean, or the special value route. When true, the domain name received from the DHCP server will be used as DNS search domain over this link, similar to the effect of the setting. If set to route, the domain name received from the DHCP server will be used for routing DNS queries only, but not for searching, similar to the effect of @@ -1363,7 +1363,7 @@ RapidCommit= - A boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through + Takes a boolean. The DHCPv6 client can obtain configuration parameters from a DHCPv6 server through a rapid two-message exchange (solicit and reply). When the rapid commit option is enabled by both the DHCPv6 client and the DHCPv6 server, the two-message exchange is used, rather than the default four-method exchange (solicit, advertise, request, and reply). The two-message exchange provides @@ -1376,7 +1376,7 @@ ForceDHCPv6PDOtherInformation= - A boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in + Takes a boolean that enforces DHCPv6 stateful mode when the 'Other information' bit is set in Router Advertisement messages. By default setting only the 'O' bit in Router Advertisements makes DHCPv6 request network information in a stateless manner using a two-message Information Request and Information Reply message exchange. @@ -1413,7 +1413,7 @@ UseDomains= - Takes a boolean argument, or the special value route. When true, the domain name + Takes a boolean, or the special value route. When true, the domain name received via IPv6 Router Advertisement (RA) will be used as DNS search domain over this link, similar to the effect of the setting. If set to route, the domain name received via IPv6 RA will be used for routing DNS queries only, but not for searching, similar to the @@ -1489,11 +1489,9 @@ EmitDNS= DNS= - Configures whether the DHCP leases handed out - to clients shall contain DNS server information. The - EmitDNS= setting takes a boolean argument - and defaults to yes. The DNS servers to - pass to clients may be configured with the + Takes a boolean. Configures whether the DHCP leases handed out + to clients shall contain DNS server information. Defaults to yes. + The DNS servers to pass to clients may be configured with the DNS= option, which takes a list of IPv4 addresses. If the EmitDNS= option is enabled but no servers configured, the servers are @@ -1540,10 +1538,8 @@ EmitTimezone= Timezone= - Configures whether the DHCP leases handed out - to clients shall contain timezone information. The - EmitTimezone= setting takes a boolean - argument and defaults to yes. The + Takes a boolean. Configures whether the DHCP leases handed out + to clients shall contain timezone information. Defaults to yes. The Timezone= setting takes a timezone string (such as Europe/Berlin or UTC) to pass to clients. If no explicit @@ -1569,11 +1565,11 @@ Managed= OtherInformation= - Controls whether a DHCPv6 server is used to acquire IPv6 - addresses on the network link when Managed= boolean + Takes a boolean. Controls whether a DHCPv6 server is used to acquire IPv6 + addresses on the network link when Managed= is set to true or if only additional network information can be obtained via DHCPv6 for the network link when - OtherInformation= boolean is set to + OtherInformation= is set to true. Both settings default to false, which means that a DHCPv6 server is not being used. @@ -1582,7 +1578,7 @@ RouterLifetimeSec= - Configures the IPv6 router lifetime in seconds. If set, + Takes a timespan. 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. When unset, the host is not acting as a router. @@ -1658,7 +1654,7 @@ AddressAutoconfiguration= OnLink= - Boolean values to specify whether IPv6 addresses can be + Takes a boolean to specify whether IPv6 addresses can be autoconfigured with this prefix and whether the prefix can be used for onlink determination. Both settings default to true in order to ease configuration. @@ -1698,7 +1694,7 @@ UnicastFlood= - A boolean. Controls whether the bridge should flood + Takes a boolean. Controls whether the bridge should flood traffic for which an FDB entry is missing and the destination is unknown through this port. When unset, the kernel's default will be used. @@ -1707,7 +1703,7 @@ HairPin= - A boolean. Configures whether traffic may be sent back + Takes a boolean. Configures whether traffic may be sent back 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. @@ -1716,14 +1712,14 @@ UseBPDU= - A boolean. Configures whether STP Bridge Protocol Data Units will be + Takes a boolean. Configures whether STP Bridge Protocol Data Units will be processed by the bridge port. When unset, the kernel's default will be used. FastLeave= - A boolean. This flag allows the bridge to immediately stop multicast + Takes 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. When unset, the kernel's default will be used. @@ -1731,7 +1727,7 @@ AllowPortToBeRoot= - A boolean. Configures whether a given port is allowed to + Takes a boolean. Configures whether a given port is allowed to become a root port. Only used when STP is enabled on the bridge. When unset, the kernel's default will be used.