[2096355] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[5d1668d] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[f051506c] | 6 |
|
---|
[9ea2f70] | 7 | <!ENTITY sane-be-download-http "http://alioth.debian.org/download.php/1079/sane-backends-&sane-version;.tar.gz">
|
---|
[f051506c] | 8 | <!ENTITY sane-be-download-ftp "ftp://ftp.sane-project.org/pub/sane/sane-backends-&sane-version;/sane-backends-&sane-version;.tar.gz">
|
---|
[9ea2f70] | 9 | <!ENTITY sane-be-md5sum "bec9b9262246316b4ebfe2bc7451aa28">
|
---|
| 10 | <!ENTITY sane-be-size "3.4 MB">
|
---|
| 11 | <!ENTITY sane-be-buildsize "56 MB">
|
---|
| 12 | <!ENTITY sane-be-time "1.3 SBU">
|
---|
[f051506c] | 13 |
|
---|
| 14 | <!ENTITY sane-fe-version "1.0.13">
|
---|
[9ea2f70] | 15 | <!ENTITY sane-fe-download-http "http://alioth.debian.org/download.php/791/sane-frontends-&sane-fe-version;.tar.gz">
|
---|
[f051506c] | 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">
|
---|
[9ea2f70] | 19 | <!ENTITY sane-fe-buildsize "2.7 MB">
|
---|
| 20 | <!ENTITY sane-fe-time "0.1 SBU">
|
---|
[5d1668d] | 21 | ]>
|
---|
| 22 |
|
---|
[8ba1563] | 23 | <sect1 id="sane" xreflabel="SANE-&sane-version;">
|
---|
[2096355] | 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
|
---|
[9ea2f70] | 123 | scanner will need the <application>libusb</application> package. Ensure
|
---|
| 124 | you have got the necessary drivers properly configured to access the
|
---|
| 125 | devices.</para>
|
---|
[2096355] | 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 &&
|
---|
| 139 | make</userinput></screen>
|
---|
| 140 |
|
---|
[9ea2f70] | 141 | <para>This package does not come with a test suite.</para>
|
---|
| 142 |
|
---|
[2096355] | 143 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 144 |
|
---|
| 145 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 146 |
|
---|
| 147 | </sect3>
|
---|
| 148 |
|
---|
| 149 | <sect3>
|
---|
| 150 | <title>Installation of SANE Front Ends</title>
|
---|
| 151 |
|
---|
| 152 | <para>The <application>SANE</application>-frontends package
|
---|
| 153 | includes the graphical frontends <command>xscanimage</command> and
|
---|
| 154 | <command>xcam</command>, and a command-line frontend
|
---|
| 155 | <command>scanadf</command>. You don't need this package if you intend
|
---|
| 156 | to use one of the more advanced graphical frontends like
|
---|
| 157 | <xref linkend="xsane"/>. For a list of frontend packages, see
|
---|
| 158 | <ulink url="http://www.sane-project.org/sane-frontends.html"/>.</para>
|
---|
| 159 |
|
---|
| 160 | <para>To install <application>SANE</application>-frontends,
|
---|
| 161 | use the following commands:</para>
|
---|
| 162 |
|
---|
| 163 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 164 | make</userinput></screen>
|
---|
| 165 |
|
---|
| 166 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 167 |
|
---|
| 168 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 169 |
|
---|
| 170 | <para>If <application>GIMP</application> was linked into the build
|
---|
| 171 | and you wish <application>GIMP</application> to use
|
---|
| 172 | <command>xscanimage</command> as a scanning plugin, issue the following
|
---|
| 173 | command as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 174 |
|
---|
| 175 | <screen role="root"><userinput>ln -v -s /usr/bin/xscanimage /usr/lib/gimp/2.0/plug-ins</userinput></screen>
|
---|
| 176 |
|
---|
| 177 | </sect3>
|
---|
| 178 |
|
---|
| 179 | </sect2>
|
---|
| 180 |
|
---|
| 181 | <sect2 role="commands">
|
---|
| 182 | <title>Command Explanations</title>
|
---|
| 183 |
|
---|
| 184 | <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
|
---|
| 185 | configuration files in <filename class="directory">/etc/sane.d</filename>
|
---|
| 186 | instead of <filename class="directory">/usr/etc/sane.d</filename>.</para>
|
---|
| 187 |
|
---|
| 188 | </sect2>
|
---|
| 189 |
|
---|
| 190 | <sect2 role="configuration">
|
---|
| 191 | <title>Configuring SANE</title>
|
---|
| 192 |
|
---|
| 193 | <sect3 id="sane-config">
|
---|
| 194 | <title>Config Files</title>
|
---|
| 195 |
|
---|
| 196 | <para><filename>/etc/sane.d/*.conf</filename></para>
|
---|
| 197 |
|
---|
| 198 | <indexterm zone="sane sane-config">
|
---|
| 199 | <primary sortas="e-etc-sane.d-conf">/etc/sane.d/*.conf</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 |
|
---|
| 202 | </sect3>
|
---|
| 203 |
|
---|
| 204 | <sect3>
|
---|
| 205 | <title>Configuration Information</title>
|
---|
| 206 |
|
---|
| 207 | <sect4>
|
---|
| 208 | <title>Backend Configuration</title>
|
---|
| 209 |
|
---|
| 210 | <para>The backend configuration files are located in
|
---|
| 211 | <filename class='directory'>/etc/sane.d</filename>. Information
|
---|
| 212 | for configuring the various backends can be found by using the man(5)
|
---|
| 213 | page for the desired backend. Run
|
---|
| 214 | <command>man sane-<replaceable>[backend]</replaceable></command>,
|
---|
| 215 | substituting the desired backend.</para>
|
---|
| 216 |
|
---|
| 217 | </sect4>
|
---|
| 218 |
|
---|
| 219 | <sect4>
|
---|
| 220 | <title>General Information</title>
|
---|
| 221 |
|
---|
| 222 | <para>For general information about configuring and using
|
---|
| 223 | <application>SANE</application>, see <command>man sane</command>.
|
---|
| 224 | Linux-2.6.x brings some special issues into the picture. See
|
---|
| 225 | <ulink url="http://www.sane-project.org/README.linux"/> for
|
---|
| 226 | information about using <application>SANE</application> with the
|
---|
| 227 | Linux-2.6.x kernel. For information about USB scanning devices,
|
---|
| 228 | run <command>man sane-usb</command>. For information about SCSI
|
---|
| 229 | devices, run <command>man sane-scsi</command>.</para>
|
---|
| 230 |
|
---|
| 231 | </sect4>
|
---|
| 232 |
|
---|
| 233 | <sect4>
|
---|
| 234 | <title>Configuration and setup of the 'saned' daemon</title>
|
---|
| 235 |
|
---|
| 236 | <para>The <command>saned</command> daemon is not meant to be used for
|
---|
| 237 | untrusted clients. You should provide <xref linkend="tcpwrappers"/>
|
---|
| 238 | and/or <xref linkend="fw-firewall"/> protection to insure only trusted
|
---|
| 239 | clients access the daemon. Due to the complex security requirements to
|
---|
| 240 | insure only trusted clients access the daemon, BLFS does not provide
|
---|
| 241 | instructions to configure the <command>saned</command> daemon. If you
|
---|
| 242 | desire to make the daemon available, ensure you provide adequate
|
---|
| 243 | security, configure your <filename>[x]inetd.conf</filename> file and
|
---|
| 244 | send a <userinput>SIGHUP</userinput> to the [x]inetd daemon. Some good
|
---|
| 245 | information for setting up and securing the <command>saned</command>
|
---|
| 246 | daemon can be found at
|
---|
| 247 | <ulink url="http://penguin-breeder.org/sane/saned/"/>.</para>
|
---|
| 248 |
|
---|
| 249 | </sect4>
|
---|
| 250 |
|
---|
| 251 | </sect3>
|
---|
| 252 |
|
---|
| 253 | </sect2>
|
---|
| 254 |
|
---|
| 255 | <sect2 role="content">
|
---|
| 256 | <title>Contents</title>
|
---|
| 257 |
|
---|
| 258 | <bridgehead renderas="sect4">Back Ends:</bridgehead>
|
---|
| 259 | <segmentedlist>
|
---|
| 260 | <segtitle>Installed Programs</segtitle>
|
---|
| 261 | <segtitle>Installed Libraries</segtitle>
|
---|
| 262 | <segtitle>Installed Directories</segtitle>
|
---|
| 263 |
|
---|
| 264 | <seglistitem>
|
---|
| 265 | <seg>gamma4scanimage, sane-config, saned, sane-find-scanner,
|
---|
| 266 | and scanimage</seg>
|
---|
| 267 | <seg>libsane.so and numerous scanner backend modules</seg>
|
---|
| 268 | <seg>/etc/sane.d, /usr/include/sane, /usr/lib/sane, /usr/share/sane, and
|
---|
| 269 | /usr/share/doc/sane-&sane-version;</seg>
|
---|
| 270 | </seglistitem>
|
---|
| 271 | </segmentedlist>
|
---|
| 272 |
|
---|
| 273 | <bridgehead renderas="sect4">Front Ends:</bridgehead>
|
---|
| 274 | <segmentedlist>
|
---|
| 275 | <segtitle>Installed Programs</segtitle>
|
---|
| 276 | <segtitle>Installed Library</segtitle>
|
---|
| 277 | <segtitle>Installed Directory</segtitle>
|
---|
| 278 |
|
---|
| 279 | <seglistitem>
|
---|
| 280 | <seg>scanadf, xcam, and xscanimage</seg>
|
---|
[6f19a68e] | 281 | <seg><application>GIMP</application> plugin embedded in
|
---|
[2096355] | 282 | <command>xscanimage</command></seg>
|
---|
| 283 | <seg>/usr/share/sane</seg>
|
---|
| 284 | </seglistitem>
|
---|
| 285 | </segmentedlist>
|
---|
| 286 |
|
---|
| 287 | <variablelist>
|
---|
| 288 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 289 | <?dbfo list-presentation="list"?>
|
---|
| 290 | <?dbhtml list-presentation="table"?>
|
---|
| 291 |
|
---|
| 292 | <varlistentry id="gamma4scanimage">
|
---|
| 293 | <term><command>gamma4scanimage</command></term>
|
---|
| 294 | <listitem>
|
---|
| 295 | <para>creates a gamma table in the format expected by
|
---|
| 296 | <command>scanimage</command>.</para>
|
---|
| 297 | <indexterm zone="sane gamma4scanimage">
|
---|
| 298 | <primary sortas="b-gamma4scanimage">gamma4scanimage</primary>
|
---|
| 299 | </indexterm>
|
---|
| 300 | </listitem>
|
---|
| 301 | </varlistentry>
|
---|
| 302 |
|
---|
| 303 | <varlistentry id="sane-config-prog">
|
---|
| 304 | <term><command>sane-config</command></term>
|
---|
| 305 | <listitem>
|
---|
| 306 | <para>is a tool used to determine the compiler and linker
|
---|
| 307 | flags that should be used to compile and link
|
---|
| 308 | <application>SANE</application>.</para>
|
---|
| 309 | <indexterm zone="sane sane-config-prog">
|
---|
| 310 | <primary sortas="b-sane-config">sane-config</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 |
|
---|
| 315 | <varlistentry id="saned">
|
---|
| 316 | <term><command>saned</command></term>
|
---|
| 317 | <listitem>
|
---|
| 318 | <para>is the <application>SANE</application> daemon that
|
---|
| 319 | allows remote clients to access image acquisition devices
|
---|
| 320 | available on the local host.</para>
|
---|
| 321 | <indexterm zone="sane saned">
|
---|
| 322 | <primary sortas="b-saned">saned</primary>
|
---|
| 323 | </indexterm>
|
---|
| 324 | </listitem>
|
---|
| 325 | </varlistentry>
|
---|
| 326 |
|
---|
| 327 | <varlistentry id="sane-find-scanner">
|
---|
| 328 | <term><command>sane-find-scanner</command></term>
|
---|
| 329 | <listitem>
|
---|
| 330 | <para>is a command-line tool to find SCSI and
|
---|
| 331 | USB scanners and determine their device files. Its primary
|
---|
| 332 | aim is to make sure that scanners can be detected by
|
---|
| 333 | <application>SANE</application> backends.</para>
|
---|
| 334 | <indexterm zone="sane sane-find-scanner">
|
---|
| 335 | <primary sortas="b-sane-find-scanner">sane-find-scanner</primary>
|
---|
| 336 | </indexterm>
|
---|
| 337 | </listitem>
|
---|
| 338 | </varlistentry>
|
---|
| 339 |
|
---|
| 340 | <varlistentry id="scanadf">
|
---|
| 341 | <term><command>scanadf</command></term>
|
---|
| 342 | <listitem>
|
---|
| 343 | <para>is a command-line interface to control image acquisition
|
---|
| 344 | devices which are equipped with an automatic document feeder
|
---|
| 345 | (ADF).</para>
|
---|
| 346 | <indexterm zone="sane scanadf">
|
---|
| 347 | <primary sortas="b-scanadf">scanadf</primary>
|
---|
| 348 | </indexterm>
|
---|
| 349 | </listitem>
|
---|
| 350 | </varlistentry>
|
---|
| 351 |
|
---|
| 352 | <varlistentry id="scanimage">
|
---|
| 353 | <term><command>scanimage</command></term>
|
---|
| 354 | <listitem>
|
---|
| 355 | <para>is a command line interface for scanning from image acquisition
|
---|
| 356 | devices such as flatbed scanners or cameras. It is also used to list
|
---|
| 357 | the available backend devices.</para>
|
---|
| 358 | <indexterm zone="sane scanimage">
|
---|
| 359 | <primary sortas="b-scanimage">scanimage</primary>
|
---|
| 360 | </indexterm>
|
---|
| 361 | </listitem>
|
---|
| 362 | </varlistentry>
|
---|
| 363 |
|
---|
| 364 | <varlistentry id="xcam">
|
---|
| 365 | <term><command>xcam</command></term>
|
---|
| 366 | <listitem>
|
---|
| 367 | <para>is a graphical camera front end for
|
---|
| 368 | <application>SANE</application>.</para>
|
---|
| 369 | <indexterm zone="sane xcam">
|
---|
| 370 | <primary sortas="b-xcam">xcam</primary>
|
---|
| 371 | </indexterm>
|
---|
| 372 | </listitem>
|
---|
| 373 | </varlistentry>
|
---|
| 374 |
|
---|
| 375 | <varlistentry id="xscanimage">
|
---|
| 376 | <term><command>xscanimage</command></term>
|
---|
| 377 | <listitem>
|
---|
| 378 | <para>is a graphical user interface for scanning.</para>
|
---|
| 379 | <indexterm zone="sane xscanimage">
|
---|
| 380 | <primary sortas="b-xscanimage">xscanimage</primary>
|
---|
| 381 | </indexterm>
|
---|
| 382 | </listitem>
|
---|
| 383 | </varlistentry>
|
---|
| 384 |
|
---|
| 385 | <varlistentry id="libsane">
|
---|
| 386 | <term><filename class='libraryfile'>libsane.so</filename></term>
|
---|
| 387 | <listitem>
|
---|
| 388 | <para>is the application programming interface that is used to
|
---|
| 389 | communicate between frontends and backends.</para>
|
---|
| 390 | <indexterm zone="sane libsane">
|
---|
| 391 | <primary sortas="c-libsane">libsane.so</primary>
|
---|
| 392 | </indexterm>
|
---|
| 393 | </listitem>
|
---|
| 394 | </varlistentry>
|
---|
| 395 |
|
---|
| 396 | <varlistentry id="libsane-module">
|
---|
| 397 | <term><filename class='libraryfile'>libsane-*.so</filename></term>
|
---|
| 398 | <listitem>
|
---|
| 399 | <para>modules are backend scanning library plugins used to interface
|
---|
| 400 | with scanning devices. See
|
---|
| 401 | <ulink url="http://www.sane-project.org/sane-supported-devices.html"/>
|
---|
| 402 | for a list of supported backends.</para>
|
---|
| 403 | <indexterm zone="sane libsane-module">
|
---|
| 404 | <primary sortas="c-libsane-module">libsane-*.so</primary>
|
---|
| 405 | </indexterm>
|
---|
| 406 | </listitem>
|
---|
| 407 | </varlistentry>
|
---|
| 408 |
|
---|
| 409 | </variablelist>
|
---|
| 410 |
|
---|
| 411 | </sect2>
|
---|
[f051506c] | 412 |
|
---|
[7008de1] | 413 | </sect1>
|
---|