2009-05-03 21:14:31 +00:00
|
|
|
|
<HTML>
|
|
|
|
|
|
<HEAD>
|
|
|
|
|
|
<TITLE>sane-canon_dr.5</TITLE>
|
|
|
|
|
|
</HEAD>
|
|
|
|
|
|
<BODY BGCOLOR=#FFFFFF TEXT=#000000><H1 ALIGN=CENTER><IMG SRC="/images/sane.png" HEIGHT=117 WIDTH=346></H1>
|
|
|
|
|
|
<H1>sane-canon_dr.5</H1>
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
<PRE>
|
|
|
|
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
|
|
|
|
|
<B><A HREF="sane-canon_dr.5.html">sane-canon_dr(5)</A></B> SANE Scanner Access Now Easy <B><A HREF="sane-canon_dr.5.html">sane-canon_dr(5)</A></B>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>NAME</H2><PRE>
|
|
|
|
|
|
sane-canon_dr - SANE backend for Canon DR-series scanners
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
|
|
|
|
The <B>sane-canon_dr</B> library implements a SANE (Scanner Access Now Easy)
|
|
|
|
|
|
backend which provides access to some Canon DR-series scanners.
|
|
|
|
|
|
|
2015-10-05 00:49:03 +00:00
|
|
|
|
This document describes backend version 51, which shipped with SANE
|
|
|
|
|
|
1.0.25.
|
2009-05-03 21:14:31 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>SUPPORTED HARDWARE</H2><PRE>
|
|
|
|
|
|
This version has only been tested with a few scanner models. Please see
|
2010-04-26 02:18:46 +00:00
|
|
|
|
http://www.sane-project.org/sane-supported-devices.html for the most
|
2009-05-03 21:14:31 +00:00
|
|
|
|
recent list.
|
|
|
|
|
|
|
2012-08-27 01:52:45 +00:00
|
|
|
|
This backend may support other Canon scanners. The best way to deter‐
|
2009-05-03 21:14:31 +00:00
|
|
|
|
mine 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 with test results.
|
|
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
In general, the larger machines (DR-4000 and up) which have been tested
|
|
|
|
|
|
use a fairly complete protocol, with hardware support for many modes,
|
|
|
|
|
|
resolutions and features. The smaller machines have many limitations,
|
2012-08-27 01:52:45 +00:00
|
|
|
|
like missing horizontal resolutions, missing binary mode, always scan‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
ning full-width, etc. There is code in the backend to address these
|
|
|
|
|
|
problems, but there seems to be no way to detect if they are required,
|
|
|
|
|
|
so they must be hard-coded.
|
|
|
|
|
|
|
2009-05-03 21:14:31 +00:00
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>OPTIONS</H2><PRE>
|
|
|
|
|
|
Effort has been made to expose most hardware options, including:
|
|
|
|
|
|
|
|
|
|
|
|
source s
|
|
|
|
|
|
Selects the source for the scan. Options may include "Flatbed",
|
|
|
|
|
|
"ADF Front", "ADF Back", "ADF Duplex".
|
|
|
|
|
|
|
|
|
|
|
|
mode m
|
|
|
|
|
|
Selects the mode for the scan. Options may include "Lineart",
|
|
|
|
|
|
"Halftone", "Gray", and "Color".
|
|
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
resolution
|
|
|
|
|
|
Controls scan resolution.
|
2009-05-03 21:14:31 +00:00
|
|
|
|
|
|
|
|
|
|
tl-x, tl-y, br-x, br-y
|
|
|
|
|
|
Sets scan area upper left and lower right coordinates. These are
|
|
|
|
|
|
renamed t, l, x, y by some frontends.
|
|
|
|
|
|
|
|
|
|
|
|
page-width, page-height
|
|
|
|
|
|
Sets paper size. Used by scanner to determine centering of scan
|
|
|
|
|
|
coordinates when using ADF and to detect double feed errors.
|
|
|
|
|
|
|
2012-08-27 01:52:45 +00:00
|
|
|
|
Other options will be available based on the capabilities of the scan‐
|
2009-05-03 21:14:31 +00:00
|
|
|
|
ner: enhancement, compression, buttons and sensors, etc.
|
|
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Additionally, several 'software' options are exposed by the backend.
|
|
|
|
|
|
These are reimplementations of features provided natively by larger
|
|
|
|
|
|
scanners, but running on the host computer. This enables smaller
|
2012-08-27 01:52:45 +00:00
|
|
|
|
machines to have similar capabilities. Please note that these features
|
2010-04-26 02:18:46 +00:00
|
|
|
|
are somewhat simplistic, and may not perform as well as the native
|
|
|
|
|
|
implementations. Note also that these features all require that the
|
|
|
|
|
|
driver cache the entire image in memory. This will almost certainly
|
|
|
|
|
|
result in a reduction of scanning speed.
|
|
|
|
|
|
|
|
|
|
|
|
swcrop
|
|
|
|
|
|
Requests the driver to detect the extremities of the paper
|
|
|
|
|
|
within the larger image, and crop the empty edges.
|
|
|
|
|
|
|
|
|
|
|
|
swdeskew
|
|
|
|
|
|
Requests the driver to detect the rotation of the paper within
|
|
|
|
|
|
the larger image, and counter the rotation.
|
|
|
|
|
|
|
|
|
|
|
|
swdespeck X
|
|
|
|
|
|
Requests the driver to find and remove dots of X diameter or
|
2012-08-27 01:52:45 +00:00
|
|
|
|
smaller from the image, and fill the space with the average sur‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
rounding color.
|
|
|
|
|
|
|
|
|
|
|
|
Use 'scanimage --help' to get a list, but be aware that some options
|
|
|
|
|
|
may be settable only when another option has been set, and that
|
2009-05-03 21:14:31 +00:00
|
|
|
|
advanced options may be hidden by some frontend programs.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>CONFIGURATION FILE</H2><PRE>
|
2010-04-26 02:18:46 +00:00
|
|
|
|
The configuration file "canon_dr.conf" is used to tell the backend how
|
|
|
|
|
|
to look for scanners, and provide options controlling the operation of
|
2009-05-03 21:14:31 +00:00
|
|
|
|
the backend. 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 fail to run.
|
|
|
|
|
|
|
|
|
|
|
|
Scanners can be specified in the configuration file in 4 ways:
|
|
|
|
|
|
|
|
|
|
|
|
"scsi CANON DR"
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Requests backend to search all scsi busses in the system for a
|
|
|
|
|
|
device which reports itself to be a scanner made by 'CANON',
|
2009-05-03 21:14:31 +00:00
|
|
|
|
with a model name starting with 'DR'.
|
|
|
|
|
|
|
|
|
|
|
|
"scsi /dev/sg0" (or other scsi device file)
|
2010-04-26 02:18:46 +00:00
|
|
|
|
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
|
2009-05-03 21:14:31 +00:00
|
|
|
|
other "scsi" line above.
|
|
|
|
|
|
|
|
|
|
|
|
"usb 0x04a9 0x1603" (or other vendor/product ids)
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Requests backend to search all usb busses in the system for a
|
|
|
|
|
|
device which uses that vendor and product id. The device will
|
2009-05-03 21:14:31 +00:00
|
|
|
|
then be queried to determine if it is a Canon scanner.
|
|
|
|
|
|
|
|
|
|
|
|
"usb /dev/usb/scanner0" (or other device file)
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Some systems use a kernel driver to access usb scanners. This
|
2009-05-03 21:14:31 +00:00
|
|
|
|
method is untested.
|
|
|
|
|
|
|
|
|
|
|
|
Besides the 'scsi' and 'usb' lines, the configuration file supports the
|
|
|
|
|
|
following 'option' lines:
|
|
|
|
|
|
|
|
|
|
|
|
"option buffer-size [number of bytes]"
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Set the number of bytes in the data buffer to something other
|
|
|
|
|
|
than the compiled-in default of 4MB. Large values may cause
|
2009-05-03 21:14:31 +00:00
|
|
|
|
timeouts or hangs, small values may cause slow scans.
|
|
|
|
|
|
|
2010-04-26 02:18:46 +00:00
|
|
|
|
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
|
2009-05-03 21:14:31 +00:00
|
|
|
|
your scsi card driver. You have been warned.
|
|
|
|
|
|
|
|
|
|
|
|
"option vendor-name [string of text]"
|
|
|
|
|
|
"option model-name [string of text]"
|
|
|
|
|
|
"option version-name [string of text]"
|
2010-04-26 02:18:46 +00:00
|
|
|
|
These options can be used collectively to override the values
|
2012-08-27 01:52:45 +00:00
|
|
|
|
provided by the scanner, or to provide the values when the scan‐
|
2009-05-03 21:14:31 +00:00
|
|
|
|
ner cannot.
|
|
|
|
|
|
|
|
|
|
|
|
"option padded-read [0|1]"
|
2010-04-26 02:18:46 +00:00
|
|
|
|
Some scanners prepend all data transmitted to host with 12
|
|
|
|
|
|
bytes. Enable this option if the scanner fails to respond to
|
2009-05-03 21:14:31 +00:00
|
|
|
|
commands.
|
|
|
|
|
|
|
2013-10-01 02:17:11 +00:00
|
|
|
|
"option duplex-offset [integer]"
|
|
|
|
|
|
Some scanners pad the upper edge of one side of a duplex scan.
|
|
|
|
|
|
There is some variation in the amount of padding. Modify this
|
|
|
|
|
|
option if your unit shows an unwanted band of image data on only
|
|
|
|
|
|
one side.
|
|
|
|
|
|
|
|
|
|
|
|
Note: 'option' lines may appear multiple times in the configuration
|
|
|
|
|
|
file. They only apply to scanners discovered by the next 'scsi/usb'
|
2009-05-03 21:14:31 +00:00
|
|
|
|
line.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>ENVIRONMENT</H2><PRE>
|
2013-10-01 02:17:11 +00:00
|
|
|
|
The backend uses a single environment variable, SANE_DEBUG_CANON_DR,
|
2009-05-03 21:14:31 +00:00
|
|
|
|
which enables debugging output to stderr. Valid values are:
|
|
|
|
|
|
|
|
|
|
|
|
5 Errors
|
|
|
|
|
|
10 Function trace
|
|
|
|
|
|
15 Function detail
|
|
|
|
|
|
20 Option commands
|
|
|
|
|
|
25 SCSI/USB trace
|
|
|
|
|
|
30 SCSI/USB detail
|
|
|
|
|
|
35 Useless noise
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>KNOWN ISSUES</H2><PRE>
|
2013-10-01 02:17:11 +00:00
|
|
|
|
This backend was entirely reverse engineered from usb traces of the
|
|
|
|
|
|
proprietary driver. Various advanced features of the machines may not
|
|
|
|
|
|
be enabled. Many machines have not been tested. Their protocol is
|
2009-05-03 21:14:31 +00:00
|
|
|
|
unknown.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>CREDITS</H2><PRE>
|
2010-04-26 02:18:46 +00:00
|
|
|
|
The various authors of the sane-fujitsu backend provided useful code
|
2012-08-27 01:52:45 +00:00
|
|
|
|
Yabarana Corp. www.yabarana.com provided significant funding
|
2009-05-03 21:14:31 +00:00
|
|
|
|
EvriChart, Inc. www.evrichart.com provided funding and loaned equipment
|
|
|
|
|
|
Canon, USA. www.usa.canon.com loaned equipment
|
2010-04-26 02:18:46 +00:00
|
|
|
|
HPrint hprint.com.br provided funding and testing for DR-2510 support
|
2012-08-27 01:52:45 +00:00
|
|
|
|
Stone-IT www.stone-it.com provided funding for DR-2010 and DR-2050 sup‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
port
|
2013-10-01 02:17:11 +00:00
|
|
|
|
Gerhard Pfeffer provided access and testing for P-208 and P-215
|
|
|
|
|
|
Special thanks to: Alejandro Imass, Andre Shimakawa, Martijn van Brum‐
|
2010-04-26 02:18:46 +00:00
|
|
|
|
melen, Thanos Diacakis and Junren Shi for testing and feedback.
|
2009-05-03 21:14:31 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
|
|
|
|
|
<B><A HREF="sane.7.html">sane(7)</A></B>, <B><A HREF="sane-scsi.5.html">sane-scsi(5)</A></B>, <B><A HREF="sane-usb.5.html">sane-usb(5)</A></B>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
|
<H2>AUTHOR</H2><PRE>
|
|
|
|
|
|
m. allan noah: <kitno455 a t gmail d o t com>
|
|
|
|
|
|
|
2015-10-05 00:49:03 +00:00
|
|
|
|
31 Aug 2015 <B><A HREF="sane-canon_dr.5.html">sane-canon_dr(5)</A></B>
|
2009-05-03 21:14:31 +00:00
|
|
|
|
</PRE>
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
<ADDRESS>
|
|
|
|
|
|
Man(1) output converted with
|
|
|
|
|
|
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
|
|
|
|
|
</ADDRESS>
|
|
|
|
|
|
</BODY>
|
|
|
|
|
|
</HTML>
|
