source: pst/scanning/sane.xml@ 2096355

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 6.1 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 2096355 was 2096355, checked in by Manuel Canales Esparcia <manuel@…>, 19 years ago

Tagged sane.xml

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

  • Property mode set to 100644
File size: 15.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY sane-be-download-http "http://gd.tuwien.ac.at/api/sane/sane-backends-&sane-version;/sane-backends-&sane-version;.tar.gz">
8 <!ENTITY sane-be-download-ftp "ftp://ftp.sane-project.org/pub/sane/sane-backends-&sane-version;/sane-backends-&sane-version;.tar.gz">
9 <!ENTITY sane-be-md5sum "3b804f35cdfbc5ad2d201ffe078bbac9">
10 <!ENTITY sane-be-size "3.2 MB">
11 <!ENTITY sane-be-buildsize "50 MB">
12 <!ENTITY sane-be-time "1.26 SBU">
13
14 <!ENTITY sane-fe-version "1.0.13">
15 <!ENTITY sane-fe-download-http "http://gd.tuwien.ac.at/api/sane/sane-frontends-&sane-fe-version;/sane-frontends-&sane-fe-version;.tar.gz">
16 <!ENTITY sane-fe-download-ftp "ftp://ftp.sane-project.org/pub/sane/sane-frontends-&sane-fe-version;/sane-frontends-&sane-fe-version;.tar.gz">
17 <!ENTITY sane-fe-md5sum "2930626e627df49b45192a722cedc8a6">
18 <!ENTITY sane-fe-size "210 KB">
19 <!ENTITY sane-fe-buildsize "2.6 MB">
20 <!ENTITY sane-fe-time "0.09 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, SANE comes with its own protocol, and the
45 vendor drivers can't be used.</para>
46
47 <para>SANE is split into back ends and front ends. The back ends are drivers
48 for the supported scanners and cameras. The front ends are user interfaces
49 to access the backends.</para>
50
51 <bridgehead renderas="sect3">Back Ends Package Information</bridgehead>
52 <itemizedlist spacing='compact'>
53 <listitem>
54 <para>Download (HTTP): <ulink url="&sane-be-download-http;"/></para>
55 </listitem>
56 <listitem>
57 <para>Download (FTP): <ulink url="&sane-be-download-ftp;"/></para>
58 </listitem>
59 <listitem>
60 <para>Download MD5 sum: &sane-be-md5sum;</para>
61 </listitem>
62 <listitem>
63 <para>Download size: &sane-be-size;</para>
64 </listitem>
65 <listitem>
66 <para>Estimated disk space required: &sane-be-buildsize;</para>
67 </listitem>
68 <listitem>
69 <para>Estimated build time: &sane-be-time;</para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">Front Ends Package Information</bridgehead>
74 <itemizedlist spacing='compact'>
75 <listitem>
76 <para>Download (HTTP): <ulink url="&sane-fe-download-http;"/></para>
77 </listitem>
78 <listitem>
79 <para>Download (FTP): <ulink url="&sane-fe-download-ftp;"/></para>
80 </listitem>
81 <listitem>
82 <para>Downlaod MD5 sum: &sane-fe-md5sum;</para>
83 </listitem>
84 <listitem>
85 <para>Download size: &sane-fe-size;</para>
86 </listitem>
87 <listitem>
88 <para>Estimated disk space required: &sane-fe-buildsize;</para>
89 </listitem>
90 <listitem>
91 <para>Estimated build time: &sane-fe-time;</para>
92 </listitem>
93 </itemizedlist>
94
95 <bridgehead renderas="sect3">SANE Dependencies</bridgehead>
96
97 <bridgehead renderas="sect4">Optional (Back Ends)</bridgehead>
98 <para><xref linkend="libjpeg"/>,
99 <xref linkend="libusb"/>,
100 <ulink url="http://cyberelk.net/tim/libieee1284/">libieee1284</ulink>,
101 <ulink url="http://www.gphoto.org/">gPhoto2</ulink>
102 (requires <ulink url="http://www.gphoto.org/">libgphoto2</ulink>) and
103 <xref linkend="tex"/></para>
104
105 <bridgehead renderas="sect4">Optional (Front Ends)</bridgehead>
106 <para>X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
107 <xref linkend="gtk2"/> and
108 <xref linkend="gimp"/></para>
109
110 </sect2>
111
112 <sect2 role="kernel" id='sane-kernel'>
113 <title>Kernel Configuration</title>
114
115 <indexterm zone="sane sane-kernel">
116 <primary sortas="d-Scanning-devices">Scanning devices</primary>
117 </indexterm>
118
119 <para>To access your scanner, you will probably need the related kernel
120 drivers or additional support packages (<xref linkend="libusb"/>).
121 A SCSI scanner will need SCSI drivers, a parallel port scanner needs
122 parallel port support (you should use enhanced EPP modes) and a USB
123 scanner will need the <application>libusb</application> package and a
124 SCSI system for emulation. Be sure that you have got the necessary
125 drivers configured to access the devices.</para>
126
127 </sect2>
128
129 <sect2 role="installation">
130 <title>Installation of SANE</title>
131
132 <sect3>
133 <title>Installation of SANE Back Ends</title>
134
135 <para>Install <application>SANE</application>-backends by
136 running the following commands:</para>
137
138<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
139make</userinput></screen>
140
141 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
142
143<screen role="root"><userinput>make install</userinput></screen>
144
145 </sect3>
146
147 <sect3>
148 <title>Installation of SANE Front Ends</title>
149
150 <para>The <application>SANE</application>-frontends package
151 includes the graphical frontends <command>xscanimage</command> and
152 <command>xcam</command>, and a command-line frontend
153 <command>scanadf</command>. You don't need this package if you intend
154 to use one of the more advanced graphical frontends like
155 <xref linkend="xsane"/>. For a list of frontend packages, see
156 <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
157
158 <para>To install <application>SANE</application>-frontends,
159 use the following commands:</para>
160
161<screen><userinput>./configure --prefix=/usr &amp;&amp;
162make</userinput></screen>
163
164 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
165
166<screen role="root"><userinput>make install</userinput></screen>
167
168 <para>If <application>GIMP</application> was linked into the build
169 and you wish <application>GIMP</application> to use
170 <command>xscanimage</command> as a scanning plugin, issue the following
171 command as the <systemitem class="username">root</systemitem> user:</para>
172
173<screen role="root"><userinput>ln -v -s /usr/bin/xscanimage /usr/lib/gimp/2.0/plug-ins</userinput></screen>
174
175 </sect3>
176
177 </sect2>
178
179 <sect2 role="commands">
180 <title>Command Explanations</title>
181
182 <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
183 configuration files in <filename class="directory">/etc/sane.d</filename>
184 instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
185
186 </sect2>
187
188 <sect2 role="configuration">
189 <title>Configuring SANE</title>
190
191 <sect3 id="sane-config">
192 <title>Config Files</title>
193
194 <para><filename>/etc/sane.d/*.conf</filename></para>
195
196 <indexterm zone="sane sane-config">
197 <primary sortas="e-etc-sane.d-conf">/etc/sane.d/*.conf</primary>
198 </indexterm>
199
200 </sect3>
201
202 <sect3>
203 <title>Configuration Information</title>
204
205 <sect4>
206 <title>Backend Configuration</title>
207
208 <para>The backend configuration files are located in
209 <filename class='directory'>/etc/sane.d</filename>. Information
210 for configuring the various backends can be found by using the man(5)
211 page for the desired backend. Run
212 <command>man sane-<replaceable>[backend]</replaceable></command>,
213 substituting the desired backend.</para>
214
215 </sect4>
216
217 <sect4>
218 <title>General Information</title>
219
220 <para>For general information about configuring and using
221 <application>SANE</application>, see <command>man sane</command>.
222 Linux-2.6.x brings some special issues into the picture. See
223 <ulink url="http://www.sane-project.org/README.linux"/> for
224 information about using <application>SANE</application> with the
225 Linux-2.6.x kernel. For information about USB scanning devices,
226 run <command>man sane-usb</command>. For information about SCSI
227 devices, run <command>man sane-scsi</command>.</para>
228
229 </sect4>
230
231 <sect4>
232 <title>Configuration and setup of the 'saned' daemon</title>
233
234 <para>The <command>saned</command> daemon is not meant to be used for
235 untrusted clients. You should provide <xref linkend="tcpwrappers"/>
236 and/or <xref linkend="fw-firewall"/> protection to insure only trusted
237 clients access the daemon. Due to the complex security requirements to
238 insure only trusted clients access the daemon, BLFS does not provide
239 instructions to configure the <command>saned</command> daemon. If you
240 desire to make the daemon available, ensure you provide adequate
241 security, configure your <filename>[x]inetd.conf</filename> file and
242 send a <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good
243 information for setting up and securing the <command>saned</command>
244 daemon can be found at
245 <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
246
247 </sect4>
248
249 </sect3>
250
251 </sect2>
252
253 <sect2 role="content">
254 <title>Contents</title>
255
256 <bridgehead renderas="sect4">Back Ends:</bridgehead>
257 <segmentedlist>
258 <segtitle>Installed Programs</segtitle>
259 <segtitle>Installed Libraries</segtitle>
260 <segtitle>Installed Directories</segtitle>
261
262 <seglistitem>
263 <seg>gamma4scanimage, sane-config, saned, sane-find-scanner,
264 and scanimage</seg>
265 <seg>libsane.so and numerous scanner backend modules</seg>
266 <seg>/etc/sane.d, /usr/include/sane, /usr/lib/sane, /usr/share/sane, and
267 /usr/share/doc/sane-&sane-version;</seg>
268 </seglistitem>
269 </segmentedlist>
270
271 <bridgehead renderas="sect4">Front Ends:</bridgehead>
272 <segmentedlist>
273 <segtitle>Installed Programs</segtitle>
274 <segtitle>Installed Library</segtitle>
275 <segtitle>Installed Directory</segtitle>
276
277 <seglistitem>
278 <seg>scanadf, xcam, and xscanimage</seg>
279 <seg><application>GIMP</application> plugin imbedded in
280 <command>xscanimage</command></seg>
281 <seg>/usr/share/sane</seg>
282 </seglistitem>
283 </segmentedlist>
284
285 <variablelist>
286 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
287 <?dbfo list-presentation="list"?>
288 <?dbhtml list-presentation="table"?>
289
290 <varlistentry id="gamma4scanimage">
291 <term><command>gamma4scanimage</command></term>
292 <listitem>
293 <para>creates a gamma table in the format expected by
294 <command>scanimage</command>.</para>
295 <indexterm zone="sane gamma4scanimage">
296 <primary sortas="b-gamma4scanimage">gamma4scanimage</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="sane-config-prog">
302 <term><command>sane-config</command></term>
303 <listitem>
304 <para>is a tool used to determine the compiler and linker
305 flags that should be used to compile and link
306 <application>SANE</application>.</para>
307 <indexterm zone="sane sane-config-prog">
308 <primary sortas="b-sane-config">sane-config</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="saned">
314 <term><command>saned</command></term>
315 <listitem>
316 <para>is the <application>SANE</application> daemon that
317 allows remote clients to access image acquisition devices
318 available on the local host.</para>
319 <indexterm zone="sane saned">
320 <primary sortas="b-saned">saned</primary>
321 </indexterm>
322 </listitem>
323 </varlistentry>
324
325 <varlistentry id="sane-find-scanner">
326 <term><command>sane-find-scanner</command></term>
327 <listitem>
328 <para>is a command-line tool to find SCSI and
329 USB scanners and determine their device files. Its primary
330 aim is to make sure that scanners can be detected by
331 <application>SANE</application> backends.</para>
332 <indexterm zone="sane sane-find-scanner">
333 <primary sortas="b-sane-find-scanner">sane-find-scanner</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="scanadf">
339 <term><command>scanadf</command></term>
340 <listitem>
341 <para>is a command-line interface to control image acquisition
342 devices which are equipped with an automatic document feeder
343 (ADF).</para>
344 <indexterm zone="sane scanadf">
345 <primary sortas="b-scanadf">scanadf</primary>
346 </indexterm>
347 </listitem>
348 </varlistentry>
349
350 <varlistentry id="scanimage">
351 <term><command>scanimage</command></term>
352 <listitem>
353 <para>is a command line interface for scanning from image acquisition
354 devices such as flatbed scanners or cameras. It is also used to list
355 the available backend devices.</para>
356 <indexterm zone="sane scanimage">
357 <primary sortas="b-scanimage">scanimage</primary>
358 </indexterm>
359 </listitem>
360 </varlistentry>
361
362 <varlistentry id="xcam">
363 <term><command>xcam</command></term>
364 <listitem>
365 <para>is a graphical camera front end for
366 <application>SANE</application>.</para>
367 <indexterm zone="sane xcam">
368 <primary sortas="b-xcam">xcam</primary>
369 </indexterm>
370 </listitem>
371 </varlistentry>
372
373 <varlistentry id="xscanimage">
374 <term><command>xscanimage</command></term>
375 <listitem>
376 <para>is a graphical user interface for scanning.</para>
377 <indexterm zone="sane xscanimage">
378 <primary sortas="b-xscanimage">xscanimage</primary>
379 </indexterm>
380 </listitem>
381 </varlistentry>
382
383 <varlistentry id="libsane">
384 <term><filename class='libraryfile'>libsane.so</filename></term>
385 <listitem>
386 <para>is the application programming interface that is used to
387 communicate between frontends and backends.</para>
388 <indexterm zone="sane libsane">
389 <primary sortas="c-libsane">libsane.so</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="libsane-module">
395 <term><filename class='libraryfile'>libsane-*.so</filename></term>
396 <listitem>
397 <para>modules are backend scanning library plugins used to interface
398 with scanning devices. See
399 <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
400 for a list of supported backends.</para>
401 <indexterm zone="sane libsane-module">
402 <primary sortas="c-libsane-module">libsane-*.so</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 </variablelist>
408
409 </sect2>
410
411</sect1>
Note: See TracBrowser for help on using the repository browser.