Debian Codegraph @

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

raw
1 .TH sane\-abaton 5 "11 Jul 2008" "" "SANE Scanner Access Now Easy"
2 .IX sane\-abaton
3 .SH NAME
4 sane\-abaton \- SANE backend for Abaton flatbed scanners
5 .SH DESCRIPTION
6 The
7 .B sane\-abaton
8 library implements a SANE (Scanner Access Now Easy) backend that
9 provides access to Abaton flatbed scanners. At present, only the Scan
10 300/GS (8bit, 256 levels of gray) is fully supported, due to the
11 absence of programming information. The Scan 300/S (black and white)
12 is recognized, but support for it is untested.
13 .PP
14 If you own a Abaton scanner other than the ones listed above that
15 works with this backend, or if you own an Abaton scanner that does not
16 work with this backend, please contact
17 .IR sane\[email protected]
18 with the model number, so that arrangements can be made to include
19 support for it. Have a look at
20 .I http://www.sane\-project.org/mailing\-lists.html
21 concerning subscription to sane\-devel.
22 .PP
23 Abaton is out of business, and these scanners are not supported by
24 Everex (the parent company of Abaton), nor is there any programming
25 information to be found. This driver is therefore based on
26 information obtained by running Abaton's scanning desk accessory under
27 MacsBug and tracing the MacOS SCSI Manager calls it made during image
28 acquisition.
29 .PP
30 However, the protocol is very similar to, though not compatible with,
31 the one used by the Apple scanners, therefore, if this backend is ever
32 extended to support the other Abaton models (they also made a color
33 flatbed scanner), it may be possible to fill in some "missing pieces"
34 from the (quite detailed) Apple scanner documentation.
35
36 .SH "DEVICE NAMES"
37 This backend expects device names of the form:
38 .PP
39 .RS
40 .I special
41 .RE
42 .PP
43 Where
44 .I special
45 is the path-name for the special device that corresponds to a SCSI
46 scanner. For SCSI scanners, the special device name must be a generic
47 SCSI device or a symlink to such a device. Under Linux, such a device
48 name takes a format such as
49 .I /dev/sga
50 or
51 .IR /dev/sg0 ,
52 for example. See
53 .BR sane\-scsi (5)
54 for details.
55
56 .SH CONFIGURATION
57 The contents of the
58 .I abaton.conf
59 file is a list of device names that correspond to Abaton scanners.
60 Empty lines and lines starting with a hash mark (#) are ignored. See
61 .BR sane\-scsi (5)
62 on details of what constitutes a valid device name.
63
64 .SH FILES
65 .TP
66 .I /etc/sane.d/abaton.conf
67 The backend configuration file (see also description of
68 .B SANE_CONFIG_DIR
69 below).
70 .TP
71 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-abaton.a
72 The static library implementing this backend.
73 .TP
74 .I /usr/lib/x86_64-linux-gnu/sane/libsane\-abaton.so
75 The shared library implementing this backend (present on systems that
76 support dynamic loading).
77 .SH ENVIRONMENT
78 .TP
79 .B SANE_CONFIG_DIR
80 This environment variable specifies the list of directories that may
81 contain the configuration file. On *NIX systems, the directories are
82 separated by a colon (`:'), under OS/2, they are separated by a
83 semi-colon (`;'). If this variable is not set, the configuration file
84 is searched in two default directories: first, the current working
85 directory (".") and then in
86 .IR /etc/sane.d .
87 If the value of the environment variable ends with the directory separator
88 character, then the default directories are searched after the explicitly
89 specified directories. For example, setting
90 .B SANE_CONFIG_DIR
91 to "/tmp/config:" would result in directories
92 .IR tmp/config ,
93 .IR . ,
94 and
95 .I /etc/sane.d
96 being searched (in this order).
97 .TP
98 .B SANE_DEBUG_ABATON
99 If the library was compiled with debug support enabled, this
100 environment variable controls the debug level for this backend. E.g.,
101 a value of 255 requests all debug output to be printed. Smaller
102 levels reduce verbosity.
103
104 .SH BUGS
105 There are a few known ones, and definitely some unknown ones.
106 .TP
107 .B Scan area miscalculations
108 For the sake of programmer efficiency, this backend handles all
109 measurements in millimetres, and floors (rather than rounds) values to
110 avoid possible damage to the scanner mechanism. Therefore, it may not
111 be possible to scan to the extreme right or bottom edges of the page.
112 .TP
113 .B Cancelling the scan
114 This might not work correctly, or it might abort the frontend. The
115 former is more likely than the latter.
116 .PP
117 If you have found something that you think is a bug, please attempt to
118 recreate it with the SANE_DEBUG_ABATON environment variable set to
119 255, and send a report detailing the conditions surrounding the bug to
120 .IR sane\[email protected] .
121
122 .SH TODO
123 .TP
124 .B Implement non-blocking support
125 .TP
126 .B Finish reverse-engineering the MacOS driver
127 This will allow me to add support for other models with reasonable
128 confidence that it will work, as well as to fully exploit the
129 information returned by the INQUIRY command.
130
131 .SH "SEE ALSO"
132 .BR sane (7),
133 .BR sane\-scsi (5),
134 .BR scanimage (1)
135
136 .SH AUTHOR
137 The
138 .B sane\-abaton
139 backend was partially written by David Huggins-Daines,
140 based on the
141 .BR sane\-apple (5)
142 backend by Milon Firikis.