summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2014-08-04 11:54:19 -0400
committerAnthony G. Basile <blueness@gentoo.org>2014-08-04 11:54:48 -0400
commit93bc913f142b42a481ca0466ebf31228e1132cdb (patch)
treef1a2252fcd1cbcd8146a918e258d377b7ba8df7d
parent5f63fcb01095830daa7d42156c880c6fcf554e56 (diff)
man: add udev.conf(5)
We generally have separate man pages for all configuration files. In this case udev.conf was already described in systemd-udevd.service(8), but it was hard to find. Docbook makes it hard to add a .so link from a different section, so describe udev.conf in its own page. Signedaoff-by: Anthony G. Basile <blueness@gentoo.org>
-rw-r--r--.gitignore1
-rw-r--r--man/Makefile.am5
-rw-r--r--man/udev.conf.xml88
-rw-r--r--man/udevadm.xml1
-rw-r--r--man/udevd.xml44
-rw-r--r--src/udev/udev.conf2
6 files changed, 110 insertions, 31 deletions
diff --git a/.gitignore b/.gitignore
index afd8e6f6fd..7fb273fb21 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,6 +33,7 @@ docs/libudev/version.xml
docs/gudev/gudev-overrides.txt
docs/libudev/libudev-overrides.txt
man/udev.7
+man/udev.conf.5
man/udevd.8
man/udevadm.8
rule_generator/write_cd_rules
diff --git a/man/Makefile.am b/man/Makefile.am
index 80d2086772..ea8d982378 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -2,6 +2,7 @@ ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
XMLPAGES = \
udev.xml \
+ udev.conf.xml \
udevd.xml \
udevadm.xml
@@ -13,6 +14,7 @@ EXTRA_DIST = \
MANPAGES = \
udev.7 \
+ udev.conf.5 \
udevd.8 \
udevadm.8
@@ -35,6 +37,9 @@ XSLTPROC_PROCESS_MAN = \
udev.7: udev.xml
$(XSLTPROC_PROCESS_MAN)
+udev.conf.5: udev.conf.xml
+ $(XSLTPROC_PROCESS_MAN)
+
udevd.8: udevd.xml
$(XSLTPROC_PROCESS_MAN)
diff --git a/man/udev.conf.xml b/man/udev.conf.xml
new file mode 100644
index 0000000000..de84b91258
--- /dev/null
+++ b/man/udev.conf.xml
@@ -0,0 +1,88 @@
+<?xml version='1.0'?>
+<?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">
+
+<!--
+ This file is part of systemd.
+
+ Copyright 2014 Zbigniew Jędrzejewski-Szmek
+
+ 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="udev.conf"
+ xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <refentryinfo>
+ <title>udev.conf</title>
+ <productname>systemd</productname>
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Kay</firstname>
+ <surname>Sievers</surname>
+ <email>kay@vrfy.org</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>udev.conf</refentrytitle>
+ <manvolnum>5</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>udev.conf</refname>
+ <refpurpose>Configuration for device event managing daemon</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/etc/udev/udev.conf</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ 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>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+</refentry>
diff --git a/man/udevadm.xml b/man/udevadm.xml
index 1b349c6b4e..51afbf3028 100644
--- a/man/udevadm.xml
+++ b/man/udevadm.xml
@@ -20,7 +20,6 @@
<refmeta>
<refentrytitle>udevadm</refentrytitle>
<manvolnum>8</manvolnum>
- <refmiscinfo class="version"></refmiscinfo>
</refmeta>
<refnamediv>
diff --git a/man/udevd.xml b/man/udevd.xml
index c72484c556..89722050a4 100644
--- a/man/udevd.xml
+++ b/man/udevd.xml
@@ -20,7 +20,6 @@
<refmeta>
<refentrytitle>udevd</refentrytitle>
<manvolnum>8</manvolnum>
- <refmiscinfo class="version"></refmiscinfo>
</refmeta>
<refnamediv>
@@ -46,12 +45,16 @@
<refsect1><title>Description</title>
<para><command>udevd</command> listens to kernel uevents.
- For every event, 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, 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
+ dynamically with <command>udevadm control</command>, or
+ configured using
+ <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ </para>
</refsect1>
<refsect1><title>Options</title>
@@ -159,29 +162,12 @@
</variablelist>
</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>
diff --git a/src/udev/udev.conf b/src/udev/udev.conf
index f39253eb67..47d1433002 100644
--- a/src/udev/udev.conf
+++ b/src/udev/udev.conf
@@ -1,3 +1,3 @@
-# see udev(7) for details
+# see udev.conf(5) for details
#udev_log="info"