sane-pixma man page on OpenMandriva

Man page or keyword search:  
man Server   8135 pages
apropos Keyword Search (all sections)
Output format
OpenMandriva logo
[printable version]

sane-pixma(5)		 SANE Scanner Access Now Easy		 sane-pixma(5)

NAME
       sane-pixma  -  SANE  backend  for  Canon	 Multi-Function	 Printers  and
       CanoScan Scanners

DESCRIPTION
       The sane-pixma 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 USB inter‐
       face and network interface using Canon's	 BJNP  protocol.  The  network
       interface supports scanners over IPv4 as well as IPv6.

       Currently, the following models work with this backend:

	      PIXMA MG2100, MG3100, MG4200, MG5100, MG5200, MG5300
	      PIXMA MG6100, MG6200, MG6300, MG8200
	      PIXMA MP140, MP150, MP160, MP170, MP180, MP190
	      PIXMA MP210, MP220, MP230, MP240, MP250, MP260, MP270, MP280
	      PIXMA MP360, MP370, MP390
	      PIXMA MP450, MP460, MP470, MP480, MP490
	      PIXMA MP500, MP510, MP520, MP530, MP540, MP550, MP560
	      PIXMA MP600, MP600R, MP610, MP620, MP630, MP640
	      PIXMA MP700, MP710, MP730, PIXMA MP750 (no grayscale)
	      PIXMA MP800, MP800R, MP810, MP830
	      PIXMA MP960, MP970, MP980, MP990
	      PIXMA MX300, MX310, MX330, MX340, MX350, MX360, MX370
	      PIXMA MX420, MX700, MX7600
	      PIXMA MX850, MX860, MX870, MX882, MX885, MX890
	      imageCLASS MF3110, MF3240, MF4010, MF4018
	      imageCLASS MF4120, MF4122, MF4140, MF4150
	      imageCLASS MF4270, MF4350d, MF4370dn, MF4380dn
	      imageCLASS MF4410, MF4430, MF4660, MF4690, MF4770n
	      imageCLASS MF5730, MF5770, MF6550, D420, D480
	      i-SENSYS MF3010, MF4320d, MF4330d, MF4550d
	      imageRUNNER 1020/1024/1025
	      CanoScan 8800F, 9000F, 9000F Mark II

       The  following  models are not well tested and/or the scanner sometimes
       hangs and must be switched off and on.

	      PIXMA MP760, MP770, MP780, MP790
	      PIXMA MX360

       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.

	      PIXMA E500, E510, E600, E610
	      PIXMA MG2200, MG2400, MG2500, MG3200, MG4100, MG5400, MG5500
	      PIXMA MG6400, MG6500, MG7100, MG8100
	      PIXMA MP375R, MP493, MP495, MP740
	      PIXMA MX320, MX390, MX410, MX430, MX450, MX510, MX520
	      PIXMA MX710, MX720, MX920
	      imageCLASS MF4570dw, MF5630, MF5650, MF5750, MF8030, MF8170c
	      imageRUNNER 1133
	      i-SENSYS MF5880dn, MF6680dn

       The backend supports:

	      *	 resolutions  of 75, 150, 300, 600, 1200, 2400, 4800, and 9600
	      DPI (some maybe buggy),
	      * color and grayscale mode, as well as lineart on	 certain  mod‐
	      els,
	      * a custom gamma table,
	      * Automatic Document Feeder, Simplex and Duplex.
	      *	 Transparency  Unit,  24 or 48 bits depth. Infrared channel on
	      certain models.

       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 respec‐
       tively.	Example: pixma:04A91709_123456 is a MP150.

       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.

       This  backend, based on cloning original Canon drivers protocols, is in
       a production stage. Designed has been carried out without any  applica‐
       ble  manufacturer  documentation, probably never available. However, we
       have tested it as well as we could, but it may not work in  all	situa‐
       tions. You will find an up-to-date status at the project homepage. (See
       below).	Users feedback is essential to help improve features and  per‐
       formances.

