chiark / gitweb /
write man page masters in DocBook XML
authorKay Sievers <kay.sievers@suse.de>
Tue, 30 Aug 2005 02:41:42 +0000 (04:41 +0200)
committerKay Sievers <kay.sievers@suse.de>
Tue, 30 Aug 2005 02:41:42 +0000 (04:41 +0200)
The troff man pages will still be checked into the tree but the
source is DocBook XML format living in the docs/ directory now.
Start with the easy ones, the main udev page is still left to
rewrite.

Signed-off-by: Kay Sievers <kay.sievers@suse.de>
Makefile
docs/udevd.xml [new file with mode: 0644]
docs/udevinfo.xml [new file with mode: 0644]
docs/udevmonitor.xml [new file with mode: 0644]
docs/udevstart.xml [new file with mode: 0644]
docs/udevtest.xml [new file with mode: 0644]
udev.8 [moved from udev.8.in with 100% similarity]
udevd.8
udevinfo.8
udevstart.8
udevtest.8

index 8f99330..1e6dd55 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -158,6 +158,13 @@ OBJS = \
 
 SYSFS = $(PWD)/libsysfs/sysfs.a
 
+MAN_PAGES = \
+       udevmonitor.8                           \
+       udevd.8                         \
+       udevtest.8                      \
+       udevinfo.8                      \
+       udevstart.8
+
 CFLAGS +=      -I$(PWD)/libsysfs/sysfs \
                -I$(PWD)/libsysfs
 
@@ -262,11 +269,9 @@ udev_version.h:
 $(LOCAL_CFG_DIR)/udev.conf:
        sed -e "s:@udevdir@:$(udevdir):" -e "s:@configdir@:$(configdir):" < $(LOCAL_CFG_DIR)/udev.conf.in > $@
 
-GEN_MANPAGES   = udev.8
-GEN_MANPAGESIN = udev.8.in
-# Rules on how to create the man pages
-$(GEN_MANPAGES): $(GEN_MANPAGESIN)
-       sed -e "s:@udevdir@:$(udevdir):" < $@.in > $@
+# man pages
+%.8: docs/%.xml
+       xmlto man $?
 
 $(UDEV_OBJS): $(HEADERS) $(GEN_HEADERS) $(HOST_PROGS) $(KLCC)
 $(SYSFS_OBJS): $(HEADERS) $(HOST_PROGS) $(KLCC)
@@ -283,7 +288,7 @@ $(CONTROL).o: $(HEADERS) $( $(HEADERS)GEN_HEADERS) $(HOST_PROGS) $(KLCC)
 $(MONITOR).o: $(HEADERS) $( $(HEADERS)GEN_HEADERS) $(HOST_PROGS) $(KLCC)
 $(STARTER).o: $(HEADERS) $(GEN_HEADERS) $(HOST_PROGS) $(KLCC)
 
-$(ROOT): $(KLCC) $(ROOT).o $(OBJS) $(HEADERS) $(GEN_MANPAGES)
+$(ROOT): $(KLCC) $(ROOT).o $(OBJS) $(HEADERS) $(MAN_PAGES)
        $(QUIET) $(LD) $(LDFLAGS) -o $@ $(ROOT).o $(OBJS) $(LIB_OBJS)
        $(QUIET) $(STRIPCMD) $@
 
@@ -333,7 +338,7 @@ $(STARTER): $(KLCC) $(STARTER).o $(OBJS)
 clean:
        -find . \( -not -type d \) -and \( -name '*~' -o -name '*.[oas]' \) -type f -print \
         | xargs rm -f 
-       -rm -f core $(ROOT) $(GEN_HEADERS) $(GEN_CONFIGS) $(GEN_MANPAGES) $(INFO) $(DAEMON) \
+       -rm -f core $(ROOT) $(GEN_HEADERS) $(GEN_CONFIGS) $(INFO) $(DAEMON) \
         $(SENDER) $(COMPILE) $(INITSENDER) $(RECORDER) $(CONTROL) $(MONITOR) $(TESTER) $(STARTER)
        -rm -f ccdv
        $(MAKE) -C klibc SUBDIRS=klibc clean
