~jfbcable/ubuntu/wily/sane-backends/fix-pixma

« back to all changes in this revision

Viewing changes to doc/sane-epson.man

  • Committer: Julian Cable
  • Author(s): Michael Thayer
  • Date: 2015-09-16 08:25:15 UTC
  • Revision ID: jfbcable@gmail.com-20150916082515-j5f0gb84wv90tok1
Tags: upstream-1.0.25+git20150528
ImportĀ upstreamĀ versionĀ 1.0.25+git20150528

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH sane\-epson 5 "11 Jul 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
 
2
.IX sane\-epson
 
3
.SH NAME
 
4
sane\-epson \- SANE backend for EPSON scanners
 
5
.SH DESCRIPTION
 
6
The
 
7
.B sane\-epson
 
8
library implements a SANE (Scanner Access Now Easy) backend that
 
9
provides access to Epson flatbed scanners.  Some functions of this 
 
10
backend should be considered
 
11
.B beta-quality
 
12
software! Most functions have been stable for a long time, but of 
 
13
course new development can not and often times will not function properly from
 
14
the very first day. Please report any strange behavior to the 
 
15
maintainer of the backend.
 
16
.PP
 
17
At present, the following scanners are known to work with this backend:
 
18
.PP
 
19
.RS
 
20
.ft CR
 
21
.nf
 
22
Model:                       Connection Type
 
23
---------------------------  -------------------
 
24
GT-5000                      SCSI, parallel
 
25
GT-6000                      parallel
 
26
GT-6500                      SCSI (use only the line "scsi" in epson.conf)
 
27
ActionScanner II             SCSI, parallel
 
28
GT-7000                      SCSI
 
29
Perfection 636               SCSI
 
30
Perfection 636U              USB
 
31
Perfection 610               USB
 
32
Perfection 640               USB
 
33
Perfection 1200S             SCSI
 
34
Perfection 1200U             USB
 
35
Perfection 1240              USB, SCSI
 
36
Perfection 1640              USB, SCSI
 
37
Perfection 1650              USB
 
38
Perfection 1660              USB
 
39
Perfection 2400              USB
 
40
Perfection 2450              USB, IEEE-1394
 
41
Expression 636 / GT-9500     SCSI
 
42
Expression 1600              USB, SCSI, IEEE-1394
 
43
Expression 1680              USB, SCSI, IEEE-1394
 
44
CX-3200                      USB
 
45
CX-5200                      USB
 
46
.fi
 
47
.ft R
 
48
and many more. The official list is on the Sane web site.
 
49
.RE
 
50
 
 
51
For other scanners the software  may or may not work.  Please send mail to 
 
52
the backend author (khk@khk.net) to report success with scanners not on
 
53
the list or problems with scanners that are listed. 
 
54
.SH OPTIONS
 
55
The options the backend supports can either be selected through command line
 
56
options to programs like scanimage or through GUI elements in programs like
 
57
xscanimage or xsane.
 
58
 
 
59
Valid command line options and their syntax can be listed by using 
 
60
.RS
 
61
scanimage \-\-help \-d epson
 
62
.RE
 
63
Not all devices support all options.
 
64
.TP
 
65
.I Scan Mode
 
66
The 
 
67
.I \-\-mode 
 
68
switch selects the basic mode of operation of the scanner. Valid choices
 
69
are Binary, Gray and Color.  The Binary mode is black and white only,
 
70
Gray will produce 256 levels of gray or more depending on the scanner
 
71
and Color means 24 bit color mode or more depending on the scanner.
 
72
Some scanners will internally use 36 bit color, their external interface
 
73
however may only support 24 bits.
 
74
 
 
75
The
 
76
.I \-\-depth
 
77
option selects the bit depth the scanner is using. This option is only
 
78
available for scanners that support more than one bit depth. Older
 
79
scanners will always transfer the image in 8bit mode. Newer scanners
 
80
allow to select either 8 bits, 12 or 14 bits per color channel. For a
 
81
color scan this means an effective color depth of 36 or 42 bits over
 
82
all three channels. The valid choices depend on the scanner model.
 
83
 
 
84
The
 
85
.I \-\-halftoning
 
86
switch selects the mode that is used in Binary mode. Valid options
 
87
are "None", "Halftone A (Hard Tone)", "Halftone B (Soft Tone)", "Halftone C
 
88
(Net Screen)", "Dither A (4x4 Bayer)", "Dither B (4x4 Spiral)", "Dither C
 
89
(4x4 Net Screen)", "Dither D (8x4 Net Screen)", "Text Enhanced Technology",
 
90
"Download pattern A", and "Download pattern B".
 
91
 
 
92
The 
 
93
.I \-\-dropout
 
94
switch selects the so called dropout color. Valid options are None,
 
95
Red, Green and Blue. The default is None. The dropout color is used for
 
