chiark / gitweb /
man: recreate from xml
authorKay Sievers <kay.sievers@vrfy.org>
Mon, 27 Nov 2006 09:30:17 +0000 (10:30 +0100)
committerKay Sievers <kay.sievers@vrfy.org>
Mon, 27 Nov 2006 09:30:17 +0000 (10:30 +0100)
extras/volume_id/vol_id.8
udev.7
udevd.8
udevinfo.8
udevmonitor.8
udevsettle.8
udevstart.8
udevtest.8
udevtrigger.8

index d57ecc6..1d7e133 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: vol_id
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: March 2006
 .\"    Manual: vol_id
 .\"    Source: volume_id
@@ -24,28 +24,28 @@ supports all common filesystem formats and detects various raid setups to preven
 .SH "OPTIONS"
 .PP
 \fB\-\-export\fR
-.RS 3n
+.RS 4
 print all values in key/value format to import them into the environment.
 .RE
 .PP
 \fB\-t\fR
-.RS 3n
+.RS 4
 print the filesystem type
 .RE
 .PP
 \fB\-l\fR
-.RS 3n
+.RS 4
 print the label of a volume
 .RE
 .PP
 \fB\-u\fR
-.RS 3n
+.RS 4
 print the uuid of a volume
 .RE
 .SH "ENVIRONMENT"
 .PP
 \fBUDEV_LOG\fR
-.RS 3n
+.RS 4
 Set the syslog priority.
 .RE
 .SH "EXIT STATUS"
diff --git a/udev.7 b/udev.7
index 3d80e13..825f74e 100644 (file)
--- a/udev.7
+++ b/udev.7
@@ -1,6 +1,6 @@
 .\"     Title: udev
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: August 2005
 .\"    Manual: udev
 .\"    Source: udev
@@ -33,20 +33,20 @@ udev expects its main configuration file at
 \fI/etc/udev/udev.conf\fR. It consists of a set of variables allowing the user to override default udev values. The following variables can be set:
 .PP
 \fBudev_root\fR
-.RS 3n
+.RS 4
 Specifies where to place the device nodes in the filesystem. The default value is
 \fI/dev\fR.
 .RE
 .PP
 \fBudev_rules\fR
-.RS 3n
+.RS 4
 The name of the udev rules file or directory to look for files with the suffix
 \fI.rules\fR. Multiple rule files are read in lexical order. The default value is
 \fI/etc/udev/rules.d\fR.
 .RE
 .PP
 \fBudev_log\fR
-.RS 3n
+.RS 4
 The logging priority. Valid values are the numerical syslog priorities or their textual representations:
 \fBerr\fR,
 \fBinfo\fR
@@ -62,181 +62,181 @@ directory or at the location specified value in the configuration file. Every li
 A rule may consists of a list of one or more key value pairs separated by a comma. Each key has a distinct operation, depending on the used operator. Valid operators are:
 .PP
 \fB==\fR
-.RS 3n
+.RS 4
 Compare for equality.
 .RE
 .PP
 \fB!=\fR
-.RS 3n
+.RS 4
 Compare for non\-equality.
 .RE
 .PP
 \fB=\fR
-.RS 3n
+.RS 4
 Assign a value to a key. Keys that represent a list, are reset and only this single value is assigned.
 .RE
 .PP
 \fB+=\fR
-.RS 3n
+.RS 4
 Add the value to a key that holds a list of entries.
 .RE
 .PP
 \fB:=\fR
-.RS 3n
+.RS 4
 Assign a value to a key finally; disallow any later changes, which may be used to prevent changes by any later rules.
 .RE
 .PP
 The following key names can be used to match against device properties:
 .PP
 \fBACTION\fR
-.RS 3n
+.RS 4
 Match the name of the event action.
 .RE
 .PP
 \fBDEVPATH\fR
-.RS 3n
+.RS 4
 Match the devpath of the event device.
 .RE
 .PP
 \fBKERNEL\fR
-.RS 3n
+.RS 4
 Match the name of the event device.
 .RE
 .PP
 \fBSUBSYSTEM\fR
