source: general/genutils/compface.xml@ 82b70873

<?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 compface-download-http "http://ftp.xemacs.org/pub/xemacs/aux/compface-&compface-version;.tar.gz">
  <!ENTITY compface-download-ftp " ">
  <!ENTITY compface-md5sum "62f4f79c0861ad292ba3cf77b4c48319">
  <!ENTITY compface-size "47 KB">
  <!ENTITY compface-buildsize "520 KB">
  <!ENTITY compface-time "Less than 0.1 SBU">
]>

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

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

  <title>Compface-&compface-version;</title>

  <indexterm zone="compface">
    <primary sortas="a-Compface">Compface</primary>
  </indexterm>

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

    <para><application>Compface</application> provides utilities and a library to
    convert from/to X-Face format, a 48x48 bitmap format used to carry thumbnails
    of email authors in a mail header.</para>

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

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

  </sect2>

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

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

<screen><userinput>./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;
install -m755 -v xbm2xface.pl /usr/bin</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>compface, uncompface and xbm2xface.pl</seg>
        <seg>libcompface.{so,a}</seg>
        <seg>None</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="compface-prog">
        <term><command>compface</command></term>
        <listitem>
          <para>is a filter for generating highly compressed representations
          of 48x48x1 face image files.</para>
          <indexterm zone="compface compface-prog">
            <primary sortas="b-compface">compface</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="uncompface">
        <term><command>uncompface</command></term>
        <listitem>
          <para>is an inverse filter which performs an inverse
          transformation with no loss of data.</para>
          <indexterm zone="compface uncompface">
            <primary sortas="b-uncompface">uncompface</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xbm2xface">
        <term><command>xbm2xface.pl</command></term>
        <listitem>
          <para>is a script to generate xfaces.</para>
          <indexterm zone="compface xbm2xface">
            <primary sortas="b-xbm2xface.pl">xbm2xface.pl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcompface">
        <term><filename class='libraryfile'>libcompface.{so,a}</filename></term>
        <listitem>
          <para>allows the compression and decompression algorithms to be
          used in other programs such as MTAs.</para>
          <indexterm zone="compface libcompface">
            <primary sortas="c-libcompface">libcompface.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>