| 1 |
.TH sane\-hp 5 "13 Jul 2008" "" "SANE Scanner Access Now Easy" |
| 2 |
.IX sane\-hp |
| 3 |
.SH NAME |
| 4 |
sane\-hp \- SANE backend for HP ScanJet scanners |
| 5 |
.SH DESCRIPTION |
| 6 |
The |
| 7 |
.B sane\-hp |
| 8 |
library implements a SANE (Scanner Access Now Easy) backend that |
| 9 |
provides access to HP ScanJet scanners which support SCL (Scanner |
| 10 |
Control Language by HP). The following |
| 11 |
scanners are known positively to work with this backend: |
| 12 |
.PP |
| 13 |
.RS |
| 14 |
.ft CR |
| 15 |
.nf |
| 16 |
Model: Product id: Interface: |
| 17 |
---------- ----------- ---------- |
| 18 |
ScanJet Plus C9195A HP Parallel Interface Card |
| 19 |
ScanJet IIc C1750A 3226 SCSI |
| 20 |
ScanJet IIcx C2500A 3332 SCSI |
| 21 |
ScanJet IIp C1790A SCSI |
| 22 |
ScanJet 3C C2520A 3503 SCSI |
| 23 |
ScanJet 3P C2570A 3406 SCSI |
| 24 |
ScanJet 4C C2520A SCSI |
| 25 |
ScanJet 4P C1130A 3540 SCSI |
| 26 |
ScanJet 4100C C6290A USB |
| 27 |
ScanJet 5P C5110A SCSI |
| 28 |
ScanJet 5100C C5190A parallel port |
| 29 |
ScanJet 5200C C7190A 3846 parallel port/USB |
| 30 |
ScanJet 6100C C2520A 3644 SCSI |
| 31 |
ScanJet 6200C C6270A 3828 SCSI/USB |
| 32 |
ScanJet 6250C C6270A 3828 SCSI/USB |
| 33 |
ScanJet 6300C C7670A SCSI/USB |
| 34 |
ScanJet 6350C C7670A SCSI/USB |
| 35 |
ScanJet 6390C C7670A SCSI/USB |
| 36 |
PhotoSmart C5100A R029,R030,R032 SCSI |
| 37 |
.fi |
| 38 |
.ft R |
| 39 |
.RE |
| 40 |
.PP |
| 41 |
Support for models 5100C/5200C connected to the parallel port requires |
| 42 |
the ppSCSI driver available at |
| 43 |
.I http://cyberelk.net/tim/parport/ppscsi.html |
| 44 |
and |
| 45 |
.IR http://penguin-breeder.org/kernel/download/ . |
| 46 |
|
| 47 |
.PP |
| 48 |
Support for models 5200C/62X0C/63X0C connected to USB requires |
| 49 |
libusb. See |
| 50 |
.BR sane\-usb (5) |
| 51 |
for more details. |
| 52 |
.PP |
| 53 |
The |
| 54 |
.B sane\-hp |
| 55 |
backend no longer supports OfficeJet multi-function peripherals. |
| 56 |
For these devices use the external "hplip" packages available at: |
| 57 |
.IR https://developers.hp.com/hp\-linux\-imaging\-and\-printing/ . |
| 58 |
For information about the previous hpoj driver, see: |
| 59 |
.IR http://hpoj.sourceforge.net/ . |
| 60 |
.PP |
| 61 |
Because Hewlett-Packard does no longer produce scanners that support |
| 62 |
SCL (beside the OfficeJets), the above list of supported scanners is |
| 63 |
complete. |
| 64 |
Other HP scanners are not supported by the |
| 65 |
.B sane\-hp |
| 66 |
backend, but might be supported by another one. See |
| 67 |
.IR http://www.sane\-project.org/ . |
| 68 |
You can also watch the sane\-devel mailing list at |
| 69 |
.IR http://www.sane\-project.org/mailing\-lists.html . |
| 70 |
.PP |
| 71 |
More details about the hp backend can be found on its homepage |
| 72 |
.IR http://web.archive.org/web/20070206115546/http://www.kirchgessner.net/sane.html . |
| 73 |
.PP |
| 74 |
.SH "DEVICE NAMES" |
| 75 |
This backend expects device names of the form: |
| 76 |
.PP |
| 77 |
.RS |
| 78 |
.I special |
| 79 |
.RE |
| 80 |
.PP |
| 81 |
Where |
| 82 |
.I special |
| 83 |
is the UNIX path-name for the special device that corresponds to the |
| 84 |
scanner. For SCSI scanners the special device name must be a generic SCSI |
| 85 |
device or a symlink to such a device. Under Linux, such a device name could be |
| 86 |
.I /dev/sga |
| 87 |
or |
| 88 |
.IR /dev/sg2 , |
| 89 |
for example. If the special device name contains "usb", "uscanner" or "ugen", |
| 90 |
it is assumed that the scanner is connected by USB. |
| 91 |
For the HP ScanJet Plus the special device name must be the device |
| 92 |
that corresponds to the parallel interface card that was shipped with the |
| 93 |
scanner. That is |
| 94 |
.IR /dev/hpscan . |
| 95 |
A special driver is required for this card. |
| 96 |
See |
| 97 |
.I ftp://rvs.ctrl\-c.liu.se/pub/wingel/hpscan |
| 98 |
for details. If the link |
| 99 |
does not work, try |
| 100 |
.IR ftp://sunsite.unc.edu/pub/Linux/kernel/patches/scanners . |
| 101 |
.SH CONFIGURATION |
| 102 |
The contents of the |
| 103 |
.I hp.conf |
| 104 |
file is a list of options and device names that correspond to HP ScanJet |
| 105 |
scanners. Empty lines and lines starting with a hash mark |
| 106 |
(#) are ignored. See |
| 107 |
.BR sane\-scsi (5) |
| 108 |
and |
| 109 |
.BR sane\-usb (5) |
| 110 |
on details of what constitutes a valid device name. |
| 111 |
.PP |
| 112 |
Options specified in front of the first line that contains a device name |
| 113 |
are defaults for all devices. Options specified below a line that |
| 114 |
contains a device name apply just to the most recently mentioned device. |
| 115 |
.PP |
| 116 |
Supported options are |
| 117 |
.BR connect\-scsi , |
| 118 |
.BR connect\-device , |
| 119 |
.BR enable\-image\-buffering , |
| 120 |
and |
| 121 |
.BR dumb\-read . |
| 122 |
|
| 123 |
Option |
| 124 |
.B connect\-scsi |
| 125 |
specifies that the scanner is connected to the system by SCSI. |
| 126 |
Input/output is performed using SCSI-commands. This is the default. |
| 127 |
But if your SCSI device name contains "usb", "uscanner" or "ugen", |
| 128 |
option connect\-scsi must be specified. Otherwise it is assumed that |
| 129 |
the scanner is connected by USB. |
| 130 |
|
| 131 |
Option |
| 132 |
.B connect\-device |
| 133 |
specifies that the scanner is connected to the system by a special |
| 134 |
device. Input/output is performed by |
| 135 |
.BR read ()/ write "()-operations" |
| 136 |
on the device. This option must be used for HP ScanJet Plus |
| 137 |
or scanners connected to USB which are accessed through a named device |
| 138 |
(e.g. |
| 139 |
.IR /dev/usb/scanner0 ). |
| 140 |
For device names that contain "usb", "uscanner" or "ugen", it is not |
| 141 |
necessary to specify option connect\-device. |
| 142 |
|
| 143 |
Option |
| 144 |
.B enable\-image\-buffering |
| 145 |
stores the scanned image in memory before passing it to the frontend. Could be |
| 146 |
used in case of forward/backward moving scanner lamp. |
| 147 |
|
| 148 |
Option |
| 149 |
.B dumb\-read |
| 150 |
can be used to work around problems with "Error during device I/O". These |
| 151 |
problems may occur with certain SCSI-to-USB converters or Buslogic SCSI cards. |
| 152 |
The option should not be used for SCSI devices which are working correctly. |
| 153 |
Otherwise startup of frontends and changing parameters might be slower. |
| 154 |
.PP |
| 155 |
A sample configuration file is shown below: |
| 156 |
.PP |
| 157 |
.RS |
| 158 |
.ft CR |
| 159 |
.nf |
| 160 |
/dev/scanner |
| 161 |
# this is a comment |
| 162 |
/dev/hpscan |
| 163 |
option connect\-device |
| 164 |
.fi |
| 165 |
.ft R |
| 166 |
.RE |
| 167 |
.PP |
| 168 |
.I /dev/scanner |
| 169 |
is typically a symlink to the actual SCSI scanner device. |
| 170 |
.RE |
| 171 |
.SH FILES |
| 172 |
.TP |
| 173 |
.I /etc/sane.d/hp.conf |
| 174 |
The backend configuration file (see also description of |
| 175 |
.B SANE_CONFIG_DIR |
| 176 |
below). |
| 177 |
.TP |
| 178 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-hp.a |
| 179 |
The static library implementing this backend. |
| 180 |
.TP |
| 181 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-hp.so |
| 182 |
The shared library implementing this backend (present on systems that |
| 183 |
support dynamic loading). |
| 184 |
.TP |
| 185 |
.I $HOME/.sane/calib-hp:<device>.dat |
| 186 |
Calibration data for HP PhotoSmart PhotoScanner that is retrieved from the |
| 187 |
scanner after calibration. The data is uploaded to the scanner at start |
| 188 |
of the backend if it is in media mode 'print media' or if the media mode is |
| 189 |
changed to 'print media'. |
| 190 |
.SH ENVIRONMENT |
| 191 |
.TP |
| 192 |
.B SANE_CONFIG_DIR |
| 193 |
This environment variable specifies the list of directories that may |
| 194 |
contain the configuration file. On *NIX systems, the directories are |
| 195 |
separated by a colon (`:'), under OS/2, they are separated by a |
| 196 |
semi-colon (`;'). If this variable is not set, the configuration file |
| 197 |
is searched in two default directories: first, the current working |
| 198 |
directory |
| 199 |
.RI ( "." ) |
| 200 |
and then in |
| 201 |
.IR /etc/sane.d . |
| 202 |
If the value of the |
| 203 |
environment variable ends with the directory separator character, then |
| 204 |
the default directories are searched after the explicitly specified |
| 205 |
directories. For example, setting |
| 206 |
.B SANE_CONFIG_DIR |
| 207 |
to "/tmp/config:" would result in directories |
| 208 |
.IR "tmp/config" , |
| 209 |
.IR "." , |
| 210 |
and |
| 211 |
.I "/etc/sane.d" |
| 212 |
being searched (in this order). |
| 213 |
.TP |
| 214 |
.B SANE_DEBUG_HP |
| 215 |
If the library was compiled with debug support enabled, this |
| 216 |
environment variable controls the debug level for this backend. E.g., |
| 217 |
a value of 128 requests all debug output to be printed. Smaller |
| 218 |
levels reduce verbosity. |
| 219 |
.TP |
| 220 |
.B SANE_HOME_HP |
| 221 |
Only used for OS/2 and along with use of HP PhotoSmart PhotoScanner. |
| 222 |
Must be set to the directory where the directory |
| 223 |
.I .sane |
| 224 |
is located. Is used to save and read the calibration file. |
| 225 |
.TP |
| 226 |
.B SANE_HP_KEEPOPEN_SCSI |
| 227 |
.TP |
| 228 |
.B SANE_HP_KEEPOPEN_USB |
| 229 |
.TP |
| 230 |
.B SANE_HP_KEEPOPEN_DEVICE |
| 231 |
For each type of connection (connect\-scsi, connect\-usb, connect\-device) |
| 232 |
it can be specified if the connection to the device should be kept open ("1") |
| 233 |
or not ("0"). |
| 234 |
Usually the connections are closed after an operation is performed. |
| 235 |
Keeping connection open to SCSI-devices can result in errors during device IO |
| 236 |
when the scanner has not been used for some time. By default, USB-connections |
| 237 |
are kept open. Other connections are closed. |
| 238 |
.TP |
| 239 |
.B SANE_HP_RDREDO |
| 240 |
Specifies number of retries for read operation before returning an EOF error. |
| 241 |
Only supported for non-SCSI devices. Default: 1 retry. Time between retries |
| 242 |
is 0.1 seconds. |
| 243 |
|
| 244 |
.SH BUGS |
| 245 |
.TP |
| 246 |
.B HP PhotoSmart PhotoScanner |
| 247 |
In media mode 'slide' and 'negative', scan resolutions are rounded to |
| 248 |
multiple of 300 dpi. The scanner does not scale the data correctly |
| 249 |
on other resolutions. Some newer models (firmware code R030 and later) |
| 250 |
do not support adjustment of contrast/intensity level and tone map. |
| 251 |
The backend will simulate this by software, but only for gray |
| 252 |
and 24 bit color. |
| 253 |
.TP |
| 254 |
.B Automatic Document Feeder (ADF) |
| 255 |
For use of the ADF with |
| 256 |
.BR xscanimage (1), |
| 257 |
first place paper in the ADF and |
| 258 |
then change option scan source to 'ADF'. Press 'change document' |
| 259 |
to load a sheet. Then press 'scan' to start a scan. |
| 260 |
Maybe it is sufficient to press 'scan' without 'change document' |
| 261 |
for repeated scans. The use of the preview window is not recommended |
| 262 |
when working with the ADF. |
| 263 |
Setting a window to scan from ADF is not supported with |
| 264 |
.BR xscanimage (1). |
| 265 |
Try |
| 266 |
.BR xsane (1). |
| 267 |
.TP |
| 268 |
.B Immediate actions |
| 269 |
Some actions in |
| 270 |
.BR xscanimage (1) |
| 271 |
(i.e. unload, select media, calibrate) |
| 272 |
have an immediate effect on the scanner without starting a scan. |
| 273 |
These options can not be used with |
| 274 |
.BR scanimage (1). |
| 275 |
|
| 276 |
.SH TODO |
| 277 |
.TP |
| 278 |
.B HP PhotoSmart PhotoScanner |
| 279 |
PhotoScanners with firmware release R030 and up have |
| 280 |
no firmware support for contrast/brightness/gamma table. In the current |
| 281 |
backend this is simulated by software on 24 bits data. |
| 282 |
Simulation on 30 bits should give better results. |
| 283 |
.TP |
| 284 |
.B Data widths greater than 8 bits |
| 285 |
Custom gamma table does not work. |
| 286 |
.TP |
| 287 |
.B Parallel scanner support |
| 288 |
Beside the ScanJet Plus which came with its own parallel interface card, |
| 289 |
currently only the HP ScanJet 5100C/5200C are supported. |
| 290 |
These scanners are using an internal parallel-to-SCSI converter which |
| 291 |
is supported by the ppSCSI-driver (see above). |
| 292 |
|
| 293 |
.SH "SEE ALSO" |
| 294 |
.BR sane (7), |
| 295 |
.BR sane\-scsi (5), |
| 296 |
.BR sane\-usb (5) |
| 297 |
.BR scanimage (1), |
| 298 |
.BR xscanimage (1), |
| 299 |
.BR scanimage (1) |
| 300 |
|
| 301 |
.SH AUTHOR |
| 302 |
The sane\-hp backend was written by Geoffrey T. Dairiki. |
| 303 |
.br |
| 304 |
HP PhotoSmart PhotoScanner support by Peter Kirchgessner. |