source: general/graphlib/fontconfig.xml@ ac567be

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY fontconfig-download-http "http://fontconfig.org/release/fontconfig-&fontconfig-version;.tar.gz">
  <!ENTITY fontconfig-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/fontconfig-&fontconfig-version;.tar.gz">
  <!ENTITY fontconfig-md5sum        "7354f9f125ea78a8f2851cb9c31d4866">
  <!ENTITY fontconfig-size          "942 KB">
  <!ENTITY fontconfig-buildsize     "13.0 MB">
  <!ENTITY fontconfig-time          "0.2 SBU">
]>

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

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

  <title>Fontconfig-&fontconfig-version;</title>

  <indexterm zone="fontconfig">
    <primary sortas="a-Fontconfig">Fontconfig</primary>
  </indexterm>

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

    <para>The <application>Fontconfig</application> package is a library
    for configuring and customizing font access.</para>

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

    <note>
      <para>The numbering system of <application>Fontconfig</application> is
      unusual. The beta versions of the package are numbered with a 9x in the
      last portion of the release number. This means that 2.3.92 is a beta
      release and the most current release is of the form
      &fontconfig-version;</para>
    </note>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para><xref linkend="freetype2"/> and <xref linkend="expat"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="docbook-utils"/></para>

    <note>
      <para>If you have <application>DocBook-utils</application> installed
      and you remove the <parameter>--disable-docs</parameter> parameter from
      the <command>configure</command> command below, you must have
      <xref linkend="perl-sgmlspm"/> and <xref linkend="jadetex"/> installed
      also, or the <application>Fontconfig</application> build will fail.</para>
    </note>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc --disable-docs \
    --with-docdir=/usr/share/doc/fontconfig-&fontconfig-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 &amp;&amp;
install -v -m644 doc/*.3 /usr/share/man/man3 &amp;&amp;
install -v -m644 doc/*.5 /usr/share/man/man5 &amp;&amp;
install -v -m755 \
        -d /usr/share/doc/fontconfig-&fontconfig-version;/fontconfig-devel &amp;&amp;
install -v -m644 doc/*.{html,pdf,txt} \
        /usr/share/doc/fontconfig-&fontconfig-version; &amp;&amp;
install -v -m644 doc/fontconfig-devel/* \
        /usr/share/doc/fontconfig-&fontconfig-version;/fontconfig-devel</userinput></screen>

  </sect2>

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

    <para><parameter>--disable-docs</parameter>: This switch avoids building
    the documentation (the release tarball includes pre-generated
    documentation).</para>

    <para><parameter>--with-docdir=/usr/share/doc/fontconfig-&fontconfig-version;</parameter>:
    Though this parameter seems counter-intuitive following the preceding
    parameter to the <command>configure</command> command, it is used so that
    if the builder removes the <parameter>--disable-docs</parameter> parameter,
    the documentation will be installed in a versioned directory name instead
    of the default
    <filename class='directory'>/usr/share/doc/fontconfig</filename>.</para>

  </sect2>

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

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

      <para><filename>/etc/fonts/* and /etc/fonts/conf.d/*</filename></para>

      <indexterm zone="fontconfig fontconfig-config">
        <primary sortas="e-etc-fonts">/etc/fonts/*</primary>
      </indexterm>

      <indexterm zone="fontconfig fontconfig-config">
        <primary sortas="e-etc-fonts-conf.d">/etc/fonts/conf.d/*</primary>
      </indexterm>

    </sect3>

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

      <para>The configuration file for <application>Fontconfig</application> is
      <filename>/etc/fonts/fonts.conf</filename>. Generally you do not want to
      edit this file. To put a new font directory in the configuration, create
      (or update) the <filename>/etc/fonts/local.conf</filename> file with your
      local information. The default location of fonts in
      <application>Fontconfig</application> is:</para>

      <itemizedlist spacing='compact'>
        <listitem>
          <para>/usr/share/fonts</para>
        </listitem>
        <listitem>
          <para>~/.fonts</para>
        </listitem>
      </itemizedlist>

      <indexterm zone="fontconfig fontconfig-config">
        <primary sortas="g-usr-share-fonts">/usr/share/fonts</primary>
      </indexterm>

      <indexterm zone="fontconfig fontconfig-config">
        <primary sortas="g-AA.fonts">~/.fonts</primary>
      </indexterm>

      <note>
        <para><application>X</application> also includes an internal (and
        older) version of <application>Fontconfig</application> and unless it
        is explicitly disabled when building <application>Xorg</application> or
        <application>XFree86</application>, the internal version is created
        leaving two slightly incompatible libraries on your system. It is
        recommended that you only install one version.</para>
      </note>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>fc-cache, fc-list, and fc-match</seg>
        <seg>libfontconfig.[so,a]</seg>
        <seg>/etc/fonts, /usr/include/fontconfig and
        /usr/share/doc/fontconfig-&fontconfig-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="fc-cache">
        <term><command>fc-cache</command></term>
        <listitem>
          <para>is used to create font information caches.</para>
          <indexterm zone="fontconfig fc-cache">
            <primary sortas="b-fc-cache">fc-cache</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fc-list">
        <term><command>fc-list</command></term>
        <listitem>
          <para>is used to create font lists.</para>
          <indexterm zone="fontconfig fc-list">
            <primary sortas="b-fc-list">fc-list</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="fc-match">
        <term><command>fc-match</command></term>
        <listitem>
          <para>is used to match available fonts, or find fonts that match
          a given pattern.</para>
          <indexterm zone="fontconfig fc-match">
            <primary sortas="b-fc-match">fc-match</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfontconfig">
        <term><filename class='libraryfile'>libfontconfig.[so,a]</filename></term>
        <listitem>
          <para>contains functions used by the
          <application>Fontconfig</application> programs and also by other
          programs to configure or customize font access.</para>
          <indexterm zone="fontconfig libfontconfig">
            <primary sortas="c-libfontconfig">libfontconfig.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>