X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=man%2Fsystemd.link.xml;h=178f9b81afce6439c1ce57d7e2042f9c58c6ed06;hb=8274a4132cb7274ea3ca2ee3d68dce9a62cbf71b;hp=794e0e06fce1c8645eaf9ef85d3f82cfe4816f20;hpb=c605bd00d2cf5d30c7522ac862dc70ece952ec07;p=thirdparty%2Fsystemd.git diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 794e0e06fce..178f9b81afc 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -1,40 +1,15 @@ - + systemd.link systemd - - - - Developer - Tom - Gundersen - - @@ -75,33 +50,32 @@ same name pointing to /dev/null disables the configuration file entirely (it is "masked"). - The link file contains a [Match] section, - which determines if a given link file may be applied to a given - device, as well as a [Link] section specifying - how the device should be configured. The first (in lexical order) - of the link files that matches a given device is applied. Note - that a default file 99-default.link is - shipped by the system. Any user-supplied - .link should hence have a lexically earlier - name to be considered at all. - - See - udevadm8 - for diagnosing problems with .link files. + The link file contains a [Match] section, which determines if a given link file may be applied to a + given device, as well as a [Link] section specifying how the device should be configured. The first (in + lexical order) of the link files that matches a given device is applied. Note that a default file + 99-default.link is shipped by the system. Any user-supplied + .link should hence have a lexically earlier name to be considered at all. + + See udevadm8 for + diagnosing problems with .link files. [Match] Section Options - A link file is said to match a device if each of the entries - in the [Match] section matches, or if the - section is empty. The following keys are accepted: + A link file is said to match a device if each of the entries in the [Match] section matches, or if + the section is empty. The following keys are accepted: MACAddress= - The hardware address. + A whitespace-separated list of hardware addresses. Use full colon-, hyphen- or dot-delimited hexadecimal. See the example below. + This option may appear more than once, in which case the lists are merged. If the empty string is assigned to this option, the list + of hardware addresses defined prior to this is reset. + + Example: + MACAddress=01:23:45:67:89:ab 00-11-22-33-44-55 AABB.CCDD.EEFF @@ -120,18 +94,15 @@ A whitespace-separated list of shell-style globs matching the persistent path, as exposed by the udev property - ID_PATH. + ID_PATH. Driver= - A whitespace-separated list of shell-style globs matching - the driver currently bound to the device, - as exposed by the udev property DRIVER - of its parent device, or if that is not set, the - driver as exposed by ethtool -i - of the device itself. + A whitespace-separated list of shell-style globs matching the driver currently bound to the + device, as exposed by the udev property DRIVER of its parent device, or if that + is not set, the driver as exposed by ethtool -i of the device itself. @@ -139,14 +110,14 @@ A whitespace-separated list of shell-style globs matching the device type, as exposed by the udev - property DEVTYPE. + property DEVTYPE. Host= Matches against the hostname or machine - ID of the host. See ConditionHost= in + ID of the host. See ConditionHost= in systemd.unit5 for details. @@ -157,7 +128,7 @@ Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation. See - ConditionVirtualization= in + ConditionVirtualization= in systemd.unit5 for details. @@ -167,7 +138,7 @@ Checks whether a specific kernel command line option is set (or if prefixed with the exclamation mark unset). See - ConditionKernelCommandLine= in + ConditionKernelCommandLine= in systemd.unit5 for details. @@ -177,7 +148,7 @@ Checks whether the kernel version (as reported by uname -r) matches a certain expression (or if prefixed with the exclamation mark does not match it). See - ConditionKernelVersion= in + ConditionKernelVersion= in systemd.unit5 for details. @@ -187,7 +158,7 @@ Architecture= Checks whether the system is running on a specific - architecture. See ConditionArchitecture= + architecture. See ConditionArchitecture= in systemd.unit5 for details. @@ -200,7 +171,7 @@ [Link] Section Options - The [Link] section accepts the following + The [Link] section accepts the following keys: @@ -213,8 +184,7 @@ Alias= - The ifalias is set to this - value. + The ifalias interface property is set to this value. @@ -226,7 +196,7 @@ - persistent + If the hardware has a persistent MAC address, as most hardware should, and if it is used by the kernel, @@ -240,7 +210,7 @@ - random + If the kernel is using a random MAC address, nothing is done. Otherwise, a new address is randomly @@ -251,7 +221,7 @@ - none + Keeps the MAC address assigned by the kernel. @@ -263,28 +233,23 @@ MACAddress= The MAC address to use, if no - MACAddressPolicy= + MACAddressPolicy= is specified. NamePolicy= - An ordered, space-separated list of policies by which - the interface name should be set. - NamePolicy may be disabled by specifying - net.ifnames=0 on the kernel command line. - Each of the policies may fail, and the first successful one - is used. The name is not set directly, but is exported to - udev as the property ID_NET_NAME, which - is, by default, used by a udev rule to set - NAME. If the name has already been set by - userspace, no renaming is performed. The available policies - are: + An ordered, space-separated list of policies by which the interface name should be set. + NamePolicy= may be disabled by specifying on the + kernel command line. Each of the policies may fail, and the first successful one is used. The name + is not set directly, but is exported to udev as the property , which + is, by default, used by a udev rule to set NAME. The available policies are: + - kernel + If the kernel claims that the name it has set for a device is predictable, then no renaming is @@ -292,46 +257,53 @@ - database + The name is set based on entries in the udev's Hardware Database with the key - ID_NET_NAME_FROM_DATABASE. + ID_NET_NAME_FROM_DATABASE. - onboard + The name is set based on information given by the firmware for on-board devices, as exported by the - udev property ID_NET_NAME_ONBOARD. + udev property ID_NET_NAME_ONBOARD. - slot + The name is set based on information given by the firmware for hot-plug devices, as exported by the - udev property ID_NET_NAME_SLOT. + udev property ID_NET_NAME_SLOT. - path + The name is set based on the device's physical location, as exported by the udev property - ID_NET_NAME_PATH. + ID_NET_NAME_PATH. - mac + The name is set based on the device's persistent MAC address, as exported by the udev property - ID_NET_NAME_MAC. + ID_NET_NAME_MAC. + + + + + + If the device already had a name given by userspace (as part of creation of the device + or a rename), keep it. @@ -376,19 +348,17 @@ Duplex= - The duplex mode to set for the device. The accepted - values are half and - full. + The duplex mode to set for the device. The accepted values are and + . 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. Unset by default, which means that the kernel default - will be used. + When unset, the kernel's default will be used. Note that if autonegotiation is enabled, speed and duplex settings are read-only. If autonegotation is disabled, speed and duplex settings are writable @@ -403,58 +373,58 @@ - phy + Wake on PHY activity. - unicast + Wake on unicast messages. - multicast + Wake on multicast messages. - broadcast + Wake on broadcast messages. - arp + Wake on ARP. - magic + Wake on receipt of a magic packet. - secureon + Enable secureon(tm) password for MagicPacket(tm). - off + Never wake. - Defaults to off. + Defaults to . @@ -465,32 +435,32 @@ - tp + An Ethernet interface using Twisted-Pair cable as the medium. - aui + Attachment Unit Interface (AUI). Normally used with hubs. - bnc + An Ethernet interface using BNC connectors and co-axial cable. - mii + An Ethernet interface using a Media Independent Interface (MII). - fibre + An Ethernet interface using Optical Fibre as the medium. @@ -498,52 +468,133 @@ + + Advertise= + + This sets what speeds and duplex modes of operation are advertised for auto-negotiation. + This implies AutoNegotiation=yes. The supported values are: + + + Supported advertise values + + + + + + + Advertise + Speed (Mbps) + Duplex Mode + + + + 10half + + + 10full + + + 100half + + + 100full + + + 1000half + + + 1000full + + + 10000full + + + 2500full + + + 1000full + + + 10000full + + + 10000full + + + 10000full + + + 20000full + + + 20000full + + +
+ + By default this is unset, i.e. all possible modes will be advertised. + This option may be specified more than once, in which case all specified speeds and modes are advertised. + If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect. + + + TCPSegmentationOffload= - The TCP Segmentation Offload (TSO) when true enables - TCP segmentation offload. Takes a boolean value. - Defaults to "unset". + 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. - Defaults to "unset". + 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. - Defaults to "unset". + Takes a boolean. If set to true, the Generic Segmentation Offload (GSO) is enabled. + When unset, the kernel's default will be used. + + + + GenericReceiveOffload= + + Takes a boolean. If set to true, the Generic Receive Offload (GRO) is enabled. + When unset, the kernel's default will be used. - UDPSegmentationOffload= + LargeReceiveOffload= - The UDP Segmentation Offload (USO) when true enables - UDP segmentation offload. Takes a boolean value. - Defaults to "unset". + Takes a boolean. If set to true, the Large Receive Offload (LRO) is enabled. + When unset, the kernel's default will be used. - - GenericReceiveOffload= + + RxChannels= - The Generic Receive Offload (GRO) when true enables - generic receive offload. Takes a boolean value. - Defaults to "unset". + Sets the number of receive channels (a number between 1 and 4294967295) . - LargeReceiveOffload= + TxChannels= + + Sets the number of transmit channels (a number between 1 and 4294967295). + + + + OtherChannels= + + Sets the number of other channels (a number between 1 and 4294967295). + + + + CombinedChannels= - The Large Receive Offload (LRO) when true enables - large receive offload. Takes a boolean value. - Defaults to "unset". + Sets the number of combined set channels (a number between 1 and 4294967295).