1xsane(1)                    General Commands Manual                   xsane(1)
2
3
4

NAME

6       xsane - scanner frontend for SANE
7

SYNOPSIS

9       xsane [--help|-h] [--version|-v] [--license|-l] [--device-settings file
10       |-d  file]  [--viewer|-V]  [--save|-s]   [--copy|-c]   [--multipage|-m]
11       [--fax|-f] [--email|-e] [--no-mode-selection|-n] [--Fixed|-F] [--Resiz‐
12       able|-R]  [--print-filenames|-p]  [--force-filename  name   |-N   name]
13       [--display d] [--no-xshm] [--sync] [devicename]
14

DESCRIPTION

16       xsane  provides a graphical user-interface to control an image acquisi‐
17       tion device such as a flatbed scanner.  It allows previewing and  scan‐
18       ning individual images and can be invoked either directly from the com‐
19       mand-line or through The GIMP image manipulation program.  In the  for‐
20       mer  case,  xsane  acts  as  a  stand-alone program that saves acquired
21       images in a suitable PNM format (PBM for  black-and-white  images,  PGM
22       for  grayscale  images, and PPM for color images) or converts the image
23       to JPEG, PNG, PS or TIFF.  In the latter case, the images are  directly
24       passed to The GIMP for further processing.
25
26       xsane  accesses  image  acquisition  devices  through the SANE (Scanner
27       Access Now Easy) interface.  The list of available devices  depends  on
28       installed hardware and configuration.  When invoked without an explicit
29       devicename argument, xsane presents a  dialog  listing  all  known  and
30       available  devices.  To access an available device that is not known to
31       the system, the devicename must be specified explicitly. The format  of
32       devicename is backendname:devicefile (eg: umax:/dev/sga).
33

RUNNING UNDER THE GIMP

35       To  run  xsane  under  the  gimp(1), you should at first make sure that
36       xsane is compiled with gimp support by entering "xsane -v" on a  shell.
37       If  xsane is compiled with gimp support then simply set a symbolic link
38       from the xsane-binary to one of the gimp(1) plug-ins directories.   For
39       example, for gimp-1.0.x the command
40
41              ln -s /usr/bin/xsane ~/.gimp/plug-ins/
42
43       for gimp 1.2.x the command:
44
45              ln -s /usr/bin/xsane ~/.gimp-1.2/plug-ins/
46
47       and for gimp 2.0.x the command:
48
49              ln -s /usr/bin/xsane ~/.gimp-2.0/plug-ins/
50
51       adds  a  symlink for the xsane binary to the user's plug-ins directory.
52       After creating this symlink, xsane will be queried by gimp(1) the  next
53       time  it's  invoked.   From  then  on,  xsane  can  be  invoked through
54       "Xtns->XSane->Device     dialog..."     (gimp-1.0.x)     or     through
55       "File->Acquire->XSane->Device  dialog..."  (gimp-1.2.x  and 2.0.x) menu
56       entry.
57
58       You'll also find that the "Xtns->XSane" or "File->Acquire->XSane"  menu
59       contains short-cuts to the SANE devices that were available at the time
60       the xsane was queried.  Note that gimp(1) caches  these  short-cuts  in
61       ~/.gimp/pluginrc.   Thus,  when  the  list of available devices changes
62       (e.g., a new scanner is installed or the  device  of  the  scanner  has
63       changed),  then it is typically desirable to rebuild this cache.  To do
64       this,  you  can  either  touch(1)  the  xsane  binary   (e.g.,   "touch
65       /usr/bin/xsane")  or  delete  the plugin cache (e.g., "rm ~/.gimp/plug‐
66       inrc").  Either way, invoking gimp(1) afterwards will cause  the  plug‐
67       inrc to be rebuilt.
68
69       When  xsane  is  started from the gimp then it is not possible to add a
70       devicename explicitly. You have to make the devices known to the system
71       by configuring sane-dll, sane-net and saned.
72
73

OPTIONS

75       If  the  --help or -h flag is given xsane displays a short help message
76       and exits.
77
78       If the --version or -v flag is given xsane prints  a  version  informa‐
79       tion,  some  information  about  gtk+  and  gimp version it is compiled
80       against and lists the supported file formats, then it exits.
81
82       If the --license or -l flag is given xsane prints  license  information
83       and exits.
84
85       The --device-settings or -d flag reads the next option as default file‐
86       name for device settings. The extension ".drc" must not be included.
87
88       The --viewer or -V flag forces xsane to start in viewer mode.
89
90       The --save or -s flag forces xsane to start in save mode.
91
92       The --copy or -c flag forces xsane to start in copy mode.
93
94       The --multipage or -m flag forces xsane to start in multipage mode.
95
96       The --fax or -f flag forces xsane to start in fax mode.
97
98       The --email or -e flag forces xsane to start in e-mail mode.
99
100       The --no-mode-selection or -n flag disables the  menu  for  xsane  mode
101       selection (viewer, save, copy, fax, mail).
102
103       If  the --Fixed or -F flag is given then xsane uses a fixed, non resiz‐
104       able main window.  The flag overwrites the preferences value.
105
106       If the --Resizable or -R flag is given then xsane uses a  scrolled  and
107       resizable main window.  The flag overwrites the preferences value.
108
109       If --print-filenames or -p flag is given then xsane prints the names of
110       created files to the standard output.
111
112       When the flag --force-filename or -N is given then xsane reads the next
113       option  as  default  image  filename.  The name should be of the format
114       "name-###.ext". The selection  box  for  filenames  is  disabled.  This
115       option  normally should be used with the option --no-mode-selection and
116       --save.
117
118       The --display flag selects the X11 display used to present the  graphi‐
119       cal user-interface (see X(1) for details).
120
121       The --no-xshm flag forces xsane not to use shared memory images.
122
123       The  --sync flag requests a synchronous connection with the X11 server.
124       This is for debugging purposes only.
125

ENVIRONMENT

127       SANE_DEFAULT_DEVICE
128              is used to preselect the device in the device dialog.  This  way
129              you only have to accept the device (<ENTER> or OK-Button).
130
131

FILES

133       $HOME/.sane/xsane/xsane.rc
134              This  files  holds  the  user  preferences.  Normally, this file
135              should not be manipulated directly.  Instead,  the  user  should
136              customize the program through the "Preferences" menu.
137
138       $HOME/.sane/xsane/devicename.rc
139              For  each device, there is one rc-file that holds the saved set‐
140              tings for that particular device.  Normally,  this  file  should
141              not  be  manipulated directly.  Instead, the user should use the
142              xsane interface to select appropriate values and then  save  the
143              device  settings  using  the "Preferences->Save Device Settings"
144              menubar entry.
145
146       /usr/share/sane/xsane/xsane-style.rc
147              This system-wide file controls the aspects of the user-interface
148              such  as  colors and fonts.  It is a GTK style file and provides
149              fine control over the visual aspects of the user-interface.
150
151       $HOME/.sane/xsane/xsane-style.rc
152              This file serves the same purpose as the system-wide style file.
153              If present, it takes precedence over the system wide style file.
154

SEE ALSO

156       gimp(1),   xscanimage(1),   scanimage(1),   sane-dll(5),   sane-net(5),
157       saned(1), sane-scsi(5), sane-usb(5), sane-"backendname"(5)
158

AUTHOR

160       Oliver Rauch <Oliver.Rauch@rauch-domain.de>
161
162
163
164                                  15 Jun 2002                         xsane(1)
Impressum