]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/systemd-udevd.service.xml
test-hostname-util: add assert_se's to make coverity happy
[thirdparty/systemd.git] / man / systemd-udevd.service.xml
index 50a10764bf8e2e1d05b15b84eb35436d9341127d..12b51a152de9ed8aa1ba020a0b3eaa8fcdc429a3 100644 (file)
@@ -1,9 +1,31 @@
-<?xml version='1.0'?>
-<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?>
+<?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
-<refentry id="systemd-udevd.service">
+<!--
+  SPDX-License-Identifier: LGPL-2.1+
+
+  This file is part of systemd.
+
+  Copyright 2010-2013 Kay Sievers
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+-->
+
+<refentry id="systemd-udevd.service"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
+
   <refentryinfo>
     <title>systemd-udevd.service</title>
     <productname>systemd</productname>
@@ -20,7 +42,6 @@
   <refmeta>
     <refentrytitle>systemd-udevd.service</refentrytitle>
     <manvolnum>8</manvolnum>
-    <refmiscinfo class="version"></refmiscinfo>
   </refmeta>
 
   <refnamediv>
@@ -42,6 +63,7 @@
       <arg><option>--debug</option></arg>
       <arg><option>--children-max=</option></arg>
       <arg><option>--exec-delay=</option></arg>
+      <arg><option>--event-timeout=</option></arg>
       <arg><option>--resolve-names=early|late|never</option></arg>
       <arg><option>--version</option></arg>
       <arg><option>--help</option></arg>
 
   <refsect1><title>Description</title>
     <para><command>systemd-udevd</command> listens to kernel uevents.
-      For every event, systemd-udevd executes matching instructions
-      specified in udev rules. See <citerefentry>
-      <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
-      </citerefentry>.</para>
-    <para>The behavior of the running daemon can be changed with
-    <command>udevadm control</command>.</para>
+    For every event, systemd-udevd executes matching instructions
+    specified in udev rules. See <citerefentry>
+    <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
+    </citerefentry>.</para>
+
+    <para>The behavior of the daemon can be configured using
+    <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+    its command line options, environment variables, and on the kernel
+    command line, or changed dynamically with <command>udevadm
+    control</command>.
+    </para>
   </refsect1>
 
   <refsect1><title>Options</title>
           <para>Detach and run in the background.</para>
         </listitem>
       </varlistentry>
+
       <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>
         <term><option>--children-max=</option></term>
         <listitem>
           <para>Limit the number of events executed in parallel.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term><option>--exec-delay=</option></term>
         <listitem>
-          <para>Delay the execution of RUN instruction by the given
-          number of seconds. This option might be useful when
-          debugging system crashes during coldplug caused by loading
-          non-working kernel modules.</para>
+          <para>Delay the execution of <varname>RUN</varname>
+          instructions by the given number of seconds. This option
+          might be useful when debugging system crashes during
+          coldplug caused by loading non-working kernel
+          modules.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term><option>--resolve-names=</option></term>
+        <term><option>--event-timeout=</option></term>
         <listitem>
-          <para>Specify when systemd-udevd should resolve names of users and groups.
-          When set to <option>early</option> (the default) names will be
-          resolved when the rules are parsed.  When set to
-          <option>late</option> names will be resolved for every event.
-          When set to <option>never</option> names will never be resolved
-          and all devices will be owned by root.</para>
+          <para>Set the number of seconds to wait for events to finish. After
+          this time, the event will be terminated. The default is 180 seconds.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
-        <term><option>--version</option></term>
+        <term><option>--resolve-names=</option></term>
         <listitem>
-          <para>Print version number.</para>
+          <para>Specify when systemd-udevd should resolve names of users and groups.
+          When set to <option>early</option> (the default), names will be
+          resolved when the rules are parsed.  When set to
+          <option>late</option>, names will be resolved for every event.
+          When set to <option>never</option>, names will never be resolved
+          and all devices will be owned by root.</para>
         </listitem>
       </varlistentry>
+
       <varlistentry>
         <term><option>--help</option></term>
-        <listitem>
-          <para>Print help text.</para>
-        </listitem>
-      </varlistentry>
-    </variablelist>
-  </refsect1>
 
-  <refsect1><title>Environment</title>
-    <variablelist class='environment-variables'>
-      <varlistentry>
-        <term><varname>$UDEV_LOG=</varname></term>
-        <listitem>
-          <para>Set the logging priority.</para>
-        </listitem>
+        <xi:include href="standard-options.xml" xpointer="help-text" />
       </varlistentry>
+      <xi:include href="standard-options.xml" xpointer="version" />
     </variablelist>
- </refsect1>
 </refsect1>
 
   <refsect1><title>Kernel command line</title>
     <variablelist class='kernel-commandline-options'>
       <para>Parameters starting with "rd." will be read when
       <command>systemd-udevd</command> is used in an initrd.</para>
       <varlistentry>
-        <term><varname>udev.log-priority=</varname></term>
-        <term><varname>rd.udev.log-priority=</varname></term>
+        <term><varname>udev.log_priority=</varname></term>
+        <term><varname>rd.udev.log_priority=</varname></term>
         <listitem>
-          <para>Set the logging priority.</para>
+          <para>Set the log level.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><varname>udev.children-max=</varname></term>
-        <term><varname>rd.udev.children-max=</varname></term>
+        <term><varname>udev.children_max=</varname></term>
+        <term><varname>rd.udev.children_max=</varname></term>
         <listitem>
           <para>Limit the number of events executed in parallel.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term><varname>udev.exec-delay=</varname></term>
-        <term><varname>rd.udev.exec-delay=</varname></term>
+        <term><varname>udev.exec_delay=</varname></term>
+        <term><varname>rd.udev.exec_delay=</varname></term>
         <listitem>
-          <para>Delay the execution of RUN instruction by the given
+          <para>Delay the execution of <varname>RUN</varname> instructions by the given
           number of seconds. This option might be useful when
           debugging system crashes during coldplug caused by loading
           non-working kernel modules.</para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><varname>udev.event_timeout=</varname></term>
+        <term><varname>rd.udev.event_timeout=</varname></term>
+        <listitem>
+          <para>Wait for events to finish up to the given number
+          of seconds. This option might be useful if events are
+          terminated due to kernel drivers taking too long to initialize.</para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><varname>net.ifnames=</varname></term>
         <listitem>
          in kernel-command-line.xml -->
  </refsect1>
 
- <refsect1><title>Configuration file</title>
-   <para>udev expects its main configuration file at <filename>/etc/udev/udev.conf</filename>.
-   It consists of a set of variables allowing the user to override default udev values. All
-   empty lines or lines beginning with '#' are ignored. The following variables can be
-   set:</para>
-   <variablelist>
-     <varlistentry>
-       <term><varname>udev_log</varname></term>
-       <listitem>
-         <para>The logging priority. Valid values are the numerical syslog priorities
-         or their textual representations: <option>err</option>, <option>info</option>
-         and <option>debug</option>.</para>
-       </listitem>
-     </varlistentry>
-   </variablelist>
- </refsect1>
-
   <refsect1>
     <title>See Also</title>
-    <para><citerefentry>
-        <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
-      </citerefentry>, <citerefentry>
-        <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
-    </citerefentry></para>
+    <para>
+      <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+    </para>
   </refsect1>
 </refentry>