| 1 |
.TH sane\-kodak 5 "10 Feb 2010" "" "SANE Scanner Access Now Easy" |
| 2 |
.IX sane\-kodak |
| 3 |
|
| 4 |
.SH NAME |
| 5 |
sane\-kodak \- SANE backend for big Kodak flatbed and ADF scanners |
| 6 |
|
| 7 |
.SH DESCRIPTION |
| 8 |
The |
| 9 |
.B sane\-kodak |
| 10 |
library implements a SANE (Scanner Access Now Easy) backend which |
| 11 |
provides access to large Kodak flatbed and ADF scanners. |
| 12 |
|
| 13 |
This document describes backend version 7, which shipped with SANE 1.0.21. |
| 14 |
|
| 15 |
.SH SUPPORTED HARDWARE |
| 16 |
This version should support models which speak the Kodak SCSI and Firewire |
| 17 |
protocols. The i1860 was used to develop the backend, but other models may |
| 18 |
work with only minimal modifications. Please see the list at |
| 19 |
.I http://www.sane\-project.org/sane\-supported\-devices.html |
| 20 |
for an updated list. |
| 21 |
|
| 22 |
If you have a machine not on that list, or reported as 'untested': the best way |
| 23 |
to determine level of support is to test the scanner directly, or to collect a |
| 24 |
trace of the windows driver in action. Please contact the author for help or |
| 25 |
with test results. |
| 26 |
|
| 27 |
.SH UNSUPPORTED HARDWARE |
| 28 |
Most of the recent Kodak consumer or workgroup level machines are based on |
| 29 |
other chipsets and are not supported by this backend. Some of these scanners |
| 30 |
may be supported by another backend. |
| 31 |
|
| 32 |
.SH OPTIONS |
| 33 |
Effort has been made to expose the basic hardware options, including: |
| 34 |
.PP |
| 35 |
.B --source s |
| 36 |
.RS |
| 37 |
Selects the source for the scan. Options |
| 38 |
may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex". |
| 39 |
.RE |
| 40 |
.PP |
| 41 |
.B --mode m |
| 42 |
.RS |
| 43 |
Selects the mode for the scan. Options |
| 44 |
may include "Lineart", "Halftone", "Gray", and "Color". |
| 45 |
.RE |
| 46 |
.PP |
| 47 |
.B --resolution |
| 48 |
.RS |
| 49 |
Controls scan resolution. Available choices may be limited by mode. |
| 50 |
.RE |
| 51 |
.PP |
| 52 |
.BR --tl\-x ", " --tl\-y ", " --br\-x ", " --br\-y |
| 53 |
.RS |
| 54 |
Sets scan area upper left and lower right coordinates. These are renamed |
| 55 |
.BR -t ", " -l ", " -x ", " -y |
| 56 |
by some frontends. |
| 57 |
.RE |
| 58 |
.PP |
| 59 |
.BR --page\-width ", " --page\-height |
| 60 |
.RS |
| 61 |
Sets paper size. Used by scanner to determine centering of scan |
| 62 |
coordinates when using the ADF (Automatic Document Feeder) and to |
| 63 |
detect double feed errors. |
| 64 |
.RE |
| 65 |
.PP |
| 66 |
Other options will be available based on the capabilities of the scanner. |
| 67 |
Use |
| 68 |
.I scanimage \-\-help |
| 69 |
to get a list, but be aware that some options may |
| 70 |
be settable only when another option has been set, and that advanced options |
| 71 |
may be hidden by some frontend programs. |
| 72 |
.PP |
| 73 |
.SH CONFIGURATION FILE |
| 74 |
The configuration file |
| 75 |
.I kodak.conf |
| 76 |
is used to tell the backend how to look |
| 77 |
for scanners, and provide options controlling the operation of the backend. |
| 78 |
This file is read each time the frontend asks the backend for a list |
| 79 |
of scanners, generally only when the frontend starts. If the configuration |
| 80 |
file is missing, the backend will use a set of compiled defaults, which |
| 81 |
are identical to the default configuration file shipped with SANE. |
| 82 |
.PP |
| 83 |
Scanners can be specified in the configuration file in 2 ways: |
| 84 |
.PP |
| 85 |
"scsi KODAK" |
| 86 |
.RS |
| 87 |
Requests backend to search all scsi buses in the system for a device |
| 88 |
which reports itself to be a scanner made by 'KODAK'. |
| 89 |
.RE |
| 90 |
.PP |
| 91 |
"scsi /dev/sg0" (or other scsi device file) |
| 92 |
.RS |
| 93 |
Requests backend to open the named scsi device. Only useful if you have |
| 94 |
multiple compatible scanners connected to your system, and need to |
| 95 |
specify one. Probably should not be used with the other "scsi" line above. |
| 96 |
.RE |
| 97 |
.PP |
| 98 |
The only configuration option supported is "buffer\-size=xxx", allowing you |
| 99 |
to set the number of bytes in the data buffer to something other than the |
| 100 |
compiled\-in default, 32768 (32K). Some users report that their scanner will |
| 101 |
"hang" mid\-page, or fail to transmit the image if the buffer is not large |
| 102 |
enough. |
| 103 |
.PP |
| 104 |
Note: This option may appear multiple times in the configuration file. It only |
| 105 |
applies to scanners discovered by 'scsi/usb' lines that follow this option. |
| 106 |
.PP |
| 107 |
Note: The backend does not place an upper bound on this value, as some users |
| 108 |
required it to be quite large. Values above the default are not recommended, |
| 109 |
and may crash your OS or lockup your scsi card driver. You have been |
| 110 |
warned. |
| 111 |
.PP |
| 112 |
|
| 113 |
.SH ENVIRONMENT |
| 114 |
The backend uses a single environment variable, |
| 115 |
.BR SANE_DEBUG_KODAK , |
| 116 |
which enables debugging output to stderr. Valid values are: |
| 117 |
.PP |
| 118 |
.RS |
| 119 |
5 Errors |
| 120 |
.br |
| 121 |
10 Function trace |
| 122 |
.br |
| 123 |
15 Function detail |
| 124 |
.br |
| 125 |
20 Option commands |
| 126 |
.br |
| 127 |
25 SCSI trace |
| 128 |
.br |
| 129 |
30 SCSI detail |
| 130 |
.br |
| 131 |
35 Useless noise |
| 132 |
.RE |
| 133 |
|
| 134 |
.SH KNOWN ISSUES |
| 135 |
Most hardware options are either not supported or not exposed for control by |
| 136 |
the user, including: multifeed detection, image compression, autocropping, |
| 137 |
endorser, thresholding, multi\-stream, etc. |
| 138 |
.PP |
| 139 |
|
| 140 |
.SH CREDITS |
| 141 |
The various authors of the |
| 142 |
.BR sane\-fujitsu (5) |
| 143 |
backend provided useful code. |
| 144 |
.br |
| 145 |
Kodak provided access to hardware, documentation and personnel. |
| 146 |
|
| 147 |
.SH "SEE ALSO" |
| 148 |
.BR sane (7), |
| 149 |
.BR sane\-scsi (5), |
| 150 |
.BR scanimage (1) |
| 151 |
|
| 152 |
.SH AUTHOR |
| 153 |
m. allan noah: |
| 154 |
.RI < "kitno455 a t gmail d o t com" > |