source: pst/scanning/sane.xml@ a29486e4

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

Update locations of files hosted on anduin

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@16519 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 21.2 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://fossies.org/linux/misc//sane-backends-&sane-version;.tar.gz">
8 <!ENTITY sane-be-download-ftp " ">
9 <!ENTITY sane-be-md5sum "1ca68e536cd7c1852322822f5f6ac3a4">
10 <!ENTITY sane-be-size "5.6 MB">
11 <!ENTITY sane-be-buildsize "97 MB">
12 <!ENTITY sane-be-time "1 SBU">
13
14 <!ENTITY sane-fe-download-http "http://alioth.debian.org/frs/download.php/file/1140/sane-frontends-&sane-fe-version;.tar.gz">
15 <!ENTITY sane-fe-download-ftp "ftp://ftp2.sane-project.org/pub/sane/sane-frontends-&sane-fe-version;.tar.gz">
16 <!ENTITY sane-fe-md5sum "c63bf7b0bb5f530cf3c08715db721cd3">
17 <!ENTITY sane-fe-size "231 KB">
18 <!ENTITY sane-fe-buildsize "3.0 MB">
19 <!ENTITY sane-fe-time "less than 0.1 SBU">
20]>
21
22<sect1 id="sane" xreflabel="SANE-&sane-version;">
23 <?dbhtml filename="sane.html"?>
24
25 <sect1info>
26 <othername>$LastChangedBy$</othername>
27 <date>$Date$</date>
28 </sect1info>
29
30 <title>SANE-&sane-version;</title>
31
32 <indexterm zone="sane">
33 <primary sortas="a-SANE">SANE</primary>
34 </indexterm>
35
36 <sect2 role="package">
37 <title>Introduction to SANE</title>
38
39 <para><application>SANE</application> is short for Scanner Access Now Easy.
40 Scanner access; however, is far from easy, since every vendor has their own
41 protocols. The only known protocol that should bring some unity into this
42 chaos is the TWAIN interface, but this is too imprecise to allow a stable
43 scanning framework. Therefore, <application>SANE</application> comes with
44 its own protocol, and the vendor drivers can't be used.</para>
45
46 <para><application>SANE</application> is split into back ends and front
47 ends. The back ends are drivers for the supported scanners and cameras. The
48 front ends are user interfaces to access the backends.</para>
49
50 &lfs78_checked;
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">Additional Downloads</bridgehead>
97 <itemizedlist spacing="compact">
98 <listitem>
99 <para>Required patch:
100 <ulink url="&patch-root;/sane-backends-&sane-version;-v4l-1.patch"/>
101 </para>
102 </listitem>
103 </itemizedlist>
104-->
105 <bridgehead renderas="sect3">SANE Dependencies</bridgehead>
106
107 <bridgehead renderas="sect4">Optional (Back Ends)</bridgehead>
108 <para role="optional">
109 <xref linkend="avahi"/>,
110 <xref linkend="cups"/>,
111 <xref linkend="libjpeg"/>,
112 <xref linkend="libtiff"/>,
113 <xref linkend="libusb"/>,
114 <xref linkend="v4l-utils"/>,
115 <ulink url="http://www.net-snmp.org/">Net-SNMP</ulink>,
116 <ulink url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>,
117 <ulink url="http://www.gphoto.org/">libgphoto2</ulink>, and
118 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
119 </para>
120
121 <bridgehead renderas="sect4">Optional (Front Ends)</bridgehead>
122 <para role="optional">
123 <xref linkend="x-window-system"/>,
124 <xref linkend="gtk2"/>, and
125 <xref linkend="gimp"/>
126 </para>
127
128 <para condition="html" role="usernotes">User Notes:
129 <ulink url="&blfs-wiki;/sane"/></para>
130
131 </sect2>
132
133 <sect2 role="kernel" id='sane-kernel'>
134 <title>Kernel Configuration, Drivers and Additional Packages</title>
135
136 <indexterm zone="sane sane-kernel">
137 <primary sortas="d-Scanning-devices">Scanning devices</primary>
138 </indexterm>
139
140 <para>To access your scanner, you will probably need the related kernel
141 drivers and/or additional support packages. A SCSI scanner will need SCSI
142 drivers, a parallel port scanner needs parallel port support (you should
143 use enhanced EPP modes) and perhaps <ulink
144 url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>, and a USB
145 scanner will need the <xref linkend="libusb"/> package. For HP devices, you
146 may need <ulink
147 url="http://sourceforge.net/projects/hplip/files/hplip/">hplip</ulink>.
148 Ensure you have the necessary drivers properly configured to access
149 the devices.</para>
150
151 </sect2>
152
153 <sect2 role="installation">
154 <title>Installation of SANE</title>
155
156 <sect3>
157 <title>Installation of SANE Back Ends</title>
158
159 <note>
160 <para>
161 You may safely disregard any messages printed on the screen when you
162 unpack the tarball.
163 </para>
164 </note>
165
166 <para>The <application>SANE</application> daemon should run with its own
167 group. Create this group by issuing the following commands as the
168 <systemitem class="username">root</systemitem> user:</para>
169
170<screen><userinput>groupadd -g 70 scanner</userinput></screen>
171
172 <note>
173 <para>
174 The user building <application>SANE</application>-backends should be
175 a member of the <systemitem class="groupname">scanner</systemitem>
176 group before proceeding. After you have added the user building the
177 package to the <systemitem class="groupname">scanner</systemitem>
178 group, issue the following command to create a new shell:
179 </para>
180
181<screen><userinput>su $(whoami)</userinput></screen>
182
183 <para>
184 Check the output of the <userinput>groups</userinput> command and
185 ensure the user is a member of the
186 <systemitem class="groupname">scanner</systemitem> group.
187 </para>
188 </note>
189
190 <para>For a USB scanner, if you are linking to <xref linkend="libusb"/>,
191 include the configure switch --enable-libusb_1_0. Install
192 <application>SANE</application>-backends by running the following
193 commands:</para>
194
195 <!-- Not sure why this was there as it works if TeX is installed
196 and it doesn't try to use it if TeX is not installed
197 -disable-latex &amp;&amp; -->
198
199<screen><userinput>./configure --prefix=/usr \
200 --sysconfdir=/etc \
201 --localstatedir=/var \
202 --with-docdir=/usr/share/doc/sane-backend-&sane-version; \
203 --with-group=scanner &amp;&amp;
204make &amp;&amp;
205exit</userinput></screen>
206
207 <para>If you want to test the results, some files need to be fixed:</para>
208
209<screen><userinput>sed -i -e 's/Jul 31 07:52:48/Oct 7 08:58:33/' \
210 -e 's/1.0.24git/1.0.24/' \
211 testsuite/tools/data/db.ref \
212 testsuite/tools/data/html-mfgs.ref \
213 testsuite/tools/data/usermap.ref \
214 testsuite/tools/data/html-backends-split.ref \
215 testsuite/tools/data/udev+acl.ref \
216 testsuite/tools/data/udev.ref</userinput></screen>
217
218 <para>To test the results, issue: <command>make check</command>.</para>
219
220 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
221
222<screen role="root"><userinput>make install &amp;&amp;
223install -m 644 -v tools/udev/libsane.rules \
224 /etc/udev/rules.d/65-scanner.rules &amp;&amp;
225chgrp -v scanner /var/lock/sane</userinput></screen>
226
227 <para>With the scanner on, run <command>scanimage -L</command> and the
228 name and location of the device should appear. Of course, you need the
229 device drivers configured, in order to run this test.</para>
230
231 </sect3>
232
233 <sect3>
234 <title>Installation of SANE Front Ends</title>
235
236 <para>The <application>SANE</application>-frontends package
237 includes the graphical frontends <command>xscanimage</command> and
238 <command>xcam</command>, and a command-line frontend
239 <command>scanadf</command>. You don't need this package if you intend
240 to use one of the more advanced graphical frontends like
241 <xref linkend="xsane"/>. For a list of frontend packages, see
242 <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
243
244 <para>To install <application>SANE</application>-frontends,
245 use the following commands:</para>
246
247<screen><userinput>sed -i -e "/SANE_CAP_ALWAYS_SETTABLE/d" src/gtkglue.c &amp;&amp;
248./configure --prefix=/usr --mandir=/usr/share/man &amp;&amp;
249make</userinput></screen>
250
251 <para>This package does not come with a test suite.</para>
252
253 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
254
255<screen role="root"><userinput>make install &amp;&amp;
256install -v -m644 doc/sane.png xscanimage-icon-48x48-2.png \
257 /usr/share/sane</userinput></screen>
258
259 <para>If <application>GIMP</application> was linked into the build and
260 you wish <application>GIMP</application> to use
261 <command>xscanimage</command> as a scanning plugin, issue the following
262 command as the <systemitem class="username">root</systemitem> user:</para>
263
264<screen role="root"><userinput>ln -v -s ../../../../bin/xscanimage /usr/lib/gimp/2.0/plug-ins</userinput></screen>
265
266 <note>
267 <para>
268 If the plugin <command>xscanimage</command> is disabled in
269 <application>GIMP</application>'s menu, in order to enable it,
270 "create" a blank image using the menu or Ctrl-N. After that, it is
271 enabled.
272 </para>
273 </note>
274
275 </sect3>
276
277 </sect2>
278
279 <sect2 role="commands">
280 <title>Command Explanations</title>
281
282 <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
283 configuration files in <filename class="directory">/etc/sane.d</filename>
284 instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
285
286 <para><parameter>--with-group=scanner</parameter>: This parameter causes
287 the directory created for the locking files to be group owned by the
288 <systemitem class="groupname">scanner</systemitem> group instead of the
289 default <systemitem class="groupname">uucp</systemitem> group.</para>
290
291 <para><command>exit</command>: This command is used to exit the shell
292 created by the <command>su</command> command.</para>
293 </sect2>
294
295 <sect2 role="configuration">
296 <title>Configuring SANE</title>
297
298 <sect3 id="sane-config">
299 <title>Config Files</title>
300
301 <para><filename>/etc/sane.d/*.conf</filename></para>
302
303 <indexterm zone="sane sane-config">
304 <primary sortas="e-etc-sane.d-conf">/etc/sane.d/*.conf</primary>
305 </indexterm>
306
307 </sect3>
308
309 <sect3>
310 <title>Configuration Information</title>
311
312 <sect4>
313 <title>Backend Configuration</title>
314
315 <para>The backend configuration files are located in
316 <filename class='directory'>/etc/sane.d</filename>. Information
317 for configuring the various backends can be found by using the man(5)
318 page for the desired backend. Run
319 <command>man sane-<replaceable>&lt;backend&gt;</replaceable></command>,
320 substituting the desired backend.</para>
321
322 <para>Add any desired users to the <systemitem
323 class="groupname">scanner</systemitem> group.</para>
324
325 <para>If you want to access a network scanner, include two lines in
326 <filename>net.conf</filename>, as <systemitem class="username">root</systemitem> user
327 (make sure to replace &lt;server_ip&gt; by the actual value, below):</para>
328
329<screen role="root"><userinput>cat &gt;&gt; /etc/sane.d/net.conf &lt;&lt; "EOF"
330connect_timeout = 60
331&lt;server_ip&gt;
332EOF</userinput></screen>
333
334 <para>On the server side, include the client ip in the access list of
335 <filename>/etc/sane.d/saned.conf</filename>, restart the
336 <command>saned</command> daemon, and make sure the firewall, if any, is
337 open to the client.</para>
338
339 </sect4>
340
341 <sect4>
342 <title>Frontend Configuration</title>
343 <para>
344 If you use a desktop environment like <application>Gnome</application>
345 or <application>KDE</application> you may wish to create a
346 <filename>xscanimage.desktop</filename> file so that
347 <application>xscanimage</application> appears in the panel's menus.
348 As the <systemitem class="username">root</systemitem> user:
349 </para>
350
351<screen role="root"><userinput>mkdir -pv /usr/share/{applications,pixmaps} &amp;&amp;
352
353cat &gt; /usr/share/applications/xscanimage.desktop &lt;&lt; "EOF" &amp;&amp;
354[Desktop Entry]
355Encoding=UTF-8
356Name=XScanImage - Scanning
357Comment=Acquire images from a scanner
358Exec=xscanimage
359Icon=xscanimage
360Terminal=false
361Type=Application
362Categories=Application;Graphics
363EOF
364
365ln -svf ../sane/xscanimage-icon-48x48-2.png /usr/share/pixmaps/xscanimage.png</userinput></screen>
366
367 </sect4>
368
369 <sect4>
370 <title>General Information</title>
371
372 <para>For general information about configuring and using
373 <application>SANE</application>, see <command>man sane</command>.
374 Linux-2.6.x brings some special issues into the picture. See
375 <ulink url="http://www.sane-project.org/README.linux"/> for
376 information about using <application>SANE</application> with the
377 Linux-2.6.x kernel. For information about USB scanning devices,
378 run <command>man sane-usb</command>. For information about SCSI
379 devices, run <command>man sane-scsi</command>.</para>
380
381 </sect4>
382
383 <sect4>
384 <title>Configuration and setup of the 'saned' daemon</title>
385
386 <para>The <command>saned</command> daemon is not meant to be used for
387 untrusted clients. You should provide <xref linkend="fw-firewall"/>
388 protection to ensure only trusted
389 clients access the daemon. Due to the complex security requirements to
390 ensure only trusted clients access the daemon, BLFS does not provide
391 instructions to configure the <command>saned</command> daemon. If you
392 desire to make the daemon available, ensure you provide adequate
393 security, configure your <filename>[x]inetd.conf</filename> file and
394 send a <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good
395 information for setting up and securing the <command>saned</command>
396 daemon can be found at
397 <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
398
399 </sect4>
400
401 </sect3>
402
403 </sect2>
404
405 <sect2 role="content">
406 <title>Contents</title>
407
408 <bridgehead renderas="sect4">Back Ends:</bridgehead>
409 <segmentedlist>
410 <segtitle>Installed Programs</segtitle>
411 <segtitle>Installed Libraries</segtitle>
412 <segtitle>Installed Directories</segtitle>
413
414 <seglistitem>
415 <seg>gamma4scanimage, sane-config, saned, sane-find-scanner,
416 and scanimage</seg>
417 <seg>libsane.so and numerous scanner backend modules</seg>
418 <seg>/etc/sane.d, /usr/include/sane, /usr/lib/sane, /usr/share/sane,
419 and /usr/share/doc/sane-&sane-version;</seg>
420 </seglistitem>
421 </segmentedlist>
422
423 <bridgehead renderas="sect4">Front Ends:</bridgehead>
424 <segmentedlist>
425 <segtitle>Installed Programs</segtitle>
426 <segtitle>Installed Library</segtitle>
427 <segtitle>Installed Directories</segtitle>
428
429 <seglistitem>
430 <seg>scanadf, xcam, and xscanimage</seg>
431 <seg><application>GIMP</application> plugin embedded in
432 <command>xscanimage</command></seg>
433 <seg>None</seg>
434 </seglistitem>
435 </segmentedlist>
436
437 <variablelist>
438 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
439 <?dbfo list-presentation="list"?>
440 <?dbhtml list-presentation="table"?>
441
442 <varlistentry id="gamma4scanimage">
443 <term><command>gamma4scanimage</command></term>
444 <listitem>
445 <para>creates a gamma table in the format expected by
446 <command>scanimage</command>.</para>
447 <indexterm zone="sane gamma4scanimage">
448 <primary sortas="b-gamma4scanimage">gamma4scanimage</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="sane-config-prog">
454 <term><command>sane-config</command></term>
455 <listitem>
456 <para>is a tool used to determine the compiler and linker
457 flags that should be used to compile and link
458 <application>SANE</application>.</para>
459 <indexterm zone="sane sane-config-prog">
460 <primary sortas="b-sane-config">sane-config</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="saned">
466 <term><command>saned</command></term>
467 <listitem>
468 <para>is the <application>SANE</application> daemon that
469 allows remote clients to access image acquisition devices
470 available on the local host.</para>
471 <indexterm zone="sane saned">
472 <primary sortas="b-saned">saned</primary>
473 </indexterm>
474 </listitem>
475 </varlistentry>
476
477 <varlistentry id="sane-find-scanner">
478 <term><command>sane-find-scanner</command></term>
479 <listitem>
480 <para>is a command-line tool to find SCSI and
481 USB scanners and determine their device files. Its primary
482 purpose is to make sure that scanners can be detected by
483 <application>SANE</application> backends.</para>
484 <indexterm zone="sane sane-find-scanner">
485 <primary sortas="b-sane-find-scanner">sane-find-scanner</primary>
486 </indexterm>
487 </listitem>
488 </varlistentry>
489
490 <varlistentry id="scanadf">
491 <term><command>scanadf</command></term>
492 <listitem>
493 <para>is a command-line interface to control image acquisition
494 devices which are equipped with an automatic document feeder
495 (ADF).</para>
496 <indexterm zone="sane scanadf">
497 <primary sortas="b-scanadf">scanadf</primary>
498 </indexterm>
499 </listitem>
500 </varlistentry>
501
502 <varlistentry id="scanimage">
503 <term><command>scanimage</command></term>
504 <listitem>
505 <para>is a command line interface for scanning from image acquisition
506 devices such as flatbed scanners or cameras. It is also used to list
507 the available backend devices.</para>
508 <indexterm zone="sane scanimage">
509 <primary sortas="b-scanimage">scanimage</primary>
510 </indexterm>
511 </listitem>
512 </varlistentry>
513
514 <varlistentry id="xcam">
515 <term><command>xcam</command></term>
516 <listitem>
517 <para>is a graphical camera front end for
518 <application>SANE</application>.</para>
519 <indexterm zone="sane xcam">
520 <primary sortas="b-xcam">xcam</primary>
521 </indexterm>
522 </listitem>
523 </varlistentry>
524
525 <varlistentry id="xscanimage">
526 <term><command>xscanimage</command></term>
527 <listitem>
528 <para>is a graphical user interface for scanning.</para>
529 <indexterm zone="sane xscanimage">
530 <primary sortas="b-xscanimage">xscanimage</primary>
531 </indexterm>
532 </listitem>
533 </varlistentry>
534
535 <varlistentry id="libsane">
536 <term><filename class='libraryfile'>libsane.so</filename></term>
537 <listitem>
538 <para>is the application programming interface that is used to
539 communicate between frontends and backends.</para>
540 <indexterm zone="sane libsane">
541 <primary sortas="c-libsane">libsane.so</primary>
542 </indexterm>
543 </listitem>
544 </varlistentry>
545
546 <varlistentry id="libsane-module">
547 <term><filename class='libraryfile'>libsane-*.so</filename></term>
548 <listitem>
549 <para>modules are backend scanning library plugins used to interface
550 with scanning devices. See
551 <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
552 for a list of supported backends.</para>
553 <indexterm zone="sane libsane-module">
554 <primary sortas="c-libsane-module">libsane-*.so</primary>
555 </indexterm>
556 </listitem>
557 </varlistentry>
558
559 </variablelist>
560
561 </sect2>
562
563</sect1>
Note: See TracBrowser for help on using the repository browser.