source: general/genlib/mowgli.xml@ 4662286

<?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 libmowgli-download-http "http://distfiles.atheme.org/libmowgli-&libmowgli-version;.tar.bz">
<!ENTITY libmowgli-download-ftp " ">
<!ENTITY libmowgli-md5sum "9833b5845e60fe965924be4a15a30374">
<!ENTITY libmowgli-size "103 KB">
<!ENTITY libmowgli-buildsize "1.9 MB">
<!ENTITY libmowgli-time "less than 0.1 SBU">
]>

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

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

  <title>libmowgli-&libmowgli-version;</title>

  <indexterm zone="libmowgli">
    <primary sortas="a-libmowgli">Libmowgli</primary>
  </indexterm>

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

    <para>The <application>libmowgli</application> package contains a
    development framework for C, similar to <xref linkend="glib2"/>. It
    provides high performance and highly flexible algorithms for routine
    tasks such as reference-counting, linked lists and spinlocks, and thus
    helps programmers write better engineered code.</para>

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

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

  </sect2>

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

    <para>The libmowgli build system outputs text in color while running make.
    This is fine if you're running these commands in a terminal. However, if
    you're installing libmowgli with a script and piping the output to a log
    file it will add control characters to the file which may make the file
    unreadable. If you wish, you can disable the colored text control characters
    with this sed:</para>

<screen><userinput>sed -i 's/\\033\[\([01];3.m\|0m\|K\)//g' buildsys.mk.in</userinput></screen>

    <para>Install <application>libmowgli</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 formal 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 Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libmowgli.so</seg>
        <seg>/usr/include/libmowgli</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libmowgli.so">
        <term><filename class='libraryfile'>libmowgli.so</filename></term>
        <listitem>
          <para>libraries contain optimized functions for various common
          C programming tasks.</para>
          <indexterm zone="libmowgli">
            <primary sortas="c-libmowgli">libmowgli.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>