1SCANADF-PERL(1) User Contributed Perl Documentation SCANADF-PERL(1)
2
6 scanadf - acquire multiple images from a scanner equipped with an ADF
7
9 scanadf [ -d | --device-name dev ] [ -h | --help ] [ -L |
10 --list-devices ] [ -v | --verbose ] [ -V | --version ] [ -o |
11 --output-file name ] [ -N | --no-overwrite ] [ -S | --scan-script name
12 ] [ --script-wait ] [ -s | --start-count num ] [ -e | --end-count num ]
13 [ -r | --raw ] [ device-specific-options ]
14
16 scanadf is a command-line interface to control image acquisition
17 devices which are capable of returning a series of images (e.g. a
18 scanner with an automatic document feeder (ADF)). The device is
19 controlled via command-line options. After command-line processing,
20 scanadf normally proceeds to acquire a series of images until the
21 device returns the SANE_STATUS_NO_DOCS status code.
22 The images are written to output files, specified by the --output-file
24 option. These files are typically written in one of the PNM (portable
25 aNyMaP) formats (PBM for black-and-white images, PGM for grayscale
26 images, and PPM for color images). Several optional frame formats
27 (SANE_FRAME_JPEG, SANE_FRAME_G31D, SANE_FRAME_G32D, SANE_FRAME_G42D,
28 and SANE_FRAME_TEXT) are supported. In each case, the data is written
29 out to the output file as-is without a header. Unrecognized frame
30 formats are handled in the same way, although a warning message is
31 printed in verbose mode.
32 Typically, the optional frame formats are used in conjunction with a
34 scan script (specified by the --scanscript option) which is invoked for
35 each acquired image. The script is provided with a series of
36 environment variables which describe the parameters and format of the
37 image file.
38 scanadf accesses image acquisition devices through the SANE (Scanner
40 Access Now Easy) interface and can thus support any device for which
41 there exists a SANE backend (try "apropos sane\-" to get a list of
42 available backends).
43
45 The -d or --device-name options must be followed by a SANE device-name.
46 A (partial) list of available devices can be obtained with the
47 --list-devices option (see below). If no device-name is specified
48 explicitly, scanadf will attempt to open the first available device.
49 The -h or --help options request help information. The information is
51 printed on standard output and in this case, no attempt will be made to
52 acquire an image.
53 The -L or --list-devices option requests a (partial) list of devices
55 that are available. The list is not complete since some devices may be
56 available, but are not listed in any of the configuration files (which
57 are typically stored in directory /etc/sane.d). This is particularly
58 the case when accessing scanners through the network. If a device is
59 not listed in a configuration file, the only way to access it is by its
60 full device name. You may need to consult your system administrator to
61 find out the names of such devices.
62 The -v or --verbose options increase the verbosity of the operation of
64 scanadf. The option may be specified repeatedly, each time increasing
65 the verbosity level.
66 The -V or --version option requests that scanadf print the program and
68 package name, as well as the version number of the SANE distribution
69 that it came with.
70 The -o or --output-file option specifies a format string used to
72 generate the name of file to write the image data to. You can use %d
73 replacement in the output file name; this will be replaced with the
74 current page number. The default format string is image-%04d.
75 The -N or --no-overwrite option prevents scanadf from overwriting
77 existing image files.
78 The -S or --scan-script option specifies the name of script to run
80 after each scanned image is acquired. The script receives the name of
81 the image output file as its first and only command line argument.
82 Additionally the scan script can reference the following environment
83 variables to get information about the parameters of the image.
84 SCAN_RES
86 - the image resolution (in DPI)
87 SCAN_WIDTH
89 - the image width (in pixels)
90 SCAN_HEIGHT
92 - the image height (in pixels)
93 SCAN_DEPTH
95 - the image bit-depth (in bits)
96 SCAN_FORMAT
98 - a string representing the image format (e.g. gray, g42d, text,
99 etc)
100 SCAN_FORMAT_ID
102 - the numeric image format identifier
103 If the --scipt-wait option is given, scanadf will wait until all scan-
105 scripts have been finished before exiting. That will be useful if
106 scanadf is used in conjunction with tools to modify the scanned images.
107 The -s or --start-count option specifies the page number of first
109 scanned image.
110 The -e or --end-count option specifies the last page number to scan.
112 Using this option, you can request a specific number of pages to be
113 scanned, rather than scanning until there are no more images available.
114 The -r or --raw option specifies that the raw image data be written to
116 the output file as-is without interpretation. This disables the
117 writing of the PNM header for basic frame types. This feature is
118 usually used in conjunction with the --scan-script option where the
119 scan script uses the environment variables to understand the format and
120 parameters of the image and converts the file to a more useful format.
121 NOTE: With support for the optional frame types and the default
122 handling of unrecognized frametypes, this option becomes less and less
123 useful.
124 As you might imagine, much of the power of scanadf comes from the fact
126 that it can control any SANE backend. Thus, the exact set of command-
127 line options depends on the capabilities of the selected device. To
128 see the options for a device named dev , invoke scanadf via a command-
129 line of the form:
130 scanadf --help --device dev
132 The documentation for the device-specific options printed by --help is
134 explained in the manual page for scanimage.
135
137 /etc/sane.d
138 This directory holds various configuration files. For details,
139 please refer to the manual pages listed below.
140
142 scanimage(1), xscanimage(1), sane(7)
143
145 Transliterated from the C original by Jeffrey Ratcliffe.
146
148 All the bugs of scanadf and much, much more.
149 This program relies on the backend to return the SANE_STATUS_NO_DOCS
151 status code when the automatic document feeder is out of paper. Use of
152 this program with backends that do not support ADFs (e.g. flatbed
153 scanners) will likely result in repeated scans of the same document.
154 In this case, it is essential to use the start-count and end-count to
155 control the number of images acquired.
156 Only a subset of the SANE backends support feeders and return
158 SANE_STATUS_NO_DOCS appropriately. Backends which are known to work at
159 this time are:
160 sane-bh
162 - Bell+Howell Copiscan II series scanners.
163 sane-hp
165 - Hewlett Packard scanners. A patch to the sane-hp backend is
166 necessary. The --scantype=ADF option must be specified (earlier
167 versions of the backend used the --scan-from-adf option, instead).
168 sane-umax
170 - UMAX scanners. Support exists in build 12 and later. The
171 --source="Automatic Document Feeder" option must be specified.
172perl v5.12.4 2009-11-24 SCANADF-PERL(1)