X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=udev%2Fudevadm.xml;h=64e6f2aeb979a8828c3327895362e7f37d70da06;hp=2e02c305d920ac766d3b18082eb849eaae3573b2;hb=9060b066d9e7aaca9795010ac5fff61018947f87;hpb=7d563a17f3967890331daf08d43f2f005418139b

diff --git a/udev/udevadm.xml b/udev/udevadm.xml
index 2e02c305d..64e6f2aeb 100644
--- a/udev/udevadm.xml
+++ b/udev/udevadm.xml
@@ -24,7 +24,13 @@
 
       <refsynopsisdiv>
         <cmdsynopsis>
-          <command>udevadm info <optional>options</optional></command>
+          <command>udevadm</command>
+            <arg><option>--debug</option></arg>
+            <arg><option>--version</option></arg>
+            <arg><option>--help</option></arg>
+        </cmdsynopsis>
+        <cmdsynopsis>
+          <command>udevadm info <replaceable>options</replaceable></command>
         </cmdsynopsis>
         <cmdsynopsis>
           <command>udevadm trigger <optional>options</optional></command>
@@ -41,12 +47,6 @@
         <cmdsynopsis>
           <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
         </cmdsynopsis>
-        <cmdsynopsis>
-          <command>udevadm version</command>
-        </cmdsynopsis>
-        <cmdsynopsis>
-          <command>udevadm help</command>
-        </cmdsynopsis>
       </refsynopsisdiv>
 
       <refsect1><title>DESCRIPTION</title>
@@ -56,6 +56,26 @@
       </refsect1>
 
       <refsect1><title>OPTIONS</title>
+        <variablelist>
+          <varlistentry>
+            <term><option>--debug</option></term>
+            <listitem>
+              <para>Print debug messages to stderr.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>--version</option></term>
+            <listitem>
+              <para>Print version number.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>--help</option></term>
+            <listitem>
+              <para>Print help text.</para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
 
         <refsect2><title>udevadm info <replaceable>options</replaceable></title>
           <para>Queries the udev database for device information
@@ -70,7 +90,7 @@
                 <option>--path</option> or <option>--name</option> to identify the specified
                 device. Valid queries are:
                 <command>name</command>, <command>symlink</command>, <command>path</command>,
-                <command>env</command>, <command>all</command>.</para>
+                <command>property</command>, <command>all</command>.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
@@ -130,7 +150,7 @@
         </refsect2>
 
         <refsect2><title>udevadm trigger <optional>options</optional></title>
-          <para>Request device uevents, usually used to replay events at system coldplug.</para>
+          <para>Request device events from the kernel. Usually used to replay events at system coldplug time.</para>
           <variablelist>
             <varlistentry>
               <term><option>--verbose</option></term>
@@ -145,15 +165,17 @@
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--retry-failed</option></term>
+              <term><option>--type=<replaceable>type</replaceable></option></term>
               <listitem>
-                <para>Trigger only the events which are failed during a previous run.</para>
+                <para>Trigger a specific type of devices. Valid types are:
+                <command>devices</command>, <command>subsystems</command>, <command>failed</command>.
+                The default value is <command>devices</command>.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
               <term><option>--action=<replaceable>action</replaceable></option></term>
               <listitem>
-                <para>Type of event to be triggered. The default value is "add".</para>
+                <para>Type of event to be triggered. The default value is <command>add</command>.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
@@ -189,20 +211,10 @@
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--socket=<replaceable>path</replaceable></option></term>
+              <term><option>--property-match=<replaceable>property</replaceable>=<replaceable>value</replaceable></option></term>
               <listitem>
-                <para>Pass the synthesized events to the specified socket, instead of triggering
-                a global kernel event. All available event values will be send in the same format
-                the kernel sends an uevent, or <option>RUN+="socket:<replaceable>path</replaceable>"</option>
-                sends a message. 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>
-            <varlistentry>
-              <term><option>--env=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
-              <listitem>
-                <para>Pass an additional environemt key to the event. This works only with the
-                --socket option.</para>
+                <para>Trigger events for devices with a matching property value. This option can be
+                specified multiple times and supports shell style pattern matching.</para>
               </listitem>
             </varlistentry>
           </variablelist>
