chiark / gitweb /
[PATCH] put symlink only rules to the man page
[elogind.git] / udev.8
diff --git a/udev.8 b/udev.8
index 9eeff96d48f805e4809817cc8de317456677cb42..24ff4e28a964fca2ea698282ffaff7fe8ea1a4f9 100644 (file)
--- a/udev.8
+++ b/udev.8
@@ -25,7 +25,7 @@ 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 will continue, regardless of the state of the device representation.
+will continue, regardless of the state of the device representation.
 .SH "DESCRIPTION"
 .B udev
 creates or removes device node files usually located in the /dev directory.
@@ -178,6 +178,9 @@ Match the topological position on bus, like physical port of USB device
 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.
+.br
+Trailing whitespace characters in the sysfs attribute value are ignored, if
+the key doesn't have any trailing whitespace characters by itself.
 .TP
 .B PROGRAM
 Call external program. This key is valid if the program returns successful.
@@ -197,8 +200,7 @@ call. This key may used in any following rule after a
 call.
 .TP
 .B NAME
-The name of the node to be created. If the name field is omitted or its
-value is empty, the device will be ignored and no node will be created.
+The name of the node to be created.
 .br
 If given with the attribute
 .BR NAME{ all_partitions }
@@ -208,6 +210,16 @@ This may be useful for removable media devices.
 .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.
+.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
+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
+distribution provided rules file.
 .P
 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 fields support simple printf-like string substitution:
@@ -297,6 +309,17 @@ video*:root:video:0660
 dsp1:::0666
 .fi
 .P
+The value
+.I $local
+can be substituted for 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