2003-09-23 15:30:05 +00:00
|
|
|
<HTML>
|
|
|
|
|
<HEAD>
|
|
|
|
|
<TITLE>xscanimage.1</TITLE>
|
|
|
|
|
</HEAD>
|
2003-10-15 14:33:32 +00:00
|
|
|
<BODY BGCOLOR=#FFFFFF TEXT=#000000><H1 ALIGN=CENTER><IMG SRC="/images/sane.png" HEIGHT=117 WIDTH=346></H1>
|
2003-09-23 15:30:05 +00:00
|
|
|
<H1>xscanimage.1</H1>
|
|
|
|
|
<HR>
|
|
|
|
|
<PRE>
|
|
|
|
|
<!-- Manpage converted by man2html 3.0.1 -->
|
2003-10-15 14:33:32 +00:00
|
|
|
<B><A HREF="xscanimage.1.html">xscanimage(1)</A></B> <B><A HREF="xscanimage.1.html">xscanimage(1)</A></B>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>NAME</H2><PRE>
|
|
|
|
|
xscanimage - scan an image
|
2003-09-23 15:30:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SYNOPSIS</H2><PRE>
|
|
|
|
|
<B>xscanimage</B> [<B>--version</B>|<B>-V</B>] [<B>--help</B>|<B>-h</B>] [<B>--display</B> <I>d</I>] [<B>--no-xshm</B>]
|
|
|
|
|
[<B>--sync</B>] [<I>devicename</I>]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>DESCRIPTION</H2><PRE>
|
|
|
|
|
<B>xscanimage</B> provides a graphical user-interface to control an image
|
|
|
|
|
acquisition device such as a flatbed scanner or a camera. It allows
|
|
|
|
|
previewing and scanning invidual images and can be invoked either
|
|
|
|
|
directly from the command-line or through The GIMP image manipulation
|
|
|
|
|
program. In the former case, <B>xscanimage</B> acts as a stand-alone program
|
|
|
|
|
that saves acquired images in a suitable PNM format (PBM for black-and-
|
|
|
|
|
white images, PGM for grayscale images, and PPM for color images). In
|
|
|
|
|
the latter case, the images are directly passed to The GIMP for further
|
|
|
|
|
processing.
|
|
|
|
|
|
|
|
|
|
<B>xscanimage</B> accesses image acquisition devices through the SANE (Scanner
|
|
|
|
|
Access Now Easy) interface. The list of available devices depends on
|
|
|
|
|
installed hardware and configuration. When invoked without an explicit
|
|
|
|
|
devicename argument, <B>xscanimage</B> presents a dialog listing of all known
|
|
|
|
|
and available devices. If the environment variable SANE_DEFAULT_DEVICE
|
|
|
|
|
is set to the devicename, the device is preselected in the dialog. To
|
|
|
|
|
access an available device that is not known to the system, the device-
|
|
|
|
|
name must be specified explicitly. The format of devicename is backend-
|
|
|
|
|
name:devicefile (e.g. umax:/dev/sga).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>RUNNING UNDER THE GIMP</H2><PRE>
|
|
|
|
|
To run <B>xscanimage</B> under the <B><A HREF="gimp.1.html">gimp(1)</A></B>, simply copy it to one of the
|
|
|
|
|
<B><A HREF="gimp.1.html">gimp(1)</A></B> plug-ins directories. If you want to conserve disk-space, you
|
|
|
|
|
can create a symlink instead. For example, for gimp-1.0.x the command
|
|
|
|
|
|
|
|
|
|
ln -s /usr/local/bin/xscanimage ~/.gimp/plug-ins/
|
|
|
|
|
|
|
|
|
|
and for gimp-1.2.x the command
|
|
|
|
|
|
|
|
|
|
ln -s /usr/local/bin/xscanimage ~/.gimp-1.2/plug-ins/
|
|
|
|
|
|
|
|
|
|
adds a symlink for the <B>xscanimage</B> binary to the user's plug-ins direc-
|
|
|
|
|
tory. After creating this symlink, <B>xscanimage</B> will be queried by
|
|
|
|
|
<B><A HREF="gimp.1.html">gimp(1)</A></B> the next time it's invoked. From then on, <B>xscanimage</B> can be
|
|
|
|
|
invoked through "File->Acquire->Xscanimage->Device dialog..." menu
|
|
|
|
|
entry.
|
|
|
|
|
|
|
|
|
|
You'll also find that the "File->Acquire->Xscanimage" menu contains
|
|
|
|
|
short-cuts to the SANE devices that were available at the time <B>xscanim-</B>
|
|
|
|
|
<B>age</B> was queried. For example, the first PNM pseudo-device is typically
|
|
|
|
|
available as the short-cut "File->Acquire->Xscanimage->pnm:0". Note
|
|
|
|
|
that <B><A HREF="gimp.1.html">gimp(1)</A></B> caches these short-cuts in ~/.gimp/pluginrc. Thus, when
|
|
|
|
|
the list of available devices changes (e.g., a new scanner is
|
|
|
|
|
installed), then it is typically desirable to rebuild this cache. To
|
|
|
|
|
do this, you can either <B><A HREF="touch.1.html">touch(1)</A></B> the <B>xscanimage</B> binary (e.g., "touch
|
|
|
|
|
/usr/local/bin/xscanimage") or delete the plug-ins cache (e.g., "rm
|
|
|
|
|
~/.gimp/plug-ins"). Either way, invoking <B><A HREF="gimp.1.html">gimp(1)</A></B> afterwards will cause
|
|
|
|
|
the pluginrc to be rebuilt.
|
2003-10-15 14:33:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>OPTIONS</H2><PRE>
|
|
|
|
|
If the <B>--version</B> <B>(-V)</B> option is given, <B>xscanimage</B> will output its ver-
|
|
|
|
|
sion number.
|
|
|
|
|
|
|
|
|
|
The <B>--help</B> <B>(-h)</B> flag prints a short summary of options.
|
|
|
|
|
|
|
|
|
|
The <B>--display</B> flag selects the X11 display used to present the graphi-
|
|
|
|
|
cal user-interface (see <B><A HREF="X.1.html">X(1)</A></B> for details).
|
|
|
|
|
|
|
|
|
|
The <B>--no-xshm</B> flag requests not to use shared memory images. Shared
|
|
|
|
|
memory images usually enhance performance but cause problems with some
|
2003-09-23 15:30:05 +00:00
|
|
|
buggy X11 servers. Unless your X11 server dies when running this pro-
|
|
|
|
|
gram, there is no need or advantage to specify this flag.
|
|
|
|
|
|
|
|
|
|
The <B>--sync</B> flag requests a synchronous connection with the X11 server.
|
|
|
|
|
This is for debugging purposes only.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>ENVIRONMENT</H2><PRE>
|
|
|
|
|
<B>SANE_DEFAULT_DEVICE</B>
|
|
|
|
|
The default device-name. Example:
|
|
|
|
|
SANE_DEFAULT_DEVICE="hp:/dev/scanner".
|
|
|
|
|
|
|
|
|
|
<B>SANE_DEBUG_XSCANIMAGE</B>
|
|
|
|
|
This environment variable controls the debug level xscanimage.
|
|
|
|
|
Higher debug levels increase the verbosity of the output.
|
|
|
|
|
|
|
|
|
|
Value Descsription
|
|
|
|
|
0 print fatal errors
|
|
|
|
|
1 print errors
|
|
|
|
|
2 print warnings
|
|
|
|
|
3 print information messages
|
|
|
|
|
4 print everything
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
SANE_DEBUG_XSCANIMAGE=3
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>FILES</H2><PRE>
|
|
|
|
|
<I>$HOME/.sane/xscanimage/xscanimage.rc</I>
|
|
|
|
|
This files holds the user preferences. Normally, this file
|
|
|
|
|
should not be manipulated directly. Instead, the user should
|
|
|
|
|
customize the program through the "Preferences" dialog.
|
|
|
|
|
|
|
|
|
|
<I>$HOME/.sane/xscanimage/devicename.rc</I>
|
|
|
|
|
For each device, there is one rc-file that holds the saved set-
|
|
|
|
|
tings for that particular device. Normally, this file should
|
|
|
|
|
not be manipulated directly. Instead, the user should use the
|
|
|
|
|
<B>xscanimage</B> interface to select appropriate values and then save
|
|
|
|
|
the device settings using the "Preferences->Save Device Set-
|
|
|
|
|
tings" menubar entry.
|
|
|
|
|
|
|
|
|
|
<I>$HOME/.sane/preview-devicename.ppm</I>
|
|
|
|
|
After acquiring a preview, <B>xscanimage</B> normally saves the preview
|
|
|
|
|
image in this device-specific file. Thus, next time the program
|
|
|
|
|
is started up, the program can present the old preview image.
|
|
|
|
|
This feature can be turned off through the "Preferences->Preview
|
|
|
|
|
Options..." dialog.
|
|
|
|
|
|
|
|
|
|
<I>/usr/local/share/sane-style.rc</I>
|
|
|
|
|
This system-wide file controls the aspects of the user-interface
|
|
|
|
|
such as colors and fonts. It is a GTK style file and provides
|
|
|
|
|
fine control over the visual aspects of the user-interface.
|
|
|
|
|
|
|
|
|
|
<I>$HOME/.sane/sane-style.rc</I>
|
|
|
|
|
This file serves the same purpose as the system-wide style file.
|
|
|
|
|
If present, it takes precedence over the system wide style file.
|
2003-10-15 14:33:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
|
|
|
|
<B><A HREF="sane.7.html">sane(7)</A></B>, <B><A HREF="gimp.1.html">gimp(1)</A></B>, <B><A HREF="xcam.1.html">xcam(1)</A></B>, <B><A HREF="scanimage.1.html">scanimage(1)</A></B>, <B><A HREF="scanadf.1.html">scanadf(1)</A></B>, <B><A HREF="sane-scsi.5.html">sane-scsi(5)</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>, sane-"backendname"(5)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>AUTHOR</H2><PRE>
|
|
|
|
|
Tristan Tarrant, Andreas Beck, David Mosberger, and Henning Meier-
|
|
|
|
|
Geinitz
|
|
|
|
|
|
|
|
|
|
1 Feb 2003 <B><A HREF="xscanimage.1.html">xscanimage(1)</A></B>
|
2003-09-23 15:30:05 +00:00
|
|
|
</PRE>
|
|
|
|
|
<HR>
|
|
|
|
|
<ADDRESS>
|
|
|
|
|
Man(1) output converted with
|
|
|
|
|
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
|
|
|
|
|
</ADDRESS>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