@@ -369,7 +374,9 @@ install-man:
        $(INSTALL_DATA) -D udevtest.8 $(DESTDIR)$(mandir)/man8/udevtest.8
        $(INSTALL_DATA) -D udevstart.8 $(DESTDIR)$(mandir)/man8/udevstart.8
        $(INSTALL_DATA) -D udevd.8 $(DESTDIR)$(mandir)/man8/udevd.8
+       $(INSTALL_DATA) -D udevmonitor.8 $(DESTDIR)$(mandir)/man8/udevmonitor.8
        - ln -f -s udevd.8 $(DESTDIR)$(mandir)/man8/udevsend.8
+       - ln -f -s udevd.8 $(DESTDIR)$(mandir)/man8/udevcontrol.8
 
 uninstall-man:
        - rm $(mandir)/man8/udev.8
@@ -377,7 +384,9 @@ uninstall-man:
        - rm $(mandir)/man8/udevtest.8
        - rm $(mandir)/man8/udevstart.8
        - rm $(mandir)/man8/udevd.8
+       - rm $(mandir)/man8/udevmonitor.8
        - rm $(mandir)/man8/udevsend.8
+       - rm $(mandir)/man8/udevcontrol.8
 
 install: install-config install-man all
        $(INSTALL) -d $(DESTDIR)$(udevdir)
