| 1 |
.TH "sane\-umax_pp" "5" "14 Jul 2008" "" "SANE Scanner Access Now Easy" |
| 2 |
.IX sane\-umax_pp |
| 3 |
.SH "NAME" |
| 4 |
sane\-umax_pp \- SANE backend for Umax Astra parallel port flatbed scanners |
| 5 |
.SH "DESCRIPTION" |
| 6 |
The |
| 7 |
.B sane\-umax_pp |
| 8 |
library implements a SANE (Scanner Access Now Easy) backend that |
| 9 |
provides access to Umax parallel port flatbed scanners. The |
| 10 |
following scanners work with this backend: |
| 11 |
.PP |
| 12 |
.RS |
| 13 |
Model: |
| 14 |
.br |
| 15 |
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |
| 16 |
.br |
| 17 |
Astra 610P |
| 18 |
.br |
| 19 |
Astra 1220P |
| 20 |
.br |
| 21 |
HP3200C |
| 22 |
.br |
| 23 |
Astra 1600P |
| 24 |
.br |
| 25 |
Astra 2000P |
| 26 |
.br |
| 27 |
Genius ColorPage-Life Pro |
| 28 |
.br |
| 29 |
.RE |
| 30 |
.PP |
| 31 |
This backend handles 75x75, 150x150, 300x300, 600x600 and 600x1200 for 1220P/1600P/2000P |
| 32 |
dpi scan resolutions, and 75x75, 150x150, 300x300 and 300x600 for 610P. In color and gray |
| 33 |
levels, there is a software lineart mode. |
| 34 |
.PP |
| 35 |
The new generation models share a newer version of the 610P ASIC embedded in an EPAT chip. |
| 36 |
Only parts such as CCD and ADC change from |
| 37 |
one to another. They even all reports being UMAX Astra 1220P via IEEE1284. |
| 38 |
There isn't a software method to recognize them properly. Under windows, model is |
| 39 |
set by the driver installed, regardless of the hardware. |
| 40 |
.PP |
| 41 |
.TP |
| 42 |
.B EPP/ECP MODES ONLY |
| 43 |
The current version of the backend uses only EPP or ECP mode to communicate |
| 44 |
with the scanner. PS/2 mode isn't implemented. The 610P only use SPP. It is |
| 45 |
recommended that you set your parallel port to EPP in BIOS with the current |
| 46 |
version of this |
| 47 |
backend. You can leave it to ECP or ECP+EPP, but in this case you may not use |
| 48 |
ppdev but only direct hardware access if you have to use ECP. ECPEPP will only |
| 49 |
work if you use a 2.4 or 2.6 kernel with ppdev character device support. |
| 50 |
.PP |
| 51 |
This backend does support parport sharing only |
| 52 |
.I |
| 53 |
if you have a kernel with ppdev support. |
| 54 |
.I |
| 55 |
.PP |
| 56 |
Note that if you don't use the ppdev character device, the backend |
| 57 |
needs to run as root. To allow user access to the scanner |
| 58 |
run the backend through the network interface (see |
| 59 |
.BR saned (8) |
| 60 |
and |
| 61 |
.BR sane\-net (5)). |
| 62 |
A more relaxed solution (security wise) is to add suid bit to the frontend |
| 63 |
(see |
| 64 |
.BR chmod (1)). |
| 65 |
The backend drops root privileges as soon as it can, right after gaining direct |
| 66 |
access to I/O ports, which lessen risks of being root. |
| 67 |
|
| 68 |
.SH "DEVICE NAMES" |
| 69 |
This backend expects device names of the form: |
| 70 |
.PP |
| 71 |
.RS |
| 72 |
.I port value |
| 73 |
.RE |
| 74 |
.PP |
| 75 |
Where |
| 76 |
\fBvalue\fR is: |
| 77 |
|
| 78 |
.RS |
| 79 |
.TP |
| 80 |
auto |
| 81 |
autodetect all parallel ports and probe |
| 82 |
them for scanner |
| 83 |
.TP |
| 84 |
safe\-auto |
| 85 |
autodetect all parallel ports and probe |
| 86 |
them for scanner, but does not try direct |
| 87 |
hardware access |
| 88 |
.TP |
| 89 |
.I /dev/ppi0 |
| 90 |
uses *BSD ppi device, depending on the |
| 91 |
number of available parallel port, you |
| 92 |
have to use |
| 93 |
.IR /dev/ppi1 , |
| 94 |
.IR /dev/ppi2 ", ..." |
| 95 |
.TP |
| 96 |
.I /dev/parport0 |
| 97 |
uses Linux ppdev device, depending on the |
| 98 |
number of available parallel port, you |
| 99 |
have to use |
| 100 |
.IR /dev/parport1 , |
| 101 |
.IR /dev/parport2 ", ..." |
| 102 |
.TP |
| 103 |
0x378 |
| 104 |
does direct hardware access on the given |
| 105 |
address. Usual values are 0x378, 0x278, 0x3BC. |
| 106 |
In this case, you have to run the backend as |
| 107 |
root (*BSD and Linux), or with 'IOPL=yes' on |
| 108 |
OS/2 |
| 109 |
.PP |
| 110 |
.RE |
| 111 |
\fBNOTE:\fR in all cases, you must have sufficient privileges |
| 112 |
to get access to the chosen device or address. Depending on the |
| 113 |
security settings, devices may not be available for all users. |
| 114 |
You have to change permissions on the |
| 115 |
.I /dev/ppi* |
| 116 |
or |
| 117 |
.I /dev/parport* |
| 118 |
devices. |
| 119 |
.PP |
| 120 |
.RE |
| 121 |
You can rename any device using the |
| 122 |
.PP |
| 123 |
.RS |
| 124 |
.I name devname |
| 125 |
.br |
| 126 |
.I model model |
| 127 |
.br |
| 128 |
.I vendor vendor |
| 129 |
.RE |
| 130 |
.PP |
| 131 |
options. These options apply to the last port option. |
| 132 |
|
| 133 |
.SH "CONFIGURATION" |
| 134 |
Please make sure to edit |
| 135 |
.I umax_pp.conf |
| 136 |
.B before |
| 137 |
you use the backend. |
| 138 |
.PP |
| 139 |
The contents of the |
| 140 |
.I umax_pp.conf |
| 141 |
file is a list of options and device names that correspond to Umax |
| 142 |
scanners. Empty lines and lines starting with a hash mark (#) are |
| 143 |
ignored. |
| 144 |
.PP |
| 145 |
The eight options supported are |
| 146 |
.BR red\-gain , |
| 147 |
.BR green\-gain , |
| 148 |
.BR blue\-gain , |
| 149 |
.BR red\-offset , |
| 150 |
.BR green\-offset , |
| 151 |
.BR blue\-offset , |
| 152 |
.BR astra , |
| 153 |
and |
| 154 |
.BR buffer . |
| 155 |
|
| 156 |
Options |
| 157 |
.BR red\-gain , |
| 158 |
.B green\-gain |
| 159 |
and |
| 160 |
.B blue\-gain |
| 161 |
allow you to adjust the sensitivity of your scanner for the given color. Values |
| 162 |
range from 0 (lowest gain) to 15 (highest). If the advanced option "Gain" isn't |
| 163 |
checked in the frontend, the backend does automatic gain calibration, and do not use |
| 164 |
user provided values. |
| 165 |
|
| 166 |
.PP |
| 167 |
|
| 168 |
Options |
| 169 |
.BR red\-offset , |
| 170 |
.B green\-offset |
| 171 |
and |
| 172 |
.B blue\-offset |
| 173 |
allow you to adjust the offset of your scanner for the given color. Values |
| 174 |
range from 0 (lowest offset) to 15 (highest). |
| 175 |
.PP |
| 176 |
|
| 177 |
Option |
| 178 |
.B astra |
| 179 |
allows you to change the model of your scanner. Current auto detection is based |
| 180 |
on side effects on scanning when using 1220P command set on other models, so |
| 181 |
it may fail on unknown hardware combination. Valid values are 610, 1220, 1600 |
| 182 |
and 2000. It is useful only when autodetection fails to detect properly |
| 183 |
your scanner model. If your scanner work properly but is reported wrongly, |
| 184 |
let it be that way. |
| 185 |
The only valid case to change the model is when your scanner produces "black" or |
| 186 |
"inverted" scans. In this case you can put the model. Be aware that it will |
| 187 |
prevent scanner model autodetection. |
| 188 |
.PP |
| 189 |
|
| 190 |
Option |
| 191 |
.B buffer |
| 192 |
allows you to change the size of the scan buffer. The size must be specified in |
| 193 |
bytes. The default value is 2 megabytes. Decreasing this value will improve the |
| 194 |
smoothness of progress bar in the frontend, but will stall the |
| 195 |
scan more often. |
| 196 |
|
| 197 |
.PP |
| 198 |
|
| 199 |
|
| 200 |
|
| 201 |
.SH "FILES" |
| 202 |
.TP |
| 203 |
.I /etc/sane.d/umax_pp.conf |
| 204 |
The backend configuration file (see also description of |
| 205 |
.B SANE_CONFIG_DIR |
| 206 |
below). |
| 207 |
.TP |
| 208 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-umax_pp.a |
| 209 |
The static library implementing this backend. |
| 210 |
.TP |
| 211 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-umax_pp.so |
| 212 |
The shared library implementing this backend (present on systems that |
| 213 |
support dynamic loading). |
| 214 |
|
| 215 |
.SH "ENVIRONMENT" |
| 216 |
.TP |
| 217 |
.B SANE_CONFIG_DIR |
| 218 |
This environment variable specifies the list of directories that may |
| 219 |
contain the configuration file. On *NIX systems, the directories are |
| 220 |
separated by a colon (`:'), under OS/2, they are separated by a |
| 221 |
semi-colon (`;'). If this variable is not set, the configuration file |
| 222 |
is searched in two default directories: first, the current working |
| 223 |
directory (".") and then in |
| 224 |
.IR /etc/sane.d . |
| 225 |
If the value of the |
| 226 |
environment variable ends with the directory separator character, then |
| 227 |
the default directories are searched after the explicitly specified |
| 228 |
directories. For example, setting |
| 229 |
.B SANE_CONFIG_DIR |
| 230 |
to "/tmp/config:" would result in directories |
| 231 |
.IR tmp/config , |
| 232 |
.IR . , |
| 233 |
and |
| 234 |
.I /etc/sane.d |
| 235 |
being searched (in this order). |
| 236 |
.TP |
| 237 |
.B SANE_DEBUG_UMAX_PP |
| 238 |
If the library was compiled with debug support enabled, this |
| 239 |
environment variable controls the debug level for this backend. E.g., |
| 240 |
a value of 128 requests all debug output to be printed. Smaller |
| 241 |
levels reduce verbosity. |
| 242 |
|
| 243 |
.PP |
| 244 |
.RS |
| 245 |
.ft CR |
| 246 |
.nf |
| 247 |
level debug output |
| 248 |
\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |
| 249 |
0 nothing |
| 250 |
1 errors |
| 251 |
2 warnings & minor errors |
| 252 |
3 additional information |
| 253 |
4 debug information |
| 254 |
5 code flow (not supported yet) |
| 255 |
6 special debug information |
| 256 |
.fi |
| 257 |
.ft R |
| 258 |
.RE |
| 259 |
.PP |
| 260 |
.TP |
| 261 |
.B SANE_DEBUG_UMAX_PP_LOW |
| 262 |
This variable sets the debug level for the SANE interface for the Umax |
| 263 |
ASIC. Note that enabling this will spam your terminal with some |
| 264 |
million lines of debug output. |
| 265 |
|
| 266 |
.PP |
| 267 |
.RS |
| 268 |
.ft CR |
| 269 |
.nf |
| 270 |
level debug output |
| 271 |
\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- |
| 272 |
0 nothing |
| 273 |
1 errors |
| 274 |
8 command blocks |
| 275 |
16 detailed code flow |
| 276 |
32 dump datafiles |
| 277 |
255 everything |
| 278 |
.fi |
| 279 |
.ft R |
| 280 |
.RE |
| 281 |
.PP |
| 282 |
|
| 283 |
.PP |
| 284 |
.SH "SEE ALSO" |
| 285 |
.BR sane (7), |
| 286 |
.BR sane\-net (5), |
| 287 |
.BR saned (8) |
| 288 |
|
| 289 |
.TP |
| 290 |
For latest bug fixes and information see |
| 291 |
.I http://umax1220p.sourceforge.net/ |
| 292 |
|
| 293 |
.SH "AUTHOR" |
| 294 |
St\['e]phane Voltz |
| 295 |
.RI < [email protected] > |
| 296 |
|
| 297 |
.SH "CREDITS" |
| 298 |
Support for the 610P has been made possible thank to an hardware donation |
| 299 |
by William Stuart. |
| 300 |
|
| 301 |
.SH "BUG REPORTS" |
| 302 |
If something doesn't work, please contact me. But I need some information about |
| 303 |
your scanner to be able to help you... |
| 304 |
|
| 305 |
.TP |
| 306 |
.I SANE version |
| 307 |
Run |
| 308 |
.I "scanimage \-V" |
| 309 |
to determine this |
| 310 |
.TP |
| 311 |
.I the backend version and your scanner hardware |
| 312 |
Run |
| 313 |
.I "SANE_DEBUG_UMAX_PP=255 scanimage \-L 2>log" |
| 314 |
as root. If you don't get any output |
| 315 |
from the |
| 316 |
.B sane\-umax_pp |
| 317 |
backend, make sure a line "umax_pp" is included into your |
| 318 |
.I /etc/sane.d/dll.conf |
| 319 |
file. |
| 320 |
If your scanner isn't detected, make sure you've defined the right port address, or the |
| 321 |
correct device |
| 322 |
in your |
| 323 |
.I umax_pp.conf |
| 324 |
file. |
| 325 |
.TP |
| 326 |
.I the name of your scanner/vendor |
| 327 |
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. |
| 328 |
.TP |
| 329 |
.I any further comments |
| 330 |
if you have comments about the documentation (what could be done better), or you |
| 331 |
think I should know something, please include it. |