source: general/graphlib/aalib.xml@ 22ac237

<?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 aalib-download-http "http://prdownloads.sourceforge.net/aa-project/aalib-&aalib-version;.tar.gz">
  <!ENTITY aalib-download-ftp "ftp://ftp.ratmir.tver.ru/pub/FreeBsd/ports/distfiles/aalib-&aalib-version;.tar.gz">
  <!ENTITY aalib-md5sum "9801095c42bba12edebd1902bcf0a990">
  <!ENTITY aalib-size "388 KB">
  <!ENTITY aalib-buildsize "6.5 MB">
  <!ENTITY aalib-time "0.15 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">aalib-&aalib-version;.tar</keyword>
      <keyword role="ftpdir">aalib</keyword>
    </keywordset>
  </sect1info>

  <title>AAlib-&aalib-version;</title>

  <indexterm zone="aalib">
    <primary sortas="a-AAlib">AAlib</primary>
  </indexterm>

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

    <para><application>AAlib</application> is a library to render any graphic into
    ASCII Art.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
    <xref linkend="slang"/> and
    <xref linkend="gpm"/></para>

  </sect2>

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

    <para>Install <application>AAlib</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</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>aafire, aainfo, aalib-config, aasavefont, and aatest</seg>
        <seg>libaa.[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="aafire">
        <term><command>aafire</command></term>
        <listitem>
          <para>is little toy of <application>AAlib</application>, rendering
          an animated fire in ASCII Art.</para>
          <indexterm zone="aalib aafire">
            <primary sortas="b-aafire">aafire</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="aainfo">
        <term><command>aainfo</command></term>
        <listitem>
          <para>provides information for your current settings related to
          <application>AAlib</application>.</para>
          <indexterm zone="aalib aainfo">
            <primary sortas="b-aainfo">aainfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="aalib-config">
        <term><command>aalib-config</command></term>
        <listitem>
          <para>provides configuration info for <application>AAlib</application>.</para>
          <indexterm zone="aalib aalib-config">
            <primary sortas="b-aalib-config">aalib-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="aatest">
        <term><command>aatest</command></term>
        <listitem>
          <para>shows the abilities of <application>AAlib</application>
          in a little test.</para>
          <indexterm zone="aalib aatest">
            <primary sortas="b-aatest">aatest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libaa">
        <term><filename class='libraryfile'>libaa.[so,a]</filename></term>
        <listitem>
          <para>is a collection of routines to render any graphical input in
          portable format to ASCII Art. It can be used through many programs
          and has a very well documented API, so you can easily put it into
          your own programs.</para>
          <indexterm zone="aalib libaa">
            <primary sortas="c-libaa">libaa.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>