xsane - scanner frontend for SANE
provides a graphical user-interface to control an image acquisition
device such as a flatbed scanner. It allows previewing and scanning individual
images and can be invoked either directly from the command-line or through The
GIMP image manipulation program. In the former case, xsane
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) or converts the image to JPEG, PNG, PS or TIFF. In the latter case,
the images are directly passed to The GIMP for further processing.
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
presents a dialog listing all known and available
devices. To access an available device that is not known to the system, the
devicename must be specified explicitly. The format of devicename is
backendname:devicefile (eg: umax:/dev/sga).
To run xsane
under the gimp
(1), you should at first make sure that
xsane is compiled with gimp support by entering "xsane -v" on a
shell. If xsane is compiled with gimp support then simply set a symbolic link
from the xsane-binary to one of the gimp
(1) plug-ins directories. For
example, for gimp-1.0.x the command
ln -s @BINDIR@/xsane ~/.gimp/plug-ins/
for gimp 1.2.x the command:
ln -s @BINDIR@/xsane ~/.gimp-1.2/plug-ins/
and for gimp 2.0.x the command:
ln -s @BINDIR@/xsane ~/.gimp-2.0/plug-ins/
adds a symlink for the xsane
binary to the user's plug-ins directory.
After creating this symlink, xsane
will be queried by gimp
the next time it's invoked. From then on, xsane
can be invoked through
"Xtns->XSane->Device dialog..." (gimp-1.0.x) or through
"File->Acquire->XSane->Device dialog..." (gimp-1.2.x and
2.0.x) menu entry.
You'll also find that the "Xtns->XSane" or
"File->Acquire->XSane" menu contains short-cuts to the SANE
devices that were available at the time the xsane
was queried. Note
(1) caches these short-cuts in ~/.gimp/pluginrc. Thus, when
the list of available devices changes (e.g., a new scanner is installed or the
device of the scanner has changed), then it is typically desirable to rebuild
this cache. To do this, you can either touch
(1) the xsane
(e.g., "touch @BINDIR@/xsane") or delete the plugin cache (e.g.,
"rm ~/.gimp/pluginrc"). Either way, invoking gimp
afterwards will cause the pluginrc to be rebuilt.
is started from the gimp
then it is not possible to add
a devicename explicitly. You have to make the devices known to the system by
configuring sane-dll, sane-net
If the --version
flag is given xsane prints a version
information, some information about gtk+ and gimp version it is compiled
against and lists the supported file formats, then it exits.
when the --license
flag is given xsane prints license
information and exits.
flag reads the next option as default
filename for device settings. The extension ".drc" must not be
flag forces xsane to start in viewer mode.
flag forces xsane to start in save mode.
flag forces xsane to start in copy mode.
flag forces xsane to start in fax mode.
flag forces xsane to start in mail mode.
flag disables the menu for xsane
mode selection (viewer, save, copy, fax, mail).
If the --Fixed
flag is given then xsane uses a fixed, non
resizable main window. The flag overwrites the preferences value.
If the --Resizable
flag is given then xsane uses a scrolled
and resizable main window. The flag overwrites the preferences value.
flag is given then xsane prints the
names of created files to the standard output.
When the flag --force-filename
is given then xsane reads the
next option as default image filename. The name should be of the format
"name-###.ext". The selection box for filenames is disabled. This
option normally should be used with the option --no-mode-selection
flag selects the X11 display used to present the graphical
user-interface (see X
(1) for details).
flag requests a synchronous connection with the X11 server.
This is for debugging purposes only.
- is used to preselect the device in the device dialog. This way you only
have to accept the device (<ENTER> or OK-Button).
- This files holds the user preferences. Normally, this file should not be
manipulated directly. Instead, the user should customize the program
through the "Preferences" menu.
- For each device, there is one rc-file that holds the saved settings for
that particular device. Normally, this file should not be manipulated
directly. Instead, the user should use the xsane interface to
select appropriate values and then save the device settings using the
"Preferences->Save Device Settings" menubar entry.
- 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.
- This file serves the same purpose as the system-wide style file. If
present, it takes precedence over the system wide style file.
gimp(1), xscanimage(1), scanimage(1), sane-dll(5), sane-net(5), saned(1),
sane-scsi(5), sane-usb(5), sane-"backendname"(5)
Oliver Rauch <Oliver.Rauch@rauch-domain.de>