source: x/lib/pango.xml@ 2ffe965

<?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.30/pango-&pango-version;.tar.xz">
  <!ENTITY pango-download-ftp  "&gnome-download-ftp;/pango/1.30/pango-&pango-version;.tar.xz">
  <!ENTITY pango-md5sum        "ec3c1f236ee9bd4a982a5f46fcaff7b9">
  <!ENTITY pango-size          "1.2 MB">
  <!ENTITY pango-buildsize     "40 MB">
  <!ENTITY pango-time          "0.5 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>
      <application>Pango</application> is a library for laying out and rendering
      of text, with an emphasis on internationalization. It can be used anywhere
      that text layout is needed, though most of the work on Pango so far has
      been done in the context of the GTK+ widget toolkit.
    </para>

    &lfs71_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, one of:</bridgehead>
    <para role="required">
      <xref linkend="cairo"/>
      <xref linkend="freetype2"/> or
      <xref linkend="xorg7-lib"/>
      (all 3 are required if you intend to install Gtk+)
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="fontconfig"/>
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <ulink url="http://linux.thai.net/libthai">LibThai</ulink>
    </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>

    <note>
      <para>
        If you installed the package on to your system using a
        <quote>DESTDIR</quote> method then important file was not installed and
        must be copied and/or generated. Generate it using the following
        command as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>pango-querymodules > /etc/pango/pango.modules</userinput></screen>
    </note>
  </sect2>

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

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

  </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 and
          libpangoxft-1.0.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>