diff --git a/docs/udevd.xml b/docs/udevd.xml
new file mode 100644 (file)
index 0000000..eeaec44
--- /dev/null
@@ -0,0 +1,99 @@
+<?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>
+  <articleinfo>
+    <title>xmlto</title>
+    <author>
+      <firstname>Kay</firstname>
+      <surname>Sievers</surname>
+      <email>kay.sievers@vrfy.org</email>
+    </author>
+    <copyright>
+      <year>2005</year>
+      <holder>Kay Sievers</holder>
+    </copyright>
+  </articleinfo>
+
+  <section>
+    <title>udevd, udevsend, udevcontrol</title>
+    <refentry>
+      <refentryinfo>
+        <title>udevd</title>
+        <date>August 2005</date>
+        <productname>udev</productname>
+      </refentryinfo>
+
+      <refmeta>
+        <refentrytitle>udevd</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </refmeta>
+
+      <refnamediv>
+        <refname>udevd</refname><refpurpose>event managing daemon</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>udevd</command>
+          <arg><option>--daemon</option></arg>
+        </cmdsynopsis>
+        <cmdsynopsis>
+          <command>udevcontrol <replaceable>command</replaceable></command>
+        </cmdsynopsis>
+        <cmdsynopsis>
+          <command>udevsend <replaceable>subsystem</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>log_priority=<replaceable>value</replaceable></option></term>
+            <listitem>
+              <para>udevcontrol can dynamically set the log level of udevd.
+              Valid values are the numerical syslog priorities or their textual
+              representations: err, info and debug.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>stop_exec_queue</option></term>
+            <listitem>
+              <para>udevcontrol stops the execution of events from udevd.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term><option>start_exec_queue</option></term>
+            <listitem>
+              <para>udevcontrol starts the execution of events from udevd.</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>8</manvolnum>
+        </citerefentry></para>
+      </refsect1>
+    </refentry>
+  </section>
+</article>
diff --git a/docs/udevinfo.xml b/docs/udevinfo.xml
new file mode 100644 (file)
index 0000000..b8ced7f
--- /dev/null
@@ -0,0 +1,131 @@
+<?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>
+  <articleinfo>
+    <title>xmlto</title>
+    <author>
+      <firstname>Kay</firstname>
+      <surname>Sievers</surname>
+      <email>kay.sievers@vrfy.org</email>
+    </author>
+    <copyright>
+      <year>2005</year>
+      <holder>Kay Sievers</holder>
+    </copyright>
+  </articleinfo>
+
+  <section>
+    <title>udevinfo</title>
+    <refentry>
+      <refentryinfo>
+        <title>udevinfo</title>
+        <date>August 2005</date>
+        <productname>udev</productname>
+      </refentryinfo>
+
+      <refmeta>
+        <refentrytitle>udevinfo</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </refmeta>
+
+      <refnamediv>
+        <refname>udevinfo</refname><refpurpose>query device information from the udev database</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>udevinfo</command>
+          <arg><option>-q <replaceable>query-type</replaceable></option></arg>
+          <arg><option>-a </option></arg>
+          <arg><option>-p <replaceable>device-path</replaceable></option></arg>
+          <arg><option>-n <replaceable>node-name</replaceable></option></arg>
+          <arg><option>-r</option></arg>
+          <arg><option>-e</option></arg>
+          <arg><option>-V</option></arg>
+          <arg><option>-h</option></arg>
+        </cmdsynopsis>
+      </refsynopsisdiv>
+
+      <refsect1><title>DESCRIPTION</title>
+        <para>udevinfo queries the udev database for device information
+        stored in the udev database. udevinfo also queries the properties
+        of a device from its sysfs representation to help creating udev
+        rules to match this device.</para>
+      </refsect1>
+
+      <refsect1><title>OPTIONS</title>
+        <variablelist>
+          <varlistentry>
+            <term><option>-q</option></term>
+            <listitem>
+              <para>Query the database for specified type of device data. It needs the
+              <option>-p</option> or <option>-n</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>-a</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>-p <replaceable>device-path</replaceable></option></term>
+            <listitem>
+              <para>The sysfs path of the device to query.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>-n <replaceable>node-name</replaceable></option></term>
+            <listitem>
+              <para>The name of the device node or a symlink to query</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>-r</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.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>-e</option></term>
+            <listitem>
+              <para>Export the content of the udev database.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>-h</option></term>
+            <listitem>
+              <para>Print help text.</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>8</manvolnum>
+        </citerefentry></para>
+      </refsect1>
+    </refentry>
+  </section>
+</article>
diff --git a/docs/udevmonitor.xml b/docs/udevmonitor.xml
new file mode 100644 (file)
index 0000000..6f1e347
--- /dev/null
@@ -0,0 +1,76 @@
+<?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>
+  <articleinfo>
+    <title>xmlto</title>
+    <author>
+      <firstname>Kay</firstname>
+      <surname>Sievers</surname>
+      <email>kay.sievers@vrfy.org</email>
+    </author>
+    <copyright>
+      <year>2005</year>
+      <holder>Kay Sievers</holder>
+    </copyright>
+  </articleinfo>
+
+  <section>
+    <title>udevmonitor</title>
+    <refentry>
+      <refentryinfo>
+        <title>udevmonitor</title>
+        <date>August 2005</date>
+        <productname>udev</productname>
+      </refentryinfo>
+
+      <refmeta>
+        <refentrytitle>udevmonitor</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </refmeta>
+
+      <refnamediv>
+        <refname>udevmonitor</refname>
+        <refpurpose>print the kernel and udev event sequence to the console</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>udevmonitor</command>
+          <arg><option>--env</option></arg>
+        </cmdsynopsis>
+      </refsynopsisdiv>
+
+      <refsect1><title>DESCRIPTION</title>
+        <para>udevmonitor listens to the kernel uevents and events send out by a udev rule
+        and prints the devpath of the event to the console. It can be used analyze to the
+        event timing by comparing the timestamps of the kernel uevent with the udev event.
+        </para>
+      </refsect1>
+
+      <refsect1><title>OPTIONS</title>
+        <variablelist>
+          <varlistentry>
+            <term><option>--env</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>
+        </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>8</manvolnum>
+        </citerefentry></para>
+      </refsect1>
+    </refentry>
+  </section>
+</article>
diff --git a/docs/udevstart.xml b/docs/udevstart.xml
new file mode 100644 (file)
index 0000000..f917287
--- /dev/null
@@ -0,0 +1,62 @@
+<?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>
+  <articleinfo>
+    <title>xmlto</title>
+    <author>
+      <firstname>Kay</firstname>
+      <surname>Sievers</surname>
+      <email>kay.sievers@vrfy.org</email>
+    </author>
+    <copyright>
+      <year>2005</year>
+      <holder>Kay Sievers</holder>
+    </copyright>
+  </articleinfo>
+
+  <section>
+    <title>udevstart</title>
+    <refentry>
+      <refentryinfo>
+        <title>udevstart</title>
+        <date>August 2005</date>
+        <productname>udev</productname>
+      </refentryinfo>
+
+      <refmeta>
+        <refentrytitle>udevstart</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </refmeta>
+
+      <refnamediv>
+        <refname>udevstart</refname><refpurpose>populate initial device directory</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>udevstart</command>
+        </cmdsynopsis>
+      </refsynopsisdiv>
+
+      <refsect1><title>DESCRIPTION</title>
+        <para>udevstart scans the kernel exported device information available in
+        sysfs for devices which require a device node to operate and creates the node
+        using the specified udev rules. udevstart is used to create the initial
+        device directory after system bootup.</para>
+      </refsect1>
+
+      <refsect1><title>AUTHOR</title>
+        <para>Written by Harald Hoyer <email>harald@redhat.com</email>.</para>
+      </refsect1>
+
+      <refsect1>
+        <title>SEE ALSO</title>
+        <para><citerefentry>
+            <refentrytitle>udev</refentrytitle><manvolnum>8</manvolnum>
+        </citerefentry></para>
+      </refsect1>
+    </refentry>
+  </section>
+</article>
diff --git a/docs/udevtest.xml b/docs/udevtest.xml
new file mode 100644 (file)
index 0000000..ceea041
--- /dev/null
@@ -0,0 +1,62 @@
+<?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>
+  <articleinfo>
+    <title>xmlto</title>
+    <author>
+      <firstname>Kay</firstname>
+      <surname>Sievers</surname>
+      <email>kay.sievers@vrfy.org</email>
+    </author>
+    <copyright>
+      <year>2005</year>
+      <holder>Kay Sievers</holder>
+    </copyright>
+  </articleinfo>
+
+  <section>
+    <title>udevtest</title>
+    <refentry>
+      <refentryinfo>
+        <title>udevtest</title>
+        <date>August 2005</date>
+        <productname>udev</productname>
+      </refentryinfo>
+
+      <refmeta>
+        <refentrytitle>udevtest</refentrytitle>
+        <manvolnum>8</manvolnum>
+      </refmeta>
+
+      <refnamediv>
+        <refname>udevtest</refname>
+        <refpurpose>simulate a udev run and print the action to the console</refpurpose>
+      </refnamediv>
+
+      <refsynopsisdiv>
+        <cmdsynopsis>
+          <command>udevtest <filename>device-path</filename> <replaceable>subsystem</replaceable></command>
+        </cmdsynopsis>
+      </refsynopsisdiv>
+
+      <refsect1><title>DESCRIPTION</title>
+        <para>udevtest simulates a udev run for the given device and prints out the
+        name of the node udev would have created, or the name of the network interface,
+        that would have been renamend.</para>
+      </refsect1>
+
+      <refsect1><title>AUTHOR</title>
+        <para>Written by Greg Kroah-Hartman <email>greg@kroah.com</email>.</para>
+      </refsect1>
+
+      <refsect1>
+        <title>SEE ALSO</title>
+        <para><citerefentry>
+            <refentrytitle>udev</refentrytitle><manvolnum>8</manvolnum>
+        </citerefentry></para>
+      </refsect1>
+    </refentry>
+  </section>
+</article>
similarity index 100%
rename from udev.8.in
rename to udev.8
diff --git a/udevd.8 b/udevd.8
index 02e2e2c..01b90cc 100644 (file)
--- a/udevd.8
+++ b/udevd.8
@@ -1,43 +1,41 @@
-.TH UDEVD 8 "February 2004" "" "Linux Administrator's Manual"
-.SH NAME
-udevd, udevdsend \- udev event serializer daemon and udev event sender
-.SH SYNOPSIS
-.BI udevsend
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.0).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "UDEVD" "8" "August 2005" "udev" "udevd, udevsend, udevcontrol"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+udevd \- event managing daemon
+.SH "SYNOPSIS"
+.HP 6
+\fBudevd\fR [\fB\-\-daemon\fR]
+.HP 20
+\fBudevcontrol \fR\fB\fIcommand\fR\fR
+.HP 19
+\fBudevsend \fR\fB\fIsubsystem\fR\fR
 .SH "DESCRIPTION"
