Debian Codegraph @

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

raw
1 .TH "sane\-pixma" "5" "15 Aug 2020" "" "SANE Scanner Access Now Easy"
2 .IX sane\-pixma
3 .SH NAME
4 sane\-pixma \- SANE backend for Canon Multi-Function Printers and CanoScan Scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-pixma
8 library implements a SANE (Scanner Access Now Easy) backend that provides
9 access to Canon PIXMA / i-SENSYS / imageCLASS / imageRUNNER multi-function
10 devices (All-in-one printers) and the Canon CanoScan Flatbed/TPU scanners.
11 The backend implements both the USB interface and network interface
12 (using Canon's BJNP and MFNP protocols). The network interface supports scanners
13 over IPv4 as well as IPv6 (MFNP over IPv6 is untested).
14 .PP
15 Currently, the following models work with this backend:
16
17
18 .PP
19 .RS
20 PIXMA E410, E510, E3600, E4500
21 .br
22 PIXMA G600, G2000, G2010, G2030, G2070, G2100, G3030, G3070
23 .br
24 PIXMA G3080, G3090, G4000, G4070, G4080, G4511
25 .br
26 PIXMA GX1000, GX2000, GX3000, GX4000, GX6000, GX6500, GX7000
27 .br
28 PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3000, MG3100
29 .br
30 PIXMA MG3200, MG3500, MG3600, MG4200, MG5100, MG5200, MG5300
31 .br
32 PIXMA MG5400, MG5500, MG5600, MG5700, MG6100, MG6200, MG6300
33 .br
34 PIXMA MG6400, MG7100, MG7500, MG7700, MG8200
35 .br
36 PIXMA MP140, MP150, MP160, MP170, MP180, MP190
37 .br
38 PIXMA MP210, MP220, MP230, MP240, MP250, MP260, MP270, MP280
39 .br
40 PIXMA MP360, MP370, MP390
41 .br
42 PIXMA MP450, MP460, MP470, MP480, MP490, MP495
43 .br
44 PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
45 .br
46 PIXMA MP600, MP600R, MP610, MP620, MP630, MP640
47 .br
48 PIXMA MP700, MP710, MP730, PIXMA MP750 (no grayscale)
49 .br
50 PIXMA MP800, MP800R, MP810, MP830
51 .br
52 PIXMA MP960, MP970, MP980, MP990
53 .br
54 PIXMA MX300, MX310, MX330, MX340, MX350, MX360, MX370
55 .br
56 PIXMA MX410, MX420, MX470, MX510, MX520, MX530, MX700, MX720
57 .br
58 PIXMA MX850, MX860, MX870, MX882, MX885, MX890, MX920, MX7600
59 .br
60 PIXMA TC-20M, TC-5200M
61 .br
62 PIXMA TR4500, TR4600, TR4700
63 .br
64 PIXMA TS2400, TS2600, TS3100, TS3300, TS3450, TS3451, TS3452
65 .br
66 PIXMA TS3500, TS3600, TS3700, TS5000, TS5100, TS5150, TS5350i
67 .br
68 PIXMA TS5400, TS6100, TS6200, TS7530, TS7450i ,TS8000, TS8200
69 .br
70 PIXMA TS8530, TS8630, TS8800
71 .br
72 PIXUS MP10
73 .br
74 imageCLASS MF634Cdw, MF733Cdw
75 .br
76 imageCLASS MF3110, MF3240, MF4010, MF4018
77 .br
78 imageCLASS MF4120, MF4122, MF4140, MF4150
79 .br
80 imageCLASS MF4270, MF4350d, MF4370dn, MF4380dn
81 .br
82 imageCLASS MF4410, MF4430, MF4570dw, MF4660, MF4690
83 .br
84 imageCLASS MF5730, MF5770, MF6550, MPC200
85 .br
86 imageCLASS D420, D480, D530, D570
87 .br
88 i-SENSYS MF210, MF230, MF240, MF440, MF620, MF630, MF640
89 .br
90 i-SENSYS MF645C, MF730, MF731/733, MF741/743
91 .br
92 i-SENSYS MF3010, MF4320d, MF4330d, MF4500, MF4700, MF4800
93 .br
94 i-SENSYS MF6100, MF8030, MF8200C, MF8300
95 .br
96 imageRUNNER 1018/1022/1023, 1020/1024/1025, 1133
97 .br
98 CanoScan 8800F, 9000F, 9000F Mark II
99 .br
100 CanoScan LiDE 300, 400
101 .br
102 MAXIFY MB2000, MB2100, MB2300, MB2700, MB5000, MB5100, MB5400
103 .RE
104 .PP
105 The following models are not well tested and/or the scanner sometimes hangs
106 and must be switched off and on.
107 .PP
108 .RS
109 PIXMA MP760, MP770, MP780, MP790
110 .RE
111 .PP
112 The following models may use the same Pixma protocol as those listed
113 above, but have not yet been reported to work (or not). They are declared
114 in the backend so that they get recognized and activated.
115 Feedback in the sane\-devel mailing list welcome.
116 .PP
117 .RS
118 PIXMA E400, E460, E470, E480, E500, E560, E600, E610
119 .br
120 PIXMA E3100, E3300, E3400, E4200
121 .br
122 PIXMA G2020, G2060, G3020, G3060, G7000, G7080
123 .br
124 PIXMA MG4100, MG6500, MG6600, MG6800, MG6900, MG8100
125 .br
126 PIXMA MP375R, MP493, MP740
127 .br
128 PIXMA MX320, MX390, MX430, MX450, MX490, MX710
129 .br
130 PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000, GM4080
131 .br
132 PIXMA TR7500, TR7530, TR7600, TR7800, TR8500, TR8530, TR8580 TR8600
133 .br
134 PIXMA TR8630, TR9530
135 .br
136 PIXMA TS3400, TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300
137 .br
138 PIXMA TS6330, TS6330, TS6380, TS6400, TS6630, TS6730, TS7330, TS7400,
139 .br
140 PIXMA TS7430, TS7600i, TS7700, TS7700A, TS7700i, TS8100, TS8130
141 .br
142 PIXMA TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS8700, TS9000
143 .br
144 PIXMA TS9100, TS9180, TS9500, TS9580
145 .br
146 PIXUS MP5, XK50, XK60, XK70, XK80, XK90, XK100, XK110, XK120, XK130
147 .br
148 PIXUS XK500
149 .br
150 imageCLASS MF720, MF810/820, MF5630, MF5650, MF5750, MF8170c
151 .br
152 imageCLASS MPC190, D550
153 .br
154 i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740, MF750
155 .br
156 i-SENSYS MF5880dn, MF5900, MF6680dn, MF8500C
157 .br
158 MAXIFY MB5300
159 .RE
160 .PP
161 The following models may use partly the same Pixma protocol as other devices
162 listed above, but may still need some work. They are declared in the backend
163 as experimental and need the environment variable PIXMA_EXPERIMENT=1 to get
164 recognized and activated. Snoop logs are required to further investigate,
165 please contact the sane\-devel mailing list.
166 .PP
167 .RS
168 \-\- none \-\-
169 .RE
170 .PP
171 The backend supports:
172 .PP
173 .RS
174 * resolutions of 75, 150, 300, 600, 1200, 2400, 4800, and 9600 DPI (some maybe buggy),
175 .br
176 * color and grayscale mode, as well as lineart on certain models,
177 .br
178 * a custom gamma table,
179 .br
180 * Automatic Document Feeder, Simplex and Duplex,
181 .br
182 * Transparency Unit, 24 or 48 bits depth. Infrared channel on certain models.
183 .RE
184 .PP
185 The device name for USB devices is in the form pixma:xxxxyyyy_zzzzz
186 where x, y and z are vendor ID, product ID and serial number respectively.
187 .PP
188 Example: pixma:04A91709_123456 is a MP150.
189 .PP
190 Device names for BJNP/MFNP devices is in the form pixma:aaaa_bbbbb
191 where aaaa is the scanners model and bbbb is the hostname or ip-adress.
192 .PP
193 Example: pixma:MF4800_192.168.1.45 is a MF4800 Series multi-function peripheral.
194 .PP
195 This backend, based on cloning original Canon drivers protocols, is in
196 a production stage. Design has been carried out without any applicable
197 manufacturer documentation, probably never available. However, we have tested
198 it as well as we could, but it may not work in all situations. You will find
199 an up-to-date status at the project homepage. (See below).
200 Users feedback is essential to help improve features and performances.
201 .SH OPTIONS
202 Besides "well-known" options (e.g. resolution, mode etc.)
203 .B sane\-pixma
204 backend also
205 provides the following options, i.e. the options might change in the future.
206 .br
207 The button status can be polled i.e. with
208 .I scanimage \-A.
209 .br
210 Button scan is disabled on MAC OS X due to darwin libusb not handling
211 timeouts in usb interrupt reads, but may work when using the network protocol.
212 .TP
213 .I adf\-wait
214 This option enables and sets the time in seconds waiting for a document
215 inserted into the
216 .BR Automatic
217 .BR Document
218 .BR Feeder .
219 The maximum allowed waiting time is 3600 sec (= 1 hour).
220 .TP
221 .I button\-controlled
222 This option can be used by applications (like
223 .BR scanadf (1)
224 and
225 .BR scanimage (1))
226 in batch mode, for example when you want to scan many photos or
227 multiple-page documents. If it is enabled (i.e. is set to true or yes), the
228 backend waits before every scan until the user presses the "SCAN" button
229 (for MP150) or the color-scan button (for other models). Just put the
230 first page in the scanner, press the button, then the next page, press
231 the button and so on. When you finished, press the gray-scan button. (For
232 MP150 you have to stop the frontend by pressing Ctrl-C for example.)
233 .TP
234 .I button\-update (deprecated)
235 (write only) In the past this option was required to be set to force
236 reading of the button status for
237 .I button\-1
238 and
239 .I button\-2.
240 The
241 .B sane\-pixma
242 backend no longer requires this option to be used: if no fresh data is available, it
243 will be now requested automatically from the scanner. This option is left for
244 backward compatibility reasons.
245 .TP
246 .I button\-1 button\-2
247 (read only) These options will return the value of the respective buttons.
248 Value 0 means that the button was not pressed, 1 is returned when the button
249 was pressed. Some scanners, with more than two buttons, send the button number
250 as target.
251 .TP
252 .I original
253 (read only) Returns the value of the type or size of original to be scanned
254 if the scanner provides that data. Known values of type: 1 = document, 2 = photo,
255 5 = film. Known values of size: 1 = A4, 2 = Letter, 8 = 10x15, 9 = 13x18, b = auto.
256 Not all scanners can provide this data.
257 .TP
258 .I target
259 (read only) Returns the value of the target of the scan operation if the scanner
260 provides that data. The values depend on the scanner type. Known values:
261 1 = save to disk, 2 = save to pdf, 3 = send to email, 4 = send to application
262 or 1 = JPEG, 2 = TIFF, 3 = PDF, 4 = Compact PDF. For some scanners this value
263 is equivalent to the number of the pressed button. Not all scanners can provide
264 this data.
265 .TP
266 .I scan\-resolution
267 (read only) Returns the resolution of the scan operation if the scanner
268 provides that data. Known values: 1 = 75 dpi, 2 = 150 dpi, 3 = 300 dpi,
269 4 = 600 dpi. Not all scanners can provide this data.
270 .TP
271 .I document\-type
272 (read only) Returns the type of the scanned document if the scanner provides
273 that data. Known values: 1 = Document, 2 = Photo, 3 = Auto scan. Not all scanners
274 can provide this data.
275 .TP
276 .I adf\-status
277 (read only) Returns the status of the document feeder if the scanner provides
278 that data. Known values: 1 = ADF empty, 2 = ADF filled. Not all scanners can
279 provide this data.
280 .TP
281 .I adf\-orientation
282 (read only) Returns the scan orientation of the medium scanned from ADF if the
283 scanner provides that data. Known values: 1 = Portrait, 2 = Landscape. Not all
284 scanners can provide this data.
285 .SH FILES
286 .TP
287 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-pixma.a
288 The static library implementing this backend.
289 .TP
290 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-pixma.so
291 The shared library implementing this backend (present on systems that
292 support dynamic loading).
293 .TP
294 .I /etc/sane.d/pixma.conf
295 The backend configuration file (see also description of
296 .B SANE_CONFIG_DIR
297 below).
298 .RS
299 .PP
300 The file contains an optional list of networked scanners using the BJNP or MFNP protools
301 (See below for datails on networking support for scanners). Normally
302 only scanners that cannot be auto-detected because they are on a different
303 subnet shall be listed here. If you do not use Linux and your OS does not allow enumeration of
304 interfaces (i.e. it does not support the
305 .BR getifaddrs ()
306 function) you also may need
307 to add your scanner here as well.
308 .PP
309 Scanners shall be listed in the configuration file as follows:
310 .PP
311 .RS
312 .I <method>://<host>[:port][/timeout=<value>]
313 .RE
314 .PP
315 .TP
316 .B method
317 indicates the protocol used.
318 .I bjnp
319 is used for inkjet multi-functionals and
320 .I mfnp
321 is used for laser multi-functionals).
322 .TP
323 .B host
324 is the hostname or IP address of the scanner, e.g.
325 .I bjnp://10.0.1.4
326 for IPv4,
327 .I bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a]
328 for a literal IPv6-address or
329 .I bjnp://myscanner.mydomain.org
330 for a hostname.
331 .TP
332 .B port
333 is optional and is normally implied by the method.
334 Port 8610 is the standard port for mfnp, 8612 for bjnp.
335 .TP
336 .B timeout
337 scanner-specific timeout value for the network protocol. The value is in ms.
338 .PP
339 Define each scanner each on a separate line.
340 .PP
341 More globally-applicable timeouts can be set using the bjnp-timeout parameter as follows:
342 .PP
343 .RS
344 .I bjnp-timeout=<value>
345 .RE
346 .PP
347 A timeout defined using bjnp-timeout will apply to the following scanner definitions
348 in the file. If required, the bjnp-timeout setting
349 can be defined multiple times, where each setting will apply only to the scanners that
350 follow the setting. The last setting is used for auto-discovered scanners.
351 If not explicitly set, the default 1000ms setting will apply.
352 .PP
353 Setting timeouts should only be required in exceptional cases.
354 .PP
355 .RE
356 .PP
357 If so desired, networking can be disabled as follows:
358 .RS
359 .IP \fInetworking=no\FR
360 If the first non-commented line contains this entry all networking will be disabled.
361 All further statements in the configuration file will be ignored.
362 .IP \fIauto_detection=no\fR
363 This line will cause auto-detection to be skipped.
364 Explicitly defined network scanners will still be probed.
365 .SH USB SUPPORT
366 USB scanners will be auto-detected and require no configuration.
367 .SH NETWORKING SUPPORT
368 The
369 .B sane\-pixma
370 backend supports network scanners using the so called Canon BJNP
371 and MFNP protocols.
372 .PP
373 Canon seems to be dropping support for these protocols in recent scanners.
374 To verify if your scanner supports one of these protocols, check the content of
375 the _scanner._tcp service entry in mDNS/DNS-SD (using for example
376 .BR avahi-discover (1)).
377 If that does not list port 8610
378 or 8612 your scanner probably does not support the mfmp or bjnp protols.
379 .PP
380 Both IPv4 and IPv6 are supported, but IPv6 is as
381 yet untested with MFNP. Please report your results on the mailing list.
382 .PP
383 Configuration is normally not required.
384 The
385 .B sane\-pixma
386 backend will auto-detect your scanner if it is within
387 the same subnet as your computer if your OS does support this.
388 .PP
389 If your scanner can not be auto-detected, you can add it to the
390 .B sane\-pixma
391 configuration file (see above).
392 .SH FIREWALLING FOR NETWORKED SCANNERS
393 The
394 .B sane\-pixma
395 backend communicates with port 8610 for MFNP or port 8612
396 for BJNP on the scanner. So
397 you will have to allow outgoing traffic TO port 8610 or 8612 on the
398 common subnet for scanning.
399 .PP
400 Scanner detection is slightly more complicated. The
401 .B sane\-pixma
402 backend sends
403 a broadcast on all direct connected subnets it can find (provided your OS
404 allows for enumeration of all network interfaces). The broadcast is sent FROM
405 port 8612 TO port 8610 or 8612 on the broadcast address of each interface.
406 The outgoing packets will be allowed by the rule described above.
407 .PP
408 Responses from the scanner are sent back to the computer TO port 8612.
409 Connection tracking however does not see a match as the response does not come
410 from the broadcast address but from the scanners own address.
411 For automatic detection of your scanner, you will therefore have to allow
412 incoming packets TO port 8612 on your computer. This applies to both MFNP and
413 BJNP.
414 .PP
415 So in short: open the firewall for all traffic from your computer to port
416 8610 (for MFNP) or 8612 (for BJNP)
417 AND to port 8612 (for both BJNP and MFNP) to your computer.
418 .PP
419 With the firewall rules above there is no need to add the scanner to the
420 .I pixma.conf
421 file, unless the scanner is on a network that is not directly
422 connected to your computer.
423 .SH ENVIRONMENT
424 .TP
425 .B SANE_DEBUG_PIXMA
426 If the library was compiled with debug support enabled, this environment
427 variable controls the debug level for this backend itself. Higher value increases
428 the verbosity and includes the information printed at the lower levels.
429 .RS
430 0 print nothing (default)
431 .br
432 1 print error and warning messages (recommended)
433 .br
434 2 print informational messages
435 .br
436 3 print debug-level messages
437 .br
438 4 print verbose debug-level messages
439 .br
440 11 dump USB traffic
441 .br
442 21 full dump USB traffic
443 .br
444 .RE
445 .TP
446 .B SANE_DEBUG_BJNP
447 If the library was compiled with debug support enabled, this environment
448 variable controls the debug level for the
449 .B BJNP and MFNP
450 network protocols for this backend. Higher value increases
451 the verbosity and includes the information printed at the lower levels.
452 .RS
453 0 print nothing (default)
454 .br
455 1 Print error and warning messages (recommended)
456 .br
457 2 Print high level function tracing information
458 .br
459 3 Print more detailed protocol tracing information
460 .br
461 4 Print protocol headers
462 .br
463 5 Print full protocol contents
464 .RE
465 .TP
466 .B PIXMA_EXPERIMENT
467 Setting to a non-zero value will enable experimental support for further models.
468 You should also set SANE_DEBUG_PIXMA to 11.
469 .TP
470 .B SANE_CONFIG_DIR
471 This environment variable specifies the list of directories that may
472 contain the configuration file. On *NIX systems, the directories are
473 separated by a colon (`:'), under OS/2, they are separated by a
474 semi-colon (`;'). If this variable is not set, the configuration file
475 is searched in two default directories: first, the current working
476 directory (".") and then in
477 .IR /etc/sane.d .
478 If the value of the
479 environment variable ends with the directory separator character, then
480 the default directories are searched after the explicitly specified
481 directories. For example, setting
482 .B SANE_CONFIG_DIR
483 to "/tmp/config:" would result in directories
484 .IR "tmp/config" ,
485 .IR "." ,
486 and
487 .I "/etc/sane.d"
488 being searched (in this order).
489 .SH "SEE ALSO"
490 .BR sane (7),
491 .BR sane\-dll (5),
492 .BR scanimage (1),
493 .BR scanadf (1),
494 .BR gamma4scanimage (1),
495 .BR getifaddrs (3)
496 .PP
497 In case of trouble with a recent Pixma model, try the latest code for
498 the
499 .B sane\-pixma
500 backend, available in the Sane git repository at:
501 .br
502 .I https://gitlab.com/sane-project/backends.git
503 .PP
504 You can also post into the Sane-devel mailing list for support.
505
506 .SH AUTHORS
507 Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk, Rolf Bensch
508 .PP
509 We would like to thank all testers and helpers. Without them we could not be
510 able to write subdrivers for models we don't have. See also the project
511 homepage.