-.RS 3n
+.RS 4
 Match the subsystem of the event device.
 .RE
 .PP
 \fBATTR{\fR\fB\fIfilename\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 Match sysfs attribute values of the event device. Up to five
 \fBATTR\fR
 keys can be specified per rule. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself. Depending on the type of operator, this key is also used to set the value of a sysfs attribute.
 .RE
 .PP
 \fBKERNELS\fR
-.RS 3n
+.RS 4
 Search the devpath upwards for a matching device name.
 .RE
 .PP
 \fBSUBSYSTEMS\fR
-.RS 3n
+.RS 4
 Search the devpath upwards for a matching device subsystem name.
 .RE
 .PP
 \fBDRIVERS\fR
-.RS 3n
+.RS 4
 Search the devpath upwards for a matching device driver name.
 .RE
 .PP
 \fBATTRS{\fR\fB\fIfilename\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 Search the devpath upwards for a device with matching sysfs attribute values. Up to five
 \fBATTRS\fR
 keys can be specified per rule. All attributes must match on the same device. Trailing whitespace in the attribute values is ignored, if the specified match value does not contain trailing whitespace itself.
 .RE
 .PP
 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 Match against the value of an environment variable. Up to five
 \fBENV\fR
 keys can be specified per rule. Depending on the type of operator, this key is also used to export a variable to the environment.
 .RE
 .PP
 \fBPROGRAM\fR
-.RS 3n
+.RS 4
 Execute external program. The key is true, if the program returns without exit code zero. The whole event environment is available to the executed program. The program's output printed to stdout is available for the RESULT key.
 .RE
 .PP
 \fBRESULT\fR
-.RS 3n
+.RS 4
 Match the returned string of the last PROGRAM call. This key can be used in the same or in any later rule after a PROGRAM call.
 .RE
 .PP
 Most of the fields support a shell style pattern matching. The following pattern characters are supported:
 .PP
 \fB*\fR
-.RS 3n
+.RS 4
 Matches zero, or any number of characters.
 .RE
 .PP
 \fB?\fR
-.RS 3n
+.RS 4
 Matches any single character.
 .RE
 .PP
 \fB[]\fR
-.RS 3n
+.RS 4
 Matches any single character specified within the brackets. For example, the pattern string 'tty[SR]' would match either 'ttyS' or 'ttyR'. Ranges are also supported within this match with the '\-' character. For example, to match on the range of all digits, the pattern [0\-9] would be used. If the first character following the '[' is a '!', any characters not enclosed are matched.
 .RE
 .PP
 The following keys can get values assigned:
 .PP
 \fBNAME\fR
-.RS 3n
+.RS 4
 The name of the node to be created, or the name the network interface should be renamed to. Only one rule can set the node name, all later rules with a NAME key will be ignored.
 .RE
 .PP
 \fBSYMLINK\fR
-.RS 3n
+.RS 4
 The name of a symlink targeting the node. Every matching rule can add this value to the list of symlinks to be created along with the device node. Multiple symlinks may be specified by separating the names by the space character.
 .RE
 .PP
 \fBOWNER, GROUP, MODE\fR
-.RS 3n
+.RS 4
 The permissions for the device node. Every specified value overwrites the compiled\-in default value.
 .RE
 .PP
 \fBATTR{\fR\fB\fIkey\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 The value that should be written to a sysfs attribute of the event device. Depending on the type of operator, this key is also used to match against the value of a sysfs attribute.
 .RE
 .PP
 \fBENV{\fR\fB\fIkey\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 Export a variable to the environment. Depending on the type of operator, this key is also to match against an environment variable.
 .RE
 .PP
 \fBRUN\fR
-.RS 3n
+.RS 4
 Add a program to the list of programs to be executed for a specific device. This can only be used for very short running tasks. Running an event process for a long period of time may block all further events for this or a dependent device. Long running tasks need to be immediately detached from the event process itself.
 .RE
 .PP
 \fBLABEL\fR
-.RS 3n
+.RS 4
 Named label where a GOTO can jump to.
 .RE
 .PP
 \fBGOTO\fR
-.RS 3n
+.RS 4
 Jumps to the next LABEL with a matching name
 .RE
 .PP
 \fBIMPORT{\fR\fB\fItype\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 Import a set of variables into the event environment, depending on
 \fItype\fR:
-.RS 3n
+.RS 4
 .PP
 \fBprogram\fR
-.RS 3n
+.RS 4
 Execute an external program specified as the assigned value and import its output, which must be in environment key format.
 .RE
 .PP
 \fBfile\fR
-.RS 3n
+.RS 4
 Import a text file specified as the assigned value, which must be in environment key format.
 .RE
 .PP
 \fBparent\fR
-.RS 3n
+.RS 4
 Import the stored keys from the parent device by reading the database entry of the parent device. The value assigned to
 \fBIMPORT{parent}\fR
 is used as a filter of key names to import (with the same shell\-style pattern matching used for comparisons).
 .RE
 .RE
-.IP "" 3n
+.IP "" 4
 If no option is given, udev will choose between
 \fBprogram\fR
 and
@@ -245,12 +245,12 @@ based on the executable bit of of the file permissions.
 .RE
 .PP
 \fBWAIT_FOR_SYSFS\fR
-.RS 3n
+.RS 4
 Wait for the specified sysfs file of the device to be created. Can be used to fight against kernel sysfs timing issues.
 .RE
 .PP
 \fBOPTIONS\fR
-.RS 3n
+.RS 4
 \fBlast_rule\fR
 stops further rules application. No later rules will have any effect.
 \fBignore_device\fR
@@ -274,22 +274,22 @@ fields support simple printf\-like string substitutions. The
 format chars gets applied after all rules have been processed, right before the program is executed. It allows the use of the complete environment set by earlier matching rules. For all other fields, substitutions are applied while the individual rule is being processed. The available substitutions are:
 .PP
 \fB$kernel\fR, \fB%k\fR
-.RS 3n
+.RS 4
 The kernel name for this device.
 .RE
 .PP
 \fB$number\fR, \fB%n\fR
-.RS 3n
+.RS 4
 The kernel number for this device. For example, 'sda3' has kernel number of '3'
 .RE
 .PP
 \fB$devpath\fR, \fB%p\fR
-.RS 3n
+.RS 4
 The devpath of the device.
 .RE
 .PP
 \fB$id\fR, \fB%b\fR
-.RS 3n
+.RS 4
 The name of the device matched while searching the devpath upwards for
 \fBSUBSYSTEMS\fR,
 \fBKERNELS\fR,
@@ -299,54 +299,54 @@ and
 .RE
 .PP
 \fB$attr{\fR\fB\fIfile\fR\fR\fB}\fR, \fB%s{\fR\fB\fIfile\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 The value of a sysfs attribute found at the device, where all keys of the rule have matched. If the matching device does not have such an attribute, all devices along the chain of parents are searched for a matching attribute. If the attribute is a symlink, the last element of the symlink target is returned as the value.
 .RE
 .PP
 \fB$env{\fR\fB\fIkey\fR\fR\fB}\fR, \fB%E{\fR\fB\fIkey\fR\fR\fB}\fR
-.RS 3n
+.RS 4
 The value of an environment variable.
 .RE
 .PP
 \fB$major\fR, \fB%M\fR
-.RS 3n
+.RS 4
 The kernel major number for the device.
 .RE
 .PP
 \fB$minor\fR \fB%m\fR
-.RS 3n
+.RS 4
 The kernel minor number for the device.
 .RE
 .PP
 \fB$result\fR, \fB%c\fR
-.RS 3n
+.RS 4
 The string returned by the external program requested with PROGRAM. A single part of the string, separated by a space character may be selected by specifying the part number as an attribute:
 \fB%c{N}\fR. If the number is followed by the '+' char this part plus all remaining parts of the result string are substituted:
 \fB%c{N+}\fR
 .RE
 .PP
 \fB$parent\fR, \fB%P\fR
-.RS 3n
+.RS 4
 The node name of the parent device.
 .RE
 .PP
 \fB$root\fR, \fB%r\fR
-.RS 3n
+.RS 4
 The udev_root value.
 .RE
 .PP
 \fB$tempnode\fR, \fB%N\fR
-.RS 3n
+.RS 4
 The name of a created temporary device node to provide access to the device from a external program before the real node is created.
 .RE
 .PP
 \fB%%\fR
-.RS 3n
+.RS 4
 The '%' character itself.
 .RE
 .PP
 \fB$$\fR
-.RS 3n
+.RS 4
 The '$' character itself.
 .RE
 .PP
diff --git a/udevd.8 b/udevd.8
index 4243064..f40a959 100644 (file)
--- a/udevd.8
+++ b/udevd.8
@@ -1,6 +1,6 @@
 .\"     Title: udevd
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: August 2005
 .\"    Manual: udevd, udevcontrol
 .\"    Source: udev
@@ -23,27 +23,27 @@ udevd listens to kernel uevents and passes the incoming events to udev. It ensur
 .SH "OPTIONS"
 .PP
 \fB\-\-daemon\fR
-.RS 3n
+.RS 4
 Detach and run in the background.
 .RE
 .PP
 \fB\-\-debug\-trace\fR
-.RS 3n
+.RS 4
 Run all events completely serialized. This may be useful if udev triggers actions or loads kernel modules which cause problems and a slow but continiuous operation is needed, where no events are processed in parallel.
 .RE
 .PP
 \fB\-\-verbose\fR
-.RS 3n
+.RS 4
 Print log messages to stdout.
 .RE
 .PP
 \fB\-\-help\fR
-.RS 3n
+.RS 4
 Print usage.
 .RE
 .PP
 \fBlog_priority=\fR\fB\fIvalue\fR\fR
-.RS 3n
+.RS 4
 udevcontrol can dynamically set the log level of udevd. Valid values are the numerical syslog priorities or their textual representations:
 \fBerr\fR,
 \fBinfo\fR
@@ -52,18 +52,18 @@ and
 .RE
 .PP
 \fBstop_exec_queue\fR
-.RS 3n
+.RS 4
 udevcontrol stops the execution of events from udevd.
 .RE
 .PP
 \fBstart_exec_queue\fR
-.RS 3n
+.RS 4
 udevcontrol starts the execution of events from udevd.
 .RE
 .SH "ENVIRONMENT"
 .PP
 \fBUDEV_LOG\fR
-.RS 3n
+.RS 4
 Overrides the syslog priority specified in the config file.
 .RE
 .SH "AUTHOR"
index 7ba7e70..c22ddfd 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: udevinfo
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: August 2005
 .\"    Manual: udevinfo
 .\"    Source: udev
@@ -21,7 +21,7 @@ udevinfo queries the udev database for device information stored in the udev dat
 .SH "OPTIONS"
 .PP
 \fB\-\-query=\fR\fB\fItype\fR\fR
-.RS 3n
+.RS 4
 Query the database for specified type of device data. It needs the
 \fB\-\-path\fR
 or
@@ -35,17 +35,17 @@ to identify the specified device. Valid queries are:
 .RE
 .PP
 \fB\-\-path=\fR\fB\fIdevpath\fR\fR
-.RS 3n
+.RS 4
 The devpath of the device to query.
 .RE
 .PP
 \fB\-\-name=\fR\fB\fInode\fR\fR
-.RS 3n
+.RS 4
 The name of the device node or a symlink to query
 .RE
 .PP
 \fB\-\-root\fR
-.RS 3n
+.RS 4
 The udev root directory:
 \fI/dev\fR. If used in conjunction with a
 \fBname\fR
@@ -55,17 +55,17 @@ query, the query returns the absolute path including the root directory.
 .RE
 .PP
 \fB\-\-attribute\-walk\fR
-.RS 3n
+.RS 4
 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.
 .RE
 .PP
 \fB\-\-export\fR
-.RS 3n
+.RS 4
 Export the content of the udev database.
 .RE
 .PP
 \fB\-\-help\fR
-.RS 3n
+.RS 4
 Print help text.
 .RE
 .SH "AUTHOR"
index a43ea40..1fbf01e 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: udevmonitor
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: August 2005
 .\"    Manual: udevmonitor
 .\"    Source: udev
@@ -17,11 +17,11 @@ udevmonitor \- print the kernel and udev event sequence to the console
 \fBudevmonitor\fR [\fB\-\-env\fR]
 .SH "DESCRIPTION"
 .PP
-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.
+udevmonitor listens to the kernel uevents and events sent out by a udev rule and prints the devpath of the event to the console. It can be used to analyze the event timing, by comparing the timestamps of the kernel uevent and the udev event.
 .SH "OPTIONS"
 .PP
 \fB\-\-env\fR
-.RS 3n
+.RS 4
 Print the complete environment for all events. Can be used to compare the kernel supplied and the udev added environment values.
 .RE
 .SH "AUTHOR"
index bf0cb06..0e463bd 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: udevsettle
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: March 2006
 .\"    Manual: udevsettle
 .\"    Source: udev
@@ -21,13 +21,13 @@ Waits watching the udev event queue and exits if all current events are handled.
 .SH "OPTIONS"
 .PP
 \fB\-\-timeout=\fR\fB\fIseconds\fR\fR
-.RS 3n
+.RS 4
 maximum seconds to wait for the queue to become empty.
 .RE
 .SH "ENVIRONMENT"
 .PP
 \fBUDEV_LOG\fR
-.RS 3n
+.RS 4
 Overrides the syslog priority specified in the config file.
 .RE
 .SH "AUTHOR"
index 3357c89..c8a7c6f 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: udevstart
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: August 2005
 .\"    Manual: udevstart
 .\"    Source: udev
index bb5e98c..cf6057e 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: udevtest
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: August 2005
 .\"    Manual: udevtest
 .\"    Source: udev
index 300f8e8..957decc 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: udevtrigger
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
 .\"      Date: March 2006
 .\"    Manual: udevtrigger
 .\"    Source: udev
@@ -21,43 +21,43 @@ Trigger kernel device uevents to replay missing events at system coldplug.
 .SH "OPTIONS"
 .PP
 \fB\-\-verbose\fR
-.RS 3n
+.RS 4
 Print the list of devices which will be triggered.
 .RE
 .PP
 \fB\-\-dry\-run\fR
-.RS 3n
+.RS 4
 Do not actually trigger the event.
 .RE
 .PP
 \fB\-\-retry\-failed\fR
-.RS 3n
+.RS 4
 Trigger only the events which are failed during a previous run.
 .RE
 .PP
 \fB\-\-subsystem\-match=\fR\fB\fIsubsystem\fR\fR
-.RS 3n
+.RS 4
 Trigger events for devices which belong to a matching subsystem. This option can be specified multiple times and supports shell style pattern matching.
 .RE
 .PP
 \fB\-\-subsystem\-nomatch=\fR\fB\fIsubsystem\fR\fR
-.RS 3n
+.RS 4
 Do not trigger events for devices which belong to a matching subsystem. This option can be specified multiple times and supports shell style pattern matching.
 .RE
 .PP
 \fB\-\-attr\-match=\fR\fB\fIattribute=value\fR\fR
-.RS 3n
+.RS 4
 Trigger events for devices with a matching sysfs attribute. If a value is specified along with the attribute name, the content of the attribute is matched against the given value using shell style pattern matching. If no value is specified, the existence of the sysfs attribute is checked. This option can be specified multiple times.
 .RE
 .PP
 \fB\-\-attr\-nomatch\fR\fB\fIattribute=value\fR\fR
-.RS 3n
+.RS 4
 Do not trigger events for devices with a matching sysfs attribute. If a value is specified along with the attribute name, the content of the attribute is matched against the given value using shell style pattern matching. If no value is specified, the existence of the sysfs attribute is checked. This option can be specified multiple times.
 .RE
 .SH "ENVIRONMENT"
 .PP
 \fBUDEV_LOG\fR
-.RS 3n
+.RS 4
 Overrides the syslog priority specified in the config file.
 .RE
 .SH "AUTHOR"