1xsane(1) General Commands Manual xsane(1)
2
6 xsane - scanner frontend for SANE
7
9 xsane [--version|-v] [--license|-l] [--device-settings file |-d file]
10 [--viewer|-V] [--save|-s] [--copy|-c] [--fax|-f] [--mail|-m] [--no-
11 mode-selection|-n] [--Fixed|-F] [--Resizable|-R] [--print-filenames|-p]
12 [--force-filename name |-N name] [--display d] [--sync] [devicename]
13
15 xsane provides a graphical user-interface to control an image acquisi‐
16 tion device such as a flatbed scanner. It allows previewing and scan‐
17 ning individual images and can be invoked either directly from the com‐
18 mand-line or through The GIMP image manipulation program. In the for‐
19 mer case, xsane acts as a stand-alone program that saves acquired
20 images in a suitable PNM format (PBM for black-and-white images, PGM
21 for grayscale images, and PPM for color images) or converts the image
22 to JPEG, PNG, PS or TIFF. In the latter case, the images are directly
23 passed to The GIMP for further processing.
24 xsane accesses image acquisition devices through the SANE (Scanner
26 Access Now Easy) interface. The list of available devices depends on
27 installed hardware and configuration. When invoked without an explicit
28 devicename argument, xsane presents a dialog listing all known and
29 available devices. To access an available device that is not known to
30 the system, the devicename must be specified explicitly. The format of
31 devicename is backendname:devicefile (eg: umax:/dev/sga).
32
34 To run xsane under the gimp(1), you should at first make sure that
35 xsane is compiled with gimp support by entering "xsane -v" on a shell.
36 If xsane is compiled with gimp support then simply set a symbolic link
37 from the xsane-binary to one of the gimp(1) plug-ins directories. For
38 example, for gimp-1.0.x the command
39 ln -s /usr/bin/xsane ~/.gimp/plug-ins/
41 for gimp 1.2.x the command:
43 ln -s /usr/bin/xsane ~/.gimp-1.2/plug-ins/
45 and for gimp 2.0.x the command:
47 ln -s /usr/bin/xsane ~/.gimp-2.0/plug-ins/
49 adds a symlink for the xsane binary to the user's plug-ins directory.
51 After creating this symlink, xsane will be queried by gimp(1) the next
52 time it's invoked. From then on, xsane can be invoked through
53 "Xtns->XSane->Device dialog..." (gimp-1.0.x) or through
54 "File->Acquire->XSane->Device dialog..." (gimp-1.2.x and 2.0.x) menu
55 entry.
56 You'll also find that the "Xtns->XSane" or "File->Acquire->XSane" menu
58 contains short-cuts to the SANE devices that were available at the time
59 the xsane was queried. Note that gimp(1) caches these short-cuts in
60 ~/.gimp/pluginrc. Thus, when the list of available devices changes
61 (e.g., a new scanner is installed or the device of the scanner has
62 changed), then it is typically desirable to rebuild this cache. To do
63 this, you can either touch(1) the xsane binary (e.g., "touch
64 /usr/bin/xsane") or delete the plugin cache (e.g., "rm ~/.gimp/plug‐
65 inrc"). Either way, invoking gimp(1) afterwards will cause the plug‐
66 inrc to be rebuilt.
67 When xsane is started from the gimp then it is not possible to add a
69 devicename explicitly. You have to make the devices known to the system
70 by configuring sane-dll, sane-net and saned.
71
74 If the --version or -v flag is given xsane prints a version informa‐
75 tion, some information about gtk+ and gimp version it is compiled
76 against and lists the supported fileformats, then it exits.
77 when the --license or -l flag is igven xsane prints license information
79 and exits.
80 The --device-settings or -d flag reads the next option as default file‐
82 name for device settings. The extension ".drc" must not be included.
83 The --viewer or -V flag forces xsane to start in viewer mode.
85 The --save or -s flag forces xsane to start in save mode.
87 The --copy or -c flag forces xsane to start in copy mode.
89 The --fax or -f flag forces xsane to start in fax mode.
91 The --mail or -m flag forces xsane to start in mail mode.
93 The --no-mode-selection or -n flag disables the menu for xsane mode
95 selection (viwer, save, copy, fax, mail).
96 If the --Fixed or -F flag is given then xsane uses a fixed, non resiz‐
98 able main window. The flag overwrites the preferences value.
99 If the --Resizable or -R flag is given then xsane uses a scrolled and
101 resizable main window. The flag overwrites the preferences value.
102 If --print-filenames or -p flag is given then xsane prints the names of
104 created files to the standard output.
105 When the flag --force-filename or -N is given then xsane reads the next
107 option as default image filename. The name should be of the format
108 "name-###.ext". The selection box for filenames is disabled. This
109 option normally should be used with the option --no-mode-selection and
110 --save.
111 The --display flag selects the X11 display used to present the graphi‐
113 cal user-interface (see X(1) for details).
114 The --sync flag requests a synchronous connection with the X11 server.
116 This is for debugging purposes only.
117
119 SANE_DEFAULT_DEVICE
120 is used to preselect the device in the device dialog. This way
121 you only have to accept the device (<ENTER> or OK-Button).
122
125 $HOME/.sane/xsane/xsane.rc
126 This files holds the user preferences. Normally, this file
127 should not be manipulated directly. Instead, the user should
128 customize the program through the "Preferences" menu.
129 $HOME/.sane/xsane/devicename.rc
131 For each device, there is one rc-file that holds the saved set‐
132 tings for that particular device. Normally, this file should
133 not be manipulated directly. Instead, the user should use the
134 xsane interface to select appropriate values and then save the
135 device settings using the "Preferences->Save Device Settings"
136 menubar entry.
137 /usr/share/sane/xsane/xsane-style.rc
139 This system-wide file controls the aspects of the user-interface
140 such as colors and fonts. It is a GTK style file and provides
141 fine control over the visual aspects of the user-interface.
142 $HOME/.sane/xsane/xsane-style.rc
144 This file serves the same purpose as the system-wide style file.
145 If present, it takes precedence over the system wide style file.
146
148 gimp(1), xscanimage(1), scanimage(1), sane-dll(5), sane-net(5),
149 saned(1), sane-scsi(5), sane-usb(5), sane-"backendname"(5)
150
152 Oliver Rauch <Oliver.Rauch@rauch-domain.de>
153 15 Jun 2002 xsane(1)