sane-project-backends/tools/hotplug-ng
Julien BLACHE 6e4ed52293 Add basic .gitignore files 2009-05-04 14:45:17 +02:00
..
.gitignore Add basic .gitignore files 2009-05-04 14:45:17 +02:00
README Updated documentation concerning udev. 2006-05-10 19:34:05 +00:00
libsane.hotplug Add missing quotes in the grep line. 2005-03-03 13:47:39 +00:00

README

hotplug/hotplug-ng hook for sane-backends
-----------------------------------------

The libsane.hotplug script is intended to replace the existing hotplug scripts,
as those won't be usable with the new hotplug-ng. The libsane.hotplug script
works with both hotplug and hotplug-ng.  For current Linux kernels, "udev" is
state of the art, see the "udev" directory instead.

This script is provided in the hope that it will be useful, simpler, faster and
more extensible than the current usermap approach.


INSTALLATION
------------

Install libsane.hotplug in /etc/hotplug/usb, and make it executable.

Create the directory /etc/sane.d/hotplug and copy libsane.db there.


FILE FORMAT
-----------

The libsane.db contains 5 tab-separated fields:

0xVVVV<tab>0xPPPP<tab>root:scanner<tab>0660<tab>optional_script

Fields:
 - vendor ID
 - product ID
 - ownership (user:group)
 - permissions
 - path of an optional script to run (it can be omitted)


USAGE
-----

When run by hotplug/hotplug-ng, the libsane.hotplug script will grep for
^0xVVVV[[:space:]]0xPPPP in /etc/sane.d/hotplug/*.db. If a match is found,
the settings are applied to the device.

The optional script is then run; this script can access the environment
variables set by hotplug/hotplug-ng (see the documentation). The libsane.hotplug
script will also set and export the DEVVID and DEVPID variables, containing the
vendor and device ID of the scanner (of the form VVVV and PPPP).