X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=udev%2Fudevadm.xml;h=9d905abd0c9d34806e0e91844dda2d2c38b24849;hp=670c991457145e7c53b62a47ead133101b6efb4b;hb=b822542608326092e177fd1707ca7fb53b2846c4;hpb=726687ad48bdececed1e7e44387c50e009e28208

diff --git a/udev/udevadm.xml b/udev/udevadm.xml
index 670c99145..9d905abd0 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>
@@ -33,7 +39,7 @@
           <command>udevadm settle <optional>options</optional></command>
         </cmdsynopsis>
         <cmdsynopsis>
-          <command>udevadm control <optional>options</optional> <replaceable>instruction</replaceable></command>
+          <command>udevadm control <replaceable>command</replaceable></command>
         </cmdsynopsis>
         <cmdsynopsis>
           <command>udevadm monitor <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
@@ -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>
@@ -188,23 +210,6 @@
                 of the sysfs attribute is checked. This option can be specified multiple times.</para>
               </listitem>
             </varlistentry>
-            <varlistentry>
-              <term><option>--socket=<replaceable>path</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>
-              </listitem>
-            </varlistentry>
           </variablelist>
         </refsect2>
 
@@ -215,7 +220,14 @@
               <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>--quiet</option></term>
+              <listitem>
+                <para>Do not print any output, like the remaining queue entries when reaching the timeout.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
@@ -231,7 +243,7 @@
           <para>Modify the internal state of the running udev daemon.</para>
           <variablelist>
             <varlistentry>
-              <term><option>--log_priority=<replaceable>value</replaceable></option></term>
+              <term><option>--log-priority=<replaceable>value</replaceable></option></term>
               <listitem>
                 <para>Set the internal log level of udevd. Valid values are the numerical
                 syslog priorities or their textual representations: <option>err</option>,
@@ -239,20 +251,20 @@
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--stop_exec_queue</option></term>
+              <term><option>--stop-exec-queue</option></term>
               <listitem>
                 <para>Signal udevd to stop executing new events. Incoming events
                 will be queued.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--start_exec_queue</option></term>
+              <term><option>--start-exec-queue</option></term>
               <listitem>
                 <para>Signal udevd to enable the execution of events.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--reload_rules</option></term>
+              <term><option>--reload-rules</option></term>
               <listitem>
                 <para>Signal udevd to reload the rules from the config.</para>
               </listitem>
@@ -264,19 +276,12 @@
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--max_childs=</option><replaceable>value</replaceable></term>
+              <term><option>--max-childs=</option><replaceable>value</replaceable></term>
               <listitem>
                 <para>Set the maximum number of events, udevd will handle at the
                 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>
@@ -321,8 +326,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 +340,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 +348,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>