From 420a506ef00b011ddb50249c0c53c07cbc37e04c Mon Sep 17 00:00:00 2001 From: Kay Sievers Date: Tue, 30 Aug 2005 04:41:42 +0200 Subject: write man page masters in DocBook XML 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 --- docs/udevd.xml | 99 ++++++++++++++++++++++++++++++++++++++ docs/udevinfo.xml | 131 +++++++++++++++++++++++++++++++++++++++++++++++++++ docs/udevmonitor.xml | 76 ++++++++++++++++++++++++++++++ docs/udevstart.xml | 62 ++++++++++++++++++++++++ docs/udevtest.xml | 62 ++++++++++++++++++++++++ 5 files changed, 430 insertions(+) create mode 100644 docs/udevd.xml create mode 100644 docs/udevinfo.xml create mode 100644 docs/udevmonitor.xml create mode 100644 docs/udevstart.xml create mode 100644 docs/udevtest.xml (limited to 'docs') 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 @@ + + + +
+ + xmlto + + Kay + Sievers + kay.sievers@vrfy.org + + + 2005 + Kay Sievers + + + +
+ udevd, udevsend, udevcontrol + + + udevd + August 2005 + udev + + + + udevd + 8 + + + + udevdevent managing daemon + + + + + udevd + + + + udevcontrol command + + + udevsend subsystem + + + + DESCRIPTION + 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. + + + OPTIONS + + + + + Detach and run in the background. + + + + + + udevcontrol can dynamically set the log level of udevd. + Valid values are the numerical syslog priorities or their textual + representations: err, info and debug. + + + + + + udevcontrol stops the execution of events from udevd. + + + + + + udevcontrol starts the execution of events from udevd. + + + + + + AUTHOR + Written by Kay Sievers kay.sievers@vrfy.org. + + + + SEE ALSO + + udev8 + + + +
+
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 @@ + + + +
+ + xmlto + + Kay + Sievers + kay.sievers@vrfy.org + + + 2005 + Kay Sievers + + + +
+ udevinfo + + + udevinfo + August 2005 + udev + + + + udevinfo + 8 + + + + udevinfoquery device information from the udev database + + + + + udevinfo + + + + + + + + + + + + DESCRIPTION + 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. + + + OPTIONS + + + + + Query the database for specified type of device data. It needs the + or to identify the specified + device. Valid queries are: + name, symlink, path, + env, all. + + + + + + + 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. + + + + + + + The sysfs path of the device to query. + + + + + + + The name of the device node or a symlink to query + + + + + + + The udev root directory: /dev. If used in conjunction + with a name or symlink query, the + query returns the absolute path. + + + + + + + Export the content of the udev database. + + + + + + + Print help text. + + + + + + AUTHOR + Written by Kay Sievers kay.sievers@vrfy.org. + + + + SEE ALSO + + udev8 + + + +
+
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 @@ + + + +
+ + xmlto + + Kay + Sievers + kay.sievers@vrfy.org + + + 2005 + Kay Sievers + + + +
+ udevmonitor + + + udevmonitor + August 2005 + udev + + + + udevmonitor + 8 + + + + udevmonitor + print the kernel and udev event sequence to the console + + + + + udevmonitor + + + + + DESCRIPTION + 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. + + + + OPTIONS + + + + + Print the complete environment for all events. Can be used to compare the + kernel supplied and the udev added environment values. + + + + + + AUTHOR + Written by Kay Sievers kay.sievers@vrfy.org. + + + + SEE ALSO + + udev8 + + + +
+
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 @@ + + + +
+ + xmlto + + Kay + Sievers + kay.sievers@vrfy.org + + + 2005 + Kay Sievers + + + +
+ udevstart + + + udevstart + August 2005 + udev + + + + udevstart + 8 + + + + udevstartpopulate initial device directory + + + + + udevstart + + + + DESCRIPTION + 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. + + + AUTHOR + Written by Harald Hoyer harald@redhat.com. + + + + SEE ALSO + + udev8 + + + +
+
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 @@ + + + +
+ + xmlto + + Kay + Sievers + kay.sievers@vrfy.org + + + 2005 + Kay Sievers + + + +
+ udevtest + + + udevtest + August 2005 + udev + + + + udevtest + 8 + + + + udevtest + simulate a udev run and print the action to the console + + + + + udevtest device-path subsystem + + + + DESCRIPTION + 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. + + + AUTHOR + Written by Greg Kroah-Hartman greg@kroah.com. + + + + SEE ALSO + + udev8 + + + +
+
-- cgit v1.2.3-54-g00ecf