| 1 |
.TH sane\-st400 5 "14 Jul 2008" "" "SANE Scanner Access Now Easy" |
| 2 |
.IX sane\-st400 |
| 3 |
.SH NAME |
| 4 |
sane\-st400 \- SANE backend for Siemens ST/Highscan flatbed scanners |
| 5 |
.SH DESCRIPTION |
| 6 |
The |
| 7 |
.B sane\-st400 |
| 8 |
library implements a SANE (Scanner Access Now Easy) backend that |
| 9 |
provides access to Siemens ST400 flatbed scanners and compatibles. |
| 10 |
At present, the following scanners are supported by this backend: |
| 11 |
.PP |
| 12 |
.RS |
| 13 |
Siemens ST400 (6 bit gray scale) |
| 14 |
.br |
| 15 |
Siemens ST800 (6 bit gray scale) |
| 16 |
.br |
| 17 |
.RE |
| 18 |
.PP |
| 19 |
The driver supports line art and gray scans up to 8bpp. |
| 20 |
.PP |
| 21 |
The Siemens ST/Highscan series includes several more models, e.g. the ST300 |
| 22 |
and ST600. If you own one of these scanners, or a scanner other than the |
| 23 |
ones listed above that works with this backend, please let us know by sending |
| 24 |
the scanner's model name, SCSI ID, and firmware revision to |
| 25 |
.IR sane\[email protected] . |
| 26 |
Have a look at |
| 27 |
.I http://www.sane\-project.org/mailing\-lists.html |
| 28 |
concerning subscription to sane\-devel. |
| 29 |
|
| 30 |
.SH "DEVICE NAMES" |
| 31 |
This backend expects device names of the form: |
| 32 |
.PP |
| 33 |
.RS |
| 34 |
.I special |
| 35 |
.RE |
| 36 |
.PP |
| 37 |
Where |
| 38 |
.I special |
| 39 |
is the path-name for the special device that corresponds to a |
| 40 |
SCSI scanner. For SCSI scanners, the special device name must be a |
| 41 |
generic SCSI device or a symlink to such a device. Under Linux, such |
| 42 |
a device name could be |
| 43 |
.I /dev/sga |
| 44 |
or |
| 45 |
.IR /dev/sge , |
| 46 |
for example. See |
| 47 |
.BR sane\-scsi (5) |
| 48 |
for details. |
| 49 |
|
| 50 |
.SH CONFIGURATION |
| 51 |
The contents of the |
| 52 |
.I st400.conf |
| 53 |
file is a list of device names that correspond to Siemens |
| 54 |
scanners. Empty lines and lines starting with a hash mark (#) are |
| 55 |
ignored. A sample configuration file is shown below: |
| 56 |
.PP |
| 57 |
.RS |
| 58 |
/dev/scanner |
| 59 |
.br |
| 60 |
# this is a comment |
| 61 |
.br |
| 62 |
/dev/sge |
| 63 |
.RE |
| 64 |
.PP |
| 65 |
The default configuration file that is distributed with SANE looks like |
| 66 |
this: |
| 67 |
.PP |
| 68 |
.RS |
| 69 |
scsi SIEMENS "ST 400" Scanner * * 3 0 |
| 70 |
.RE |
| 71 |
.PP |
| 72 |
In this configuration, the driver can only access the ST400 model |
| 73 |
at SCSI ID 3 LUN 0 (see section |
| 74 |
.B BUGS |
| 75 |
below for the reason). |
| 76 |
To use the driver with other scanner models, add an appropriate line to |
| 77 |
the configuration file. For example, to use it with an ST800 at SCSI |
| 78 |
ID 3 LUN 0, add the line: |
| 79 |
.PP |
| 80 |
.RS |
| 81 |
scsi SIEMENS "ST 800" Scanner * * 3 0 |
| 82 |
.RE |
| 83 |
|
| 84 |
.SH FILES |
| 85 |
.TP |
| 86 |
.I /etc/sane.d/st400.conf |
| 87 |
The backend configuration file (see also description of |
| 88 |
.B SANE_CONFIG_DIR |
| 89 |
below). |
| 90 |
.TP |
| 91 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-st400.a |
| 92 |
The static library implementing this backend. |
| 93 |
.TP |
| 94 |
.I /usr/lib/x86_64-linux-gnu/sane/libsane\-st400.so |
| 95 |
The shared library implementing this backend (present on systems that |
| 96 |
support dynamic loading). |
| 97 |
.SH ENVIRONMENT |
| 98 |
.TP |
| 99 |
.B SANE_CONFIG_DIR |
| 100 |
This environment variable specifies the list of directories that may |
| 101 |
contain the configuration file. On *NIX systems, the directories are |
| 102 |
separated by a colon (`:'), under OS/2, they are separated by a |
| 103 |
semi-colon (`;'). If this variable is not set, the configuration file |
| 104 |
is searched in two default directories: first, the current working |
| 105 |
directory (".") and then in |
| 106 |
.IR /etc/sane.d . |
| 107 |
If the value of the |
| 108 |
environment variable ends with the directory separator character, then |
| 109 |
the default directories are searched after the explicitly specified |
| 110 |
directories. For example, setting |
| 111 |
.B SANE_CONFIG_DIR |
| 112 |
to "/tmp/config:" would result in directories |
| 113 |
.IR "tmp/config" , |
| 114 |
.IR "." , |
| 115 |
and |
| 116 |
.I /etc/sane.d |
| 117 |
being searched (in this order). |
| 118 |
.TP |
| 119 |
.B SANE_DEBUG_ST400 |
| 120 |
If the library was compiled with debug support enabled, this environment |
| 121 |
variable controls the debug level for this backend. E.g., a value of 128 |
| 122 |
requests all debug output to be printed. Smaller levels reduce verbosity. |
| 123 |
|
| 124 |
.SH MISSING FUNCTIONALITY |
| 125 |
|
| 126 |
Everything but the most basic stuff. |
| 127 |
|
| 128 |
.SH BUGS |
| 129 |
Currently, the backend does not check if the attached device really is |
| 130 |
a ST400. It will happily accept everything that matches the configuration |
| 131 |
entries. This makes it easy to test the backend with other scanners: |
| 132 |
Just add an appropriate line to the configuration file. The configuration |
| 133 |
file as distributed (see above) only works with the ST400. Be careful: |
| 134 |
If there is no config file at all, the backend defaults to |
| 135 |
.IR /dev/scanner . |
| 136 |
.PP |
| 137 |
The ST400 answers on all eight SCSI LUNs. Normally this is not a problem, |
| 138 |
as LUN support is usually disabled in SCSI drivers, but if you are seeing |
| 139 |
multiple instances of the scanner in a device list, either disable LUNs in |
| 140 |
your SCSI setup or change the entry in the configuration file to match |
| 141 |
LUN 0 only. |
| 142 |
|
| 143 |
.SH DEBUG |
| 144 |
If you encounter a bug please set the environment variable |
| 145 |
.B SANE_DEBUG_ST400 |
| 146 |
to 128 and try to regenerate the problem. Then send me a report with the |
| 147 |
log attached. |
| 148 |
.PP |
| 149 |
If you encounter a SCSI bus error or trimmed and/or displaced images please |
| 150 |
also set the environment variable |
| 151 |
.B SANE_DEBUG_SANEI_SCSI |
| 152 |
to 128 before sending me the report. |
| 153 |
|
| 154 |
.SH "SEE ALSO" |
| 155 |
.BR sane (7), |
| 156 |
.BR sane\-scsi (5) |
| 157 |
.br |
| 158 |
.I http://www.informatik.uni-oldenburg.de/~ingo/sane/ |
| 159 |
|
| 160 |
.SH AUTHOR |
| 161 |
Ingo Wilken |
| 162 |
.RI < [email protected] > |