@@ -215,7 +227,32 @@
               <term><option>--timeout=<replaceable>seconds</replaceable></option></term>
               <listitem>
                 <para>Maximum number of seconds to wait for the event queue to become empty.
-                The default value is 180 seconds.</para>
+                The default value is 180 seconds. A value of 0 will check if the queue is empty
+                and always return immediately.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--seq-start=<replaceable>seqnum</replaceable></option></term>
+              <listitem>
+                <para>Wait only for events after the given sequence number.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--seq-end=<replaceable>seqnum</replaceable></option></term>
+              <listitem>
+                <para>Wait only for events before the given sequence number.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--exit-if-exists=<replaceable>file</replaceable></option></term>
+              <listitem>
+                <para>Stop waiting if file exists.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--quiet</option></term>
+              <listitem>
+                <para>Do not print any output, like the remaining queue entries when reaching the timeout.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
@@ -254,13 +291,16 @@
             <varlistentry>
               <term><option>--reload-rules</option></term>
               <listitem>
-                <para>Signal udevd to reload the rules from the config.</para>
+                <para>Signal udevd to reload the rules files.
+                The udev daemon detects changes automatically, this option is
+                usually not needed. Reloading rules does not apply any changes
+                to already existing devices.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--env=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
+              <term><option>--property=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
               <listitem>
-                <para>Set global variable.</para>
+                <para>Set a global property for all events.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
@@ -270,13 +310,6 @@
                 same time.</para>
               </listitem>
             </varlistentry>
-            <varlistentry>
-              <term><option>--max-childs-running=<replaceable>value</replaceable></option></term>
-              <listitem>
-                <para>Set the maximum number of events, which are allowed to run at the
-                same time.</para>
-              </listitem>
-            </varlistentry>
             <varlistentry>
               <term><option>--help</option></term>
               <listitem>
@@ -292,13 +325,6 @@
           event timing, by comparing the timestamps of the kernel uevent and the udev event.
           </para>
           <variablelist>
-            <varlistentry>
-              <term><option>--environment</option></term>
-              <listitem>
-                <para>Print the complete environment for all events. Can be used to compare the
-                kernel supplied and the udev added environment values.</para>
-              </listitem>
-            </varlistentry>
             <varlistentry>
               <term><option>--kernel</option></term>
               <listitem>
@@ -311,6 +337,12 @@
                 <para>Print the udev event after the rule processing.</para>
               </listitem>
             </varlistentry>
+            <varlistentry>
+              <term><option>--property</option></term>
+              <listitem>
+                <para>Also print the properties of the event.</para>
+              </listitem>
+            </varlistentry>
             <varlistentry>
               <term><option>--help</option></term>
               <listitem>
@@ -321,8 +353,7 @@
         </refsect2>
 
         <refsect2><title>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></title>
-          <para>Simulate a udev event run for the given device, and print out debug
-          output. Unless forced to, no device node or symlink will be created.</para>
+          <para>Simulate a udev event run for the given device, and print debug output.</para>
           <variablelist>
             <varlistentry>
               <term><option>--action=<replaceable>string</replaceable></option></term>
@@ -336,13 +367,6 @@
                 <para>The subsystem string.</para>
               </listitem>
             </varlistentry>
-            <varlistentry>
-              <term><option>--force</option></term>
-              <listitem>
-                <para>Force the creation of a device node or symlink. Usually the test run
-                prints only debug output.</para>
-              </listitem>
-            </varlistentry>
             <varlistentry>
               <term><option>--help</option></term>
               <listitem>
@@ -351,14 +375,6 @@
             </varlistentry>
           </variablelist>
         </refsect2>
-
-        <refsect2><title>udevadm version</title>
-          <para>Print version number.</para>
-        </refsect2>
-
-        <refsect2><title>udevadm help</title>
-          <para>Print help text.</para>
-        </refsect2>
       </refsect1>
 
       <refsect1><title>AUTHOR</title>