chiark / gitweb /
udev: rules - ignore the lack of trailing newline
[elogind.git] / man / udevadm.xml
index fd17f40be3d2df72969c36535c499fe68de8e0ed..38c1935fa82de190e5fba3ceae0bb1ba93e66fb0 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">
@@ -66,7 +66,7 @@
     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>
       </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>
       </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>
+    <refsect2><title>udevadm hwdb
+      <arg choice="opt"><replaceable>options</replaceable></arg>
+    </title>
       <para>Maintain the hardware database index in <filename>/etc/udev/hwdb.bin</filename>.</para>
       <variablelist>
         <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>