summaryrefslogtreecommitdiff
path: root/doc/sane-rts8891.man
blob: 95d028bcb899844d649e1ed2f85dfda28af4473c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
.TH "sane\-rts8891" "5" "8 Dec 2008" "@PACKAGEVERSION@" "SANE Scanner Access Now Easy"
.SH "NAME"
sane\-rts8891 \- SANE backend for rts8891 based scanners
.SH "DESCRIPTION"
The
.B sane\-rts8891
library implements a SANE (Scanner Access Now Easy) backend that
provides access to scanners based on the rts8891 ASIC.
.PP
The scanners that work with this backend are:
.PP
.RS
.ft CR
.nf
   Vendor Model           status
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-  \-\-\-\-\-\-\-\-\-\-\-
  Umax Astra 4400       untested
  Umax Astra 4450       untested
  HP scanjet 4000c      good
  HP scanjet 4470c      good
.fi
.ft R
.RE

The options the backend supports can either be selected through
command line options to programs like
.BR scanimage (1)
or through GUI elements in
.BR xscanimage (1)
or
.BR xsane (1).

.br
If you notice any strange behavior, please report to the backend
maintainer or to the SANE mailing list.

Valid command line options and their syntax can be listed by using

.RS
scanimage \-\-help \-d rts8891
.RE

.TP
.B Scan Mode Options

.TP
.B \-\-mode
selects the basic mode of operation of the scanner. Valid choices are
.IR "Color" ,
.I Gray
and
.IR Lineart .
The default mode is
.IR Color .
The
.I Lineart
mode is for black and white only (1 bit).
.I Gray
will produce 256 levels of gray (8 bits).
.I Color
mode allows for over 16 million different colors produced from
24 bits of color information.

.TP
.B \-\-resolution
selects the resolution for a scan. The horizontal and vertical resolutions are set
by the value of this option. The scanner is capable of the following resolutions for the specified option value:
.PP
.RS
.ft CR
.nf
  Value   Hor. Resolution  Vert. Resolution
  \-\-\-\-\-   \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
  75      75dpi            75dpi
  150     150dpi           150dpi
  300     300dpi           300dpi
  600     600dpi           600dpi
  1200    1200dpi          1200dpi
.fi
.ft R
.RE

.TP
.B \-\-preview
requests a preview scan. The resolution used for that scan is 75 dpi
and the scan area and the scan mode are as specified through their options,
or the default if not specified. The default value for preview mode is "no".

.TP
.B \-\-threshold
selects the  minimum\-brightness to get a white point. The threshold is only used with Lineart mode scans.
It is specified as a percentage in the range 0..100% (in steps of 1).
The default value of the threshold option is 50.


.SH "CONFIGURATION FILE"
The configuration file
.I @CONFIGDIR@/rts8891.conf
contains the usb device ids of supported scanners (eg usb 0x043d 0x007c) and scanner configuration options.
Empty lines and lines starting with a hash mark (#) are
ignored.
.PP
The options supported are
.BR allowsharing ,
.B modelnumber
.

Option
.TP
.B allowsharing
enables or not the sharing of the scanner between multiple frontends at the same time.
.TP
.B modelnumber
is used to force the reported model by the backend and is only useful in the case of a scanner which NVRAM has been erased.

.RS
.ft CR
.nf
0 to report a HP4470c.
1 to report a HP4400c.
2 to report an Astra 4400.
.fi
.ft R
.RE

.SH "FILES"
.TP
.I @LIBDIR@/libsane\-rts8891.a
The static library implementing this backend.
.TP
.I @LIBDIR@/libsane\-rts8891.so
The shared library implementing this backend (present on systems that
support dynamic loading).

.SH "ENVIRONMENT"
.TP
.B SANE_DEBUG_RTS8891 SANE_DEBUG_RTS8891_LOW SANE_DEBUG_RTS88XX_LIB
If the library was compiled with debug support enabled, these
environment variables control the debug level for this backend. E.g.,
a value of 255 requests all debug output to be printed. Smaller levels
reduce verbosity.

.SH "LIMITATIONS"
Scanners of the same model exist with different sensors, due to lack of data
(ie USB logs) some sensors are better supported than others. At least 75 dpi
mode is working for any model. Sharing the scanner between several frontends
at the same time (allowsharing option) may not work on some USB controllers.
.PP
XPA is not (yet) supported.
.SH "BUGS"
.br
No bugs currently known.

.SH "SEE ALSO"
.BR sane\-scsi (5),
.BR scanimage (1),
.BR xscanimage (1),
.BR xsane (1),
.BR sane (7)

.SH "AUTHOR"
.TP
This backend has been developed by St\['e]phane Voltz.
.I http://stef.dev.free.fr/sane/rts8891

.SH "CREDITS"
.TP
Many thanks go to:
Laurent Fournier who donated me a HP4470c.
Vladimir Sysoev and "TheUnruly Squash" for the time they spent recording
USB activity and testing the experimental version on HP4400 models.