2010-02-11 03:38:37 +00:00
|
|
|
.TH sane\-kodak 5 "10 Feb 2010" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
|
2009-06-23 03:06:22 +00:00
|
|
|
.IX sane\-kodak
|
|
|
|
|
|
|
|
|
|
.SH NAME
|
|
|
|
|
sane\-kodak \- SANE backend for big Kodak flatbed and ADF scanners
|
|
|
|
|
|
|
|
|
|
.SH DESCRIPTION
|
2017-05-27 05:27:22 +00:00
|
|
|
The
|
2009-06-23 03:06:22 +00:00
|
|
|
.B sane\-kodak
|
|
|
|
|
library implements a SANE (Scanner Access Now Easy) backend which
|
|
|
|
|
provides access to large Kodak flatbed and ADF scanners.
|
|
|
|
|
|
2010-02-11 03:38:37 +00:00
|
|
|
This document describes backend version 7, which shipped with SANE 1.0.21.
|
2009-06-23 03:06:22 +00:00
|
|
|
|
|
|
|
|
.SH SUPPORTED HARDWARE
|
2017-05-27 05:27:22 +00:00
|
|
|
This version should support models which speak the Kodak SCSI and Firewire
|
|
|
|
|
protocols. The i1860 was used to develop the backend, but other models may
|
|
|
|
|
work with only minimal modifications. Please see the list at
|
2021-02-02 20:58:54 +00:00
|
|
|
.I http://www.sane\-project.org/sane\-supported\-devices.html
|
|
|
|
|
for an updated list.
|
2009-06-23 03:06:22 +00:00
|
|
|
|
2017-05-27 05:27:22 +00:00
|
|
|
If you have a machine not on that list, or reported as 'untested': the best way
|
|
|
|
|
to determine level of support is to test the scanner directly, or to collect a
|
|
|
|
|
trace of the windows driver in action. Please contact the author for help or
|
2009-06-23 03:06:22 +00:00
|
|
|
with test results.
|
|
|
|
|
|
|
|
|
|
.SH UNSUPPORTED HARDWARE
|
2017-05-27 05:27:22 +00:00
|
|
|
Most of the recent Kodak consumer or workgroup level machines are based on
|
|
|
|
|
other chipsets and are not supported by this backend. Some of these scanners
|
2009-06-23 03:06:22 +00:00
|
|
|
may be supported by another backend.
|
|
|
|
|
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
Effort has been made to expose the basic hardware options, including:
|
|
|
|
|
.PP
|
2021-02-02 20:58:54 +00:00
|
|
|
.B --source s
|
2009-06-23 03:06:22 +00:00
|
|
|
.RS
|
|
|
|
|
Selects the source for the scan. Options
|
|
|
|
|
may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex".
|
|
|
|
|
.RE
|
|
|
|
|
.PP
|
2021-02-02 20:58:54 +00:00
|
|
|
.B --mode m
|
2009-06-23 03:06:22 +00:00
|
|
|
.RS
|
|
|
|
|
Selects the mode for the scan. Options
|
|
|
|
|
may include "Lineart", "Halftone", "Gray", and "Color".
|
|
|
|
|
.RE
|
|
|
|
|
.PP
|
2021-02-02 20:58:54 +00:00
|
|
|
.B --resolution
|
2009-06-23 03:06:22 +00:00
|
|
|
.RS
|
|
|
|
|
Controls scan resolution. Available choices may be limited by mode.
|
|
|
|
|
.RE
|
|
|
|
|
.PP
|
2021-02-02 20:58:54 +00:00
|
|
|
.BR --tl\-x ", " --tl\-y ", " --br\-x ", " --br\-y
|
2009-06-23 03:06:22 +00:00
|
|
|
.RS
|
2017-05-27 05:27:22 +00:00
|
|
|
Sets scan area upper left and lower right coordinates. These are renamed
|
2021-02-02 20:58:54 +00:00
|
|
|
.BR -t ", " -l ", " -x ", " -y
|
|
|
|
|
by some frontends.
|
2009-06-23 03:06:22 +00:00
|
|
|
.RE
|
|
|
|
|
.PP
|
2021-02-02 20:58:54 +00:00
|
|
|
.BR --page\-width ", " --page\-height
|
2009-06-23 03:06:22 +00:00
|
|
|
.RS
|
|
|
|
|
Sets paper size. Used by scanner to determine centering of scan
|
2021-08-29 23:00:23 +00:00
|
|
|
coordinates when using the ADF (Automatic Document Feeder) and to
|
|
|
|
|
detect double feed errors.
|
2009-06-23 03:06:22 +00:00
|
|
|
.RE
|
|
|
|
|
.PP
|
|
|
|
|
Other options will be available based on the capabilities of the scanner.
|
2021-02-13 20:02:54 +00:00
|
|
|
Use
|
|
|
|
|
.I scanimage \-\-help
|
|
|
|
|
to get a list, but be aware that some options may
|
2017-05-27 05:27:22 +00:00
|
|
|
be settable only when another option has been set, and that advanced options
|
2009-06-23 03:06:22 +00:00
|
|
|
may be hidden by some frontend programs.
|
|
|
|
|
.PP
|
|
|
|
|
.SH CONFIGURATION FILE
|
2021-02-02 20:58:54 +00:00
|
|
|
The configuration file
|
|
|
|
|
.I kodak.conf
|
|
|
|
|
is used to tell the backend how to look
|
2009-06-23 03:06:22 +00:00
|
|
|
for scanners, and provide options controlling the operation of the backend.
|
2017-05-27 05:27:22 +00:00
|
|
|
This file is read each time the frontend asks the backend for a list
|
2009-06-23 03:06:22 +00:00
|
|
|
of scanners, generally only when the frontend starts. If the configuration
|
|
|
|
|
file is missing, the backend will use a set of compiled defaults, which
|
|
|
|
|
are identical to the default configuration file shipped with SANE.
|
|
|
|
|
.PP
|
|
|
|
|
Scanners can be specified in the configuration file in 2 ways:
|
|
|
|
|
.PP
|
|
|
|
|
"scsi KODAK"
|
|
|
|
|
.RS
|
2020-08-29 06:33:32 +00:00
|
|
|
Requests backend to search all scsi buses in the system for a device
|
2017-05-27 05:27:22 +00:00
|
|
|
which reports itself to be a scanner made by 'KODAK'.
|
2009-06-23 03:06:22 +00:00
|
|
|
.RE
|
|
|
|
|
.PP
|
|
|
|
|
"scsi /dev/sg0" (or other scsi device file)
|
|
|
|
|
.RS
|
|
|
|
|
Requests backend to open the named scsi device. Only useful if you have
|
|
|
|
|
multiple compatible scanners connected to your system, and need to
|
|
|
|
|
specify one. Probably should not be used with the other "scsi" line above.
|
|
|
|
|
.RE
|
|
|
|
|
.PP
|
|
|
|
|
The only configuration option supported is "buffer\-size=xxx", allowing you
|
2017-05-27 05:27:22 +00:00
|
|
|
to set the number of bytes in the data buffer to something other than the
|
2009-06-23 03:06:22 +00:00
|
|
|
compiled\-in default, 32768 (32K). Some users report that their scanner will
|
|
|
|
|
"hang" mid\-page, or fail to transmit the image if the buffer is not large
|
|
|
|
|
enough.
|
|
|
|
|
.PP
|
|
|
|
|
Note: This option may appear multiple times in the configuration file. It only
|
|
|
|
|
applies to scanners discovered by 'scsi/usb' lines that follow this option.
|
|
|
|
|
.PP
|
|
|
|
|
Note: The backend does not place an upper bound on this value, as some users
|
|
|
|
|
required it to be quite large. Values above the default are not recommended,
|
|
|
|
|
and may crash your OS or lockup your scsi card driver. You have been
|
|
|
|
|
warned.
|
|
|
|
|
.PP
|
|
|
|
|
|
|
|
|
|
.SH ENVIRONMENT
|
2021-02-13 20:02:54 +00:00
|
|
|
The backend uses a single environment variable,
|
|
|
|
|
.BR SANE_DEBUG_KODAK ,
|
|
|
|
|
which enables debugging output to stderr. Valid values are:
|
2009-06-23 03:06:22 +00:00
|
|
|
.PP
|
|
|
|
|
.RS
|
|
|
|
|
5 Errors
|
|
|
|
|
.br
|
|
|
|
|
10 Function trace
|
|
|
|
|
.br
|
|
|
|
|
15 Function detail
|
|
|
|
|
.br
|
|
|
|
|
20 Option commands
|
|
|
|
|
.br
|
|
|
|
|
25 SCSI trace
|
|
|
|
|
.br
|
|
|
|
|
30 SCSI detail
|
|
|
|
|
.br
|
|
|
|
|
35 Useless noise
|
|
|
|
|
.RE
|
|
|
|
|
|
|
|
|
|
.SH KNOWN ISSUES
|
2017-05-27 05:27:22 +00:00
|
|
|
Most hardware options are either not supported or not exposed for control by
|
2009-06-23 03:06:22 +00:00
|
|
|
the user, including: multifeed detection, image compression, autocropping,
|
2021-08-29 23:00:23 +00:00
|
|
|
endorser, thresholding, multi\-stream, etc.
|
2009-06-23 03:06:22 +00:00
|
|
|
.PP
|
|
|
|
|
|
|
|
|
|
.SH CREDITS
|
2021-02-02 20:58:54 +00:00
|
|
|
The various authors of the
|
|
|
|
|
.BR sane\-fujitsu (5)
|
|
|
|
|
backend provided useful code.
|
2009-06-23 03:06:22 +00:00
|
|
|
.br
|
|
|
|
|
Kodak provided access to hardware, documentation and personnel.
|
2017-05-27 05:27:22 +00:00
|
|
|
|
2009-06-23 03:06:22 +00:00
|
|
|
.SH "SEE ALSO"
|
2021-02-02 20:58:54 +00:00
|
|
|
.BR sane (7),
|
|
|
|
|
.BR sane\-scsi (5),
|
|
|
|
|
.BR scanimage (1)
|
2009-06-23 03:06:22 +00:00
|
|
|
|
|
|
|
|
.SH AUTHOR
|
2021-02-13 20:02:54 +00:00
|
|
|
m. allan noah:
|
|
|
|
|
.RI < "kitno455 a t gmail d o t com" >
|
