source: pst/scanning/sane.xml@ f1e103a

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 f1e103a was f1e103a, checked in by Randy McMurchy <randy@…>, 13 years ago

Added new package TeX Live-20100722

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@8820 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 16.3 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/download.php/2318/sane-backends-&sane-version;.tar.gz">
8 <!ENTITY sane-be-download-ftp "ftp://ftp2.sane-project.org/pub/sane/old-versions/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 "8c0936272dcfd4e98c51512699f1c06f">
11 <!ENTITY sane-be-size "4.1 MB">
12 <!ENTITY sane-be-buildsize "71 MB">
13 <!ENTITY sane-be-time "1.5 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-compat"/>,
102 <ulink url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>,
103 <ulink url="http://www.gphoto.org/">libgphoto2</ulink>, and
104 <xref linkend="tetex"/> or <xref linkend="texlive"/></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>The <application>SANE</application> daemon should run with its own
140 group. Create this group by issuing the following commands as the
141 <systemitem class="username">root</systemitem> user:</para>
142
143<screen><userinput>groupadd -g 70 scanner</userinput></screen>
144
145 <para>Install <application>SANE</application>-backends by
146 running the following commands:</para>
147
148<screen><userinput>sed -i 's/SYSFS/ATTRS/g' tools/sane-desc.c &amp;&amp;
149./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
150make</userinput></screen>
151
152 <para>This package does not come with a test suite.</para>
153
154 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
155
156<screen role="root"><userinput>make install &amp;&amp;
157install -m 644 -v tools/udev/libsane.rules /etc/udev/rules.d/65-scanner.rules</userinput></screen>
158
159 </sect3>
160
161 <sect3>
162 <title>Installation of SANE Front Ends</title>
163
164 <para>The <application>SANE</application>-frontends package
165 includes the graphical frontends <command>xscanimage</command> and
166 <command>xcam</command>, and a command-line frontend
167 <command>scanadf</command>. You don't need this package if you intend
168 to use one of the more advanced graphical frontends like
169 <xref linkend="xsane"/>. For a list of frontend packages, see
170 <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
171
172 <para>To install <application>SANE</application>-frontends,
173 use the following commands:</para>
174
175<screen><userinput>./configure --prefix=/usr &amp;&amp;
176make</userinput></screen>
177
178 <para>This package does not come with a test suite.</para>
179
180 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
181
182<screen role="root"><userinput>make install &amp;&amp;
183install -v -m644 doc/sane.png xscanimage-icon-48x48-2.png \
184 /usr/share/sane</userinput></screen>
185
186 <para>If <application>GIMP</application> was linked into the build and
187 you wish <application>GIMP</application> to use
188 <command>xscanimage</command> as a scanning plugin, issue the following
189 command as the <systemitem class="username">root</systemitem> user:</para>
190
191<screen role="root"><userinput>ln -v -s ../../../../bin/xscanimage /usr/lib/gimp/2.0/plug-ins</userinput></screen>
192
193 </sect3>
194
195 </sect2>
196
197 <sect2 role="commands">
198 <title>Command Explanations</title>
199
200 <para><command>sed -i 's/SYSFS/ATTRS/g' tools/sane-desc.c</command>: This
201 command fixes an obsolete <application>udev</application> parameter.</para>
202
203 <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
204 configuration files in <filename class="directory">/etc/sane.d</filename>
205 instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
206
207 </sect2>
208
209 <sect2 role="configuration">
210 <title>Configuring SANE</title>
211
212 <sect3 id="sane-config">
213 <title>Config Files</title>
214
215 <para><filename>/etc/sane.d/*.conf</filename></para>
216
217 <indexterm zone="sane sane-config">
218 <primary sortas="e-etc-sane.d-conf">/etc/sane.d/*.conf</primary>
219 </indexterm>
220
221 </sect3>
222
223 <sect3>
224 <title>Configuration Information</title>
225
226 <sect4>
227 <title>Backend Configuration</title>
228
229 <para>The backend configuration files are located in
230 <filename class='directory'>/etc/sane.d</filename>. Information
231 for configuring the various backends can be found by using the man(5)
232 page for the desired backend. Run
233 <command>man sane-<replaceable>&lt;backend&gt;</replaceable></command>,
234 substituting the desired backend.</para>
235
236 <para>Add any desired users to the <systemitem
237 class="groupname">scanner</systemitem> group.</para>
238
239 </sect4>
240
241 <sect4>
242 <title>General Information</title>
243
244 <para>For general information about configuring and using
245 <application>SANE</application>, see <command>man sane</command>.
246 Linux-2.6.x brings some special issues into the picture. See
247 <ulink url="http://www.sane-project.org/README.linux"/> for
248 information about using <application>SANE</application> with the
249 Linux-2.6.x kernel. For information about USB scanning devices,
250 run <command>man sane-usb</command>. For information about SCSI
251 devices, run <command>man sane-scsi</command>.</para>
252
253 </sect4>
254
255 <sect4>
256 <title>Configuration and setup of the 'saned' daemon</title>
257
258 <para>The <command>saned</command> daemon is not meant to be used for
259 untrusted clients. You should provide <xref linkend="tcpwrappers"/>
260 and/or <xref linkend="fw-firewall"/> protection to ensure only trusted
261 clients access the daemon. Due to the complex security requirements to
262 ensure only trusted clients access the daemon, BLFS does not provide
263 instructions to configure the <command>saned</command> daemon. If you
264 desire to make the daemon available, ensure you provide adequate
265 security, configure your <filename>[x]inetd.conf</filename> file and
266 send a <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good
267 information for setting up and securing the <command>saned</command>
268 daemon can be found at
269 <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
270
271 </sect4>
272
273 </sect3>
274
275 </sect2>
276
277 <sect2 role="content">
278 <title>Contents</title>
279
280 <bridgehead renderas="sect4">Back Ends:</bridgehead>
281 <segmentedlist>
282 <segtitle>Installed Programs</segtitle>
283 <segtitle>Installed Libraries</segtitle>
284 <segtitle>Installed Directories</segtitle>
285
286 <seglistitem>
287 <seg>gamma4scanimage, sane-config, saned, sane-find-scanner,
288 and scanimage</seg>
289 <seg>libsane.so and numerous scanner backend modules</seg>
290 <seg>/etc/sane.d, /usr/include/sane, /usr/lib/sane, /usr/share/sane,
291 and /usr/share/doc/sane-&sane-version;</seg>
292 </seglistitem>
293 </segmentedlist>
294
295 <bridgehead renderas="sect4">Front Ends:</bridgehead>
296 <segmentedlist>
297 <segtitle>Installed Programs</segtitle>
298 <segtitle>Installed Library</segtitle>
299 <segtitle>Installed Directories</segtitle>
300
301 <seglistitem>
302 <seg>scanadf, xcam, and xscanimage</seg>
303 <seg><application>GIMP</application> plugin embedded in
304 <command>xscanimage</command></seg>
305 <seg>None</seg>
306 </seglistitem>
307 </segmentedlist>
308
309 <variablelist>
310 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
311 <?dbfo list-presentation="list"?>
312 <?dbhtml list-presentation="table"?>
313
314 <varlistentry id="gamma4scanimage">
315 <term><command>gamma4scanimage</command></term>
316 <listitem>
317 <para>creates a gamma table in the format expected by
318 <command>scanimage</command>.</para>
319 <indexterm zone="sane gamma4scanimage">
320 <primary sortas="b-gamma4scanimage">gamma4scanimage</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="sane-config-prog">
326 <term><command>sane-config</command></term>
327 <listitem>
328 <para>is a tool used to determine the compiler and linker
329 flags that should be used to compile and link
330 <application>SANE</application>.</para>
331 <indexterm zone="sane sane-config-prog">
332 <primary sortas="b-sane-config">sane-config</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="saned">
338 <term><command>saned</command></term>
339 <listitem>
340 <para>is the <application>SANE</application> daemon that
341 allows remote clients to access image acquisition devices
342 available on the local host.</para>
343 <indexterm zone="sane saned">
344 <primary sortas="b-saned">saned</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 <varlistentry id="sane-find-scanner">
350 <term><command>sane-find-scanner</command></term>
351 <listitem>
352 <para>is a command-line tool to find SCSI and
353 USB scanners and determine their device files. Its primary
354 purpose is to make sure that scanners can be detected by
355 <application>SANE</application> backends.</para>
356 <indexterm zone="sane sane-find-scanner">
357 <primary sortas="b-sane-find-scanner">sane-find-scanner</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="scanadf">
363 <term><command>scanadf</command></term>
364 <listitem>
365 <para>is a command-line interface to control image acquisition
366 devices which are equipped with an automatic document feeder
367 (ADF).</para>
368 <indexterm zone="sane scanadf">
369 <primary sortas="b-scanadf">scanadf</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="scanimage">
375 <term><command>scanimage</command></term>
376 <listitem>
377 <para>is a command line interface for scanning from image acquisition
378 devices such as flatbed scanners or cameras. It is also used to list
379 the available backend devices.</para>
380 <indexterm zone="sane scanimage">
381 <primary sortas="b-scanimage">scanimage</primary>
382 </indexterm>
383 </listitem>
384 </varlistentry>
385
386 <varlistentry id="xcam">
387 <term><command>xcam</command></term>
388 <listitem>
389 <para>is a graphical camera front end for
390 <application>SANE</application>.</para>
391 <indexterm zone="sane xcam">
392 <primary sortas="b-xcam">xcam</primary>
393 </indexterm>
394 </listitem>
395 </varlistentry>
396
397 <varlistentry id="xscanimage">
398 <term><command>xscanimage</command></term>
399 <listitem>
400 <para>is a graphical user interface for scanning.</para>
401 <indexterm zone="sane xscanimage">
402 <primary sortas="b-xscanimage">xscanimage</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="libsane">
408 <term><filename class='libraryfile'>libsane.so</filename></term>
409 <listitem>
410 <para>is the application programming interface that is used to
411 communicate between frontends and backends.</para>
412 <indexterm zone="sane libsane">
413 <primary sortas="c-libsane">libsane.so</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="libsane-module">
419 <term><filename class='libraryfile'>libsane-*.so</filename></term>
420 <listitem>
421 <para>modules are backend scanning library plugins used to interface
422 with scanning devices. See
423 <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
424 for a list of supported backends.</para>
425 <indexterm zone="sane libsane-module">
426 <primary sortas="c-libsane-module">libsane-*.so</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 </variablelist>
432
433 </sect2>
434
435</sect1>
Note: See TracBrowser for help on using the repository browser.