kopia lustrzana https://gitlab.com/sane-project/website
328 wiersze
17 KiB
HTML
328 wiersze
17 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>scanimage.1</TITLE>
|
|
</HEAD>
|
|
<BODY BGCOLOR=#FFFFFF TEXT=#000000><H1 ALIGN=CENTER><IMG SRC="../images/sane.png" HEIGHT=117 WIDTH=346></H1>
|
|
<H1>scanimage.1</H1>
|
|
<HR>
|
|
<PRE>
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
|
<B><A HREF="scanimage.1.html">scanimage(1)</A></B> SANE Scanner Access Now Easy <B><A HREF="scanimage.1.html">scanimage(1)</A></B>
|
|
|
|
|
|
</PRE>
|
|
<H2>NAME</H2><PRE>
|
|
scanimage - scan an image
|
|
|
|
|
|
</PRE>
|
|
<H2>SYNOPSIS</H2><PRE>
|
|
<B>scanimage</B> [<B>-d</B>|<B>--device-name</B> <I>dev</I>] [<B>--format</B> <I>format</I>] [<B>-i</B>|<B>--icc-profile</B>
|
|
<I>profile</I>] [<B>-L</B>|<B>--list-devices</B>] [<B>-f</B>|<B>--formatted-device-list</B> <I>format</I>]
|
|
[<B>-b</B>|<B>--batch</B> [=<I>format</I>]] [<B>--batch-start</B> <I>start</I>] [<B>--batch-count</B> <I>count</I>]
|
|
[<B>--batch-increment</B> <I>increment</I>] [<B>--batch-double</B>] [<B>--accept-md5-only</B>]
|
|
[<B>-p</B>|<B>--progress</B>] [<B>-o</B>|<B>--output-file</B>] [<B>-n</B>|<B>--dont-scan</B>] [<B>-T</B>|<B>--test</B>]
|
|
[<B>-A</B>|<B>--all-options</B>] [<B>-h</B>|<B>--help</B>] [<B>-v</B>|<B>--verbose</B>] [<B>-B</B>|<B>--buffer-size</B>
|
|
[=<I>size</I>]] [<B>-V</B>|<B>--version</B>] [<I>device-specific-options</I>]
|
|
|
|
|
|
</PRE>
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
<B>scanimage</B> is a command-line interface to control image acquisition de-
|
|
vices such as flatbed scanners or cameras. The device is controlled
|
|
via command-line options. After command-line processing, <B>scanimage</B>
|
|
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 im-
|
|
ages), TIFF format (black-and-white, grayscale or color), PNG format,
|
|
or JPEG format. <B>scanimage</B> accesses image acquisition devices through
|
|
the <B>SANE</B> (Scanner Access Now Easy) interface and can thus support any
|
|
device for which there exists a <B>SANE</B> backend (try <B>apropos</B> <I>sane-</I> to get
|
|
a list of available backends).
|
|
|
|
|
|
</PRE>
|
|
<H2>EXAMPLES</H2><PRE>
|
|
To get a list of devices:
|
|
|
|
scanimage -L
|
|
|
|
To scan with default settings to the file image.pnm:
|
|
|
|
scanimage >image.pnm
|
|
|
|
To scan 100x100 mm to the file image.tiff (-x and -y may not be avail-
|
|
able with all devices):
|
|
|
|
scanimage -x 100 -y 100 --format=tiff >image.tiff
|
|
|
|
To print all available options:
|
|
|
|
scanimage -h
|
|
|
|
|
|
</PRE>
|
|
<H2>OPTIONS</H2><PRE>
|
|
Parameters are separated by a blank from single-character options (e.g.
|
|
-d epson) and by a "=" from multi-character options (e.g. --de-
|
|
vice-name=epson).
|
|
|
|
The <B>-d</B> or <B>--device-name</B> options must be followed by a <B>SANE</B> device-name
|
|
like `<I>epson:/dev/sg0</I>' or `<I>hp:/dev/usbscanner0</I>'. A (partial) list of
|
|
available devices can be obtained with the <B>--list-devices</B> option (see
|
|
below). If no device-name is specified explicitly, <B>scanimage</B> reads a
|
|
device-name from the environment variable <B>SANE_DEFAULT_DEVICE</B>. If this
|
|
variable is not set, <B>scanimage</B> will attempt to open the first available
|
|
device.
|
|
|
|
The <B>--format</B> <I>format</I> option selects how image data is written to stan-
|
|
dard output or the file specified by the --output-file option. <I>format</I>
|
|
can be <B>pnm</B>, <B>tiff</B>, <B>png</B>, or <B>jpeg</B>. If <B>--format</B> is not specified, PNM is
|
|
written by default.
|
|
|
|
The <B>-i</B> or <B>--icc-profile</B> option is used to include an ICC profile into a
|
|
TIFF file.
|
|
|
|
The <B>-L</B> or <B>--list-devices</B> 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 <I>/usr/local/etc/sane.d</I>). This is par-
|
|
ticularly 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 admin-
|
|
istrator to find out the names of such devices.
|
|
|
|
The <B>-f</B> or <B>--formatted-device-list</B> option works similar to <B>--list-de-</B>
|
|
<B>vices</B>, but requires a format string. <B>scanimage</B> replaces the placehold-
|
|
ers <B>%d</B> <B>%v</B> <B>%m</B> <B>%t</B> <B>%i</B> <B>%n</B> with the device name, vendor name, model name,
|
|
scanner type, an index number and newline respectively. The command
|
|
|
|
<B>scanimage</B> <B>-f</B> <I>"</I> <I>scanner</I> <I>number</I> <I>%i</I> <I>device</I> <I>%d</I> <I>is</I> <I>a</I> <I>%t,</I> <I>model</I> <I>%m,</I>
|
|
<I>produced</I> <I>by</I> <I>%v</I> <I>"</I>
|
|
|
|
will produce something like:
|
|
|
|
scanner number 0 device sharp:/dev/sg1 is a flatbed scanner,
|
|
model JX250 SCSI, produced by SHARP
|
|
|
|
The <B>--batch*</B> options provide the features for scanning documents using
|
|
document feeders. <B>--batch</B> [<I>format</I>] is used to specify the format of
|
|
the filename that each page will be written to. Each page is written
|
|
out to a single file. If <I>format</I> is not specified, the default of
|
|
out%d.pnm (or out%d.tif for --format tiff, out%d.png for --format png
|
|
or out%d.jpg for -- format jpeg) will be used. This option is incom-
|
|
patible with the --output-path option. <I>format</I> is given as a printf
|
|
style string with one integer parameter. <B>--batch-start</B> <I>start</I> selects
|
|
the page number to start naming files with. If this option is not
|
|
given, the counter will start at 1. <B>--batch-count</B> <I>count</I> specifies the
|
|
number of pages to attempt to scan. If not given, scanimage will con-
|
|
tinue scanning until the scanner returns a state other than OK. Not
|
|
all scanners with document feeders signal when the ADF is empty, use
|
|
this command to work around them. With <B>--batch-increment</B> <I>increment</I> you
|
|
can change the amount that the number in the filename is incremented
|
|
by. Generally this is used when you are scanning double-sided docu-
|
|
ments on a single-sided document feeder. A specific command is pro-
|
|
vided to aid this: <B>--batch-double</B> will automatically set the increment
|
|
to 2. <B>--batch-prompt</B> will ask for pressing RETURN before scanning a
|
|
page. This can be used for scanning multiple pages without an automatic
|
|
document feeder.
|
|
|
|
The <B>--accept-md5-only</B> option only accepts user authorization requests
|
|
that support MD5 security. The <B>SANE</B> network daemon (<B>saned</B>) is capable
|
|
of doing such requests. See <B><A HREF="saned.8.html">saned(8)</A></B>.
|
|
|
|
The <B>-p</B> or <B>--progress</B> option requests that <B>scanimage</B> prints a progress
|
|
counter. It shows how much image data of the current image has already
|
|
been received by <B>scanimage</B> (in percent).
|
|
|
|
The <B>-o</B> or <B>--output-file</B> option requests that <B>scanimage</B> saves the scan-
|
|
ning output to the given path. This option is incompatible with the
|
|
--batch option. The program will try to guess --format from the file
|
|
name. If that is not possible, it will print an error message and
|
|
exit.
|
|
|
|
The <B>-n</B> or <B>--dont-scan</B> option requests that <B>scanimage</B> only sets the op-
|
|
tions provided by the user but doesn't actually perform a scan. This
|
|
option can be used to e.g. turn off the scanner's lamp (if supported by
|
|
the backend).
|
|
|
|
The <B>-T</B> or <B>--test</B> option requests that <B>scanimage</B> performs a few simple
|
|
sanity tests to make sure the backend works as defined by the <B>SANE</B> API
|
|
(in particular the <B>sane_read</B> function is exercised by this test).
|
|
|
|
The <B>-A</B> or <B>--all-options</B> option requests that <B>scanimage</B> lists all avail-
|
|
able options exposed the backend, including button options. The infor-
|
|
mation is printed on standard output and no scan will be done.
|
|
|
|
The <B>-h</B> or <B>--help</B> 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 <B>-v</B> or <B>--verbose</B> options increase the verbosity of the operation of
|
|
<B>scanimage.</B> The option may be specified repeatedly, each time increas-
|
|
ing the verbosity level.
|
|
|
|
The <B>-B</B> option without argument changes the input buffer size from the
|
|
default 32KB to 1MB. For finer grained control, use <B>--buffer-size=</B>
|
|
followed by the number of KB.
|
|
|
|
The <B>-V</B> or <B>--version</B> option requests that <B>scanimage</B> prints the program
|
|
and package name, the version number of the <B>SANE</B> distribution that it
|
|
came with and the version of the backend that it loads. Usually that's
|
|
the dll backend. If more information about the version numbers of the
|
|
backends are necessary, the <B>DEBUG</B> variable for the dll backend can be
|
|
used. Example: SANE_DEBUG_DLL=3 scanimage -L.
|
|
|
|
As you might imagine, much of the power of <B>scanimage</B> comes from the
|
|
fact that it can control any <B>SANE</B> backend. Thus, the exact set of com-
|
|
mand-line options depends on the capabilities of the selected device.
|
|
To see the options for a device named <I>dev</I>, invoke <B>scanimage</B> via a com-
|
|
mand-line of the form:
|
|
|
|
<B>scanimage</B> <B>--help</B> <B>--device-name</B> <I>dev</I>
|
|
|
|
The documentation for the device-specific options printed by <B>--help</B> is
|
|
best explained with a few examples:
|
|
|
|
-l 0..218mm [0]
|
|
Top-left x position of scan area.
|
|
|
|
The description above shows that option <B>-l</B> expects an option
|
|
value in the range from 0 to 218 mm. The value in square brack-
|
|
ets indicates that the current option value is 0 mm. Most back-
|
|
ends provide similar geometry options for top-left y position
|
|
(-t), width (-x) and height of scan-area (-y).
|
|
|
|
--brightness -100..100% [0]
|
|
Controls the brightness of the acquired image.
|
|
|
|
The description above shows that option <B>--brightness</B> expects an
|
|
option value in the range from -100 to 100 percent. The value
|
|
in square brackets indicates that the current option value is 0
|
|
percent.
|
|
|
|
--default-enhancements
|
|
Set default values for enhancement controls.
|
|
|
|
The description above shows that option <B>--default-enhancements</B>
|
|
has no option value. It should be thought of as having an imme-
|
|
diate effect at the point of the command-line at which it ap-
|
|
pears. For example, since this option resets the <B>--brightness</B>
|
|
option, the option-pair <B>--brightness</B> <B>50</B> <B>--default-enhancements</B>
|
|
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 <B>--mode</B> accepts an argu-
|
|
ment that must be one of the strings <B>Lineart</B>, <B>Gray</B>, or <B>Color</B>.
|
|
The value in the square bracket indicates that the option is
|
|
currently set to <B>Gray</B>. 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 set-
|
|
ting <B>--mode</B> <B>col</B> is identical to <B>--mode</B> <B>Color</B>.
|
|
|
|
--custom-gamma[=(yes|no)] [inactive]
|
|
Determines whether a builtin or a custom gamma-table
|
|
should be used.
|
|
|
|
The description above shows that option <B>--custom-gamma</B> expects
|
|
either no option value, a "yes" string, or a "no" string. Spec-
|
|
ifying the option with no value is equivalent to specifying
|
|
"yes". The value in square-brackets indicates that the option
|
|
is not currently active. That is, attempting to set the option
|
|
would result in an error message. The set of available options
|
|
typically depends on the settings of other options. For exam-
|
|
ple, the <B>--custom-gamma</B> table might be active only when a
|
|
grayscale or color scan-mode has been requested.
|
|
|
|
Note that the <B>--help</B> option is processed only after all other
|
|
options have been processed. This makes it possible to see the
|
|
option settings for a particular mode by specifying the appro-
|
|
priate mode-options along with the <B>--help</B> option. For example,
|
|
the command-line:
|
|
|
|
<B>scanimage</B> <B>--help</B> <B>--mode</B> <I>color</I>
|
|
|
|
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 <B>--gamma-table</B> 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 cumbersome 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 3, the
|
|
9-th element is set to 12 and the values in between are interpo-
|
|
lated 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". The program
|
|
<B>gamma4scanimage</B> can be used to generate such gamma tables (see
|
|
<B><A HREF="gamma4scanimage.1.html">gamma4scanimage(1)</A></B> for details).
|
|
|
|
--filename <string> [/tmp/input.ppm]
|
|
The filename of the image to be loaded.
|
|
|
|
The description 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 <B>/tmp/input.ppm</B>.
|
|
|
|
|
|
</PRE>
|
|
<H2>ENVIRONMENT</H2><PRE>
|
|
<B>SANE_DEFAULT_DEVICE</B>
|
|
The default device-name.
|
|
|
|
|
|
</PRE>
|
|
<H2>FILES</H2><PRE>
|
|
<I>/usr/local/etc/sane.d</I>
|
|
This directory holds various configuration files. For details,
|
|
please refer to the manual pages listed below.
|
|
|
|
<I>~/.sane/pass</I>
|
|
This file contains lines of the form
|
|
|
|
user:password:resource
|
|
|
|
scanimage uses this information to answer user authorization re-
|
|
quests automatically. The file must have 0600 permissions or
|
|
stricter. You should use this file in conjunction with the --ac-
|
|
cept-md5-only option to avoid server-side attacks. The resource
|
|
may contain any character but is limited to 127 characters.
|
|
|
|
|
|
</PRE>
|
|
<H2>SEE ALSO</H2><PRE>
|
|
<B><A HREF="sane.7.html">sane(7)</A></B>, <B><A HREF="gamma4scanimage.1.html">gamma4scanimage(1)</A></B>, <B><A HREF="xscanimage.1.html">xscanimage(1)</A></B>, <B>xcam(1)</B>, <B>xsane(1)</B>,
|
|
<B><A HREF="scanadf.1.html">scanadf(1)</A></B>, <B><A HREF="sane-dll.5.html">sane-dll(5)</A></B>, <B><A HREF="sane-net.5.html">sane-net(5)</A></B>, <B>sane-"backendname"</B>(5)
|
|
|
|
|
|
</PRE>
|
|
<H2>AUTHOR</H2><PRE>
|
|
David Mosberger, Andreas Beck, Gordon Matzigkeit, Caskey Dickson, and
|
|
many others. For questions and comments contact the sane-devel mail-
|
|
inglist (see http://www.sane-project.org/mailing-lists.html).
|
|
|
|
|
|
</PRE>
|
|
<H2>BUGS</H2><PRE>
|
|
For vector options, the help output currently has no indication as to
|
|
how many elements a vector-value should have.
|
|
|
|
10 Jul 2008 <B><A HREF="scanimage.1.html">scanimage(1)</A></B>
|
|
</PRE>
|
|
<HR>
|
|
<ADDRESS>
|
|
Man(1) output converted with
|
|
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
|
</ADDRESS>
|
|
</BODY>
|
|
</HTML>
|