source: general/prog/scour.xml@ 059a6e02

<?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 scour-download-http "https://github.com/scour-project/scour/archive/v&scour-version;/scour-&scour-version;.tar.gz">
  <!ENTITY scour-download-ftp  " ">
  <!ENTITY scour-md5sum        "1de595a0b1627d47b01b4e5fa2976087">
  <!ENTITY scour-size          "96 KB">
  <!ENTITY scour-buildsize     "1.3 MB">
  <!ENTITY scour-time          "less than 0.1 SBU">
]>

  <!-- Begin scour -->
  <sect2 id="scour" xreflabel="Scour-&scour-version;">

    <title>Scour-&scour-version;</title>

    <indexterm zone="scour">
      <primary sortas="a-scour">scour</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Scour</title>

      <para>
        <application>Scour</application> is an SVG (Scalable Vector Graphics)
        optimizer/cleaner that reduces their size by optimizing structure and
        removing unnecessary data.
      </para>

      &lfs83_checked;

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

      <bridgehead renderas="sect4">Scour Dependencies</bridgehead>

      <!-- Required: only setuptools, which is available from our Python and
      Python3 installs via pypi (it has a recursive dependency) -->

      <bridgehead renderas="sect5">Recommended</bridgehead>
      <para role="recommended">
        <xref linkend="python2"/>
      </para>

      <note>
        <para>
          The only use of Scour in this book is by applications which
          require Python2.
        </para>
      </note>

      <bridgehead renderas="sect5">Optional (for the main test)</bridgehead>
      <para role="optional">
        <xref linkend="six"/>
      </para>

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

    <sect3 role="installation">
      <title>Installation of scour</title>

      <note>
        <para>
          Although this package installs modules for <application>Python
          2</application> <emphasis>or</emphasis> <application>Python
          3</application> they are usually invoked by <command>scour</command>
          which is a script using the version of
          <application>Python</application> for which it was compiled.
        </para>

        <para>
          For the moment, use of <application>Python 2</application> will
          normally be adequate.
        </para>
      </note>

<!-- Editors note: Use \-\-root= instead of DESTDIR= when updating. -->

      <para>
        To build the <application>Python 2</application> module, issue:
      </para>

<screen><userinput>python setup.py build</userinput></screen>

      <para>
        To partially test the results, issue: <command>python testcss.py</command>.
        If you have installed <application>Six</application> you can run the main
        tests by issuing: <command>python testscour.py</command>.
      </para>

      <para>
        To install the <application>Python 2</application> module
        run the following command as the
        <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>python setup.py install --optimize=1</userinput></screen>

      <note>
        <para>
          If you wish to install the <application>Python 3</application>
          modules, change 'python' to 'python3' in each of the above steps.
        </para>
      </note>

    </sect3>

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

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <segtitle>Installed Libraries</segtitle>
        <segtitle>Installed Directories</segtitle>

        <seglistitem>
          <seg>
            scour
          </seg>
          <seg>
            None
          </seg>
          <seg>
            None
          </seg>
        </seglistitem>
      </segmentedlist>

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

      <varlistentry id="scour-prog">
        <term><command>scour</command></term>
        <listitem>
          <para>
            is a program to optimize and clean SVG files.
          </para>
          <indexterm zone="scour scour-prog">
            <primary sortas="b-scour">scour</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

    </sect3>

  </sect2>
  <!--End scour -->