source: x/lib/freeglut.xml@ 7377d74

<?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 freeglut-download-http
  "&sourceforge-repo;/freeglut/freeglut-&freeglut-version;.tar.gz">
  <!ENTITY freeglut-download-ftp " ">
  <!ENTITY freeglut-md5sum        "5db8651af306bc403fbfd36934a20e1d">
  <!ENTITY freeglut-size          "960 KB">
  <!ENTITY freeglut-buildsize     "10 MB">
  <!ENTITY freeglut-time          "0.1 SBU">
]>

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

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

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

  <indexterm zone="freeglut">
    <primary sortas="a-Freeglut">Freeglut</primary>
  </indexterm>

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

    <para><application>freeglut</application> is intended to be a 100%
    compatible, completely opensourced clone of the GLUT library. GLUT is a
    window system independent toolkit for writing OpenGL programs, implementing
    a simple windowing API, which makes learning about and exploring OpenGL
    programming very easy.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="mesalib"/></para>

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

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

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

<screen><userinput>./configure --prefix=<replaceable>&lt;$XORG_PREFIX&gt;</replaceable> --disable-static &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;
mkdir -p <replaceable>&lt;$XORG_PREFIX&gt;</replaceable>/share/doc/freeglut-&freeglut-version; &amp;&amp;
cp doc/*.{html,png} <replaceable>&lt;$XORG_PREFIX&gt;</replaceable>/share/doc/freeglut-&freeglut-version;</userinput></screen>
  </sect2>

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

    <para><option>--disable-static</option>: This option stops it compiling a
    static version of the library.</para>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>libglut.so</seg>
        <seg><replaceable>&lt;$XORG_PREFIX&gt;</replaceable>/share/doc/freeglut-&freeglut-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libglut">
        <term><filename class='libraryfile'>libglut.so</filename></term>
        <listitem>
          <para>contains functions that implement the OpenGL Utility
          Toolkit.</para>
          <indexterm zone="freeglut libglut">
            <primary sortas="c-libglut">libglut.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>