X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fudev.xml;h=ae7dc61b03ec5c3cd57cf8b531e1d4230e362f3a;hb=bf175aafd20c9ef974709ef12c5acf836121af33;hp=bd071e17709414db21e51e51ea657f269b6acb10;hpb=d2df0d0ed3a88e491405b403e6022e6619750130;p=elogind.git
diff --git a/man/udev.xml b/man/udev.xml
index bd071e177..ae7dc61b0 100644
--- a/man/udev.xml
+++ b/man/udev.xml
@@ -63,10 +63,10 @@
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in /etc
have the highest priority, files in /run take precedence
- over files with the same name in /lib. This can be
+ over files with the same name in /usr/lib. This can be
used to override a system-supplied rules file with a local file if needed;
a symlink in /etc with the same name as a rules file in
- /lib, pointing to /dev/null,
+ /usr/lib, pointing to /dev/null,
disables the rules file entirely. Rule files must have the extension
.rules; other extensions are ignored.
@@ -255,9 +255,9 @@
Execute a program to determine whether there
is a match; the key is true if the program returns
successfully. The device properties are made available to the
- executed program in the environment. The program's stdout
- is available in the RESULT key.
- This can only be used for very short-running foreground tasks. For details
+ executed program in the environment. The program's standard ouput
+ is available in the RESULT key.
+ This can only be used for very short-running foreground tasks. For details,
see RUN.
@@ -265,8 +265,9 @@
RESULT
- Match the returned string of the last PROGRAM call. This key can
- be used in the same or in any later rule after a PROGRAM call.
+ Match the returned string of the last PROGRAM call.
+ This key can be used in the same or in any later rule after a
+ PROGRAM call.
@@ -293,9 +294,10 @@
example, the pattern string tty[SR]
would match either ttyS or ttyR.
Ranges are also supported via the - character.
- For example, to match on the range of all digits, the pattern [0-9] could
- be used. If the first character following the [ is a
- !, any characters not enclosed are matched.
+ For example, to match on the range of all digits, the pattern
+ [0-9] could be used. If the first character
+ following the [ is a !,
+ any characters not enclosed are matched.
@@ -360,7 +362,8 @@
Set a device property value. Property names with a leading .
are neither stored in the database nor exported to events or
- external tools (run by, say, the PROGRAM match key).
+ external tools (run by, for example, the PROGRAM
+ match key).
@@ -380,24 +383,26 @@
RUN{type}
- Add a program to the list of programs to be executed after processing all the
- rules for a specific event, depending on type:
+ Add a program to the list of programs to be executed after
+ processing all the rules for a specific event, depending on
+ type:programExecute an external program specified as the assigned
- value. If no absolute path is given, the program is expected to live in
- /usr/lib/udev, otherwise the absolute path must be specified.
- This is the default if no type is
- specified.
+ value. If no absolute path is given, the program is expected
+ to live in /usr/lib/udev; otherwise, the
+ absolute path must be specified.
+ This is the default if no type
+ is specified.builtin
- As program, but use one of the built-in programs rather
- than an external one.
+ As program, but use one of the
+ built-in programs rather than an external one.
@@ -406,7 +411,7 @@
This can only be used for very short-running foreground tasks. Running an
event process for a long period of time may block all further events for
this or a dependent device.
- Starting daemons or other long running processes is not appropriate
+ Starting daemons or other long-running processes is not appropriate
for udev; the forked processes, detached or not, will be unconditionally
killed after the event handling has finished.
@@ -415,14 +420,14 @@
LABEL
- A named label to which a GOTO may jump.
+ A named label to which a GOTO may jump.GOTO
- Jumps to the next LABEL with a matching name.
+ Jumps to the next LABEL with a matching name.
@@ -525,21 +530,24 @@
- Apply the permissions specified in this rule to the static device node with
- the specified name. Also, for every tag specified in this rule, create a symlink
+ Apply the permissions specified in this rule to the
+ static device node with the specified name. Also, for every
+ tag specified in this rule, create a symlink
in the directory
/run/udev/static_node-tags/tag
- pointing at the static device node with the specified name. Static device node
- creation is performed by systemd-tmpfiles before systemd-udevd is started. The
- static nodes might not have a corresponding kernel device; they are used to
- trigger automatic kernel module loading when they are accessed.
+ pointing at the static device node with the specified name.
+ Static device node creation is performed by systemd-tmpfiles
+ before systemd-udevd is started. The static nodes might not
+ have a corresponding kernel device; they are used to trigger
+ automatic kernel module loading when they are accessed.
- Watch the device node with inotify; when the node is closed after being opened for
- writing, a change uevent is synthesized.
+ Watch the device node with inotify; when the node is
+ closed after being opened for writing, a change uevent is
+ synthesized.
@@ -553,13 +561,15 @@
- The NAME, SYMLINK, PROGRAM,
- OWNER, GROUP, MODE and RUN
- fields support simple string substitutions. The RUN
- substitutions are performed after all rules have been processed, right before the program
- is executed, allowing for the use of device properties set by earlier matching
- rules. For all other fields, substitutions are performed while the individual rule is
- being processed. The available substitutions are:
+ The NAME, SYMLINK,
+ PROGRAM, OWNER,
+ GROUP, MODE, and
+ RUN fields support simple string substitutions.
+ The RUN substitutions are performed after all rules
+ have been processed, right before the program is executed, allowing for
+ the use of device properties set by earlier matching rules. For all other
+ fields, substitutions are performed while the individual rule is being
+ processed. The available substitutions are:,
@@ -572,7 +582,8 @@
, The kernel number for this device. For example,
- sda3 has kernel number 3.
+ sda3 has kernel number 3.
+
@@ -586,8 +597,9 @@
,
- The name of the device matched while searching the devpath upwards for
- , , and .
+ The name of the device matched while searching the devpath
+ upwards for , ,
+ , and .
@@ -595,8 +607,10 @@
- The driver name of the device matched while searching the devpath upwards for
- , , and .
+ The driver name of the device matched while searching the
+ devpath upwards for ,
+ , , and
+ .
@@ -605,12 +619,15 @@
, The value of a sysfs attribute found at the device where
- all keys of the rule have matched. If the matching device does not have
- such an attribute, and a previous KERNELS, SUBSYSTEMS, DRIVERS, or
- ATTRS test selected a parent device, then the attribute from that
- parent device is used.
- If the attribute is a symlink, the last element of the symlink target is
- returned as the value.
+ all keys of the rule have matched. If the matching device does not
+ have such an attribute, and a previous ,
+ , , or
+ test selected a parent device, then the
+ attribute from that parent device is used.
+
+ If the attribute is a symlink, the last element of the
+ symlink target is returned as the value.
+
@@ -638,7 +655,8 @@
,
- The string returned by the external program requested with PROGRAM.
+ The string returned by the external program requested with
+ PROGRAM.
A single part of the string, separated by a space character, may be selected
by specifying the part number as an attribute: %c{N}.
If the number is followed by the + character, this part plus all remaining parts
@@ -715,10 +733,10 @@
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in /etc
have the highest priority, files in /run take precedence
- over files with the same name in /lib. This can be
+ over files with the same name in /usr/lib. This can be
used to override a system-supplied hwdb file with a local file if needed;
a symlink in /etc with the same name as a hwdb file in
- /lib, pointing to /dev/null,
+ /usr/lib, pointing to /dev/null,
disables the hwdb file entirely. hwdb files must have the extension
.hwdb; other extensions are ignored.
@@ -754,10 +772,10 @@
regardless of the directories in which they live. However, files with
identical filenames replace each other. Files in /etc
have the highest priority, files in /run take precedence
- over files with the same name in /lib. This can be
+ over files with the same name in /usr/lib. This can be
used to override a system-supplied link file with a local file if needed;
a symlink in /etc with the same name as a link file in
- /lib, pointing to /dev/null,
+ /usr/lib, pointing to /dev/null,
disables the link file entirely.The link file contains a [Match] section, which
@@ -772,147 +790,223 @@
- MACAddress
+ MACAddress=The hardware address.
- Path
+ Path=
- The persistent path, as exposed by the udev property ID_PATH.
+ The persistent path, as exposed by the udev property ID_PATH.
+ May contain shell style globs.
- Driver
+ Driver=
- The driver currently bound to the device, as exposed by the udev property DRIVER.
+ 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.
- Type
+ Type=The device type, as exposed by the udev property DEVTYPE.
+
+ Host=
+
+ Matches against the hostname or machine ID of the
+ host. See ConditionHost= in
+ systemd.unit5
+ for details.
+
+
+
+ Virtualization=
+
+ Checks whether the system is executed in a virtualized
+ environment and optionally test whether it is a specific
+ implementation. See ConditionVirtualization= in
+ systemd.unit5
+ for details.
+
+
+
+ KernelCommandLine=
+
+ Checks whether a specific kernel command line option is
+ set (or if prefixed with the exclamation mark unset). See
+ ConditionKernelCommandLine= in
+ systemd.unit5
+ for details.
+
+
+
+ Architecture=
+
+ Checks whether the system is running on a specific
+ architecture. See ConditionArchitecture= in
+ systemd.unit5
+ for details.
+
+ The [Link] section accepts the following keys:
- Description
+ Description=A description of the device.
- Alias
+ Alias=The ifalias is set to this value.
- MACAddressPolicy
+ MACAddressPolicy=
- The policy by which the MAC address should be set. The available policies are:
+ The policy by which the MAC address should be set. The
+ available policies are:
+ persistent
- If the hardware has a persistent MAC address, as most hardware should, and this is used by
- the kernel, nothing is done. Otherwise, a new MAC address is generated which is guaranteed to be
- the same on every boot for the given machine and the given device, but which is otherwise random.
+ If the hardware has a persistent MAC address, as most
+ hardware should, and this is used by the kernel, nothing is
+ done. Otherwise, a new MAC address is generated which is
+ guaranteed to be the same on every boot for the given
+ machine and the given device, but which is otherwise random.
random
- If the kernel is using a random MAC address, nothing is done. Otherwise, a new address is
- randomly generated each time the device appears, typically at boot.
+ If the kernel is using a random MAC address, nothing is
+ done. Otherwise, a new address is randomly generated each
+ time the device appears, typically at boot.
+
- MACAddress
+ MACAddress=
- The MAC address to use, if no MACAddressPolicy is specified.
+ The MAC address to use, if no MACAddressPolicy=
+ is specified.
+
- NamePolicy
+ NamePolicy=
- An ordered, space-separated list of policies by which the interface name should be set.
- NamePolicy may be disabeld by specifying net.ifnames=0 on the
- kernel commandline. Each of the policies may fail, and the first successfull one is used. The name
- is not set directly, but exported to udev as the property ID_NET_NAME, which is
- by default used by an udev rule to set NAME. 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 net.ifnames=0 on the
+ kernel commandline. 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. The available policies are:
+
+
+ database
+
+ The name is set based on entries in the Hardware
+ Database with the key
+ 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.
+ 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.
+ 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.
+ 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.
+ path
- The name is set based on the device's physical location, as exported by the udev
- property ID_NET_NAME_PATH.
+ The name is set based on the device's physical location,
+ as exported by the udev property
+ 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.
+ The name is set based on the device's persistent MAC
+ address, as exported by the udev property
+ ID_NET_NAME_MAC.
+
- Name
+ Name=
- The interface name to use in case all the policies specified in NamePolicy
- fail, or in case NamePolicy is missing or disabled.
+ The interface name to use in case all the policies specified
+ in NamePolicy= fail, or in case
+ NamePolicy= is missing or disabled.
+
- MTU
+ MTU=The MTU to set for the device.
- SpeedMBytes
+ SpeedMBytes=The speed to set for the device.
- Duplex
+ 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 half and full.
+
- WakeOnLan
+ WakeOnLan=
- The Wake-On-Lan policy to set for the device. The supported values are:
+ The Wake-on-LAN policy to set for the device. The supported
+ values are:
+ phy
@@ -923,7 +1017,7 @@
magic
- Wake on receipt of magic packet.
+ Wake on receipt of a magic packet.
@@ -940,11 +1034,13 @@
See Also
-
+
+ systemd-udevd.service8,
udevadm8
-
+
+