96
monochrome scanning and selects the color that is not scanned. This can
 
97
be used to e.g. scan an original with a colored background.
 
98
 
 
99
The
 
100
.I \-\-brightness
 
101
switch controls the brightness of the scan. Valid options are integer
 
102
values from \-3 to 3. The default is 0. The larger the brightness value,
 
103
the brighter the image gets. If a user defined table for the gamma
 
104
correction is selected, the brightness parameter is not available.
 
105
 
 
106
The
 
107
.I \-\-sharpness
 
108
switch sets the sharpness of the image data. Valid options are integer
 
109
values from \-2 to 2, with \-2 meaning "Defocus", \-1 "Defocus slightly",
 
110
0 "Normal", 1 "Sharpen slightly" and 2 "Sharpen".
 
111
 
 
112
The 
 
113
.I \-\-gamma\-correction
 
114
switch controls the scanner's internal gamma correction. Valid options are
 
115
"Default", "User defined", "High density printing" "Low density printing"
 
116
and "High contrast printing".
 
117
 
 
118
The 
 
119
.I \-\-color\-correction
 
120
switch controls the scanner's internal color correction function. Valid
 
121
options are "No Correction", "Impact\-dot printers", "Thermal printers",
 
122
"Ink\-jet printers" and "CRT monitors". The default is "CRT monitors".
 
123
 
 
124
The 
 
125
.I \-\-resolution
 
126
switch selects the resolution for a scan. Some EPSON scanners will scan in
 
127
any resolution between the lowest and highest possible value. The list
 
128
reported by the scanner can be displayed using the "\-\-help \-d epson"
 
129
parameters to scanimage.
 
130
 
 
131
The 
 
132
.I \-\-mirror
 
133
option controls the way the image is scanned. By reading the image data
 
134
from right to left the image is mirrored. Valid options are "yes" and
 
135
"no". The default is "no".
 
136
 
 
137
The 
 
138
.I \-\-speed
 
139
option can improve the scan speed in monochrome mode. Valid options are
 
140
"yes" or "no", the "yes" option will speed up the scan if this option
 
141
is supported.
 
142
 
 
143
The 
 
144
.I \-\-auto\-area\-segmentation 
 
145
switch activates the automatic area segmentation for monochrome scans. The
 
146
scanner will try to determine which areas are text and which contain
 
147
images. The image areas will be halftoned, and the text will be
 
148
improved. Valid options are "yes" and "no". The default is "yes".
 
149
 
 
150
The 
 
151
.I \-\-gamma\-table
 
152
parameter can be used to download a user defined gamma table. The option
 
153
takes 256 values from the range 0-255. In color mode this option equally
 
154
affects the red, green, and blue channel.
 
155
 
 
156
The 
 
157
.I \-\-red\-gamma\-table 
 
158
parameter can be used to download a user defined gamma table for the
 
159
red channel. The valid options are the same as for \-\-gamma\-table.
 
160
 
 
161
The 
 
162
.I \-\-green\-gamma\-table 
 
163
parameter can be used to download a user defined gamma table for the
 
164
green channel. The valid options are the same as for \-\-gamma\-table.
 
165
 
 
166
The 
 
167
.I \-\-blue\-gamma\-table 
 
168
parameter can be used to download a user defined gamma table for the
 
169
blue channel. The valid options are the same as for \-\-gamma\-table.
 
170
 
 
171
The color correction coefficients
 
172
.I \-\-cct\-1 \-\-cct\-2 \-\-cct\-3 ... \-\-cct\-9
 
173
will install color correction coefficients for the user defined color
 
174
correction. Values are specified as integers in the range \-127..127.
 
175
 
 
176
The 
 
177
.I \-\-preview
 
178
option requests a preview scan. The frontend software automatically selects a low 
 
179
resolution. Valid options are "yes" and "no". The default is "no".
 
180
 
 
181
The 
 
182
.I \-\-preview\-speed
 
183
options will increase the scan speed if this is supported by the
 
184
scanner. Valid options are "yes" and "no", the default is "no".
 
185
 
 
186
 
 
187
The geometry options
 
188
.I \-l \-t \-x \-y 
 
189
control the scan area: \-l sets the top left x coordinate, \-t the top
 
190
left y coordinate, \-x selects the width and \-y the height of the scan
 
191
area. All parameters are specified in millimeters.
 
192
 
 
193
The
 
194
.I \-\-quick\-format
 
195
option lets the user select a scan area with predefined sizes. Valid
 
196
parameters are "CD", "A5 portrait", "A5 landscape", "Letter", "A4" and
 
197
"max". The default is "max", which selects the largest possible area.
 
198
 
 
199
The
 
200
.I \-\-source
 
201
option selects the scan source. Valid options depend on the installed
 
202
options. The default is "Flatbed".
 
203
 
 
204
The 
 
205
.I \-\-auto\-eject
 
