chiark / gitweb /
[PATCH] add net/atml and class/ppdev to the wait_for_sysfs exception list
[elogind.git] / udev.8.in
index 9c22f8aa633a9e78fb78717a031bfa230427d130..7bdf560970ff46ddd830fb80f3d1ba26da67fb83 100644 (file)
--- a/udev.8.in
+++ b/udev.8.in
@@ -4,29 +4,24 @@ udev \- Linux configurable dynamic device naming support
 .SH SYNOPSIS
 .BI udev " hotplug-subsystem"
 .P
 .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
 .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
 .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.
 .B UDEV_CONFIG_FILE
 Overrides the default location of the
 .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
+.P
 .B UDEV_NO_DEVD
 The default behavior of
 .B udev
 .B UDEV_NO_DEVD
 The default behavior of
 .B udev
@@ -41,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
 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
 .P
 As part of the
 .B hotplug
@@ -81,7 +75,7 @@ value is
 .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
 .TP
 .B udev_rules
 The name of the udev rules file or directory to look for files with the suffix
@@ -124,7 +118,7 @@ file. The default value is
 udev_root="/udev"
 
 # udev_db - The name and location of the udev database
 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
 
 # udev_rules - The name of the udev rules file or directory to look
                for files with the suffix .rules
@@ -178,6 +172,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 +217,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
@@ -342,17 +349,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
@@ -378,9 +374,12 @@ The name of a program must end with
 suffix, to be recognized.
 .br
 In addition to the hotplug environment variables,
 suffix, 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
 .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
 directory are sorted in lexical order, while the directories are searched in
 the following order:
 .sp