summaryrefslogtreecommitdiff
path: root/doc/xsane.man
diff options
context:
space:
mode:
Diffstat (limited to 'doc/xsane.man')
-rw-r--r--doc/xsane.man128
1 files changed, 90 insertions, 38 deletions
diff --git a/doc/xsane.man b/doc/xsane.man
index 1021b89..babb1a4 100644
--- a/doc/xsane.man
+++ b/doc/xsane.man
@@ -1,26 +1,31 @@
-.TH xsane 1 "11 Aug 2000"
+.TH xsane 1 "15 Jun 2002"
.IX xsane
.SH NAME
xsane - scanner frontend for SANE
.SH SYNOPSIS
.B xsane
.RB [ --version | -v ]
+.RB [ --license | -l ]
.RB [ --device-settings
.IR file
.RB | -d
.IR file ]
-.RB [ --scan | -s ]
+.RB [ --viewer | -V ]
+.RB [ --save | -s ]
.RB [ --copy | -c ]
.RB [ --fax | -f ]
+.RB [ --mail | -m ]
.RB [ --no-mode-selection | -n ]
.RB [ --Fixed | -F ]
-.RB [ --Scrolled | -S ]
+.RB [ --Resizable | -R ]
+.RB [ --print-filenames | -p ]
+.RB [ --force-filename
+.IR name
+.RB | -N
+.IR name ]
.RB [ --display
.IR d ]
-.RB [ --no-xshm ]
.RB [ --sync ]
-.RB [ --debug-level
-.IR n ]
.RI [ devicename ]
.SH DESCRIPTION
.B xsane
@@ -50,8 +55,10 @@ backendname:devicefile (eg: umax:/dev/sga).
To run
.B xsane
under the
-.BR gimp (1),
-simply set a symbolic link from the xsane-binary to one of the
+.BR 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
.BR gimp (1)
plug-ins directories. For example, for gimp-1.0.x the command
.PP
@@ -59,10 +66,16 @@ plug-ins directories. For example, for gimp-1.0.x the command
ln -s @BINDIR@/xsane ~/.gimp/plug-ins/
.RE
.PP
-and for gimp 1.1.x the command:
+for gimp 1.2.x the command:
.PP
.RS
-ln -s @BINDIR@/xsane ~/.gimp-1.1/plug-ins/
+ln -s @BINDIR@/xsane ~/.gimp-1.2/plug-ins/
+.RE
+.PP
+and for gimp 2.0.x the command:
+.PP
+.RS
+ln -s @BINDIR@/xsane ~/.gimp-2.0/plug-ins/
.RE
.PP
adds a symlink for the
@@ -73,10 +86,10 @@ will be queried by
.BR gimp (1)
the next time it's invoked. From then on,
.B xsane
-can be invoked through "Xtns->XSane->Device dialog..." or through
-"File->Acquire->XSane->Device dialog..." menu entry.
+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"/"File->Acquire->XSane" menu contains
+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
.B xsane
was queried.
@@ -93,6 +106,17 @@ binary (e.g., "touch @BINDIR@/xsane") or delete the plugin cache
(e.g., "rm ~/.gimp/pluginrc"). Either way, invoking
.BR gimp (1)
afterwards will cause the pluginrc to be rebuilt.
+.PP
+When
+.B xsane
+is started from the
+.B gimp
+then it is not possible to add a devicename explictly. You have to make the
+devices known to the system by configuring
+.B sane-dll, sane-net
+and
+.B saned.
+
.SH OPTIONS
.PP
If the
@@ -103,37 +127,55 @@ flag is given xsane prints a version information, some
information about gtk+ and gimp version it is compiled
against and lists the supported fileformats, then it exits.
.PP
+when the
+.B --license
+or
+.B -l
+flag is igven xsane prints license information and exits.
+.PP
The
-.B --scan
+.B --device-settings
or
-.B -s
-flag forces xsane to start in scan mode.
+.B -d
+flag reads the next option as default filename
+for device settings. The extension ".drc" must not
+be included.
.PP
The
-.B --fax
+.B --viewer
or
-.B -f
-flag forces xsane to start in fax mode.
+.B -V
+flag forces xsane to start in viewer mode.
+.PP
+The
+.B --save
+or
+.B -s
+flag forces xsane to start in save mode.
.PP
The
.B --copy
or
.B -c
+flag forces xsane to start in copy mode.
+.PP
+The
+.B --fax
+or
+.B -f
flag forces xsane to start in fax mode.
.PP
The
-.B --no-mode-selection
+.B --mail
or
-.B -n
-flag disables the menu for xsane mode selection (scan, copy, fax).
+.B -m
+flag forces xsane to start in mail mode.
.PP
The
-.B --device-settings
+.B --no-mode-selection
or
-.B -d
-flag reads the next option as default filename
-for device settings. The extension ".drc" must not
-be included.
+.B -n
+flag disables the menu for xsane mode selection (viwer, save, copy, fax, mail).
.PP
If the
.B --Fixed
@@ -143,12 +185,29 @@ flag is given then xsane uses a fixed, non resizable main window.
The flag overwrites the preferences value.
.PP
If the
-.B --Scrolled
+.B --Resizable
or
-.B -S
-flag is given then xsane uses a scrolled, resizable main window.
+.B -R
+flag is given then xsane uses a scrolled and resizable main window.
The flag overwrites the preferences value.
.PP
+If
+.B --print-filenames
+or
+.B -p
+flag is given then xsane prints the names of created files to the standard output.
+.PP
+When the flag
+.B --force-filename
+or
+.B -N
+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
+.B --no-mode-selection
+and
+.B --save.
+.PP
The
.B --display
flag selects the X11 display used to present the graphical user-interface
@@ -157,13 +216,6 @@ flag selects the X11 display used to present the graphical user-interface
for details).
.PP
The
-.B --no-xshm
-flag requests not to use shared memory images. Shared memory images
-usually enhance performance but cause problems with some buggy X11
-servers. Unless your X11 server dies when running this program, there
-is no need or advantage to specify this flag.
-.PP
-The
.B --sync
flag requests a synchronous connection with the X11 server. This is for
debugging purposes only.
@@ -198,7 +250,7 @@ This file serves the same purpose as the system-wide style file. If
present, it takes precedence over the system wide style file.
.SH "SEE ALSO"
gimp(1), xscanimage(1), scanimage(1),
-sane\-dll(5), sane\-net(5), sane-scsi(5),
+sane\-dll(5), sane\-net(5), saned(1), sane\-scsi(5), sane\-usb(5),
sane\-"backendname"(5)
.SH AUTHOR
Oliver Rauch <Oliver.Rauch@rauch-domain.de>