#

# sane-umax_pp.5

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

## NAME

           sane-umax_pp  - SANE backend for Umax Astra parallel port flatbed scan-
           ners

## DESCRIPTION

           The sane-umax_pp library implements a SANE (Scanner  Access  Now  Easy)
           backend  that  provides  access to Umax parallel port flatbed scanners.
           The following scanners work with this backend:

                  Model:
                  --------------------
                  Astra 1220P
                  HP3200C
                  Astra 1600P
                  Astra 2000P

           This backend handles 75x75, 150x150, 300x300, 600x600 and 600x1200  dpi
           scan resolutions, in color and gray levels. There is a software lineart
           mode.

           These scanners share the same ASIC. Only parts  such  as  CCD  and  ADC
           change  from  one  to  another.  They even all reports being UMAX Astra
           1220P via IEEE1284.  There isn't software way to recognize  them  prop-
           erly.  Under  windows, model is set by the driver installed, regardless
           of the hardware.

           EPP MODE ONLY
                  The current version of the backend use only EPP mode to communi-
                  cate  with the scanner. PS/2 and SPP mode aren't implemented. It
                  is recommended that you set your parallel port to  EPP  in  BIOS
                  with the current version of this backend.  ECPEPP will only work
                  if you use a 2.4 kernel with ppdev character device support.

           This backend does support parport sharing only if  you  have  a  kernel
           with ppdev support.

           Note  that  if  you  don't  use the ppdev character device, the backend
           needs to run as root. To allow user access to the scanner run the back-
           end  through  the  network interface (See saned(1) and sane-net(5)).  A
           more relaxed solution (security wise) is to add suid bit to  the  fron-
           tend  (See  chmod(1)).  The backend drop root priviledges as soon as it
           can, right after gaining direct access to IO ports, which lessen  risks
           when being root.

## DEVICE NAMES

           This backend expects device names of the form:

                  port value

           Where  value  is the base address, or the ppdev device name of the port
           your scanner is attached to.  Known ports are 0x378, 0x278 and 0x3BC  .
           Or  the name of the parallel port character device user interface, such
           as /dev/parport0 for the linux ppdev, or /dev/ppi0 for FreeBSD ppi.
           Under linux, if you are not sure which port your scanner  is  connected
           to,  may  have a look at your /etc/modules.conf. Also typing dmesg|grep
           parport in a command shell should show you a line like:
           parport0: PC-style at 0x378 (0x778), irq 7, dma 3  [PCSPP,TRISTATE,COM-
           PAT,ECP,DMA]
           telling you about port address and mode.

           If  you  are  using  the linux ppdev character device, you will have to
           specify the device name, which is /dev/parport0 for the first  parallel
           port. Check the permissions on /dev/paraport0, many linux distributions
           restrict them for root only access. Get sure they are like:
           crw-rw-rw- 1 root root 99, 0 mai 20 2002 /dev/parport0
           crw-rw-rw- 1 root root 99, 1 mai 20 2002 /dev/parport1
           crw-rw-rw- 1 root root 99, 2 mai 20 2002 /dev/parport2
           crw-rw-rw- 1 root root 99, 3 mai 20 2002 /dev/parport3
           The same apply with the /dev/ppi0 character device under FreeBSD.

           You can rename any device using the

                  name devname
                  model model
                  vendor vendor

           options. These options apply to the last port option.

