


scanimage(1)                                         scanimage(1)


NNAAMMEE
       scanimage - scan an image

SSYYNNOOPPSSIISS
       ssccaanniimmaaggee  [--dd|----ddeevviiccee--nnaammee  _d_e_v] [--hh|----hheellpp] [--LL|----lliisstt--
       ddeevviicceess]   [--TT|----tteesstt]    [--vv|----vveerrbboossee]    [--VV|----vveerrssiioonn]
       [_d_e_v_i_c_e_-_s_p_e_c_i_f_i_c_-_o_p_t_i_o_n_s]

DDEESSCCRRIIPPTTIIOONN
       ssccaanniimmaaggee  is  a  command-line  interface to control image
       acquisition devices such as flatbed scanners  or  cameras.
       The  device is controlled via command-line options.  After
       command-line processing, ssccaanniimmaaggee  normally  proceeds  to
       acquire  an  image.  The image data is written to standard
       output in one of the PNM (portable  aNyMaP)  formats  (PBM
       for  black-and-white images, PGM for grayscale images, and
       PPM for color images).  ssccaanniimmaaggee accesses image  acquisi-
       tion  devices  through  the SANE (Scanner Access Now Easy)
       interface and can thus support any device for which  there
       exists  a  SANE backend (try "apropos sane-" to get a list
       of available backends).

OOPPTTIIOONNSS
       The --dd or ----ddeevviiccee--nnaammee options must be followed by a SANE
       device-name.  A (partial) list of available devices can be
       obtained with the ----lliisstt--ddeevviicceess option (see  below).   If
       no  device-name  is  specified  explicitly, ssccaanniimmaaggee will
       attempt to open the first available device.

       The --hh or ----hheellpp options request  help  information.   The
       information  is  printed  on  standard  output and in this
       case, no attempt will be made to acquire an image.

       The --LL or ----lliisstt--ddeevviicceess option requests a (partial)  list
       of  devices  that are available.  The list is not complete
       since some devices may be available, but are not listed in
       any of the configuration files (which are typically stored
       in directory /usr/local/etc/sane.d).  This is particularly
       the  case when accessing scanners through the network.  If
       a device is not listed in a configuration file,  the  only
       way to access it is by its full device name.  You may need
       to consult your system administrator to find out the names
       of such devices.

       The  --TT or ----tteesstt option requests that ssccaanniimmaaggee perform a
       few simple sanity tests to make sure the backend works  as
       defined by the SANE API (in particular the ssaannee__rreeaadd func-
       tion is excercised by this test).

       The --vv or ----vveerrbboossee options increase the verbosity of  the
       operation  of  ssccaanniimmaaggee..   The  option  may  be specified
       repeatedly, each time increasing the verbosity level.

       The --VV or ----vveerrssiioonn option requests that  ssccaanniimmaaggee  print



                           4 March 1998                         1





scanimage(1)                                         scanimage(1)


       the  program and package name, as well as the version num-
       ber of the SANE distribution that it came with.

       As you might imagine, much of the power of ssccaanniimmaaggee comes
       from the fact that it can control any SANE backend.  Thus,
       the exact set of command-line options depends on the capa-
       bilities of the selected device.  To see the options for a
       device named _d_e_v, invoke ssccaanniimmaaggee via a  command-line  of
       the form:

              scanimage --help --device _d_e_v

       The  documentation for the device-specific options printed
       by ----hheellpp is best explained with a few examples:

        --brightness -100..100% [0]
           Controls the brightness of the acquired image.

              The description above shows that  option  ----bbrriigghhtt--
              nneessss expects an option value in the range from -100
              to 100 percent.  The value in square brackets indi-
              cates that the current option value is 0 percent.

        --default-enhancements
           Set default values for enhancement controls.

              The  description above shows that option ----ddeeffaauulltt--
              eennhhaanncceemmeennttss has no option  value.   It  should  be
              thought  of  as  having  an immediate effect at the
              point of the command-line at which it appears.  For
              example,  since this option resets the ----bbrriigghhttnneessss
              option, the option-pair ----bbrriigghhttnneessss 5500  ----ddeeffaauulltt--
              eennhhaanncceemmeennttss would effectively be a no-op.

        --mode Lineart|Gray|Color [Gray]
           Selects the scan mode (e.g., lineart or color).

              The  description  above  shows  that  option ----mmooddee
              accepts an argument that must be one of the strings
              LLiinneeaarrtt,  GGrraayy,  or CCoolloorr.  The value in the square
              bracket indicates that the option is currently  set
              to  GGrraayy.  For convenience, it is legal to abbrevi-
              ate the  string  values  as  long  as  they  remain
              unique.   Also,  the  case  of the spelling doesn't
              matter.  For example, option setting ----mmooddee ccooll  is
              identical to ----mmooddee CCoolloorr.

        --custom-gamma[=(yes|no)] [inactive]
           Determines whether a builtin or a custom gamma-table
           should be used.

              The  description  above shows that option ----ccuussttoomm--
              ggaammmmaa expects  either  no  option  value,  a  "yes"
              string,  or  a  "no" string.  Specifying the option



                           4 March 1998                         2