-.B udevd
-allows the serialization of
-.BR hotplug (8)
-events. The events generated by the kernel may arrive in random order
-in userspace, that makes it neccessary to reorder them.
-.br
-.B udevd
-takes care of the kernel supplied
-.B SEQNUM
-sequence number and arranges the events for execution in the correct order.
-Missing sequences delay the execution of the following events until a timeout
-is reached. Events without any sequence number are bypassing the queue and
-will be executed immediately.
-.br
-For each event a
-.BR udev (8)
-instance is executed in the background with the complete environment received
-by the hotplug event. All further events for the same device are delayed until
-the execution is finished. This way there will never be more than one instance
-running for a single device at the same time.
-.br
-.B udevd
-receives the events from
-.B udevsend
-If
-.B udevd
-isn't already running,
-.B udevsend
-will start it.
+.PP
+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.
+.SH "OPTIONS"
+.TP
+\fB\-\-daemon\fR
+Detach and run in the background.
+.TP
+\fBlog_priority=\fR\fB\fIvalue\fR\fR
+udevcontrol can dynamically set the log level of udevd. Valid values are the numerical syslog priorities or their textual representations: err, info and debug.
+.TP
+\fBstop_exec_queue\fR
+udevcontrol stops the execution of events from udevd.
+.TP
+\fBstart_exec_queue\fR
+udevcontrol starts the execution of events from udevd.
+.SH "AUTHOR"
+.PP
+Written by Kay Sievers 
+<kay.sievers@vrfy.org>.
 .SH "SEE ALSO"
