1 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
2 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
3 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
4 | %general-entities;
|
---|
5 |
|
---|
6 | <!ENTITY sane-be-download-http "http://gd.tuwien.ac.at/api/sane/sane-backends-&sane-version;/sane-backends-&sane-version;.tar.gz">
|
---|
7 | <!ENTITY sane-be-download-ftp "ftp://ftp.sane-project.org/pub/sane/sane-backends-&sane-version;/sane-backends-&sane-version;.tar.gz">
|
---|
8 | <!ENTITY sane-be-md5sum "3b804f35cdfbc5ad2d201ffe078bbac9">
|
---|
9 | <!ENTITY sane-be-size "3.2 MB">
|
---|
10 | <!ENTITY sane-be-buildsize "50 MB">
|
---|
11 | <!ENTITY sane-be-time "1.26 SBU">
|
---|
12 |
|
---|
13 | <!ENTITY sane-fe-version "1.0.13">
|
---|
14 | <!ENTITY sane-fe-download-http "http://gd.tuwien.ac.at/api/sane/sane-frontends-&sane-fe-version;/sane-frontends-&sane-fe-version;.tar.gz">
|
---|
15 | <!ENTITY sane-fe-download-ftp "ftp://ftp.sane-project.org/pub/sane/sane-frontends-&sane-fe-version;/sane-frontends-&sane-fe-version;.tar.gz">
|
---|
16 | <!ENTITY sane-fe-md5sum "2930626e627df49b45192a722cedc8a6">
|
---|
17 | <!ENTITY sane-fe-size "210 KB">
|
---|
18 | <!ENTITY sane-fe-buildsize "2.6 MB">
|
---|
19 | <!ENTITY sane-fe-time "0.09 SBU">
|
---|
20 | ]>
|
---|
21 |
|
---|
22 | <sect1 id="sane" xreflabel="SANE-&sane-version;">
|
---|
23 | <sect1info>
|
---|
24 | <othername>$LastChangedBy$</othername>
|
---|
25 | <date>$Date$</date>
|
---|
26 | </sect1info>
|
---|
27 | <?dbhtml filename="sane.html"?>
|
---|
28 | <title>SANE-&sane-version;</title>
|
---|
29 |
|
---|
30 | <sect2>
|
---|
31 | <title>Introduction to
|
---|
32 | <application><acronym>SANE</acronym></application></title>
|
---|
33 |
|
---|
34 | <para><application><acronym>SANE</acronym></application> is short for Scanner
|
---|
35 | Access Now Easy. Scanner access, however, is far from easy, since every vendor
|
---|
36 | has their own protocols. The only known protocol that should bring some unity
|
---|
37 | into this chaos is the TWAIN interface, but this is too imprecise to allow a
|
---|
38 | stable scanning framework. Therefore, <acronym>SANE</acronym> comes with its
|
---|
39 | own protocol, and the vendor drivers can't be used.</para>
|
---|
40 |
|
---|
41 | <para><acronym>SANE</acronym> is split into back ends and front ends. The back
|
---|
42 | ends are drivers for the supported scanners and cameras. The front ends are
|
---|
43 | user interfaces to access the backends.</para>
|
---|
44 |
|
---|
45 | <sect3><title>Back ends package information</title>
|
---|
46 | <itemizedlist spacing='compact'>
|
---|
47 | <listitem><para>Download (HTTP): <ulink
|
---|
48 | url="&sane-be-download-http;"/></para></listitem>
|
---|
49 | <listitem><para>Download (FTP): <ulink
|
---|
50 | url="&sane-be-download-ftp;"/></para></listitem>
|
---|
51 | <listitem><para>Download MD5 sum: &sane-be-md5sum;</para></listitem>
|
---|
52 | <listitem><para>Download size: &sane-be-size;</para></listitem>
|
---|
53 | <listitem><para>Estimated disk space required:
|
---|
54 | &sane-be-buildsize;</para></listitem>
|
---|
55 | <listitem><para>Estimated build time:
|
---|
56 | &sane-be-time;</para></listitem></itemizedlist>
|
---|
57 | </sect3>
|
---|
58 |
|
---|
59 | <sect3><title>Front ends package information</title>
|
---|
60 | <itemizedlist spacing='compact'>
|
---|
61 | <listitem><para>Download (HTTP): <ulink
|
---|
62 | url="&sane-fe-download-http;"/></para></listitem>
|
---|
63 | <listitem><para>Download (FTP): <ulink
|
---|
64 | url="&sane-fe-download-ftp;"/></para></listitem>
|
---|
65 | <listitem><para>Downlaod MD5 sum: &sane-fe-md5sum;</para></listitem>
|
---|
66 | <listitem><para>Download size: &sane-fe-size;</para></listitem>
|
---|
67 | <listitem><para>Estimated disk space required:
|
---|
68 | &sane-fe-buildsize;</para></listitem>
|
---|
69 | <listitem><para>Estimated build time:
|
---|
70 | &sane-fe-time;</para></listitem></itemizedlist>
|
---|
71 | </sect3>
|
---|
72 |
|
---|
73 | <sect3><title><application><acronym>SANE</acronym></application>
|
---|
74 | dependencies</title>
|
---|
75 | <sect4><title>Optional (back ends)</title>
|
---|
76 | <para><xref linkend="libjpeg"/>,
|
---|
77 | <xref linkend="libusb"/>,
|
---|
78 | <ulink url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>,
|
---|
79 | <ulink url="http://www.gphoto.org/">gPhoto2</ulink>
|
---|
80 | (requires <ulink url="http://www.gphoto.org/">libgphoto2</ulink>) and
|
---|
81 | <xref linkend="tex"/></para>
|
---|
82 | </sect4>
|
---|
83 |
|
---|
84 | <sect4><title>Optional (front ends)</title>
|
---|
85 | <para>X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
|
---|
86 | <xref linkend="gtk2"/> and
|
---|
87 | <xref linkend="gimp"/></para>
|
---|
88 | </sect4>
|
---|
89 | </sect3>
|
---|
90 |
|
---|
91 | </sect2>
|
---|
92 |
|
---|
93 | <sect2>
|
---|
94 | <title>Installation of
|
---|
95 | <application><acronym>SANE</acronym></application></title>
|
---|
96 |
|
---|
97 | <sect3><title>Preparing your system for scanner access</title>
|
---|
98 | <para>To access your scanner, you will probably need the related kernel
|
---|
99 | drivers or additional support packages (<application>libusb</application>).
|
---|
100 | A <acronym>SCSI</acronym> scanner will need <acronym>SCSI</acronym>
|
---|
101 | drivers, a parallel port scanner needs parallel port support (you should use
|
---|
102 | enhanced <acronym>EPP</acronym> modes) and a <acronym>USB</acronym> scanner
|
---|
103 | will need the <application>libusb</application> package and a
|
---|
104 | <acronym>SCSI</acronym> system for emulation. Be sure that you have got the
|
---|
105 | necessary drivers to access the devices.</para>
|
---|
106 | </sect3>
|
---|
107 |
|
---|
108 | <sect3><title>Installation of
|
---|
109 | <application><acronym>SANE</acronym></application> back ends</title>
|
---|
110 |
|
---|
111 | <para>Install <application><acronym>SANE</acronym></application>-backends by
|
---|
112 | running the following commands:</para>
|
---|
113 |
|
---|
114 | <screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
115 | make &&
|
---|
116 | make install</command></userinput></screen>
|
---|
117 | </sect3>
|
---|
118 |
|
---|
119 | <sect3><title>Installation of
|
---|
120 | <application><acronym>SANE</acronym></application> front ends</title>
|
---|
121 |
|
---|
122 | <para>The <application><acronym>SANE</acronym></application>-frontends package
|
---|
123 | includes the graphical frontends <command>xscanimage</command> and
|
---|
124 | <command>xcam</command>, and a command-line frontend
|
---|
125 | <command>scanadf</command>. You don't need this package if you intend to use
|
---|
126 | one of the more advanced graphical frontends like <xref linkend="xsane"/>. For
|
---|
127 | a list of frontend packages, see
|
---|
128 | <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
|
---|
129 |
|
---|
130 | <para>To install <application><acronym>SANE</acronym></application>-frontends,
|
---|
131 | use the following commands:</para>
|
---|
132 |
|
---|
133 | <screen><userinput><command>./configure --prefix=/usr &&
|
---|
134 | make &&
|
---|
135 | make install</command></userinput></screen>
|
---|
136 |
|
---|
137 | <para>If <application>GIMP</application> was linked into the build and you
|
---|
138 | wish <application>GIMP</application> to use <command>xscanimage</command> as
|
---|
139 | a scanning plugin, issue the following command:</para>
|
---|
140 |
|
---|
141 | <screen><userinput><command>ln -s /usr/bin/xscanimage /usr/lib/gimp/2.0/plug-ins</command></userinput></screen>
|
---|
142 | </sect3>
|
---|
143 |
|
---|
144 | </sect2>
|
---|
145 |
|
---|
146 | <sect2>
|
---|
147 | <title>Command explanations</title>
|
---|
148 |
|
---|
149 | <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
|
---|
150 | configuration files in <filename class="directory">/etc/sane.d</filename>
|
---|
151 | instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
|
---|
152 |
|
---|
153 | </sect2>
|
---|
154 |
|
---|
155 | <sect2>
|
---|
156 | <title>Configuring <application><acronym>SANE</acronym></application></title>
|
---|
157 |
|
---|
158 | <sect3><title>Config files</title>
|
---|
159 | <para><filename>/etc/sane.d/*.conf</filename></para>
|
---|
160 | </sect3>
|
---|
161 |
|
---|
162 | <sect3><title>Configuration information</title>
|
---|
163 | <sect4><title>Backend configuration</title>
|
---|
164 | <para>The backend configuration files are located in
|
---|
165 | <filename class='directory'>/etc/sane.d</filename>. Information for configuring
|
---|
166 | the various backends can be found by using the man(5) page for the desired
|
---|
167 | backend. Run <command>man sane-<replaceable>[backend]</replaceable></command>,
|
---|
168 | substituting the desired backend.</para>
|
---|
169 | </sect4>
|
---|
170 |
|
---|
171 | <sect4><title>General information</title>
|
---|
172 | <para>For general information about configuring and using
|
---|
173 | <application><acronym>SANE</acronym></application>, see
|
---|
174 | <command>man sane</command>. Linux-2.6.x brings some special issues into the
|
---|
175 | picture. See <ulink url="http://www.sane-project.org/README.linux"/> for
|
---|
176 | information about using <application><acronym>SANE</acronym></application>
|
---|
177 | with the Linux-2.6.x kernel. For information about <acronym>USB</acronym>
|
---|
178 | scanning devices, run <command>man sane-usb</command>. For information about
|
---|
179 | <acronym>SCSI</acronym> devices, run <command>man sane-scsi</command>.</para>
|
---|
180 | </sect4>
|
---|
181 |
|
---|
182 | <sect4><title>Configuration and setup of the <command>saned</command>
|
---|
183 | daemon</title>
|
---|
184 | <para>The <command>saned</command> daemon is not meant to be used for untrusted
|
---|
185 | clients. You should provide <application>tcpwrapper</application> and/or
|
---|
186 | firewall protection to insure only trusted clients access the daemon. Due to
|
---|
187 | the complex security requirements to insure only trusted clients access the
|
---|
188 | daemon, <acronym>BLFS</acronym> does not provide instructions to configure the
|
---|
189 | <command>saned</command> daemon. If you desire to make the daemon available,
|
---|
190 | ensure you provide adequate security, configure your
|
---|
191 | <filename>[x]inetd.conf</filename> file and send a
|
---|
192 | <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good information for
|
---|
193 | setting up and securing the <command>saned</command> daemon can be found at
|
---|
194 | <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
|
---|
195 | </sect4>
|
---|
196 | </sect3>
|
---|
197 |
|
---|
198 | </sect2>
|
---|
199 |
|
---|
200 | <sect2>
|
---|
201 | <title>Contents</title>
|
---|
202 |
|
---|
203 | <sect3><title>Back ends:</title>
|
---|
204 | <para>The <application><acronym>SANE</acronym></application>-backends package
|
---|
205 | contains
|
---|
206 | <command>gamma4scanimage</command>,
|
---|
207 | <command>sane-config</command>,
|
---|
208 | <command>saned</command>,
|
---|
209 | <command>sane-find-scanner</command>,
|
---|
210 | <command>scanimage</command>,
|
---|
211 | the <filename class='libraryfile'>libsane</filename> library and
|
---|
212 | numerous scanner backend modules. See
|
---|
213 | <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
|
---|
214 | for a list of supported backends.</para>
|
---|
215 | </sect3>
|
---|
216 |
|
---|
217 | <sect3><title>Front ends:</title>
|
---|
218 | <para>The <application><acronym>SANE</acronym></application>-frontends package
|
---|
219 | contains
|
---|
220 | <command>scanadf</command>,
|
---|
221 | <command>xcam</command>,
|
---|
222 | <command>xscanimage</command> and a <application>GIMP</application> plugin
|
---|
223 | imbedded in <command>xscanimage</command>.</para>
|
---|
224 | </sect3>
|
---|
225 |
|
---|
226 | </sect2>
|
---|
227 |
|
---|
228 | <sect2>
|
---|
229 | <title>Description</title>
|
---|
230 |
|
---|
231 | <sect3><title>gamma4scanimage</title>
|
---|
232 | <para><command>gamma4scanimage</command> creates a gamma table in the format
|
---|
233 | expected by <command>scanimage</command>.</para></sect3>
|
---|
234 |
|
---|
235 | <sect3><title>sane-config</title>
|
---|
236 | <para><command>sane-config</command> is a tool used to determine the compiler
|
---|
237 | and linker flags that should be used to compile and link
|
---|
238 | <application><acronym>SANE</acronym></application>.</para></sect3>
|
---|
239 |
|
---|
240 | <sect3><title>saned</title>
|
---|
241 | <para><command>saned</command> is the
|
---|
242 | <application><acronym>SANE</acronym></application> daemon that allows remote
|
---|
243 | clients to access image acquisition devices available on the local
|
---|
244 | host.</para></sect3>
|
---|
245 |
|
---|
246 | <sect3><title>sane-find-scanner</title>
|
---|
247 | <para><command>sane-find-scanner</command> is a command-line tool to find
|
---|
248 | <acronym>SCSI</acronym> and <acronym>USB</acronym> scanners and determine
|
---|
249 | their device files. Its primary aim is to make sure that scanners can be
|
---|
250 | detected by <application><acronym>SANE</acronym></application>
|
---|
251 | backends.</para></sect3>
|
---|
252 |
|
---|
253 | <sect3><title>scanadf</title>
|
---|
254 | <para><command>scanadf</command> is a command-line interface to control image
|
---|
255 | acquisition devices which are equipped with an automatic document feeder
|
---|
256 | (<acronym>ADF</acronym>).</para></sect3>
|
---|
257 |
|
---|
258 | <sect3><title>scanimage</title>
|
---|
259 | <para><command>scanimage</command> is a command line interface for scanning
|
---|
260 | from image acquisition devices such as flatbed scanners or cameras. It is
|
---|
261 | also used to list the available backend devices.</para></sect3>
|
---|
262 |
|
---|
263 | <sect3><title>xcam</title>
|
---|
264 | <para><command>xcam</command> is a graphical camera front end for
|
---|
265 | <application><acronym>SANE</acronym></application>.</para></sect3>
|
---|
266 |
|
---|
267 | <sect3><title>xscanimage</title>
|
---|
268 | <para><command>xscanimage</command> is a graphical user interface for
|
---|
269 | scanning.</para></sect3>
|
---|
270 |
|
---|
271 | </sect2>
|
---|
272 |
|
---|
273 | </sect1>
|
---|