[PATCH] add IGNORE rule type

[elogind.git] / udev.8

diff --git a/udev.8 b/udev.8
index 7b4e17b5c41d1fab754f628b204eca766378e85e..3eb4aecad27b8adbbe3f92f1709d214cb867b10c 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"
 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.
 .SH "DESCRIPTION"
 .B udev
 creates or removes device node files usually located in the /dev directory.


@@ -18,7 +21,7 @@ On device creation,
 .B udev
 reads the sysfs directory of the given device to collect device attributes
 like label, serial number or bus device number.
 .B udev
 reads the sysfs directory of the given device to collect device attributes
 like label, serial number or bus device number.

-These attributes are treated as a key 
+These attributes are treated as a key

 to determine a unique name for device file creation.
 .B udev
 maintains a database for devices present on the system.
 to determine a unique name for device file creation.
 .B udev
 maintains a database for devices present on the system.


@@ -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.
 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
 .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"
 
 # 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
 #                explicit match in the permissions file
 default_mode="0666"
 .fi


@@ -87,7 +111,7 @@ The rules for udev to use when naming devices may specified at
 .I /etc/udev/udev.rules
 or specified by the
 .I udev_rules
 .I /etc/udev/udev.rules
 or specified by the
 .I udev_rules

-value in the 
+value in the

 .I /etc/udev/udev.conf
 file.
 .P
 .I /etc/udev/udev.conf
 file.
 .P


@@ -106,16 +130,22 @@ The line format is:
 where valid methods with corresponding keys are:
 .TP
 .B CALLOUT
 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
 .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
 .br

-.RB "keys: " BUS ", "
-.I sysfs_attribute
+.RB "keys: " BUS ", " SYSFS_

 .TP
 .B NUMBER
 device number on the bus, like PCI bus id
 .TP
 .B NUMBER
 device number on the bus, like PCI bus id


@@ -130,10 +160,16 @@ device position on bus, like physical port of USB device
 .B REPLACE
 string replacement of the kernel device name
 .br
 .B REPLACE
 string replacement of the kernel device name
 .br

-.RB "key: " KERNEL_NAME
+.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:
 .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:
 .P
 .RB "The " NAME " ," SYMLINK " and " PROGRAM
 fields support simple printf-like string substitution:


@@ -142,6 +178,9 @@ fields support simple printf-like string substitution:
 The "kernel number" of the device.
 for example, 'sda3' has a "kernel number" of '3'
 .TP
 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
 .B %M
 The kernel major number for the device.
 .TP


@@ -158,7 +197,7 @@ The CALLOUT program returned string.
 .B %D
 Use the devfs style disk name for this device.
 For partitions, this will result in 'part%n'
 .B %D
 Use the devfs style disk name for this device.
 For partitions, this will result in 'part%n'

-If this is not a partition, it will result in 'disk'.
+If this is not a partition, it will result in 'disc'.

 .P
 .RI "A sample " udev.rules " might look like this:"
 .sp
 .P
 .RI "A sample " udev.rules " might look like this:"
 .sp


@@ -167,7 +206,10 @@ If this is not a partition, it will result in 'disk'.
 CALLOUT, BUS="scsi", PROGRAM="/sbin/scsi_id", ID="OEM 0815", NAME="disk1"
 
 # USB printer to be called lp_color
 CALLOUT, BUS="scsi", PROGRAM="/sbin/scsi_id", ID="OEM 0815", NAME="disk1"
 
 # USB printer to be called lp_color

-LABEL, BUS="usb", serial="W09090207101241330", NAME="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"
 
 # sound card with PCI bus id 00:0b.0 to be called dsp
 NUMBER, BUS="pci", ID="00:0b.0", NAME="dsp"


@@ -179,7 +221,7 @@ TOPOLOGY, BUS="usb", PLACE="2.3", NAME="mouse1"
 REPLACE, KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 
 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...
 REPLACE, KERNEL="ttyUSB1", NAME="pda", SYMLINK="palmtop handheld"
 
 # multiple USB webcams with symlinks to be called webcam0, webcam1, ...

-LABEL, BUS="usb", model="WebCam V3", NAME="video%n", SYMLINK="webcam%n"
+LABEL, BUS="usb", SYSFS_model="XV3", NAME="video%n", SYMLINK="webcam%n"

 .fi
 .P
 Permissions and ownership for the created device files may specified at
 .fi
 .P
 Permissions and ownership for the created device files may specified at