-.BR udev (8),
-.BR udevinfo (8),
-.BR hotplug (8)
-.SH AUTHORS
-.B udevd
-was developed primarily by Kay Sievers <kay.sievers@vrfy.org>, with much help
-from others.
+.PP
+\fBudev\fR(8)
index 28904fe..d8f7bbe 100644 (file)
@@ -1,69 +1,60 @@
-.TH UDEVINFO 8 "January 2004" "" "Linux Administrator's Manual"
-.SH NAME
-udevinfo \- retrieve information from udev
-.SH SYNOPSIS
-.B udevinfo
-.RI "[\-q " query_type " \-p " sysfs_path "] [\-drVh]"
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.0).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "UDEVINFO" "8" "August 2005" "udev" "udevinfo"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+udevinfo \- query device information from the udev database
+.SH "SYNOPSIS"
+.HP 9
+\fBudevinfo\fR [\fB\-q\ \fR\fB\fIquery\-type\fR\fR] [\fB\-a\ \fR] [\fB\-p\ \fR\fB\fIdevice\-path\fR\fR] [\fB\-n\ \fR\fB\fInode\-name\fR\fR] [\fB\-r\fR] [\fB\-e\fR] [\fB\-V\fR] [\fB\-h\fR]
 .SH "DESCRIPTION"
-.B udevinfo
-allows users to query the udev database for information on any device
-currently present on the system.  It also provides a way to query any device
-in the sysfs tree to help creating
-.B udev
-rules.
+.PP
+udevinfo queries the udev database for device information stored in the udev database. udevinfo also queries the properties of a device from its sysfs representation to help creating udev rules to match this device.
 .SH "OPTIONS"
 .TP
