summaryrefslogtreecommitdiff
path: root/doc/sane-snapscan.man
blob: 6e718750ff44681e4e6aa2cb4ad7af2dd440969c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.TH sane\-snapscan 5 "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
.IX sane\-snapscan
.SH NAME
sane\-snapscan \- SANE backend for AGFA SnapScan flatbed scanners
.SH DESCRIPTION
The
.B sane\-snapscan
library implements a SANE (Scanner Access Now Easy) backend that provides
access to AGFA SnapScan flatbed scanners. At present, the following scanners
are supported from this backend: AGFA SnapScan 300, 310, 600, and 1236s,
1236u, 1212u, e20, e25,
e40, e50, e60, Vuego 310s, Acer 300f, 310s, 610s, 610plus, Prisa 620s, Prisa
620u, Prisa 620ut, Prisa 640u, Prisa 640bu, Prisa 1240, Prisa 3300, Prisa
4300, Prisa 5300 and Guillemot Maxi Scan A4 Deluxe (SCSI) (with
varying success).
.PP

.SH "DEVICE NAMES"
This backend expects device names of the form:
.PP
.RS
.I special
.RE
.PP
Where
.I special
is the path-name for the special device that corresponds to a
SCSI scanner. For SCSI
scanners, the special device name must be a generic SCSI device or a
symlink to such a device.  Under Linux, such a device name could be
.I /dev/sga
or
.IR /dev/sge ,
for example.  See sane\-scsi(5) for details.
.P
For USB scanners the devicename must contain the keyword "usb", as in
.I /dev/usbscanner
or
.IR /dev/usb/scanner0 .
For scanners that need a firmware upload before scanning add a line starting
with "firmware" followed by the fully qualified path to your firmware file,
e.g.
.PP
.RS
firmware @DATADIR@/sane/snapscan/firmware.bin
.RE
.PP
For further details read http://snapscan.sourceforge.net.

.SH CONFIGURATION
The contents of the
.I snapscan.conf
file is a list of device names that correspond to SnapScan
scanners.  Empty lines and lines starting with a hash mark (#) are
ignored.  See sane\-scsi(5) on details of what constitutes a valid
device name.

.SH FILES
.TP
.I @CONFIGDIR@/snapscan.conf
The backend configuration file (see also description of
.B SANE_CONFIG_DIR
below).
.TP
.I @LIBDIR@/libsane\-snapscan.a
The static library implementing this backend.
.TP
.I @LIBDIR@/libsane\-snapscan.so
The shared library implementing this backend (present on systems that
support dynamic loading).
.SH ENVIRONMENT
.TP
.B SANE_CONFIG_DIR
This environment variable specifies the list of directories that may
contain the configuration file.  Under UNIX, the directories are
separated by a colon (`:'), under OS/2, they are separated by a
semi-colon (`;').  If this variable is not set, the configuration file
is searched in two default directories: first, the current working
directory (".") and then in @CONFIGDIR@.  If the value of the
environment variable ends with the directory separator character, then
the default directories are searched after the explicitly specified
directories.  For example, setting
.B SANE_CONFIG_DIR
to "/tmp/config:" would result in directories "tmp/config", ".", and
"@CONFIGDIR@" being searched (in this order).
.TP
.B SANE_DEBUG_SNAPSCAN
If the library was compiled with debug support enabled, this
environment variable controls the debug level for this backend.  E.g.,
a value of 255 requests all debug output to be printed.  Smaller
levels reduce verbosity.


.SH BUGS
Man page doesn't provide much information yet.

.SH "SEE ALSO"
sane(7), sane\-scsi(5)
.br
http://www.cs.ualberta.ca/~charter/SnapScan/snapscan.html
.br
http://sourceforge.net/projects/snapscan/ (new development website)

.SH AUTHOR
Kevin Charter, Franck Schneider, Michel Roelofs, Emmanuel Blot,
Mikko Tyolajarvi, David Mosberger-Tang, Wolfgang Goeller,
Petter Reinholdtsen, Gary Plewa, Sebastien Sable, Oliver Schwartz
and Mikael Magnusson.
.br
Man page by Henning Meier-Geinitz (mostly based on the web pages and
source code).