2013-03-21 18:10:03 +00:00
|
|
|
.TH "sane\-pixma" "5" "21 Mar 2013" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
|
2008-07-14 10:49:06 +00:00
|
|
|
.IX sane\-pixma
|
2006-05-26 07:49:24 +00:00
|
|
|
.SH NAME
|
2009-12-26 13:40:39 +00:00
|
|
|
.B sane\-pixma
|
|
|
|
\- SANE backend for Canon PIXMA Multi-Functions Printers
|
|
|
|
.br
|
2012-07-31 11:19:37 +00:00
|
|
|
E, MG, MP, MX, ImageCLASS, imageRunner and I-SENSYS series
|
|
|
|
.br
|
|
|
|
and for Canon CanoScan Flatbed/TPU Scanners
|
2006-05-26 07:49:24 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
The
|
2008-07-14 10:49:06 +00:00
|
|
|
.B sane\-pixma
|
2006-05-26 07:49:24 +00:00
|
|
|
library implements a SANE (Scanner Access Now Easy) backend that provides
|
|
|
|
access to Canon PIXMA multi-function devices (All-in-one printers).
|
2013-01-10 20:10:41 +00:00
|
|
|
The backend implements both USB interface and network interface
|
|
|
|
using Canon's BJNP protocol. The network interface supports scanners over
|
|
|
|
IPv4 as well as IPv6.
|
|
|
|
.PP
|
2006-05-26 07:49:24 +00:00
|
|
|
Currently, the following models work with this backend:
|
|
|
|
.PP
|
|
|
|
.RS
|
2013-03-15 21:49:49 +00:00
|
|
|
PIXMA MG2100, MG3100, MG4200, MG5100, MG5300, MG6100, MG6200, MG6300
|
2012-08-27 13:40:21 +00:00
|
|
|
.br
|
2009-04-21 08:22:20 +00:00
|
|
|
PIXMA MP140, MP150, MP160, MP170, MP180, MP190
|
2006-06-03 00:39:09 +00:00
|
|
|
.br
|
2013-03-21 18:10:03 +00:00
|
|
|
PIXMA MP210, MP220, MP230, MP240, MP250, MP260, MP270, MP280
|
2009-04-21 08:22:20 +00:00
|
|
|
.br
|
2010-09-08 20:08:32 +00:00
|
|
|
PIXMA MP360, MP370, MP390
|
2010-09-02 16:18:53 +00:00
|
|
|
.br
|
2010-01-08 20:09:22 +00:00
|
|
|
PIXMA MP450, MP460, MP470, MP480, MP490
|
2009-04-21 08:22:20 +00:00
|
|
|
.br
|
2010-01-08 20:09:22 +00:00
|
|
|
PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
|
2007-07-19 22:17:21 +00:00
|
|
|
.br
|
2012-07-31 11:19:37 +00:00
|
|
|
PIXMA MP600, MP600R, MP610, MP620, MP630, MP640
|
|
|
|
.br
|
|
|
|
PIXMA MP700, MP710, MP730, PIXMA MP750 (no grayscale)
|
|
|
|
.br
|
|
|
|
PIXMA MP800, MP800R, MP810, MP830
|
|
|
|
.br
|
|
|
|
PIXMA MP960, MP970, MP980, MP990
|
2008-03-16 16:33:53 +00:00
|
|
|
.br
|
2012-08-26 17:36:07 +00:00
|
|
|
PIXMA MX300, MX310, MX330, MX340, MX350, MX360, MX370
|
2008-04-15 21:27:34 +00:00
|
|
|
.br
|
2012-07-31 11:19:37 +00:00
|
|
|
PIXMA MX420, MX700, MX7600
|
2010-07-22 05:56:13 +00:00
|
|
|
.br
|
2012-12-07 18:29:58 +00:00
|
|
|
PIXMA MX850, MX860, MX870, MX882, MX885, MX890
|
2012-01-23 10:21:02 +00:00
|
|
|
.br
|
2012-07-31 11:19:37 +00:00
|
|
|
ImageCLASS MF3110, MF3240, MF4010, MF4018
|
2006-06-03 00:39:09 +00:00
|
|
|
.br
|
2012-07-31 11:19:37 +00:00
|
|
|
ImageCLASS MF4120, MF4122, MF4140, MF4150
|
2008-04-21 19:24:07 +00:00
|
|
|
.br
|
2012-07-31 11:19:37 +00:00
|
|
|
ImageCLASS MF4270, MF4350d, MF4370dn, MF4380dn
|
2009-04-21 08:22:20 +00:00
|
|
|
.br
|
2012-12-07 18:44:44 +00:00
|
|
|
ImageCLASS MF4410, MF4430, MF4660, MF4690
|
2009-10-18 13:04:39 +00:00
|
|
|
.br
|
2012-09-12 20:47:29 +00:00
|
|
|
ImageCLASS MF5730, MF5770, MF6550, D420, D480
|
2009-10-21 19:39:27 +00:00
|
|
|
.br
|
2013-01-14 13:21:58 +00:00
|
|
|
I-SENSYS MF4320d, MF4330d, MF4550d
|
2010-04-12 20:45:58 +00:00
|
|
|
.br
|
2012-09-03 08:41:37 +00:00
|
|
|
imageRunner 1020/1024/1025
|
|
|
|
.br
|
2012-01-15 02:48:19 +00:00
|
|
|
CanoScan 8800F, 9000F
|
2006-06-10 10:50:43 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2007-04-09 20:41:25 +00:00
|
|
|
The following models are not well tested and/or the scanner sometimes hangs
|
|
|
|
and must be switched off and on.
|
2006-05-26 07:49:24 +00:00
|
|
|
.PP
|
|
|
|
.RS
|
2012-07-31 11:19:37 +00:00
|
|
|
PIXMA MP760, MP770, MP780, MP790
|
|
|
|
.br
|
|
|
|
PIXMA MX360
|
2006-05-26 07:49:24 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2008-02-17 15:49:43 +00:00
|
|
|
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.
|
2012-07-28 11:59:17 +00:00
|
|
|
Feedback in the sane\-devel mailing list welcome.
|
2008-02-17 15:49:43 +00:00
|
|
|
.PP
|
|
|
|
.RS
|
2012-08-26 17:36:07 +00:00
|
|
|
PIXMA E500, E600
|
|
|
|
.br
|
2013-01-21 09:07:24 +00:00
|
|
|
PIXMA MG4100, MG5200
|
2012-07-31 11:19:37 +00:00
|
|
|
.br
|
2012-12-07 19:13:39 +00:00
|
|
|
PIXMA MG8100, MG8200
|
2012-07-31 11:19:37 +00:00
|
|
|
.br
|
|
|
|
PIXMA MP375R, MP493, MP495, MP740
|
2008-10-14 19:48:59 +00:00
|
|
|
.br
|
2012-12-07 18:29:58 +00:00
|
|
|
PIXMA MX320, MX410, MX430, MX510, MX710
|
2008-04-21 19:24:07 +00:00
|
|
|
.br
|
2012-09-12 20:47:29 +00:00
|
|
|
ImageCLASS MF5630, MF5650, MF5750, MF8030, MF8170c
|
2013-01-14 14:25:45 +00:00
|
|
|
.br
|
2013-01-14 14:44:46 +00:00
|
|
|
I-SENSYS MF5880dn, MF6680dn
|
2008-04-02 20:13:48 +00:00
|
|
|
.RE
|
|
|
|
.PP
|
2012-08-26 17:36:07 +00:00
|
|
|
\#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
|
2009-12-26 13:40:39 +00:00
|
|
|
The backend supports:
|
2008-02-22 21:42:30 +00:00
|
|
|
.PP
|
2009-12-26 13:40:39 +00:00
|
|
|
.RS
|
2012-01-15 02:48:19 +00:00
|
|
|
* resolutions of 75, 150, 300, 600, 1200, 2400, 4800, and 9600 DPI (some maybe buggy),
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2010-09-02 16:18:53 +00:00
|
|
|
* color and grayscale mode, as well as lineart on certain models,
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2008-10-14 19:48:59 +00:00
|
|
|
* a custom gamma table,
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2009-12-26 13:40:39 +00:00
|
|
|
* Automatic Document Feeder, Simplex and Duplex.
|
2008-10-05 20:42:19 +00:00
|
|
|
.br
|
2013-02-18 17:53:06 +00:00
|
|
|
* Transparency Unit, 24 or 48 bits depth. Infrared channel on certain models.
|
2009-12-26 13:40:39 +00:00
|
|
|
.RE
|
2006-05-26 07:49:24 +00:00
|
|
|
.PP
|
2009-10-22 14:05:22 +00:00
|
|
|
The device name for USB devices is in the form pixma:xxxxyyyy_zzzzz
|
2006-05-26 07:49:24 +00:00
|
|
|
where x, y and z are vendor ID, product ID and serial number respectively.
|
|
|
|
Example: pixma:04A91709_123456 is a MP150.
|
|
|
|
.PP
|
2009-10-22 14:05:22 +00:00
|
|
|
Device names for BJNP devices is in the form pixma:aaaa_bbbbb
|
|
|
|
where aaaa is the scanners model and bbbb is the hostname or ip-adress.
|
|
|
|
.PP
|
2008-05-29 20:01:56 +00:00
|
|
|
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
|
2013-01-10 20:10:41 +00:00
|
|
|
it as well as we could, but it may not work in all situations. You will find
|
2008-05-29 20:01:56 +00:00
|
|
|
an up-to-date status at the project homepage. (See below).
|
|
|
|
Users feedback is essential to help improve features and performances.
|
2006-06-08 17:50:14 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
Besides "well-known" options (e.g. resolution, mode etc.) pixma backend also
|
|
|
|
provides the following
|
2008-06-15 20:05:14 +00:00
|
|
|
\#.B experimental
|
2006-06-08 17:50:14 +00:00
|
|
|
options for button handling, i.e. the options might change in the future.
|
2009-04-05 19:49:41 +00:00
|
|
|
.br
|
2013-01-18 11:14:19 +00:00
|
|
|
The button status can be polled i.e. with 'scanimage -A'.
|
|
|
|
.br
|
2009-04-05 19:49:41 +00:00
|
|
|
Button scan is disabled on MAC OS X due to darwin libusb not handling
|
2013-01-18 11:14:19 +00:00
|
|
|
timeouts in usb interrupt reads.
|
2006-06-08 17:50:14 +00:00
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
.I button\-controlled
|
2013-01-10 20:10:41 +00:00
|
|
|
This option can be used by applications (like
|
2006-06-08 17:50:14 +00:00
|
|
|
.BR scanadf (1)
|
|
|
|
and
|
2013-01-10 20:10:41 +00:00
|
|
|
.BR scanimage (1))
|
2006-06-08 17:50:14 +00:00
|
|
|
in batch mode, for example when you want to scan many photos or
|
|
|
|
multiple-page documents. If it is enabled (i.e. is set to true or yes), the
|
|
|
|
backend waits before every scan until the user presses the "SCAN" button
|
|
|
|
(for MP150) or the color-scan button (for other models). Just put the
|
|
|
|
first page in the scanner, press the button, then the next page, press
|
|
|
|
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
|
2013-01-10 20:10:41 +00:00
|
|
|
.I button\-update
|
|
|
|
(write only) In the past this option was required to be set to force
|
|
|
|
reading of the button status for
|
2008-07-14 10:49:06 +00:00
|
|
|
.I button\-1
|
2006-06-08 17:50:14 +00:00
|
|
|
and
|
2013-01-10 20:10:41 +00:00
|
|
|
.I button\-2.
|
|
|
|
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
|
|
|
|
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
|
2013-01-18 11:14:19 +00:00
|
|
|
was pressed. Some scanners with more than two buttons send the button number
|
|
|
|
as target.
|
2013-01-10 20:10:41 +00:00
|
|
|
.TP
|
|
|
|
.I original
|
|
|
|
(read only) returns the value of the type of original to be scanned if the
|
|
|
|
scanner provides that data. Known values: 1 = document, 2 = foto, 5 = film.
|
|
|
|
Not all scanners can provide this data.
|
|
|
|
.TP
|
|
|
|
.I target
|
|
|
|
(read only) returns the value of the target of the scan operation if the scanner
|
|
|
|
provides that data. Known values: 1 = save to disk, 2 = save to pdf, 3 = send to
|
2013-01-18 11:14:19 +00:00
|
|
|
email, 4 = send to application. For some scanners this value is equivalent to
|
|
|
|
the number of the pressed button. Not all scanners can provide this data.
|
2006-05-26 07:49:24 +00:00
|
|
|
.SH FILES
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
.I @LIBDIR@/libsane\-pixma.a
|
2006-05-26 07:49:24 +00:00
|
|
|
The static library implementing this backend.
|
|
|
|
.TP
|
2008-07-14 10:49:06 +00:00
|
|
|
.I @LIBDIR@/libsane\-pixma.so
|
2006-05-26 07:49:24 +00:00
|
|
|
The shared library implementing this backend (present on systems that
|
|
|
|
support dynamic loading).
|
2009-10-22 14:05:22 +00:00
|
|
|
.TP
|
|
|
|
.I @CONFIGDIR@/pixma.conf
|
|
|
|
The backend configuration file (see also description of
|
|
|
|
.B SANE_CONFIG_DIR
|
|
|
|
below). The files contains an optional list of scanners. Normally only scanners
|
|
|
|
that can not 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 may need to add your scanner here as well.
|
|
|
|
Scanners shall be listed as:
|
|
|
|
.PP
|
|
|
|
.RS
|
|
|
|
.I bjnp://<host>
|
|
|
|
.RE
|
|
|
|
.RS
|
2013-01-10 20:10:41 +00:00
|
|
|
where 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. Define each scanner on a new
|
|
|
|
line.
|
2009-10-22 14:05:22 +00:00
|
|
|
.SH USB SUPPORT
|
|
|
|
USB scanners will be auto-detected and require no configuration.
|
|
|
|
.SH NETWORKING SUPPORT
|
2013-01-10 20:10:41 +00:00
|
|
|
The pixma backend supports network scanners using the so called Canon BJNP
|
|
|
|
protocol. Both IPv4 and IPv6 are supported.
|
|
|
|
.PP
|
2009-10-22 14:05:22 +00:00
|
|
|
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.
|
2013-01-10 20:10:41 +00:00
|
|
|
.PP
|
|
|
|
If your scanner can not be auto-detected, you can add it to the pixma
|
|
|
|
configuration file (see above).
|
2009-10-22 14:05:22 +00:00
|
|
|
.SH FIREWALLING FOR NETWORKED SCANNERS
|
|
|
|
The sane pixma backend communicates with port 8612 on the scanner. So
|
|
|
|
you will have to allow outgoing traffic TO port 8612 on the common subnet
|
|
|
|
for scanning.
|
2013-01-10 20:10:41 +00:00
|
|
|
.PP
|
2009-10-22 14:05:22 +00:00
|
|
|
Scanner detection is slightly more complicated. The pixma backend sends
|
2013-01-10 20:10:41 +00:00
|
|
|
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 8612 on the broadcast address of each interface.
|
2009-10-22 14:05:22 +00:00
|
|
|
The outgoing packets will be allowed by the rule described above.
|
2013-01-10 20:10:41 +00:00
|
|
|
.PP
|
2009-10-22 14:05:22 +00:00
|
|
|
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.
|
2013-01-10 20:10:41 +00:00
|
|
|
For automatic detection of your scanner, you will therefore have to allow
|
|
|
|
incoming packets TO port 8612 on your computer.
|
|
|
|
.PP
|
|
|
|
So in short: open the firewall for all traffic from your computer to port 8612
|
|
|
|
AND to port 8612 to your computer.
|
|
|
|
.PP
|
2009-10-22 14:05:22 +00:00
|
|
|
With the firewall rules above there is no need to add the scanner to the
|
|
|
|
pixma.conf file, unless the scanner is on a network that is not directly
|
|
|
|
connected to your computer.
|
2006-05-26 07:49:24 +00:00
|
|
|
.SH ENVIRONMENT
|
|
|
|
.TP
|
|
|
|
.B SANE_DEBUG_PIXMA
|
|
|
|
If the library was compiled with debug support enabled, this environment
|
2013-01-10 20:10:41 +00:00
|
|
|
variable controls the debug level for this backend itself. Higher value increases
|
|
|
|
the verbosity and includes the information printed at the lower levels.
|
2006-05-26 07:49:24 +00:00
|
|
|
.RS
|
2006-08-27 12:44:35 +00:00
|
|
|
0 print nothing (default)
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2006-06-03 00:39:09 +00:00
|
|
|
1 print error and warning messages (recommended)
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2006-06-08 17:50:14 +00:00
|
|
|
2 print informational messages
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2006-06-08 17:50:14 +00:00
|
|
|
3 print debug-level messages
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2013-01-10 20:10:41 +00:00
|
|
|
11 dump USB traffic
|
|
|
|
.br
|
|
|
|
21 full dump USB traffic
|
|
|
|
.br
|
|
|
|
.RE
|
|
|
|
.TP
|
|
|
|
.B SANE_DEBUG_BJNP
|
|
|
|
If the library was compiled with debug support enabled, this environment
|
|
|
|
variable controls the debug level for the
|
|
|
|
.B BJNP
|
|
|
|
network protocol for this backend. Higher value increases
|
|
|
|
the verbosity and includes the information printed at the lower levels.
|
|
|
|
.RS
|
|
|
|
0 print nothing (default)
|
|
|
|
.br
|
|
|
|
1 Print error and warning messages (recommended)
|
|
|
|
.br
|
|
|
|
2 Print high level function tracing information
|
|
|
|
.br
|
|
|
|
3 Print more detailed protocol tracing information
|
2006-05-26 07:49:24 +00:00
|
|
|
.br
|
2013-01-10 20:10:41 +00:00
|
|
|
4 Print protocol headers
|
2008-02-24 09:25:38 +00:00
|
|
|
.br
|
2013-01-10 20:10:41 +00:00
|
|
|
5 Print full protocol contents
|
2006-05-26 07:49:24 +00:00
|
|
|
.RE
|
|
|
|
.TP
|
|
|
|
.B PIXMA_EXPERIMENT
|
|
|
|
Setting to a non-zero value will enable the support for experimental models.
|
2009-10-21 19:39:27 +00:00
|
|
|
You should also set SANE_DEBUG_PIXMA to 11.
|
2009-10-22 14:05:22 +00:00
|
|
|
.TP
|
|
|
|
.B SANE_CONFIG_DIR
|
|
|
|
This environment variable specifies the list of directories that may
|
|
|
|
contain the configuration file. Under UNIX, the directories are
|
|
|
|
separated by a colon (`:'), under OS/2, they are separated by a
|
|
|
|
semi-colon (`;'). If this variable is not set, the configuration file
|
|
|
|
is searched in two default directories: first, the current working
|
|
|
|
directory (".") and then in @CONFIGDIR@. If the value of the
|
|
|
|
environment variable ends with the directory separator character, then
|
|
|
|
the default directories are searched after the explicitly specified
|
|
|
|
directories. For example, setting
|
|
|
|
.B SANE_CONFIG_DIR
|
|
|
|
to "/tmp/config:" would result in directories "tmp/config", ".", and
|
|
|
|
"@CONFIGDIR@" being searched (in this order).
|
2006-05-26 07:49:24 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR sane (7),
|
2008-07-14 10:49:06 +00:00
|
|
|
.BR sane\-dll (5),
|
2008-02-17 15:49:43 +00:00
|
|
|
.I http://home.arcor.de/wittawat/pixma/,
|
|
|
|
.I http://mp610.blogspot.com/
|
2009-12-26 13:40:39 +00:00
|
|
|
.PP
|
|
|
|
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
|
|
|
|
.PP
|
|
|
|
You can also post into the Sane-devel mailing list for support.
|
2009-10-22 14:05:22 +00:00
|
|
|
|
2008-05-29 20:01:56 +00:00
|
|
|
.SH AUTHORS
|
2012-01-18 07:58:52 +00:00
|
|
|
Wittawat Yamwong, Nicolas Martin, Dennis Lou, Louis Lagendijk, Rolf Bensch
|
2006-05-26 07:49:24 +00:00
|
|
|
.PP
|
2008-05-29 20:01:56 +00:00
|
|
|
We would like to thank all testers and helpers. Without them we could not be
|
|
|
|
able to write subdrivers for models we don't have. See also the project
|
2006-06-08 17:50:14 +00:00
|
|
|
homepage.
|