glfs/general/graphlib/qpdf.xml

<?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 qpdf-download-http "https://github.com/qpdf/qpdf/releases/download/v&qpdf-version;/qpdf-&qpdf-version;.tar.gz">
  <!ENTITY qpdf-download-ftp  " ">
  <!ENTITY qpdf-md5sum        "479befd15a61516ef3b2634f63ec684a">
  <!ENTITY qpdf-size          "18 MB">
  <!ENTITY qpdf-buildsize     "263 MB (add 1 MB for tests)">
  <!ENTITY qpdf-time          "0.5 SBU (using parallelism=4; add 0.5 SBU for tests)">
]>

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


  <title>Qpdf-&qpdf-version;</title>

  <indexterm zone="qpdf">
    <primary sortas="a-Qpdf">Qpdf</primary>
  </indexterm>

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

    <para>
      The <application>Qpdf</application> package contains command-line
      programs and a library that does structural, content-preserving
      transformations on PDF files.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libjpeg"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gs"/>,
      <xref linkend="gnutls"/>,
      <xref linkend="libtiff"/>,
      <xref linkend="sphinx"/> with <xref linkend="sphinx_rtd_theme"/>, and
      <xref linkend="texlive"/> or <xref linkend="tl-installer"/>
    </para>

  </sect2>

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

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_STATIC_LIBS=OFF     \
      -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/qpdf-&qpdf-version; \
      .. &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>ctest</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>

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

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

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

      <seglistitem>
        <seg>
          fix-qdf, qpdf, and zlib-flate
        </seg>
        <seg>
          libqpdf.so
        </seg>
        <seg>
          /usr/lib/cmake/qpdf,
          /usr/include/qpdf, and
          /usr/share/doc/qpdf-&qpdf-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="fix-qdf">
        <term><command>fix-qdf</command></term>
        <listitem>
          <para>
            is used to repair PDF files in QDF form after
            editing
          </para>
          <indexterm zone="qpdf fix-qdf">
            <primary sortas="b-fix-qdf">fix-qdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qpdf-prog">
        <term><command>qpdf</command></term>
        <listitem>
          <para>
            is used to convert one PDF file to another equivalent
            PDF file
          </para>
          <indexterm zone="qpdf qpdf-prog">
            <primary sortas="b-qpdf">qpdf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="zlib-flate">
        <term><command>zlib-flate</command></term>
        <listitem>
          <para>
            is a raw zlib compression program
          </para>
          <indexterm zone="qpdf zlib-flate">
            <primary sortas="b-qpdf">zlib-flate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libqpdf">
        <term><filename class="libraryfile">libqpdf.so</filename></term>
        <listitem>
          <para>
            contains the <application>Qpdf</application> API functions
          </para>
          <indexterm zone="qpdf libqpdf">
            <primary sortas="c-libqpdf">libqpdf.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>