X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fudev.xml;h=db729378c5c81c4534c5c2e67296668ee65493ca;hb=19f8d037833f2426f0ea6b06279d669ed69fcfd1;hp=bd071e17709414db21e51e51ea657f269b6acb10;hpb=d2df0d0ed3a88e491405b403e6022e6619750130;p=elogind.git
diff --git a/man/udev.xml b/man/udev.xml
index bd071e177..db729378c 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.
@@ -305,8 +307,11 @@
NAME
- The name to use for a network interface. The name of a device node
- cannot be changed by udev, only additional symlinks can be created.
+ The name to use for a network interface. See
+ systemd.link5
+ for a higher-level mechanism for setting the interface name.
+ The name of a device node cannot be changed by udev, only additional
+ symlinks can be created.
@@ -360,7 +365,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 +386,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 +414,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 +423,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.
@@ -507,13 +515,6 @@
priorities overwrite existing symlinks of other devices. The default is 0.
-
-
-
- Number of seconds an event waits for operations to finish before
- giving up and terminating itself.
-
-
@@ -525,21 +526,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 +557,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 +578,8 @@
, The kernel number for this device. For example,
- sda3 has kernel number 3.
+ sda3 has kernel number 3.
+
@@ -586,8 +593,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 +603,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 +615,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 +651,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 +729,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.
@@ -741,210 +755,18 @@
During runtime only the binary database is used.
- Network Link Configuration
- Network link configuration is performed by the net_setup_link
- udev builtin.
-
- The link files are read from the files located in the
- system network directory /usr/lib/systemd/network,
- the volatile runtime network directory /run/systemd/network
- and the local administration network directory /etc/systemd/network.
- Link files must have the extension .link; other extensions are ignored.
- All link files are collectively sorted and processed in lexical order,
- 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
- 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,
- disables the link file entirely.
-
- The link file contains a [Match] section, which
- determines if a given link file may be applied to a given device; and 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.
-
- 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.
-
-
-
-
- Path
-
- The persistent path, as exposed by the udev property ID_PATH.
-
-
-
- Driver
-
- The driver currently bound to the device, as exposed by the udev property DRIVER.
-
-
-
- Type
-
- The device type, as exposed by the udev property DEVTYPE.
-
-
-
-
- The [Link] section accepts the following keys:
-
-
-
- Description
-
- A description of the device.
-
-
-
- Alias
-
- The ifalias is set to this value.
-
-
-
- MACAddressPolicy
-
- 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.
-
-
-
-
- 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.
-
-
-
-
-
-
- MACAddress
-
- The MAC address to use, if no MACAddressPolicy is specified.
-
-
-
- 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:
-
-
- 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.
-
-
-
- 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.
-
-
-
-
-
-
- Name
-
- The interface name to use in case all the policies specified in NamePolicy
- fail, or in case NamePolicy is missing or disabled.
-
-
-
- MTU
-
- The MTU to set for the device.
-
-
-
- SpeedMBytes
-
- The speed to set for the device.
-
-
-
- Duplex
-
- The duplex mode to set for the device. The accepted values are half and
- full.
-
-
-
- WakeOnLan
-
- The Wake-On-Lan policy to set for the device. The supported values are:
-
-
- phy
-
- Wake on PHY activity.
-
-
-
- magic
-
- Wake on receipt of magic packet.
-
-
-
- off
-
- Never wake.
-
-
-
-
-
-
-
-
See Also
-
+
+ systemd-udevd.service8,
udevadm8
-
+ ,
+
+ systemd.link5
+
+