source: pst/scanning/sane.xml@ 3f9d988e

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 3f9d988e was 3f9d988e, checked in by Bruce Dubbs <bdubbs@…>, 11 years ago

Update tags

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