diff options
Diffstat (limited to 'doc/sane-pixma.man')
| -rw-r--r-- | doc/sane-pixma.man | 193 |
1 files changed, 120 insertions, 73 deletions
diff --git a/doc/sane-pixma.man b/doc/sane-pixma.man index 1058e92..ea85ec5 100644 --- a/doc/sane-pixma.man +++ b/doc/sane-pixma.man @@ -1,4 +1,4 @@ -.TH "sane\-pixma" "5" "20 May 2017" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" +.TH "sane\-pixma" "5" "28 Dec 2019" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy" .IX sane\-pixma .SH NAME sane\-pixma \- SANE backend for Canon Multi-Function Printers and CanoScan Scanners @@ -8,20 +8,24 @@ The library implements a SANE (Scanner Access Now Easy) backend that provides access to Canon PIXMA / i-SENSYS / imageCLASS / imageRUNNER multi-function devices (All-in-one printers) and the Canon CanoScan Flatbed/TPU scanners. -The backend implements both the USB interface and network interface -(using Canon's BJNP and MFNP protocols). The network interface supports scanners +The backend implements both the USB interface and network interface +(using Canon's BJNP and MFNP protocols). The network interface supports scanners over IPv4 as well as IPv6 (MFNP over IPv6 is untested). .PP Currently, the following models work with this backend: .PP .RS -PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3100, MG3200 +PIXMA E510 .br -PIXMA MG3500, MG3600, MG4200, MG5100, MG5200, MG5300, MG5400 +PIXMA G2000, G2010, G2100 .br -PIXMA MG5500, MG5600, MG5700, MG6100, MG6200, MG6300, MG6400 +PIXMA MG2100, MG2200, MG2400, MG2500, MG2900, MG3000, MG3100 .br -PIXMA MG7100, MG7500, MG7700, MG8200 +PIXMA MG3200, MG3500, MG3600, MG4200, MG5100, MG5200, MG5300 +.br +PIXMA MG5400, MG5500, MG5600, MG5700, MG6100, MG6200, MG6300 +.br +PIXMA MG6400, MG7100, MG7500, MG7700, MG8200 .br PIXMA MP140, MP150, MP160, MP170, MP180, MP190 .br @@ -47,8 +51,12 @@ PIXMA MX410, MX420, MX470, MX510, MX520, MX530, MX700, MX720 .br PIXMA MX850, MX860, MX870, MX882, MX885, MX890, MX920, MX7600 .br +PIXMA TS3100, TS5000, TS6100, TS6200, TS8000, TS8200 +.br PIXUS MP10 .br +imageCLASS MF634Cdw, MF733Cdw +.br imageCLASS MF3110, MF3240, MF4010, MF4018 .br imageCLASS MF4120, MF4122, MF4140, MF4150 @@ -57,17 +65,23 @@ imageCLASS MF4270, MF4350d, MF4370dn, MF4380dn .br imageCLASS MF4410, MF4430, MF4570dw, MF4660, MF4690 .br -imageCLASS MF5730, MF5770, MF6550, MPC200, D420, D480, D530 +imageCLASS MF5730, MF5770, MF6550, MPC200 .br -i-SENSYS MF230, MF240, MF3010, MF4320d, MF4330d, MF4500, MF4700 +imageCLASS D420, D480, D530, D570 .br -i-SENSYS MF4800, MF6100, MF8200C, MF8300 +i-SENSYS MF210, MF230, MF240, MF620, MF630, MF640, MF645C, MF730 .br -imageRUNNER 1020/1024/1025 +i-SENSYS MF731/733, MF741/743, MF3010, MF4320d, MF4330d, MF4500 +.br +i-SENSYS MF4700, MF4800, MF6100, MF8030, MF8200C, MF8300 +.br +imageRUNNER 1020/1024/1025, 1133 .br CanoScan 8800F, 9000F, 9000F Mark II .br -MAXIFY MB5000 (ADF is not working) +CanoScan LiDE 300, 400 +.br +MAXIFY MB2000, MB2100, MB2300, MB2700, MB5000, MB5400 .RE .PP The following models are not well tested and/or the scanner sometimes hangs @@ -77,46 +91,57 @@ and must be switched off and on. PIXMA MP760, MP770, MP780, MP790 .RE .PP -The following models may use the same Pixma protocol as those listed -above, but have not yet been reported to work (or not). They are declared -in the backend so that they get recognized and activated. +The following models may use the same Pixma protocol as those listed +above, but have not yet been reported to work (or not). They are declared +in the backend so that they get recognized and activated. Feedback in the sane\-devel mailing list welcome. .PP .RS -PIXMA E400, E460, E470, E480, E500, E510, E560, E600, E610 +PIXMA E400, E410, E460, E470, E480, E500, E560, E600, E610 .br -PIXMA MG3000, MG4100, MG6500, MG6600, MG6800, MG6900, MG8100 +PIXMA E3100, E3300, E4200 +.br +PIXMA MG4100, MG6500, MG6600, MG6800, MG6900, MG8100 .br PIXMA MP375R, MP493, MP495, MP740 .br PIXMA MX320, MX390, MX430, MX450, MX490, MX710 .br -PIXMA G3000 +PIXMA G3000, G3010, G4000, G4010, G6000, G6080 +.br +PIXMA TR4500, TR7500, TR7530, TR8500, TR8530, TR8580, TR9530 +.br +PIXMA TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300 +.br +PIXMA TS6330, TS6380, TS7330, TS8100, TS8130, TS8180, TS8230 .br -PIXMA TS9000, TS800, TS6000, TS5000 +PIXMA TS8280,, TS8300, TS8330, TS8380, TS9000, TS9100, TS9180 .br -PIXUS MP5 +PIXMA TS9500, TS9580 .br -imageCLASS MF810/820, MF5630, MF5650, MF5750, MF8030, MF8170c +PIXUS MP5, XK50, XK60, XK70, XK80 .br -imageCLASS MPC190 +imageCLASS MF810/820, MF5630, MF5650, MF5750, MF8170c .br -imageRUNNER 1133 +imageCLASS MPC190, D550 .br -i-SENSYS MF210, MF220, MF5880dn, MF5900, MF6680dn, MF8500C +i-SENSYS MF110, MF220, MF260, MF410, MF420, MF510, MF520, MF740 .br -MAXIFY MB2000, MB2300, MB5300 +i-SENSYS MF5880dn, MF5900, MF6680dn, MF8500C +.br +MAXIFY MB5100, MB5300 +.RE +.PP +The following models may use partly the same Pixma protocol as other devices +listed above, but may still need some work. They are declared in the backend +as experimental and need the environment variable PIXMA_EXPERIMENT=1 to get +recognized and activated. Snoop logs are required to further investigate, +please contact the sane\-devel mailing list. +.PP +.RS +\-\- none \-\- .RE .PP -\#The following models may use partly the same Pixma protocol as other devices -\#listed above, but may still need some work. They are declared in the backend -\#as experimental. Snoop logs are required to further investigate, please contact -\#the sane\-devel mailing list. -\#.PP -\#.RS -\#PIXMA MP--- -\#.RE -\#.PP The backend supports: .PP .RS @@ -133,7 +158,7 @@ The backend supports: .PP The device name for USB devices is in the form pixma:xxxxyyyy_zzzzz where x, y and z are vendor ID, product ID and serial number respectively. -.PP +.PP Example: pixma:04A91709_123456 is a MP150. .PP Device names for BJNP/MFNP devices is in the form pixma:aaaa_bbbbb @@ -141,12 +166,12 @@ where aaaa is the scanners model and bbbb is the hostname or ip-adress. .PP Example: pixma:MF4800_192.168.1.45 is a MF4800 Series multi-function peripheral. .PP -This backend, based on cloning original Canon drivers protocols, is in +This backend, based on cloning original Canon drivers protocols, is in a production stage. Designed has been carried out without any applicable -manufacturer documentation, probably never available. However, we have tested -it as well as we could, but it may not work in all situations. You will find -an up-to-date status at the project homepage. (See below). -Users feedback is essential to help improve features and performances. +manufacturer documentation, probably never available. However, we have tested +it as well as we could, but it may not work in all situations. You will find +an up-to-date status at the project homepage. (See below). +Users feedback is essential to help improve features and performances. .SH OPTIONS Besides "well-known" options (e.g. resolution, mode etc.) pixma backend also provides the following options, i.e. the options might change in the future. @@ -178,20 +203,20 @@ the button and so on. When you finished, press the gray-scan button. (For MP150 you have to stop the frontend by pressing Ctrl-C for example.) .TP .I button\-update (deprecated) -(write only) In the past this option was required to be set to force +(write only) In the past this option was required to be set to force reading of the button status for .I button\-1 and .I button\-2. -The +The .B sane\-pixma -no longer requires this option to be used: if no fresh data is available, it -will be now requested automatically from the scanner. This option is left for +no longer requires this option to be used: if no fresh data is available, it +will be now requested automatically from the scanner. This option is left for backward compatibility reasons. .TP .I button\-1 button\-2 (read only) These options will return the value of the respective buttons. -value 0 means that the button was not pressed, 1 is returned when the button +value 0 means that the button was not pressed, 1 is returned when the button was pressed. Some scanners with more than two buttons send the button number as target. .TP @@ -225,81 +250,105 @@ support dynamic loading). .I @CONFIGDIR@/pixma.conf The backend configuration file (see also description of .B SANE_CONFIG_DIR -below). The file contains an optional list of networked scanners. Normally -only scanners that cannot be auto-detected because they are on a different -subnet shall be listed here. If your OS does not allow enumeration of -interfaces (i.e. it does not support the getifaddrs() function) you also may need -to add your scanner here as well. +below). .RS .PP -.I Scanners shall be listed in the configuraton file as follows: +The file contains an optional list of networked scanners using the BJNP or MFNP protools +(See below for datails on networking support for scanners). Normally +only scanners that cannot be auto-detected because they are on a different +subnet shall be listed here. If you do not use Linux and your OS does not allow enumeration of +interfaces (i.e. it does not support the getifaddrs() function) you also may need +to add your scanner here as well. +.PP +.I Scanners shall be listed in the configuration file as follows: .PP .RS .I <method>://<host>[:port][/timeout=<value>] .RE .PP where method indicates the protocol used (bjnp is used for inkjet multi-functionals -and mfnp is used for laser multi-functionals). +and mfnp is used for laser multi-functionals). .PP -host is the hostname or IP address of the scanner, e.g. bjnp://10.0.1.4 -for IPv4, bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] for a literal +host is the hostname or IP address of the scanner, e.g. bjnp://10.0.1.4 +for IPv4, bjnp://[2001:888:118e:18e2:21e:8fff:fe36:b64a] for a literal IPv6-address or bjnp://myscanner.mydomain.org for a hostname. .PP The port number is optional and in normally implied by the method. Port 8610 is the standard port for mfnp, 8612 for bjnp. .PP -A scanner specific timeout value for the network protocol can be set using the +A scanner specific timeout value for the network protocol can be set using the bjnp-timeout parameter. The value is in ms. .PP Define scanners each on a new line. .PP -More globally applicable tinmeouts can be set using the bjnp-timeout parameter as folllows: +More globally applicable timeouts can be set using the bjnp-timeout parameter as follows: .PP .RS .I bjnp-timeout=<value> .RE .PP A timeout defined using bjnp-timeout will apply to the following scanner definitions -in the file. If required the bjnp-timeout setting +in the file. If required the bjnp-timeout setting can be defined multiple times, where each settng will apply only to the scanners that follow the setting. The last setting is used for the auto discovered scanners. -If not explicitely set, the default 1000ms setting will apply. +If not explicitly set, the default 1000ms setting will apply. .PP Setting timeouts should only be required in exceptional cases. .PP +.RE +.PP +If so desired networking can be disbled as follows: +.RS +.IP - +If the first non-commented line contains +.B networking=no +all networking will be disabled. +This will cause all further statements in the configuration file to be ignored. +.IP - +A line that contains +.B auto_detection=no +will cause auto-detection to be skipped. Explicitely defined network scanners will still be probed. .SH USB SUPPORT USB scanners will be auto-detected and require no configuration. .SH NETWORKING SUPPORT -The pixma backend supports network scanners using the so called Canon BJNP -protocol and MFNP protocol. Both IPv4 and IPv6 are supported, but IPv6 is as +The pixma backend supports network scanners using the so called Canon BJNP +and MFNP protocols. +.PP +Canon seems to be dropping support for these protocols in recent scanners. +To verify if your scanner supports one of these protocols, check the content of +the _scanner._tcp service entry in mDNS/DNS-SD (using for example avahi-discover). +If that does not list port 8610 +or 8612 your scanner probably does not support the mfmp or bjnp protols. +.PP +Both IPv4 and IPv6 are supported, but IPv6 is as yet untested with MFNP. Please report your results on the mailing list. .PP Configuration is normally not required. The pixma backend will auto-detect your scanner if it is within the same subnet as your computer if your OS does support this. .PP -If your scanner can not be auto-detected, you can add it to the pixma +If your scanner can not be auto-detected, you can add it to the pixma configuration file (see above). .SH FIREWALLING FOR NETWORKED SCANNERS -The sane pixma backend communicates with port 8610 for MFNP or port 8612 +The sane pixma backend communicates with port 8610 for MFNP or port 8612 for BJNP on the scanner. So -you will have to allow outgoing traffic TO port 8610 or 8612 on the +you will have to allow outgoing traffic TO port 8610 or 8612 on the common subnet for scanning. .PP Scanner detection is slightly more complicated. The pixma backend sends -a broadcast on all direct connected subnets it can find (provided your OS -allows for enumeration of all netowrk interfaces). The broadcast is sent FROM +a broadcast on all direct connected subnets it can find (provided your OS +allows for enumeration of all netowrk interfaces). The broadcast is sent FROM port 8612 TO port 8610 or 8612 on the broadcast address of each interface. The outgoing packets will be allowed by the rule described above. .PP Responses from the scanner are sent back to the computer TO port 8612. Connection tracking however does not see a match as the response does not come from the broadcast address but from the scanners own address. -For automatic detection of your scanner, you will therefore have to allow +For automatic detection of your scanner, you will therefore have to allow incoming packets TO port 8612 on your computer. This applies to both MFNP and BJNP. .PP -So in short: open the firewall for all traffic from your computer to port +So in short: open the firewall for all traffic from your computer to port 8610 (for MFNP) or 8612 (for BJNP) AND to port 8612 (for both BJNP and MFNP) to your computer. .PP @@ -331,7 +380,7 @@ the verbosity and includes the information printed at the lower levels. .TP .B SANE_DEBUG_BJNP If the library was compiled with debug support enabled, this environment -variable controls the debug level for the +variable controls the debug level for the .B BJNP and MFNP network protocols for this backend. Higher value increases the verbosity and includes the information printed at the lower levels. @@ -341,7 +390,7 @@ the verbosity and includes the information printed at the lower levels. 1 Print error and warning messages (recommended) .br 2 Print high level function tracing information -.br +.br 3 Print more detailed protocol tracing information .br 4 Print protocol headers @@ -369,13 +418,11 @@ to "/tmp/config:" would result in directories "tmp/config", ".", and .SH "SEE ALSO" .BR sane (7), .BR sane\-dll (5), -.I http://home.arcor.de/wittawat/pixma/, -.I http://mp610.blogspot.com/ .PP -In case of trouble with a recent Pixma model, try the latest code for +In case of trouble with a recent Pixma model, try the latest code for the pixma backend, available in the Sane git repository at: .br -.I http://git.debian.org/?p=sane/sane-backends.git +.I https://gitlab.com/sane-project/backends.git .PP You can also post into the Sane-devel mailing list for support. |