Debian Codegraph @

upstream/debian-unstable/man5/sane-mustek_usb.5

raw
1 .TH sane\-mustek_usb 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-mustek_usb
3 .SH NAME
4 sane\-mustek_usb \- SANE backend for Mustek USB flatbed scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-mustek_usb
8 library implements a SANE (Scanner Access Now Easy) backend that provides
9 access to Mustek USB flatbed scanners (including a clone from Trust). At
10 present, the following scanners are known to work more or less with this
11 backend:
12 .PP
13 .RS
14 Mustek 600 CU
15 .br
16 Mustek 1200 UB
17 .br
18 Mustek 1200 CU
19 .br
20 Mustek 1200 CU Plus
21 .br
22 Trust Compact Scan USB 19200
23 .br
24 .RE
25 .PP
26 More details can be found on the Mustek USB backend homepage
27 .IR http://www.meier\-geinitz.de/sane/mustek_usb\-backend/ .
28 .PP
29 The Mustek BearPaw 1200 and 2400 scanners are supported by the plustek
30 backend. See
31 .BR sane\-plustek (5)
32 for details. The Mustek BearPaw 1200F is supported by the MA-1509 backend. See
33 .BR sane\-ma1509 (5)
34 for details. Other Mustek USB scanners are supported by the gt68xx backend,
35 see
36 .BR sane\-gt68xx (5).
37 .PP
38 This backend can only work with scanners that are already detected by the
39 operating system. See
40 .BR sane\-usb (5)
41 for details.
42 .PP
43 If you own a Mustek (or Trust) scanner other than the ones listed above that
44 works with this backend, please let me know this by sending the scanner's
45 exact model name and the USB vendor and device ids (e.g. from
46 .I /proc/bus/usb/devices
47 or syslog) to me.
48
49 .SH "DEVICE NAMES"
50 This backend expects device names of the form:
51 .PP
52 .RS
53 .I special
54 .RE
55 .PP
56 Where
57 .I special
58 is a path-name for the special device that corresponds to a USB scanner.
59 With Linux, such a device name could be
60 .I /dev/usb/scanner0
61 or
62 .IR /dev/usbscanner1 ,
63 for example.
64 .PP
65 For FreeBSD use
66 .IR /dev/uscanner0 .
67
68 .SH CONFIGURATION
69 The contents of the
70 .I mustek_usb.conf
71 file is a list of options and device names that correspond to Mustek
72 USB scanners. Empty lines and lines starting with a hash mark (#) are
73 ignored. If a device name is placed in
74 .IR mustek_usb.conf ,
75 it must be followed by a line containing the keyword
76 .B option
77 and an option specifying the scanner type. The following options can be used:
78 .BR 600cu ,
79 .BR 1200cu ,
80 .BR 1200cu_plus ,
81 .BR 1200ub .
82 For the Trust Compact Scan USB 19200 use `option 1200ub'.
83 .PP
84 Instead of using the device name, the scanner can be autodetected by
85 .B "usb vendor_id product_id"
86 statements which are already included into
87 .IR mustek_usb.conf .
88 This is only supported with Linux 2.4.8 and higher and all systems that
89 support libusb. "vendor_id" and "product_id" are hexadecimal numbers that
90 identify the scanner. If this doesn't work, a device name and the option
91 specifying the scanner type must be placed in
92 .I mustek_usb.conf
93 as described above.
94 .PP
95 The global
96 .B option max_block_size
97 can be used to limit the amount of data acquired in one turn from the USB
98 system. It may be worth trying, if USB errors occur.
99 .PP
100 A sample configuration file is shown below:
101 .PP
102 .RS
103 # Comment
104 .br
105 option max_block_size 1024
106 .br
107 usb 0x055f 0x0001
108 .br
109 /dev/usb/scanner0
110 .br
111 option 600cu
112 .RE
113 .PP
114 The first line is ignored. The second line sets the buffer size to a maximum of
115 1024 bytes. The third line tries to autodetect a scanner with vendor id 0x055f
116 and product id 0x0001 (Mustek 1200 CU). The fourth line tells the backend to
117 attach to
118 .I /dev/usb/scanner0
119 and the fifth line specifies that
120 .I /dev/usb/scanner0
121 is a Mustek 600 CU.
122 .SH FILES
123 .TP
124 .I /etc/sane.d/mustek_usb.conf
125 The backend configuration file (see also description of
126 .B SANE_CONFIG_DIR
127 below).
128 .TP
129 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-mustek_usb.a
130 The static library implementing this backend.
131 .TP
132 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-mustek_usb.so
133 The shared library implementing this backend (present on systems that
134 support dynamic loading).
135 .SH ENVIRONMENT
136 .TP
137 .B SANE_CONFIG_DIR
138 This environment variable specifies the list of directories that may
139 contain the configuration file. On *NIX systems, the directories are
140 separated by a colon (`:'), under OS/2, they are separated by a
141 semi-colon (`;'). If this variable is not set, the configuration file
142 is searched in two default directories: first, the current working
143 directory (".") and then in
144 .IR /etc/sane.d .
145 If the value of the
146 environment variable ends with the directory separator character, then
147 the default directories are searched after the explicitly specified
148 directories. For example, setting
149 .B SANE_CONFIG_DIR
150 to "/tmp/config:" would result in directories
151 .IR tmp/config ,
152 .IR . ,
153 and
154 .I "/etc/sane.d"
155 being searched (in this order).
156 .TP
157 .B SANE_DEBUG_MUSTEK_USB
158 If the library was compiled with debug support enabled, this
159 environment variable controls the debug level for this backend. Higher
160 debug levels increase the verbosity of the output.
161
162 .ft CR
163 .nf
164 Value Description
165 0 no output
166 1 print fatal errors
167 2 print important messages
168 3 print non-fatal errors and less important messages
169 4 print all but debugging messages
170 5 print high level debugging messages
171 6 print medium level debugging messages
172 7 print low level debugging messages
173 .fi
174 .ft R
175
176 Example:
177 export SANE_DEBUG_MUSTEK_USB=4
178
179 .SH "SEE ALSO"
180 .BR sane (7),
181 .BR sane\-usb (5),
182 .BR sane\-mustek (5),
183 .BR sane\-mustek_pp (5),
184 .BR sane\-plustek (5),
185 .BR sane\-gt68xx (5),
186 .BR sane\-ma1509 (5)
187 .br
188 .IR /usr/share/doc/libsane/mustek_usb/mustek_usb.CHANGES ,
189 .br
190 .I /usr/share/doc/libsane/mustek_usb/mustek_usb.TODO
191 .br
192 .I http://www.meier\-geinitz.de/sane/mustek_usb\-backend/
193
194 .SH AUTHOR
195 Henning Meier-Geinitz
196 .RI < henning@meier\-geinitz.de >
197 .br
198 This backend is based on the Mustek 1200ub backend from Mustek, maintained by
199 Tom Wang.
200
201 .SH BUGS
202 These devices have a hardware bug: Once data is written to them, they can't be
203 reset (toggle = DATA0). That means, any operation that tries to reset the
204 device will result in running into timeouts.
205
206 In earlier versions this backend failed when it was loaded the second time in
207 some configurations. The only choice was to replug the scanner in this case. The
208 backend uses a workaround for that bug now but it's only tested on
209 Linux. Reports for other operating systems are appreciated.
210
211 .PP
212 More detailed bug information is available at the Mustek backend homepage
213 .IR http://www.meier\-geinitz.de/sane/mustek_usb\-backend/ .