Also merge into the top-level Makefile.am the simpler extras.

[elogind.git] / udev / udev.xml

diff --git a/udev/udev.xml b/udev/udev.xml
index 4c35e197911ee16b7b30e10d3ba8f99f537a4494..c34a106d208635f2ce24fc14582206456f04ffc2 100644 (file)
--- a/udev/udev.xml
+++ b/udev/udev.xml
@@ -8,14 +8,12 @@
     <refentry>
       <refentryinfo>
         <title>udev</title>
-        <date>August 2005</date>
         <productname>udev</productname>
       </refentryinfo>
 
       <refmeta>
         <refentrytitle>udev</refentrytitle>
         <manvolnum>7</manvolnum>
-        <refmiscinfo class="version"></refmiscinfo>
       </refmeta>
 
       <refnamediv>
@@ -90,7 +88,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>
 
-          <para>A rule may consist of a list of one or more key value pairs separated by
+          <para>A rule 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:</para>
           <variablelist>
@@ -104,7 +102,7 @@
             <varlistentry>
               <term><option>!=</option></term>
               <listitem>
-                <para>Compare for non-equality.</para>
+                <para>Compare for inequality.</para>
               </listitem>
             </varlistentry>
 
@@ -168,6 +166,16 @@
               </listitem>
             </varlistentry>
 
+            <varlistentry>
+              <term><option>SYMLINK</option></term>
+              <listitem>
+                <para>Match the name of a symlink targeting the node. It can
+                be used once a SYMLINK key has been set in one of the preceding
+                rules. There may be multiple symlinks; only one needs to match.
+                </para>
+              </listitem>
+            </varlistentry>
+
             <varlistentry>
               <term><option>SUBSYSTEM</option></term>
               <listitem>
@@ -297,7 +305,7 @@
             <varlistentry>
               <term><option>SYMLINK</option></term>
               <listitem>
-                <para>The name of a symlink targeting the node. Every matching rule can add
+                <para>The name of a symlink targeting the node. Every matching rule will add
                 this value to the list of symlinks to be created along with the device  node.
                 Multiple symlinks may be specified by separating the names by the space
                 character.</para>
@@ -323,7 +331,8 @@
             <varlistentry>
               <term><option>ENV{<replaceable>key</replaceable>}</option></term>
               <listitem>
-                <para>Set a device property value.</para>
+                <para>Set a device property value. Property names with a leading '.'
+                are not stored in the database or exported to external tool or events.</para>
               </listitem>
             </varlistentry>
 
@@ -334,7 +343,10 @@
                 device. This can only be used for very short running tasks. Running an
                 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>
+                detached from the event process itself. If the option
+                <option>RUN{<replaceable>fail_event_on_error</replaceable>}</option> is
+                specified, and the executed program returns non-zero, the event will be
+                marked as failed for a possible later handling.</para>
                 <para>If the specified 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
@@ -457,6 +469,13 @@
                       with this option.</para>
                     </listitem>
                   </varlistentry>
+                  <varlistentry>
+                    <term><option>watch</option></term>
+                    <listitem>
+                      <para>Watch the device node with inotify, when closed after being opened for
+                     writing, a change uevent will be synthesised.</para>
+                    </listitem>
+                  </varlistentry>
                 </variablelist>
               </listitem>
             </varlistentry>
@@ -613,9 +632,6 @@
               </listitem>
             </varlistentry>
           </variablelist>
-          <para>The count of characters to be substituted may be limited by specifying
-          the format length value. For example, '%3s{file}' will only
-          insert the first three characters of the sysfs attribute</para>
         </refsect2>
       </refsect1>