[PATCH] rename udev_lib to udev_utils and dev_d to udev_multiplex

[elogind.git] / udev.8.in

diff --git a/udev.8.in b/udev.8.in
index f803578968f201ff5dec78cc5442d6792ffdf6d5..728ddb1a45355c5d3abeb84e2d1599427092f3c5 100644 (file)
--- a/udev.8.in
+++ b/udev.8.in
@@ -20,13 +20,6 @@ Overrides the default location of the
 .B udev
 config file.
 .TP
 .B udev
 config file.
 .TP

-.B UDEV_NO_SLEEP
-The default behavior of
-.B udev
-is to wait until all the sysfs files of the device chain are populated. If set,
-.B udev
-will continue, regardless of the state of the device representation.
-.TP

 .B UDEV_NO_DEVD
 The default behavior of
 .B udev
 .B UDEV_NO_DEVD
 The default behavior of
 .B udev


@@ -77,24 +70,24 @@ in this file:
 .B udev_root
 Indicates where to place the device nodes in the filesystem. The default
 value is
 .B udev_root
 Indicates where to place the device nodes in the filesystem. The default
 value is

-.IR @udevdir@ .
+.IR @udevdir@/ .

 .TP
 .B udev_db
 The name and location of the udev database. The default value is
 .TP
 .B udev_db
 The name and location of the udev database. The default value is

-.IR @udevdir@/.udev.tdb .
+.IR @udevdir@/.udevdb .

 .TP
 .B udev_rules
 The name of the udev rules file or directory to look for files with the suffix
 .IR .rules .
 All rule files are read in lexical order. The default value is
 .TP
 .B udev_rules
 The name of the udev rules file or directory to look for files with the suffix
 .IR .rules .
 All rule files are read in lexical order. The default value is

-.IR /etc/udev/udev.rules .
+.IR /etc/udev/rules.d/ .

 .TP
 .B udev_permissions
 The name of the udev permission file or directory to look for files with the
 suffix
 .IR .permissions .
 All permission files are read in lexical order. The default value is
 .TP
 .B udev_permissions
 The name of the udev permission file or directory to look for files with the
 suffix
 .IR .permissions .
 All permission files are read in lexical order. The default value is

-.IR /etc/udev/udev.permissions .
+.IR /etc/udev/permissions.d/ .

 .TP
 .B udev_log
 The switch, if udev logs some information for every device handled.
 .TP
 .B udev_log
 The switch, if udev logs some information for every device handled.


@@ -121,17 +114,17 @@ file. The default value is
 .sp
 .nf
 # udev_root - where to place the device nodes in the filesystem
 .sp
 .nf
 # udev_root - where to place the device nodes in the filesystem

-udev_root="@udevdir@"
+udev_root="/udev"

 
 # udev_db - The name and location of the udev database
 
 # udev_db - The name and location of the udev database

-udev_db="@udevdir@/.udev.tdb"
+udev_db="/udev/.udevdb"

 
 # udev_rules - The name of the udev rules file or directory to look
                for files with the suffix .rules
 udev_rules="/etc/udev/rules.d/"
 
 
 # udev_rules - The name of the udev rules file or directory to look
                for files with the suffix .rules
 udev_rules="/etc/udev/rules.d/"
 

-# udev_permissions - The name of the udev permission file or directry to look
-                     for files with the suffix .permissions
+# udev_permissions - The name of the udev permission file or directory
+                     to look for files with the suffix .permissions

 udev_permissions="/etc/udev/udev.permissions"
 
 # udev_log - set to "yes" if you want logging, else "no"
 udev_permissions="/etc/udev/udev.permissions"
 
 # udev_log - set to "yes" if you want logging, else "no"


@@ -150,14 +143,14 @@ default_owner="root"
 default_group="root"
 .fi
 .P
 default_group="root"
 .fi
 .P

-The rules for udev to use when naming devices may specified in
-.I /etc/udev/udev.rules
-or by the
+The rules for device naming, are read from the files located in the
+.I /etc/udev/rules.d/
+directory, or at the location specified by the

 .I udev_rules
 value in the
 .I /etc/udev/udev.conf
 file.
 .I udev_rules
 value in the
 .I /etc/udev/udev.conf
 file.

