source: x/lib/pango.xml@ 372da32

<?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 pango-download-http "&gnome-download-http;/pango/1.29/pango-&pango-version;.tar.xz">
  <!ENTITY pango-download-ftp "&gnome-download-ftp;/pango/1.29/pango-&pango-version;.tar.xz">
  <!ENTITY pango-md5sum        "9d5aba73897d2e8e8115b3f4fddbc0af">
  <!ENTITY pango-size          "1.1 MB">
  <!ENTITY pango-buildsize     "36 MB">
  <!ENTITY pango-time          "0.4 SBU">
]>

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

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

  <title>Pango-&pango-version;</title>

  <indexterm zone="pango">
    <primary sortas="a-Pango">Pango</primary>
  </indexterm>

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

    <para>The <application>Pango</application> package contains the
    <filename class="libraryfile">libpango</filename> libraries. These are
    useful for the layout and rendering of multilingual text.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="glib2"/> and one of:
    <xref linkend="cairo"/>, <xref linkend="x-window-system"/> or
    <xref linkend="fontconfig"/></para>

    <note>
      <para><application>cairo</application> is not required to build
      <application>Pango</application>, but it is highly recommended that you
      install <application>cairo</application> and the X Window System before
      building    <application>Pango</application>. If you don&apos;t build
      <application>Pango</application> with a <application>cairo</application>
      and <application>libXft</application> backend, then
      <application>GTK+</application>-2 will not build.</para>
    </note>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gobject-introspection"/>,
    <ulink url="http://linux.thai.net/libthai">LibThai</ulink></para>

    <bridgehead renderas="sect4">Optional (To Rebuild the API
    Documentation)</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>. You can
    install <xref linkend="gtk-doc"/> if you wish to test the documentation
    section of the test suite. Also, the <quote>testboundries</quote> test
    could fail if you have <application>LibThai</application> installed.
    </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>

    <para><parameter>--sysconfdir=/etc</parameter>: This switch installs the
    configuration files into <filename class="directory">/etc</filename>
    instead of <filename class="directory">/usr/etc</filename>.</para>

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

    <para><parameter>--disable-static</parameter>: This switch prevents the
    static libraries from being built.</para>

  </sect2>

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

    <sect3 id="pango-config">
      <title>Config Files</title>

      <para><filename>/etc/pango/pangorc</filename>,
      <filename>~/.pangorc</filename>, and the file specified in the
      environment variable <envar>PANGO_RC_FILE</envar></para>

      <indexterm zone="pango pango-config">
        <primary sortas="e-etc-pango-pangorc">/etc/pango/pangorc</primary>
      </indexterm>

      <indexterm zone="pango pango-config">
        <primary sortas="e-AA.pangorc">~/.pangorc</primary>
      </indexterm>

    </sect3>

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

      <para>The <application>Pango</application> module path is specified by
      the key <userinput><parameter>Pango/ModulesPath</parameter></userinput>
      in the <application>Pango</application> config database, which is read
      from the config files listed above.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>pango-querymodules and pango-view</seg>
        <seg>libpango-1.0.so, libpangocairo-1.0.so, libpangoft2-1.0.so,
        libpangox-1.0.so, libpangoxft-1.0.so, pango-arabic-fc.so,
        pango-arabic-lang.so, pango-basic-fc.so, pango-basic-x.so,
        pango-hangul-fc.so, pango-hebrew-fc.so, pango-indic-fc.so,
        pango-indic-lang.so, pango-khmer-fc.so, pango-syriac-fc.so,
        pango-thai-fc.so, and pango-tibetan-fc.so</seg>
        <seg>/etc/pango, /usr/include/pango-1.0 /usr/lib/pango and
        /usr/share/gtk-doc/html/pango</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="pango-querymodules">
        <term><command>pango-querymodules</command></term>
        <listitem>
          <para>is a module registration utility that collects
          information about <application>Pango</application> loadable
          modules.</para>
          <indexterm zone="pango pango-querymodules">
            <primary sortas="b-pango-querymodules">pango-querymodules</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pango-view">
        <term><command>pango-view</command></term>
        <listitem>
          <para>renders a given file through <application>Pango</application>
          for viewing purposes.</para>
          <indexterm zone="pango pango-view">
            <primary sortas="b-pango-view">pango-view</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="Pango-libraries">
        <term><filename class="libraryfile">libpango*-1.0.so</filename></term>
        <listitem>
          <para>contain low level layout rendering routines, a high
          level driver for laying out entire blocks of text, and routines
          to assist in editing internationalized text.</para>
          <indexterm zone="pango Pango-libraries">
            <primary sortas="c-Pango-libraries">libpango*-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>