udev - man page update
PATCH 1/1 udev - man page update
Hey it's not longer the "goal" to provide a dynamic dev directory, we have just arrived. So I change it to more self-confident words :)
I've also added the completly missing environment variables to the man pages.
To stop the misuse of the PROGRAM= call paramenters, we better mention its limitations.
thanks,
Kay
===== udev.8 1.41 vs edited =====
udev.8 +31 -2
@@ -3,11 +3,34 @@ udev \- Linux configurable dynamic device naming support .SH SYNOPSIS .BI udev " hotplug-subsystem" +.P +The environment must provide the following variables: +.TP +.B ACTION +.IR add " or " remove +signifies the connection or disconnection of a device. +.TP +.B DEVPATH +The sysfs devpath of the device without the mountpoint but a leading slash. +.P +Additional optional environment variables are: +.TP +.B UDEV_CONFIG_FILE +Overrides the default location of the +.B udev +config file. +.TP +.B UDEV_NO_SLEEP +The default behavior of +.B udev +is to wait until all the sysfs files of the device chain are populated. If set +.B udev +will will continue, regardless of the state of the device representation. .SH "DESCRIPTION" .B udev creates or removes device node files usually located in the /dev directory. -Its goal is to provide a dynamic device directory that contains only the files -for devices that are actually present. +It provides a dynamic device directory that contains only the files for +devices that are actually present. .P As part of the .B hotplug
@@ -159,6 +182,11 @@ .TP .B PROGRAM Call external program. This key is valid if the program returns successful. +A few command line options may specified, but shell characters like pipe, +diversion or similiar options are not available. The environment variables of +.B udev +are also available for the program. +.br The string returned by the program may additionally matched with the .B RESULT key.
@@ -285,6 +313,7 @@ .LP .SH "SEE ALSO" .BR udevinfo (8), +.BR udevd (8), .BR hotplug (8) .PP The
===== udevd.8 1.3 vs edited =====
udevd.8 +18 -1
@@ -3,6 +3,21 @@ udevd \- udev event serializer daemon .br udevsend \- sends the event to udevd +.SH SYNOPSIS +.BI udevsend " hotplug-subsystem" +.sp +The environment must provide the following variables: +.TP +.B ACTION +.IR add " or " remove +signifies the connection or disconnection of a device. +.TP +.B DEVPATH +The sysfs devpath of the device without the mountpoint but a leading slash. +.TP +.B SEQNUM +The sequence number of the event provided by the kernel. +If unset, the event bypasses the queue and will be executed immediately. .SH "DESCRIPTION" .B udevd allows the serialization of
@@ -33,7 +48,9 @@ .B udevsend will start it. .SH "SEE ALSO" -.BR udev (8), " hotplug" (8) +.BR udev (8), +.BR udevinfo (8), +.BR hotplug (8) .SH AUTHORS .B udevd was developed primarily by Kay Sievers <[email protected]>, with much help
Greg KH
AppliedQuoted 8 lines · Kay Sievers
Hey it's not longer the "goal" to provide a dynamic dev directory, we have just arrived. So I change it to more self-confident words :)
I've also added the completly missing environment variables to the man pages.
To stop the misuse of the PROGRAM= call paramenters, we better mention its limitations.
Applied, thanks.
greg k-h
-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now. Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id56&alloc_id438&op=click
_______________________________________________
Linux-hotplug-devel mailing list http://linux-hotplug.sourceforge.net
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel
PATCH 1/1 udev - man page update
In reply to Kay SieversHere is a small change to the udev man page:
- clarify the use of the NAME{all_partitions} syntax and add a example to udev.rules.example
- mention the empty NAME field to ignore the device
- prepare a SYMLINK field for the addition of Andrey's "multiple symlinks" documentation :)
thanks,
Kay
===== udev.8 1.44 vs edited =====
udev.8 +14 -9
@@ -151,16 +151,15 @@ Every line in the rules file defines the mapping between device attributes and the device file name. One ore more keys are specified to match a rule with the current device. If all keys are matching, the rule will be applied -and the name is used for the device node. One or more optional symlinks -targeting the node may be specified. +and the name is used for the device node. .br If no matching rule is found, the default kernel device name is used. .P -The line format is: +Every rule consists of a list a comma separated fields: .sp -.I key,[key,...] name [, symlink] +.IR "key " ,[ "key " ,...] " name " [, " symlink" ] .sp -where keys are: +where possible fields are: .TP .B BUS Match the bus type of the device.
@@ -196,13 +195,19 @@ call. This key may used in any following rule after a .B PROGRAM call. -.P -The +.TP .B NAME -field given with the attribute +The name of the node to be created. If the name field is omitted or its +value is empty, the device will be ignored and no node will be created. +.br +If given with the attribute .BR NAME{ all_partitions } -will create all 15 partitions of a blockdevice. +it will create all 15 partitions of a blockdevice. This may be useful for removable media devices. +.TP +.B SYMLINK +The name of a symlink targeting the node. Multiple symlinks may be +specified by separating the names by the space character. .P .RB "The " NAME " ," SYMLINK " and " PROGRAM fields support simple printf-like string substitution:
===== etc/udev/udev.rules.examples 1.2 vs edited =====
etc/udev/udev.rules.examples +4 -0
@@ -51,6 +51,10 @@ # DRI devices always go into a subdirectory (as per the LSB spec) KERNEL="card*", NAME="dri/card%n" +# create all 15 partitions of a USB flash card reader +# note the trailing spaces in the attribute, use udevinfo(8) to examine your device +BUS="scsi", SYSFS{model}="CF/MD ", NAME{all_partitions}="compactflash" + # alsa devices KERNEL="controlC[0-9]*", NAME="snd/%k" KERNEL="hw[CD0-9]*", NAME="snd/%k"
Greg KH
AppliedQuoted 7 lines · Kay Sievers
Here is a small change to the udev man page:
- clarify the use of the NAME{all_partitions} syntax and add a example to udev.rules.example
- mention the empty NAME field to ignore the device
- prepare a SYMLINK field for the addition of Andrey's "multiple symlinks" documentation :)
Applied, thanks.
greg k-h
-------------------------------------------------------
SF.Net is sponsored by: Speed Start Your Linux Apps Now. Build and deploy apps & Web services for Linux with
a free DVD software kit from IBM. Click Now!
http://ads.osdn.com/?ad_id56&alloc_id438&op=click
_______________________________________________
Linux-hotplug-devel mailing list http://linux-hotplug.sourceforge.net
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel