2008-07-14 10:49:06 +00:00
|
|
|
.TH sane\-umax 5 "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
|
|
|
|
.IX sane\-umax
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.SH NAME
|
2008-07-14 10:49:06 +00:00
|
|
|
sane\-umax \- SANE backend for UMAX scanners
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.SH ABOUT THIS FILE
|
|
|
|
|
2012-07-31 01:42:52 +00:00
|
|
|
This file only is a short description of the umax-backend for sane! For detailed information take a look at
|
2008-07-14 10:49:06 +00:00
|
|
|
sane\-umax\-doc.html (it is included in the sane source directory and in the xsane online help)!
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
|
|
|
The
|
2008-07-14 10:49:06 +00:00
|
|
|
.B sane\-umax
|
2012-07-31 01:42:52 +00:00
|
|
|
library implements a SANE backend that provides access to several UMAX-SCSI-scanners and some Linotye Hell SCSI-scanners,
|
|
|
|
parallel- and USB-scanners are not (and probably will never be) supported!
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.B I suggest you hold one hand on the power-button of the scanner while you try the first scans!
|
|
|
|
|
|
|
|
.SH CONFIGURATION
|
|
|
|
|
|
|
|
The configuration file for this backend resides in
|
2005-04-12 06:01:14 +00:00
|
|
|
.IR @CONFIGDIR@/umax.conf .
|
1999-08-09 18:06:01 +00:00
|
|
|
|
2000-08-12 15:11:46 +00:00
|
|
|
Its contents is a list of device names that correspond to UMAX and UMAX compatible scanners. Empty lines
|
1999-08-09 18:06:01 +00:00
|
|
|
and lines starting with a hash mark (#) are ignored. A sample configuration file is
|
|
|
|
shown below:
|
|
|
|
|
2005-04-12 06:01:14 +00:00
|
|
|
.nf
|
2000-10-02 10:20:02 +00:00
|
|
|
# this is a comment
|
|
|
|
#
|
2008-07-14 10:49:06 +00:00
|
|
|
option scsi\-maxqueue 4
|
|
|
|
option scsi\-buffer\-size\-min 65536
|
|
|
|
option scsi\-buffer\-size\-max 131072
|
|
|
|
option scan\-lines 40
|
|
|
|
option preview\-lines 10
|
|
|
|
option scsi\-maxqueue 2
|
|
|
|
option execute\-request\-sense 0
|
|
|
|
option force\-preview\-bit\-rgb 0
|
|
|
|
option slow\-speed \-1
|
|
|
|
option care\-about\-smearing \-1
|
|
|
|
option calibration\-full\-ccd \-1
|
|
|
|
option calibration\-width\-offset \-1
|
|
|
|
option calibration\-bytes\-pixel \-1
|
|
|
|
option exposure\-time\-rgb\-bind \-1
|
|
|
|
option invert\-shading\-data \-1
|
|
|
|
option lamp\-control\-available 0
|
|
|
|
option gamma\-lsb\-padded 0
|
1999-08-09 18:06:01 +00:00
|
|
|
/dev/sge
|
2005-04-12 06:01:14 +00:00
|
|
|
\
|
2002-01-21 21:00:33 +00:00
|
|
|
#scsi Vendor Model Type Bus Channel ID LUN
|
|
|
|
# The following scanner supports lamp control
|
2008-07-14 10:49:06 +00:00
|
|
|
option lamp\-control\-available 1
|
2002-01-21 21:00:33 +00:00
|
|
|
scsi UMAX * Scanner * * * * *
|
2005-04-12 06:01:14 +00:00
|
|
|
\
|
2002-01-21 21:00:33 +00:00
|
|
|
# scanner on /dev/scanner does not support lamp control
|
2008-07-14 10:49:06 +00:00
|
|
|
option lamp\-control\-available 0
|
2002-01-21 21:00:33 +00:00
|
|
|
/dev/scanner
|
2005-04-12 06:01:14 +00:00
|
|
|
.fi
|
|
|
|
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
execute\-request\-sense:
|
2005-04-12 06:01:14 +00:00
|
|
|
values: 0 = disabled, 1 = enabled
|
|
|
|
.br
|
|
|
|
default = 0
|
|
|
|
.br
|
|
|
|
If set to 1 umax_do_request_sense is called in
|
|
|
|
umax_do_calibration. This can hang the system
|
|
|
|
(but has been enabled until this version)
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
scsi\-buffer\-size\-min, scsi\-buffer\-size\-max:
|
2005-04-12 06:01:14 +00:00
|
|
|
values: 4096-1048576
|
|
|
|
.br
|
|
|
|
default min = 32768, max = 131072
|
|
|
|
.br
|
|
|
|
Especially the minimum value is very important.
|
|
|
|
If this value is set too small the backend is not
|
|
|
|
able to send gamma tables to the scanner or to
|
|
|
|
do a correct color calibration. This may result in
|
|
|
|
strange color effects. If the minimum value is set
|
|
|
|
too large then the backend is not able to allocate
|
|
|
|
the requested scsi buffer size and aborts with
|
|
|
|
out of memory error. The default is 32KB, for
|
|
|
|
some scanners it should be increased to 64KB.
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
scan\-lines, preview\-lines:
|
2005-04-12 06:01:14 +00:00
|
|
|
values: 1-65535
|
|
|
|
.br
|
2008-07-14 10:49:06 +00:00
|
|
|
default: scan\-lines = 40, preview\-lines = 10
|
2005-04-12 06:01:14 +00:00
|
|
|
.br
|
|
|
|
define the maximum number of lines that are scanned
|
|
|
|
into one buffer
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
force\-preview\-bit\-rgb:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
|
|
|
0 = disabled,
|
|
|
|
1 = enabled
|
|
|
|
.br
|
|
|
|
default = 0
|
|
|
|
.br
|
|
|
|
set preview bit in rgb real scan
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
slow\-speed, care\-about\-smearing:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
2008-07-14 10:49:06 +00:00
|
|
|
\-1 = auto,
|
2005-04-12 06:01:14 +00:00
|
|
|
0 = disabled,
|
|
|
|
1 = enabled
|
|
|
|
.br
|
2008-07-14 10:49:06 +00:00
|
|
|
default = \-1
|
2005-04-12 06:01:14 +00:00
|
|
|
.br
|
|
|
|
dangerous options, needed for some scanners
|
|
|
|
do not changed these options until you really know
|
|
|
|
what you do, you may destroy your scanner when you
|
|
|
|
define wrong values for this options
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
calibration\-full\-ccd:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
2008-07-14 10:49:06 +00:00
|
|
|
\-1 = auto,
|
2005-04-12 06:01:14 +00:00
|
|
|
0 = disabled,
|
|
|
|
1 = enabled
|
|
|
|
.br
|
2008-07-14 10:49:06 +00:00
|
|
|
default = \-1
|
2005-04-12 06:01:14 +00:00
|
|
|
.br
|
|
|
|
do calibration for each pixel of ccd instead of
|
|
|
|
selected image
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
calibration\-width\-offset:
|
|
|
|
values: \-99999 = auto, > \-99999 set value
|
2005-04-12 06:01:14 +00:00
|
|
|
.br
|
|
|
|
add an offset width to the calculated with for
|
|
|
|
image/ccd
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
calibration\-bytes\-pixel:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
2008-07-14 10:49:06 +00:00
|
|
|
\-1 = disabled,
|
2005-04-12 06:01:14 +00:00
|
|
|
0 = not set,
|
|
|
|
1 = 1 byte/pixel,
|
|
|
|
2 = 2 bytes/pixel
|
|
|
|
.br
|
|
|
|
use # bytes per pixel for calibration
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
exposure\-time\-rgb\-bind:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
2008-07-14 10:49:06 +00:00
|
|
|
\-1 = automatically set by driver \- if known,
|
2005-04-12 06:01:14 +00:00
|
|
|
0 = disabled (own selection for red, green and blue),
|
|
|
|
1 = enabled (same values for red, green and blue)
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
invert\-shading\-data:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
2008-07-14 10:49:06 +00:00
|
|
|
\-1 = automatically set by driver \- if known,
|
2005-04-12 06:01:14 +00:00
|
|
|
0 = disabled,
|
|
|
|
1 = enabled
|
|
|
|
.br
|
2008-07-14 10:49:06 +00:00
|
|
|
default = \-1
|
2005-04-12 06:01:14 +00:00
|
|
|
.br
|
|
|
|
invert shading data before sending it back to the scanner
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
lamp\-control\-available:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
|
|
|
0 = automatically set by driver \- if known,
|
|
|
|
1 = available
|
|
|
|
.br
|
|
|
|
default = 0
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
gamma\-lsb\-padded:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
2008-07-14 10:49:06 +00:00
|
|
|
\-1 = automatically set by driver \- if known,
|
2005-04-12 06:01:14 +00:00
|
|
|
0 = gamma data is msb padded,
|
|
|
|
1 = gamma data is lsb padded
|
|
|
|
.br
|
2008-07-14 10:49:06 +00:00
|
|
|
default = \-1
|
2005-04-12 06:01:14 +00:00
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
handle\-bad\-sense\-error:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
|
|
|
0 = handle as device busy,
|
|
|
|
1 = handle as ok,
|
|
|
|
2 = handle as i/o error,
|
|
|
|
3 = ignore bad error code \- continue sense handler
|
|
|
|
.br
|
|
|
|
default = 0
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
scsi\-maxqueue:
|
2005-04-12 06:01:14 +00:00
|
|
|
values:
|
|
|
|
1..# (maximum defined at compile time)
|
|
|
|
.br
|
|
|
|
default = 2
|
|
|
|
.br
|
|
|
|
most scsi drivers allow internal command queueing with a depth
|
|
|
|
of 2 commands. In most cases it does not mprove anything when you
|
|
|
|
increase this value. When your scsi driver does not support any
|
|
|
|
command queueing you can try to set this value to 1.
|
|
|
|
|
|
|
|
.PP
|
1999-08-09 18:06:01 +00:00
|
|
|
The special device name must be a generic SCSI device or a symlink to such a device.
|
|
|
|
To find out to which device your scanner is assigned and how you have to set the
|
2008-07-14 10:49:06 +00:00
|
|
|
permissions of that device, have a look at sane\-scsi.
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.SH SCSI ADAPTER TIPS
|
|
|
|
|
2000-08-12 15:11:46 +00:00
|
|
|
The ISA-SCSI-adapters that are shipped with some Umax-scanners are not supported very
|
|
|
|
well by Linux (I suggest not to use it), the PCI-SCSI-adapters that come with some
|
|
|
|
Umax-scanners are not supported at all (as far as I know). On other platforms these
|
|
|
|
SCSI-adapters are not supported. So you typically need to purchase another SCSI-adapter
|
|
|
|
that is supported by your platform. See the relevant hardware FAQs and HOWTOs for your
|
1999-08-09 18:06:01 +00:00
|
|
|
platform for more information.
|
|
|
|
|
|
|
|
The UMAX-scanners do block the scsi-bus for a few seconds while scanning. It is not
|
|
|
|
necessary to connect the scanner to its own SCSI-adapter. But if you need short
|
2000-08-12 15:11:46 +00:00
|
|
|
response time for your SCSI-harddisk (e.g. if your computer is a file-server) or
|
|
|
|
other scsi devices, I suggest you use an own SCSI-adapter for your UMAX-scanner.
|
|
|
|
|
|
|
|
If you have any problems with your Umax scanner, check your scsi chain
|
|
|
|
(cable length, termination, ...).
|
1999-08-09 18:06:01 +00:00
|
|
|
|
2008-07-14 10:49:06 +00:00
|
|
|
See also: sane\-scsi(5)
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.SH FILES
|
|
|
|
|
2005-04-12 06:01:14 +00:00
|
|
|
.TP
|
1999-08-09 18:06:01 +00:00
|
|
|
The backend configuration file:
|
2005-04-12 06:01:14 +00:00
|
|
|
.I @CONFIGDIR@/umax.conf
|
|
|
|
.TP
|
1999-08-09 18:06:01 +00:00
|
|
|
The static library implementing this backend:
|
2008-07-14 10:49:06 +00:00
|
|
|
.I @LIBDIR@/libsane\-umax.a
|
2005-04-12 06:01:14 +00:00
|
|
|
.TP
|
|
|
|
The shared library implementing this backend:
|
2008-07-14 10:49:06 +00:00
|
|
|
.I @LIBDIR@/libsane\-umax.so
|
2005-04-12 06:01:14 +00:00
|
|
|
(present on systems that support dynamic loading)
|
1999-08-09 18:06:01 +00:00
|
|
|
|
|
|
|
.SH ENVIRONMENT
|
|
|
|
|
2005-04-12 06:01:14 +00:00
|
|
|
.TP
|
1999-08-09 18:06:01 +00:00
|
|
|
.B SANE_DEBUG_UMAX
|
2005-04-12 06:01:14 +00:00
|
|
|
If the library was compiled with debug support enabled, this environment
|
1999-08-09 18:06:01 +00:00
|
|
|
variable controls the debug level for this backend. E.g., a value of 128
|
|
|
|
requests all debug output to be printed. Smaller levels reduce verbosity:
|
|
|
|
SANE_DEBUG_UMAX values
|
|
|
|
|
|
|
|
.ft CR
|
|
|
|
.nf
|
2005-04-12 06:01:14 +00:00
|
|
|
Number Remark
|
|
|
|
\
|
1999-08-09 18:06:01 +00:00
|
|
|
0 print important errors (printed each time)
|
|
|
|
1 print errors
|
|
|
|
2 print sense
|
|
|
|
3 print warnings
|
|
|
|
4 print scanner-inquiry
|
2012-07-31 01:42:52 +00:00
|
|
|
5 print information
|
|
|
|
6 print less important information
|
1999-08-09 18:06:01 +00:00
|
|
|
7 print called procedures
|
|
|
|
8 print reader_process messages
|
2008-07-14 10:49:06 +00:00
|
|
|
10 print called sane\-init-routines
|
|
|
|
11 print called sane\-procedures
|
1999-08-09 18:06:01 +00:00
|
|
|
12 print sane infos
|
|
|
|
13 print sane option-control messages
|
2005-04-12 06:01:14 +00:00
|
|
|
.fi
|
|
|
|
.ft R
|
|
|
|
|
|
|
|
.TP
|
1999-08-09 18:06:01 +00:00
|
|
|
Example:
|
|
|
|
export SANE_DEBUG_UMAX=8
|
|
|
|
|
|
|
|
.SH BUGS
|
|
|
|
|
|
|
|
X-resolutions greater than 600 dpi sometimes make problems
|
|
|
|
|
2001-06-10 13:32:31 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
sane(7)
|
|
|
|
|
1999-08-09 18:06:01 +00:00
|
|
|
.SH AUTHOR
|
|
|
|
|
|
|
|
Oliver Rauch
|
|
|
|
|
|
|
|
.SH EMAIL-CONTACT
|
2001-10-27 11:58:09 +00:00
|
|
|
Oliver.Rauch@Rauch-Domain.DE
|