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