move udev_device_db to libudev

[elogind.git] / udev / udevadm.xml

diff --git a/udev/udevadm.xml b/udev/udevadm.xml
index 670c991457145e7c53b62a47ead133101b6efb4b..b7687d5dd1c5c1ce0eb1e385333d8e1b458de536 100644 (file)
--- a/udev/udevadm.xml
+++ b/udev/udevadm.xml
@@ -24,7 +24,13 @@
 
       <refsynopsisdiv>
         <cmdsynopsis>
 
       <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>
         </cmdsynopsis>
         <cmdsynopsis>
           <command>udevadm trigger <optional>options</optional></command>


@@ -33,7 +39,7 @@
           <command>udevadm settle <optional>options</optional></command>
         </cmdsynopsis>
         <cmdsynopsis>
           <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>
         </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 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>
       </refsynopsisdiv>
 
       <refsect1><title>DESCRIPTION</title>


@@ -56,6 +56,26 @@
       </refsect1>
 
       <refsect1><title>OPTIONS</title>
       </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
 
         <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>
         </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>
           <variablelist>
             <varlistentry>
               <term><option>--verbose</option></term>


@@ -145,15 +165,17 @@
               </listitem>
             </varlistentry>
             <varlistentry>
               </listitem>
             </varlistentry>
             <varlistentry>

-              <term><option>--retry-failed</option></term>
+              <term><option>--type=<replaceable>type</replaceable></option></term>

               <listitem>
               <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>
               </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>
               </listitem>
             </varlistentry>
             <varlistentry>


@@ -188,23 +210,6 @@
                 of the sysfs attribute is checked. This option can be specified multiple times.</para>
               </listitem>
             </varlistentry>
                 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>
 
           </variablelist>
         </refsect2>
 


@@ -231,7 +236,7 @@
           <para>Modify the internal state of the running udev daemon.</para>
           <variablelist>
             <varlistentry>
           <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>,
               <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 +244,20 @@
               </listitem>
             </varlistentry>
             <varlistentry>
               </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>
               <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>
               <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>
               <listitem>
                 <para>Signal udevd to reload the rules from the config.</para>
               </listitem>


@@ -264,19 +269,12 @@
               </listitem>
             </varlistentry>
             <varlistentry>
               </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>
               <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>
             <varlistentry>
               <term><option>--help</option></term>
               <listitem>


@@ -351,14 +349,6 @@
             </varlistentry>
           </variablelist>
         </refsect2>
             </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>
       </refsect1>
 
       <refsect1><title>AUTHOR</title>