sane-kodak(5)

💖 sane-kodak 💖

okay bestie, gather round, because we're talking about sane-kodak — the SANE backend for big Kodak flatbed and ADF scanners. yes it's a section 5 manpage, yes it's real, yes it's giving main character energy for your giant office scanner. let's get into it 🎀

---

✨ NAME ✨

sane-kodak — the SANE backend for big Kodak flatbed and ADF scanners 🦋

---

🌸 DESCRIPTION 🌸

so, the sane-kodak library implements a SANE (Scanner Access Now Easy) backend, and it gives you access to large Kodak flatbed and ADF scanners. periodt 💅

this doc describes backend version 7, which shipped with SANE 1.0.21. iykyk.

---

👑 SUPPORTED HARDWARE 👑

this version should support models that speak the Kodak SCSI and Firewire protocols. the i1860 was the one used to develop the backend, but other models may work with only minimal modifications. for an updated list, please see:

http://www.sane-project.org/sane-supported-devices.html

if you've got a machine that's not on that list, or it's reported as 'untested': the best way to figure out your level of support is to just test the scanner directly, or collect a trace of the windows driver doing its thing. please contact the author for help or to drop your test results 🫶

---

💀 UNSUPPORTED HARDWARE 💀

ngl, most of the recent Kodak consumer or workgroup level machines are built on other chipsets and are not supported by this backend. some of these scanners may be supported by another backend though, so don't fully spiral 🌈

---

✨ OPTIONS ✨

effort has been made to expose the basic hardware options, including:

• --source s — picks the source for the scan. options may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex".
• --mode m — picks the mode for the scan. options may include "Lineart", "Halftone", "Gray", and "Color".
• --resolution — controls scan resolution. the available choices may be limited by mode, so don't be surprised bestie.
• --tl-x, --tl-y, --br-x, --br-y — sets the scan area upper left and lower right coordinates. these get renamed to -t, -l, -x, -y by some frontends.
• --page-width, --page-height — sets paper size. the scanner uses this to determine centering of scan coordinates when using the ADF (Automatic Document Feeder) and to detect double feed errors.

other options will be available based on the capabilities of the scanner. use scanimage --help to get a list, but be aware that some options may be settable only when another option has already been set, and that advanced options may be hidden by some frontend programs. 🙈

---

🎀 CONFIGURATION FILE 🎀

the configuration file kodak.conf is what tells the backend how to look for scanners, and provides options controlling how the backend operates. this file is read each time the frontend asks the backend for a list 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. no cap.

scanners can be specified in the configuration file in 2 ways:

• "scsi KODAK" — asks the backend to search all scsi buses in the system for a device which reports itself to be a scanner made by 'KODAK'.
• "scsi /dev/sg0" (or other scsi device file) — asks the 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.

the only configuration option supported is "buffer-size=xxx", which lets you set the number of bytes in the data buffer to something other than the 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. 😭

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.

Note: the backend does not place an upper bound on this value, because 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. 💀

---

🦋 ENVIRONMENT 🦋

the backend uses a single environment variable, SANE_DEBUG_KODAK, which enables debugging output to stderr. valid values are:

5  Errors
10 Function trace
15 Function detail
20 Option commands
25 SCSI trace
30 SCSI detail
35 Useless noise

---

🙈 KNOWN ISSUES 🙈

most hardware options are either not supported or not exposed for control by the user, including: multifeed detection, image compression, autocropping, endorser, thresholding, multi-stream, etc. yeah. it's giving minimal, bestie 🫠

---

🌟 CREDITS 🌟

the various authors of the sane-fujitsu(5) backend provided useful code. Kodak provided access to hardware, documentation and personnel. iconic behaviour fr fr 🫶

---

🌈 SEE ALSO 🌈

sane(7), sane-scsi(5), scanimage(1)

---

💜 AUTHOR 💜

m. allan noah: <kitno455 a t gmail d o t com>

---

okay that's the whole thing, and yes it's dated 10 Feb 2010 and yes it's from the sane-kodak(5) page, so go forth and scan something huge. slay 💅✨