From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kay Sievers Date: Wed, 25 Feb 2004 00:25:52 +0000 Subject: [PATCH] udev - man page update Message-Id: <20040225002552.GA24875@vrfy.org> MIME-Version: 1 Content-Type: multipart/mixed; boundary="SLDf9lqlvOQaIe6s" List-Id: To: linux-hotplug@vger.kernel.org --SLDf9lqlvOQaIe6s Content-Type: text/plain; charset=us-ascii Content-Disposition: inline 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 --SLDf9lqlvOQaIe6s Content-Type: text/plain; charset=us-ascii Content-Disposition: inline; filename="03-man-update.patch" ===== udev.8 1.41 vs edited ===== --- 1.41/udev.8 Wed Feb 25 00:46:55 2004 +++ edited/udev.8 Wed Feb 25 01:20:09 2004 @@ -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 ===== --- 1.3/udevd.8 Wed Feb 25 00:46:55 2004 +++ edited/udevd.8 Wed Feb 25 00:47:02 2004 @@ -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 , with much help --SLDf9lqlvOQaIe6s-- ------------------------------------------------------- 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_id=1356&alloc_id=3438&op=click _______________________________________________ Linux-hotplug-devel mailing list http://linux-hotplug.sourceforge.net Linux-hotplug-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linux-hotplug-devel