diff options
author | Jörg Frings-Fürst <debian@jff-webhosting.net> | 2021-02-16 18:24:46 +0100 |
---|---|---|
committer | Jörg Frings-Fürst <debian@jff-webhosting.net> | 2021-02-16 18:24:46 +0100 |
commit | ecaaf250cb33ff61f37a7b441f2337584a655350 (patch) | |
tree | 4303648095deff998ae20c2393b56db527742ac9 /doc/sane-usb.man | |
parent | 5793a221e112fa49073de0137d6bfa750a61b0a1 (diff) | |
parent | 351b7328520c16730ceb46e5acae16038c42185e (diff) |
Update upstream source from tag 'upstream/1.0.32'
Update to upstream version '1.0.32'
with Debian dir 2c1111c59d9d68bcbf479a4a4de7697fe2de127f
Diffstat (limited to 'doc/sane-usb.man')
-rw-r--r-- | doc/sane-usb.man | 82 |
1 files changed, 56 insertions, 26 deletions
diff --git a/doc/sane-usb.man b/doc/sane-usb.man index cb65c7f..ea4ee01 100644 --- a/doc/sane-usb.man +++ b/doc/sane-usb.man @@ -4,28 +4,30 @@ sane\-usb \- USB configuration tips for SANE .SH DESCRIPTION This manual page contains information on how to access scanners with a USB -interface. It focusses on two main topics: getting the scanner detected by the +interface. It focuses on two main topics: getting the scanner detected by the operating system kernel and using it with SANE. .PP This page applies to USB most backends and scanners, as they use the generic -sanei_usb interface. However, there is one exceptions: USB Scanners -supported by the microtek2 backend need a special USB kernel -driver, see +sanei_usb interface. However, there is one exception: USB Scanners +supported by the .BR sane\-microtek2 (5) -for details. +backend need a special USB kernel driver. .SH "QUICK START" This is a short HOWTO-like section. For the full details, read the following sections. The goal of this section is to get the scanner detected by .BR sane\-find\-scanner (1). .PP -Run sane\-find\-scanner. If it lists your scanner with the correct vendor and +Run +.BR sane\-find\-scanner (1). +If it lists your scanner with the correct vendor and product ids, you are done. See section .B "SANE ISSUES" for details on how to go on. .PP -sane\-find\-scanner doesn't list your scanner? Does it work as root? If yes, -there is a permission issue. See the +.BR sane\-find\-scanner (1) +doesn't list your scanner? Does it work as root? If yes, there is a permission issue. +See the .B LIBUSB section for details. .PP @@ -61,17 +63,35 @@ none /proc/bus/usb usbfs defaults 0 0 The permissions for the device files used by libusb must be adjusted for user access. Otherwise only root can use SANE devices. For .IR Linux , -the devices are located in /proc/bus/usb/ or in /dev/bus/usb, if you use +the devices are located in +.I /proc/bus/usb/ +or in +.IR /dev/bus/usb , +if you use udev. There are directories named e.g. "001" (the bus name) containing files "001", "002" etc. (the device files). The right device files can be found out by -running scanimage \-L as root. Setting permissions with "chmod" is not permanent, -however. They will be reset after reboot or replugging the scanner. -.PP -Usually udev or for older distributions the hotplug utilities are used, which +running: +.I "scanimage \-L: +as root. Setting permissions with +.BR chmod (1) +is not permanent, however. They will be reset after reboot or replugging the scanner. +.PP +Usually +.BR udev (7) +or for older distributions the hotplug utilities are used, which support dynamic setting of access permissions. SANE comes with udev and hotplug -scripts in the directory tools/udev and tools/hotplug. They can be used for -setting permissions, see @DOCDIR@/README.linux, tools/README and the README in -the tools/hotplug directory for more details. +scripts in the directory +.I tools/udev +and +.IR tools/hotplug . +They can be used for setting permissions, see +.IR @DOCDIR@/README.linux , +.IR tools/README +and the +.I README +in the +.I tools/hotplug +directory for more details. .PP For the .BR BSDs , @@ -81,8 +101,10 @@ Use chmod to apply appropriate permissions. .SH "SANE ISSUES" .PP -This section assumes that your scanner is detected by sane\-find\-scanner. It -doesn't make sense to go on, if this is not the case. While sane\-find\-scanner +This section assumes that your scanner is detected by +.BR sane\-find\-scanner (1). +It doesn't make sense to go on, if this is not the case. While +.BR sane\-find\-scanner (1) is able to detect any USB scanner, actual scanning will only work if the scanner is supported by a SANE backend. Information on the level of support can be found on the SANE webpage @@ -104,9 +126,13 @@ is the USB vendor id, and .I PRODUCT is the USB product id of the scanner. Both ids are non-negative integer numbers in decimal or hexadecimal format. The correct values for these fields can be -found by running sane\-find\-scanner, looking into the syslog (e.g., -/var/log/messages) or under Linux by issuing the command "cat -/proc/bus/usb/devices". This is an example of a config file line: +found by running +.BR sane\-find\-scanner (1), +looking into the syslog (e.g., +.IR /var/log/messages ) +or under Linux by issuing the command +.IR "cat /proc/bus/usb/devices" . +This is an example of a config file line: .PP .RS usb 0x055f 0x0006 @@ -137,14 +163,17 @@ If the library was compiled with debug support enabled, this environment variable controls the debug level for the USB I/O subsystem. E.g., a value of 128 requests all debug output to be printed. Smaller levels reduce verbosity. Values greater than 4 enable -libusb debugging (if available). Example: export SANE_DEBUG_SANEI_USB=4. +libusb debugging (if available). Example: +.IR "export SANE_DEBUG_SANEI_USB=4" . .PP .TP .B SANE_USB_WORKAROUND If your scanner does not work when plugged into a USB3 port, try -setting the environment variable SANE_USB_WORKAROUND to 1. This -may work around issues which happen with particular kernel -versions. Example: export SANE_USB_WORKAROUND=1. +setting the environment variable +.B SANE_USB_WORKAROUND +to 1. This may work around issues which happen with particular kernel +versions. Example: +.I export SANE_USB_WORKAROUND=1. .SH "SEE ALSO" .BR sane (7), @@ -153,4 +182,5 @@ versions. Example: export SANE_USB_WORKAROUND=1. .BR sane\-scsi (5) .SH AUTHOR -Henning Meier-Geinitz <henning@meier\-geinitz.de> +Henning Meier-Geinitz +.RI < henning@meier\-geinitz.de > |