chiark / gitweb /
[PATCH] udevd-test.pl: remove wrong date calculation
[elogind.git] / udev.8.in
index a7f0bf03929993baabbdc946d3f0c99ad4be2070..07bd7bce3061138ddd003651342b1f4f770f6cb0 100644 (file)
--- a/udev.8.in
+++ b/udev.8.in
@@ -4,22 +4,24 @@ udev \- Linux configurable dynamic device naming support
 .SH SYNOPSIS
 .BI udev " hotplug-subsystem"
 .P
-The environment must provide the following variables:
+The following variables are read from the environment:
 .TP
 .B ACTION
 .IR add " or " remove
-signifies the connection or disconnection of a device.
-.TP
+signifies the addition or the removal of a device.
+.P
 .B DEVPATH
 The sysfs devpath of the device without the mountpoint but a leading slash.
 .P
-Additional optional environment variables:
-.TP
+.B SUBSYSTEM
+The subsystem the device belongs to. Alternatively the subsystem may
+be passed as the first argument.
+.P
 .B UDEV_CONFIG_FILE
 Overrides the default location of the
 .B udev
 config file.
-.TP
+.P
 .B UDEV_NO_DEVD
 The default behavior of
 .B udev
@@ -34,7 +36,6 @@ provides a dynamic device directory containing only the files for actually
 present devices. It creates or removes device node files usually located in
 the /dev directory, or it renames network interfaces.
 .br
-
 .P
 As part of the
 .B hotplug
@@ -57,7 +58,7 @@ queries its database for the name of the device file to be deleted.
 All
 .B udev
 configuration files consist of a set of lines of text.  All empty
-lines and lines beginning with a '#' will be ignored.
+lines or lines beginning with '#' will be ignored.
 .P
 
 .B udev
@@ -74,7 +75,7 @@ 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
@@ -90,22 +91,22 @@ All permission files are read in lexical order. The default value is
 .IR /etc/udev/permissions.d/ .
 .TP
 .B udev_log
-The switch, if udev logs some information for every device handled.
+The switch to enable/disable logging of udev information
 The default value is
 .IR yes .
 .TP
 .B default_mode
-The default mode for all nodes not explicitely matching in the permissions
+The default mode for all nodes not explicitly matching in the permissions
 file. The default value is
 .IR 0666 .
 .TP
 .B default_owner
-The default owner for all nodes not explicitely matching in the permissions
+The default owner for all nodes not explicitly matching in the permissions
 file. The default value is
 .IR root .
 .TP
 .B default_group
-The default group for all nodes not explicitely matching in the permissions
+The default group for all nodes not explicitly matching in the permissions
 file. The default value is
 .IR root .
 .br
@@ -117,7 +118,7 @@ file. The default value is
 udev_root="/udev"
 
 # udev_db - The name and location of the udev database
-udev_db="/udev/.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
@@ -131,19 +132,19 @@ udev_permissions="/etc/udev/udev.permissions"
 udev_log="yes"
 
 # default_mode - set the default mode for all nodes not
-#                explicitely matching in the permissions file
+#                explicitly matching in the permissions file
 default_mode="0666"
 
 # default_owner - set the default owner for all nodes not
-#                 explicitely matching in the permissions file
+#                 explicitly matching in the permissions file
 default_owner="root"
 
 # default_group - set the default group for all nodes not
-#                 explicitely matching in the permissions file
+#                 explicitly matching in the permissions file
 default_group="root"
 .fi
 .P
-The rules for device naming, are read from the files located in 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
@@ -171,6 +172,12 @@ Match the bus type of the device.
 .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
@@ -210,16 +217,23 @@ 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
+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
 specified by separating the names by the space character.
 .br
 If both the name and the symlink fields are omitted or its
-values empty, the device will be ignored and no node will be created.
+values are empty, the device will be ignored and no node will be created.
 .br
 If only the symlink field is given and the name field is omitted,
-the rule will not be applied immediatly, but the symlink field is added
+the rule will not be applied immediately, but the symlink field is added
 to the symlink list of the rule which will create the node.
 This makes it possible to specify additional symlinks in a possibly
 separate rules file, while the device nodes are maintained by the
@@ -230,7 +244,7 @@ The permissions for this device. Every specified value overwrites the value
 given in the permissions file.
 .P
 .RB "The " NAME " ," SYMLINK " and " PROGRAM
-fields support simple printf-like string substitution:
+fields support simple printf-like string substitutions:
 .TP
 .B %n
 The "kernel number" of the device.
@@ -249,7 +263,7 @@ The kernel minor number for the device.
 The bus id for the device.
 .TP
 .B %c
-The string returned from the execution of
+The string returned by the external program, specified in
 .B PROGRAM
 (This does not work within the
 .B PROGRAM
@@ -282,7 +296,7 @@ the first three characters of the sysfs attribute.
 .RI "A sample " udev.rules " might look like this:"
 .sp
 .nf
-# if /sbin/scsi_id returns "OEM 0815" device will be called disk1
+# if /sbin/scsi_id returns "OEM 0815", the device will be called disk1
 BUS="scsi", PROGRAM="/sbin/scsi_id", RESULT="OEM 0815", NAME="disk1"
 
 # USB printer to be called lp_color
@@ -312,7 +326,7 @@ KERNEL="hd[a-z]", PROGRAM="/bin/cat /proc/ide/%k/media", RESULT="cdrom",
 
 .fi
 .P
-The permissions and ownership of the created device file is read from
+The permissions and ownership of the created device file are read from
 the files located in the
 .I /etc/udev/permissions.d/
 directory, or at the location specified by the
@@ -349,20 +363,23 @@ 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. If the first character
-following the '[' is a '!', any character not enclosed is matched.
+following the '[' is a '!', any characters not enclosed are matched.
 .P
 After device node creation, removal, or network device renaming,
 .B udev
 executes the programs in the directory tree under
 .IR /etc/dev.d/ .
-The name of a program must end with
+The name of a program must have the suffix
 .I .dev
-suffix, to be recognized.
+to be recognized.
 .br
 In addition to the hotplug environment variables,
+.B UDEV_LOG
+is set if udev is configured to use the syslog facility. Executed programs may
+want to follow that setting.
 .B DEVNAME
 is exported to make the name of the created node, or the name the network
-device is renamed to, available to the executed program. The programs in every
+device is renamed to, available to the executed program.  The programs in every
 directory are sorted in lexical order, while the directories are searched in
 the following order:
 .sp