source: general/genlib/liboil.xml@ 8fc023d2

<?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 liboil-download-http "http://liboil.freedesktop.org/download/liboil-&liboil-version;.tar.gz">
  <!ENTITY liboil-download-ftp  " ">
  <!ENTITY liboil-md5sum        "febb1d9f9bc4c440fcf622dc90f8b6b7">
  <!ENTITY liboil-size          "836 KB">
  <!ENTITY liboil-buildsize     "29.4 MB">
  <!ENTITY liboil-time          "0.6 SBU">
]>

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

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

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

  <indexterm zone="liboil">
    <primary sortas="a-liboil">liboil</primary>
  </indexterm>

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

    <para><application>Liboil</application> is a library of simple
    functions that are optimized for various CPUs.</para>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="glib2"/> and
    <xref linkend="gtk-doc"/></para>

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

  </sect2>

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

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

<!-- <screen><userinput>CONFIGPARMS="- -prefix=/usr"</userinput></screen>

    <para>If you wish to rebuild the API documentation, run
    the following command:</para>

<screen><userinput>CONFIGPARMS="$CONFIGPARMS - -enable-gtk-doc"</userinput></screen>

    <para>Run the following commands:</para> -->

<screen><userinput>./configure --prefix=/usr &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</userinput></screen>

  </sect2>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>oil-bugreport</seg>
        <seg>liboil-0.3{so,a}</seg>
        <seg>/usr/include/liboil-0.3/liboil and
        /usr/share/gtk-doc/html/liboil</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="oil-bugreport">
        <term><command>oil-bugreport</command></term>
        <listitem>
          <para>prints out API function stats.</para>
          <indexterm zone="liboil oil-bugreport">
            <primary sortas="b-oil-bugreport">oil-bugreport</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liboil-0.3">
        <term><filename class='libraryfile'>liboil-0.3.{so,a}</filename></term>
        <listitem>
          <para>contains the liboil API functions.</para>
          <indexterm zone="liboil liboil-0.3">
            <primary sortas="c-liboil-0.3">liboil-0.3.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>