source: general/graphlib/poppler.xml@ f72b76dd

<?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 poppler-download-http "http://poppler.freedesktop.org/poppler-&poppler-version;.tar.gz">
  <!ENTITY poppler-download-ftp  " ">
  <!ENTITY poppler-md5sum        "053fdfd70533ecce1a06353fa945f061">
  <!ENTITY poppler-size          "1.0 MB">
  <!ENTITY poppler-buildsize     "49 MB (additional 15 MB to install the encoding data package)">
  <!ENTITY poppler-time          "1.0 SBU (includes building with all dependencies)">

  <!ENTITY poppler-data-version  "0.1">
]>

<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 and command line tools used to manipulate PDF files.
    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">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/poppler-&poppler-version;-security_fixes-1.patch"/></para>
      </listitem>
      <listitem>
        <para>Poppler Encoding Data: <ulink
        url="http://poppler.freedesktop.org/poppler-data-&poppler-data-version;.tar.gz"/></para>
      </listitem>
    </itemizedlist>

    <para>The additional package consists of encoding files for use with
    Poppler. The encoding files are optional and poppler will automatically
    read them if they are present. When installed, they enable Poppler to
    render CJK and Cyrillic properly.</para>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="pkgconfig"/> and
    <xref linkend="fontconfig"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libjpeg"/>,
    <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>

    <para>If you're installing <application>Poppler</application> to support
    <xref linkend="kdegraphics"/>, you will need to have <xref linkend="qt"/>
    installed so that the <filename class='libraryfile'>libpoppler-qt</filename>
    library is built.</para>

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

  </sect2>

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

    <caution>
      <para><application>Poppler</application> will overwrite command-line
      utilities and man pages previously installed by the
      <application>Xpdf</application> package. If you prefer to keep the
      <application>Xpdf</application> versions of these files, pass the
      <option>--disable-utils</option> parameter to the
      <command>configure</command> command below.</para>
    </caution>

    <para>The <command>configure</command> command below includes three
    parameters which disable various rendering back-ends. Ensure you remove
    any of the parameters for which you have the corresponding dependency
    installed. Install <application>Poppler</application> by running the
    following commands:</para>

<screen><userinput>patch -Np1 -i ../poppler-&poppler-version;-security_fixes-1.patch &amp;&amp;
./configure --prefix=/usr \
            --sysconfdir=/etc \
            --enable-zlib \
            --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 -m755 -d      /usr/share/doc/poppler-&poppler-version; &amp;&amp;
install -v -m644 README* /usr/share/doc/poppler-&poppler-version;</userinput></screen>

    <para>If you downloaded the additional encoding data package, install
    it by issuing the following command after unpacking the tarball and
    changing into the newly-created package source directory (as the
    <systemitem class="username">root</systemitem> user):</para>

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

  </sect2>

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

    <para><parameter>--enable-zlib</parameter>: This parameter forces the build
    to link with the system-installed
    <filename class='libraryfile'>libz</filename> library to enable compressed
    PDF functionality.</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 <xref linkend="evince"/>, 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>

  </sect2>

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

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

      <seglistitem>
        <seg><xref linkend="xpdf-content"/></seg>
        <seg>libpoppler.{so,a}, libpoppler-glib.{so,a},
        libpoppler-qt.{so,a} and libpoppler-qt4.{so,a}</seg>
        <seg>/usr/include/poppler,
        /usr/share/doc/poppler-&poppler-version;,
        /usr/share/gtk-doc/html/poppler and
        /usr/share/poppler</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>