Debian Codegraph @

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

raw
1 .TH sane\-mustek_pp 5 "13 Jul 2008"
2 .de EX
3 .sp
4 .nf
5 .ft CW
6 ..
7 .de EE
8 .ft R
9 .fi
10 .sp
11 ..
12 .IX sane\-mustek_pp
13 .SH NAME
14 sane\-mustek_pp \- SANE backend for Mustek parallel port flatbed scanners
15 .SH DESCRIPTION
16 The
17 .B sane\-mustek_pp
18 library implements a SANE (Scanner Access Now Easy) backend that
19 provides access to Mustek parallel port flatbed scanners and OEM versions.
20
21 There are 2 classes of Mustek parallel port scanners: regular
22 .B CCD
23 (cold cathode device) scanners and
24 .B CIS
25 (contact image sensor) scanners.
26 .P
27 The current version of this backend supports both CCD type scanners and
28 CIS type scanners.
29 .P
30 The following scanners might work with this backend:
31
32 .SS "CCD scanners"
33
34 .EX
35 Model: ASIC ID: CCD Type: works:
36 --------------------------------------------------------------
37 SE 6000 P 1013 00 yes
38 SM 4800 P 1013/1015 04/01 yes
39 SE 1200 ED Plus 1015 01 no
40 SM 1200 ED Plus 1015 01 no
41 SE 12000 P 1505 05 no
42 600 III EP Plus 1013/1015 00/01 yes
43 SE 600 SEP 1013 ?? yes
44 600 II EP ???? ?? no
45 MD9848 1015 00 yes
46 Gallery 4800 ???? ?? yes
47 Viviscan Compact II 1013 00 yes
48 .EE
49 .SS CIS scanners
50 .EX
51 Model: ASIC ID: works:
52 -----------------------------------------------
53 Mustek 600 CP & 96 CP 1015 yes (*)
54 Mustek 1200 CP 1015 yes
55 Mustek 1200 CP+ 1015 yes
56 .EE
57
58 .EX
59 OEM versions Original works
60 --------------------------------------------------
61 Medion/LifeTec/Tevion
62 MD/LT 9350/9351 1200 CP yes
63 MD/LT 9850/9851 1200 CP maybe (**)
64 MD/LT 9858 1200 CP probably
65 MD/LT 9890/9891 1200 CP yes
66 Targa
67 Funline TS12EP 1200 CP yes
68 Funline TS6EP 600 CP yes
69 Trust
70 Easy Connect 9600+ 600 CP yes
71 Cybercom
72 9352 1200 CP yes (***)
73 .EE
74 .HP
75 (*) Calibration problems existed with earlier version of
76 this driver. They seem to be solved now.
77 .HP
78 (**) Problems have been reported in the past for the
79 MD/LT9850 type (striped scans, head moving in wrong
80 direction at some resolutions). It is not known whether
81 the current version of the driver still has these problems.
82 .PP
83 .B IF YOU HEAR LOUD CLICKING NOISES, IMMEDIATELY UNPLUG THE SCANNER !
84 (This holds for any type of scanner).
85 .HP
86 (***) Possibly, the engine_delay parameter has to be set to 1 ms
87 for accurate engine movements.
88 .PP
89 Please note that this backend is still under construction. Certain models
90 are currently not supported and some may never be because the communication
91 protocol is still unknown (eg., SE 12000 P).
92 .PP
93 Some scanners work faster when
94 .B EPP/ECP
95 is enabled in the BIOS. EPP mode however may lead to hard-locks on some Linux
96 systems. If that is the case for you, you can either disable ECP/EPP in your
97 BIOS or disable it in the backend itself (see GLOBAL OPTIONS).
98 .PP
99 Note that the backend needs to run as root or has to have appropriate access
100 rights to
101 .I /dev/parport*
102 if libieee1284 support is compiled in. To allow user
103 access to the scanner run the backend through the network interface (see
104 .BR saned (8)
105 and
106 .BR sane\-net (5)).
107 Note also that the backend
108 .I does not
109 support
110 .IR "parport sharing" ,
111 i.e. if you try printing while scanning, your computer may crash. To enable
112 parport sharing, you have to enable
113 .BR libieee1284 (3)
114 at compile time.
115 You may also have to enable the backend explicitly in your
116 .IR dll.conf .
117 Just remove the hash mark in the line "mustek_pp".
118
119 .SH "DEVICE DEFINITION"
120 This backend allows multiple devices being defined and configured via the
121 .I mustek_pp.conf
122 file (even simultaneously, provided that they are connected to different
123 parallel ports). Please make sure to edit this file
124 .B before
125 you use the backend.
126 .PP
127 A device can be defined as follows:
128 .PP
129 .RS
130 .I scanner <name> <port name> <driver>
131 .RE
132 .PP
133 where
134 .HP
135 .B <name>
136 is an arbitrary name for the device, optionally enclosed by double quotes,
137 for instance "LifeTec 9350".
138 .HP
139 .B <port name>
140 is the name of the parallel port to which the device is connected. In case
141 libieee1284 is used for communication with the port
142 .I (default
143 .IR setup) ,
144 valid port names are
145 .BR parport0 ,
146 .BR parport1 ,
147 and
148 .BR parport2 .
149 .PP
150 In case the backend is configured for raw IO
151 .I (old
152 .IR setup) ,
153 port addresses have to be used instead of port names:
154 .BR 0x378 ,
155 .BR 0x278 ,
156 or
157 .BR 0x3BC .
158 The mapping of parallel ports (lp0, lp1, and lp2) to these addresses
159 can be different for different Linux kernel versions. For instance,
160 if you are using a Kernel 2.2.x or better and you have only one
161 parallel port, this port is named lp0 regardless of the base address. However,
162 this backend requires the base address of your port. If you are not sure which
163 port your scanner is connected to, have a look at your
164 .IR /etc/conf.modules ,
165 .I /etc/modules.conf
166 and/or
167 .IR /proc/ioports .
168 .PP
169 If you are unsure which port to use, you can use the magic value
170 .BR *
171 to probe for your scanner.
172 .PP
173 .HP
174 .B <driver>
175 is the driver to use for this device. Currently available drivers are:
176 .IP
177 .BR cis600 " : for 600 CP, 96 CP & OEM versions"
178 .br
179 .BR cis1200 " : for 1200 CP & OEM versions"
180 .br
181 .BR cis1200+ " : for 1200 CP+ & OEM versions"
182 .br
183 .BR ccd300 " : for 600 IIIE P & OEM version"
184 .IP
185 .B Choosing the wrong driver can damage your scanner!
186 .br
187 Especially, using the 1200CP settings on a 600CP can be
188 harmful. If the scanner starts making a loud noise, turn
189 it off immediately !!!
190 .PP
191 Using the cis600 driver on a 1200CP or a 1200CP+ is probably not
192 dangerous. The cis1200+ driver also works for the 1200CP, and using
193 the cis1200 driver on a 1200CP+ will typically result in scans that
194 cover only half of the width of the scan area (also not dangerous).
195 .PP
196 If unsure about the exact model of your OEM version, check the optical
197 resolution in the manual or on the box: the 600CP has a maximum optical
198 resolution of 300x600 DPI, whereas the 1200CP and 1200CP+ have a maximum
199 optical resolution of 600x1200 DPI.
200 .PP
201 Examples:
202 .PP
203 .RS
204 scanner "LifeTec 9350" 0x378 cis1200
205 .PP
206 scanner Mustek_600CP 0x378 cis600
207 .PP
208 scanner Mustek_600IIIEP * ccd300
209 .RE
210
211 If in doubt which port you have to use, or whether your scanner is
212 detected at all, you can use
213 .I sane\-find\-scanner \-p
214 to probe all configured ports.
215
216 .SH CONFIGURATION
217 .PP
218 The contents of the
219 .I mustek_pp.conf
220 file is a list of device definitions and device options that correspond to
221 Mustek scanners. Empty lines and lines starting with a hash mark (#) are
222 ignored. Options have the following format:
223 .PP
224 .RS
225 .I option <name> [<value>]
226 .RE
227 .PP
228 Depending on the nature of the option, a value may or may not be present.
229 Options always apply to the scanner definition that precedes them. There
230 are no global options. Options are also driver-specific: not all drivers
231 support all possible options.
232
233 .SS Common options
234 .TP
235 .B bw <value>
236 Black/white discrimination value to be used during lineart scanning. Pixel
237 values below this value are assumed to be black, values above are
238 assumed to be white.
239 .br
240 Default value: 127
241 .br
242 Minimum: 0
243 .br
244 Maximum: 255
245 .sp
246 Example: option bw 150
247
248 .SS CIS driver options
249 .TP
250 .B top_adjust <value>
251 Vertical adjustment of the origin, expressed in millimeter (floating point).
252 This option can be used to calibrate the position of the origin, within
253 certain limits. Note that CIS scanners are probably temperature sensitive, and
254 that a certain inaccuracy may be hard to avoid. Differences in offset between
255 runs in the order of 1 to 2 mm are not unusual.
256 .br
257 Default value: 0.0
258 .br
259 Minimum: \-5.0
260 .br
261 Maximum: 5.0
262 .br
263 .sp
264 Example: option top_adjust \-2.5
265 .TP
266 .B slow_skip
267 Turns fast skipping to the start of the scan region off. When the region to
268 scan does not start at the origin, the driver will try to move the scanhead
269 to the start of the scan area at the fastest possible speed. On some models,
270 this may not work, resulting in large inaccuracies (up to centimeters).
271 By setting this option, the driver is forced to use normal speed during
272 skipping, which can circumvent the accuracy problems. Currently, there are
273 no models for which these inaccuracy problems are known to occur.
274 .sp
275 By default, fast skipping is used.
276 .sp
277 Example: option slow_skip
278 .TP
279 .B engine_delay <value>
280 Under normal circumstances, it is sufficient for the driver to wait for the
281 scanner signaling that the engine is stable, before a new engine command can
282 be transmitted. In rare cases, certain scanners and/or parallel port chipsets
283 appear to prevent reliable detection of the engine state. As a result, engine
284 commands are transmitted too soon and the movement of the scanner head becomes
285 unreliable. Inaccuracies ranging up to 10 cm over the whole vertical scan
286 range have been reported. To work around this problem, the engine_delay option
287 can be set. If it is set, the driver waits an additional amount of time after
288 every engine command, equal to the engine_delay parameter, expressed in
289 milliseconds. It practice an engine_delay of 1 ms is usually sufficient. The
290 maximum delay is 100 ms.
291 .sp
292 Note that every additional ms of delay can add up to 14 seconds to the total
293 scanning time (highest resolution), so an as small as possible value is
294 preferred.
295 .sp
296 Default value: 0
297 .br
298 Minimum: 0
299 .br
300 Maximum: 100
301 .sp
302 Example: option engine_delay 1
303
304 .SS CCD driver options
305 .TP
306 .B top <value>
307 Number of scanlines to skip to the start of the scan area. The number can
308 be any positive integer. Values known to me are 47 and 56.
309 .sp
310 Default value: 47
311 .br
312 Minimum: 0
313 .br
314 Maximum: none
315 .br
316 .sp
317 Example: option top 56
318 .TP
319 .B waitbank <value>
320 The number of usecs to wait for a bank change. You should not touch this
321 value actually. May be any positive integer
322 .sp
323 Default value: 700
324 .br
325 Minimum: 0
326 .br
327 Maximum: none
328 .sp
329 Example: option waitbank 700
330 .PP
331 A sample configuration file is shown below:
332 .PP
333 .EX
334 #
335 # LifeTec/Medion 9350 on port 0x378
336 #
337 scanner "LifeTec 9350" 0x378 cis1200
338
339 # Some calibration options (examples!).
340 option bw 127
341 option top_skip \-0.8
342
343 #
344 # A Mustek 600CP on port 0x3BC
345 #
346 scanner "Mustek 600CP" 0x3BC cis600
347
348 # Some calibration options (examples!).
349 option bw 120
350 option top_skip 1.2
351
352 #
353 # A Mustek 1200CP+ on port 0x278
354 #
355 scanner "Mustek 1200CP plus" 0x278 cis1200+
356
357 # Some calibration options (examples!).
358 option bw 130
359 option top_skip 0.2
360
361 #
362 # A Mustek 600 III EPP on port parport0
363 #
364 scanner "Mustek 600 III EPP" parport0 ccd300
365
366 # Some calibration options (examples!).
367 option bw 130
368 option top 56
369 .EE
370
371 .SH GLOBAL OPTIONS
372 .PP
373 You can control the overall behaviour of the
374 .B sane-\mustek_pp
375 backend by global
376 options which precede any scanner definition in the
377 .I mustek_pp.conf
378 file.
379 .sp
380 Currently, there is only one global option:
381
382 .SS Global options
383 .TP
384 .B no_epp
385 Disable parallel port mode EPP: works around a known bug in the Linux parport
386 code. Enable this option, if the backend hangs when trying to access the
387 parallel port in EPP mode.
388 .sp
389 Default value: use EPP
390 .sp
391 Example: option no_epp
392
393 .SH FILES
394 .TP
395 .I /etc/sane.d/mustek_pp.conf
396 The backend configuration file (see also description of
397 .B SANE_CONFIG_DIR
398 below).
399 .TP
400 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-mustek_pp.a
401 The static library implementing this backend.
402 .TP
403 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-mustek_pp.so
404 The shared library implementing this backend (present on systems that
405 support dynamic loading).
406
407 .SH ENVIRONMENT
408 .TP
409 .B SANE_CONFIG_DIR
410 This environment variable specifies the list of directories that may
411 contain the configuration file. On *NIX systems, the directories are
412 separated by a colon (`:'), under OS/2, they are separated by a
413 semi-colon (`;'). If this variable is not set, the configuration file
414 is searched in two default directories: first, the current working
415 directory (".") and then in
416 .IR /etc/sane.d .
417 If the value of the
418 environment variable ends with the directory separator character, then
419 the default directories are searched after the explicitly specified
420 directories. For example, setting
421 .B SANE_CONFIG_DIR
422 to "/tmp/config:" would result in directories
423 .IR "tmp/config" ,
424 .IR "." ,
425 and
426 .I "/etc/sane.d"
427 being searched (in this order).
428 .TP
429 .B SANE_DEBUG_MUSTEK_PP
430 If the library was compiled with debug support enabled, this
431 environment variable controls the debug level for this backend. E.g.,
432 a value of 128 requests all debug output to be printed. Smaller
433 levels reduce verbosity.
434 .EX
435 level debug output
436 --------------------------------------
437 0 nothing
438 1 errors
439 2 warnings & minor errors
440 3 additional information
441 4 debug information
442 5 code flow (not supported yet)
443 6 special debug information
444 .EE
445 .TP
446 .B SANE_DEBUG_SANEI_PA4S2
447 This variable sets the debug level for the SANE interface for the Mustek
448 chipset A4S2. Note that enabling this will spam your terminal with some
449 million lines of debug output.
450 .EX
451 level debug output
452 ----------------------------
453 0 nothing
454 1 errors
455 2 warnings
456 3 things nice to know
457 4 code flow
458 5 detailed code flow
459 6 everything
460 .EE
461
462 .SH "SEE ALSO"
463 .BR sane (7),
464 .BR sane\-mustek (5),
465 .BR sane\-net (5),
466 .BR saned (8),
467 .BR sane\-find\-scanner (1),
468 .BR scanimage (1)
469
470 .TP
471 For latest bug fixes and information see
472 .I http://www.penguin\-breeder.org/sane/mustek_pp/
473
474 .TP
475 For additional information on the CIS driver, see
476 .I http://home.scarlet.be/eddy_de_greef/
477
478 .SH AUTHORS
479 .nf
480 Jochen Eisinger
481 .RI < "jochen at penguin\-breeder dot org" >
482 Eddy De Greef
483 .RI < "eddy_de_greef at scarlet dot be" >
484 .fi
485
486 .SH BUGS
487 Too many... please send bug reports to
488 .I sane\[email protected]
489 (note that you have to subscribe first to the list before you can send
490 emails... see
491 .IR http://www.sane\-project.org/mailing\-lists.html ).
492
493 .SH BUG REPORTS
494 If something doesn't work, please contact us (Jochen for the CCD scanners,
495 Eddy for the CIS scanners). But we need some information about
496 your scanner to be able to help you...
497
498 .TP
499 .I SANE version
500 Run
501 .I scanimage \-V
502 to determine this.
503 .TP
504 .I the backend version and your scanner hardware
505 Run
506 .I SANE_DEBUG_MUSTEK_PP=128 scanimage \-L
507 as root. If you don't get any output from the
508 .BR sane\-mustek_pp
509 backend, make sure a line "mustek_pp" is included into your
510 .IR /etc/sane.d/dll.conf .
511 If your scanner isn't detected, make sure you've defined the right port address
512 in your
513 .IR mustek_pp.conf .
514 .TP
515 .I the name of your scanner/vendor also a worthy information. Please also include the
516 optical resolution and lamp type of your scanner, both can be found in the manual of
517 your scanner.
518 .TP
519 .I any further comments
520 if you have comments about the documentation (what could be done better), or you
521 think I should know something, please include it.