chiark / gitweb /
man: add "link_priority" option
[elogind.git] / udev.xml
index 5e5388da51cd691df38e56678f90b88ac5940e8e..5ba3d3636cacdd20ab544b56375528fec36f10f7 100644 (file)
--- a/udev.xml
+++ b/udev.xml
 
         <para>Usually udev runs as <citerefentry><refentrytitle>udevd</refentrytitle>
         <manvolnum>8</manvolnum></citerefentry> and receives uevents directly from the
-        kernel if a device is added or removed form the system.</para>
+        kernel if a device is added or removed from the system.</para>
 
         <para>If udev receives a device event, it matches its configured rules
         against the available device attributes provided in sysfs to identify the device.
-        Rules that match, may provide additional device information or specify a device
+        Rules that match may provide additional device information or specify a device
         node name and multiple symlink names and instruct udev to run additional programs
         as part of the device event handling.</para>
       </refsect1>
           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 rule may consists of a list of one or more key value pairs separated by
+          <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 consist 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:</para>
           <variablelist>
             </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>
               <term><option>PROGRAM</option></term>
               <listitem>
                 <para>Execute external program. The key is true, if the program returns
-                without exit code zero. The whole event environment is available to the
-                executed program. The program's output printed to stdout is available for
+                with exit code zero. The whole event environment is available to the
+                executed program. The program's output printed to stdout, is available in
                 the RESULT key.</para>
               </listitem>
             </varlistentry>
                   </varlistentry>
                 </variablelist>
                 <para>If no option is given, udev will choose between <option>program</option>
-                and <option>file</option> based on the executable bit of of the file
+                and <option>file</option> based on the executable bit of the file
                 permissions.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
               <term><option>OPTIONS</option></term>
               <listitem>
-                <para><option>last_rule</option> stops further rules application. No later rules
-                will have any effect.
-                <option>ignore_device</option> will ignore this event completely.
-                <option>ignore_remove</option> will ignore  any  later  remove  event  for  this
-                device. This may be useful as a workaround for broken device drivers.
-                <option>all_partitions</option> will create the device nodes for all available
-                partitions of a block device. This may be useful for removable media devices where
-                media changes are not detected.</para>
+                <para>Rule and device options:</para>
+                <variablelist>
+                  <varlistentry>
+                    <term><option>last_rule</option></term>
+                    <listitem>
+                      <para>Stops further rules application. No later rules will have
+                      any effect.</para>
+                    </listitem>
+                  </varlistentry>
+                  <varlistentry>
+                    <term><option>ignore_device</option></term>
+                    <listitem>
+                      <para>Ignore this event completely.</para>
+                    </listitem>
+                  </varlistentry>
+                  <varlistentry>
+                    <term><option>ignore_remove</option></term>
+                    <listitem>
+                      <para>Ignore any later remove event for this device. This may be useful
+                      as a workaround for broken device drivers.</para>
+                    </listitem>
+                  </varlistentry>
+                  <varlistentry>
+                    <term><option>link_priority=<replaceable>value</replaceable></option></term>
+                    <listitem>
+                      <para>Specify the priority of the created symlinks. Devices with higher
+                      priorities overwrite existing symlinks of other devices.</para>
+                    </listitem>
+                  </varlistentry>
+                  <varlistentry>
+                    <term><option>all_partitions</option></term>
+                    <listitem>
+                      <para>Create the device nodes for all available partitions of a block device.
+                      This may be useful for removable media devices where media changes are not
+                      detected.</para>
+                    </listitem>
+                  </varlistentry>
+                </variablelist>
               </listitem>
             </varlistentry>
           </variablelist>
             </varlistentry>
 
             <varlistentry>
-              <term><option>$minor</option> <option>%m</option></term>
+              <term><option>$minor</option>, <option>%m</option></term>
               <listitem>
                 <para>The kernel minor number for the device.</para>
               </listitem>