Debian Codegraph @

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

raw
1 .TH sane\-umax 5 "14 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-umax
3
4 .SH NAME
5 sane\-umax \- SANE backend for UMAX scanners
6
7 .SH ABOUT THIS FILE
8
9 This file is only a brief description of the
10 .B sane\-umax
11 backend for SANE! For detailed information take a look at
12 sane\-umax\-doc.html (it is included in the sane source directory and in the
13 .BR xsane (1)
14 online help)!
15
16 .SH DESCRIPTION
17
18 The
19 .B sane\-umax
20 library implements a SANE backend that provides access to several UMAX-SCSI-scanners and some Linotype Hell SCSI-scanners,
21 parallel- and USB-scanners are not (and probably will never be) supported!
22
23 .B I suggest you hold one hand on the power-button of the scanner while you try the first scans!
24
25 .SH CONFIGURATION
26
27 The configuration file for this backend resides in
28 .IR /etc/sane.d/umax.conf .
29
30 Its contents is a list of device names that correspond to UMAX and UMAX compatible scanners. Empty lines
31 and lines starting with a hash mark (#) are ignored. A sample configuration file is
32 shown below:
33
34 .nf
35 # this is a comment
36 #
37 option scsi\-maxqueue 4
38 option scsi\-buffer\-size\-min 65536
39 option scsi\-buffer\-size\-max 131072
40 option scan\-lines 40
41 option preview\-lines 10
42 option scsi\-maxqueue 2
43 option execute\-request\-sense 0
44 option force\-preview\-bit\-rgb 0
45 option slow\-speed \-1
46 option care\-about\-smearing \-1
47 option calibration\-full\-ccd \-1
48 option calibration\-width\-offset \-1
49 option calibration\-bytes\-pixel \-1
50 option exposure\-time\-rgb\-bind \-1
51 option invert\-shading\-data \-1
52 option lamp\-control\-available 0
53 option gamma\-lsb\-padded 0
54 /dev/sge
55 \
56 #scsi Vendor Model Type Bus Channel ID LUN
57 # The following scanner supports lamp control
58 option lamp\-control\-available 1
59 scsi UMAX * Scanner * * * * *
60 \
61 # scanner on /dev/scanner does not support lamp control
62 option lamp\-control\-available 0
63 /dev/scanner
64 .fi
65
66 .TP
67 execute\-request\-sense:
68 values: 0 = disabled, 1 = enabled
69 .br
70 default = 0
71 .br
72 If set to 1,
73 .BR umax_do_request_sense ()
74 is called in
75 .BR umax_do_calibration ().
76 This can hang the system, but has been enabled until this version.
77 .TP
78 scsi\-buffer\-size\-min, scsi\-buffer\-size\-max:
79 values: 4096-1048576
80 .br
81 default min = 32768, max = 131072
82 .br
83 Especially the minimum value is very important.
84 If this value is set too small the backend is not
85 able to send gamma tables to the scanner or to
86 do a correct color calibration. This may result in
87 strange color effects. If the minimum value is set
88 too large then the backend is not able to allocate
89 the requested SCSI buffer size and aborts with
90 out of memory error. The default is 32KB, for
91 some scanners it should be increased to 64KB.
92 .TP
93 scan\-lines, preview\-lines:
94 values: 1-65535
95 .br
96 default: scan\-lines = 40, preview\-lines = 10
97 .br
98 define the maximum number of lines that are scanned
99 into one buffer
100 .TP
101 force\-preview\-bit\-rgb:
102 values:
103 0 = disabled,
104 1 = enabled
105 .br
106 default = 0
107 .br
108 set preview bit in rgb real scan
109 .TP
110 slow\-speed, care\-about\-smearing:
111 values:
112 \-1 = auto,
113 0 = disabled,
114 1 = enabled
115 .br
116 default = \-1
117 .br
118 Dangerous options, needed for some scanners.
119 .br
120 Do not change these options unless you really know
121 what you are doing otherwise you may destroy your scanner
122 with invalid values.
123 .TP
124 calibration\-full\-ccd:
125 values:
126 \-1 = auto,
127 0 = disabled,
128 1 = enabled
129 .br
130 default = \-1
131 .br
132 do calibration for each pixel of ccd instead of
133 selected image
134 .TP
135 calibration\-width\-offset:
136 values: \-99999 = auto, > \-99999 set value
137 .br
138 add an offset to the calculated width for image/ccd
139 .TP
140 calibration\-bytes\-pixel:
141 values:
142 \-1 = disabled,
143 0 = not set,
144 1 = 1 byte/pixel,
145 2 = 2 bytes/pixel
146 .br
147 use # bytes per pixel for calibration
148 .TP
149 exposure\-time\-rgb\-bind:
150 values:
151 \-1 = automatically set by driver \- if known,
152 0 = disabled (own selection for red, green and blue),
153 1 = enabled (same values for red, green and blue)
154 .TP
155 invert\-shading\-data:
156 values:
157 \-1 = automatically set by driver \- if known,
158 0 = disabled,
159 1 = enabled
160 .br
161 default = \-1
162 .br
163 invert shading data before sending it back to the scanner
164 .TP
165 lamp\-control\-available:
166 values:
167 0 = automatically set by driver \- if known,
168 1 = available
169 .br
170 default = 0
171 .TP
172 gamma\-lsb\-padded:
173 values:
174 \-1 = automatically set by driver \- if known,
175 0 = gamma data is msb padded,
176 1 = gamma data is lsb padded
177 .br
178 default = \-1
179 .TP
180 handle\-bad\-sense\-error:
181 values:
182 0 = handle as device busy,
183 1 = handle as ok,
184 2 = handle as i/o error,
185 3 = ignore bad error code \- continue sense handler
186 .br
187 default = 0
188 .TP
189 scsi\-maxqueue:
190 values:
191 1..# (maximum defined at compile time)
192 .br
193 default = 2
194 .br
195 most SCSI drivers allow internal command queueing with a depth
196 of 2 commands. In most cases it does not improve anything when you
197 increase this value. When your SCSI driver does not support any
198 command queueing you can try to set this value to 1.
199
200 .PP
201 The special device name must be a generic SCSI device or a symlink to such a device.
202 To find out to which device your scanner is assigned and how you have to set the
203 permissions of that device, have a look at
204 .BR sane\-scsi (5).
205
206 .SH SCSI ADAPTER TIPS
207
208 The ISA-SCSI-adapters that are shipped with some UMAX-scanners are not supported very
209 well by Linux (I suggest not to use it), the PCI-SCSI-adapters that come with some
210 UMAX-scanners are not supported at all (as far as I know). On other platforms these
211 SCSI-adapters are not supported. So you typically need to purchase another SCSI-adapter
212 that is supported by your platform. See the relevant hardware FAQs and HOWTOs for your
213 platform for more information.
214
215 The UMAX-scanners do block the SCSI-bus for a few seconds while scanning. It is not
216 necessary to connect the scanner to its own SCSI-adapter. But if you need short
217 response time for your SCSI-harddisk (e.g. if your computer is a file-server) or
218 other SCSI devices, I suggest you use an own SCSI-adapter for your UMAX-scanner.
219
220 If you have any problems with your UMAX scanner, check your SCSI chain
221 (cable length, termination, ...).
222
223 See also:
224 .BR sane\-scsi (5)
225
226 .SH FILES
227
228 .TP
229 The backend configuration file:
230 .I /etc/sane.d/umax.conf
231 .TP
232 The static library implementing this backend:
233 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-umax.a
234 .TP
235 The shared library implementing this backend:
236 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-umax.so
237 (present on systems that support dynamic loading)
238
239 .SH ENVIRONMENT
240
241 .TP
242 .B SANE_DEBUG_UMAX
243 If the library was compiled with debug support enabled, this environment
244 variable controls the debug level for this backend. E.g., a value of 128
245 requests all debug output to be printed. Smaller levels reduce verbosity.
246 .B SANE_DEBUG_UMAX
247 values:
248
249 .ft CR
250 .nf
251 Number Remark
252 \
253 0 print important errors (printed each time)
254 1 print errors
255 2 print sense
256 3 print warnings
257 4 print scanner-inquiry
258 5 print information
259 6 print less important information
260 7 print called procedures
261 8 print reader_process messages
262 10 print called sane\-init-routines
263 11 print called sane\-procedures
264 12 print sane infos
265 13 print sane option-control messages
266 .fi
267 .ft R
268
269 .TP
270 Example:
271 export SANE_DEBUG_UMAX=8
272
273 .SH BUGS
274 X-resolutions greater than 600 dpi sometimes cause problems.
275
276 .SH SEE ALSO
277 .BR sane (7),
278 .BR sane\-scsi (5)
279
280 .SH AUTHOR
281 Oliver Rauch
282
283 .SH EMAIL-CONTACT
284 .I [email protected]