206
option will eject a page after scanning from the document feeder. 
 
207
 
 
208
The
 
209
.I \-\-film\-type
 
210
option will select the film type for scans with the transparency
 
211
unit. This option is only activated if the TPU is selected as scan
 
212
source. Valid options are "Negative Film" and "Positive Film".
 
213
 
 
214
The
 
215
.I \-\-focus\-position
 
216
option selects the focus position for all scans. Valid options are "Focus
 
217
2.5mm above glass" and "Focus on glass". The focus on the 2.5mm point
 
218
above the glass is necessary for scans with the transparency unit, so
 
219
that the scanner can focus on the film if one of the film holders is used.
 
220
This option is only functional for selected scanners, all other scanners
 
221
will ignore this option.
 
222
 
 
223
 
 
224
.SH CONFIGURATION FILE
 
225
The configuration file @CONFIGDIR@/epson.conf specifies the device(s) that the 
 
226
backend will use. Possible connection types are:
 
227
.TP
 
228
.I SCSI
 
229
This is the default, and if nothing else is specified the backend software will
 
230
open a given path as SCSI device. More information about valid syntax for SCSI
 
231
devices can be found in sane\-scsi(5).
 
232
.br
 
233
Usually SCSI scanners are configured with a line "scsi EPSON" in this file. In 
 
234
some cases it may be necessary to only use the string "scsi" (e.g. for the GT-6500).
 
235
.TP
 
236
.I PIO \- Parallel Interface
 
237
The parallel interface can be configured in two ways: An integer value starting
 
238
at the beginning of a line will be interpreted as the IO address of the parallel
 
239
port. To make it clearer that a configured IO address is a parallel port the 
 
240
port address can be preceded by the string "PIO". The PIO connection does not
 
241
use a special device file in the /dev directory. The IO address can be specified
 
242
in hex mode (prefixed with "0x").
 
243
.TP
 
244
.I USB
 
245
A device file that is preceded by the string "USB" is treated as a scanner 
 
246
connected via the Universal Serial Bus. The correct special device file has
 
247
to be created prior to using it with Sane. See the USB documentation for 
 
248
more information about how to set up the USB subsystem and the required 
 
249
device files.
 
250
.SH FILES
 
251
.TP
 
252
.I @LIBDIR@/libsane\-epson.a
 
253
The static library implementing this backend.
 
254
.TP
 
255
.I @LIBDIR@/libsane\-epson.so
 
256
The shared library implementing this backend (present on systems that
 
257
support dynamic loading).
 
258
.SH ENVIRONMENT
 
259
.TP
 
260
.B SANE_DEBUG_EPSON
 
261
If the library was compiled with debug support enabled, this
 
262
environment variable controls the debug level for this backend.  E.g.,
 
263
a value of 128 requests all debug output to be printed.  Smaller
 
264
levels reduce verbosity.
 
265
.TP
 
266
.B SANE_DEBUG_EPSON_SCSI
 
267
If the library was compiled with debug support enabled, this
 
268
environment variable controls the SCSI related debug level for this backend.  
 
269
Only a value of 2 is supported.
 
270
.TP
 
271
.B SANE_EPSON_CMD_LVL
 
272
This allows one to override the function or command level that the backend
 
273
uses to communicate with the scanner. The function level a scanner
 
274
supports is determined during the initialization of the device. If
 
275
the backend does not recognize the function level reported by the 
 
276
scanner it will default to function level B3. Valid function levels
 
277
are A1, A2, B1, B2, B3, B4, B5, B6, B7, B8, D1 and F5. Use this feature
 
278
only if you know what you are doing!
 
279
 
 
280
.SH "SEE ALSO"
 
281
 
 
282
sane\-scsi(5), scanimage(1), xscanimage(1), xsane(1)
 
283
 
 
284
.SH BUGS
 
285
 
 
286
None :-) At least none are currently known.
 
287
 
 
288
.SH UNSUPPORTED DEVICES
 
289
The backend may be used with Epson scanners that are not yet listed 
 
290
under the list of supported devices. A scanner that is not recognized
 
291
may default to the function level B3, which means that not all 
 
292
functions that the scanner may be capable of are accessible. 
 
293
 
 
294
If the scanner is not even recognized as an Epson scanner this is
 
295
probably because the device name reported by the scanner is not in the
 
296
correct format. Please send this information to the backend maintainer
 
297
(email address is in the AUTHOR section of this man page or in the
 
298
AUTHORS file of the SANE distribution). 
 
299
 
 
300
The Perfection 600, Perfection 650, Perfection 660, Perfection 1250 and 
 
301
Perfection 1260 are not supported by this backend.
 
302
 
 
303
.SH AUTHOR
 
304
 
 
305
The package is actively maintained by Karl Heinz Kremer (khk@khk.net). The
 
306
software is based on work by Christian Bucher and Kazuhiro Sasayama