-.B \-V
-Print the version information.
-.TP
-.B \-r
-Print the
-.B udev_root
-directory. When used in conjunction with a query for the node name or the
-symlink names, the
-.B udev_root
-will be prepended to query result.
-.TP
-.BI \-q " query_type"
-Query the database for specified value of a created device node or network
-interface.
-.RB Needs " \-p " or " \-n " specified.
-.br
-Valid types are:
-.BR name ", " symlink ", " path " or " all.
-.TP
-.BI \-p " sysfs_path"
-Specify the sysfs path of the device to query.
-.TP
-.BI \-n " name"
-Specify the name of the node, the symlink or the network interface for the
-device to query. Partition names generated with the NAME{all_partitons} option
-can not be queried, the main device must be used instead.
-.TP
-.B \-a
-Print all
-.BI SYSFS{ filename }
-attributes along the device chain. Useful for finding
-unique attributes to compose a rule.
-.RB Needs " \-p " specified.
-.TP
-.B \-d
-Print the relationship between the devpath and the node name for all devices
-currently available in the database.
-.TP
-.B \-e
-Print all attributes for all devices curently available in the database.
-.TP
-.B \-h
+\fB\-q\fR
+Query the database for specified type of device data. It needs the 
+\fB\-p\fR 
+or 
+\fB\-n\fR 
+to identify the specified device. Valid queries are: 
+\fBname\fR, 
+\fBsymlink\fR, 
+\fBpath\fR, 
+\fBenv\fR, 
+\fBall\fR.
+.TP
+\fB\-a\fR
+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.
+.TP
+\fB\-p \fR\fB\fIdevice\-path\fR\fR
+The sysfs path of the device to query.
+.TP
+\fB\-n \fR\fB\fInode\-name\fR\fR
+The name of the device node or a symlink to query
+.TP
+\fB\-r\fR
+The udev root directory: 
+\fI/dev\fR. If used in conjunction with a 
+\fBname\fR 
+or 
+\fBsymlink\fR 
+query, the query returns the absolute path.
+.TP
+\fB\-e\fR
+Export the content of the udev database.
+.TP
+\fB\-h\fR
 Print help text.
-.SH "FILES"
-.nf
-/etc/udev/*  udev config files
-.fi
-.LP
+.SH "AUTHOR"
+.PP
+Written by Kay Sievers 
+<kay.sievers@vrfy.org>.
 .SH "SEE ALSO"
-.BR udev (8)
-.SH AUTHORS
-.B udevinfo
-was developed primarily by Kay Sievers <kay.sievers@vrfy.org>, with help
-from others.
+.PP
+\fBudev\fR(8)
index c64400c..ea7a59e 100644 (file)
@@ -1,18 +1,24 @@
-.TH UDEVSTART 8 "March 2004" "" "Linux Administrator's Manual"
-.SH NAME
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.0).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "UDEVSTART" "8" "August 2005" "udev" "udevstart"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
 udevstart \- populate initial device directory
-.SH SYNOPSIS
-.B udevstart
+.SH "SYNOPSIS"
+.HP 10
+\fBudevstart\fR
 .SH "DESCRIPTION"
-.B udevstart
-walks trough the sysfs device tree and calls
-.B udev
-to create the nodes for every valid device found. It can be used to fill a
-empty device directory with nodes for all devices currently available on
-the system.
+.PP
+udevstart scans the kernel exported device information available in sysfs for devices which require a device node to operate and creates the node using the specified udev rules. udevstart is used to create the initial device directory after system bootup.
+.SH "AUTHOR"
+.PP
+Written by Harald Hoyer 
+<harald@redhat.com>.
 .SH "SEE ALSO"
-.BR udev (8)
-.SH AUTHORS
-.B udevstart
-was developed primarily by Harald Hoyer <harald@redhat.com>, with much help
-from others.
+.PP
+\fBudev\fR(8)
index a595a30..e547811 100644 (file)
@@ -1,19 +1,24 @@
-.TH UDEVTEST 8 "March 2004" "" "Linux Administrator's Manual"
-.SH NAME
-udevtest \- simulates a udev run to test the configured rules
-.SH SYNOPSIS
-.B udevtest
-.I sysfs_device_path subsystem
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.0).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "UDEVTEST" "8" "August 2005" "udev" "udevtest"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+udevtest \- simulate a udev run and print the action to the console
+.SH "SYNOPSIS"
+.HP 31
+\fBudevtest \fR\fB\fIdevice\-path\fR\fR\fB \fR\fB\fIsubsystem\fR\fR
 .SH "DESCRIPTION"
-.B udevtest
-simulates a
-.B udev
-run for the given device, and prints out the name of the node
-the real udev would have created, or the name of the renamed network
-interface.
+.PP
+udevtest simulates a udev run for the given device and prints out the name of the node udev would have created, or the name of the network interface, that would have been renamend.
+.SH "AUTHOR"
+.PP
+Written by Greg Kroah\-Hartman 
+<greg@kroah.com>.
 .SH "SEE ALSO"
-.BR udev (8)
-.SH AUTHORS
-.B udevtest
-was developed by Greg Kroah-Hartman <greg@kroah.com> with much help
-from others.
+.PP
+\fBudev\fR(8)