source: pst/scanning/sane.xml@ 17273d0

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 17273d0 was 17273d0, checked in by Bruce Dubbs <bdubbs@…>, 11 years ago

qpdf-5.0.0.
Update to libwebp-0.3.1.
Update to giflib-4.2.1.

Many LFS-7.3 tags thanks to Jean-Philippe MENGUAL.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@11421 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 19.5 KB
Line 
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/frs/?group_id=30186"> -->
8 <!ENTITY sane-be-download-http " ">
9 <!ENTITY sane-be-download-ftp "ftp://ftp2.sane-project.org/pub/sane/sane-backends-&sane-version;.tar.gz">
10 <!--<!ENTITY sane-be-download-ftp "&gentoo-ftp-repo;/sane-backends-&sane-version;.tar.gz">-->
11 <!ENTITY sane-be-md5sum "979c9dbb23920d04e322be23122c7de7">
12 <!ENTITY sane-be-size "5.1 MB">
13 <!ENTITY sane-be-buildsize "120 MB">
14 <!ENTITY sane-be-time "1.2 SBU">
15
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 &lfs73_checked;
53
54 <!-- This note is not applicable. First, there is no issue downloading the
55 ftp://ftp2.sane-project.org/pub/sane/sane-backends-1.0.23.tar.gz
56 tarball with wget. Next, the combined tarball exists on the SANE FTP
57 site, but the MD5sum is wrong. We can simply point the download to
58 the SANE FTP site and create our own MD5sum (as we do on many packages).
59
60 <note><para>The upstream web site uses a self signed security
61 certificate. If using <command>wget</command>, the option -no-check-certificate
62 needs to be added.</para>
63
64 <para>The md5sum of the backend file does not match unless the three parts
65 of the divided tarball on the upstream server,
66 sane-backends-1.0.23.tar.gz.[1-3], are combined. A combined tarball with
67 the correct md5sum is located at <ulink
68 url="http://anduin.linuxfromscratch.org/sources/other/sane-backends-1.0.23.tar.gz">http://anduin.linuxfromscratch.org/sources/other/sane-backends-1.0.23.tar.gz</ulink>.</para></note>
69 -->
70
71 <bridgehead renderas="sect3">Back Ends Package Information</bridgehead>
72 <itemizedlist spacing='compact'>
73 <listitem>
74 <para>Download (HTTP): <ulink url="&sane-be-download-http;"/></para>
75 </listitem>
76 <listitem>
77 <para>Download (FTP): <ulink url="&sane-be-download-ftp;"/></para>
78 </listitem>
79 <listitem>
80 <para>Download MD5 sum: &sane-be-md5sum;</para>
81 </listitem>
82 <listitem>
83 <para>Download size: &sane-be-size;</para>
84 </listitem>
85 <listitem>
86 <para>Estimated disk space required: &sane-be-buildsize;</para>
87 </listitem>
88 <listitem>
89 <para>Estimated build time: &sane-be-time;</para>
90 </listitem>
91 </itemizedlist>
92
93 <bridgehead renderas="sect3">Front Ends Package Information</bridgehead>
94 <itemizedlist spacing='compact'>
95 <listitem>
96 <para>Download (HTTP): <ulink url="&sane-fe-download-http;"/></para>
97 </listitem>
98 <listitem>
99 <para>Download (FTP): <ulink url="&sane-fe-download-ftp;"/></para>
100 </listitem>
101 <listitem>
102 <para>Downlaod MD5 sum: &sane-fe-md5sum;</para>
103 </listitem>
104 <listitem>
105 <para>Download size: &sane-fe-size;</para>
106 </listitem>
107 <listitem>
108 <para>Estimated disk space required: &sane-fe-buildsize;</para>
109 </listitem>
110 <listitem>
111 <para>Estimated build time: &sane-fe-time;</para>
112 </listitem>
113 </itemizedlist>
114<!--
115 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
116 <itemizedlist spacing="compact">
117 <listitem>
118 <para>Required patch:
119 <ulink url="&patch-root;/sane-backends-&sane-version;-v4l-1.patch"/>
120 </para>
121 </listitem>
122 </itemizedlist>
123-->
124 <bridgehead renderas="sect3">SANE Dependencies</bridgehead>
125
126 <bridgehead renderas="sect4">Optional (Back Ends)</bridgehead>
127 <para role="optional">
128 <xref linkend="avahi"/>,
129 <xref linkend="cups"/>,
130 <xref linkend="libjpeg"/>,
131 <xref linkend="libtiff"/>,
132 <xref linkend="libusb"/>,
133 <ulink url="http://www.net-snmp.org/">Net-SNMP</ulink>,
134 <ulink url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>,
135 <ulink url="http://www.gphoto.org/">libgphoto2</ulink>,
136 <ulink url="http://linuxtv.org/downloads/v4l-utils/">Video4Linux</ulink>, and
137 <xref linkend="texlive"/>
138 </para>
139
140 <bridgehead renderas="sect4">Optional (Front Ends)</bridgehead>
141 <para role="optional">
142 <xref linkend="x-window-system"/>,
143 <xref linkend="gtk2"/>, and
144 <xref linkend="gimp"/>
145 </para>
146
147 <para condition="html" role="usernotes">User Notes:
148 <ulink url="&blfs-wiki;/sane"/></para>
149
150 </sect2>
151
152 <sect2 role="kernel" id='sane-kernel'>
153 <title>Kernel Configuration</title>
154
155 <indexterm zone="sane sane-kernel">
156 <primary sortas="d-Scanning-devices">Scanning devices</primary>
157 </indexterm>
158
159 <para>To access your scanner, you will probably need the related kernel
160 drivers and/or additional support packages. A SCSI scanner will need SCSI
161 drivers, a parallel port scanner needs parallel port support (you should
162 use enhanced EPP modes) and perhaps <ulink
163 url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>, and a USB
164 scanner will need the <xref linkend="libusb"/> package. Ensure you have
165 the necessary drivers properly configured to access the devices.</para>
166
167 </sect2>
168
169 <sect2 role="installation">
170 <title>Installation of SANE</title>
171
172 <sect3>
173 <title>Installation of SANE Back Ends</title>
174
175 <note>
176 <para>
177 You may safely disregard any messages printed on the screen when you
178 unpack the tarball.
179 </para>
180 </note>
181
182 <para>The <application>SANE</application> daemon should run with its own
183 group. Create this group by issuing the following commands as the
184 <systemitem class="username">root</systemitem> user:</para>
185
186<screen><userinput>groupadd -g 70 scanner</userinput></screen>
187
188 <note>
189 <para>
190 The user building <application>SANE</application>-backends should be
191 a member of the <systemitem class="groupname">scanner</systemitem>
192 group before proceeding. After you have added the user building the
193 package to the <systemitem class="groupname">scanner</systemitem>
194 group, issue the following command to create a new shell:
195 </para>
196
197<screen><userinput>su $(whoami)</userinput></screen>
198
199 <para>
200 Check the output of the <userinput>groups</userinput> command and
201 ensure the user is a member of the
202 <systemitem class="groupname">scanner</systemitem> group.
203 </para>
204 </note>
205
206 <para>Install <application>SANE</application>-backends by
207 running the following commands:</para>
208
209 <!-- Not sure why this was there as it works if TeX is installed
210 and it doesn't try to use it if TeX is not installed
211 -disable-latex &amp;&amp; -->
212
213<screen><userinput>./configure --prefix=/usr \
214 --sysconfdir=/etc \
215 --localstatedir=/var \
216 --with-docdir=/usr/share/doc/sane-backend-1.0.23 \
217 --with-group=scanner &amp;&amp;
218make &amp;&amp;
219exit</userinput></screen>
220
221 <para>To test the results, issue: <command>make check</command>.</para>
222
223 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
224
225<screen role="root"><userinput>make install &amp;&amp;
226install -m 644 -v tools/udev/libsane.rules \
227 /etc/udev/rules.d/65-scanner.rules &amp;&amp;
228chgrp -v scanner /var/lock/sane</userinput></screen>
229
230 </sect3>
231
232 <sect3>
233 <title>Installation of SANE Front Ends</title>
234
235 <para>The <application>SANE</application>-frontends package
236 includes the graphical frontends <command>xscanimage</command> and
237 <command>xcam</command>, and a command-line frontend
238 <command>scanadf</command>. You don't need this package if you intend
239 to use one of the more advanced graphical frontends like
240 <xref linkend="xsane"/>. For a list of frontend packages, see
241 <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
242
243 <para>To install <application>SANE</application>-frontends,
244 use the following commands:</para>
245
246<screen><userinput>sed -i -e "/SANE_CAP_ALWAYS_SETTABLE/d" src/gtkglue.c &amp;&amp;
247./configure --prefix=/usr &amp;&amp;
248make</userinput></screen>
249
250 <para>This package does not come with a test suite.</para>
251
252 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
253
254<screen role="root"><userinput>make install &amp;&amp;
255install -v -m644 doc/sane.png xscanimage-icon-48x48-2.png \
256 /usr/share/sane</userinput></screen>
257
258 <para>If <application>GIMP</application> was linked into the build and
259 you wish <application>GIMP</application> to use
260 <command>xscanimage</command> as a scanning plugin, issue the following
261 command as the <systemitem class="username">root</systemitem> user:</para>
262
263<screen role="root"><userinput>ln -v -s ../../../../bin/xscanimage /usr/lib/gimp/2.0/plug-ins</userinput></screen>
264
265 </sect3>
266
267 </sect2>
268
269 <sect2 role="commands">
270 <title>Command Explanations</title>
271
272 <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
273 configuration files in <filename class="directory">/etc/sane.d</filename>
274 instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
275
276 <para><parameter>--with-group=scanner</parameter>: This parameter causes
277 the directory created for the locking files to be group owned by the
278 <systemitem class="groupname">scanner</systemitem> group instead of the
279 default <systemitem class="groupname">uucp</systemitem> group.</para>
280
281 <para><command>exit</command>: This command is used to exit the shell
282 created by the <command>su</command> command.</para>
283 </sect2>
284
285 <sect2 role="configuration">
286 <title>Configuring SANE</title>
287
288 <sect3 id="sane-config">
289 <title>Config Files</title>
290
291 <para><filename>/etc/sane.d/*.conf</filename></para>
292
293 <indexterm zone="sane sane-config">
294 <primary sortas="e-etc-sane.d-conf">/etc/sane.d/*.conf</primary>
295 </indexterm>
296
297 </sect3>
298
299 <sect3>
300 <title>Configuration Information</title>
301
302 <sect4>
303 <title>Backend Configuration</title>
304
305 <para>The backend configuration files are located in
306 <filename class='directory'>/etc/sane.d</filename>. Information
307 for configuring the various backends can be found by using the man(5)
308 page for the desired backend. Run
309 <command>man sane-<replaceable>&lt;backend&gt;</replaceable></command>,
310 substituting the desired backend.</para>
311
312 <para>Add any desired users to the <systemitem
313 class="groupname">scanner</systemitem> group.</para>
314
315 </sect4>
316
317 <sect4>
318 <title>General Information</title>
319
320 <para>For general information about configuring and using
321 <application>SANE</application>, see <command>man sane</command>.
322 Linux-2.6.x brings some special issues into the picture. See
323 <ulink url="http://www.sane-project.org/README.linux"/> for
324 information about using <application>SANE</application> with the
325 Linux-2.6.x kernel. For information about USB scanning devices,
326 run <command>man sane-usb</command>. For information about SCSI
327 devices, run <command>man sane-scsi</command>.</para>
328
329 </sect4>
330
331 <sect4>
332 <title>Configuration and setup of the 'saned' daemon</title>
333
334 <para>The <command>saned</command> daemon is not meant to be used for
335 untrusted clients. You should provide <xref linkend="fw-firewall"/>
336 protection to ensure only trusted
337 clients access the daemon. Due to the complex security requirements to
338 ensure only trusted clients access the daemon, BLFS does not provide
339 instructions to configure the <command>saned</command> daemon. If you
340 desire to make the daemon available, ensure you provide adequate
341 security, configure your <filename>[x]inetd.conf</filename> file and
342 send a <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good
343 information for setting up and securing the <command>saned</command>
344 daemon can be found at
345 <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
346
347 </sect4>
348
349 </sect3>
350
351 </sect2>
352
353 <sect2 role="content">
354 <title>Contents</title>
355
356 <bridgehead renderas="sect4">Back Ends:</bridgehead>
357 <segmentedlist>
358 <segtitle>Installed Programs</segtitle>
359 <segtitle>Installed Libraries</segtitle>
360 <segtitle>Installed Directories</segtitle>
361
362 <seglistitem>
363 <seg>gamma4scanimage, sane-config, saned, sane-find-scanner,
364 and scanimage</seg>
365 <seg>libsane.so and numerous scanner backend modules</seg>
366 <seg>/etc/sane.d, /usr/include/sane, /usr/lib/sane, /usr/share/sane,
367 and /usr/share/doc/sane-&sane-version;</seg>
368 </seglistitem>
369 </segmentedlist>
370
371 <bridgehead renderas="sect4">Front Ends:</bridgehead>
372 <segmentedlist>
373 <segtitle>Installed Programs</segtitle>
374 <segtitle>Installed Library</segtitle>
375 <segtitle>Installed Directories</segtitle>
376
377 <seglistitem>
378 <seg>scanadf, xcam, and xscanimage</seg>
379 <seg><application>GIMP</application> plugin embedded in
380 <command>xscanimage</command></seg>
381 <seg>None</seg>
382 </seglistitem>
383 </segmentedlist>
384
385 <variablelist>
386 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
387 <?dbfo list-presentation="list"?>
388 <?dbhtml list-presentation="table"?>
389
390 <varlistentry id="gamma4scanimage">
391 <term><command>gamma4scanimage</command></term>
392 <listitem>
393 <para>creates a gamma table in the format expected by
394 <command>scanimage</command>.</para>
395 <indexterm zone="sane gamma4scanimage">
396 <primary sortas="b-gamma4scanimage">gamma4scanimage</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="sane-config-prog">
402 <term><command>sane-config</command></term>
403 <listitem>
404 <para>is a tool used to determine the compiler and linker
405 flags that should be used to compile and link
406 <application>SANE</application>.</para>
407 <indexterm zone="sane sane-config-prog">
408 <primary sortas="b-sane-config">sane-config</primary>
409 </indexterm>
410 </listitem>
411 </varlistentry>
412
413 <varlistentry id="saned">
414 <term><command>saned</command></term>
415 <listitem>
416 <para>is the <application>SANE</application> daemon that
417 allows remote clients to access image acquisition devices
418 available on the local host.</para>
419 <indexterm zone="sane saned">
420 <primary sortas="b-saned">saned</primary>
421 </indexterm>
422 </listitem>
423 </varlistentry>
424
425 <varlistentry id="sane-find-scanner">
426 <term><command>sane-find-scanner</command></term>
427 <listitem>
428 <para>is a command-line tool to find SCSI and
429 USB scanners and determine their device files. Its primary
430 purpose is to make sure that scanners can be detected by
431 <application>SANE</application> backends.</para>
432 <indexterm zone="sane sane-find-scanner">
433 <primary sortas="b-sane-find-scanner">sane-find-scanner</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="scanadf">
439 <term><command>scanadf</command></term>
440 <listitem>
441 <para>is a command-line interface to control image acquisition
442 devices which are equipped with an automatic document feeder
443 (ADF).</para>
444 <indexterm zone="sane scanadf">
445 <primary sortas="b-scanadf">scanadf</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="scanimage">
451 <term><command>scanimage</command></term>
452 <listitem>
453 <para>is a command line interface for scanning from image acquisition
454 devices such as flatbed scanners or cameras. It is also used to list
455 the available backend devices.</para>
456 <indexterm zone="sane scanimage">
457 <primary sortas="b-scanimage">scanimage</primary>
458 </indexterm>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry id="xcam">
463 <term><command>xcam</command></term>
464 <listitem>
465 <para>is a graphical camera front end for
466 <application>SANE</application>.</para>
467 <indexterm zone="sane xcam">
468 <primary sortas="b-xcam">xcam</primary>
469 </indexterm>
470 </listitem>
471 </varlistentry>
472
473 <varlistentry id="xscanimage">
474 <term><command>xscanimage</command></term>
475 <listitem>
476 <para>is a graphical user interface for scanning.</para>
477 <indexterm zone="sane xscanimage">
478 <primary sortas="b-xscanimage">xscanimage</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 <varlistentry id="libsane">
484 <term><filename class='libraryfile'>libsane.so</filename></term>
485 <listitem>
486 <para>is the application programming interface that is used to
487 communicate between frontends and backends.</para>
488 <indexterm zone="sane libsane">
489 <primary sortas="c-libsane">libsane.so</primary>
490 </indexterm>
491 </listitem>
492 </varlistentry>
493
494 <varlistentry id="libsane-module">
495 <term><filename class='libraryfile'>libsane-*.so</filename></term>
496 <listitem>
497 <para>modules are backend scanning library plugins used to interface
498 with scanning devices. See
499 <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
500 for a list of supported backends.</para>
501 <indexterm zone="sane libsane-module">
502 <primary sortas="c-libsane-module">libsane-*.so</primary>
503 </indexterm>
504 </listitem>
505 </varlistentry>
506
507 </variablelist>
508
509 </sect2>
510
511</sect1>
Note: See TracBrowser for help on using the repository browser.