-.P
+.br

 Every line in the rules file defines the mapping between device attributes
 and the device name. One or more keys are specified to match a rule with
 the current device. If all keys are matching, the rule will be applied and
 Every line in the rules file defines the mapping between device attributes
 and the device name. One or more keys are specified to match a rule with
 the current device. If all keys are matching, the rule will be applied and


@@ -178,6 +171,12 @@ Match the bus type of the device.
 .B KERNEL
 Match the kernel device name.
 .TP
 .B KERNEL
 Match the kernel device name.
 .TP

+.B SUBSYSTEM
+Match the kernel subsystem name.
+.TP
+.B DRIVER
+Match the kernel driver name.
+.TP

 .B ID
 Match the device number on the bus, like PCI bus id.
 .TP
 .B ID
 Match the device number on the bus, like PCI bus id.
 .TP


@@ -217,6 +216,13 @@ If given with the attribute
 .BR NAME{ all_partitions }
 it will  create all 15 partitions of a blockdevice.
 This may be useful for removable media devices.
 .BR NAME{ all_partitions }
 it will  create all 15 partitions of a blockdevice.
 This may be useful for removable media devices.

+.br
+If given with the attribute
+.BR NAME{ ignore_remove }
+it will will ignore any later remove event for this device.
+This may be useful as a workaround for broken device drivers.
+.sp
+Multiple attributes may be separated by comma.

 .TP
 .B SYMLINK
 The name of a symlink targeting the node. Multiple symlinks may be
 .TP
 .B SYMLINK
 The name of a symlink targeting the node. Multiple symlinks may be


@@ -272,6 +278,13 @@ all remaining parts of the result string are substituted:
 .BI %s{ filename }
 The content of a sysfs attribute.
 .TP
 .BI %s{ filename }
 The content of a sysfs attribute.
 .TP

+.B %e
+If a device node already exists with the name, the smallest positive
+decimal integer N is substituted such that the resulting name doesn't
+match an existing device node. Otherwise nothing is substituted. This
+can be used to create compatibility symlinks and enumerate devices of
+the same type originating from different kernel subsystems.
+.TP

 .B %%
 The '%' character itself.
 .P
 .B %%
 The '%' character itself.
 .P


@@ -302,11 +315,20 @@ KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 
 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"
 
 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 BUS="usb", SYSFS{model}="XV3", NAME="video%n", SYMLINK="webcam%n"

+
+# grouping of optical drives from multiple kernel subsystems
+KERNEL="sr*", NAME="%k", SYMLINK="cdrom%e"
+KERNEL="scd*", NAME="%k", SYMLINK="cdrom%e"
+KERNEL="pcd*", NAME="%k", SYMLINK="cdrom%e"
+KERNEL="hd[a-z]", PROGRAM="/bin/cat /proc/ide/%k/media", RESULT="cdrom",
+  NAME="%k", SYMLINK="cdrom%e"
+

 .fi
 .P
 .fi
 .P

-Permissions and ownership for the created device files may specified in
-.I /etc/udev/udev.permissions
-or by the
+The permissions and ownership of the created device file is read from
+the files located in the
+.I /etc/udev/permissions.d/
+directory, or at the location specified by the

 .I udev_permission
 value in the
 .I /etc/udev/udev.conf
 .I udev_permission
 value in the
 .I /etc/udev/udev.conf


@@ -326,17 +348,6 @@ video*:root:video:0660
 dsp1:::0666
 .fi
 .P
 dsp1:::0666
 .fi
 .P

-The value
-.I $local
-can be used instead of a specific username.  In that case, udev will determine
-the current local user at the time of device node creation and substitute
-that username as the owner of the new device node.  This is useful, for
-example, to let hot-plugged devices, such as cameras, be owned by the user at
-the current console.  Note that if no user is currently logged in, or if udev
-otherwise fails to determine a current user, the
-.I default_owner
-value is used in lieu.
-.P

 A number of different fields in the above configuration files support a simple
 form of shell style pattern matching. It supports the following pattern characters:
 .TP
 A number of different fields in the above configuration files support a simple
 form of shell style pattern matching. It supports the following pattern characters:
 .TP