| 1 |
.TH sane\-microtek2 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy" |
| 2 |
.SH NAME |
| 3 |
sane\-microtek2 \- SANE backend for Microtek scanners with SCSI-2 command set |
| 4 |
.SH DESCRIPTION |
| 5 |
The |
| 6 |
.B sane\-microtek2 |
| 7 |
library implements a SANE (Scanner Access Now Easy) backend that |
| 8 |
provides access to Microtek scanners with a SCSI-2 command set. |
| 9 |
This backend can be considered alpha to beta. Some scanner models are reported |
| 10 |
to work well, others not. |
| 11 |
.PP |
| 12 |
There exists a different backend for Microtek scanners with SCSI-1 command |
| 13 |
set. |
| 14 |
Refer to |
| 15 |
.BR sane\-microtek (5) |
| 16 |
for details. |
| 17 |
.PP |
| 18 |
And there is partial progress for the ScanMaker 3600. |
| 19 |
See |
| 20 |
.IR http://sourceforge.net/projects/sm3600 . |
| 21 |
.PP |
| 22 |
At present, the following scanners are known positively to work with this |
| 23 |
backend: |
| 24 |
.PP |
| 25 |
.ft CR |
| 26 |
.nf |
| 27 |
Vendor Product id Remark |
| 28 |
-------------------------------------------------------------------- |
| 29 |
Microtek E3+ Parport and SCSI |
| 30 |
Microtek X6 SCSI |
| 31 |
Microtek X6EL SCSI |
| 32 |
Microtek X6USB USB |
| 33 |
Microtek ScanMaker V300 Parport and SCSI |
| 34 |
Microtek ScanMaker V310 Parport and SCSI |
| 35 |
Microtek ScanMaker V600 Parport and SCSI |
| 36 |
Microtek ScanMaker 330 SCSI |
| 37 |
Microtek ScanMaker 630 SCSI |
| 38 |
Microtek ScanMaker 636 SCSI |
| 39 |
Microtek ScanMaker 9600XL SCSI; only flatbed mode? |
| 40 |
Microtek Phantom 330CX Parport |
| 41 |
Microtek SlimScan C3 Parport |
| 42 |
Microtek SlimScan C6 USB |
| 43 |
Microtek Phantom 636 SCSI |
| 44 |
Microtek Phantom 636CX Parport |
| 45 |
Microtek V6USL SCSI and USB |
| 46 |
Microtek V6UPL USB; not stable |
| 47 |
Microtek X12USL SCSI; only 8bit color, work in progress |
| 48 |
Vobis HighScan SCSI (E3+ based models) |
| 49 |
Scanport SQ300 Parport? |
| 50 |
Scanport SQ4836 SCSI |
| 51 |
Scanpaq SQ2030 Parport |
| 52 |
.fi |
| 53 |
.ft R |
| 54 |
.PP |
| 55 |
Additional information can be found at |
| 56 |
.IR http://www.sane\-project.org/ . |
| 57 |
.PP |
| 58 |
If you own a Microtek scanner other than the ones listed above, |
| 59 |
it may or may not work with SANE! Because equal scanners are sold under |
| 60 |
different names in different countries your model may be equivalent to one of |
| 61 |
the above. |
| 62 |
.PP |
| 63 |
The parport scanners work with the ppscsi + onscsi kernel modules. See |
| 64 |
.I http://cyberelk.net/tim/parport/ppscsi.html |
| 65 |
and |
| 66 |
.IR http://penguin-breeder.org/kernel/download/ . |
| 67 |
|
| 68 |
.PP |
| 69 |
The USB scanners work with the microtek kernel module. You may have to add the |
| 70 |
vendor and model codes to microtek.c if they aren't yet listed there. |
| 71 |
.PP |
| 72 |
Both parport and USB scanners need the generic SCSI support, so check if you |
| 73 |
have loaded the scsi_mod and sg modules! |
| 74 |
.PP |
| 75 |
If you try your scanner for the first time keep an eye on it. If it gets |
| 76 |
commands that it doesn't understand the scanhead may go beyond the scan area. |
| 77 |
The scanner then makes strange noises. In this case immediately switch off |
| 78 |
the scanner or disconnect its power cable to prevent damages! |
| 79 |
.PP |
| 80 |
If your scanner is a different one than the models mentioned above and it is |
| 81 |
working please tell the author about it. It would be nice if you add a logfile |
| 82 |
to this information (creation of the logfile: see below). |
| 83 |
.PP |
| 84 |
If your scanner is not working properly you also should create a logfile and |
| 85 |
send it to the author. He will use the information to improve the backend and |
| 86 |
possibly make your scanner work. |
| 87 |
.PP |
| 88 |
.br |
| 89 |
How to create the logfile? |
| 90 |
.TP |
| 91 |
\- put the line |
| 92 |
.br |
| 93 |
"option dump 2" into your |
| 94 |
.I microtek2.conf |
| 95 |
file or change the existing "option dump" to "2" |
| 96 |
.TP |
| 97 |
\- in a terminal (bash) type |
| 98 |
.br |
| 99 |
"export SANE_DEBUG_MICROTEK2=30" and then |
| 100 |
.br |
| 101 |
"scanimage \-l0 \-t0 \-x100 \-y20 2>scan.log >sout.pnm" |
| 102 |
.br |
| 103 |
You get two files: scan.log contains the logfile and sout.pnm the scanned |
| 104 |
image (if there was scanned something). Zip them before sending. |
| 105 |
|
| 106 |
.SH "FRONTEND OPTIONS" |
| 107 |
This backend dynamically enables the options for the frontend, that are |
| 108 |
supported by the scanner in dependence of the scanning-mode and other |
| 109 |
options. |
| 110 |
Not supported options are disabled. |
| 111 |
.PP |
| 112 |
The following options are supported by the |
| 113 |
.B sane\-microtek2 |
| 114 |
driver: |
| 115 |
.PP |
| 116 |
Color, grayscale, halftone and lineart scans. |
| 117 |
.PP |
| 118 |
Highlight, midtone, shadow, contrast, brightness, exposure time control, |
| 119 |
gamma correction, threshold (dependent of the scan mode and the scanner |
| 120 |
capabilities) |
| 121 |
.PP |
| 122 |
Transparency media adapter, automatic document feeder |
| 123 |
.PP |
| 124 |
Additional options can be enabled or disabled in the |
| 125 |
.I microtek2.conf |
| 126 |
file. See the configuration section of this manpage. |
| 127 |
|
| 128 |
.SH "DEVICE NAMES" |
| 129 |
This backend expects device names of the form: |
| 130 |
.PP |
| 131 |
.RS |
| 132 |
.I special |
| 133 |
.RE |
| 134 |
.PP |
| 135 |
Where |
| 136 |
.I special |
| 137 |
is the UNIX path-name for the special device that corresponds to the |
| 138 |
scanner. The special device name must be a generic SCSI device or a |
| 139 |
symlink to such a device. Under Linux, such a device name could be |
| 140 |
.I /dev/sga |
| 141 |
or |
| 142 |
.I /dev/sge |
| 143 |
for example. |
| 144 |
.SH "CONFIGURATION" |
| 145 |
The configuration file for this backend resides in |
| 146 |
.IR /etc/sane.d/microtek2.conf . |
| 147 |
|
| 148 |
Its contents is a list of device names that correspond to Microtek |
| 149 |
scanners with SCSI-2 interface. Empty lines and lines starting with |
| 150 |
a hash mark (#) are ignored. |
| 151 |
.PP |
| 152 |
The configuration file may also contain options. Global options that are valid |
| 153 |
for all devices are placed above the device names. Device-specific options |
| 154 |
are |
| 155 |
placed under the device name. Note that, except for option dump <n> and |
| 156 |
option strip-height <n>, the entry in the |
| 157 |
.I microtek2.conf |
| 158 |
file only enables |
| 159 |
the corresponding option for being showed in the frontend. There, in the |
| 160 |
frontend, you can switch the options on and off. |
| 161 |
Currently the following options are supported: |
| 162 |
.PP |
| 163 |
.RS |
| 164 |
option dump <n> |
| 165 |
.br |
| 166 |
option strip\-height <n> |
| 167 |
.br |
| 168 |
option no\-backtrack\-option <on/off> |
| 169 |
.br |
| 170 |
option lightlid\-35 <on/off> |
| 171 |
.br |
| 172 |
option toggle\-lamp <on/off> |
| 173 |
.br |
| 174 |
option lineart\-autoadjust <on/off> |
| 175 |
.br |
| 176 |
option backend\-calibration <on/off> |
| 177 |
.br |
| 178 |
option colorbalance\-adjust <on/off> |
| 179 |
.RE |
| 180 |
.PP |
| 181 |
.I option dump <n> |
| 182 |
enables printing of additional information about the SCSI commands that are |
| 183 |
sent to the scanner to stderr. This option is primarily useful for debugging |
| 184 |
purpose. This option has to be a global option and is best placed at the top |
| 185 |
of the |
| 186 |
.I microtek2.conf |
| 187 |
file. |
| 188 |
.PP |
| 189 |
If n=1 the contents of the command blocks |
| 190 |
and the results for the INQUIRY and READ SCANNER ATTRIBUTES command are |
| 191 |
printed to stderr. |
| 192 |
.PP |
| 193 |
If n=2 the contents of the command blocks for all other SCSI commands are |
| 194 |
printed to stderr, too. If n=3 the contents of the gamma table is |
| 195 |
printed, too. If n=4 all scan data is additionally printed to stderr. |
| 196 |
.PP |
| 197 |
The default is n=1. |
| 198 |
.PP |
| 199 |
.I option strip\-height <n> |
| 200 |
, where <n> is a floating point number, limits the amount of data that is |
| 201 |
read from the scanner with one read command. |
| 202 |
The unit is inch and <n> defaults to 1.0, if this option is not set in the |
| 203 |
configuration file. If less than <n> inch of data fit into the SCSI buffer, |
| 204 |
then the smaller value is used and this option has no effect. |
| 205 |
.PP |
| 206 |
If your system has a big SCSI buffer and you want to make use of the whole |
| 207 |
buffer, increase the value for <n>. For example, if <n> is set to 14.0, |
| 208 |
no restrictions apply for scanners with a letter, legal or A4 sized scan area. |
| 209 |
.PP |
| 210 |
.PP |
| 211 |
The following options enable or disable additional frontend options. If an |
| 212 |
option is set to <on> an appropriate option will appear in the frontend. |
| 213 |
.PP |
| 214 |
.I option no\-backtrack\-option <on/off> |
| 215 |
prevents the scanner head from moving backwards between the read commands. |
| 216 |
This speeds up scanning. Try it. |
| 217 |
.PP |
| 218 |
.I option lightlid\-35 <on/off> |
| 219 |
If you use the LightLid-35 transparency adapter you get an advanced |
| 220 |
option which switches off the flatbed lamp during the scan. |
| 221 |
.PP |
| 222 |
.I option toggle\-lamp <on/off> |
| 223 |
You get a button in the frontend where you can switch on and off the flatbed |
| 224 |
lamp. |
| 225 |
.PP |
| 226 |
.I option lineart\-autoadjust <on/off> |
| 227 |
You can tell the backend to try to determine a good value for the lineart |
| 228 |
threshold. |
| 229 |
.PP |
| 230 |
.I option backend\-calibration <on/off> |
| 231 |
Some scanners (e.g. Phantom 330CX and 636CX) need to have calibrated the data |
| 232 |
by the backend. Try this option if you see vertical stripes in your pictures. |
| 233 |
.PP |
| 234 |
.I option colorbalance\-adjust <on/off> |
| 235 |
Some scanners (e.g. Phantom 330CX and 636CX) need to have corrected |
| 236 |
the color balance. If this option is enabled you get advanced options |
| 237 |
where you can balance the colors. And you will have a button |
| 238 |
to use the values that the firmware of the scanner provides. |
| 239 |
.PP |
| 240 |
A sample configuration file is shown below: |
| 241 |
.PP |
| 242 |
.RS |
| 243 |
option dump 1 |
| 244 |
.br |
| 245 |
option strip\-height 1.0 |
| 246 |
.br |
| 247 |
/dev/scanner |
| 248 |
.br |
| 249 |
option no\-backtrack\-option on |
| 250 |
.br |
| 251 |
# this is a comment |
| 252 |
.br |
| 253 |
/dev/sge |
| 254 |
.br |
| 255 |
option lightlid\-35 on |
| 256 |
.RE |
| 257 |
|
| 258 |
This backend also supports the new configuration file format which makes |
| 259 |
it easier to detect scanners under Linux. If you have only one scanner it |
| 260 |
would be best to use the following configuration file for this backend: |
| 261 |
.PP |
| 262 |
.RS |
| 263 |
option dump 1 |
| 264 |
.br |
| 265 |
option strip\-height 14.0 |
| 266 |
.br |
| 267 |
option no\-backtrack\-option on |
| 268 |
.br |
| 269 |
option backend\-calibration on |
| 270 |
.br |
| 271 |
option lightlid\-35 on |
| 272 |
.br |
| 273 |
option toggle\-lamp on |
| 274 |
.br |
| 275 |
option lineart\-autoadjust on |
| 276 |
.br |
| 277 |
option colorbalance\-adjust off |
| 278 |
.br |
| 279 |
scsi * * Scanner |
| 280 |
.RE |
| 281 |
|
| 282 |
In this case all SCSI-Scanners should be detected automatically because of the |
| 283 |
.PP |
| 284 |
scsi * * Scanner |
| 285 |
.PP |
| 286 |
line. |
| 287 |
|
| 288 |
.SH "FILES" |
| 289 |
.TP |
| 290 |
.I /etc/sane.d/microtek2.conf |
| 291 |
The backend configuration file. |
| 292 |
.TP |
| 293 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-microtek2.a |
| 294 |
The static library implementing this backend. |
| 295 |
.TP |
| 296 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-microtek2.so |
| 297 |
The shared library implementing this backend (present on systems that |
| 298 |
support dynamic loading). |
| 299 |
.SH "ENVIRONMENT" |
| 300 |
.TP |
| 301 |
.B SANE_DEBUG_MICROTEK2 |
| 302 |
If the library was compiled with debug support enabled, this |
| 303 |
environment variable controls the debug level for this backend. E.g., |
| 304 |
a value of 255 requests all debug output to be printed. Smaller |
| 305 |
levels reduce verbosity. To see error messages on stderr set |
| 306 |
.B SANE_DEBUG_MICROTEK2 |
| 307 |
to 1 (Remark: The whole debugging levels should be better revised). |
| 308 |
.br |
| 309 |
E.g. just say: |
| 310 |
.br |
| 311 |
export SANE_DEBUG_MICROTEK2=128 |
| 312 |
|
| 313 |
.SH "SEE ALSO" |
| 314 |
.BR sane\-scsi(5) , |
| 315 |
.BR sane (7) |
| 316 |
|
| 317 |
.SH "AUTHORS" |
| 318 |
Bernd Schroeder (not active anymore) |
| 319 |
.br |
| 320 |
Karsten Festag |
| 321 |
.RI < [email protected] >. |