source: pst/scanning/xsane.xml@ 55e56644

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY xsane-download-http "&sources-anduin-http;/xsane/xsane-&xsane-version;.tar.gz">
  <!ENTITY xsane-download-ftp  "&sources-anduin-ftp;/xsane/xsane-&xsane-version;.tar.gz">
  <!ENTITY xsane-md5sum        "9927f21e1ab6ba96315e7f0e30746deb">
  <!ENTITY xsane-size          "2.9 MB">
  <!ENTITY xsane-buildsize     "23 MB">
  <!ENTITY xsane-time          "0.2 SBU">
]>

<sect1 id="xsane" xreflabel="XSane-&xsane-version;">
  <?dbhtml filename="xsane.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>XSane-&xsane-version;</title>

  <indexterm zone="xsane">
    <primary sortas="a-XSane">XSane</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to XSane</title>

    <para><application>XSane</application> is another front end for
    <xref linkend="sane"/>. It has additional features to improve the image
    quality and ease of use compared to <command>xscanimage</command>.</para>

    &lfs83_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&xsane-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&xsane-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &xsane-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &xsane-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &xsane-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &xsane-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">XSane Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk2"/> and
      <xref linkend="sane"/> (back ends)
    </para>
<!--
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="xdg-utils"/> (for the help documentation at runtime)
    </para>-->

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="lcms"/> and
      <xref linkend="gimp"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/xsane"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of XSane</title>

    <para>Install <application>XSane</application> by running the following
    commands:</para>

<!--sed -i -e 's/netscape/xdg-open/'                   src/xsane.h      &amp;&amp;-->
<screen><userinput>sed -i -e 's/png_ptr->jmpbuf/png_jmpbuf(png_ptr)/' src/xsane-save.c &amp;&amp;
./configure --prefix=/usr                                           &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make xsanedocdir=/usr/share/doc/xsane-&xsane-version; install &amp;&amp;
ln -v -s ../../doc/xsane-&xsane-version; /usr/share/sane/xsane/doc</userinput></screen>
<!--
    <para>If you have not installed <xref linkend="xdg-utils"/> and have not
    issued the first sed:</para>-->
    <para>A browser of your choice can be used to get inline help, using the
    following command,  as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>ln -v -s &lt;browser&gt; /usr/bin/netscape</userinput></screen>

    <note><para>Be sure to replace &lt;browser&gt; with the browser of your
    choice on your system.</para></note>

    <para>Alternatively, if the environment variable BROWSER is set to the
    browser you want to use, eg, BROWSER="/usr/bin/firefox", the first time you
    run <command>xsane</command>, it will be recorded in ~/.sane/xsane/xsane.rc.
    If you wish to change it, edit this file, or remove it, and use the
    instructions above, so that a new one is created.</para>

    <para>If <application>GIMP</application> is installed, issue the following
    command as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>ln -v -s /usr/bin/xsane /usr/lib/gimp/2.0/plug-ins/</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>
<!--
    <para><command>sed -i -e 's/netscape/xdg-open/' src/xsane.h </command>:
    This is to use <command>xdg-open</command> for the help documentation,
    instead of the hardcoded browser.</para>-->

    <para><command>ln -v -s ../../doc/xsane-&xsane-version;
    /usr/share/sane/xsane/doc</command>: This symlink is created to ensure that
    any program that looks for the <application>XSane</application>
    documentation in the default location will find it, as the documentation
    is installed in an alternate location specified in the
    <command>make install</command> command.</para>

    <para><command>ln -v -s /usr/bin/xsane /usr/lib/gimp/2.0/plug-ins/</command>:
    This creates a link in the system-wide <application>GIMP</application>
    <filename class='directory'>plug-ins</filename> directory so that users can
    access <application>XSane</application> directly from
    <application>GIMP</application>. <application>GIMP</application> must be
    available before building <application>XSane</application> for this to work.
    Alternatively, create the link in <filename
    class='directory'>~/.gimp-2.0/plug-ins/</filename> to provide individual
    user access. <command>man xsane</command> for additional information.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>xsane</seg>
        <seg>None</seg>
        <seg>/usr/share/doc/xsane-&xsane-version; and
        /usr/share/sane/xsane</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="xsane-prog">
        <term><command>xsane</command></term>
        <listitem>
          <para>is a graphical user-interface to control an image acquisition
          device such as a flatbed scanner.</para>
          <indexterm zone="xsane xsane-prog">
            <primary sortas="b-xsane">xsane</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>