Debian Codegraph @

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

raw
1 .TH sane\-fujitsu 5 "24 Mar 2023" "" "SANE Scanner Access Now Easy"
2 .IX sane\-fujitsu
3
4 .SH NAME
5 sane\-fujitsu \- SANE backend for Fujitsu and Ricoh fi series scanners
6
7 .SH DESCRIPTION
8 The
9 .B sane\-fujitsu
10 library implements a SANE (Scanner Access Now Easy) backend which provides
11 access to most Fujitsu flatbed and ADF scanners, and the subsequent Ricoh models.
12
13 This document describes backend version 140.
14
15 .SH SUPPORTED HARDWARE
16 This version supports every known model which speaks the Fujitsu SCSI and
17 SCSI\-over\-USB protocols. Specifically, the SCSI M309x and M409x series, the
18 SCSI fi\-series, and most of the USB fi\-, ScanSnap, & iX series scanners are
19 supported. Please see the list at
20 .I http://www.sane\-project.org/sane\-supported\-devices.html
21 for details.
22
23 This backend may support other Fujitsu or newer Ricoh scanners. The best
24 way to determine level of support is to test the scanner directly,
25 or to collect a trace of the windows driver in action.
26 Please contact the author for help or with test results.
27
28 .SH UNSUPPORTED HARDWARE
29 The following scanners are known NOT to work with this backend,
30 either because they have an unsupported chipset, or an unsupported
31 interface type. Some of these scanners may be supported by another
32 backend.
33 .PP
34 .RS
35 .ft CR
36 .nf
37 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
38 SCSI: SERIAL: USB:
39 \-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\- \-\-\-\-\-\-\-\-\-\-\-\-
40 ScanStation M3093E/DE/EX fi\-4110EOX/2
41 ScanPartner M3096EX fi\-4010CU
42 SP\-Jr M3097E+/DE S300/S300M
43 SP\-10/10C M3099A/EH/EX S1300/S1100
44 SP\-15C/300C fi\-60F/65F
45 SP\-600C/620C fi\-5015C
46 SP\-2x/3x
47 .fi
48 .ft R
49 .RE
50 .P
51
52 .SH OPTIONS
53 Effort has been made to expose all hardware options, including:
54 .PP
55 .B source s
56 .RS
57 Selects the source for the scan. Options
58 may include "Flatbed", "ADF Front", "ADF Back", "ADF Duplex", "Card Front", "Card Back", "Card Duplex".
59 .RE
60 .PP
61 .B mode m
62 .RS
63 Selects the mode for the scan. Options
64 may include "Lineart", "Halftone", "Gray", and "Color".
65 .RE
66 .PP
67 .B resolution, y\-resolution
68 .RS
69 Controls scan resolution. Setting
70 .B \-\-resolution
71 also sets
72 .BR \-\-y\-resolution,
73 though this behavior is overridden by some frontends.
74 .RE
75 .PP
76 .B tl\-x, tl\-y, br\-x, br\-y
77 .RS
78 Sets scan area upper left and lower right coordinates. These are renamed
79 .B t, l, x, y
80 by some frontends.
81 .RE
82 .PP
83 .B page\-width, page\-height
84 .RS
85 Sets paper size. Used by scanner to determine centering of scan
86 coordinates when using the ADF (Automatic Document Feeder) and to detect
87 double feed errors.
88 .RE
89 .PP
90 Other options will be available based on the capabilities of the scanner:
91 machines with IPC or DTC will have additional enhancement options, those
92 with CMP will have compression options, those with a printer will have a
93 group of endorser options.
94
95 Additionally, several 'software' options are exposed by the backend. These
96 are reimplementations of features provided natively by larger scanners, but
97 running on the host computer. This enables smaller machines to have similar
98 capabilities. Please note that these features are somewhat simplistic, and
99 may not perform as well as the native implementations. Note also that these
100 features all require that the driver cache the entire image in memory. This
101 will almost certainly result in a reduction of scanning speed.
102 .PP
103 .B swcrop
104 .RS
105 Requests the driver to detect the extremities of the paper within the larger
106 image, and crop the empty edges.
107 .RE
108 .PP
109 .B swdeskew
110 .RS
111 Requests the driver to detect the rotation of the paper within the larger
112 image, and counter the rotation.
113 .RE
114 .PP
115 .B swdespeck X
116 .RS
117 Requests the driver to find and remove dots of X diameter or smaller from the
118 image, and fill the space with the average surrounding color.
119 .RE
120
121 Use
122 .I 'scanimage \-\-help'
123 to get a list, but be aware that some options may
124 be settable only when another option has been set, and that advanced options
125 may be hidden by some frontend programs.
126
127 .SH CONFIGURATION FILE
128 The configuration file
129 .I fujitsu.conf
130 is used to tell the backend how to look
131 for scanners, and provide options controlling the operation of the backend.
132 This file is read each time the frontend asks the backend for a list
133 of scanners, generally only when the frontend starts. If the configuration
134 file is missing, the backend will be unable to locate any scanners.
135 .PP
136 Scanners can be specified in the configuration file in 4 ways:
137 .PP
138 "scsi FUJITSU"
139 .RS
140 Requests backend to search all scsi buses in the system for a device
141 which reports itself to be a scanner made by 'FUJITSU'.
142 .RE
143 .PP
144 "scsi /dev/sg0" (or other scsi device file)
145 .RS
146 Requests backend to open the named scsi device. Only useful if you have
147 multiple compatible scanners connected to your system, and need to
148 specify one. Probably should not be used with the other "scsi" line above.
149 .RE
150 .PP
151 "usb 0x04c5 0x1042" (or other vendor/product ids)
152 .RS
153 Requests backend to search all usb buses in the system for a device
154 which uses that vendor and product id. The device will then be queried
155 to determine if it is a supported scanner.
156 .RE
157 .PP
158 "usb /dev/usb/scanner0" (or other device file)
159 .RS
160 Some systems use a kernel driver to access usb scanners. This method is
161 untested.
162 .RE
163 .PP
164 The only configuration option supported is "buffer\-size=xxx", allowing you
165 to set the number of bytes in the data buffer to something other than the
166 compiled\-in default, 65536 (64K). Some users report that their scanner will
167 "hang" mid\-page, or fail to transmit the image if the buffer is not large
168 enough.
169 .PP
170 Note: This option may appear multiple times in the configuration file. It only
171 applies to scanners discovered by 'scsi/usb' lines that follow this option.
172 .PP
173 Note: The backend does not place an upper bound on this value, as some users
174 required it to be quite large. Values above the default are not recommended,
175 and may crash your OS or lockup your scsi card driver. You have been
176 warned.
177 .PP
178
179 .SH ENVIRONMENT
180 The backend uses a single environment variable,
181 .BR SANE_DEBUG_FUJITSU ,
182 which enables debugging output to stderr. Valid values are:
183 .PP
184 .RS
185 5 Errors
186 .br
187 10 Function trace
188 .br
189 15 Function detail
190 .br
191 20 Option commands
192 .br
193 25 SCSI/USB trace
194 .br
195 30 SCSI/USB writes
196 .br
197 31 SCSI/USB reads
198 .br
199 35 Useless noise
200 .RE
201
202 .SH KNOWN ISSUES
203 Flatbed units may fail to scan at maximum area, particularly at
204 high resolution.
205 .PP
206 Any model that does not support VPD during inquiry will not function until
207 an override is added to the backend.
208 .PP
209 CCITT Fax compression used by older scanners is not supported.
210 .PP
211 JPEG output is supported by the backend, but not by the SANE protocol, so is
212 disabled in this release. It can be enabled if you rebuild from source.
213 .PP
214 Network interfaces are not supported on any scanner model.
215
216 .SH CREDITS
217 m3091 backend: Frederik Ramm
218 .RI < "frederik a t remote d o t org" >
219 .br
220 m3096g backend: Randolph Bentson
221 .RI < "bentson a t holmsjoen d o t com" >
222 .br
223 (with credit to the unnamed author of the coolscan driver)
224 .br
225 fujitsu backend, m3093, fi\-4340C, ipc, cmp, long\-time maintainer:
226 .br
227 Oliver Schirrmeister
228 .RI < "oschirr a t abm d o t de" >
229 .br
230 m3092: Mario Goppold
231 .RI < "mgoppold a t tbzpariv d o t tcc\-chemnitz dot de" >
232 .br
233 fi\-4220C and basic USB support: Ron Cemer
234 .RI < "ron a t roncemer d o t com" >
235 .br
236 fi\-4120, fi\-series color, backend re\-write, jpeg, current maintainer:
237 m. allan noah:
238 .RI < "kitno455 a t gmail d o t com" >
239
240 JPEG output and low memory usage support funded by:
241 Archivista GmbH
242 .I www.archivista.ch
243
244 Endorser support funded by:
245 O A S Oilfield Accounting Service Ltd
246 1500, 840 \- 7th Avenue S.W.
247 Calgary, Alberta
248 T2P 3G2 Canada
249 1\-403\-263\-2600
250 .I www.oas.ca
251
252 Automatic length detection support funded by:
253 Martin G. Miller
254 .I mgmiller at optonline.net
255
256 Hardware donated, software image enhancement and fi-6/7xxx support funded by:
257 PFU America, Inc.
258 .I fujitsuscanners.com
259
260 iX500 support funded by:
261 Prefix Computer Services
262 .I www.prefixservice.com
263
264 .SH "SEE ALSO"
265 .BR sane (7),
266 .BR sane\-scsi (5),
267 .BR sane\-usb (5),
268 .BR sane\-sp15c (5),
269 .BR sane\-avision (5),
270 .BR sane\-epjitsu (5)
271
272 .SH AUTHOR
273 m. allan noah: <kitno455 a t gmail d o t com>