source: x/lib/mesalib.xml@ aed37975

<?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 mesalib-download-http "&sourceforge-repo;/mesa3d/MesaLib-&mesalib-version;.tar.bz2">
  <!ENTITY mesalib-download-ftp  " ">
  <!ENTITY mesalib-md5sum        "04d379292e023df0b0266825cb0dbde5">
  <!ENTITY mesalib-size          "3.2 MB">
  <!ENTITY mesalib-buildsize     "175 MB">
  <!ENTITY mesalib-time          "2.7 SBU">

  <!ENTITY mesademos-download-http "&sourceforge-repo;/mesa3d/MesaDemos-&mesalib-version;.tar.bz2">
  <!ENTITY mesademos-md5sum        "22e03dc4038cd63f32c21eb60994892b">
  <!ENTITY mesademos-size          "1.4 MB">

  <!ENTITY mesaglut-download-http  "&sourceforge-repo;/mesa3d/MesaGLUT-&mesalib-version;.tar.bz2">
  <!ENTITY mesaglut-md5sum         "f67daf93e12c4a459703bbf3e4004e31">
  <!ENTITY mesaglut-size           "328 KB">

]>

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

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

  <title>MesaLib-&mesalib-version;</title>

  <indexterm zone="mesalib">
    <primary sortas="a-MesaLib">MesaLib</primary>
  </indexterm>

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

    <para><application>Mesa</application> is an OpenGL compatible 3-D graphics
    library.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>

    <itemizedlist spacing="compact">
      <title>Recommended demonstration and diagnostic utilities for
      verifying OpenGL operation</title>
      <listitem>
        <para>Download (HTTP): <ulink url="&mesademos-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &mesademos-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &mesademos-size;</para>
      </listitem>
    </itemizedlist>

    <itemizedlist spacing="compact">
      <title>Optional GLUT library (see also <xref linkend="freeglut"/>)</title>
      <listitem>
        <para>Download (HTTP): <ulink url="&mesaglut-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &mesaglut-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &mesaglut-size;</para>
      </listitem>
    </itemizedlist>

    <note><para>Mesa's GLUT library is not released under a free software
    license.  Permission is granted by the copyright holder for its use within
    the Mesa distribution. <xref linkend="freeglut"/> is recommended over
    Mesa's GLUT library.</para></note>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="xorg7-lib"/>,
    <xref linkend="xorg7-util"/>,
    <xref linkend="libdrm"/>, and
    <xref linkend="expat"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libxcb"/> and
    <xref linkend="lesstif"/></para>

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

  </sect2>

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

    <para>Extract all three tarballs from the same top-level directory as they
    all will extract to the
    <filename class="directory">Mesa-&mesalib-version;</filename>
    directory.</para>

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

<screen><userinput>sed 's@FLAGS=\"-g@FLAGS=\"@' -i configure &amp;&amp;
./configure $XORG_CONFIG &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</userinput></screen>

    <para>If you built the demo programs, install them using the following
    command as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 progs/xdemos/glx{info,gears} ${XORG_PREFIX}/bin</userinput></screen>

    <para>Finally, if installing to any prefix other than
    <filename class="directory">/usr</filename>, you should create symlinks
    to the GL headers in <filename class="directory">/usr/include</filename>.
    Execute the following command as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>ln -s -v ${XORG_PREFIX}/include/GL /usr/include</userinput></screen>

  </sect2>

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

    <para><command>sed 's@FLAGS=\"-g@FLAGS=\"@' -i configure</command>: by
    default, Mesa builds with debugging symbols.  Remove the -g switch from
    both <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar> with this
    command.</para>

    <para><option>--enable-xcb</option>: use the XCB backend instead of the
    default XLib backend for GLX.</para>

    <para><option>--enable-motif</option>: build motif widgets into the
    GL widgets library (requires <application>lesstif</application>).</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs (optional)</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>glxgears and glxinfo</seg>
        <seg>libGL.so, libGLU.so, libGLw.so, *_dri.so and
        optionally, libglut.so</seg>
        <seg><envar>$XORG_PREFIX</envar>/lib/modules/dri and
        <envar>$XORG_PREFIX</envar>/share/doc/MesaLib-&mesalib-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="glxgears">
        <term><filename>glxgears</filename></term>
        <listitem>
          <para>is a GL demo useful for troubleshooting graphics
          problems.</para>
          <indexterm zone="mesalib glxgears">
            <primary sortas="b-glxgears">glxgears</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="glxinfo">
        <term><filename>glxinfo</filename></term>
        <listitem>
          <para>is a diagnostic program that displays information about the
          graphics hardware and installed GL libraries.</para>
          <indexterm zone="mesalib glxinfo">
            <primary sortas="b-glxinfo">glxinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGL">
        <term><filename class='libraryfile'>libGL.so</filename></term>
        <listitem>
          <para>is the main OpenGL library.</para>
          <indexterm zone="mesalib libGL">
            <primary sortas="c-libGL">libGL.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGLU">
        <term><filename class='libraryfile'>libGLU.so</filename></term>
        <listitem>
          <para>is the OpenGL Utility library.</para>
          <indexterm zone="mesalib libGLU">
            <primary sortas="c-libGLU">libGLU.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libGLw">
        <term><filename class='libraryfile'>libGLw.so</filename></term>
        <listitem>
          <para>is the Xt/Motif OpenGL drawing area widget library.</para>
          <indexterm zone="mesalib libGLw">
            <primary sortas="c-libGLw">libGLw.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libglut-mesa">
        <term><filename class='libraryfile'>libglut.so</filename></term>
        <listitem>
          <para>is the OpenGL Utility Toolkit (GLUT) library.</para>
          <indexterm zone="mesalib libglut-mesa">
            <primary sortas="c-libglut">libglut.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>