source: x/lib/mesalib.xml@ 804ecc5

<?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 "http://downloads.sourceforge.net/mesa3d/MesaLib-&mesalib-version;.tar.bz2">
  <!ENTITY mesalib-download-ftp  " ">
  <!ENTITY mesalib-md5sum        "e4d894181f1859651658b3704633e10d">
  <!ENTITY mesalib-size          "3.1 MB">
  <!ENTITY mesalib-buildsize     "172 MB">
  <!ENTITY mesalib-time          "1.6 SBU">

  <!ENTITY mesademos-download-http "http://downloads.sourceforge.net/mesa3d/MesaDemos-&mesalib-version;.tar.bz2">
  <!ENTITY mesademos-md5sum        "e870efe98d3a50be01ab211b9b2e25d9">
  <!ENTITY mesademos-size          "1.3 MB">

  <!ENTITY mesaglut-download-http  "http://downloads.sourceforge.net/mesa3d/MesaGLUT-&mesalib-version;.tar.bz2">
  <!ENTITY mesaglut-md5sum         "e84edbb11c69c8e408dfadd2ed08e95b">
  <!ENTITY mesaglut-size           "306 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>

    <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>

<!-- XFREE86
     <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
    href="../../xincludes/xorg7-only.xml"/>

    <note>
      <para>It is not recommended to build a newer version of
      <application>Mesa</application> with <xref linkend="xfree86"/>.</para>
    </note>
XFREE86 -->

    <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>

<!-- XFREE86
    Commenting this out as there is already mention of this
    <caution>
      <para>You should ensure that the <envar>XORG_PREFIX</envar> variable in
      the commands below is the same as the one used in the installation prefix
      of <application>Xorg</application>.</para>
    </caution>
XFREE86 -->

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

<screen><userinput>make linux-dri-x86 OPT_FLAGS="-O2 -fno-strict-aliasing" \
    DRI_DRIVER_INSTALL_DIR=${XORG_PREFIX}/lib/X11/modules/dri \
    X11_INCLUDES=-I${XORG_PREFIX}/include \
    EXTRA_LIB_PATH=-L${XORG_PREFIX}/lib</userinput></screen>

    <para>If you downloaded and extracted the Demos package, build the programs
    with the following commands:</para>

<screen><userinput>sed -i 's@-l$(GLUT_LIB)@@g' configs/default &amp;&amp;
make -C progs/xdemos PROGS='glxinfo glxgears'</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 INSTALL_DIR=${XORG_PREFIX} \
    DRI_DRIVER_INSTALL_DIR=${XORG_PREFIX}/lib/X11/modules/dri &amp;&amp;
install -dv ${XORG_PREFIX}/share/doc/MesaLib-&mesalib-version; &amp;&amp;
install -v -m644 docs/* ${XORG_PREFIX}/share/doc/MesaLib-&mesalib-version;</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>

    <tip>
      <para>Do not remove the Mesa source tree yet, it will be required to
      build the <xref linkend="xorg7-server"/>.</para>
    </tip>

  </sect2>

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

    <para><command>make ... linux-dri-x86</command>: The
    <option>linux-dri-x86</option> target is specified to use a
    few other helpful flags in addition to the defaults. See the other
    targets in the <filename class="directory">configs</filename> directory
    if your architecture is not x86.</para>

    <para><envar>OPT_FLAGS="-O2 -fno-strict-aliasing"</envar>: A bug where
    OpenGL applications are shifted to the left by 50% can be worked around
    by adding <option>-fno-strict-aliasing</option> to the compiler flags.</para>

    <para><envar>DRI_DRIVER_INSTALL_DIR=${XORG_PREFIX}/lib/X11/modules/dri</envar>:
    This setting specifies the location that the DRI modules will be installed
    to. This path is also built into <filename
    class="libraryfile">libGL.so</filename>.</para>

    <para><command>sed -i 's@-l$(GLUT_LIB)@@g' configs/default</command>:
    Disables linking against the GLUT libraries for the demo programs, omit
    this command if you downloaded and extracted the GLUT tarball.</para>

    <para><command>make ... PROGS='glxinfo glxgears'</command>: Only builds
    the <command>glxinfo</command> and <command>glxgears</command>
    programs.</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>