chiark / gitweb /
[PATCH] add IGNORE rule type
[elogind.git] / udev.8
diff --git a/udev.8 b/udev.8
index 65af6d0..3eb4aec 100644 (file)
--- a/udev.8
+++ b/udev.8
@@ -3,6 +3,9 @@
 udev \- Linux configurable dynamic device naming support
 .SH SYNOPSIS
 .BI udev " hotplug-subsystem"
+.br
+.B udev
+.RI "[-q " sysfs_path "] [-rVh]"
 .SH "DESCRIPTION"
 .B udev
 creates or removes device node files usually located in the /dev directory.
@@ -26,6 +29,27 @@ maintains a database for devices present on the system.
 On device removal,
 .B udev
 queries the internal database for the name of the device file to be deleted.
+.SH "OPTIONS"
+.B udev
+normally is called by
+.B hotplug
+with the subsystem as argument and various environment variables set.
+.br
+It may also called with the following options:
+.TP
+.B -V
+Print the version information.
+.TP
+.B -r
+Print the the
+.B udev
+root directory.
+.TP
+.BI -q " sysfs_path"
+Query with the sysfs path as argument for the name of the created device node.
+.TP
+.B -h
+Print help text.
 .SH "CONFIGURATION"
 All
 .B udev
@@ -78,7 +102,7 @@ udev_rules="/etc/udev/udev.rules"
 # udev_permissions - The name and location of the udev permission file
 udev_permissions="/etc/udev/udev.permissions"
 
-# default_mode - set the default mode for all nodes that have no 
+# default_mode - set the default mode for all nodes that have no
 #                explicit match in the permissions file
 default_mode="0666"
 .fi
@@ -106,18 +130,18 @@ The line format is:
 where valid methods with corresponding keys are:
 .TP
 .B CALLOUT
-calling external program, that returns a string to match.  The 
-.BR BUS 
+calling external program, that returns a string to match.  The
+.B BUS
 key is optional, but if specified, the sysfs device bus must be able to be
-detemined by a "device" symlink.
+determined by a "device" symlink.
 .br
 .RB "keys: " BUS ", " PROGRAM ", " ID
 .TP
 .B LABEL
 device label or serial number, like USB serial number, SCSI UUID or
 file system label.  Up to 5 different sysfs files can be checked, with
-all of the values being required in order to match the rule.  The 
-.BR BUS 
+all of the values being required in order to match the rule.  The
+.B BUS
 key is optional, but if specified, the sysfs device bus must be able to be
 detemined by a "device" symlink.
 .br
@@ -137,9 +161,15 @@ device position on bus, like physical port of USB device
 string replacement of the kernel device name
 .br
 .RB "key: " KERNEL
+.TP
+.B IGNORE
+tell udev to not care about creation of this device, e.g. because the
+device is already handled by another program
+.br
+.RB "key: " KERNEL
 .P
 The methods are applied in the following order:
-.BR CALLOUT ", " LABEL ", " NUMBER ", " TOPOLOGY ", " REPLACE "."
+.BR IGNORE ", " CALLOUT ", " LABEL ", " NUMBER ", " TOPOLOGY ", " REPLACE "."
 .P
 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 fields support simple printf-like string substitution: