diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/udevd.xml | 99 | ||||
| -rw-r--r-- | docs/udevinfo.xml | 131 | ||||
| -rw-r--r-- | docs/udevmonitor.xml | 76 | ||||
| -rw-r--r-- | docs/udevstart.xml | 62 | ||||
| -rw-r--r-- | docs/udevtest.xml | 62 |
5 files changed, 430 insertions, 0 deletions
diff --git a/docs/udevd.xml b/docs/udevd.xml new file mode 100644 index 0000000000..eeaec4402f --- /dev/null +++ b/docs/udevd.xml @@ -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 index 0000000000..b8ced7f174 --- /dev/null +++ b/docs/udevinfo.xml @@ -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 index 0000000000..6f1e347f84 --- /dev/null +++ b/docs/udevmonitor.xml @@ -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 index 0000000000..f917287086 --- /dev/null +++ b/docs/udevstart.xml @@ -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 index 0000000000..ceea0413c5 --- /dev/null +++ b/docs/udevtest.xml @@ -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> |