summaryrefslogtreecommitdiff
path: root/doc/sane-pixma.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/sane-pixma.man')
-rw-r--r--doc/sane-pixma.man88
1 files changed, 59 insertions, 29 deletions
diff --git a/doc/sane-pixma.man b/doc/sane-pixma.man
index 87aadd4..bebe485 100644
--- a/doc/sane-pixma.man
+++ b/doc/sane-pixma.man
@@ -105,7 +105,9 @@ Feedback in the sane\-devel mailing list welcome.
.RS
PIXMA E400, E460, E470, E480, E500, E560, E600, E610
.br
-PIXMA E3100, E3300, E4200
+PIXMA E3100, E3300, E3400, E4200
+.br
+PIXMA G2020, G2060, G3020, G3060, G7000, G7080
.br
PIXMA MG4100, MG6500, MG6600, MG6800, MG6900, MG8100
.br
@@ -113,19 +115,21 @@ PIXMA MP375R, MP493, MP740
.br
PIXMA MX320, MX390, MX430, MX450, MX490, MX710
.br
-PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000
+PIXMA G3000, G3010, G4010, G6000, G6080, G7000, GM4000, GM4080
+.br
+PIXMA TR7500, TR7530, TR7600, TR8500, TR8530, TR8580, TR8600
.br
-PIXMA TR7500, TR7530, TR8500, TR8530, TR8580, TR9530
+PIXMA TR8630, TR9530
.br
-PIXMA TS6000, TS6130, TS6180, TS6230, TS6280, TS6300, TS6330
+PIXMA TS3400, TS5100, TS6000, TS6130, TS6180, TS6230, TS6280, TS6300
.br
-PIXMA TS6380, TS7330, TS8100, TS8130, TS8180, TS8230, TS8280
+PIXMA TS6330, TS6330, TS6380, TS6400, TS7330, TS7400, TS7430, TS8100
.br
-PIXMA TS8300, TS8330, TS8380, TS9000, TS9100, TS9180, TS9500
+PIXMA TS8130, TS8180, TS8230, TS8280, TS8300, TS8330, TS8380, TS9000
.br
-PIXMA TS9580
+PIXMA TS9100, TS9180, TS9500, TS9580
.br
-PIXUS MP5, XK50, XK60, XK70, XK80
+PIXUS MP5, XK50, XK60, XK70, XK80, XK90
.br
imageCLASS MF720, MF810/820, MF5630, MF5650, MF5750, MF8170c
.br
@@ -179,10 +183,13 @@ 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
+Besides "well-known" options (e.g. resolution, mode etc.)
+.Bsane\-pixma
+backend also
provides the following options, i.e. the options might change in the future.
.br
-The button status can be polled i.e. with 'scanimage \-A'.
+The button status can be polled i.e. with
+.I scanimage \-A.
.br
Button scan is disabled on MAC OS X due to darwin libusb not handling
timeouts in usb interrupt reads, but may work when using the network protocol.
@@ -216,7 +223,7 @@ and
.I button\-2.
The
.B sane\-pixma
-no longer requires this option to be used: if no fresh data is available, it
+backend 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
@@ -228,7 +235,7 @@ as target.
.TP
.I original
(read only) Returns the value of the type or size of original to be scanned
-if the scanner provides that data. Known values of type: 1 = document, 2 = foto,
+if the scanner provides that data. Known values of type: 1 = document, 2 = photo,
5 = film. Known values of size: 1 = A4, 2 = Letter, 8 = 10x15, 9 = 13x18, b = auto.
Not all scanners can provide this data.
.TP
@@ -278,10 +285,12 @@ The file contains an optional list of networked scanners using the BJNP or MFNP
(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
+interfaces (i.e. it does not support the
+.BR getifaddrs ()
+qfunction) you also may need
to add your scanner here as well.
.PP
-.I Scanners shall be listed in the configuration file as follows:
+Scanners shall be listed in the configuration file as follows:
.PP
.RS
.I <method>://<host>[:port][/timeout=<value>]
@@ -310,7 +319,7 @@ More globally applicable timeouts can be set using the bjnp-timeout parameter as
.PP
A timeout defined using bjnp-timeout will apply to the following scanner definitions
in the file. If required the bjnp-timeout setting
-can be defined multiple times, where each settng will apply only to the scanners that
+can be defined multiple times, where each setting will apply only to the scanners that
follow the setting. The last setting is used for the auto discovered scanners.
If not explicitly set, the default 1000ms setting will apply.
.PP
@@ -318,7 +327,7 @@ Setting timeouts should only be required in exceptional cases.
.PP
.RE
.PP
-If so desired networking can be disbled as follows:
+If so desired networking can be disabled as follows:
.RS
.IP -
If the first non-commented line contains
@@ -328,16 +337,19 @@ 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.
+will cause auto-detection to be skipped. Explicitly 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
+The
+.B sane\-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).
+the _scanner._tcp service entry in mDNS/DNS-SD (using for example
+.BR avahi-discover (1)).
If that does not list port 8610
or 8612 your scanner probably does not support the mfmp or bjnp protols.
.PP
@@ -345,20 +357,27 @@ 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
+.B sane\-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
+.B sane\-pixma
configuration file (see above).
.SH FIREWALLING FOR NETWORKED SCANNERS
-The sane pixma backend communicates with port 8610 for MFNP or port 8612
+The
+.B 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
common subnet for scanning.
.PP
-Scanner detection is slightly more complicated. The pixma backend sends
+Scanner detection is slightly more complicated. The
+.B sane\-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
+allows for enumeration of all network 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
@@ -374,7 +393,8 @@ So in short: open the firewall for all traffic from your computer to port
AND to port 8612 (for both BJNP and MFNP) to your computer.
.PP
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
+.I pixma.conf
+file, unless the scanner is on a network that is not directly
connected to your computer.
.SH ENVIRONMENT
.TP
@@ -429,21 +449,31 @@ 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
+directory (".") and then in
+.IR @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).
+to "/tmp/config:" would result in directories
+.IR "tmp/config" ,
+.IR "." ,
+and
+.I "@CONFIGDIR@"
+being searched (in this order).
.SH "SEE ALSO"
.BR sane (7),
.BR sane\-dll (5),
.BR scanimage (1),
+.BR scanadf (1),
.BR gamma4scanimage (1),
+.BR getifaddrs (3)
.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:
+the
+.B sane\-pixma
+backend, available in the Sane git repository at:
.br
.I https://gitlab.com/sane-project/backends.git
.PP