Debian Codegraph @

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

raw
1 .TH "sane\-genesys" "5" "4 Jul 2012" "" "SANE Scanner Access Now Easy"
2 .IX sane\-genesys
3 .SH "NAME"
4 sane\-genesys \- SANE backend for GL646, GL841, GL843, GL847 and GL124 based USB flatbed scanners
5 .SH "DESCRIPTION"
6 The
7 .B sane\-genesys
8 library implements a SANE (Scanner Access Now Easy) backend that provides
9 access to USB flatbed scanners based on the Genesys GL646, GL841, GL843, GL847 and GL124 chips.
10 At present, the following scanners are known to work with this backend:
11 .PP
12 .RS
13 Canon LiDE 35/40/50/60/100/110/120/200/210/220/700
14 .br
15 Hewlett-Packard HP2300C/HP2400/HP3670/HP3690/G4010/G4050
16 .br
17 Medion MD5345/MD6228/MD6274
18 .br
19 Panasonic KV-SS080
20 .br
21 Plustek OpticBook 3600
22 .br
23 Pentax DSmobile 600
24 .br
25 Syscan/Ambir DocketPORT 467/485/487/665/685
26 .br
27 Visioneer OneTouch 7100/Strobe XP100 (rev3)/XP200/XP300/Roadwarrior
28 .br
29 Xerox Travel Scanner 100, OneTouch 2400
30 .RE
31
32 .PP
33 This is stable software for supported models. But if you test new or untested scanners, keep
34 your hand at the scanner's plug and unplug it, if the head bumps at the end of
35 the scan area.
36 .PP
37 If you own a scanner other than the ones listed above that works with this
38 backend, please let me know this by sending the scanner's exact model name and
39 the USB vendor and device ids (e.g. from
40 .IR /proc/bus/usb/devices ,
41 .I sane\-find\-scanner
42 or syslog) to the sane\-devel mailing list. Even if the scanner's name is only
43 slightly different from the models mentioned above, please let me know.
44 .PP
45 If you own a scanner that isn't detected by the genesys backend but has a GL646,
46 GL841, GL843, GL847 or GL124 chipset, you can try to add it to the backend.
47 .PP
48 .SH "CALIBRATION"
49 To give correct image quality, sheet fed scanners need to be calibrated using the
50 calibration sheet sold with the scanner. To do calibration, you must insert this target
51 in the feeder then start calibration either by passing the \-\-calibrate option to
52 .BR scanimage (1)
53 or by clicking on the available 'calibrate' button in the 'advanced options' in a graphical
54 frontend. The result of the calibration is stored in a file in the home directory of the user doing it.
55 If you plug the scanner in another machine or use it with another account, calibration
56 will have to be redone, unless you use the \-\-calibration\-file option.
57 If no home directory is defined,
58 .B USERAPPPROFILE
59 will be used, then
60 .B TMPDIR
61 or
62 .BR TMP.
63 If none of these directories exist, the backend will try
64 to write in the current working directory. Flatbed scanners also make use of the calibration file as a cache
65 to avoid calibration before each scan. Calibration file name is the name of the scanner model if only
66 one scanner is detected. In the case of several identical model, the file name will be the name
67 of the logical USB device name. The expiration time manages the time a calibration is valid in cache.
68 A value of -1 means forever, 0 means no cache.
69
70 .SH EXTRAS SCAN OPTIONS
71
72 .TP
73 .B \-\-lamp\-off\-time number
74 The lamp will be turned off after the given time (in minutes). A value of 0 means that the lamp won't be turned off.
75
76 .TP
77 .B \-\-threshold percent
78 0..100% (in steps of 1). Select minimum brightness to get a white point. Pixels
79 with brightness below that value will be scanned as black.
80
81 .TP
82 .B \-\-brightness value
83 \-100..100 (in steps of 1). Set the brightness enhancement. 0 for no enhancement, negative
84 values to decrease brightness, and positive values to increase it.
85
86 .TP
87 .B \-\-contrast value
88 \-100..100 (in steps of 1). Set the contrast enhancement. 0 for no enhancement, negative
89 values to decrease contrast, and positive values to increase it.
90
91 .TP
92 .B \-\-disable-interpolation yes|no
93 When using high resolutions where the horizontal resolution is smaller than vertical resolution,
94 data is expanded by software to preserve picture geometry. This can be disabled by this option to get
95 real scanned data.
96
97 .TP
98 .B \-\-disable-dynamic-lineart yes|no
99 Disable use of a software adaptive algorithm to generate lineart and rely on hardware lineart.
100
101 .TP
102 .B \-\-color-filter None|Red|Green|Blue
103 When using gray or lineart this option selects the used color. Using a color filter
104 will give a monochrome scan. CIS based scanners can do true gray when no filter (None value) is
105 selected.
106
107 .TP
108 .B \-\-lamp\-off\-scan
109 The lamp will be turned off during the scan. Calibration is still done with lamp on.
110
111 .TP
112 .B \-\-clear\-calibration
113 Clear calibration cache data, triggering a new calibration for the device when the
114 next scan will happen.
115
116 .TP
117 .B \-\-calibration\-file
118 Specify the calibration file name to use. At least the directory containing the file
119 must exist, since it won't be created. This option is disabled if the backend is run
120 as root. It maybe used in case of sheet-fed scanners to share a calibration file for several
121 users.
122
123 .TP
124 .B \-\-expiration\-time
125 Specify the time (in minutes) a cached calibration is considered valid. If older than the given value, a new
126 calibration is done. A value of -1 means no expiration and cached value are kept forever unless cleared by
127 user with the calibration clear option. A value of 0 means cache is disabled.
128
129 .PP
130 Additionally, several 'software' options are exposed by the backend. These
131 are reimplementations of features provided natively by larger scanners, but
132 running on the host computer. This enables smaller machines to have similar
133 capabilities. Please note that these features are somewhat simplistic, and
134 may not perform as well as the native implementations. Note also that these
135 features all require that the driver cache the entire image in memory. This
136 will almost certainly result in a reduction of scanning speed.
137
138 .TP
139 .B \-\-swcrop
140 Requests the driver to detect the extremities of the paper within the larger
141 image, and crop the empty edges.
142
143 .TP
144 .B \-\-swdeskew
145 Requests the driver to detect the rotation of the paper within the larger
146 image, and counter the rotation.
147
148 .TP
149 .B \-\-swdespeck \-\-despeck X
150 Requests the driver to find and remove dots of X diameter or smaller from the
151 image, and fill the space with the average surrounding color.
152
153 .TP
154 .B \-\-swskip 0..100% (in steps of 1) [0]
155 Request driver to discard pages with low numbers of dark pixels.
156
157 .TP
158 .B \-\-swderotate[=(yes|no)] [no]
159 Request driver to detect and correct 90 degree image rotation.
160
161 .SH "SYSTEM ISSUES"
162 This backend needs libusb-0.1.6 or later installed, and hasn't tested in other
163 configuration than a linux kernel 2.6.9 or higher. However, it should work any
164 system with libusb where the SANE package can be compiled. For
165 setting permissions and general USB information look at
166 .BR sane\-usb (5).
167
168
169 .SH "CONFIGURATION"
170 The contents of the
171 .I genesys.conf
172 file is a list of usb lines containing vendor and product ids that correspond
173 to USB scanners. The file can also contain option lines. Empty lines and
174 lines starting with a hash mark (#) are ignored. The scanners are
175 autodetected by
176 .B usb vendor_id product_id
177 statements which are already included into
178 .IR genesys.conf .
179 "vendor_id" and "product_id" are hexadecimal numbers that identify the
180 scanner.
181 .PP
182
183 .SH "FILES"
184 .TP
185 .I /etc/sane.d/genesys.conf
186 The backend configuration file (see also description of
187 .B SANE_CONFIG_DIR
188 below).
189 .TP
190 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-genesys.a
191 The static library implementing this backend.
192 .TP
193 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-genesys.so
194 The shared library implementing this backend (present on systems that
195 support dynamic loading).
196 .SH "ENVIRONMENT"
197 .TP
198 .B SANE_CONFIG_DIR
199 This environment variable specifies the list of directories that may
200 contain the configuration file. On *NIX systems, the directories are
201 separated by a colon (`:'), under OS/2, they are separated by a
202 semi-colon (`;'). If this variable is not set, the configuration file
203 is searched in two default directories: first, the current working
204 directory (".") and then in
205 .IR /etc/sane.d .
206 If the value of the environment variable ends with the directory separator
207 character, then the default directories are searched after the explicitly
208 specified directories. For example, setting
209 .B SANE_CONFIG_DIR
210 to "/tmp/config:" would result in directories
211 .IR tmp/config ,
212 .IR . ,
213 and
214 .I "/etc/sane.d"
215 being searched (in this order).
216 .TP
217 .B SANE_DEBUG_GENESYS
218 If the library was compiled with debug support enabled, this environment
219 variable controls the debug level for this backend. Higher debug levels
220 increase the verbosity of the output. If the debug level is set to 1 or higher,
221 some debug options become available that are normally hidden. Handle them with
222 care. This will print messages related to core genesys functions.
223 .TP
224 .B SANE_DEBUG_GENESYS_IMAGE
225 If the library was compiled with debug support enabled, this environment
226 variable enables logging of intermediate image data. To enable this mode,
227 set the environmental variable to 1.
228
229
230 Example (full and highly verbose output for gl646):
231 .br
232 export SANE_DEBUG_GENESYS=255
233
234 .SH CREDITS
235
236 Jack McGill for donating several sheetfed and flatbed scanners, which made possible to add support
237 for them in the genesys backend:
238 .RS
239 Hewlett-Packard HP3670
240 .br
241 Visioneer Strobe XP100 (rev3)/XP200/XP300/Roadwarrior
242 .br
243 Canon LiDE 200
244 .br
245 Pentax DSmobile 600
246 .br
247 Syscan/Ambir DocketPORT 467/485/487/665/685
248 .br
249 Xerox Travel Scanner 100, Onetouch 2400
250 .RE
251 .TP
252 cncsolutions sponsored and supported the work on the Panasonic KV-SS080.
253 .br
254 .TP
255 Brian Paavo from Benthic Science Limited for donating a Canoscan LiDE 700F.
256 .br
257 .TP
258 Dany Qumsiyeh for donating a Canoscan LiDE 210 and a LiDE 220.
259 .br
260 .TP
261 Luc Verhaegen for donating a Canoscan LiDE 120.
262 .br
263
264 .SH "SEE ALSO"
265 .BR sane (7),
266 .BR sane\-usb (5)
267 .br
268
269
270 .SH "AUTHOR"
271 Oliver Rauch
272 .br
273 Henning Meier-Geinitz
274 .RI < henning@meier\-geinitz.de >
275 .br
276 Gerhard Jaeger
277 .RI < [email protected] >
278 .br
279 St\['e]phane Voltz
280 .RI < [email protected] >
281 .br
282 Philipp Schmid
283 .RI < [email protected] >
284 .br
285 Pierre Willenbrock
286 .RI < [email protected] >
287 .br
288 Alexey Osipov
289 .RI < [email protected] >
290 for HP2400 final support
291
292 .SH "LIMITATIONS"
293
294 Powersaving isn't implemented for gl646 based scanner. Dynamic (emulated from gray data and with dithering)
295 isn't enabled for gl646 scanners. Hardware lineart is limited up to 600 dpi for gl847 based scanners,
296 due to the way image sensors are built.
297 .PP
298 This backend will be much slower if not using libusb\-1.0. So be sure that sane\-backends is built with
299 the
300 .B \-\-enable-libusb_1_0
301 option.
302
303 .SH "BUGS"
304 For the LiDE 200, the scanned data at 4800 dpi is obtained "as is" from sensor.
305 It seems the windows driver does some digital processing to improve it, which is not implemented in the backend.
306 .PP