chiark / gitweb /
rtnl: match - only match on one type at a time
[elogind.git] / man / udevadm.xml
index 11900d2..30a6ac4 100644 (file)
@@ -50,6 +50,9 @@
       <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>
     <cmdsynopsis>
   </refsynopsisdiv>
 
   <refsect1><title>Description</title>
-    <para>udevadm expects a command and command specific options.  It
-    controls the runtime behavior of udev, requests kernel events,
-    manages the event queue, and provides simple debugging mechanisms.</para>
+    <para><command>udevadm</command> expects a command and command
+    specific options.  It controls the runtime behavior of
+    <command>systemd-udevd</command>, requests kernel events, manages
+    the event queue, and provides simple debugging mechanisms.</para>
   </refsect1>
 
   <refsect1><title>OPTIONS</title>
         <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>property</command>, <command>all</command>.</para>
+            <para>Query the database for the specified type of device
+            data. It needs the <option>--path</option> or
+            <option>--name</option> to identify the specified
+            device. Valid queries are: <constant>name</constant>,
+            <constant>symlink</constant>, <constant>path</constant>,
+            <constant>property</constant>,
+            <constant>all</constant>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><option>--path=<replaceable>devpath</replaceable></option></term>
           <listitem>
-            <para>The devpath of the device to query.</para>
+            <para>The <filename>/sys</filename> path of the device to
+            query, e.g.
+            <filename><optional>/sys</optional>/class/block/sda</filename>.
+            Note that this option usually is not very useful, since
+            <command>udev</command> can guess the type of the
+            argument, so <command>udevadm
+            --devpath=/class/block/sda</command> is equivalent to
+            <command>udevadm /sys/class/block/sda</command>.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><option>--name=<replaceable>file</replaceable></option></term>
           <listitem>
-            <para>The name of the device node or a symlink to query</para>
+            <para>The name of the device node or a symlink to query,
+            e.g. <filename><optional>/dev</optional>/sda</filename>.
+            Note that this option usually is not very useful, since
+            <command>udev</command> can guess the type of the
+            argument, so <command>udevadm --name=sda</command> is
+            equivalent to <command>udevadm /dev/sda</command>.</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>--run</option></term>
-          <listitem>
-            <para>The udev runtime directory: <filename>/run/udev</filename>.</para>
+            <para>Print absolute paths in <command>name</command> or <command>symlink</command>
+            query.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
         <varlistentry>
           <term><option>--exit</option></term>
           <listitem>
-            <para>Signal and wait for udevd to exit.</para>
+            <para>Signal and wait for systemd-udevd to exit.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><option>--log-priority=<replaceable>value</replaceable></option></term>
           <listitem>
-            <para>Set the internal log level of udevd. Valid values are the numerical
+            <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>
           </listitem>
         <varlistentry>
           <term><option>--stop-exec-queue</option></term>
           <listitem>
-            <para>Signal udevd to stop executing new events. Incoming events
+            <para>Signal systemd-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>
+            <para>Signal systemd-udevd to enable the execution of events.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><option>--reload</option></term>
           <listitem>
-            <para>Signal udevd to reload the rules files and other databases like the kernel
+            <para>Signal systemd-udevd to reload the rules files and other databases like the kernel
             module index. Reloading rules and databases does not apply any changes to already
             existing devices; the new configuration will only be applied to new events.</para>
           </listitem>
         <varlistentry>
           <term><option>--children-max=</option><replaceable>value</replaceable></term>
           <listitem>
-            <para>Set the maximum number of events, udevd will handle at the
+            <para>Set the maximum number of events, systemd-udevd will handle at the
             same time.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
           <term><option>--timeout=</option><replaceable>seconds</replaceable></term>
           <listitem>
-            <para>The maximum number seconds to wait for a reply from udevd.</para>
+            <para>The maximum number of seconds to wait for a reply from systemd-udevd.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
       </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>--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>--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>--root=<replaceable>string</replaceable></option></term>
+          <listitem>
+            <para>Alternative root path in the filesystem for reading and writing files.</para>
+          </listitem>
+        </varlistentry>
+      </variablelist>
+    </refsect2>
+
     <refsect2><title>udevadm test <optional>options</optional> <replaceable>devpath</replaceable></title>
       <para>Simulate a udev event run for the given device, and print debug output.</para>
       <variablelist>
           </listitem>
         </varlistentry>
         <varlistentry>
-          <term><option>--subsystem=<replaceable>string</replaceable></option></term>
+          <term><option>--resolve-names=<constant>early</constant>|<constant>late</constant>|<constant>never</constant></option></term>
           <listitem>
-            <para>The subsystem string.</para>
+            <para>Specify when udevadm should resolve names of users
+            and groups.  When set to <constant>early</constant> (the
+            default), names will be resolved when the rules are
+            parsed. When set to <constant>late</constant>, names will
+            be resolved for every event. When set to
+            <constant>never</constant>, names will never be resolved
+            and all devices will be owned by root.</para>
           </listitem>
         </varlistentry>
         <varlistentry>
         <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
     </citerefentry>
     <citerefentry>
-        <refentrytitle>udevd</refentrytitle><manvolnum>8</manvolnum>
+        <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
     </citerefentry></para>
   </refsect1>
 </refentry>