Debian Codegraph @

upstream/debian-unstable/man5/sane-canon_dr.5

raw
1 .TH sane\-canon_dr 5 "13 Feb 2021" "" "SANE Scanner Access Now Easy"
2 .IX sane\-canon_dr
3
4 .SH NAME
5 sane\-canon_dr \- SANE backend for Canon DR-series scanners
6
7 .SH DESCRIPTION
8 The
9 .B sane\-canon_dr
10 library implements a SANE (Scanner Access Now Easy) backend which
11 provides access to some Canon DR-series scanners.
12
13 This document describes backend version 60, which shipped with SANE 1.0.32.
14
15 .SH SUPPORTED HARDWARE
16 This version has only been tested with a few scanner models. Please see
17 .I http://www.sane\-project.org/sane\-supported\-devices.html
18 for the most recent list.
19
20 This backend may support other Canon scanners. The best
21 way to determine level of support is to test the scanner directly,
22 or to collect a trace of the windows driver in action.
23 Please contact the author for help or with test results.
24
25 In general, the larger machines (DR-4000 and up) which have been tested use
26 a fairly complete protocol, with hardware support for many modes, resolutions
27 and features. The smaller machines have many limitations, like missing
28 horizontal resolutions, missing binary mode, always scanning full-width, etc.
29 There is code in the backend to address these problems, but there seems to be
30 no way to detect if they are required, so they must be hard-coded.
31
32 .SH OPTIONS
33 Effort has been made to expose most hardware options, including:
34 .TP
35 .B \-\-source Flatbed|ADF Front|ADF Back|ADF Duplex
36 Selects the source for the scan.
37
38 .TP
39 .B \-\-mode Lineart|Halftone|Gray|Color
40 Selects the mode for the scan.
41
42 .TP
43 .B \-\-resolution
44 Controls scan resolution.
45
46 .TP
47 .B \-\-tl\-x, \-\-tl\-y, \-\-br\-x, \-\-br\-y
48 Sets scan area upper left and lower right coordinates. These are renamed
49 .BR -t ,
50 .BR -l ,
51 .BR -x ,
52 .B -y
53 by some frontends.
54
55 .TP
56 .B \-\-page\-width, \-\-page\-height
57 Sets paper size. Used by scanner to determine centering of scan
58 coordinates when using the ADF (Automatic Document Feeder) and
59 to detect double feed errors.
60
61 .PP
62 Other options will be available based on the capabilities of the scanner:
63 enhancement, compression, buttons and sensors, etc.
64 .PP
65 Additionally, several 'software' options are exposed by the backend. These
66 are reimplementations of features provided natively by larger scanners, but
67 running on the host computer. This enables smaller machines to have similar
68 capabilities. Please note that these features are somewhat simplistic, and
69 may not perform as well as the native implementations. Note also that these
70 features all require that the driver cache the entire image in memory. This
71 will almost certainly result in a reduction of scanning speed.
72
73 .TP
74 .B \-\-swcrop
75 Requests the driver to detect the extremities of the paper within the larger
76 image, and crop the empty edges.
77
78 .TP
79 .B \-\-swdeskew
80 Requests the driver to detect the rotation of the paper within the larger
81 image, and counter the rotation.
82
83 .TP
84 .B \-\-swdespeck X
85 Requests the driver to find and remove dots of X diameter or smaller from the
86 image, and fill the space with the average surrounding color.
87
88 Use 'scanimage \-\-help' to get a list, but be aware that some options may
89 be settable only when another option has been set, and that advanced options
90 may be hidden by some frontend programs.
91
92 .SH CONFIGURATION FILE
93 The configuration file
94 .I canon_dr.conf
95 is used to tell the backend how to look for scanners, and provide options
96 controlling the operation of the backend. This file is read each time the
97 frontend asks the backend for a list of scanners, generally only when the
98 frontend starts. If the configuration file is missing, the backend will
99 fail to run.
100 .PP
101 Scanners can be specified in the configuration file in 4 ways:
102 .PP
103 "scsi CANON DR"
104 .RS
105 Requests backend to search all scsi buses in the system for a device
106 which reports itself to be a scanner made by 'CANON', with a model name
107 starting with 'DR'.
108 .RE
109 .PP
110 "scsi /dev/sg0" (or other scsi device file)
111 .RS
112 Requests backend to open the named scsi device. Only useful if you have
113 multiple compatible scanners connected to your system, and need to
114 specify one. Probably should not be used with the other "scsi" line above.
115 .RE
116 .PP
117 "usb 0x04a9 0x1603" (or other vendor/product ids)
118 .RS
119 Requests backend to search all usb buses in the system for a device
120 which uses that vendor and product id. The device will then be queried
121 to determine if it is a Canon scanner.
122 .RE
123 .PP
124 "usb /dev/usb/scanner0" (or other device file)
125 .RS
126 Some systems use a kernel driver to access usb scanners. This method is untested.
127 .RE
128 .PP
129 Besides the 'scsi' and 'usb' lines, the configuration file supports the
130 following 'option' lines:
131 .PP
132 "option buffer-size [number of bytes]"
133 .RS
134 Set the number of bytes in the data buffer to something other than the
135 compiled\-in default of 4MB. Large values may cause timeouts or hangs, small
136 values may cause slow scans.
137 .PP
138 Note: The backend does not place an upper bound on this value, as some users
139 required it to be quite large. Values above the default are not recommended,
140 and may crash your OS or lockup your scsi card driver. You have been
141 warned.
142 .RE
143 .PP
144 "option vendor-name [string of text]"
145 .br
146 "option model-name [string of text]"
147 .br
148 "option version-name [string of text]"
149 .RS
150 These options can be used collectively to override the values provided by the
151 scanner, or to provide the values when the scanner cannot.
152 .RE
153 .PP
154 "option padded-read [0|1]"
155 .RS
156 Some scanners prepend all data transmitted to host with 12 bytes. Enable this option if the scanner fails to respond to commands.
157 .RE
158 .PP
159 "option duplex-offset [integer]"
160 .RS
161 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.
162 .RE
163 .PP
164 .BR NOTE :
165 "option" lines may appear multiple times in the configuration file.
166 They only apply to scanners discovered by the next 'scsi/usb' line.
167 .PP
168
169 .SH ENVIRONMENT
170 The backend uses a single environment variable,
171 .BR SANE_DEBUG_CANON_DR ,
172 which enables debugging output to stderr. Valid values are:
173 .PP
174 .RS
175 5 Errors
176 .br
177 10 Function trace
178 .br
179 15 Function detail
180 .br
181 20 Option commands
182 .br
183 25 SCSI/USB trace
184 .br
185 30 SCSI/USB detail
186 .br
187 35 Useless noise
188 .RE
189
190 .SH KNOWN ISSUES
191 This backend was entirely reverse engineered from usb traces of the proprietary
192 driver. Various advanced features of the machines may not be enabled. Many
193 machines have not been tested. Their protocol is unknown.
194
195 .SH CREDITS
196
197 The various authors of the
198 .BR sane\-fujitsu (5)
199 backend provided useful code.
200 .br
201 Yabarana Corp.
202 .I www.yabarana.com
203 provided significant funding.
204 .br
205 EvriChart, Inc.
206 .I www.evrichart.com
207 provided funding and loaned equipment.
208 .br
209 Canon, USA.
210 .I www.usa.canon.com
211 loaned equipment.
212 .br
213 HPrint
214 .I hprint.com.br
215 provided funding and testing for DR-2510 support.
216 .br
217 Stone-IT
218 .I www.stone-it.com
219 provided funding for DR-2010 and DR-2050 support.
220 .br
221 Gerhard Pfeffer provided access and testing for P-208 and P-215.
222 .br
223 Special thanks to: Alejandro Imass, Andre Shimakawa, Martijn van Brummelen, Thanos Diacakis and Junren Shi for testing and feedback.
224
225 .SH "SEE ALSO"
226 .BR sane (7),
227 .BR sane\-scsi (5),
228 .BR sane\-usb(5)
229
230 .SH AUTHOR
231 m. allan noah:
232 .IR "<kitno455 a t gmail d o t com>" .