Debian Codegraph @

upstream/debian-unstable/man5/sane-epson.5

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