X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=udev.8;h=d7999aadfd182a686e3c17a063c52530e1bdc8e6;hp=bac35b091d53447c10d4d56a333c3b63408fb839;hb=167a27e70f4010fdce561cff2ea1a07730aae28a;hpb=fc1f0d43267be8bfc1a4afd79532e081921589e1 diff --git a/udev.8 b/udev.8 index bac35b091..d7999aadf 100644 --- a/udev.8 +++ b/udev.8 @@ -18,22 +18,24 @@ On device creation, .B udev reads the sysfs directory of the given device to collect device attributes like label, serial number or bus device number. -These attributes are treated as a key -to determine a unique name for device file creation. +These attributes may used as keys to determine a +unique name for device file creation. .B udev maintains a database for devices present on the system. .br On device removal, .B udev -queries the internal database for the name of the device file to be deleted. +queries its database for the name of the device file to be deleted. .SH "CONFIGURATION" -All udev configuration files consist of a set of lines of text. All empty +All +.B udev +configuration files consist of a set of lines of text. All empty lines, and lines beginning with a '#' will be ignored. .P .B udev expects its main configuration file at -.I /etc/udev/udev.conf. +.IR /etc/udev/udev.conf . The file consists of a set of variables and values that allow the user to override default udev values. The current set of variables that can be overridden in this file is: @@ -41,27 +43,49 @@ overridden in this file is: .B udev_root This is the where in the filesystem to place the device nodes. The default value for this is -.I /udev/ +.IR /udev/ . .TP .B udev_db The name and location of the udev database. The default value for this is -.I /udev/.udev.tdb +.IR /udev/.udev.tdb . .TP .B udev_rules This is the location of the udev rules file. The default value for this is -.I /etc/udev/udev.rules +.IR /etc/udev/udev.rules . +If a directory is specified, the whole directory is +scanned for files ending with +.I .rules +and all rule files are read in lexical order. .TP .B udev_permissions -This is the location of the udev permission file. The default value for this is -.I /etc/udev/udev.permissions +This is the location of the udev permission file. The default value for this is +.IR /etc/udev/udev.permissions . +If a directory is specified, the whole directory is scanned for files ending with +.I .permissions +and all permission files are read in lexical order. +.TP +.B udev_log +If you want udev to log some information to the syslog for every node created or +removed. The default value for this is +.IR yes . .TP .B default_mode This is the default mode for all nodes that have no explicit match in the permissions file. The default value for this is -.I 0666 +.IR 0666 . +.TP +.B default_owner +This is the default owner for all nodes that have no explicit match in the +permissions file. The default value for this is +.IR root . +.TP +.B default_group +This is the default group for all nodes that have no explicit match in the +permissions file. The default value for this is +.IR root . .br .P -A sample \fIudev.conf\fP might look like this: +.RI "A sample " udev.conf " might look like this: .sp .nf # udev_root - where in the filesystem to place the device nodes @@ -70,147 +94,164 @@ udev_root="/udev/" # udev_db - The name and location of the udev database. udev_db="/udev/.udev.tdb" -# udev_rules - The name and location of the udev rules file -udev_rules="/etc/udev/udev.rules" +# udev_rules - The location of the directory where to look for files + which names ending with .rules +udev_rules="/etc/udev/" # udev_permissions - The name and location of the udev permission file udev_permissions="/etc/udev/udev.permissions" -# default_mode - set the default mode for all nodes that have no +# udev_log - set to "yes" if you want logging, else "no" +udev_log="yes" + +# default_mode - set the default mode for all nodes that have no # explicit match in the permissions file default_mode="0666" + +# default_owner - set the default owner for all nodes that have no +# explicit match in the permissions file +default_owner="root" + +# default_group - set the default group for all nodes that have no +# explicit match in the permissions file +default_group="root" .fi .P The rules for udev to use when naming devices may specified at .I /etc/udev/udev.rules -or specified by the +or specified by the .I udev_rules -value in the +value in the .I /etc/udev/udev.conf file. .P -Every line in the rules file define the mapping between device attributes and -the device file name. It starts with a keyword defining the method used to -match, followed by one ore more keys to compare and the filename for the -device. If no matching configuration is found, the default kernel device name -is used. +Every line in the rules file defines the mapping between device attributes +and the device file name. One ore more keys are specified to match a rule +with the current device. If all keys are matching, the rule will be applied +and the name is used for the device node. One or more optional symlinks +targeting the node may be specified. +.br +If no matching rule is found, the default kernel device name is used. .P The line format is: -.RS .sp -.I method, key,[key,...] name +.I key,[key,...] name [, symlink] .sp -.RE -where valid methods with corresponding keys are: +where keys are: .TP -.B CALLOUT -calling external program, that returns a string to match -.br -keys: \fBBUS\fP, \fBPROGRAM\fP, \fBID\fP +.B BUS +Match the bus type of the device. +(The sysfs device bus must be able to be determined by a "device" symlink.) .TP -.B LABEL -device label or serial number, like USB serial number, SCSI UUID or -file system label -.br -keys: \fBBUS\fP, \fIsysfs_attribute\fP +.B KERNEL +Match the kernel device name. .TP -.B NUMBER -device number on the bus, like PCI bus id -.br -keys: \fBBUS\fP, \fBID\fP +.B ID +Match the device number on the bus, like PCI bus id. .TP -.B TOPOLOGY -device position on bus, like physical port of USB device -.br -keys: \fBBUS\fP, \fBPLACE\fP +.B PLACE +Match the topological position on bus, like physical port of USB device .TP -.B REPLACE -string replacement of the kernel device name -.br -key: \fBKERNEL_NAME\fP +.BI SYSFS{ filename } +Match sysfs device attribute like label, vendor, USB serial number, SCSI UUID +or file system label. Up to 5 different sysfs files can be checked, with +all of the values being required in order to match the rule. +.TP +.B PROGRAM +Call external program. This key is valid if the program returns successful. +The string returned by the program may additionally matched with the +.B RESULT +key. +.TP +.B RESULT +Match the returned string of the last +.B PROGRAM +call. This key may used in any following rule after a +.B PROGRAM +call. .P -The methods are applied in the following order: -.B CALLOUT -, -.B LABEL -, -.B NUMBER -, -.B TOPOLOGY -, -.B REPLACE +The +.B NAME +field given with the attribute +.BR NAME{ all_partitions } +will create all 15 partitions of a blockdevice. +This may be useful for removable media devices. .P -The -.B NAME -and -.B PROGRAM -fields support simple printf-like string subtitution: -.RS +.RB "The " NAME " ," SYMLINK " and " PROGRAM +fields support simple printf-like string substitution: .TP .B %n -the "kernel number" of the device +The "kernel number" of the device. for example, 'sda3' has a "kernel number" of '3' .TP +.B %k +The "kernel name" for the device. +.TP .B %M -the kernel major number for the device +The kernel major number for the device. .TP .B %m -the kernel minor number for the device +The kernel minor number for the device. .TP .B %b -the bus id for the device +The bus id for the device. .TP .B %c -the CALLOUT program returned string -(this does not work within the PROGRAM field for the obvious reason.) +The +.B PROGRAM +returned string. +(This does not work within the +.B PROGRAM +field for the obvious reason.) +.br +A single part of the string, separated by the space character +my be selected by specifying the part number as a attribute: +.BI %c{ part } +.TP +.BI %s{ filename } +The content of a sysfs attribute. .TP -.B %D -Use the devfs style disk name for this device. -For partitions, this will result in 'part%n' -If this is not a partition, it will result in 'disk' -.RE +.B %% +The '%' char itself. .P -A sample \fIudev.rules\fP might look like this: +.RI "A sample " udev.rules " might look like this:" .sp .nf # if /sbin/scsi_id returns "OEM 0815" device will be called disk1 -CALLOUT, BUS="scsi", PROGRAM="/sbin/scsi_id", ID="OEM 0815", NAME="disk1" +BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1" # USB printer to be called lp_color -LABEL, BUS="usb", serial="W09090207101241330", NAME="lp_color" +BUS="usb", SYSFS{serial}="W09090207101241330", NAME="lp_color" + +# SCSI disk with a specific vendor and model number is to be called boot +BUS="scsi", SYSFS{vendor}="IBM", SYSFS{model}="ST336", NAME="boot%n" # sound card with PCI bus id 00:0b.0 to be called dsp -NUMBER, BUS="pci", ID="00:0b.0", NAME="dsp" +BUS="pci", ID="00:0b.0", NAME="dsp" # USB mouse at third port of the second hub to be called mouse1 -TOPOLOGY, BUS="usb", PLACE="2.3", NAME="mouse1" +BUS="usb", PLACE="2.3", NAME="mouse1" -# ttyUSB1 should always be called pda -REPLACE, KERNEL="ttyUSB1", NAME="pda" +# ttyUSB1 should always be called pda with two additional symlinks +KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld" -# USB webcams to be called webcam0, webcam1, ... -LABEL, BUS="usb", model="WebCam Version 3", NAME="webcam%n" +# multiple USB webcams with symlinks to be called webcam0, webcam1, ... +BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n" .fi .P Permissions and ownership for the created device files may specified at .I /etc/udev/udev.permissions -or specified by the +or specified by the .I udev_permission -value in the +value in the .I /etc/udev/udev.conf file. .br Every line lists a device name followed by owner, group and permission mode. All values are separated by colons. The name field may contain a -wildcard to apply the values to a whole class of devices. -.br -If -.B udev -was built using klibc or is used before the user database is accessible (e.g. -.B initrd -), only numeric owner and group values may be used. +pattern to apply the values to a whole class of devices. .sp -A sample \fIudev.permissions\fP might look like this: +.RI "A sample " udev.permissions " might look like this:" .sp .nf #name:user:group:mode @@ -221,9 +262,7 @@ dsp1:::0666 .fi .P A number of different fields in the above configuration files support a simple -form of wildcard matching. This form is based on the fnmatch(3) style, and -supports the following fields: -.RS +form of shell style pattern matching. It supports the following pattern characters: .TP .B * Matches zero, one, or more characters. @@ -235,18 +274,17 @@ Matches any single character, but does not match zero characters. Matches any single character specified within the brackets. For 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. -.RE +the range of all digits, the pattern [0-9] would be used. If the first character +following the '[' is a '!' then any character not enclosed is matched. .SH "FILES" .nf -.ft B -.ft /sbin/udev udev program /etc/udev/* udev config files /etc/hotplug.d/default/udev.hotplug hotplug symlink to udev program .fi .LP .SH "SEE ALSO" +.BR udevinfo (8), .BR hotplug (8) .PP The