From 014ba30c45b1de6fb82196a7268ea91515cfbc63 Mon Sep 17 00:00:00 2001 From: "Anthony G. Basile" Date: Thu, 30 Oct 2014 21:55:52 -0400 Subject: man/udev.xml: update man page Signed-off-by: Anthony G. Basile --- man/udev.xml | 125 +++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 70 insertions(+), 55 deletions(-) (limited to 'man/udev.xml') diff --git a/man/udev.xml b/man/udev.xml index 0ecf683a28..73539803dd 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -30,7 +30,7 @@ udev - Linux dynamic device management + Dynamic device management Description @@ -54,23 +54,21 @@ sources is provided by the library libudev. - Rules files + Rules Files The udev rules are read from the files located in the system rules directory /lib/udev/rules.d, the volatile runtime directory /run/udev/rules.d and the local administration directory /etc/udev/rules.d. All rules files are collectively sorted and processed in lexical order, regardless of the directories in which they live. However, files with - identical file names replace each other. Files in /etc + 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 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, - disables the rules file entirely. - - Rule files must have the extension .rules; other - extensions are ignored. + disables the rules file entirely. Rule files must have the extension + .rules; other extensions are ignored. Every line in the rules file contains at least one key-value pair. Except for empty lines or lines beginning with #, which are ignored. @@ -264,9 +262,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 output + is available in the RESULT key. + This can only be used for very short-running foreground tasks. For details, see RUN. @@ -274,15 +272,15 @@ 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. Most of the fields support shell glob pattern matching and alternate patterns. The following special characters are supported: - * @@ -303,9 +301,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. @@ -378,7 +377,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). @@ -398,24 +398,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: program Execute an external program specified as the assigned - value. If no absolute path is given, the program is expected to live in - /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 /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. @@ -424,7 +426,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. @@ -433,14 +435,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. @@ -494,7 +496,7 @@ Import the stored keys from the parent device by reading the database entry of the parent device. The value assigned to is used as a filter of key names - to import (with the same shell-style pattern matching used for + to import (with the same shell glob pattern matching used for comparisons). @@ -536,17 +538,19 @@ - Apply the permissions specified in this rule to the static device node with - the specified name. Static device node creation can be requested by kernel modules. - These nodes might not have a corresponding kernel device at the time udevd is - started; they can trigger automatic kernel module loading. + Apply the permissions specified in this rule to the + static device node with the specified name. Static device node + creation can be requested by kernel modules. These nodes might + not have a corresponding kernel device at the time udevd is started; + they can trigger automatic kernel module loading. - 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. @@ -560,13 +564,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: , @@ -579,7 +585,8 @@ , The kernel number for this device. For example, - sda3 has kernel number 3. + sda3 has kernel number 3. + @@ -593,8 +600,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 . @@ -602,8 +610,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 + . @@ -612,12 +622,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. + @@ -645,7 +658,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 @@ -750,7 +764,8 @@ See Also - + + udevd8 , -- cgit v1.2.3-54-g00ecf