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