Debian Codegraph @

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