-.\" ** You probably do not want to edit this file directly **
-.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
-.\" Instead of manually editing it, you probably should edit the DocBook XML
-.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.\" Title: udev
+.\" Author:
+.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
+.\" Date: August 2005
+.\" Manual: udev
+.\" Source: udev
+.\"
.PP
udev expects its main configuration file at
\fI/etc/udev/udev.conf\fR. It consists of a set of variables allowing the user to override default udev values. The following variables can be set:
.PP
udev expects its main configuration file at
\fI/etc/udev/udev.conf\fR. It consists of a set of variables allowing the user to override default udev values. The following variables can be set:
\fBudev_rules\fR
The name of the udev rules file or directory to look for files with the suffix
\fI.rules\fR. Multiple rule files are read in lexical order. The default value is
\fI/etc/udev/rules.d\fR.
\fBudev_rules\fR
The name of the udev rules file or directory to look for files with the suffix
\fI.rules\fR. Multiple rule files are read in lexical order. The default value is
\fI/etc/udev/rules.d\fR.
directory or at the location specified value in the configuraton file. Every line in the rules file contains at least one key value pair. There are two kind of keys, match and assignement keys. If all match keys are matching against its value, the rule gets applied and the assign keys get the specified value assigned. A matching rule may specify the name of the device node, add a symlink pointing to the node, or run a specified program as part of the event handling. If no matching rule is found, the default device node name is used.
.PP
A rule may consists of a list of one or more key value pairs separated by a comma. Each key has a distinct operation, depending on the used operator. Valid operators are:
directory or at the location specified value in the configuraton file. Every line in the rules file contains at least one key value pair. There are two kind of keys, match and assignement keys. If all match keys are matching against its value, the rule gets applied and the assign keys get the specified value assigned. A matching rule may specify the name of the device node, add a symlink pointing to the node, or run a specified program as part of the event handling. If no matching rule is found, the default device node name is used.
.PP
A rule may consists of a list of one or more key value pairs separated by a comma. Each key has a distinct operation, depending on the used operator. Valid operators are:
\fB:=\fR
Assign a value to a key finally; disallow any later changes, which may be used to prevent changes by any later rules.
.PP
The following key names can be used to match against device properties:
\fB:=\fR
Assign a value to a key finally; disallow any later changes, which may be used to prevent changes by any later rules.
.PP
The following key names can be used to match against device properties:
\fBSYSFS{\fR\fB\fIfilename\fR\fR\fB}\fR
Search the devpath upwards for a device with matching sysfs attribute values. Up to five
\fBSYSFS\fR
keys can be specified per rule. All attributes must match on the same device. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
\fBSYSFS{\fR\fB\fIfilename\fR\fR\fB}\fR
Search the devpath upwards for a device with matching sysfs attribute values. Up to five
\fBSYSFS\fR
keys can be specified per rule. All attributes must match on the same device. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
\fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
Match against the value of an environment variable. Up to five
\fBENV\fR
keys can be specified per rule. This key can also be used to export a variable to the environment.
\fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
Match against the value of an environment variable. Up to five
\fBENV\fR
keys can be specified per rule. This key can also be used to export a variable to the environment.
\fBPROGRAM\fR
Execute external program. The key is true, if the program returns without exit code zero. The whole event environment is available to the executed program. The program's output printed to stdout is available for the RESULT key.
\fBPROGRAM\fR
Execute external program. The key is true, if the program returns without exit code zero. The whole event environment is available to the executed program. The program's output printed to stdout is available for the RESULT key.
\fBRESULT\fR
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.
.PP
Most of the fields support a shell style pattern matching. The following pattern characters are supported:
\fBRESULT\fR
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.
.PP
Most of the fields support a shell style pattern matching. The following pattern characters are supported:
\fB[]\fR
Matches any single character specified within the brackets. example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. Ranges are also supported within this match with the '\-' character. For example, to match on the range of all digits, the pattern [0\-9] would be used. If the first character following the '[' is a '!', any characters not enclosed are matched.
.PP
The following keys can get values assigned:
\fB[]\fR
Matches any single character specified within the brackets. example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. Ranges are also supported within this match with the '\-' character. For example, to match on the range of all digits, the pattern [0\-9] would be used. If the first character following the '[' is a '!', any characters not enclosed are matched.
.PP
The following keys can get values assigned:
\fBNAME\fR
The name of the node to be created, or the name the network interface should be renamed to. Only one rule can set the node name, all later rules with a NAME key will be ignored.
\fBNAME\fR
The name of the node to be created, or the name the network interface should be renamed to. Only one rule can set the node name, all later rules with a NAME key will be ignored.
\fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
Export a variable to the environment. This key can also be used to match against an environment variable.
\fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
Export a variable to the environment. This key can also be used to match against an environment variable.
\fBIMPORT{\fR\fB\fItype\fR\fR\fB}\fR
Import the printed result or the value of a file in environment key format into the event environment.
\fBprogram\fR
will execute an external program and read its output.
\fBfile\fR
will inport a text file. If no option is given, udev will determine it from the executable bit of of the file permissions.
\fBIMPORT{\fR\fB\fItype\fR\fR\fB}\fR
Import the printed result or the value of a file in environment key format into the event environment.
\fBprogram\fR
will execute an external program and read its output.
\fBfile\fR
will inport a text file. If no option is given, udev will determine it from the executable bit of of the file permissions.
-fields support simple printf\-like string substitutions:
-.TP
+and
+\fBRUN\fR
+fields support simple printf\-like string substitutions. The
+\fBRUN\fR
+format chars gets applied after all rules have been processed, right before the program is executed. It allows the use of the complete environment set by earlier matching rules. For all other fields, substitutions are applied while the individual rule is being processed. The available substitutions are:
+.TP 3n
\fB$sysfs{\fR\fB\fIfile\fR\fR\fB}\fR, \fB%s{\fR\fB\fIfile\fR\fR\fB}\fR
The value of a sysfs attribute found at the current or a parent device.
\fB$sysfs{\fR\fB\fIfile\fR\fR\fB}\fR, \fB%s{\fR\fB\fIfile\fR\fR\fB}\fR
The value of a sysfs attribute found at the current or a parent device.
\fB$env{\fR\fB\fIkey\fR\fR\fB}\fR, \fB%E{\fR\fB\fIkey\fR\fR\fB}\fR
The value of an environment variable.
\fB$env{\fR\fB\fIkey\fR\fR\fB}\fR, \fB%E{\fR\fB\fIkey\fR\fR\fB}\fR
The value of an environment variable.
\fB$result\fR, \fB%c\fR
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:
\fB%c{N}\fR. If the number is followed by the '+' char this part plus all remaining parts of the result string are substituted:
\fB%c{N+}\fR
\fB$result\fR, \fB%c\fR
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:
\fB%c{N}\fR. If the number is followed by the '+' char this part plus all remaining parts of the result string are substituted:
\fB%c{N+}\fR
\fB$tempnode\fR, \fB%N\fR
The name of a created temporary device node to provide access to the device from a external program before the real node is created.
\fB$tempnode\fR, \fB%N\fR
The name of a created temporary device node to provide access to the device from a external program before the real node is created.
\fB$$\fR
The '$' character itself.
.PP
The count of characters to be substituted may be limited by specifying the format length value. For example, '%3s{file}' will only insert the first three characters of the sysfs attribute
\fB$$\fR
The '$' character itself.
.PP
The count of characters to be substituted may be limited by specifying the format length value. For example, '%3s{file}' will only insert the first three characters of the sysfs attribute
-.SH "ENVIRONMENT"
-.TP
-\fBACTION\fR
-\fIadd\fR
-or
-\fIremove\fR
-signifies the addition or the removal of a device.
-.TP
-\fBDEVPATH\fR
-The sysfs devpath without the mountpoint but a leading slash.
-.TP
-\fBSUBSYSTEM\fR
-The kernel subsystem the device belongs to.
-.TP
-\fBUDEV_LOG\fR
-Overrides the syslog priority specified in the config file.
+.\" end of SS subsection "Rules files"