Debian Codegraph @

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

raw
1 .TH sane\-artec_eplus48u 5 "11 Jul 2008" "" "SANE"
2 .SH NAME
3 sane\-artec_eplus48u \- SANE backend for the scanner Artec E+ 48U and re-badged models
4 .SH DESCRIPTION
5 The
6 .B sane\-artec_eplus48u
7 library implements a SANE (Scanner Access Now Easy) backend that provides
8 access to several USB flatbed scanners using the GT6816 chipset like the Artec E+ 48U.
9 These scanners have a contact image sensor (CIS).
10 .PP
11 A complete list of supported devices can be found on
12 .IR http://www.sane\-project.org/sane\-supported\-devices.html .
13 .PP
14 This is ALPHA 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 mentioned on the list that works with this
19 backend, please let us know this by sending the scanner's exact model name and
20 the USB vendor and product ids (e.g. from
21 .IR /proc/bus/usb/devices ,
22 .BR sane\-find\-scanner (1)
23 or syslog) to me. Even if the scanner's name is only
24 slightly different from the models mentioned above, please let me know.
25 .PP
26 .SH KERNEL ISSUES
27 If libusb-0.1.6 or later is installed, this section can be skipped. The
28 scanner should be found by
29 .BR sane\-find\-scanner (1)
30 without further actions. For setting permissions and general USB information
31 look at
32 .BR sane\-usb (5).
33 .PP
34 When you are using the scanner module, a Linux kernel 2.4.12 or newer is
35 required.
36
37 .SH FIRMWARE FILE
38 You need a firmware file for your scanner. That's a small file containing
39 software that will be uploaded to the scanner's memory. For the scanners
40 mentioned above, it's usually named
41 .I Artec48.usb
42 or
43 .IR 1200.usb .
44 You can find it on the installation CD that was provided by the manufacturer,
45 normally in the directory Win98, WinMe or similar.
46 If the Windows-driver is installed on your computer, then you can also
47 find the firmware file under c:\\windows\\system32\\drivers.
48
49 .SH CONFIGURATION
50 The contents of the
51 .I artec_eplus48u.conf
52 file is a list of
53 .I usb
54 lines containing vendor and product ids that correspond
55 to USB scanners. The file can also contain option lines. Empty lines and
56 lines starting with a hash mark (#) are ignored. The scanners are
57 autodetected by
58 .I usb vendor_id product_id
59 statements which are already included into
60 .I artec_eplus48u.conf .
61 "vendor_id" and "product_id" are hexadecimal numbers that identify the scanner.
62 .PP
63 Every
64 .I usb
65 section can have additional options.
66 .TP
67 .B artecFirmwareFile /usr/share/sane/artec_eplus48u/Artec48.usb
68 The path to the firmware file. This option is required.
69 .TP
70 .B redGamma 1.0
71 .TP
72 .B greenGamma 1.0
73 .TP
74 .B blueGamma 1.0
75 .TP
76 .B masterGamma 1.9
77 These are the default gamma values. If you set the "Defaults" option with a frontend,
78 then the gamma options are reset to the values specified here.
79 .TP
80 .B redOffset 0x28
81 .TP
82 .B greenOffset 0x2f
83 .TP
84 .B blueOffset 0x2f
85 .TP
86 .B redExposure 0xa7
87 .TP
88 .B greenExposure 0x116
89 .TP
90 .B blueExposure 0xdc
91 These are the default values for offset and exposure time.
92 You can change them (e.g. to speed up calibration)
93 if you don't want to save the calibration data permanently.
94 .TP
95 .B vendorString "Artec"
96 .TP
97 .B modelString "E+ 48U"
98 By default, the scanner is reported as "Artec E+ 48U". If you don't like this, e.g.
99 because you have an Tevion MD 9693, then change the options accordingly.
100 .SH FILES
101 .TP
102 .I /usr/local/etc/sane.d/artec_eplus48u.conf
103 The backend configuration file (see also description of
104 .B SANE_CONFIG_DIR
105 below).
106 .TP
107 .I /usr/local/lib/sane/libsane\-artec_eplus48u.a
108 The static library implementing this backend.
109 .TP
110 .I /usr/local/lib/sane/libsane\-artec_eplus48u.so
111 The shared library implementing this backend (present on systems that
112 support dynamic loading).
113 .SH ENVIRONMENT
114 .TP
115 .B SANE_CONFIG_DIR
116 This environment variable specifies the list of directories that may
117 contain the configuration file. On *NIX systems, the directories are
118 separated by a colon (`:'), under OS/2, they are separated by a
119 semi-colon (`;'). If this variable is not set, the configuration file
120 is searched in two default directories: first, the current working
121 directory (".") and then in
122 .IR /etc/sane.d .
123 If the value of the environment variable ends with the directory
124 separator character, then the default directories are searched after
125 the explicitly specified directories. For example, setting
126 .B SANE_CONFIG_DIR
127 to "/tmp/config:" would result in directories
128 .IR tmp/config ,
129 .IR . ,
130 and
131 .I /etc/sane.d
132 being searched (in this order).
133 .TP
134 .B SANE_DEBUG_ARTEC_EPLUS48U
135 If the library was compiled with debug support enabled, this
136 environment variable controls the debug level for this backend. Higher
137 debug levels increase the verbosity of the output.
138
139 Example:
140 export SANE_DEBUG_ARTEC_EPLUS48U=3
141
142 .SH "SEE ALSO"
143 .BR sane (7),
144 .BR sane\-usb (5)
145
146 .SH AUTHOR
147 Michael Herder.
148 .br
149 This backend is based on the gt68xx test-program written by Sergey Vlasov, Andreas Nowack, and
150 David Stevenson. Thanks to everyone who tested the backend or reported bugs.
151 .br
152 This man page is based on man
153 .BR sane\-gt68xx (5),
154 written by Henning Meier-Geinitz.
155
156 .SH BUGS
157 This backend has been tested on Linux only. If you are using it on a different platform, please
158 contact us.
159 .PP
160 Interpolation with 1200 dpi is weak.
161 .PP
162 Support for buttons is missing due to missing support in SANE.
163 .PP
164 Please contact us if you find a bug:
165 .IR http://www.sane\-project.org/bugs.html .