chiark / gitweb /
udevadm: info - add --export format to --device-id-of-file=
[elogind.git] / udevadm.xml
index 0dd1570bd211a6af284d3c25a049092a6c916fb7..670c991457145e7c53b62a47ead133101b6efb4b 100644 (file)
 
       <refsect1><title>DESCRIPTION</title>
         <para>udevadm expects a command and command specific options.  It
-        controls the runtime behavior of udev, request kernel events,
+        controls the runtime behavior of udev, requests kernel events,
         manages the event queue, and provides simple debugging mechanisms.</para>
       </refsect1>
 
       <refsect1><title>OPTIONS</title>
 
-        <refsect2><title>udevadm info</title>
+        <refsect2><title>udevadm info <replaceable>options</replaceable></title>
           <para>Queries the udev database for device information
           stored in the udev database. It can also query the properties
           of a device from its sysfs representation to help creating udev
@@ -80,7 +80,7 @@
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--name=<replaceable>node</replaceable></option></term>
+              <term><option>--name=<replaceable>file</replaceable></option></term>
               <listitem>
                 <para>The name of the device node or a symlink to query</para>
               </listitem>
                 along the chain, up to the root of sysfs that can be used in udev rules.</para>
               </listitem>
             </varlistentry>
+            <varlistentry>
+              <term><option>--device-id-of-file=<replaceable>file</replaceable></option></term>
+              <listitem>
+                <para>Print major/minor numbers of the underlying device, where the file
+                lives on.</para>
+              </listitem>
+            </varlistentry>
             <varlistentry>
               <term><option>--export-db</option></term>
               <listitem>
           </variablelist>
         </refsect2>
 
-        <refsect2><title>udevadm trigger</title>
-          <para>Request kernel device uevents, usually used to replay events at system coldplug.</para>
+        <refsect2><title>udevadm trigger <optional>options</optional></title>
+          <para>Request device uevents, usually used to replay events at system coldplug.</para>
           <variablelist>
             <varlistentry>
               <term><option>--verbose</option></term>
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--attr-match=<replaceable>attribute=value</replaceable></option></term>
+              <term><option>--attr-match=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
               <listitem>
                 <para>Trigger events for devices with a matching sysfs attribute. If a value is specified
                 along with the attribute name, the content of the attribute is matched against the given
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>--attr-nomatch<replaceable>attribute=value</replaceable></option></term>
+              <term><option>--attr-nomatch=<replaceable>attribute</replaceable>=<replaceable>value</replaceable></option></term>
               <listitem>
                 <para>Do not trigger events for devices with a matching sysfs attribute. If a value is
                 specified along with the attribute name, the content of the attribute is matched against
                 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>
 
-        <refsect2><title>udevadm settle</title>
+        <refsect2><title>udevadm settle <optional>options</optional></title>
           <para>Watches the udev event queue, and exits if all current events are handled.</para>
           <variablelist>
             <varlistentry>
               <term><option>--timeout=<replaceable>seconds</replaceable></option></term>
               <listitem>
-                <para>Maximum seconds to wait for the queue to become empty.</para>
+                <para>Maximum number of seconds to wait for the event queue to become empty.
+                The default value is 180 seconds.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
           </variablelist>
         </refsect2>
 
-        <refsect2><title>udevadm control <replaceable>instruction</replaceable></title>
+        <refsect2><title>udevadm control <replaceable>command</replaceable></title>
           <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>
             </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>
             </varlistentry>
             <varlistentry>
-              <term><option>env <replaceable>var</replaceable>=<replaceable>value</replaceable></option></term>
+              <term><option>--env=<replaceable>KEY</replaceable>=<replaceable>value</replaceable></option></term>
               <listitem>
                 <para>Set global variable.</para>
               </listitem>
             </varlistentry>
             <varlistentry>
-              <term><option>max_childs</option></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</option></term>
+              <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>
+              <term><option>--help</option></term>
               <listitem>
                 <para>Print help text.</para>
               </listitem>
           </variablelist>
         </refsect2>
 
-        <refsect2><title>udevadm monitor</title>
+        <refsect2><title>udevadm monitor <optional>options</optional></title>
           <para>Listens to the kernel uevents and events sent out by a udev rule
           and prints the devpath of the event to the console. It can be used to analyze the
           event timing, by comparing the timestamps of the kernel uevent and the udev event.
           </variablelist>
         </refsect2>
 
-        <refsect2><title>udevadm test</title>
+        <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>
           <variablelist>