Debian Codegraph @

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

raw
1 .TH sane\-mustek 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-mustek
3 .SH NAME
4 sane\-mustek \- SANE backend for Mustek SCSI flatbed scanners (and some other devices)
5 .SH DESCRIPTION
6 The
7 .B sane\-mustek
8 library implements a SANE (Scanner Access Now Easy) backend that provides access
9 to Mustek (and some relabeled Trust and Primax) SCSI and parport flatbed
10 scanners. At present, the following scanners are known to work more or less
11 with this backend:
12 .PP
13 .RS
14 Paragon MFS-6000CX
15 .br
16 Paragon MFS-12000CX
17 .br
18 Paragon MFC-600S, 600 II CD, ScanMagic 600 II SP
19 .br
20 Paragon MFC-800S, 800 II SP
21 .br
22 Paragon MFS-6000SP
23 .br
24 Paragon MFS-8000SP
25 .br
26 Paragon MFS-1200SP, MFS-12000SP
27 .br
28 ScanExpress 6000SP
29 .br
30 ScanExpress 12000SP, 12000SP Plus, Paragon 1200 III SP, ScanMagic 9636S, 9636S Plus
31 .br
32 Paragon 1200 LS
33 .br
34 ScanExpress A3 SP
35 .br
36 Paragon 1200 SP Pro
37 .br
38 Paragon 1200 A3 Pro/1200 A3 Pro
39 .br
40 Paragon 600 II EP
41 .br
42 Paragon 600 II N
43 .br
44 Trust Imagery 1200
45 .br
46 Trust Imagery 1200 SP
47 .br
48 Trust Imagery 4800 SP
49 .br
50 Trust SCSI Connect 19200
51 .br
52 Primax Compact 4800 SCSI
53 .br
54 .RE
55 .PP
56 More details can be found on the Mustek SCSI backend homepage
57 .IR http://www.meier\-geinitz.de/sane/mustek\-backend/ .
58 .PP
59 Don't mix up MFS (Paragon), Pro and ScanExpress models! They're
60 completely different. Check the exact model name! Note that we have encountered some Mustek models that are not specifically Paragon branded (e.g. "1200 A3 Pro"), but are also known to work.
61 .PP
62 Note that most of the above scanners come with a SCSI interface. The only
63 non-SCSI scanners that have some support at this point is the 600 II N and 600
64 II EP scanners. The former one comes with its own parallel port adapter (i.e.,
65 it does
66 .I not
67 attach to the printer port). Both scanners use the SCSI protocol internally,
68 too. More info on how to use these parallel port scanners can be found below in
69 section
70 .BR "PARALLEL PORT SCANNERS" .
71 Other parallel port scanners are not supported by this backend but you may be
72 successful using the Mustek parallel port backend mustek_pp, see
73 .BR sane\-mustek_pp (5).
74 USB scanners are also not supported by this backend but the ma1509, mustek_usb,
75 gt68xx, and plustek backends include support for some of them, see
76 .BR sane\-ma1509 (5),
77 .BR sane\-mustek_usb (5),
78 .BR sane\-gt68xx "(5), and"
79 .BR sane\-plustek (5).
80 .PP
81 Mustek scanners have no protection against exceeding the physical scan
82 area height. That is, if a scan is attempted with a height that
83 exceeds the height of the scan surface, the scanner begins making loud
84 noises and the scan mechanism may be damaged. Thus, if you hear such
85 a noise, IMMEDIATELY turn off the scanner. This shouldn't happen if
86 your scanner is in the list of known scanners. There is more
87 information in the
88 .I /usr/share/doc/libsane/PROBLEMS
89 file.
90 .PP
91 If you own a Mustek (or Trust) scanner other than the ones listed
92 above that works with this backend, please let us know by sending the
93 scanner's exact model name (look at the front and back of the scanner)
94 and a debug output to
95 .IR sane\[email protected] .
96 You can get the debug output by setting the environment variable
97 .B SANE_DEBUG_MUSTEK
98 to 5 and showing the list of available scanners with
99 .IR "scanimage \-L" .
100 Please send all of it to the mailing list. You must be subscribed to sane\-devel
101 before you can send mail to the list. See
102 .I http://www.sane\-project.org/mailing\-lists.html
103 for details.
104
105 .SH "DEVICE NAMES"
106 This backend expects device names of the form:
107 .PP
108 .RS
109 .I special
110 .RE
111 .PP
112 Where
113 .I special
114 is either the path-name for the special device that corresponds to a
115 SCSI scanner or the port number at which the parallel port scanners can
116 be found (see section
117 .B "PARALLEL PORT SCANNERS"
118 below). For SCSI scanners, the special device name must be a generic SCSI
119 device or a symlink to such a device. The program
120 .BR sane\-find\-scanner (1)
121 helps to find out the correct device. Under Linux, such a device name
122 could be
123 .I /dev/sg0
124 or
125 .IR /dev/sg3 ,
126 for example. See
127 .BR sane\-scsi (5)
128 for details.
129 .SH CONFIGURATION
130 The contents of the
131 .I mustek.conf
132 file is a list of options and device names that correspond to Mustek
133 scanners. Empty lines and lines starting with a hash mark (#) are
134 ignored. See
135 .BR sane\-scsi (5)
136 on details of what constitutes a valid device name.
137 .PP
138 The supported options are
139 .BR linedistance\-fix ,
140 .BR lineart\-fix ,
141 .BR legal\-size ,
142 .BR buffersize ,
143 .BR blocksize ,
144 .BR strip\-height ,
145 .BR disable\-double\-buffering ,
146 .BR disable\-backtracking ,
147 and
148 .BR force\-wait .
149 .PP
150 Options come in two flavors: global and positional ones. Global
151 options apply to all devices managed by the backend whereas positional
152 options apply just to the most recently mentioned device. Note that
153 this means that the order in which the options appear matters!
154 .PP
155 Option
156 .B linedistance\-fix
157 is positional and works around a problem that occurs with some SCSI
158 controllers (notably the ncr810 controller under Linux). If color
159 scans have horizontal stripes and/or the colors are off, then it's
160 likely that your controller suffers from this problem. Turning on
161 this option usually fixes the problem.
162 .PP
163 Option
164 .B lineart\-fix
165 is positional and works around a timing problem that seems to exist
166 with certain MFS-12000SP scanners. The problem manifests itself in
167 dropped lines when scanning in lineart mode. Turning on this option
168 should fix the problem but may slow down scanning a bit.
169 .PP
170 Option
171 .B legal\-size
172 is positional and sets the size of the scan area to Legal format. Set this
173 option if you own a Paragon 12000 LS. It can't be distinguished by
174 software from a ScanExpress 12000 SP (ISO A4 format).
175 .PP
176 Option
177 .B buffersize
178 is a positional option that overrides the default value set for the size of
179 the SCSI buffer. The buffer size is specified in kilobytes. The default value
180 is 128. Because of double buffering the buffer actually sent to the scanner
181 is half the size of this value. Try to increase this value to achieve higher
182 scan speeds. Note that some ScanExpress scanners don't like buffer sizes above
183 64 kb (buffersize = 128). If your sg driver can't set SCSI buffer sizes at
184 runtime you may have to change that value, too. See
185 .BR sane\-scsi (5)
186 for details.
187 .PP
188 Option
189 .B blocksize
190 is a positional option that overrides the default value set for the maximum
191 amount of data scanned in one block. The buffer size is specified in
192 kilobytes. Some scanners freeze if this value is bigger than 2048. The default
193 value is 1 GB (so effectively no limit) for most scanners. Don't change this
194 value if you don't know exactly what you do.
195 .PP
196 Option
197 .B strip\-height
198 is a global option that limits the maximum height of the strip scanned with a
199 single SCSI read command. The height is specified in inches and may contain a
200 fractional part (e.g., 1.5). Setting the strip\-height to a small value (one
201 inch, for example) reduces the likelihood of encountering problems with SCSI
202 driver timeouts and/or timeouts with other devices on the same SCSI bus.
203 Unfortunately, it also increases scan times. With current SCSI adapters and
204 drivers this option shouldn't be needed any more.
205 .PP
206 Option
207 .B disable\-double\-buffering
208 is a global option. If set, the backend will only send one buffer at a time to
209 the scanner. Try this option if you have trouble while scanning, e.g. SCSI
210 errors, freezes, or the first few cm are repeated over and over again in your
211 image.
212 .PP
213 Option
214 .B disable\-backtracking
215 is a positional option. If set, the scanner will not move back its slider
216 after each SCSI buffer is filled (`backtracking'). Setting this option will
217 lead to faster scans but may also produce horizontal stripes. This option
218 doesn't work with every scanner (only some of the paragon models can modify
219 backtracking).
220 .PP
221 Finally,
222 .B force\-wait
223 is a global option. If set, the backend will wait until the device is ready
224 before sending the inquiry command. Further more the backend will force the
225 scan slider to return to its starting position (not implemented for all
226 scanners). This option may be necessary with the 600 II N or when
227 .BR scanimage (1)
228 is used multiple times (e.g. in scripts). The default is off (not set).
229 .PP
230 A sample configuration file is shown below:
231 .PP
232 .RS
233 # limit strip height of all scanners to 1.5 inches:
234 .br
235 option strip\-height 1.5
236 .br
237 .br
238 /dev/scanner # first Mustek scanner
239 .br
240 # 1 MB buffer for /dev/scanner:
241 .br
242 option buffersize 1024
243 .br
244 /dev/sge # second Mustek scanner
245 .br
246 # turn on fixes for /dev/sge:
247 .br
248 option lineart\-fix
249 .br
250 option linedistance\-fix
251 .RE
252
253 .SH "SCSI ADAPTER TIPS"
254 .PP
255 You need a SCSI adapter for the SCSI scanners. Even if the connector is the
256 same as that of parallel port scanners, connecting it to the computers
257 parallel port will NOT work.
258 .PP
259 Mustek SCSI scanners are typically delivered with an ISA SCSI adapter.
260 Unfortunately, that adapter is not worth much since it is not
261 interrupt driven. It is (sometimes) possible to get the supplied card
262 to work, but without interrupt line, scanning will be very slow and put
263 so much load on the system, that it becomes almost unusable for other tasks.
264 .PP
265 If you already have a working SCSI controller in your system, you
266 should consider that Mustek scanners do not support the SCSI-2
267 disconnect/reconnect protocol and hence tie up the SCSI bus while a
268 scan is in progress. This means that no other SCSI device on the same
269 bus can be accessed while a scan is in progress.
270 .PP
271 Because the Mustek-supplied adapter is not worth much and because
272 Mustek scanners do not support the SCSI-2 disconnect/reconnect
273 protocol, it is recommended to install a separate (cheap) SCSI
274 controller for Mustek scanners. For example, ncr810 based cards are
275 known to work fine and cost as little as fifty US dollars.
276 .PP
277 For Mustek scanners, it is typically necessary to configure the low-level SCSI
278 driver to disable synchronous transfers (sync negotiation), tagged command
279 queuing, and target disconnects. See
280 .BR sane\-scsi (5)
281 for driver- and platform-specific information.
282 .PP
283 The ScanExpress models have sometimes trouble with high resolution
284 color mode. If you encounter sporadic corrupted images (parts duplicated
285 or shifted horizontally) kill all other applications before scanning
286 and (if sufficient memory is available) disable swapping.
287 .PP
288 Details on how to get the Mustek SCSI adapters and other cards running can be
289 found at
290 .IR http://www.meier\-geinitz.de/sane/mustek\-backend/#SCSI .
291
292 .SH "PARALLEL PORT SCANNERS"
293 This backend has support for the Paragon 600 II EP and Paragon 600 II N parallel
294 port scanners. Note that the latter scanner comes with its own ISA card that
295 implements a funky parallel port (in other words, the scanner does not connected
296 to the printer parallel port).
297 .PP
298 These scanners can be configured by listing the port number
299 of the adapter or the parallel port in the mustek.conf file. Valid port numbers
300 for the 600 II N are
301 .IR 0x26b ", " 0x2ab ", " 0x2eb ", " 0x22b ", " 0x32b ", " 0x36b ", "
302 .IR 0x3ab ", " 0x3eb .
303 For the 600 II EP use one of these:
304 .IR parport0 ", " parport1 ", " parport2 ", " 0x378 ", " 0x278 ", " 0x3bc .
305 Pick one that doesn't conflict with the other hardware in your computer. Put
306 only one number on a single line. Example:
307 .PP
308 .RS
309 .I 0x3eb
310 .RE
311 .PP
312 Note that for these scanners usually root privileges are required to access the
313 I/O ports. Thus, either make frontends such as
314 .BR scanimage (1)
315 and
316 .BR xscanimage (1)
317 setuid root (generally not recommended for security reasons) or, alternatively,
318 access this backend through the network daemon
319 .BR saned (8).
320 .PP
321 If the Mustek backend blocks while sending the inquiry command to the scanner,
322 add the option
323 .B force\-wait
324 to
325 .IR mustek.conf .
326 .PP
327 Also note that after a while of no activity, some scanners themselves (not
328 the SANE backend) turns off their CCFL lamps. This shutdown is not always
329 perfect with the result that the lamp sometimes continues to glow
330 dimly at one end. This doesn't appear to be dangerous since as soon as
331 you use the scanner again, the lamp turns back on to the normal high
332 brightness. However, the first image scanned after such a shutdown may
333 have stripes and appear to be over-exposed. When this happens, just
334 take another scan, and the image will be fine.
335
336 .SH FILES
337 .TP
338 .I /etc/sane.d/mustek.conf
339 The backend configuration file (see also description of
340 .B SANE_CONFIG_DIR
341 below).
342 .TP
343 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-mustek.a
344 The static library implementing this backend.
345 .TP
346 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-mustek.so
347 The shared library implementing this backend (present on systems that
348 support dynamic loading).
349
350 .SH ENVIRONMENT
351 .TP
352 .B SANE_CONFIG_DIR
353 This environment variable specifies the list of directories that may
354 contain the configuration file. On *NIX systems, the directories are
355 separated by a colon (`:'), under OS/2, they are separated by a
356 semi-colon (`;'). If this variable is not set, the configuration file
357 is searched in two default directories: first, the current working
358 directory (".") and then in
359 .IR /etc/sane.d .
360 If the value of the
361 environment variable ends with the directory separator character, then
362 the default directories are searched after the explicitly specified
363 directories. For example, setting
364 .B SANE_CONFIG_DIR
365 to "/tmp/config:" would result in directories
366 .IR "tmp/config" ,
367 .IR "." ,
368 and
369 .I "/etc/sane.d"
370 being searched (in this order).
371 .TP
372 .B SANE_DEBUG_MUSTEK
373 If the library was compiled with debug support enabled, this
374 environment variable controls the debug level for this backend. Higher
375 debug levels increase the verbosity of the output.
376
377 .ft CR
378 .nf
379 Value Description
380 0 no output
381 1 print fatal errors
382 2 print important messages
383 3 print non-fatal errors and less important messages
384 4 print all but debugging messages
385 5 print everything
386 .fi
387 .ft R
388
389 Example:
390 export SANE_DEBUG_MUSTEK=4
391
392 .SH "SEE ALSO"
393 .BR sane (7),
394 .BR sane\-find\-scanner (1),
395 .BR sane\-scsi (5),
396 .BR sane\-mustek_usb (5),
397 .BR sane\-gt68xx (5),
398 .BR sane\-plustek (5),
399 .BR sane\-mustek_pp (5),
400 .BR sane\-ma1509 (5),
401 .BR scanimage (1),
402 .BR xscanimage (1)
403
404 .br
405 .I /usr/share/doc/libsane/mustek/mustek.CHANGES
406 .br
407 .I http://www.meier\-geinitz.de/sane/mustek\-backend/
408
409 .SH AUTHOR
410 David Mosberger, Andreas Czechanowski, Andreas Bolsch (SE extensions),
411 Henning Meier-Geinitz, James Perry (600 II EP).
412
413 .SH BUGS
414 Scanning with the SCSI adapters supplied by Mustek is very slow at
415 high resolutions and wide scan areas.
416 .PP
417 Some scanners (e.g. Paragon 1200 A3 + Pro, SE A3) need more testing.
418 .PP
419 The gamma table supports only 256 colors, even if some scanners can do more.
420 .PP
421 More detailed bug information is available at the Mustek backend
422 homepage:
423 .IR http://www.meier\-geinitz.de/sane/mustek\-backend/ .