source: general/graphlib/poppler.xml@ 5474306

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

  <!ENTITY poppler-download-http "http://poppler.freedesktop.org/poppler-&poppler-version;.tar.gz">
  <!ENTITY poppler-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/poppler-&poppler-version;.tar.gz">
  <!ENTITY poppler-md5sum        "beb1eea135a3c5b679a7a22d01a500c0">
  <!ENTITY poppler-size          "777 KB">
  <!ENTITY poppler-buildsize     "35.0 MB">
  <!ENTITY poppler-time          "0.8 SBU">
]>

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

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

  <title>Poppler-&poppler-version;</title>

  <indexterm zone="poppler">
    <primary sortas="a-Poppler">Poppler</primary>
  </indexterm>

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

    <para>The <application>Poppler</application> package contains a PDF
    rendering library. This is useful for providing PDF rendering
    functionality as a shared library.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="pkgconfig"/>,
    <xref linkend="libjpeg"/>,
    <xref linkend="fontconfig"/>,
    <xref linkend="cairo"/>,
    <xref linkend="gtk2"/>,
    <xref linkend="qt"/> and
    <ulink url="http://www.trolltech.com/download/opensource.html">Qt-4.x.x</ulink></para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --enable-opi \
            --disable-splash-output \
            --disable-cairo-output \
            --disable-poppler-glib --disable-gtk-test &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 install &amp;&amp;
install -v -m644 -D README /usr/share/doc/poppler-&poppler-version;/README</userinput></screen>

  </sect2>

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

    <para><parameter>--enable-opi</parameter>: This parameter forces the build
    to include support for OPI comments.</para>

    <para><parameter>--disable-splash-output</parameter>: This parameter
    disables building the Splash graphics backend. Remove this parameter if
    you have <application>Fontconfig</application> installed.</para>

    <para><parameter>--disable-cairo-output</parameter>: This parameter
    disables building the <application>cairo</application> graphics backend.
    Remove this parameter if you have <application>cairo</application>
    installed.</para>

    <para><parameter>--disable-poppler-glib</parameter> and
    <parameter>--disable-gtk-test</parameter>: These parameters disable
    building the <application>GLib</application> wrapper and
    <application>GTK+</application> test program. Remove these parameters if
    you have <application>GTK+</application>-2 installed. Note that if you
    plan on building <application>Evince</application>, you must build the
    <application>GLib</application> wrapper.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Poppler</title>

    <sect3 id="poppler-config">
      <title>Config Files</title>
      <para><filename>/etc/xpdfrc</filename></para>

      <indexterm zone="poppler poppler-config">
        <primary sortas="e-etc-xpdfrc">/etc/xpdfrc</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>

      <para>No specific configuration is required.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libpoppler.[so,a], libpoppler-glib.[so,a],
        libpoppler-qt.[so,a] and libpoppler-qt4.[so,a]</seg>
        <seg>/usr/include/poppler and
        /usr/share/doc/poppler-&poppler-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libpoppler">
        <term><filename class='libraryfile'>libpoppler.[so,a]</filename></term>
        <listitem>
          <para>contains the API functions to render PDF files.</para>
          <indexterm zone="poppler libpoppler">
            <primary sortas="c-libpoppler">libpoppler.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpoppler-glib">
        <term><filename class='libraryfile'>libpoppler-glib.[so,a]</filename></term>
        <listitem>
          <para>is a wrapper library used to interface the PDF rendering
          functions with <application>GTK+</application>.</para>
          <indexterm zone="poppler libpoppler-glib">
            <primary sortas="c-libpoppler-glib">libpoppler-glib.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpoppler-qt">
        <term><filename class='libraryfile'>libpoppler-qt.[so,a]</filename></term>
        <listitem>
          <para>is a wrapper library used to interface the PDF rendering
          functions with <application>Qt</application>.</para>
          <indexterm zone="poppler libpoppler-qt">
            <primary sortas="c-libpoppler-qt">libpoppler-qt.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpoppler-qt4">
        <term><filename class='libraryfile'>libpoppler-qt4.[so,a]</filename></term>
        <listitem>
          <para>is a wrapper library used to interface the PDF rendering
          functions with <application>Qt</application>-4.</para>
          <indexterm zone="poppler libpoppler-qt4">
            <primary sortas="c-libpoppler-qt4">libpoppler-qt4.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>