chiark / gitweb /
man: add note about parent matching behavior
authorKay Sievers <kay.sievers@suse.de>
Sun, 25 Feb 2007 00:26:53 +0000 (01:26 +0100)
committerKay Sievers <kay.sievers@suse.de>
Sun, 25 Feb 2007 00:26:53 +0000 (01:26 +0100)
udev.7
udev.xml

diff --git a/udev.7 b/udev.7
index 207214821d3c740aa013cea1eee45da7c895357a..7dd3c1f2b7dc82111eb277f05dd5737921c49fa6 100644 (file)
--- a/udev.7
+++ b/udev.7
@@ -57,7 +57,9 @@ and
 .PP
 The udev rules are read from the files located in the
 \fI/etc/udev/rules.d\fR
-directory or at the location specified value in the configuration file. Every line in the rules file contains at least one key value pair. There are two kind of keys, match and assignment keys. If all match keys are matching against its value, the rule gets applied and the assign keys get the specified value assigned. A matching rule may specify the name of the device node, add a symlink pointing to the node, or run a specified program as part of the event handling. If no matching rule is found, the default device node name is used.
+directory or at the location specified value in the configuration file. Every line in the rules file contains at least one key value pair. There are two kind of keys, match and assignment keys. If all match keys are matching against its value, the rule gets applied and the assign keys get the specified value assigned.
+.PP
+A matching rule may specify the name of the device node, add a symlink pointing to the node, or run a specified program as part of the event handling. If no matching rule is found, the default device node name is used.
 .PP
 A rule may consists of a list of one or more key value pairs separated by a comma. Each key has a distinct operation, depending on the used operator. Valid operators are:
 .PP
@@ -86,7 +88,7 @@ Add the value to a key that holds a list of entries.
 Assign a value to a key finally; disallow any later changes, which may be used to prevent changes by any later rules.
 .RE
 .PP
-The following key names can be used to match against device properties:
+The following key names can be used to match against device properties. Some of the keys also match against properties of the parent devices in sysfs, not only the device that has generated the event. If multiple keys that match a parent device are specified in a single rule, all these keys must match at one and the same parent device.
 .PP
 \fBACTION\fR
 .RS 4
@@ -108,6 +110,11 @@ Match the name of the event device.
 Match the subsystem of the event device.
 .RE
 .PP
+\fBDRIVER\fR
+.RS 4
+Match the driver name of the event device. Only set for devices which are bound to a driver at the time the event is generated.
+.RE
+.PP
 \fBATTR{\fR\fB\fIfilename\fR\fR\fB}\fR
 .RS 4
 Match sysfs attribute values of the event device. Up to five
@@ -134,7 +141,7 @@ Search the devpath upwards for a matching device driver name.
 .RS 4
 Search the devpath upwards for a device with matching sysfs attribute values. Up to five
 \fBATTRS\fR
-keys can be specified per rule. All attributes must match on the same device. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
+keys can be specified per rule, but all of them must match on the same device. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
 .RE
 .PP
 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
index 5e5388da51cd691df38e56678f90b88ac5940e8e..68edb8fb99000826084c8f74392c401bd1a5cd09 100644 (file)
--- a/udev.xml
+++ b/udev.xml
           value in the configuration file. Every line in the rules file contains at least
           one key value pair. There are two kind of keys, match and assignment keys.
           If all match keys are matching against its value, the rule gets applied and the
-          assign keys get the specified value assigned. A matching rule may specify the
-          name of the device node, add a symlink pointing to the node, or run a specified
-          program as part of the event handling. If no matching rule is found, the default
-          device node name is used.</para>
+          assign keys get the specified value assigned.</para>
+
+          <para>A matching rule may specify the name of the device node, add a symlink
+          pointing to the node, or run a specified program as part of the event handling.
+          If no matching rule is found, the default device node name is used.</para>
 
           <para>A rule may consists of a list of one or more key value pairs separated by
           a comma. Each key has a distinct operation, depending on the used operator. Valid
             </varlistentry>
           </variablelist>
 
-          <para>The following key names can be used to match against device properties:</para>
+          <para>The following key names can be used to match against device properties.
+          Some of the keys also match against properties of the parent devices in sysfs,
+          not only the device that has generated the event. If multiple keys that match
+          a parent device are specified in a single rule, all these keys must match at
+          one and the same parent device.</para>
           <variablelist>
             <varlistentry>
               <term><option>ACTION</option></term>
                 <para>Match the subsystem of the event device.</para>
               </listitem>
             </varlistentry>
-<!--
             <varlistentry>
               <term><option>DRIVER</option></term>
               <listitem>
-                <para>Match the driver name of the event device. Only set for devices created by a bus driver.</para>
+                <para>Match the driver name of the event device. Only set for devices
+                which are bound to a driver at the time the event is generated.</para>
               </listitem>
             </varlistentry>
--->
             <varlistentry>
               <term><option>ATTR{<replaceable>filename</replaceable>}</option></term>
               <listitem>
               <term><option>ATTRS{<replaceable>filename</replaceable>}</option></term>
               <listitem>
                 <para>Search the devpath upwards for a device with matching sysfs attribute values.
-                Up to five <option>ATTRS</option> keys can be specified per rule. All attributes
+                Up to five <option>ATTRS</option> keys can be specified per rule, but all of them
                 must match on the same device. Trailing whitespace in the attribute values is ignored,
                 if the specified match value does not contain trailing whitespace itself.</para>
               </listitem>