X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fudev.xml;h=d77cbb0e6ecf766a9629ccce6b73f28e5f8d7d6d;hp=ca8444c12cca59d44b789ec8eb5b36abb066ed5c;hb=edf2573743b25273bee020230a60f1a054b8ec60;hpb=84b6ad702e64db534f67ce32d4dd2fec00a16784 diff --git a/man/udev.xml b/man/udev.xml index ca8444c12..d77cbb0e6 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -30,7 +30,7 @@ udev - Linux dynamic device management + Dynamic device management Description @@ -54,7 +54,7 @@ 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 /usr/lib/udev/rules.d, the volatile runtime directory /run/udev/rules.d @@ -63,14 +63,12 @@ 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, - disables the rules file entirely. - - Rule files must have the extension .rules; other - extensions are ignored. + /usr/lib, pointing to /dev/null, + 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. @@ -115,6 +113,13 @@ + + -= + + Remove the value from a key that holds a list of entries. + + + := @@ -257,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 ouput + is available in the RESULT key. + This can only be used for very short-running foreground tasks. For details, see RUN. @@ -267,14 +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-style pattern matching. The following - pattern characters are supported: + Most of the fields support shell glob pattern matching and + alternate patterns. The following special characters are supported: * @@ -295,9 +301,18 @@ 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. + + + + | + + Separates alternative patterns. For example, the pattern string + abc|x* would match either abc + or x*. @@ -307,8 +322,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. @@ -342,6 +360,13 @@ + + SECLABEL{module} + + Applies the specified Linux Security Module label to the device node. + + + ATTR{key} @@ -355,7 +380,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). @@ -375,24 +401,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 - /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. @@ -401,7 +429,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. @@ -410,14 +438,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. @@ -471,7 +499,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). @@ -502,13 +530,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. - - @@ -520,21 +541,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. @@ -548,13 +572,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: , @@ -567,7 +593,8 @@ , The kernel number for this device. For example, - sda3 has kernel number 3. + sda3 has kernel number 3. + @@ -581,8 +608,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 . @@ -590,8 +618,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 + . @@ -600,12 +630,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. + @@ -633,7 +666,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 @@ -701,13 +735,53 @@ + Hardware Database Files + The hwdb files are read from the files located in the + system hwdb directory /usr/lib/udev/hwdb.d, + the volatile runtime directory /run/udev/hwdb.d + and the local administration directory /etc/udev/hwdb.d. + All hwdb 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 /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 + /usr/lib, pointing to /dev/null, + disables the hwdb file entirely. hwdb files must have the extension + .hwdb; other extensions are ignored. + + The hwdb file contains data records consisting of matches and + associated key-value pairs. Every record in the hwdb starts with one or + more match string, specifying a shell glob to compare the database + lookup string against. Multiple match lines are specified in additional + consecutive lines. Every match line is compared indivdually, they are + combined by OR. Every match line must start at the first character of + the line. + + The match lines are followed by one or more key-value pair lines, which + are recognized by a leading space character. The key name and value are separated + by =. An empty line signifies the end + of a record. Lines beginning with # are ignored. + + The content of all hwdb files is read by + udevadm8 + and compiled to a binary database located at /etc/udev/hwdb.bin. + During runtime only the binary database is used. + + See Also - + + systemd-udevd.service8 , udevadm8 - + , + + systemd.link5 + +