chiark / gitweb /
update TODO
[elogind.git] / man / udevadm.xml
index e437c243c578254a96bc154a02bf0966386985fe..4aa89646dbe74efcf78e2c32cd0f7f9795ff73e6 100644 (file)
@@ -1,4 +1,4 @@
-<?xml version='1.0'?>
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
@@ -20,7 +20,6 @@
   <refmeta>
     <refentrytitle>udevadm</refentrytitle>
     <manvolnum>8</manvolnum>
-    <refmiscinfo class="version"></refmiscinfo>
   </refmeta>
 
   <refnamediv>
@@ -49,9 +48,6 @@
     <cmdsynopsis>
       <command>udevadm monitor <optional>options</optional></command>
     </cmdsynopsis>
-    <cmdsynopsis>
-      <command>udevadm hwdb <optional>options</optional></command>
-    </cmdsynopsis>
     <cmdsynopsis>
       <command>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></command>
     </cmdsynopsis>
     the event queue, and provides simple debugging mechanisms.</para>
   </refsect1>
 
-  <refsect1><title>OPTIONS</title>
+  <refsect1><title>Options</title>
     <variablelist>
       <varlistentry>
         <term><option>--debug</option></term>
         <listitem>
-          <para>Print debug messages to STDERR.</para>
+          <para>Print debug messages to standard error.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
       </varlistentry>
     </variablelist>
 
-    <refsect2><title>udevadm info <optional><replaceable>OPTIONS</replaceable></optional> <optional><replaceable>DEVPATH</replaceable>|<replaceable>FILE</replaceable></optional></title>
+    <refsect2><title>udevadm info
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+      <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable></arg>
+    </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
           </listitem>
         </varlistentry>
       </variablelist>
+
+      <para>In addition an optional positional argument can be used
+      to specify a device name or a sys path. It must start with
+      <filename>/dev</filename> or <filename>/sys</filename>
+      respectively.</para>
     </refsect2>
 
-    <refsect2><title>udevadm trigger <optional>options</optional></title>
+    <refsect2><title>udevadm trigger
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+      <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>file</replaceable></arg></title>
       <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para>
       <variablelist>
         <varlistentry>
         </varlistentry>
         <varlistentry>
           <term><option>-y</option></term>
-          <term><option>--sysname-match=<replaceable>NAME</replaceable></option></term>
+          <term><option>--sysname-match=<replaceable>PATH</replaceable></option></term>
           <listitem>
             <para>Trigger events for devices with a matching sys
-            device name. This option can be specified multiple times
+            device path. This option can be specified multiple times
             and supports shell style pattern matching.</para>
           </listitem>
         </varlistentry>
+        <varlistentry>
+          <term><option>--name-match=<replaceable>NAME</replaceable></option></term>
+          <listitem>
+            <para>Trigger events for devices with a matching
+            device path. This options can be specified multiple
+            times.</para>
+          </listitem>
+        </varlistentry>
         <varlistentry>
           <term><option>-b</option></term>
           <term><option>--parent-match=<replaceable>SYSPATH</replaceable></option></term>
           </listitem>
         </varlistentry>
       </variablelist>
+
+      <para>In addition optional positional arguments can be used
+      to specify device names or sys paths. They must start with
+      <filename>/dev</filename> or <filename>/sys</filename>
+      respectively.</para>
     </refsect2>
 
-    <refsect2><title>udevadm settle <optional>options</optional></title>
+    <refsect2><title>udevadm settle
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+    </title>
       <para>Watches the udev event queue, and exits if all current events are handled.</para>
       <variablelist>
         <varlistentry>
             return immediately.</para>
           </listitem>
         </varlistentry>
-        <varlistentry>
-          <term><option>-s</option></term>
-          <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>-e</option></term>
-          <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>-E</option></term>
           <term><option>--exit-if-exists=<replaceable>FILE</replaceable></option></term>
             <para>Stop waiting if file exists.</para>
           </listitem>
         </varlistentry>
-        <varlistentry>
-          <term><option>-q</option></term>
-          <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>
           <term><option>-h</option></term>
           <term><option>--help</option></term>
           <term><option>-l</option></term>
           <term><option>--log-priority=<replaceable>value</replaceable></option></term>
           <listitem>
-            <para>Set the internal log level of systemd-udevd. Valid values are the numerical
-            syslog priorities or their textual representations: <option>err</option>,
-            <option>info</option> and <option>debug</option>.</para>
+            <para>Set the internal log level of
+            <filename>systemd-udevd</filename>. Valid values are the
+            numerical syslog priorities or their textual
+            representations: <option>emerg</option>,
+            <option>alert</option>, <option>crit</option>,
+            <option>err</option>, <option>warning</option>,
+            <option>notice</option>, <option>info</option>, and
+            <option>debug</option>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
       </variablelist>
     </refsect2>
 
-    <refsect2><title>udevadm monitor <optional>options</optional></title>
+    <refsect2><title>udevadm monitor
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+    </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 hwdb <optional>options</optional></title>
-      <para>Maintain the hardware database index in <filename>/etc/udev/hwdb.bin</filename>.</para>
-      <variablelist>
-        <varlistentry>
-          <term><option>-u</option></term>
-          <term><option>--update</option></term>
-          <listitem>
-            <para>Compile the hardware database information located in /usr/lib/udev/hwdb.d/,
-            /etc/udev/hwdb.d/ and store it in <filename>/etc/udev/hwdb.bin</filename>. This should be done after
-            any update to the source files; it will not be called automatically. The running
-            udev daemon will detect a new database on its own and does not need to be
-            notified about it.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><option>-t</option></term>
-          <term><option>--test=<replaceable>string</replaceable></option></term>
-          <listitem>
-            <para>Query the database with a modalias string, and print the
-            retrieved properties.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><option>-r</option></term>
-          <term><option>--root=<replaceable>string</replaceable></option></term>
-          <listitem>
-            <para>Alternative root path in the file system for reading and writing files.</para>
-          </listitem>
-        </varlistentry>
-        <varlistentry>
-          <term><option>-h</option></term>
-          <term><option>--help</option></term>
-          <listitem>
-            <para>Print help text.</para>
-          </listitem>
-        </varlistentry>
-      </variablelist>
-    </refsect2>
-
-    <refsect2><title>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></title>
+    <refsect2><title>udevadm test
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+      <arg><replaceable>devpath</replaceable></arg>
+    </title>
       <para>Simulate a udev event run for the given device, and print debug output.</para>
       <variablelist>
         <varlistentry>
       </variablelist>
     </refsect2>
 
-    <refsect2><title>udevadm test-builtin <optional>options</optional> <replaceable>COMMAND</replaceable> <replaceable>DEVPATH</replaceable></title>
+    <refsect2><title>udevadm test-builtin
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+      <arg><replaceable>command</replaceable></arg>
+      <arg><replaceable>devpath</replaceable></arg>
+    </title>
       <para>Run a built-in command <replaceable>COMMAND</replaceable>
       for device <replaceable>DEVPATH</replaceable>, and print debug
       output.</para>
     <title>See Also</title>
     <para><citerefentry>
         <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
-    </citerefentry>
+    </citerefentry>,
     <citerefentry>
         <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
     </citerefentry></para>