1sane(7) SANE Scanner Access Now Easy sane(7)
2
6 sane - Scanner Access Now Easy: API for accessing scanners
7
10 SANE is an application programming interface (API) that provides stan‐
11 dardized access to any raster image scanner hardware. The standardized
12 interface makes it possible to write just one driver for each scanner
13 device instead of one driver for each scanner and application.
14 While SANE is primarily targeted at a UNIX environment, the standard
16 has been carefully designed to make it possible to implement the API on
17 virtually any hardware or operating system.
18 This manual page provides a summary of the information available about
20 SANE.
21 If you have trouble getting your scanner detected, read the PROBLEMS
23 section.
24
27 An application that uses the SANE interface is called a SANE frontend.
28 A driver that implements the SANE interface is called a SANE backend.
29 A meta backend provides some means to manage one or more other back‐
30 ends.
31
35 The package sane-backends contains backends, documentation, networking
36 support, and the command line frontend scanimage(1). The frontends
37 xscanimage(1), xcam(1), and scanadf(1) are included in the package
38 sane-frontends. Both packages can be downloaded from the SANE homepage
39 (http://www.sane-project.org/). Information about other frontends and
40 backends can also be found on the SANE homepage.
41
44 The following sections provide short descriptions and links to more
45 information about several aspects of SANE. A name with a number in
46 parenthesis (e.g. sane-dll(5)) points to a manual page. In this case
47 man 5 sane-dll will display the page. Entries like /usr/share/doc/sane-
48 backends/README are references to text files that were copied to the
49 SANE documentation directory (/usr/share/doc/sane-backends/) during
50 installation. Everything else is a URL to a resource on the web.
51 SANE homepage
54 Information on all aspects of SANE including a tutorial and a link to
55 the SANE FAQ can be found on the SANE homepage:
56 http://www.sane-project.org/.
57 SANE device lists
59 The SANE device lists contain information about the status of SANE
60 support for a specific device. If your scanner is not listed there
61 (either supported or unsupported), please contact us. See section HOW
62 CAN YOU HELP SANE for details. There are lists for specific releases
63 of SANE, for the current development version and a search engine:
64 http://www.sane-project.org/sane-supported-devices.html. The lists
65 are also installed on your system at /usr/share/doc/sane-backends/.
66 SANE mailing list
68 There is a mailing list for the purpose of discussing the SANE stan‐
69 dard and its implementations: sane-devel. Despite its name, the list
70 is not only intended for developers, but also for users. There are
71 also some more lists for special topics. However, for users,
72 sane-devel is the right list. How to subscribe and unsubscribe:
73 http://www.sane-project.org/mailing-lists.html.
74 SANE IRC channel
76 The IRC (Internet Relay Chat) channel #sane can be found on the
77 Freenode network (irc.freenode.net). It's for discussing SANE prob‐
78 lems, talking about development and general SANE related chatting.
79 Before asking for help, please read the other documentation mentioned
80 in this manual page. The channel's topic is also used for announce‐
81 ments of problems with SANE infrastructure (mailing lists, web
82 server, etc.).
83 Compiling and installing SANE
85 Look at /usr/share/doc/sane-backends/README and the os-dependent
86 README files for information about compiling and installing SANE.
87 SCSI configuration
89 For information about various systems and SCSI controllers see
90 sane-scsi(5).
91 USB configuration
93 For information about USB configuration see sane-usb(5).
94
97 scanimage
98 Command-line frontend. See scanimage(1).
99 saned
101 SANE network daemon that allows remote clients to access image acqui‐
102 sition devices available on the local host. See saned(8).
103 sane-find-scanner
105 Command-line tool to find SCSI and USB scanners and determine their
106 UNIX device files. See sane-find-scanner(1).
107 Also, have a look at the sane-frontends package (which includes xscan‐
109 image(1), xcam(1), and scanadf(1)) and the frontend information page at
110 http://www.sane-project.org/sane-frontends.html.
111
114 abaton
115 Supports Abaton flatbed scanners such as the Scan 300/GS (8bit, 256
116 levels of gray) and the Scan 300/S (black and white, untested). See
117 sane-abaton(5) for details.
118 agfafocus
120 Supports AGFA Focus scanners and the Siemens S9036 (untested). See
121 sane-agfafocus(5) for details.
122 apple
124 Supports Apple flatbed scanners including the following scanners:
125 AppleScanner, OneScanner and ColorOneScanner. See sane-apple(5) for
126 details.
127 artec
129 Supports several Artec/Ultima SCSI flatbed scanners as well as the
130 BlackWidow BW4800SP and the Plustek 19200S. See sane-artec(5) for
131 details.
132 artec_eplus48u
134 Supports the Artec E+ 48U scanner and re-badged models like Tevion MD
135 9693, Medion MD 9693, Medion MD 9705 and Trust Easy Webscan 19200.
136 See sane-artec_eplus48u(5) for details.
137 as6e
139 Supports the Artec AS6E parallel port interface scanner. See
140 sane-as6e(5) for details.
141 avision
143 Supports several Avision based scanners including the original Avi‐
144 sion scanners (like AV 630, AV 620, ...) as well as the HP ScanJet
145 53xx and 74xx series, Fujitsu ScanPartner, some Mitsubishi and
146 Minolta film-scanners. See sane-avision(5) for details.
147 bh
149 Supports Bell+Howell Copiscan II series document scanners. See
150 sane-bh(5) for details.
151 canon
153 Supports the CanoScan 300, CanoScan 600, and CanoScan 2700F SCSI
154 flatbed scanners. See sane-canon(5) for details.
155 canon630u
157 Supports the CanoScan 630u and 636u USB scanners. See
158 sane-canon630u(5) for details.
159 canon_dr
161 Supports the Canon DR-Series ADF SCSI and USB scanners. See
162 sane-canon_dr(5) for details.
163 canon_lide70
165 Supports the CanoScan LiDE 70 USB scanner. See sane-canon_lide70(5)
166 for details.
167 canon_pp
169 Supports the CanoScan FB330P, FB630P, N340P and N640P parallel port
170 scanners. See sane-canon_pp(5) for details.
171 cardscan
173 Support for Corex Cardscan USB scanners. See sane-cardscan(5) for
174 details.
175 coolscan coolscan2 coolscan3
177 Supports Nikon Coolscan film-scanners. See sane-coolscan(5),
178 sane-coolscan2(5) and sane-coolscan3(5) for details.
179 epjitsu
181 Supports Epson-based Fujitsu USB scanners. See sane-epjitsu(5) for
182 details.
183 epson
185 Supports Epson SCSI, parallel port and USB flatbed scanners. See
186 sane-epson(5) for details.
187 escl
189 Supports scanners through the eSCL protocol. See sane-escl(5) for
190 details.
191 fujitsu
193 Supports most Fujitsu SCSI and USB, flatbed and adf scanners. See
194 sane-fujitsu(5) for details.
195 genesys
197 Supports several scanners based on the Genesys Logic GL646, GL841,
198 GL843, GL847 and GL124 chips like the Medion 6471 and Hewlett-Packard
199 2300c.
200 See sane-genesys(5) for details.
201 gt68xx
203 Supports scanners based on the Grandtech GT-6801 and GT-6816 chips
204 like the Artec Ultima 2000 and several Mustek BearPaw CU and TA mod‐
205 els. Some Genius, Lexmark, Medion, Packard Bell, Plustek, and Trust
206 scanners are also supported. See sane-gt68xx(5) for details.
207 hp
209 Supports Hewlett-Packard ScanJet scanners which utilize SCL (Scanner
210 Control Language by HP). See sane-hp(5) for details.
211 hpsj5s
213 Supports the Hewlett-Packard ScanJet 5S scanner. See sane-hpsj5s(5)
214 for details.
215 hp3500
217 Supports the Hewlett-Packard ScanJet 3500 series. See sane-hp3500(5)
218 for details.
219 hp3900
221 Supports the Hewlett-Packard ScanJet 3900 series. See sane-hp3900(5)
222 for details.
223 hp4200
225 Supports the Hewlett-Packard ScanJet 4200 series. See sane-hp4200(5)
226 for details.
227 hp5400
229 Supports the Hewlett-Packard ScanJet 54XXC series. See sane-hp5400(5)
230 for details.
231 hpljm1005
233 Supports the Hewlett-Packard LaserJet M1005 scanner. See
234 sane-hpljm1005(5) for details.
235 hs2p
237 Supports the Ricoh IS450 family of SCSI scanners. See sane-hs2p(5)
238 for details.
239 ibm
241 Supports some IBM and Ricoh SCSI scanners. See sane-ibm(5) for
242 details.
243 kodak
245 Supports some large Kodak scanners. See sane-kodak(5) for details.
246 kodakaio
248 Supports Kodak AiO printer/scanners. See sane-kodakaio(5) for
249 details.
250 kvs1025
252 Supports Panasonic KV-S102xC scanners. See sane-kvs1025(5) for
253 details.
254 leo
256 Supports the LEO S3 and the Across FS-1130, which is a re-badged LEO
257 FS-1130 scanner. See sane-leo(5) for details.
258 lexmark
260 Supports the Lexmark X1100 series of USB scanners. See sane-lex‐
261 mark(5) for details.
262 ma1509
264 Supports the Mustek BearPaw 1200F USB flatbed scanner. See
265 sane-ma1509(5) for details.
266 magicolor
268 Supports the KONICA MINOLTA magicolor 1690MF multi-function
269 printer/scanner/fax. See sane-magicolor(5) for details.
270 matsushita
272 Supports some Panasonic KVSS high speed scanners. See sane-mat‐
273 sushita(5) for details.
274 microtek
276 Supports "second generation" Microtek scanners with SCSI-1 command
277 set. See sane-microtek(5) for details.
278 microtek2
280 Supports some Microtek scanners with a SCSI-2 command set. See
281 sane-microtek2(5) for details.
282 mustek
284 Supports most Mustek SCSI flatbed scanners including the Paragon and
285 ScanExpress series and the 600 II N and 600 II EP (non-SCSI). Some
286 Trust scanners are also supported. See sane-mustek(5) for details.
287 mustek_pp
289 Supports Mustek parallel port flatbed scanners. See sane-mustek_pp(5)
290 for details.
291 mustek_usb
293 Supports some Mustek ScanExpress USB flatbed scanners. See
294 sane-mustek_usb(5) for details.
295 mustek_usb2
297 Supports scanners using the SQ113 chipset like the Mustek BearPaw
298 2448 TA Pro USB flatbed scanner. See sane-mustek_usb2(5) for details.
299 nec
301 Supports the NEC PC-IN500/4C SCSI scanner. See sane-nec(5) for
302 details.
303 niash
305 Supports the Agfa Snapscan Touch and the HP ScanJet 3300c, 3400c, and
306 4300c USB flatbed scanners. See sane-niash(5) for details.
307 p5
309 Supports the Primax PagePartner. See sane-p5(5) for details.
310 pie
312 Supports Pacific Image Electronics (PIE) and Devcom SCSI flatbed
313 scanners. See sane-pie(5) for details.
314 pixma
316 Supports Canon PIXMA MP series (multi-function devices), Canon image‐
317 CLASS series (laser devices), Canon MAXIFY series and some Canon
318 CanoScan series. See sane-pixma(5) for details.
319 plustek
321 Supports USB flatbed scanners that use the National Semiconductor
322 LM983[1/2/3] chipset aka Merlin. Scanners using this LM983x chips
323 include some models from Plustek, KYE/Genius, Hewlett-Packard,
324 Mustek, Umax, Epson, and Canon. See sane-plustek(5) for details.
325 plustek_pp
327 Supports Plustek parallel port flatbed scanners using the Plustek
328 ASIC P96001, P96003, P98001 and P98003, which includes some models
329 from Plustek, KYE/Genius, Primax. See sane-plustek_pp(5) for details.
330 ricoh
332 Supports the Ricoh flatbed scanners IS50 and IS60. See sane-ricoh(5)
333 for details.
334 ricoh2
336 Supports the Ricoh flatbed scanners: SG-3100SNw, SP-100SU, and
337 SP-111SU. See sane-ricoh2(5) for details.
338 s9036
340 Supports Siemens 9036 flatbed scanners. See sane-s9036(5) for
341 details.
342 sceptre
344 Supports the Sceptre S1200 flatbed scanner. See sane-sceptre(5) for
345 details.
346 sharp
348 Supports Sharp SCSI scanners. See sane-sharp(5) for details.
349 sm3600
351 Supports the Microtek ScanMaker 3600 USB scanner. See sane-sm3600(5)
352 for details.
353 sm3840
355 Supports the Microtek ScanMaker 3840 USB scanner. See sane-sm3840(5)
356 for details.
357 snapscan
359 Supports AGFA SnapScan flatbed scanners including some which are
360 rebadged to other brands. See sane-snapscan(5) for details.
361 sp15c
363 Supports the Fujitsu FCPA ScanPartner 15C flatbed scanner. See
364 sane-sp15c(5) for details.
365 st400
367 Supports the Siemens ST400 and ST800. See sane-st400(5) for details.
368 tamarack
370 Supports Tamarack Artiscan flatbed scanners. See sane-tamarack(5) for
371 details.
372 teco1 teco2 teco3
374 Supports some TECO scanners, usually sold under the Relisys, Trust,
375 Primax, Piotech, Dextra names. See sane-teco1(5), sane-teco2(5) and
376 sane-teco3(5) for details.
377 u12
379 Supports USB flatbed scanners based on Plustek's ASIC 98003 (paral‐
380 lel-port ASIC) and a GeneSys Logics' USB-parport bridge chip like the
381 Plustek OpticPro U(T)12. See sane-u12(5) for details.
382 umax
384 Supports UMAX-SCSI-scanners and some Linotype Hell SCSI-scanners. See
385 sane-umax(5) for details.
386 umax_pp
388 Supports Umax parallel port flatbed scanners and the HP 3200C. See
389 sane-umax_pp(5) for details.
390 umax1200u
392 Supports the UMAX Astra 1220U (USB) flatbed scanner (and also the
393 UMAX Astra 2000U, sort of). See sane-umax1220u(5) for details.
394 xerox_mfp
396 Supports multiple Samsung-based Samsung, Xerox, and Dell scanners.
397 See sane-xerox_mfp(5) for details.
398 Also, have a look at the backend information page at
400 http://www.sane-project.org/sane-supported-devices.html and the list of
401 projects in /usr/share/doc/sane-backends/PROJECTS.
402
405 dc210
406 Supports the Kodak DC210 Digital Camera. See sane-dc210(5).
407 dc240
409 Supports the Kodak DC240 Digital Camera. See dc240(5).
410 dc25
412 Supports Kodak DC20/DC25 Digital Cameras. See dc25(5).
413 dmc
415 Supports the Polaroid Digital Microscope Camera. See dmc(5).
416 gphoto2
418 Supports digital cameras supported by the gphoto2 library package.
419 (See http://www.gphoto.org for more information and a list of sup‐
420 ported cameras.) Gphoto2 supports over 140 different camera models.
421 However, please note that more development and testing is needed
422 before all of these cameras will be supported by SANE backend. See
423 gphoto2(5).
424 qcam
426 Supports Connectix QuickCam cameras. See qcam(5).
427 stv680
429 Supports webcams with a stv680 chip. See stv680(5) for details.
430 Also, have a look at the backend information page at
432 http://www.sane-project.org/sane-supported-devices.html and the list of
433 projects in /usr/share/doc/sane-backends/PROJECTS.
434
437 dll
438 Implements a SANE backend that provides access to an arbitrary number
439 of other SANE backends by dynamic loading. See sane-dll(5).
440 net
442 The SANE network daemon saned(8) provides access to scanners located
443 on different computers in connection with the net backend. See
444 sane-net(5) and saned(8).
445 pnm
447 PNM image reader pseudo-backend. The purpose of this backend is pri‐
448 marily to aid in debugging of SANE frontends. See sane-pnm(5).
449 pint
451 Supports scanners that use the PINT (Pint Is Not Twain) device
452 driver. The PINT driver is being actively developed on the OpenBSD
453 platform, and has been ported to a few other *NIX-like operating sys‐
454 tems. See sane-pint(5).
455 test
457 Tests frontends and the SANE installation. It provides test pictures
458 and various test options. See sane-test(5).
459 v4l
461 Provides generic access to video cameras and similar equipment using
462 the V4L (Video for Linux) API. See sane-v4l(5).
463 Also, have a look at the backend information page at
465 http://www.sane-project.org/sane-supported-devices.html and the list of
466 projects in /usr/share/doc/sane-backends/PROJECTS.
467
470 By default, all SANE backends (drivers) are loaded dynamically by the
471 sane-dll meta backend. If you have any questions about the dynamic
472 loading, read sane-dll(5). SANE frontends can also be linked to other
473 backends directly by copying or linking a backend to libsane.so in
474 /usr/lib64/sane.
475
477 It's not hard to write a SANE backend. It can take some time, however.
478 You should have basic knowledge of C and enough patience to work
479 through the documentation and find out how your scanner works. Appended
480 is a list of some documents that help to write backends and frontends.
481 The SANE standard defines the application programming interface (API)
483 that is used to communicate between frontends and backends. It can be
484 found at http://sane-project.gitlab.io/standard/ .
485 There is some more information for programmers in /usr/share/doc/sane-
487 backends/backend-writing.txt. Most of the internal SANE routines
488 (sanei) are documented using doxygen:
489 http://www.sane-project.org/sanei/. Before a new backend or frontend
490 project is started, have a look at /usr/share/doc/sane-back‐
491 ends/PROJECTS for projects that are planned or not yet included into
492 the SANE distribution and at our bug-tracking system:
493 http://www.http://www.sane-project.org/bugs.html.
494 There are some links on how to find out about the protocol of a scan‐
496 ner: http://www.meier-geinitz.de/sane/misc/develop.html.
497 If you start writing a backend or frontend or any other part of SANE,
500 please contact the sane-devel mailing list for coordination so that
501 work is not duplicated.
502
505 /etc/sane.d/*.conf
506 The backend configuration files.
507 /usr/lib64/sane/libsane-*.a
509 The static libraries implementing the backends.
510 /usr/lib64/sane/libsane-*.so
512 The shared libraries implementing the backends (present on sys‐
513 tems that support dynamic loading).
514 /usr/share/doc/sane-backends/*
516 SANE documentation: The READMEs, text files for backends etc.
517
520 If your device isn't found but you know that it is supported, make sure
521 that it is detected by your operating system. For SCSI and USB scan‐
522 ners, use the sane-find-scanner(1) utility. It prints one line for
523 each scanner it has detected and some comments (#). If sane-find-scan‐
524 ner(1) finds your scanner only as root but not as normal user, the per‐
525 missions for the device files are not adjusted correctly. If the scan‐
526 ner isn't found at all, the operating system hasn't detected it and may
527 need some help. Depending on the type of your scanner, read sane-usb(5)
528 or sane-scsi(5). If your scanner (or other device) is not connected
529 over the SCSI bus or USB, read the backend's manual page for details on
530 how to set it up.
531 Is your scanner detected by the operating system but not by SANE? Try
533 scanimage -L. If the scanner is not found, check that the backend's
534 name is mentioned in /etc/sane.d/dll.conf. Some backends are commented
535 out by default. Remove the comment sign for your backend in this case.
536 Also some backends aren't compiled at all if one of their prerequisites
537 are missing. Examples include dc210, dc240, canon_pp, hpsj5s, gphoto2,
538 pint, qcam, v4l, net, sm3600, snapscan, pnm. If you need one of these
539 backends and it isn't available, read the build instructions in the
540 README file and the individual manual pages of the backends.
541 Another reason for not being detected by scanimage -L may be a missing
543 or incorrect configuration in the backend's configuration file. While
544 SANE tries to automatically find most scanners, some can't be setup
545 correctly without the intervention of the administrator. Also on some
546 operating systems auto-detection may not work. Check the backend's man‐
547 ual page for details.
548 If your scanner is still not found, try setting the various environment
550 variables that are available to assist in debugging. The environment
551 variables are documented in the relevant manual pages. For example, to
552 get the maximum amount of debug information when testing a Mustek SCSI
553 scanner, set environment variables SANE_DEBUG_DLL, SANE_DEBUG_MUSTEK,
554 and SANE_DEBUG_SANEI_SCSI to 128 and then invoke scanimage -L. The
555 debug messages for the dll backend tell if the mustek backend was found
556 and loaded at all. The mustek messages explain what the mustek backend
557 is doing while the SCSI debugging shows the low level handling. If you
558 can't find out what's going on by checking the messages carefully, con‐
559 tact the sane-devel mailing list for help (see REPORTING BUGS below).
560 Now that your scanner is found by scanimage -L, try to do a scan: scan‐
562 image >image.pnm. This command starts a scan for the default scanner
563 with default settings. All the available options are listed by running
564 scanimage --help. If scanning aborts with an error message, turn on
565 debugging as mentioned above. Maybe the configuration file needs some
566 tuning, e.g. to setup the path to a firmware that is needed by some
567 scanners. See the backend's manual page for details. If you can't find
568 out what's wrong, contact sane-devel.
569 To check that the SANE libraries are installed correctly you can use
571 the test backend, even if you don't have a scanner or other SANE
572 device:
573 scanimage -d test -T
575 You should get a list of PASSed tests. You can do the same with your
577 backend by changing "test" to your backend's name.
578 So now scanning with scanimage(1) works and you want to use one of the
580 graphical frontends like xsane(1), xscanimage(1), or quiteinsane(1) but
581 those frontends don't detect your scanner? One reason may be that you
582 installed two versions of SANE. E.g. the version that was installed by
583 your distribution in /usr and one you installed from source in
584 /usr/local/. Make sure that only one version is installed. Another
585 possible reason is, that your system's dynamic loader can't find the
586 SANE libraries. For Linux, make sure that /etc/ld.so.conf contains
587 /usr/local/lib and does not contain /usr/local/lib/sane. See also the
588 documentation of the frontends.
589
591 We appreciate any help we can get. Please have a look at our web page
592 about contributing to SANE: http://www.sane-project.org/contrib.html
593
595 For reporting bugs or requesting new features, please use our bug-
596 tracking system: http://www.sane-project.org/bugs.html. You can also
597 contact the author of your backend directly. Usually the email address
598 can be found in the /usr/share/doc/sane-backends/AUTHORS file or the
599 backend's manpage. For general discussion about SANE, please use the
600 SANE mailing list sane-devel (see http://www.sane-project.org/mail‐
601 ing-lists.html for details).
602
604 saned(8), sane-find-scanner(1), scanimage(1), sane-abaton(5),
605 sane-agfafocus(5), sane-apple(5), sane-artec(5),
606 sane-artec_eplus48u(5), sane-as6e(5), sane-avision(5), sane-bh(5),
607 sane-canon(5), sane-canon630u(5), sane-canon_dr(5), sane-canon_pp(5),
608 sane-cardscan(5), sane-coolscan(5), sane-coolscan2(5),
609 sane-coolscan3(5), sane-dc210(5), sane-dc240(5), sane-dc25(5),
610 sane-dll(5), sane-dmc(5), sane-epson(5), sane-escl(5), sane-fujitsu(5),
611 sane-genesys(5), sane-gphoto2(5), sane-gt68xx(5), sane-hp(5),
612 sane-hpsj5s(5), sane-hp3500(5), sane-hp3900(5), sane-hp4200(5),
613 sane-hp5400(5), sane-hpljm1005(5), sane-ibm(5), sane-kodak(5),
614 sane-leo(5), sane-lexmark(5), sane-ma1509(5), sane-matsushita(5),
615 sane-microtek2(5), sane-microtek(5), sane-mustek(5), sane-mustek_pp(5),
616 sane-mustek_usb(5), sane-mustek_usb2(5), sane-nec(5), sane-net(5),
617 sane-niash(5), sane-pie(5), sane-pint(5), sane-plustek(5), sane-plus‐
618 tek_pp(5), sane-pnm(5), sane-qcam(5), sane-ricoh(5), sane-ricoh2(5),
619 sane-s9036(5), sane-sceptre(5), sane-scsi(5), sane-sharp(5),
620 sane-sm3600(5), sane-sm3840(5), sane-snapscan(5), sane-sp15c(5),
621 sane-st400(5), sane-stv680(5), sane-tamarack(5), sane-teco1(5),
622 sane-teco2(5), sane-teco3(5), sane-test(5), sane-u12(5),
623 sane-umax1220u(5), sane-umax(5), sane-umax_pp(5), sane-usb(5),
624 sane-v4l(5), sane-xerox_mfp(5)
625
628 David Mosberger-Tang and many many more (see /usr/share/doc/sane-back‐
629 ends/AUTHORS for details). This man page was written by Henning Meier-
630 Geinitz. Quite a lot of text was taken from the SANE standard, several
631 man pages, and README files.
632 03 Jan 2020 sane(7)