source: general/genlib/ptlib.xml@ f3429309

<?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 ptlib-download-http "&gnome-download-http;/ptlib/2.10/ptlib-&ptlib-version;.tar.xz">
  <!ENTITY ptlib-download-ftp  "&gnome-download-ftp;/ptlib/2.10/ptlib-&ptlib-version;.tar.xz">
  <!ENTITY ptlib-md5sum        "3ffdf89170dbfa6d29a015ef8741a4e4">
  <!ENTITY ptlib-size          "2.4 MB">
  <!ENTITY ptlib-buildsize     "81 MB">
  <!ENTITY ptlib-time          "0.9 SBU">
]>

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

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

  <title>Ptlib-&ptlib-version;</title>

  <indexterm zone="ptlib">
    <primary sortas="a-Ptlib">Ptlib</primary>
  </indexterm>

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

    <para>
      The <application>Ptlib</application> (Portable Tools Library) package
      contains a class library that has its genesis many years ago as PWLib
      (portable Windows Library), a method to produce applications to run on
      various platforms.
    </para>

    &lfs78_checked;

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

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/> and
      <xref linkend="openssl"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="cyrus-sasl"/>,
      <xref linkend="lua"/>,
      <xref linkend="openldap"/>,
      <xref linkend="pulseaudio"/>,
      <xref linkend="sdl"/>,
      <xref linkend="unixodbc"/>,
      <xref linkend="v4l-utils"/>,
      <ulink url="http://sourceforge.net/projects/libdc1394/">libdc1394</ulink>, and
      <ulink url="http://www.linux1394.org/">libraw1394</ulink>,
    </para>

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

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

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

<screen><userinput>patch -Np1 -i ../ptlib-&ptlib-version;-bison_fixes-1.patch &amp;&amp;

./configure --prefix=/usr &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;
chmod -v 755 /usr/lib/libpt.so.&ptlib-version;</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          ptlib-config
        </seg>
        <seg>
          libpt.so and libpt_s.a
        </seg>
        <seg>
          /usr/include/ptclib,
          /usr/include/ptlib,
          /usr/lib/ptlib-&ptlib-version;, and
          /usr/share/ptlib
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ptlib-config">
        <term><command>ptlib-config</command></term>
        <listitem>
          <para>
            determines the compile and linker flags that should be used to
            compile and link programs that use <filename class="libraryfile">libpt</filename>.
          </para>
          <indexterm zone="ptlib ptlib-config">
            <primary sortas="b-ptlib-config">ptlib-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>