summaryrefslogtreecommitdiff
path: root/doc/sane-teco2.man
blob: 2532cf14aa7663ce5aefa53d3ae469a0ca761721 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
.TH sane\-teco2 5 "14 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
.IX sane\-teco2
.SH NAME
sane\-teco2 \- SANE backend for TECO / RELISYS scanners
.SH DESCRIPTION
The
.B sane\-teco2
library implements a SANE (Scanner Access Now Easy) backend that
provides access to some TECO SCSI flatbed scanners. This backend
should be considered
.B beta-quality
software! TECO scanners are sold under
various brands like Mustek, Relisys, Piotech, Primax, TRUST.
This backend may or may not support yours.
.PP
The scanners that should work with this backend are:
.PP
.RS
.ft CR
.nf
   Vendor Model               TECO model      status
--------------------------- --------------  -----------
  Mustek ScanMagic 4830S      VM3575         untested
  Primax Jewel 4800           VM356A         good
  Primax Profi 9600           VM6575         basic
  Primax Profi 19200          VM6586         good
  Relisys APOLLO Express 3    VM356A         basic
  Relisys APOLLO Express 6    VM6565         good
  Relisys APOLLO Express 12   ?              untested
  Relisys AVEC II S3          VM3564         good
  Relisys AVEC Super 3        VM3575         basic
  Relisys SCORPIO Pro         VM6575         good
  Relisys SCORPIO Pro-S       VM6586         untested
  Relisys SCORPIO Super 3     VM3575         good
.fi
.ft R
.RE

For all these scanners, lineart and gray mode work
well. However, most of them do not support more than a handful of
resolutions in color mode. See the backend home page (under AUTHOR)
for the exact status of each scanner.

Note that the untested scanner will not be directly supported. You
should contact the author for that.

The TECO VM number can usually be found at the back of the
scanner. It is also part of the FCC ID.

The options the backend supports can either be selected through
command line options to programs like
.BR scanimage (1)
or through GUI
elements in
.BR xscanimage (1),
.BR xsane (1),
.BR quiteinsane (1)
or
.BR kooka (1).

.br
If you have any success with a scanner not listed here, or if you notice
any strange behavior, please report to the backend maintainer or to
the SANE mailing list.

.SH OPTIONS
Valid command line options and their syntax can be listed by using:

.RS
scanimage \-\-help \-d teco2
.RE

.TP
.B Scan Mode

.TP
.B \-\-mode Lineart|Gray|Color
selects the basic mode of operation of the scanner.
The
.I Lineart
mode is black and white only (1 bit).
.I Gray
mode will produce 256 levels of gray (8 bits).
.I Color
will produce a 24 bits color image.

.TP
.B \-\-resolution 1..600
Selects the resolution for a scan. The scanner can do all resolutions
between 1 and 600, in increments of 1, for
.IR Lineart " and " Gray .
For
.IR Color ,
a restricted set of resolutions are available.

.B Note:
All values with vertical resolution in dpi > 300 (300 x 600) or 600 (600 x 1200) result in
a wrong proportion for the scan. The proportion can be adjusted with
the following
.BR convert (1)
command from imagemagick:
.br
.I convert \-geometry (dpi/max_xdpi * 100%)x100%
.br
max_xdpi is for the vm3575 constant with 300 dpi
e.g. 600dpi adjust with: convert \-geometry 200%x100%

.TP
.B \-\-preview
requests a preview scan. The resolution used for that scan is 50  dpi
(for VM356A and VM6575 75 dpi) and the scan area is the maximum allowed.
The scan mode is user selected. The default is "no".

.TP
.B Geometry options

.TP
.B \-l, \-t, \-x, " \-y
Control the scan area:
.B \-l
sets the top left x coordinate,
.B \-t
the top left y coordinate,
.B \-x
selects the width and
.B \-y
the height of the scan area. All parameters are specified in millimeters by default.


.TP
.B Enhancement options

.TP
.B \-\-custom\-gamma (no custom gamma option for the VM3564 and VM356A)
(color mode only) allows the user to specify a gamma table (see the
next 3 parameters).

.SH OPTIONS FOR COLOR MODE
These options are valid for scan mode
.I Color
only.

.TP
.B \-\-red\-gamma\-table
Can be used to download a user defined
gamma table for the red channel. The table must be 256 bytes long.

.TP
.B \-\-green\-gamma\-table
Can be used to download a user defined
gamma table for the green channel. The table must be 256 bytes long.

.TP
.B \-\-blue\-gamma\-table
Can be used to download a user defined gamma table
for the blue channel. The table must be 256 bytes long.

.SH OPTIONS ONLY FOR VM3564, VM356A, VM3575 and VM6575
These options are only available for VM3564, VM356A, VM3575 and VM6575 models.
.TP
.B \-\-white\-level\-r 0..64
Selects what red radiance level should be
considered "white", when scanning some sheets by changing the calibration
value loaded into the scanner. Scale 0..64 in steps of 1.

.TP
.B \-\-white\-level\-g 0..64
Selects what green radiance level should be
considered "white", when scanning some sheets by changing the calibration
value loaded into the scanner. Scale 0..64 in steps of 1.

.TP
.B \-\-white\-level\-b 0..64
Selects what blue radiance level should be
considered "white", when scanning some sheets by changing the calibration
value loaded into the scanner. Scale 0..64 in steps of 1.


.SH CONFIGURATION FILE
The configuration file
.I @CONFIGDIR@/teco2.conf
supports only one item: the device name to use (eg
.IR /dev/scanner ).


.SH FILES
.TP
.I @LIBDIR@/libsane\-teco2.a
The static library implementing this backend.
.TP
.I @LIBDIR@/libsane\-teco2.so
The shared library implementing this backend (present on systems that
support dynamic loading).


.SH ENVIRONMENT
.TP
.B SANE_DEBUG_TECO2
If the library was compiled with debug support enabled, this
environment variable controls the debug level for this backend. E.g.,
a value of 128 requests all debug output to be printed. Smaller levels
reduce verbosity.
.TP
.B SANE_TECO2_CAL_ALGO
Either 0 or 1. Selects the algorithm for the calibration. A
value of 1 seems to give better scans on the VM356A, VM3575.
Feedback on it is welcome.
For VM3564, VM356A, VM3575, VM6575 default 1.
For other supported types default 0.


.SH LIMITATIONS
The windows TWAIN driver has many more options than this SANE
backend. However they are only software adjustments. This backend only
implements what the scanner can support.


.SH BUGS
Plenty. Parts of this backend are still under development.


.SH "SEE ALSO"
.BR sane (7),
.BR sane\-scsi (5),
.BR scanimage (1),
.BR xscanimage (1),
.BR xsane (1)


.SH AUTHORS
.TP
Frank Zago
.I http://www.zago.net/sane/#teco2
.TP
The package is actively maintained by Gerard Klaver.
.I http://gkall.hobby.nl/teco2.html




.SH CREDITS

Thanks to:
.TP
Gerard Klaver for his relentless VM3575 testings and contributed a patch to support the VM3564 and VM356A.
.TP
Mark Plowman for providing the first SCSI traces from a VM3575.
.TP
Andreas Klaedtke for providing the first SCSI traces from a VM6586 and for his testing, and to Stefan von Dombrowski for his testing.
.TP
Nicolas Peyresaubes for providing the first SCSI traces from a VM656A and for his testing.
.TP
Dave Parker for testing the support for the VM6575.
.TP
Michael Hoeller for testing the support for the VM356A.
.TP
Christoph Hoeffner for testing the support for the VM3564 (Relisys AVEC II S3 firmware 1.09).