X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=udev.8;h=d7999aadfd182a686e3c17a063c52530e1bdc8e6;hp=3eb4aecad27b8adbbe3f92f1709d214cb867b10c;hb=167a27e70f4010fdce561cff2ea1a07730aae28a;hpb=f1db055ab2e349ce22254562faaece66d6a4a873

diff --git a/udev.8 b/udev.8
index 3eb4aecad..d7999aadf 100644
--- a/udev.8
+++ b/udev.8
@@ -3,9 +3,6 @@
 udev \- Linux configurable dynamic device naming support
 .SH SYNOPSIS
 .BI udev " hotplug-subsystem"
-.br
-.B udev
-.RI "[-q " sysfs_path "] [-rVh]"
 .SH "DESCRIPTION"
 .B udev
 creates or removes device node files usually located in the /dev directory.
@@ -21,35 +18,14 @@ 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.
-.SH "OPTIONS"
-.B udev
-normally is called by
-.B hotplug
-with the subsystem as argument and various environment variables set.
-.br
-It may also called with the following options:
-.TP
-.B -V
-Print the version information.
-.TP
-.B -r
-Print the the
-.B udev
-root directory.
-.TP
-.BI -q " sysfs_path"
-Query with the sysfs path as argument for the name of the created device node.
-.TP
-.B -h
-Print help text.
+queries its database for the name of the device file to be deleted.
 .SH "CONFIGURATION"
 All
 .B udev
@@ -59,7 +35,7 @@ lines, and lines beginning with a '#' will be ignored.
 
 .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:
@@ -67,24 +43,46 @@ 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
 .RI "A sample " udev.conf " might look like this:
@@ -96,15 +94,27 @@ 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"
 
+# 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
@@ -115,61 +125,57 @@ 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. One ore more optional symlinks targeting the node may be specified.
+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 configuration is found, the default kernel device name
-is used.
+If no matching rule is found, the default kernel device name is used.
 .P
 The line format is:
 .sp
-.I method, key,[key,...] name [, symlink]
+.I key,[key,...] name [, symlink]
 .sp
-where valid methods with corresponding keys are:
+where keys are:
 .TP
-.B CALLOUT
-calling external program, that returns a string to match.  The
 .B BUS
-key is optional, but if specified, the sysfs device bus must be able to be
-determined by a "device" symlink.
-.br
-.RB "keys: " BUS ", " PROGRAM ", " ID
+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.  Up to 5 different sysfs files can be checked, with
-all of the values being required in order to match the rule.  The
-.B BUS
-key is optional, but if specified, the sysfs device bus must be able to be
-detemined by a "device" symlink.
-.br
-.RB "keys: " BUS ", " SYSFS_
+.B KERNEL
+Match the kernel device name.
 .TP
-.B NUMBER
-device number on the bus, like PCI bus id
-.br
-.RB "keys: " BUS ", " ID
+.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
-.RB "keys: " BUS ", " PLACE
+.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
-.RB "key: " KERNEL
+.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 IGNORE
-tell udev to not care about creation of this device, e.g. because the
-device is already handled by another program
-.br
-.RB "key: " KERNEL
+.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:
-.BR IGNORE ", " CALLOUT ", " LABEL ", " NUMBER ", " TOPOLOGY ", " 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
 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 fields support simple printf-like string substitution:
@@ -191,37 +197,46 @@ The kernel minor number 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 'disc'.
+.B %%
+The '%' char itself.
 .P
 .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", SYSFS_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
-LABEL, BUS="scsi", SYSFS_vendor="IBM", SYSFS_model="ST336", NAME="boot%n"
+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 with two additional symlinks
-REPLACE, KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
+KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 
 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
-LABEL, BUS="usb", SYSFS_model="XV3", NAME="video%n", SYMLINK="webcam%n"
+BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
 .fi
 .P
 Permissions and ownership for the created device files may specified at
@@ -235,11 +250,6 @@ file.
 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
 pattern 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.
-.BR initrd "(4)), only numeric owner and group values may be used."
 .sp
 .RI "A sample " udev.permissions " might look like this:"
 .sp
@@ -274,6 +284,7 @@ following the '[' is a '!' then any character not enclosed is matched.
 .fi
 .LP
 .SH "SEE ALSO"
+.BR udevinfo (8),
 .BR hotplug (8)
 .PP
 The