[PATCH] minor grammer fixes for the udev_vs_devfs document

[elogind.git] / udev.8

diff --git a/udev.8 b/udev.8
index c4ee23dcc78f8cc2cf6bba275f022c86207434a3..5f497af92a8d31106f8d8507f58bb54660803d3b 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,13 +130,20 @@ The line format is:
 where valid methods with corresponding keys are:
 .TP
 .B CALLOUT
-calling external program, that returns a string to match
+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
+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
+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
+.B BUS
+key is optional, but if specified, the sysfs device bus must be able to be
+detemined by a "device" symlink.
 .br
 .RB "keys: " BUS ", " SYSFS_
 .TP
@@ -141,6 +172,9 @@ fields support simple printf-like string substitution:
 The "kernel number" of the device.
 for example, 'sda3' has a "kernel number" of '3'
 .TP
+.B %k
+The "kernel name" for the device.
+.TP
 .B %M
 The kernel major number for the device.
 .TP
@@ -168,6 +202,9 @@ CALLOUT, BUS="scsi", PROGRAM="/sbin/scsi_id", ID="OEM 0815", NAME="disk1"
 # USB printer to be called lp_color
 LABEL, BUS="usb", SYSFS_serial="W09090207101241330", NAME="lp_color"
 
+# SCSI disk with a specific vendor and model number is to be called boot
+LABEL, BUS="scsi", SYSFS_vendor="IBM", SYSFS_model="ST336", NAME="boot%n"
+
 # sound card with PCI bus id 00:0b.0 to be called dsp
 NUMBER, BUS="pci", ID="00:0b.0", NAME="dsp"