rules: add v4l persistent links

[elogind.git] / udev.xml

diff --git a/udev.xml b/udev.xml
index bd099479f24a7f2eabdcf61a8052462a3ebcb9db..5eff452b771d9db52c45e99e2cd6516f9393f98f 100644 (file)
--- a/udev.xml
+++ b/udev.xml
@@ -30,11 +30,11 @@
 
         <para>Usually udev runs as <citerefentry><refentrytitle>udevd</refentrytitle>
         <manvolnum>8</manvolnum></citerefentry> and receives uevents directly from the
 
         <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.
 
         <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>
         node name and multiple symlink names and instruct udev to run additional programs
         as part of the device event handling.</para>
       </refsect1>


@@ -90,7 +90,7 @@
           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>
 
           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
+          <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>
           a comma. Each key has a distinct operation, depending on the used operator. Valid
           operators are:</para>
           <variablelist>


@@ -159,6 +159,15 @@
               </listitem>
             </varlistentry>
 
               </listitem>
             </varlistentry>
 

+            <varlistentry>
+              <term><option>NAME</option></term>
+              <listitem>
+                <para>Match the name of the node or network interface. It can
+                be used once the NAME key has been set in one of the preceding
+                rules.</para>
+              </listitem>
+            </varlistentry>
+

             <varlistentry>
               <term><option>SUBSYSTEM</option></term>
               <listitem>
             <varlistentry>
               <term><option>SUBSYSTEM</option></term>
               <listitem>


@@ -224,6 +233,14 @@
               </listitem>
             </varlistentry>
 
               </listitem>
             </varlistentry>
 

+            <varlistentry>
+              <term><option>TEST{<replaceable>octal mode mask</replaceable>}</option></term>
+              <listitem>
+                <para>Test the existence of a file. An octal mode mask can be specified
+                if needed.</para>
+              </listitem>
+            </varlistentry>
+

             <varlistentry>
               <term><option>PROGRAM</option></term>
               <listitem>
             <varlistentry>
               <term><option>PROGRAM</option></term>
               <listitem>


@@ -325,6 +342,12 @@
                 event process for a long period of time may block all further events for
                 this or a dependent device. Long running tasks need to be immediately
                 detached from the event process itself.</para>
                 event process for a long period of time may block all further events for
                 this or a dependent device. Long running tasks need to be immediately
                 detached from the event process itself.</para>

+                <para>If the specifiefd string starts with
+                <option>socket:<replaceable>path</replaceable></option>, all current event
+                values will be passed to the specified socket, as a message in the same
+                format the kernel sends an uevent. If the first character of the specified path
+                is an @ character, an abstract namespace socket is used, instead of an existing
+                socket file.</para>

               </listitem>
             </varlistentry>
 
               </listitem>
             </varlistentry>
 


@@ -374,36 +397,80 @@
                   </varlistentry>
                 </variablelist>
                 <para>If no option is given, udev will choose between <option>program</option>
                   </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>
                 permissions.</para>
               </listitem>
             </varlistentry>
 
             <varlistentry>

-              <term><option>WAIT_FOR_SYSFS</option></term>
+              <term><option>WAIT_FOR</option></term>

               <listitem>
               <listitem>

-                <para>Wait for the specified sysfs file of the device to be created. Can be used
-                to fight against kernel sysfs timing issues.</para>
+                <para>Wait for a file to become available.</para>

               </listitem>
             </varlistentry>
 
             <varlistentry>
               <term><option>OPTIONS</option></term>
               <listitem>
               </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>Do not remove the device node when the device goes away. 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>
+                  <varlistentry>
+                    <term><option>event_timeout=</option></term>
+                    <listitem>
+                      <para>Number of seconds an event will wait for operations to finish, before it
+                      will terminate itself.</para>
+                    </listitem>
+                  </varlistentry>
+                  <varlistentry>
+                    <term><option>string_escape=<replaceable>none|replace</replaceable></option></term>
+                    <listitem>
+                      <para>Usually control and other possibly unsafe characters are replaced
+                      in strings used for device naming. The mode of replacement can be specified
+                      with this option.</para>
+                    </listitem>
+                  </varlistentry>
+                </variablelist>

               </listitem>
             </varlistentry>
           </variablelist>
 
           <para>The <option>NAME</option>, <option>SYMLINK</option>, <option>PROGRAM</option>,
               </listitem>
             </varlistentry>
           </variablelist>
 
           <para>The <option>NAME</option>, <option>SYMLINK</option>, <option>PROGRAM</option>,