## CONFIGURATION

           Please make sure to edit umax_pp.conf before you use the backend.

           The contents of the umax_pp.conf file is a list of options  and  device
           names that correspond to Umax scanners.  Empty lines and lines starting
           with a hash mark (#) are ignored.

           The height  options  supported  are  red-brightness,  green-brightness,
           blue-brightness,  red-contrast,  green-contrast,  blue-contrast, astra,
           and buffer.

           Options red-brightness , green-brightness and blue-brightness allow you
           to  adjust  the  sensitivy  of your scanner for the given color. Values
           range from 0 (lowest brightness)  to  15  (highest).  If  the  advanced
           option  "Brightness"  isn't  checked  in the frontend, the backend does
           automatic brightness calibration, and do not use user provided  values.

           Options  red-contrast  ,  green-contrast and blue-contrast allow you to
           adjust the contrast of your scanner for the given color.  Values  range
           from 0 (lowest contrast) to 15 (highest).

           Option  astra  allows  you to change the model of your scanner. Current
           auto detection is based on side effects on scanning  when  using  1220P
           command set on other models, so it may fail on unkown hardware combina-
           tion. Valid values are 1220, 1600 and 2000. It  is  usefull  only  when
           autodetection  fails  to  detect  properly  your scanner model. If your
           scanner work properly but is reported wrongly, let it be that way.  The
           only  valid  case  to  change  the  model is when your scanner produces
           'black' or
            'inverted' scans.  In this case you can put the model. Be  aware  that
           it will prevent autodetection.

           Option  buffer  allows  you  to change the size of the scan buffer. The
           size must be specified in bytes. The  default  value  is  2  megabytes.
           Decreasing this value will improve the progress status reporting in the
           frontend, but will stall the scan more often.

## FILES

           /usr/local/etc/sane.d/umax_pp.conf
                  The  backend  configuration  file  (see  also   description   of
                  SANE_CONFIG_DIR below).

           /usr/local/lib/sane/libsane-umax_pp.a
                  The static library implementing this backend.

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

## ENVIRONMENT

           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
                  /usr/local/etc/sane.d.  If the value of the environment variable
                  ends  with  the  directory separator character, then the default
                  directories are searched after the explicitly specified directo-
                  ries.   For  example,  setting SANE_CONFIG_DIR to "/tmp/config:"
                  would   result   in   directories   "tmp/config",    ".",    and
                  "/usr/local/etc/sane.d" being searched (in this order).

           SANE_DEBUG_UMAX_PP
                  If  the  library  was  compiled with debug support enabled, this
                  environment variable controls the debug level for this  backend.
                  E.g.,  a  value  of 128 requests all debug output to be printed.
                  Smaller levels reduce verbosity.

                  level   debug output
                  ------- ------------------------------
                   0       nothing
                   1       errors
                   2       warnings & minor errors
                   3       additional information
                   4       debug information
                   5       code flow (not supported yet)
                   6       special debug information

           SANE_DEBUG_UMAX_PP_LOW
                  This variable sets the debug level for the  SANE  interface  for
                  the  Umax  ASIC. Note that enabling this will spam your terminal
                  with some million lines of debug output.

                  level   debug output
                  ------- -------------------------------
                   0       nothing
                   1       errors
                   8       command blocks
                   16      detailed code flow
                   32      dump datafiles
                   255     everything

## SEE ALSO

           sane(7), sane-net(5), saned(1)

           For latest bug fixes and information see
                  http://umax1220p.sourceforge.net/

## AUTHOR

           St?phane VOLTZ <svoltz@wanadoo.fr>, man page derived from mustek_pp man
           page by Jochen Eisinger <jochen.eisinger@gmx.net>

## BUG REPORTS

           If  something doesn't work, please contact me. But I need some informa-
           tion about your scanner to be able to help you...

           SANE version
                  run "scanimage -V" to determine this

           the backend version and your scanner hardware
                  run "SANE_DEBUG_UMAX=255 scanimage -L 2>log"  as  root.  If  you
                  don't  get any output from the umax_pp backend, make sure a line
                  "umax_pp" is included into your  /usr/local/etc/sane.d/dll.conf.
                  If  your  scanner  isn't  detected, make sure you've defined the
                  right port address, or the correct device in your  umax_pp.conf.

           the name of your scanner/vendor
                  also a worthy information. Please also include the optical reso-
                  lution and lamp type of your scanner, both can be found  in  the
                  manual of your scanner.

           any further comments
                  if you have comments about the documentation (what could be done
                  better), or you think I should know  something,  please  include
                  it.

    sane-backends 1.0.12-cvs       16 September 2003               sane-umax_pp(5)