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