-          <option>OWNER</option>, <option>GROUP</option>  and  <option>RUN</option>
+          <option>OWNER</option>, <option>GROUP</option>, <option>MODE</option>  and  <option>RUN</option>

           fields support simple printf-like string substitutions. The <option>RUN</option>
           format chars gets applied after all rules have been processed, right before the program
           is executed. It allows the use of the complete environment set by earlier matching
           fields support simple printf-like string substitutions. The <option>RUN</option>
           format chars gets applied after all rules have been processed, right before the program
           is executed. It allows the use of the complete environment set by earlier matching


@@ -441,6 +508,15 @@
               </listitem>
             </varlistentry>
 
               </listitem>
             </varlistentry>
 

+            <varlistentry>
+              <term><option>$driver</option></term>
+              <listitem>
+                <para>The driver name of the device matched while searching the devpath upwards for
+                  <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
+                </para>
+              </listitem>
+            </varlistentry>
+

             <varlistentry>
               <term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term>
               <listitem>
             <varlistentry>
               <term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term>
               <listitem>


@@ -468,7 +544,7 @@
             </varlistentry>
 
             <varlistentry>
             </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>
               <listitem>
                 <para>The kernel minor number for the device.</para>
               </listitem>


@@ -492,6 +568,22 @@
               </listitem>
             </varlistentry>
 
               </listitem>
             </varlistentry>
 

+            <varlistentry>
+              <term><option>$name</option></term>
+              <listitem>
+                <para>The current name of the device node. If not changed by a rule, it is the
+                name of the kernel device.</para>
+              </listitem>
+            </varlistentry>
+
+            <varlistentry>
+              <term><option>$links</option></term>
+              <listitem>
+                <para>The current list of symlinks, separated by a space character. The value is
+                only set if an earlier rule assigned a value, or during a remove events.</para>
+              </listitem>
+            </varlistentry>
+

             <varlistentry>
               <term><option>$root</option>, <option>%r</option></term>
               <listitem>
             <varlistentry>
               <term><option>$root</option>, <option>%r</option></term>
               <listitem>


@@ -499,6 +591,13 @@
               </listitem>
             </varlistentry>
 
               </listitem>
             </varlistentry>
 

+            <varlistentry>
+              <term><option>$sys</option>, <option>%S</option></term>
+              <listitem>
+                <para>The sysfs mount point.</para>
+              </listitem>
+            </varlistentry>
+

             <varlistentry>
               <term><option>$tempnode</option>, <option>%N</option></term>
               <listitem>
             <varlistentry>
               <term><option>$tempnode</option>, <option>%N</option></term>
               <listitem>


@@ -530,7 +629,7 @@
       <refsect1><title>AUTHOR</title>
         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email> and
         Kay Sievers <email>kay.sievers@vrfy.org</email>. With much help from
       <refsect1><title>AUTHOR</title>
         <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email> and
         Kay Sievers <email>kay.sievers@vrfy.org</email>. With much help from

-        Dan  Stekloff <email>dsteklof@us.ibm.com</email> and many others.</para>
+        Dan Stekloff and many others.</para>

       </refsect1>
 
       <refsect1>
       </refsect1>
 
       <refsect1>


@@ -539,10 +638,7 @@
             <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
           </citerefentry>, 
           <citerefentry>
             <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
           </citerefentry>, 
           <citerefentry>

-            <refentrytitle>udevinfo</refentrytitle><manvolnum>8</manvolnum>
-          </citerefentry>, 
-          <citerefentry>
-            <refentrytitle>udevmonitor</refentrytitle><manvolnum>8</manvolnum>
+            <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>

         </citerefentry></para>
       </refsect1>
     </refentry>
         </citerefentry></para>
       </refsect1>
     </refentry>