1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY sane-be-download-http "http://alioth.debian.org/download.php/1347/sane-backends-&sane-version;.tar.gz">
|
---|
8 | <!ENTITY sane-be-download-ftp "ftp://ftp2.sane-project.org/pub/sane/sane-backends-&sane-version;/sane-backends-&sane-version;.tar.gz">
|
---|
9 | <!ENTITY sane-be-download-ftp "&gentoo-ftp-repo;/sane-backends-&sane-version;.tar.gz">
|
---|
10 | <!ENTITY sane-be-md5sum "7ca7e2908e24721471de92cf40c75e60">
|
---|
11 | <!ENTITY sane-be-size "3.7 MB">
|
---|
12 | <!ENTITY sane-be-buildsize "67 MB">
|
---|
13 | <!ENTITY sane-be-time "1.4 SBU">
|
---|
14 |
|
---|
15 | <!ENTITY sane-fe-version "1.0.14">
|
---|
16 | <!ENTITY sane-fe-download-http "http://alioth.debian.org/download.php/1140/sane-frontends-&sane-fe-version;.tar.gz">
|
---|
17 | <!ENTITY sane-fe-download-ftp "ftp://ftp2.sane-project.org/pub/sane/sane-frontends-&sane-fe-version;/sane-frontends-&sane-fe-version;.tar.gz">
|
---|
18 | <!ENTITY sane-fe-md5sum "c63bf7b0bb5f530cf3c08715db721cd3">
|
---|
19 | <!ENTITY sane-fe-size "231 KB">
|
---|
20 | <!ENTITY sane-fe-buildsize "3.0 MB">
|
---|
21 | <!ENTITY sane-fe-time "less than 0.1 SBU">
|
---|
22 | ]>
|
---|
23 |
|
---|
24 | <sect1 id="sane" xreflabel="SANE-&sane-version;">
|
---|
25 | <?dbhtml filename="sane.html"?>
|
---|
26 |
|
---|
27 | <sect1info>
|
---|
28 | <othername>$LastChangedBy$</othername>
|
---|
29 | <date>$Date$</date>
|
---|
30 | </sect1info>
|
---|
31 |
|
---|
32 | <title>SANE-&sane-version;</title>
|
---|
33 |
|
---|
34 | <indexterm zone="sane">
|
---|
35 | <primary sortas="a-SANE">SANE</primary>
|
---|
36 | </indexterm>
|
---|
37 |
|
---|
38 | <sect2 role="package">
|
---|
39 | <title>Introduction to SANE</title>
|
---|
40 |
|
---|
41 | <para><application>SANE</application> is short for Scanner Access Now Easy.
|
---|
42 | Scanner access, however, is far from easy, since every vendor has their own
|
---|
43 | protocols. The only known protocol that should bring some unity into this
|
---|
44 | chaos is the TWAIN interface, but this is too imprecise to allow a stable
|
---|
45 | scanning framework. Therefore, <application>SANE</application> comes with
|
---|
46 | its own protocol, and the vendor drivers can't be used.</para>
|
---|
47 |
|
---|
48 | <para><application>SANE</application> is split into back ends and front
|
---|
49 | ends. The back ends are drivers for the supported scanners and cameras. The
|
---|
50 | front ends are user interfaces to access the backends.</para>
|
---|
51 |
|
---|
52 | <bridgehead renderas="sect3">Back Ends Package Information</bridgehead>
|
---|
53 | <itemizedlist spacing='compact'>
|
---|
54 | <listitem>
|
---|
55 | <para>Download (HTTP): <ulink url="&sane-be-download-http;"/></para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Download (FTP): <ulink url="&sane-be-download-ftp;"/></para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>Download MD5 sum: &sane-be-md5sum;</para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>Download size: &sane-be-size;</para>
|
---|
65 | </listitem>
|
---|
66 | <listitem>
|
---|
67 | <para>Estimated disk space required: &sane-be-buildsize;</para>
|
---|
68 | </listitem>
|
---|
69 | <listitem>
|
---|
70 | <para>Estimated build time: &sane-be-time;</para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Front Ends Package Information</bridgehead>
|
---|
75 | <itemizedlist spacing='compact'>
|
---|
76 | <listitem>
|
---|
77 | <para>Download (HTTP): <ulink url="&sane-fe-download-http;"/></para>
|
---|
78 | </listitem>
|
---|
79 | <listitem>
|
---|
80 | <para>Download (FTP): <ulink url="&sane-fe-download-ftp;"/></para>
|
---|
81 | </listitem>
|
---|
82 | <listitem>
|
---|
83 | <para>Downlaod MD5 sum: &sane-fe-md5sum;</para>
|
---|
84 | </listitem>
|
---|
85 | <listitem>
|
---|
86 | <para>Download size: &sane-fe-size;</para>
|
---|
87 | </listitem>
|
---|
88 | <listitem>
|
---|
89 | <para>Estimated disk space required: &sane-fe-buildsize;</para>
|
---|
90 | </listitem>
|
---|
91 | <listitem>
|
---|
92 | <para>Estimated build time: &sane-fe-time;</para>
|
---|
93 | </listitem>
|
---|
94 | </itemizedlist>
|
---|
95 |
|
---|
96 | <bridgehead renderas="sect3">SANE Dependencies</bridgehead>
|
---|
97 |
|
---|
98 | <bridgehead renderas="sect4">Optional (Back Ends)</bridgehead>
|
---|
99 | <para role="optional"><xref linkend="libjpeg"/>,
|
---|
100 | <xref linkend="libtiff"/>,
|
---|
101 | <xref linkend="libusb"/>,
|
---|
102 | <ulink url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>,
|
---|
103 | <ulink url="http://www.gphoto.org/">libgphoto2</ulink>, and
|
---|
104 | <xref linkend="tetex"/></para>
|
---|
105 |
|
---|
106 | <bridgehead renderas="sect4">Optional (Front Ends)</bridgehead>
|
---|
107 | <para role="optional"><xref linkend="x-window-system"/>,
|
---|
108 | <xref linkend="gtk2"/>, and
|
---|
109 | <xref linkend="gimp"/></para>
|
---|
110 |
|
---|
111 | <para condition="html" role="usernotes">User Notes:
|
---|
112 | <ulink url="&blfs-wiki;/sane"/></para>
|
---|
113 |
|
---|
114 | </sect2>
|
---|
115 |
|
---|
116 | <sect2 role="kernel" id='sane-kernel'>
|
---|
117 | <title>Kernel Configuration</title>
|
---|
118 |
|
---|
119 | <indexterm zone="sane sane-kernel">
|
---|
120 | <primary sortas="d-Scanning-devices">Scanning devices</primary>
|
---|
121 | </indexterm>
|
---|
122 |
|
---|
123 | <para>To access your scanner, you will probably need the related kernel
|
---|
124 | drivers and/or additional support packages. A SCSI scanner will need SCSI
|
---|
125 | drivers, a parallel port scanner needs parallel port support (you should
|
---|
126 | use enhanced EPP modes) and perhaps <ulink
|
---|
127 | url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink> and a USB
|
---|
128 | scanner will need the <xref linkend="libusb"/> package. Ensure you have
|
---|
129 | the necessary drivers properly configured to access the devices.</para>
|
---|
130 |
|
---|
131 | </sect2>
|
---|
132 |
|
---|
133 | <sect2 role="installation">
|
---|
134 | <title>Installation of SANE</title>
|
---|
135 |
|
---|
136 | <sect3>
|
---|
137 | <title>Installation of SANE Back Ends</title>
|
---|
138 |
|
---|
139 | <para>Install <application>SANE</application>-backends by
|
---|
140 | running the following commands:</para>
|
---|
141 |
|
---|
142 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
143 | make</userinput></screen>
|
---|
144 |
|
---|
145 | <para>This package does not come with a test suite.</para>
|
---|
146 |
|
---|
147 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
148 |
|
---|
149 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
150 |
|
---|
151 | </sect3>
|
---|
152 |
|
---|
153 | <sect3>
|
---|
154 | <title>Installation of SANE Front Ends</title>
|
---|
155 |
|
---|
156 | <para>The <application>SANE</application>-frontends package
|
---|
157 | includes the graphical frontends <command>xscanimage</command> and
|
---|
158 | <command>xcam</command>, and a command-line frontend
|
---|
159 | <command>scanadf</command>. You don't need this package if you intend
|
---|
160 | to use one of the more advanced graphical frontends like
|
---|
161 | <xref linkend="xsane"/>. For a list of frontend packages, see
|
---|
162 | <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
|
---|
163 |
|
---|
164 | <para>To install <application>SANE</application>-frontends,
|
---|
165 | use the following commands:</para>
|
---|
166 |
|
---|
167 | <screen><userinput>./configure --prefix=/usr &&
|
---|
168 | make</userinput></screen>
|
---|
169 |
|
---|
170 | <para>This package does not come with a test suite.</para>
|
---|
171 |
|
---|
172 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
173 |
|
---|
174 | <screen role="root"><userinput>make install &&
|
---|
175 | install -v -m644 doc/sane.png xscanimage-icon-48x48-2.png \
|
---|
176 | /usr/share/sane</userinput></screen>
|
---|
177 |
|
---|
178 | <para>If <application>GIMP</application> was linked into the build and
|
---|
179 | you wish <application>GIMP</application> to use
|
---|
180 | <command>xscanimage</command> as a scanning plugin, issue the following
|
---|
181 | command as the <systemitem class="username">root</systemitem> user:</para>
|
---|
182 |
|
---|
183 | <screen role="root"><userinput>ln -v -s ../../../../bin/xscanimage /usr/lib/gimp/2.0/plug-ins</userinput></screen>
|
---|
184 |
|
---|
185 | </sect3>
|
---|
186 |
|
---|
187 | </sect2>
|
---|
188 |
|
---|
189 | <sect2 role="commands">
|
---|
190 | <title>Command Explanations</title>
|
---|
191 |
|
---|
192 | <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
|
---|
193 | configuration files in <filename class="directory">/etc/sane.d</filename>
|
---|
194 | instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
|
---|
195 |
|
---|
196 | </sect2>
|
---|
197 |
|
---|
198 | <sect2 role="configuration">
|
---|
199 | <title>Configuring SANE</title>
|
---|
200 |
|
---|
201 | <sect3 id="sane-config">
|
---|
202 | <title>Config Files</title>
|
---|
203 |
|
---|
204 | <para><filename>/etc/sane.d/*.conf</filename></para>
|
---|
205 |
|
---|
206 | <indexterm zone="sane sane-config">
|
---|
207 | <primary sortas="e-etc-sane.d-conf">/etc/sane.d/*.conf</primary>
|
---|
208 | </indexterm>
|
---|
209 |
|
---|
210 | </sect3>
|
---|
211 |
|
---|
212 | <sect3>
|
---|
213 | <title>Configuration Information</title>
|
---|
214 |
|
---|
215 | <sect4>
|
---|
216 | <title>Backend Configuration</title>
|
---|
217 |
|
---|
218 | <para>The backend configuration files are located in
|
---|
219 | <filename class='directory'>/etc/sane.d</filename>. Information
|
---|
220 | for configuring the various backends can be found by using the man(5)
|
---|
221 | page for the desired backend. Run
|
---|
222 | <command>man sane-<replaceable><backend></replaceable></command>,
|
---|
223 | substituting the desired backend.</para>
|
---|
224 |
|
---|
225 | </sect4>
|
---|
226 |
|
---|
227 | <sect4>
|
---|
228 | <title>General Information</title>
|
---|
229 |
|
---|
230 | <para>For general information about configuring and using
|
---|
231 | <application>SANE</application>, see <command>man sane</command>.
|
---|
232 | Linux-2.6.x brings some special issues into the picture. See
|
---|
233 | <ulink url="http://www.sane-project.org/README.linux"/> for
|
---|
234 | information about using <application>SANE</application> with the
|
---|
235 | Linux-2.6.x kernel. For information about USB scanning devices,
|
---|
236 | run <command>man sane-usb</command>. For information about SCSI
|
---|
237 | devices, run <command>man sane-scsi</command>.</para>
|
---|
238 |
|
---|
239 | </sect4>
|
---|
240 |
|
---|
241 | <sect4>
|
---|
242 | <title>Configuration and setup of the 'saned' daemon</title>
|
---|
243 |
|
---|
244 | <para>The <command>saned</command> daemon is not meant to be used for
|
---|
245 | untrusted clients. You should provide <xref linkend="tcpwrappers"/>
|
---|
246 | and/or <xref linkend="fw-firewall"/> protection to ensure only trusted
|
---|
247 | clients access the daemon. Due to the complex security requirements to
|
---|
248 | ensure only trusted clients access the daemon, BLFS does not provide
|
---|
249 | instructions to configure the <command>saned</command> daemon. If you
|
---|
250 | desire to make the daemon available, ensure you provide adequate
|
---|
251 | security, configure your <filename>[x]inetd.conf</filename> file and
|
---|
252 | send a <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good
|
---|
253 | information for setting up and securing the <command>saned</command>
|
---|
254 | daemon can be found at
|
---|
255 | <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
|
---|
256 |
|
---|
257 | </sect4>
|
---|
258 |
|
---|
259 | </sect3>
|
---|
260 |
|
---|
261 | </sect2>
|
---|
262 |
|
---|
263 | <sect2 role="content">
|
---|
264 | <title>Contents</title>
|
---|
265 |
|
---|
266 | <bridgehead renderas="sect4">Back Ends:</bridgehead>
|
---|
267 | <segmentedlist>
|
---|
268 | <segtitle>Installed Programs</segtitle>
|
---|
269 | <segtitle>Installed Libraries</segtitle>
|
---|
270 | <segtitle>Installed Directories</segtitle>
|
---|
271 |
|
---|
272 | <seglistitem>
|
---|
273 | <seg>gamma4scanimage, sane-config, saned, sane-find-scanner,
|
---|
274 | and scanimage</seg>
|
---|
275 | <seg>libsane.so and numerous scanner backend modules</seg>
|
---|
276 | <seg>/etc/sane.d, /usr/include/sane, /usr/lib/sane, /usr/share/sane,
|
---|
277 | and /usr/share/doc/sane-&sane-version;</seg>
|
---|
278 | </seglistitem>
|
---|
279 | </segmentedlist>
|
---|
280 |
|
---|
281 | <bridgehead renderas="sect4">Front Ends:</bridgehead>
|
---|
282 | <segmentedlist>
|
---|
283 | <segtitle>Installed Programs</segtitle>
|
---|
284 | <segtitle>Installed Library</segtitle>
|
---|
285 | <segtitle>Installed Directories</segtitle>
|
---|
286 |
|
---|
287 | <seglistitem>
|
---|
288 | <seg>scanadf, xcam, and xscanimage</seg>
|
---|
289 | <seg><application>GIMP</application> plugin embedded in
|
---|
290 | <command>xscanimage</command></seg>
|
---|
291 | <seg>None</seg>
|
---|
292 | </seglistitem>
|
---|
293 | </segmentedlist>
|
---|
294 |
|
---|
295 | <variablelist>
|
---|
296 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
297 | <?dbfo list-presentation="list"?>
|
---|
298 | <?dbhtml list-presentation="table"?>
|
---|
299 |
|
---|
300 | <varlistentry id="gamma4scanimage">
|
---|
301 | <term><command>gamma4scanimage</command></term>
|
---|
302 | <listitem>
|
---|
303 | <para>creates a gamma table in the format expected by
|
---|
304 | <command>scanimage</command>.</para>
|
---|
305 | <indexterm zone="sane gamma4scanimage">
|
---|
306 | <primary sortas="b-gamma4scanimage">gamma4scanimage</primary>
|
---|
307 | </indexterm>
|
---|
308 | </listitem>
|
---|
309 | </varlistentry>
|
---|
310 |
|
---|
311 | <varlistentry id="sane-config-prog">
|
---|
312 | <term><command>sane-config</command></term>
|
---|
313 | <listitem>
|
---|
314 | <para>is a tool used to determine the compiler and linker
|
---|
315 | flags that should be used to compile and link
|
---|
316 | <application>SANE</application>.</para>
|
---|
317 | <indexterm zone="sane sane-config-prog">
|
---|
318 | <primary sortas="b-sane-config">sane-config</primary>
|
---|
319 | </indexterm>
|
---|
320 | </listitem>
|
---|
321 | </varlistentry>
|
---|
322 |
|
---|
323 | <varlistentry id="saned">
|
---|
324 | <term><command>saned</command></term>
|
---|
325 | <listitem>
|
---|
326 | <para>is the <application>SANE</application> daemon that
|
---|
327 | allows remote clients to access image acquisition devices
|
---|
328 | available on the local host.</para>
|
---|
329 | <indexterm zone="sane saned">
|
---|
330 | <primary sortas="b-saned">saned</primary>
|
---|
331 | </indexterm>
|
---|
332 | </listitem>
|
---|
333 | </varlistentry>
|
---|
334 |
|
---|
335 | <varlistentry id="sane-find-scanner">
|
---|
336 | <term><command>sane-find-scanner</command></term>
|
---|
337 | <listitem>
|
---|
338 | <para>is a command-line tool to find SCSI and
|
---|
339 | USB scanners and determine their device files. Its primary
|
---|
340 | purpose is to make sure that scanners can be detected by
|
---|
341 | <application>SANE</application> backends.</para>
|
---|
342 | <indexterm zone="sane sane-find-scanner">
|
---|
343 | <primary sortas="b-sane-find-scanner">sane-find-scanner</primary>
|
---|
344 | </indexterm>
|
---|
345 | </listitem>
|
---|
346 | </varlistentry>
|
---|
347 |
|
---|
348 | <varlistentry id="scanadf">
|
---|
349 | <term><command>scanadf</command></term>
|
---|
350 | <listitem>
|
---|
351 | <para>is a command-line interface to control image acquisition
|
---|
352 | devices which are equipped with an automatic document feeder
|
---|
353 | (ADF).</para>
|
---|
354 | <indexterm zone="sane scanadf">
|
---|
355 | <primary sortas="b-scanadf">scanadf</primary>
|
---|
356 | </indexterm>
|
---|
357 | </listitem>
|
---|
358 | </varlistentry>
|
---|
359 |
|
---|
360 | <varlistentry id="scanimage">
|
---|
361 | <term><command>scanimage</command></term>
|
---|
362 | <listitem>
|
---|
363 | <para>is a command line interface for scanning from image acquisition
|
---|
364 | devices such as flatbed scanners or cameras. It is also used to list
|
---|
365 | the available backend devices.</para>
|
---|
366 | <indexterm zone="sane scanimage">
|
---|
367 | <primary sortas="b-scanimage">scanimage</primary>
|
---|
368 | </indexterm>
|
---|
369 | </listitem>
|
---|
370 | </varlistentry>
|
---|
371 |
|
---|
372 | <varlistentry id="xcam">
|
---|
373 | <term><command>xcam</command></term>
|
---|
374 | <listitem>
|
---|
375 | <para>is a graphical camera front end for
|
---|
376 | <application>SANE</application>.</para>
|
---|
377 | <indexterm zone="sane xcam">
|
---|
378 | <primary sortas="b-xcam">xcam</primary>
|
---|
379 | </indexterm>
|
---|
380 | </listitem>
|
---|
381 | </varlistentry>
|
---|
382 |
|
---|
383 | <varlistentry id="xscanimage">
|
---|
384 | <term><command>xscanimage</command></term>
|
---|
385 | <listitem>
|
---|
386 | <para>is a graphical user interface for scanning.</para>
|
---|
387 | <indexterm zone="sane xscanimage">
|
---|
388 | <primary sortas="b-xscanimage">xscanimage</primary>
|
---|
389 | </indexterm>
|
---|
390 | </listitem>
|
---|
391 | </varlistentry>
|
---|
392 |
|
---|
393 | <varlistentry id="libsane">
|
---|
394 | <term><filename class='libraryfile'>libsane.so</filename></term>
|
---|
395 | <listitem>
|
---|
396 | <para>is the application programming interface that is used to
|
---|
397 | communicate between frontends and backends.</para>
|
---|
398 | <indexterm zone="sane libsane">
|
---|
399 | <primary sortas="c-libsane">libsane.so</primary>
|
---|
400 | </indexterm>
|
---|
401 | </listitem>
|
---|
402 | </varlistentry>
|
---|
403 |
|
---|
404 | <varlistentry id="libsane-module">
|
---|
405 | <term><filename class='libraryfile'>libsane-*.so</filename></term>
|
---|
406 | <listitem>
|
---|
407 | <para>modules are backend scanning library plugins used to interface
|
---|
408 | with scanning devices. See
|
---|
409 | <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
|
---|
410 | for a list of supported backends.</para>
|
---|
411 | <indexterm zone="sane libsane-module">
|
---|
412 | <primary sortas="c-libsane-module">libsane-*.so</primary>
|
---|
413 | </indexterm>
|
---|
414 | </listitem>
|
---|
415 | </varlistentry>
|
---|
416 |
|
---|
417 | </variablelist>
|
---|
418 |
|
---|
419 | </sect2>
|
---|
420 |
|
---|
421 | </sect1>
|
---|