source: x/lib/freeglut.xml@ 7335854e

<?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        "6d16873bd876fbf4980a927cfbc496a1">
  <!ENTITY freeglut-size          "459 KB">
  <!ENTITY freeglut-buildsize     "7.6 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>

    <para>If you built the GLUT library during an installation of
    <xref linkend="mesalib"/>, you do not need to install this package.</para>

    <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>sed 's@-Werror@@g' -i configure &amp;&amp;
./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 &amp;&amp;
install -v -d -m755 /usr/share/doc/freeglut-&freeglut-version; &amp;&amp;
install -v -m644 doc/freeglut_user_interface.html \
    /usr/share/doc/freeglut-&freeglut-version;</userinput></screen>

  </sect2>

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

    <para><command>sed 's@-Werror@@g' -i configure</command>: This command
    removes the <parameter>-Werror</parameter> flag from the
    <parameter>CFLAGS</parameter> and <parameter>CXXFLAGS</parameter>
     environment variables to avoid compilation failures due to old
     coding standards.</para>

  </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>libglut.{so,a}</seg>
        <seg>/usr/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,a}</filename></term>
        <listitem>
          <para>contains functions that implement the OpenGL Utility
          Toolkit.</para>
          <indexterm zone="freeglut libglut">
            <primary sortas="c-libglut">libglut.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>