scanimage(1)                                         scanimage(1)


              with no value is equivalent  to  specifying  "yes".
              The  value  in  square-brackets  indicates that the
              option is not currently active.  That is,  attempt-
              ing to set the option would result in an error mes-
              sage.   The  set  of  available  options  typically
              depends  on  the  settings  of  other options.  For
              example, the ----ccuussttoomm--ggaammmmaa table might  be  active
              only  when  a grayscale or color scan-mode has been
              requested.

              Note that the ----hheellpp option is processed only after
              all  other options have been processed.  This makes
              it possible to see the option settings for  a  par-
              ticular  mode  by  specifying the appropriate mode-
              options along with the ----hheellpp option.  For example,
              the command-line:

                scanimage --help --mode color

              would  print the option settings that are in effect
              when the color-mode is selected.

        --gamma-table 0..255,...
           Gamma-correction table.  In color mode this option
           equally affects the red, green, and blue channels
           simultaneously (i.e., it is an intensity gamma table).

              The  description  above  shows that option ----ggaammmmaa--
              ttaabbllee expects zero or more values in the range 0 to
              255.   For  example,  a legal value for this option
              would be "3,4,5,6,7,8,9,10,11,12".  Since it's cum-
              bersome  to  specify long vectors in this form, the
              same can  be  expressed  by  the  abbreviated  form
              "[0]3-[9]12".   What  this  means is that the first
              vector element is set to 0, the 9-th element is set
              to  12  and  the  values inbetween are interpolated
              linearly.  Of course, it  is  possible  to  specify
              multiple   such   linear  segments.   For  example,
              "[0]3-[2]3-[6]7,[7]10-[9]6"   is   equivalent    to
              "3,3,3,4,5,6,7,10,8,6".

        --filename <string> [/tmp/input.ppm]
           The filename of the image to be loaded.

              The  descriptoin  above  is an example of an option
              that takes an arbitrary string value (which happens
              to  be  a  filename).  Again, the value in brackets
              show that the option is current set to the filename
              //ttmmpp//iinnppuutt..ppppmm.


FFIILLEESS
       _/_u_s_r_/_l_o_c_a_l_/_e_t_c_/_s_a_n_e_._d
              This  directory  holds various configuration files.



                           4 March 1998                         3





scanimage(1)                                         scanimage(1)


              For details,  please  refer  to  the  manual  pages
              listed below.

SSEEEE AALLSSOO
       xscanimage(1),    xcam(1),    sane-dll(5),    sane-dmc(5),
       sane-epson(5),        sane-hp(5),        sane-microtek(5),
       sane-mustek(5),  sane-net(5),  sane-pnm(5),  sane-pint(5),
       sane-qcam(5), sane-umax(5)

AAUUTTHHOORR
       David Mosberger, Andreas Beck, and Gordon Matzigkeit

BBUUGGSS
       For vector options, the help output currently has no indi-
       cation as to how many elements a vector-value should have.










































                           4 March 1998                         4


