Debian Codegraph @

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

raw
1 .TH sane\-stv680 5 "11 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-stv680
3 .SH NAME
4 sane\-stv680 \- SANE backend for STV680 camera's
5 .SH DESCRIPTION
6 The
7 .B sane\-stv680
8 library implements a SANE (Scanner Access Now Easy) backend that
9 provides access to some STV680 cameras. This backend
10 should be considered
11 .B beta-quality
12 software! STV680 cameras are sold under
13 various brands like Aiptek.
14 This backend may or may not support yours.
15 .PP
16 The cameras that should work with this backend are:
17 .PP
18 .ft CR
19 .nf
20 Vendor Model USB vendor id USB product id status
21 ------------------------ ------------- -------------- --------
22 AIPTEK stv680 0x0553 0x0202 basic
23 Konica e-mini 0x04c8 0x0722 untested
24 DigitalDream l'espion XS 0x1183 0x0001 untested
25 Creative WebCam Go mini 0x041e 0x4007 untested
26 .fi
27 .ft R
28
29 For all these cameras, see the backend home page (under AUTHOR)
30 for the exact status of each camera.
31
32 For startup of this backend check that if present the stv680 kernel module is
33 removed or disabled.
34 .br
35 Also before using, enable the backend by editing the
36 .I /etc/sane.d/dll.conf
37 file, change #stv680 to stv680.
38
39 For problems with the untested cameras, you should contact the author for that.
40
41 The options the backend supports can either be selected through
42 command line options to programs like
43 .BR scanimage (1)
44 or through GUI elements in
45 .BR xcam (1).
46 For both programs use the
47 .B \-B
48 option needed for size buffer.
49
50 Some frontends examples:
51
52 .br
53 .BR xcam (1)
54 .RS
55 xcam \-B
56 .RE
57
58 .BR scanimage (1):
59 for writing in batch mode to a file or to a new file each time:
60
61 .RS
62 scanimage \-B \-d stv680:libusb:001:002 \-\-batch=out.ppm \-\-batch-count 5 \-\-mode "Color RGB"
63 .RE
64 .RS
65 scanimage \-B \-d stv680:libusb:001:002 \-\-batch=out%d.ppm \-\-batch-count 5 \-\-mode "Color RGB"
66 .RE
67
68 .br
69 If you have any success with a camera not listed here, or if you observe
70 any strange behavior, please report to the backend maintainer or to
71 the SANE mailing list.
72
73 Valid command line options and their syntax can be listed by using:
74
75 .RS
76 scanimage \-\-help \-d stv680
77 .RE
78
79
80 .TP
81 .B Scan Mode
82
83 .TP
84 .B \-\-mode
85 selects the basic mode of operation of the webcam's valid choices.
86
87 The read resolution mode is 8 bits, output resolution is 24 bits.
88 Selects the resolution for a scan.
89 The camera can do only the resolutions listed.
90 .TP
91 .B \-\-Raw
92 In this mode raw data is displayed
93 .TP
94 .B \-\-Color
95 In this mode the bayer unshuffle is done but no color correction
96 .TP
97 .B \-\-Color_RGB
98 Bayer unshuffle, color correction
99 .TP
100 .B \-\-Color_RGB_TXT
101 Bayer unshuffle, color correction, textline with date and time is added
102
103
104 .TP
105 .B Enhancement options
106
107 .TP
108 .B \-\-white\-level\-r \-32..+32
109 Selects what red radiance level should be
110 considered "white", when scanning some sheets by changing the calibration
111 value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1.
112
113 .TP
114 .B \-\-white\-level\-g \-32..+32
115 Selects what green radiance level should be
116 considered "white", when scanning some sheets by changing the calibration
117 value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1.
118
119 .TP
120 .B \-\-white\-level\-b \-32..+32
121 Selects what blue radiance level should be
122 considered "white", when scanning some sheets by changing the calibration
123 value loaded into the scanner. Scale \-32 .. 0 .. +32 in steps of 1.
124
125 .SH CONFIGURATION FILE
126 The configuration file
127 .I /etc/sane.d/stv680.conf
128 supports only one item: the device name to use (eg usb 0x.... 0x....).
129
130 .SH FILES
131 .TP
132 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-stv680.a
133 The static library implementing this backend.
134 .TP
135 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-stv680.so
136 The shared library implementing this backend (present on systems that
137 support dynamic loading).
138
139 .SH ENVIRONMENT
140 .TP
141 .B SANE_DEBUG_STV680
142 If the library was compiled with debug support enabled, this
143 environment variable controls the debug level for this backend. E.g.,
144 a value of 128 requests all debug output to be printed. Smaller levels
145 reduce verbosity.
146
147 .SH LIMITATIONS
148 The windows TWAIN driver has many more options than this SANE
149 backend. However they are only software adjustments. This backend only
150 implements what the webcam can support.
151
152 .SH BUGS
153 .TP
154 Plenty. Parts of this backend are still under development.
155 1. Some untested cameras.
156 .br
157 2. Video streaming slow and stops sometimes (scanimage).
158 .br
159 3. Sometimes 1/3 of image is NOK (xcam).
160
161
162 .SH "SEE ALSO"
163 .BR sane (7),
164 .BR sane\-usb (5),
165 .BR scanimage (1),
166 .BR xcam (1)
167
168 .SH AUTHORS
169 Gerard Klaver
170 .I http://gkall.hobby.nl/stv680-aiptek.html
171
172 .SH CREDITS
173 .TP
174 Thanks to developers of the other stv680 programs:
175 STV680 kernel module
176 .br
177 pencam2 program
178 .br
179 .BR libghoto2 (3)
180 program (camlib stv0680)