1sane-umax(5) SANE Scanner Access Now Easy sane-umax(5)
2
6 sane-umax - SANE backend for UMAX scanners
7
10 This file is only a brief description of the sane-umax backend for
11 SANE! For detailed information take a look at sane-umax-doc.html (it is
12 included in the sane source directory and in the xsane(1) online help)!
13
16 The sane-umax library implements a SANE backend that provides access to
17 several UMAX-SCSI-scanners and some Linotype Hell SCSI-scanners, paral‐
18 lel- and USB-scanners are not (and probably will never be) supported!
19 I suggest you hold one hand on the power-button of the scanner while
21 you try the first scans!
22
25 The configuration file for this backend resides in
26 /etc/sane.d/umax.conf.
27 Its contents is a list of device names that correspond to UMAX and UMAX
29 compatible scanners. Empty lines and lines starting with a hash mark
30 (#) are ignored. A sample configuration file is shown below:
31 # this is a comment
33 #
34 option scsi-maxqueue 4
35 option scsi-buffer-size-min 65536
36 option scsi-buffer-size-max 131072
37 option scan-lines 40
38 option preview-lines 10
39 option scsi-maxqueue 2
40 option execute-request-sense 0
41 option force-preview-bit-rgb 0
42 option slow-speed -1
43 option care-about-smearing -1
44 option calibration-full-ccd -1
45 option calibration-width-offset -1
46 option calibration-bytes-pixel -1
47 option exposure-time-rgb-bind -1
48 option invert-shading-data -1
49 option lamp-control-available 0
50 option gamma-lsb-padded 0
51 /dev/sge
52 #scsi Vendor Model Type Bus Channel ID LUN
53 # The following scanner supports lamp control
54 option lamp-control-available 1
55 scsi UMAX * Scanner * * * * *
56 # scanner on /dev/scanner does not support lamp control
57 option lamp-control-available 0
58 /dev/scanner
59 execute-request-sense:
62 values: 0 = disabled, 1 = enabled
63 default = 0
64 If set to 1, umax_do_request_sense() is called in umax_do_cali‐
65 bration(). This can hang the system, but has been enabled until
66 this version.
67 scsi-buffer-size-min, scsi-buffer-size-max:
69 values: 4096-1048576
70 default min = 32768, max = 131072
71 Especially the minimum value is very important. If this value
72 is set too small the backend is not able to send gamma tables to
73 the scanner or to do a correct color calibration. This may re‐
74 sult in strange color effects. If the minimum value is set too
75 large then the backend is not able to allocate the requested
76 SCSI buffer size and aborts with out of memory error. The de‐
77 fault is 32KB, for some scanners it should be increased to 64KB.
78 scan-lines, preview-lines:
80 values: 1-65535
81 default: scan-lines = 40, preview-lines = 10
82 define the maximum number of lines that are scanned into one
83 buffer
84 force-preview-bit-rgb:
86 values: 0 = disabled, 1 = enabled
87 default = 0
88 set preview bit in rgb real scan
89 slow-speed, care-about-smearing:
91 values: -1 = auto, 0 = disabled, 1 = enabled
92 default = -1
93 Dangerous options, needed for some scanners.
94 Do not change these options unless you really know what you are
95 doing otherwise you may destroy your scanner with invalid val‐
96 ues.
97 calibration-full-ccd:
99 values: -1 = auto, 0 = disabled, 1 = enabled
100 default = -1
101 do calibration for each pixel of ccd instead of selected image
102 calibration-width-offset:
104 values: -99999 = auto, > -99999 set value
105 add an offset to the calculated width for image/ccd
106 calibration-bytes-pixel:
108 values: -1 = disabled, 0 = not set, 1 = 1 byte/pixel, 2 = 2
109 bytes/pixel
110 use # bytes per pixel for calibration
111 exposure-time-rgb-bind:
113 values: -1 = automatically set by driver - if known, 0 = dis‐
114 abled (own selection for red, green and blue), 1 = enabled (same
115 values for red, green and blue)
116 invert-shading-data:
118 values: -1 = automatically set by driver - if known, 0 = dis‐
119 abled, 1 = enabled
120 default = -1
121 invert shading data before sending it back to the scanner
122 lamp-control-available:
124 values: 0 = automatically set by driver - if known, 1 = avail‐
125 able
126 default = 0
127 gamma-lsb-padded:
129 values: -1 = automatically set by driver - if known, 0 = gamma
130 data is msb padded, 1 = gamma data is lsb padded
131 default = -1
132 handle-bad-sense-error:
134 values: 0 = handle as device busy, 1 = handle as ok, 2 = handle
135 as i/o error, 3 = ignore bad error code - continue sense handler
136 default = 0
137 scsi-maxqueue:
139 values: 1..# (maximum defined at compile time)
140 default = 2
141 most SCSI drivers allow internal command queueing with a depth
142 of 2 commands. In most cases it does not improve anything when
143 you increase this value. When your SCSI driver does not support
144 any command queueing you can try to set this value to 1.
145 The special device name must be a generic SCSI device or a symlink to
148 such a device. To find out to which device your scanner is assigned
149 and how you have to set the permissions of that device, have a look at
150 sane-scsi(5).
151
154 The ISA-SCSI-adapters that are shipped with some UMAX-scanners are not
155 supported very well by Linux (I suggest not to use it), the PCI-SCSI-
156 adapters that come with some UMAX-scanners are not supported at all (as
157 far as I know). On other platforms these SCSI-adapters are not sup‐
158 ported. So you typically need to purchase another SCSI-adapter that is
159 supported by your platform. See the relevant hardware FAQs and HOWTOs
160 for your platform for more information.
161 The UMAX-scanners do block the SCSI-bus for a few seconds while scan‐
163 ning. It is not necessary to connect the scanner to its own SCSI-
164 adapter. But if you need short response time for your SCSI-harddisk
165 (e.g. if your computer is a file-server) or other SCSI devices, I sug‐
166 gest you use an own SCSI-adapter for your UMAX-scanner.
167 If you have any problems with your UMAX scanner, check your SCSI chain
169 (cable length, termination, ...).
170 See also: sane-scsi(5)
172
175 The backend configuration file:
176 /etc/sane.d/umax.conf
177 The static library implementing this backend:
179 /usr/lib64/sane/libsane-umax.a
180 The shared library implementing this backend:
182 /usr/lib64/sane/libsane-umax.so (present on systems that support
183 dynamic loading)
184
187 SANE_DEBUG_UMAX
188 If the library was compiled with debug support enabled, this en‐
189 vironment variable controls the debug level for this backend.
190 E.g., a value of 128 requests all debug output to be printed.
191 Smaller levels reduce verbosity. SANE_DEBUG_UMAX values:
192 Number Remark
194 0 print important errors (printed each time)
195 1 print errors
196 2 print sense
197 3 print warnings
198 4 print scanner-inquiry
199 5 print information
200 6 print less important information
201 7 print called procedures
202 8 print reader_process messages
203 10 print called sane-init-routines
204 11 print called sane-procedures
205 12 print sane infos
206 13 print sane option-control messages
207 Example:
210 export SANE_DEBUG_UMAX=8
211
214 X-resolutions greater than 600 dpi sometimes cause problems.
215
218 sane(7), sane-scsi(5)
219
222 Oliver Rauch
223
226 Oliver.Rauch@Rauch-Domain.DE
227 14 Jul 2008 sane-umax(5)