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 ADF and to detect double feed errors.
58
59 Other options will be available based on the capabilities of the scan‐
60 ner. Use scanimage --help to get a list, but be aware that some
61 options may be settable only when another option has been set, and that
62 advanced options may be hidden by some frontend programs.
63
65 The configuration file kodak.conf is used to tell the backend how to
66 look for scanners, and provide options controlling the operation of the
67 backend. This file is read each time the frontend asks the backend for
68 a list of scanners, generally only when the frontend starts. If the
69 configuration file is missing, the backend will use a set of compiled
70 defaults, which are identical to the default configuration file shipped
71 with SANE.
72
73 Scanners can be specified in the configuration file in 2 ways:
74
75 "scsi KODAK"
76 Requests backend to search all scsi buses in the system for a
77 device which reports itself to be a scanner made by 'KODAK'.
78
79 "scsi /dev/sg0" (or other scsi device file)
80 Requests backend to open the named scsi device. Only useful if
81 you have multiple compatible scanners connected to your system,
82 and need to specify one. Probably should not be used with the
83 other "scsi" line above.
84
85 The only configuration option supported is "buffer-size=xxx", allowing
86 you to set the number of bytes in the data buffer to something other
87 than the compiled-in default, 32768 (32K). Some users report that their
88 scanner will "hang" mid-page, or fail to transmit the image if the buf‐
89 fer is not large enough.
90
91 Note: This option may appear multiple times in the configuration file.
92 It only applies to scanners discovered by 'scsi/usb' lines that follow
93 this option.
94
95 Note: The backend does not place an upper bound on this value, as some
96 users required it to be quite large. Values above the default are not
97 recommended, and may crash your OS or lockup your scsi card driver. You
98 have been warned.
99
101 The backend uses a single environment variable, SANE_DEBUG_KODAK, which
102 enables debugging output to stderr. Valid values are:
103
104 5 Errors
105 10 Function trace
106 15 Function detail
107 20 Option commands
108 25 SCSI trace
109 30 SCSI detail
110 35 Useless noise
111
112
114 Most hardware options are either not supported or not exposed for con‐
115 trol by the user, including: multifeed detection, image compression,
116 autocropping, endorser, iThresholding, multi-stream, etc.
117
119 The various authors of the sane-fujitsu(5) backend provided useful
120 code.
121 Kodak provided access to hardware, documentation and personnel.
122
123
125 sane(7), sane-scsi(5), scanimage(1)
126
127
129 m. allan noah: <kitno455 a t gmail d o t com>
130
131
132
133 10 Feb 2010 sane-kodak(5)