OPTIONS
       Besides "well-known" options (e.g. resolution, mode etc.) pixma backend
       also provides the following  options  for  button  handling,  i.e.  the
       options might change in the future.
       The button status can be polled i.e. with 'scanimage -A'.
       Button  scan  is disabled on MAC OS X due to darwin libusb not handling
       timeouts in usb interrupt reads.

       button-controlled
	      This option can be used by  applications	(like  scanadf(1)  and
	      scanimage(1))  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.)

       button-update
	      (write  only)  In the past this option was required to be set to
	      force reading of the button status for  button-1	and  button-2.
	      The  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.

       button-1 button-2
	      (read only) These options will return the value of  the  respec‐
	      tive  buttons.  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.

       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, 5 = film. Known values of size: 1
	      = A4, 2 = Letter, 8 = 10x15, 9 = 13x18, b = auto.	 Not all scan‐
	      ners can provide this data.

       target (read  only)  Returns the value of the target of the scan opera‐
	      tion if the scanner provides that data. The values depend on the
	      scanner type. Known values: 1 = save to disk, 2 = save to pdf, 3
	      = send to email, 4 = send to application or 1 = JPEG, 2 =	 TIFF,
	      3 = PDF, 4 = Compact PDF. For some scanners this value is equiv‐
	      alent to the number of the pressed button. Not all scanners  can
	      provide this data.

       scan-resolution
	      (read  only) Returns the resolution of the scan operation if the
	      scanner provides that data. Known values: 1 = 75 dpi,  2	=  150
	      dpi, 3 = 300 dpi, 4 = 600 dpi. Not all scanners can provide this
	      data.

FILES
       /usr/lib64/sane/libsane-pixma.a
	      The static library implementing this backend.

       /usr/lib64/sane/libsane-pixma.so
	      The shared library implementing this backend (present on systems
	      that support dynamic loading).

       /etc/sane.d/pixma.conf
	      The   backend   configuration  file  (see	 also  description  of
	      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:

	      bjnp://<host>
	      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 scan‐
	      ner on a new line.

USB SUPPORT
       USB scanners will be auto-detected and require no configuration.

NETWORKING SUPPORT
       The  pixma  backend supports network scanners using the so called Canon
       BJNP protocol. Both IPv4 and IPv6 are supported.

       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.

       If your scanner can not be auto-detected, you can add it to  the	 pixma
       configuration file (see above).

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 sub‐
       net for scanning.

       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 port 8612 TO port 8612	 on  the  broadcast  address  of  each
       interface.   The outgoing packets will be allowed by the rule described
       above.

       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 incoming packets TO port 8612 on your computer.

       So in short: open the firewall for all traffic from  your  computer  to
       port 8612 AND to port 8612 to your computer.

       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.

ENVIRONMENT
       SANE_DEBUG_PIXMA
	      If  the  library	was  compiled with debug support enabled, this
	      environment variable controls the debug level for	 this  backend
	      itself.  Higher  value  increases the verbosity and includes the
	      information printed at the lower levels.
	      0	 print nothing (default)
	      1	 print error and warning messages (recommended)
	      2	 print informational messages
	      3	 print debug-level messages
	      11 dump USB traffic
	      21 full dump USB traffic

       SANE_DEBUG_BJNP
	      If the library was compiled with	debug  support	enabled,  this
	      environment  variable controls the debug level for the BJNP net‐
	      work protocol for this backend. Higher value increases the  ver‐
	      bosity and includes the information printed at the lower levels.
	      0 print nothing (default)
	      1 Print error and warning messages (recommended)
	      2 Print high level function tracing information
	      3 Print more detailed protocol tracing information
	      4 Print protocol headers
	      5 Print full protocol contents

       PIXMA_EXPERIMENT
	      Setting  to a non-zero value will enable the support for experi‐
	      mental models.  You should also set SANE_DEBUG_PIXMA to 11.

       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 config‐
	      uration file is searched in two default directories: first,  the
	      current working directory (".") and then in /etc/sane.d.	If the
	      value of the environment variable ends with the directory	 sepa‐
	      rator character, then the default directories are searched after
	      the explicitly  specified	 directories.	For  example,  setting
	      SANE_CONFIG_DIR  to  "/tmp/config:"  would result in directories
	      "tmp/config", ".", and "/etc/sane.d"  being  searched  (in  this
	      order).

SEE ALSO
       sane(7),	      sane-dll(5),	 http://home.arcor.de/wittawat/pixma/,
       http://mp610.blogspot.com/

       In case of trouble with a recent Pixma model, try the latest  code  for
       the pixma backend, available in the Sane git repository at:
       http://git.debian.org/?p=sane/sane-backends.git

       You can also post into the Sane-devel mailing list for support.

AUTHORS
       Wittawat	 Yamwong,  Nicolas  Martin,  Dennis Lou, Louis Lagendijk, Rolf
       Bensch

       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 homepage.

				  24 Sep 2013			 sane-pixma(5)
[top]

List of man pages available for OpenMandriva

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net