source: general/graphlib/potrace.xml@ a11c886

<?xml version="1.0" encoding="UTF-8"?>
<!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 potrace-download-http "&sourceforge-dl;/potrace/potrace-&potrace-version;.tar.gz">
  <!ENTITY potrace-download-ftp  " ">
  <!ENTITY potrace-md5sum        "5f0bd87ddd9a620b0c4e65652ef93d69">
  <!ENTITY potrace-size          "644 KB">
  <!ENTITY potrace-buildsize     "7.1 MB (including tests)">
  <!ENTITY potrace-time          "less than 0.1 SBU (including tests)">
]>

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


  <title>Potrace-&potrace-version;</title>

  <indexterm zone="potrace">
    <primary sortas="a-Potrace">Potrace</primary>
  </indexterm>

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

    <para>
      <!-- summarized from the home page, where Potrace(TM) is used -->
      <application>Potrace™</application> is a tool for transforming a bitmap
      (PBM, PGM, PPM, or BMP format) into one of several vector file formats.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="llvm"/> (including <command>clang</command>)
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr                        \
            --disable-static                     \
            --docdir=/usr/share/doc/potrace-&potrace-version; \
            --enable-a4                          \
            --enable-metric                      \
            --with-libpotrace                    &amp;&amp;
make</userinput></screen>

    <para>
      To run the test suite, issue: <command>make check</command>.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--enable-a4</parameter>: Use A4 as the default paper size.
    </para>

    <para>
      <!-- american spelling as in the configure script -->
      <parameter>--enable-metric</parameter>: Use metric units (centimeters)
      as default
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <para>
      <parameter>--with-libpotrace</parameter>: Install the library and headers.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          mkbitmap, potrace
        </seg>
        <seg>
          libpotrace.so
        </seg>
        <seg>
          /usr/share/doc/potrace-&potrace-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="mkbitmap">
        <term><command>mkbitmap</command></term>
        <listitem>
          <para>
            transforms images into bitmaps with scaling and filtering
          </para>
          <indexterm zone="potrace mkbitmap">
            <primary sortas="b-mkbitmap">mkbitmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="potrace-prog">
        <term><command>potrace</command></term>
        <listitem>
          <para>
            transforms bitmaps into vector graphics
          </para>
          <indexterm zone="potrace potrace-prog">
            <primary sortas="b-potrace-prog">potrace</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpotrace">
        <term><filename class="libraryfile">libpotrace.so</filename></term>
        <listitem>
          <para>
            is a library for transforming bitmaps into vector graphics
          </para>
          <indexterm zone="potrace libpotrace">
            <primary sortas="c-libpotrace">libpotrace.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>