source: x/lib/freeglut.xml@ df72afb4

<?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        "90c3ca4dd9d51cf32276bc5344ec9754">
  <!ENTITY freeglut-size          "412 KB">
  <!ENTITY freeglut-buildsize     "14 MB">
  <!ENTITY freeglut-time          "0.2 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>

    &lfs78_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="cmake"/> and
      <xref linkend="mesalib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="glu"/>
    </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>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr      \
      -DCMAKE_BUILD_TYPE=Release       \
      -DFREEGLUT_BUILD_DEMOS=OFF       \
      -DFREEGLUT_BUILD_STATIC_LIBS=OFF \
      ..

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="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DFREEGLUT_BUILD_DEMOS=ON</parameter>: This
      parameter enables building of the optional demo programs.
      Installation of the demo programs must be done manually.
      The demo programs are limited and installation is not
      recommended.
    </para>

    <para>
      <parameter>-DFREEGLUT_BUILD_STATIC_LIBS=OFF</parameter>:
      This parameter prevents static library from being
      built and installed.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libglut.so
        </seg>
        <seg>
          None
        </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>