1sane-umax(5) SANE Scanner Access Now Easy sane-umax(5)
2
6 sane-umax - SANE backend for UMAX scanners
7
10 This file only is a short description of the umax-backend for sane! For
11 detailed information take a look at sane-umax-doc.html (it is included
12 in the sane source directory and in the xsane online help)!
13
16 The sane-umax library implements a SANE backend that provides access to
17 several UMAX-SCSI-scanners and some Linotye 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
54 # The following scanner supports lamp control
55 option lamp-control-available 1
56 scsi UMAX * Scanner * * * * *
57 # scanner on /dev/scanner does not support lamp control
59 option lamp-control-available 0
60 /dev/scanner
61 execute-request-sense:
64 values: 0 = disabled, 1 = enabled
65 default = 0
66 If set to 1 umax_do_request_sense is called in umax_do_calibra‐
67 tion. This can hang the system (but has been enabled until this
68 version)
69 scsi-buffer-size-min, scsi-buffer-size-max:
71 values: 4096-1048576
72 default min = 32768, max = 131072
73 Especially the minimum value is very important. If this value
74 is set too small the backend is not able to send gamma tables to
75 the scanner or to do a correct color calibration. This may
76 result in strange color effects. If the minimum value is set too
77 large then the backend is not able to allocate the requested
78 scsi buffer size and aborts with out of memory error. The
79 default is 32KB, for some scanners it should be increased to
80 64KB.
81 scan-lines, preview-lines:
83 values: 1-65535
84 default: scan-lines = 40, preview-lines = 10
85 define the maximum number of lines that are scanned into one
86 buffer
87 force-preview-bit-rgb:
89 values: 0 = disabled, 1 = enabled
90 default = 0
91 set preview bit in rgb real scan
92 slow-speed, care-about-smearing:
94 values: -1 = auto, 0 = disabled, 1 = enabled
95 default = -1
96 dangerous options, needed for some scanners do not changed these
97 options until you really know what you do, you may destroy your
98 scanner when you define wrong values for this options
99 calibration-full-ccd:
101 values: -1 = auto, 0 = disabled, 1 = enabled
102 default = -1
103 do calibration for each pixel of ccd instead of selected image
104 calibration-width-offset:
106 values: -99999 = auto, > -99999 set value
107 add an offset width to the calculated with for image/ccd
108 calibration-bytes-pixel:
110 values: -1 = disabled, 0 = not set, 1 = 1 byte/pixel, 2 = 2
111 bytes/pixel
112 use # bytes per pixel for calibration
113 exposure-time-rgb-bind:
115 values: -1 = automatically set by driver - if known, 0 = dis‐
116 abled (own selection for red, green and blue), 1 = enabled (same
117 values for red, green and blue)
118 invert-shading-data:
120 values: -1 = automatically set by driver - if known, 0 = dis‐
121 abled, 1 = enabled
122 default = -1
123 invert shading data before sending it back to the scanner
124 lamp-control-available:
126 values: 0 = automatically set by driver - if known, 1 = avail‐
127 able
128 default = 0
129 gamma-lsb-padded:
131 values: -1 = automatically set by driver - if known, 0 = gamma
132 data is msb padded, 1 = gamma data is lsb padded
133 default = -1
134 handle-bad-sense-error:
136 values: 0 = handle as device busy, 1 = handle as ok, 2 = handle
137 as i/o error, 3 = ignore bad error code - continue sense handler
138 default = 0
139 scsi-maxqueue:
141 values: 1..# (maximum defined at compile time)
142 default = 2
143 most scsi drivers allow internal command queueing with a depth
144 of 2 commands. In most cases it does not mprove anything when
145 you increase this value. When your scsi driver does not support
146 any command queueing you can try to set this value to 1.
147 The special device name must be a generic SCSI device or a symlink to
150 such a device. To find out to which device your scanner is assigned
151 and how you have to set the permissions of that device, have a look at
152 sane-scsi.
153
156 The ISA-SCSI-adapters that are shipped with some Umax-scanners are not
157 supported very well by Linux (I suggest not to use it), the PCI-SCSI-
158 adapters that come with some Umax-scanners are not supported at all (as
159 far as I know). On other platforms these SCSI-adapters are not sup‐
160 ported. So you typically need to purchase another SCSI-adapter that is
161 supported by your platform. See the relevant hardware FAQs and HOWTOs
162 for your platform for more information.
163 The UMAX-scanners do block the scsi-bus for a few seconds while scan‐
165 ning. It is not necessary to connect the scanner to its own SCSI-
166 adapter. But if you need short response time for your SCSI-harddisk
167 (e.g. if your computer is a file-server) or other scsi devices, I sug‐
168 gest you use an own SCSI-adapter for your UMAX-scanner.
169 If you have any problems with your Umax scanner, check your scsi chain
171 (cable length, termination, ...).
172 See also: sane-scsi(5)
174
177 The backend configuration file:
178 /etc/sane.d/umax.conf
179 The static library implementing this backend:
181 /usr/lib64/sane/libsane-umax.a
182 The shared library implementing this backend:
184 /usr/lib64/sane/libsane-umax.so (present on systems that support
185 dynamic loading)
186
189 SANE_DEBUG_UMAX
190 If the library was compiled with debug support enabled, this
191 environment variable controls the debug level for this backend.
192 E.g., a value of 128 requests all debug output to be printed.
193 Smaller levels reduce verbosity: SANE_DEBUG_UMAX values
194 Number Remark
196 0 print important errors (printed each time)
198 1 print errors
199 2 print sense
200 3 print warnings
201 4 print scanner-inquiry
202 5 print information
203 6 print less important information
204 7 print called procedures
205 8 print reader_process messages
206 10 print called sane-init-routines
207 11 print called sane-procedures
208 12 print sane infos
209 13 print sane option-control messages
210 Example:
213 export SANE_DEBUG_UMAX=8
214
217 X-resolutions greater than 600 dpi sometimes make problems
218
221 sane(7)
222
225 Oliver Rauch
226
229 Oliver.Rauch@Rauch-Domain.DE
230 14 Jul 2008 sane-umax(5)