udevadm: merge all udev tools into a single binary

1 files changed, 354 insertions, 0 deletions

diff --git a/udevadm.xml b/udevadm.xml
new file mode 100644
index 0000000000..0dd1570bd2
--- /dev/null
+++ b/udevadm.xml
@@ -0,0 +1,354 @@
+<?xml version='1.0'?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<article>
+  <section>
+    <title>udevadm</title>
+    <refentry>
+      <refentryinfo>
+        <title>udevd</title>
+        <date>November 2007</date>
+        <productname>udev</productname>
+      </refentryinfo>
+
+      <refmeta>
+        <refentrytitle>udevadm</refentrytitle>
+        <manvolnum>8</manvolnum>
+        <refmiscinfo class="version"></refmiscinfo>
+      </refmeta>
+
+      <refnamediv>
+        <refname>udevadm</refname><refpurpose>udev management tool</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>udevadm info <optional>options</optional></command>
+        </cmdsynopsis>
+        <cmdsynopsis>
+          <command>udevadm trigger <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>
+        </cmdsynopsis>
+        <cmdsynopsis>
+          <command>udevadm monitor <optional>options</optional></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>
+        <para>udevadm expects a command and command specific options.  It
+        controls the runtime behavior of udev, request kernel events,
+        manages the event queue, and provides simple debugging mechanisms.</para>
+      </refsect1>
+
+      <refsect1><title>OPTIONS</title>
+
+        <refsect2><title>udevadm info</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
+          rules that match this device.</para>
+          <variablelist>
+            <varlistentry>
+              <term><option>--query=<replaceable>type</replaceable></option></term>
+              <listitem>
+                <para>Query the database for specified type of device data. It needs the
+                <option>--path</option> or <option>--name</option> to identify the specified
+                device. Valid queries are:
+                <command>name</command>, <command>symlink</command>, <command>path</command>,
+                <command>env</command>, <command>all</command>.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--path=<replaceable>devpath</replaceable></option></term>
+              <listitem>
+                <para>The devpath of the device to query.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--name=<replaceable>node</replaceable></option></term>
+              <listitem>
+                <para>The name of the device node or a symlink to query</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--root</option></term>
+              <listitem>
+                <para>The udev root directory: <filename>/dev</filename>. If used in conjunction
+                with a <command>name</command> or <command>symlink</command> query, the
+                query returns the absolute path including the root directory.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--attribute-walk</option></term>
+              <listitem>
+                <para>Print all sysfs properties of the specified device that can be used
+                in udev rules to match the specified device. It prints all devices
+                along the chain, up to the root of sysfs that can be used in udev rules.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--export-db</option></term>
+              <listitem>
+                <para>Export the content of the udev database.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--version</option></term>
+              <listitem>
+                <para>Print version.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--help</option></term>
+              <listitem>
+                <para>Print help text.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </refsect2>
+
+        <refsect2><title>udevadm trigger</title>
+          <para>Request kernel device uevents, usually used to replay events at system coldplug.</para>
+          <variablelist>
+            <varlistentry>
+              <term><option>--verbose</option></term>
+              <listitem>
+                <para>Print the list of devices which will be triggered.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--dry-run</option></term>
+              <listitem>
+                <para>Do not actually trigger the event.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--retry-failed</option></term>
+              <listitem>
+                <para>Trigger only the events which are failed during a previous run.</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>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--subsystem-match=<replaceable>subsystem</replaceable></option></term>
+              <listitem>
+                <para>Trigger events for devices which belong to a matching subsystem. This option
+                can be specified multiple times and supports shell style pattern matching.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--subsystem-nomatch=<replaceable>subsystem</replaceable></option></term>
+              <listitem>
+                <para>Do not trigger events for devices which belong to a matching subsystem. This option
+                can be specified multiple times and supports shell style pattern matching.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--attr-match=<replaceable>attribute=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
+                value using shell style pattern matching. If no value is specified, the existence of the
+                sysfs attribute is checked. This option can be specified multiple times.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--attr-nomatch<replaceable>attribute=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
+                the given value using shell style pattern matching. If no value is specified, the existence
+                of the sysfs attribute is checked. This option can be specified multiple times.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </refsect2>
+
+        <refsect2><title>udevadm settle</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>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--help</option></term>
+              <listitem>
+                <para>Print help text.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </refsect2>
+
+        <refsect2><title>udevadm control <replaceable>instruction</replaceable></title>
+          <para>Modify the internal state of the running udev daemon.</para>
+          <variablelist>
+            <varlistentry>
+              <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>,
+                <option>info</option> and <option>debug</option>.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <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>
+              <listitem>
+                <para>Signal udevd to enable the execution of events.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <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>
+              <listitem>
+                <para>Set global variable.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>max_childs</option></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>
+              <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>
+                <para>Print help text.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </refsect2>
+
+        <refsect2><title>udevadm monitor</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.
+          </para>
+          <variablelist>
+            <varlistentry>
+              <term><option>--environment</option></term>
+              <listitem>
+                <para>Print the complete environment for all events. Can be used to compare the
+                kernel supplied and the udev added environment values.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--kernel</option></term>
+              <listitem>
+                <para>Print the kernel uevents.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--udev</option></term>
+              <listitem>
+                <para>Print the udev event after the rule processing.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--help</option></term>
+              <listitem>
+                <para>Print help text.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+        </refsect2>
+
+        <refsect2><title>udevadm test</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>
+            <varlistentry>
+              <term><option>--action=<replaceable>string</replaceable></option></term>
+              <listitem>
+                <para>The action string.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><option>--subsystem=<replaceable>string</replaceable></option></term>
+              <listitem>
+                <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>
+                <para>Print help text.</para>
+              </listitem>
+            </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>
+        <para>Written by Kay Sievers <email>kay.sievers@vrfy.org</email>.</para>
+      </refsect1>
+
+      <refsect1>
+        <title>SEE ALSO</title>
+        <para><citerefentry>
+            <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
+        </citerefentry>
+        <citerefentry>
+            <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
+        </citerefentry></para>
+      </refsect1>
+    </refentry>
+  </section>
+</article>