add $driver subtitution

[thirdparty/systemd.git] / udevd.xml

<?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>udevd, udevcontrol</title>
    <refentry>
      <refentryinfo>
        <title>udevd</title>
        <date>August 2005</date>
        <productname>udev</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>udevd</refentrytitle>
        <manvolnum>8</manvolnum>
        <refmiscinfo class="version"></refmiscinfo>
      </refmeta>

      <refnamediv>
        <refname>udevd</refname><refpurpose>event managing daemon</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
        <cmdsynopsis>
          <command>udevd</command>
          <arg><option>--daemon</option></arg>
          <arg><option>--debug-trace</option></arg>
          <arg><option>--verbose</option></arg>
          <arg><option>--version</option></arg>
          <arg><option>--help</option></arg>
        </cmdsynopsis>
        <cmdsynopsis>
          <command>udevcontrol <replaceable>command</replaceable></command>
        </cmdsynopsis>
      </refsynopsisdiv>

      <refsect1><title>DESCRIPTION</title>
        <para>udevd listens to kernel uevents and passes the incoming events to
        udev. It ensures the right event order and takes care, that events for child
        devices are delayed until the parent has finished the device handling. </para>
      </refsect1>

      <refsect1><title>OPTIONS</title>
        <variablelist>
          <varlistentry>
            <term><option>--daemon</option></term>
            <listitem>
              <para>Detach and run in the background.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--debug-trace</option></term>
            <listitem>
              <para>Run all events completely serialized. This may be useful if udev triggers
              actions or loads kernel modules which cause problems and a slow but continuous
              operation is needed, where no events are processed in parallel.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--verbose</option></term>
            <listitem>
              <para>Print log messages to stdout.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--version</option></term>
            <listitem>
              <para>Print version number.</para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term><option>--help</option></term>
            <listitem>
              <para>Print usage.</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
              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>
      </refsect1>

      <refsect1><title>ENVIRONMENT</title>
        <variablelist>
          <varlistentry>
            <term><option>UDEV_LOG</option></term>
            <listitem>
              <para>Overrides the syslog priority specified in the config file.</para>
            </listitem>
          </varlistentry>
        </variablelist>
     </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></para>
      </refsect1>
    </refentry>
  </section>
</article>