source: pst/printing/libppd.xml@ 23dd524

<?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 libppd-download-http
  "https://github.com/OpenPrinting/libppd/releases/download/&libppd-version;/libppd-&libppd-version;.tar.xz">
  <!ENTITY libppd-download-ftp  " ">
  <!ENTITY libppd-md5sum        "ab889cbcdaa23689d9a425769f208da9">
  <!ENTITY libppd-size          "567 KB">
  <!ENTITY libppd-buildsize     "13 MB (with tests)">
  <!ENTITY libppd-time          "less than 0.1 SBU (Using parallelism=4; with tests)">
]>

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


  <title>libppd-&libppd-version;</title>

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

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

    <para>
      The <application>libppd</application> library contains
      functions for handling legacy printers using PPD description files.
    </para>

    &lfs122_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/libppd-&libppd-version;-upstream_fixes-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

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

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

  </sect2>

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

    <para>
      First, fix a security vulnerability that could allow for remote code
      execution:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../libppd-&libppd-version;-upstream_fixes-1.patch</userinput></screen>

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

<screen><userinput>./configure --prefix=/usr                   \
            --disable-static                \
            --with-cups-rundir=/run/cups    \
            --enable-ppdc-utils             \
            --docdir=/usr/share/doc/libppd-&libppd-version; &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, 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>

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

    <para>
      <parameter>--with-cups-rundir=/run/cups</parameter>:
      Defines the directory containing transient printing data. The default
      <filename class="directory">/var/run/cups</filename> is obsolete.
    </para>

    <para>
      <parameter>--enable-ppdc-utils</parameter>:
      Allows building utilities to manipulate <emphasis>.ppd</emphasis> files.
      <!-- This is not required until cups v3 is out, since those utilities
      are also installed by cups v2. But since cups v3 should be out before
      our next release, I put it here. Pierre -->
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          ppdc,
          ppdhtml,
          ppdi,
          ppdmerge, and
          ppdpo
        </seg>
        <seg>
          libppd.so
        </seg>
        <seg>
          /usr/include/ppd,
          /usr/share/ppdc, and
          /usr/share/doc/libppd-&libppd-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libppd-ppdc">
        <term><command>ppdc</command></term>
        <listitem>
          <para>
            compiles PPDC source files into one or more PPD files
          </para>
          <indexterm zone="libppd libppd-ppdc">
            <primary sortas="b-ppdc">ppdc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libppd-ppdhtml">
        <term><command>ppdhtml</command></term>
        <listitem>
          <para>
            reads a driver information file and produces a HTML summary
            page that lists all of the drivers in a file and the
            supported options
          </para>
          <indexterm zone="libppd libppd-ppdhtml">
            <primary sortas="b-ppdhtml">ppdhtml</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libppd-ppdi">
        <term><command>ppdi</command></term>
        <listitem>
          <para>
            imports one or more PPD files into a PPD compiler source file
          </para>
          <indexterm zone="libppd libppd-ppdi">
            <primary sortas="b-ppdi">ppdi</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libppd-ppdmerge">
        <term><command>ppdmerge</command></term>
        <listitem>
          <para>
            merges two or more PPD files into a single, multi-language
            PPD file
          </para>
          <indexterm zone="libppd libppd-ppdmerge">
            <primary sortas="b-ppdmerge">ppdmerge</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libppd-ppdpo">
        <term><command>ppdpo</command></term>
        <listitem>
          <para>
            extracts UI strings from PPDC source files and
            updates either a GNU gettext or Mac OS X strings
            format message catalog source file for translation
          </para>
          <indexterm zone="libppd libppd-ppdpo">
            <primary sortas="b-ppdpo">ppdpo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libppd-lib">
        <term><filename class="libraryfile">libppd.so</filename></term>
        <listitem>
          <para>
            contains API functions for manipulating <emphasis>.ppd</emphasis>
            files
          </para>
          <indexterm zone="libppd libppd-lib">
            <primary sortas="c-libppd">libppd.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>