Debian Codegraph @

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

raw
1 .TH sane\-gt68xx 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-gt68xx
3 .SH NAME
4 sane\-gt68xx \- SANE backend for GT-68XX based USB flatbed scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-gt68xx
8 library implements a SANE (Scanner Access Now Easy) backend that provides
9 access to USB flatbed scanners based on the Grandtech GT-6801 and GT-6816
10 chips. A list of supported scanners can be found on the gt68xx backend
11 homepage:
12 .IR http://www.meier\-geinitz.de/sane/gt68xx\-backend/ .
13 .PP
14 This is BETA software. Especially if you test new or untested scanners, keep
15 your hand at the scanner's plug and unplug it, if the head bumps at the end of
16 the scan area.
17 .PP
18 If you own a scanner other than the ones listed on the gt68xx homepage that works with this
19 backend, please let me know this by sending the scanner's exact model name and
20 the USB vendor and device ids (e.g. from
21 .BR sane\-find\-scanner (1)
22 or syslog) to me. Even if the scanner's name is only slightly different from
23 the models already listed as supported, please let me know.
24 .PP
25 If you own a scanner that isn't detected by the gt68xx backend but has a GT-6801
26 or GT-6816 chipset, you can try to add it to the backend. Have a look at the
27 following web page:
28 .I http://www.meier\-geinitz.de/sane/gt68xx\-backend/adding.html
29 .PP
30 .SH LIBUSB ISSUES
31 Please use libusb-0.1.8 or later. Without libusb or with older libusb versions
32 all kinds of trouble can be expected. The scanner should be found by
33 .BR sane\-find\-scanner (1)
34 without further actions. For setting permissions and general USB information, look at
35 .BR sane\-usb (5).
36 .PP
37
38 .SH FIRMWARE FILE
39 You need a firmware file for your scanner. That's a small file containing
40 software that will be uploaded to the scanner's memory. It's usually named
41 *.usb, e.g.
42 .IR PS1fw.usb .
43 It comes on the installation CD that was provided by the manufacturer, but it
44 may be packaged together with the installation program in an .exe file. For
45 Mustek scanners, the file can be downloaded from the gt68xx backend homepage. For
46 other scanners, check the CD for .usb files. If you only find *.cab files, try
47 .BR cabextract (1)
48 to unpack. If everything else fails, you must install the Windows
49 driver and get the firmware from there (usually in the
50 .I windows/system
51 or
52 .I system32
53 directories). Put that firmware file into
54 .IR /usr/share/sane/gt68xx/ .
55 Make sure that it's readable by everyone.
56
57 .SH CONFIGURATION
58 The contents of the
59 .I gt68xx.conf
60 file is a list of usb lines containing vendor and product ids that correspond
61 to USB scanners. The file can also contain option lines. Empty lines and
62 lines starting with a hash mark (#) are ignored. The scanners are
63 autodetected by
64 .B usb vendor_id product_id
65 statements which are already included into
66 .IR gt68xx.conf .
67 "vendor_id" and "product_id" are hexadecimal numbers that identify the
68 scanner.
69 .PP
70 The
71 .BR override ,
72 .BR firmware ,
73 .BR vendor ,
74 .BR model ,
75 and
76 .B afe
77 options must be placed after the
78 .B usb
79 line they refer to.
80 .PP
81 Option
82 .B override
83 is used to override the default model parameters. That's necessary for some
84 scanners that use the same vendor/product ids but are different. For these
85 scanners there are already commented out override lines in the configuration
86 file.
87 .B override "mustek\-scanexpress\-1200\-ub\-plus"
88 is necessary for the Mustek Scanexpress 1200 UB Plus, the
89 Medion/Lifetec/Tevion LT 9452, and the Trust Compact Scan USB 19200.
90 .B override "artec\-ultima\-2000"
91 is used for the Artec Ultima 2000, the Boeder SmartScan Slim Edition, the
92 Medion/ Lifetec/ Tevion/ Cytron MD/LT 9385, the Medion/ Lifetec/ Tevion MD
93 9458, and the Trust Flat Scan USB 19200.
94 .B override "mustek\-bearpaw\-2400\-cu"
95 is necessary for the Mustek BearPaw 2400 CU and the Fujitsu 1200CUS. The
96 .B override
97 option must be the first one after the
98 .B usb
99 line.
100 .PP
101 Option
102 .B firmware
103 selects the name and path of the firmware file. It's only necessary if the
104 default (or override) doesn't work. The default firmware directory is
105 .IR /usr/share/sane/gt68xx/ .
106 You may need to create this directory. If you want to place the firmware files
107 at a different path, use a
108 .B firmware
109 line.
110 .PP
111 The
112 .B vendor
113 and
114 .B model
115 options are not absolutely necessary but for convenience. Quite a lot of
116 scanners from different manufacturers share the same vendor/product ids so you
117 can set the "correct" name here.
118 .PP
119 The
120 .B afe
121 option allows one to set custom offset and gain values for the Analog FrontEnd of
122 the scanner. This option can be either used to select the AFE values if
123 automatic coarse calibration is disabled, or to make automatic coarse
124 calibration faster. For the latter usage, enable debug level 3 (see below),
125 scan an image and look for debug line string with "afe". Copy this line to
126 .IR gt68xx.conf .
127 The option has six parameters: red offset, red gain, green offset, green gain,
128 blue offset, and blue gain.
129 .PP
130 A sample configuration file is shown below:
131 .PP
132 .RS
133 usb 0x05d8 0x4002
134 .br
135 override "mustek\-scanexpress\-1200\-ub\-plus"
136 .br
137 firmware "/opt/gt68xx/SBfw.usb"
138 .br
139 vendor "Trust"
140 .br
141 model "Compact Scan USB 19200"
142 .br
143 afe 0x20 0x02 0x22 0x03 0x1f 0x04
144 .RE
145
146 .SH FILES
147 .TP
148 .I /etc/sane.d/gt68xx.conf
149 The backend configuration file (see also description of
150 .B SANE_CONFIG_DIR
151 below).
152 .TP
153 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-gt68xx.a
154 The static library implementing this backend.
155 .TP
156 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-gt68xx.so
157 The shared library implementing this backend (present on systems that
158 support dynamic loading).
159 .SH ENVIRONMENT
160 .TP
161 .B SANE_CONFIG_DIR
162 This environment variable specifies the list of directories that may
163 contain the configuration file. On *NIX systems, the directories are
164 separated by a colon (`:'), under OS/2, they are separated by a
165 semi-colon (`;'). If this variable is not set, the configuration file
166 is searched in two default directories: first, the current working
167 directory (".") and then in
168 .IR /etc/sane.d .
169 If the value of the
170 environment variable ends with the directory separator character, then
171 the default directories are searched after the explicitly specified
172 directories. For example, setting
173 .B SANE_CONFIG_DIR
174 to "/tmp/config:" would result in directories
175 .IR tmp/config ,
176 .IR . ,
177 and
178 .I "/etc/sane.d"
179 being searched (in this order).
180 .TP
181 .B SANE_DEBUG_GT68XX
182 If the library was compiled with debug support enabled, this environment
183 variable controls the debug level for this backend. Higher debug levels
184 increase the verbosity of the output. If the debug level is set to 1 or higher,
185 some debug options become available that are normally hidden. Handle them with
186 care.
187
188 Example:
189 export SANE_DEBUG_GT68XX=4
190
191 .SH "SEE ALSO"
192 .BR sane (7),
193 .BR sane\-usb (5),
194 .BR sane\-artec_eplus48u (5)
195 .BR sane\-plustek (5),
196 .BR sane\-ma1509 (5),
197 .BR sane\-mustek_usb (5),
198 .BR sane\-mustek (5),
199 .BR sane\-mustek_pp (5),
200 .BR cabextract (1)
201 .br
202 .I /usr/share/doc/libsane/gt68xx/gt68xx.CHANGES
203 .br
204 .I http://www.meier\-geinitz.de/sane/gt68xx
205
206 .SH AUTHOR
207 Henning Meier-Geinitz
208 .RI < henning@meier\-geinitz.de >
209 .br
210 The original gt68xx driver was written by Sergey Vlasov, Andreas Nowack, and
211 David Stevenson. Thanks for sending patches and answering questions to them
212 and all the other contributors.
213
214 .SH BUGS
215 The first few lines of the image are garbage for the 2400 TA
216 Plus.
217 .PP
218 Interpolation should be used instead of just copying data, when the X- and
219 Y-resolution differ.
220 .PP
221 Support for buttons is missing.
222 .PP
223 More detailed bug information is available at the gt68xx backend homepage
224 .IR http://www.meier\-geinitz.de/sane/gt68xx\-backend/ .
225 .br
226 Please contact us if you find a bug or missing feature:
227 .RI < sane\[email protected] >.
228 .br
229 Please send a debug log if your scanner isn't
230 detected correctly (see
231 .B SANE_DEBUG_GT68XX
232 above).