2003-09-16 05:16:37 +00:00
|
|
|
|
.\" .IX sane-umax_pp
|
|
|
|
|
.TH "sane-umax_pp" "5" "16 September 2003" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
|
|
|
|
|
.SH "NAME"
|
|
|
|
|
sane\-umax_pp \- SANE backend for Umax Astra parallel port flatbed scanners
|
|
|
|
|
.SH "DESCRIPTION"
|
2001-05-03 19:45:32 +00:00
|
|
|
|
The
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B sane\-umax_pp
|
2001-05-03 19:45:32 +00:00
|
|
|
|
library implements a SANE (Scanner Access Now Easy) backend that
|
|
|
|
|
provides access to Umax parallel port flatbed scanners. The
|
|
|
|
|
following scanners work with this backend:
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RS
|
|
|
|
|
Model:
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
|
|
|
|
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
|
|
|
|
.br
|
2004-03-09 06:12:27 +00:00
|
|
|
|
Astra 610P
|
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
Astra 1220P
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
HP3200C
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
Astra 1600P
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
Astra 2000P
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RE
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
This backend handles 75x75, 150x150, 300x300, 600x600 and 600x1200 dpi scan
|
2003-01-07 06:16:39 +00:00
|
|
|
|
resolutions, in color and gray levels. There is a software lineart mode.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
These scanners share the same ASIC. Only parts such as CCD and ADC change from
|
|
|
|
|
one to another. They even all reports being UMAX Astra 1220P via IEEE1284.
|
2003-01-07 06:16:39 +00:00
|
|
|
|
There isn't software way to recognize them properly. Under windows, model is
|
|
|
|
|
set by the driver installed, regardless of the hardware.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
|
|
|
|
.TP
|
2004-03-09 06:12:27 +00:00
|
|
|
|
.B EPP/ECP MODES ONLY
|
|
|
|
|
The current version of the backend uses only EPP or ECP mode to communicate
|
|
|
|
|
with the scanner. PS/2 and SPP mode aren't implemented. It is recommended that
|
|
|
|
|
you set your parallel port to EPP in BIOS with the current version of this
|
|
|
|
|
backend. You can leave it to ECP or ECP+EPP, but in this case you may not use
|
|
|
|
|
ppdev but only direct hardware access if you have to use ECP. ECPEPP will only
|
|
|
|
|
work if you use a 2.4 or 2.6 kernel with ppdev character device support.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
This backend does support parport sharing only
|
|
|
|
|
.I
|
|
|
|
|
if you have a kernel with ppdev support.
|
|
|
|
|
.I
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
1994-02-15 08:40:30 +00:00
|
|
|
|
Note that if you don't use the ppdev character device, the backend
|
|
|
|
|
needs to run as root. To allow user access to the scanner
|
2004-06-13 15:25:13 +00:00
|
|
|
|
run the backend through the network interface (See saned(8) and sane\-net(5)).
|
2001-06-20 04:12:58 +00:00
|
|
|
|
A more relaxed solution (security wise) is to add suid bit to the frontend
|
2001-05-03 19:45:32 +00:00
|
|
|
|
(See chmod(1)).
|
|
|
|
|
The backend drop root priviledges as soon as it can, right after gaining direct
|
2003-01-07 06:16:39 +00:00
|
|
|
|
access to IO ports, which lessen risks when being root.
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
|
|
|
|
.SH "DEVICE NAMES"
|
|
|
|
|
This backend expects device names of the form:
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RS
|
1994-02-15 08:40:30 +00:00
|
|
|
|
.I port value
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RE
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
Where
|
2003-10-21 05:04:58 +00:00
|
|
|
|
\fBvalue\fR is :
|
|
|
|
|
|
|
|
|
|
.RS
|
|
|
|
|
value description.br
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
\-\-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
auto autodetect all parallel ports and probe
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
them for scanner
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
safe\-auto autodetect all parallel ports and probe
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
them for scanner, but does not try direct
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
hardware access
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
/dev/ppi0 uses *BSD ppi device, depending on the
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
number of available parallel port, you
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
have to use /dev/ppi1, /dev/ppi2, ...
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2003-10-21 05:04:58 +00:00
|
|
|
|
/dev/parport0 uses linux ppdev device, depending on the
|
|
|
|
|
.br
|
|
|
|
|
number of available parallel port, you
|
|
|
|
|
.br
|
|
|
|
|
have to use /dev/parport1, /dev/parport2, ...
|
|
|
|
|
.br
|
|
|
|
|
0x378 does direct hardware access on the given
|
|
|
|
|
.br
|
|
|
|
|
address. Usual values are 0x378, 0x278, 0x3BC
|
|
|
|
|
.br
|
|
|
|
|
In this case, you have to run the scanner as
|
|
|
|
|
.br
|
|
|
|
|
root (*BSD and linux), or with 'IOPL=yes' on
|
|
|
|
|
.br
|
|
|
|
|
OS/2
|
|
|
|
|
.br
|
|
|
|
|
.PP
|
|
|
|
|
.RE
|
|
|
|
|
\fBNOTE:\fR in all cases, you must have sufficient priviledges
|
|
|
|
|
.br
|
|
|
|
|
to get access to the chosen device or address. Depending on the
|
|
|
|
|
.br
|
|
|
|
|
security settings, devices may not be available for all users.
|
|
|
|
|
.br
|
|
|
|
|
You have to change permissions on the dev/ppi* or /dev/parport* devices.
|
|
|
|
|
.br
|
|
|
|
|
.PP
|
|
|
|
|
.RE
|
2001-05-03 19:45:32 +00:00
|
|
|
|
You can rename any device using the
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RS
|
|
|
|
|
.I name devname
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I model model
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I vendor vendor
|
|
|
|
|
.RE
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
1994-02-15 08:40:30 +00:00
|
|
|
|
options. These options apply to the last port option.
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.SH "CONFIGURATION"
|
2001-05-03 19:45:32 +00:00
|
|
|
|
Please make sure to edit umax_pp.conf
|
|
|
|
|
.B before
|
|
|
|
|
you use the backend.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
The contents of the
|
|
|
|
|
.B umax_pp.conf
|
|
|
|
|
file is a list of options and device names that correspond to Umax
|
|
|
|
|
scanners. Empty lines and lines starting with a hash mark (#) are
|
|
|
|
|
ignored.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
The height options supported are
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.BR red\-brightness ,
|
|
|
|
|
.BR green\-brightness ,
|
|
|
|
|
.BR blue\-brightness ,
|
|
|
|
|
.BR red\-contrast ,
|
|
|
|
|
.BR green\-contrast ,
|
|
|
|
|
.BR blue\-contrast ,
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.BR astra ,
|
|
|
|
|
and
|
|
|
|
|
.BR buffer .
|
|
|
|
|
|
|
|
|
|
Options
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B red\-brightness
|
2001-05-03 19:45:32 +00:00
|
|
|
|
,
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B green\-brightness
|
2001-05-03 19:45:32 +00:00
|
|
|
|
and
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B blue\-brightness
|
2001-05-03 19:45:32 +00:00
|
|
|
|
allow you to adjust the sensitivy of your scanner for the given color. Values
|
2003-09-16 05:16:37 +00:00
|
|
|
|
range from 0 (lowest brightness) to 15 (highest). If the advanced option "Brightness" isn't
|
|
|
|
|
checked in the frontend, the backend does automatic brightness calibration, and do not use
|
|
|
|
|
user provided values.
|
2003-02-25 07:04:12 +00:00
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
|
|
|
|
Options
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B red\-contrast
|
2001-05-03 19:45:32 +00:00
|
|
|
|
,
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B green\-contrast
|
2001-05-03 19:45:32 +00:00
|
|
|
|
and
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.B blue\-contrast
|
2003-02-25 07:04:12 +00:00
|
|
|
|
allow you to adjust the contrast of your scanner for the given color. Values
|
|
|
|
|
range from 0 (lowest contrast) to 15 (highest).
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
|
|
|
|
Option
|
|
|
|
|
.B astra
|
|
|
|
|
allows you to change the model of your scanner. Current auto detection is based
|
|
|
|
|
on side effects on scanning when using 1220P command set on other models, so
|
2004-03-09 06:12:27 +00:00
|
|
|
|
it may fail on unkown hardware combination. Valid values are 610, 1220, 1600
|
2003-10-21 05:04:58 +00:00
|
|
|
|
and 2000. It is usefull only when autodetection fails to detect properly
|
|
|
|
|
your scanner model. If your scanner work properly but is reported wrongly,
|
|
|
|
|
let it be that way.
|
1994-02-15 08:40:30 +00:00
|
|
|
|
The only valid case to change the model is when your scanner produces 'black' or
|
2003-10-21 05:04:58 +00:00
|
|
|
|
'inverted' scans. In this case you can put the model. Be aware that it will
|
|
|
|
|
prevent scanner model autodetection.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
|
|
|
|
Option
|
|
|
|
|
.B buffer
|
|
|
|
|
allows you to change the size of the scan buffer. The size must be specified in
|
2003-01-07 06:16:39 +00:00
|
|
|
|
bytes. The default value is 2 megabytes. Decreasing this value will improve the
|
2004-03-09 06:12:27 +00:00
|
|
|
|
smoothness of progress bar in the frontend, but will stall the
|
2003-10-21 05:04:58 +00:00
|
|
|
|
scan more often.
|
2003-01-07 06:16:39 +00:00
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.SH "FILES"
|
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I @CONFIGDIR@/umax_pp.conf
|
|
|
|
|
The backend configuration file (see also description of
|
|
|
|
|
.B SANE_CONFIG_DIR
|
|
|
|
|
below).
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I @LIBDIR@/libsane\-umax_pp.a
|
|
|
|
|
The static library implementing this backend.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I @LIBDIR@/libsane\-umax_pp.so
|
|
|
|
|
The shared library implementing this backend (present on systems that
|
|
|
|
|
support dynamic loading).
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.SH "ENVIRONMENT"
|
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.B SANE_CONFIG_DIR
|
|
|
|
|
This environment variable specifies the list of directories that may
|
|
|
|
|
contain the configuration file. Under UNIX, the directories are
|
|
|
|
|
separated by a colon (`:'), under OS/2, they are separated by a
|
2003-09-16 05:16:37 +00:00
|
|
|
|
semi\-colon (`;'). If this variable is not set, the configuration file
|
2001-05-03 19:45:32 +00:00
|
|
|
|
is searched in two default directories: first, the current working
|
|
|
|
|
directory (".") and then in @CONFIGDIR@. If the value of the
|
|
|
|
|
environment variable ends with the directory separator character, then
|
|
|
|
|
the default directories are searched after the explicitly specified
|
|
|
|
|
directories. For example, setting
|
|
|
|
|
.B SANE_CONFIG_DIR
|
|
|
|
|
to "/tmp/config:" would result in directories "tmp/config", ".", and
|
|
|
|
|
"@CONFIGDIR@" being searched (in this order).
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.B SANE_DEBUG_UMAX_PP
|
|
|
|
|
If the library was compiled with debug support enabled, this
|
|
|
|
|
environment 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.
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RS
|
|
|
|
|
level debug output
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
|
|
|
|
\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
0 nothing
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
1 errors
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
2 warnings & minor errors
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
3 additional information
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
4 debug information
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
5 code flow (not supported yet)
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
6 special debug information
|
|
|
|
|
.RE
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.B SANE_DEBUG_UMAX_PP_LOW
|
|
|
|
|
This variable sets the debug level for the SANE interface for the Umax
|
|
|
|
|
ASIC. Note that enabling this will spam your terminal with some
|
|
|
|
|
million lines of debug output.
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.RS
|
|
|
|
|
level debug output
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
|
|
|
|
\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
|
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
0 nothing
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
1 errors
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
8 command blocks
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
16 detailed code flow
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
32 dump datafiles
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.br
|
2001-05-03 19:45:32 +00:00
|
|
|
|
255 everything
|
|
|
|
|
.RE
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.PP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.SH "SEE ALSO"
|
2004-06-13 15:25:13 +00:00
|
|
|
|
sane(7), sane\-net(5), saned(8)
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
For latest bug fixes and information see
|
|
|
|
|
.I http://umax1220p.sourceforge.net/
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.SH "AUTHOR"
|
2003-10-21 05:04:58 +00:00
|
|
|
|
St<EFBFBD>phane VOLTZ <svoltz@wanadoo.fr>
|
2001-05-03 19:45:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.SH "BUG REPORTS"
|
2001-05-03 19:45:32 +00:00
|
|
|
|
If something doesn't work, please contact me. But I need some information about
|
|
|
|
|
your scanner to be able to help you...
|
|
|
|
|
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I SANE version
|
2003-09-16 05:16:37 +00:00
|
|
|
|
run "scanimage \-V" to determine this
|
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I the backend version and your scanner hardware
|
2003-10-21 05:04:58 +00:00
|
|
|
|
run "SANE_DEBUG_UMAX_PP=255 scanimage \-L 2>log" as root. If you don't get any output
|
2001-05-03 19:45:32 +00:00
|
|
|
|
from the umax_pp backend, make sure a line "umax_pp" is included into
|
|
|
|
|
your @CONFIGDIR@/dll.conf.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
If your scanner isn't detected, make sure you've defined the right port address, or the
|
|
|
|
|
correct device
|
2001-05-03 19:45:32 +00:00
|
|
|
|
in your umax_pp.conf.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I the name of your scanner/vendor
|
|
|
|
|
also a worthy information. Please also include the optical resolution and lamp type of your scanner, both can be found in the manual of your scanner.
|
2003-09-16 05:16:37 +00:00
|
|
|
|
.TP
|
2001-05-03 19:45:32 +00:00
|
|
|
|
.I any further comments
|
|
|
|
|
if you have comments about the documentation (what could be done better), or you
|
|
|
|
|
think I should know something, please include it.
|