X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=udev.xml;h=5eff452b771d9db52c45e99e2cd6516f9393f98f;hp=5ba3d3636cacdd20ab544b56375528fec36f10f7;hb=ec9611ddb50eba7e38a77372ff1d5137f491144a;hpb=7a17ca7e798bd97678eb5e053f710b35b4674250

diff --git a/udev.xml b/udev.xml
index 5ba3d3636..5eff452b7 100644
--- a/udev.xml
+++ b/udev.xml
@@ -159,6 +159,15 @@
               </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>
@@ -224,6 +233,14 @@
               </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>
@@ -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>
+                <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>
 
@@ -380,10 +403,9 @@
             </varlistentry>
 
             <varlistentry>
-              <term><option>WAIT_FOR_SYSFS</option></term>
+              <term><option>WAIT_FOR</option></term>
               <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>
 
@@ -408,8 +430,8 @@
                   <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>
+                      <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>
@@ -427,13 +449,28 @@
                       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>,
-          <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
@@ -471,6 +508,15 @@
               </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>
@@ -522,6 +568,22 @@
               </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>
@@ -529,6 +591,13 @@
               </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>
@@ -560,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
-        Dan  Stekloff <email>dsteklof@us.ibm.com</email> and many others.</para>
+        Dan Stekloff and many others.</para>
       </refsect1>
 
       <refsect1>
@@ -569,10 +638,7 @@
             <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>