note that non-member posts are auto-rejected
[mesa.git] / docs / install.html
index d2ad3ea0a1eecb77108adc96886a4d597f4e701d..804dee59b5ab3b58684b03c74213dc4b4b53104f 100644 (file)
@@ -2,7 +2,9 @@
 
 <TITLE>Compilation and Installation</TITLE>
 
-<BODY text="#000000" bgcolor="#55bbff" link="#111188">
+<link rel="stylesheet" type="text/css" href="mesa.css"></head>
+
+<BODY>
 
 
 <H1>Compilation and Installation</H1>
 <a name="unix-x11">
 <H2>1. Unix/X11 Compilation and Installation</H1>
 
+<h3>1.1 Compilation</h3>
+
 <p>
-Mesa uses a rather conventional Makefile system.
-A GNU autoconf/automake system used to be included, but was discarded
-in Mesa 5.1 because:
+Mesa may be compiled in several different ways:
 </p>
 <ul>
-<li>It seldom worked on IRIX, Solaris, AIX, etc.
-<li>It was very compilicated
-<li>Nobody maintained it
-<li>libtool was just too weird
-</ul>
+<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
+a software renderer using Xlib to do all rendering.
+The libGL.so library will be a self-contained rendering library that will
+allow you to run OpenGL/GLX applications on any X server (regardless of
+whether it supports the GLX X server extension).
+You will <em>not</em> be able to use hardware 3D acceleration.
 <p>
-If someone strongly feels that Mesa should have a autoconf/automake
-system and wants to contribute one and maintain it, we'll consider
-adding it again.
+To compile stand-alone Mesa type <b>make</b> in the top-level directory.
+You'll see a list of supported system configurations.
+Choose one from the list (such as linux-x86), and type:
 </p>
+<pre>
+    make linux-x86
+</pre>
+<p>This will produce libGL.so and several other libraries</p>
+</li>
+
+<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
+accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
+The libGL.so library will support the GLX extension and will load/use
+the DRI hardware drivers.
 
 <p>
-In Mesa 6.1 we modified the conventional Makefile system.
-Instead of specifying all the various system configurations in the
-Make-config file, there's a directory named <code>configs/</code> which
-has an individual file for each configuration.
-One of the configs gets copied to <code>configs/current</code>, which
-is then included by all Makefiles.
+<b>Prerequisites:</b>
 </p>
 
+<ol>
 
-<h3>1.1 Compilation</h3>
-
+<li>
 <p>
-Note: if you've obtained Mesa through CVS, do this first:
+DRM kernel modules and header files from the
+<a href="http://dri.sf.net/" target="_parent">DRI</a> project.
 </p>
+
+<p>
+If you don't already have the DRM file, you can get the sources from
+CVS by doing:
 <pre>
-    cd Mesa
-    chmod a+x bin/mklib
+cvs -z3 -d:pserver:anonymous@anoncvs.freedesktop.org:/cvs/dri co drm
 </pre>
+<p>
+See the <a href="http://dri.freedesktop.org/wiki/Building" target="_parent">
+DRI Building Instructions</a> for the steps to build the DRM modules.  Mesa
+6.5 requires at least libdrm 2.0.1 or greater.
+</p>
+<p>
+You can verify that the DRM files have been properly installed by
+running <code>pkg-config --modversion libdrm</code>
+
+</li>
 
+<li>
+Recent /usr/include/GL/glxproto.h file.
+<p>You'll need this if you get any errors about _GLXvop_BindTexImageEXT
+being undefined.
+</p>
 <p>
-Just type <b>make</b> in the top-level directory.
-You'll see a list of supported system configurations.
-Choose one from the list (such as linux-x86), and type:
+Download/install the
+<a href="http://gitweb.freedesktop.org/?p=xorg/proto/glproto.git">glproto</a>
+module from X.org git, or grab the
+<A href="http://webcvs.freedesktop.org/*checkout*/xorg/proto/GL/glxproto.h?rev=1.9&content-type=text%2Fplain">glxproto.h file</a> and put it in the
+Mesa/include/GL/ directory.
+</p>
+
+</li>
+
+<li>DRI-enabled X server.
+<p>Visit
+<a href="http://www.xfree86.org" target="_parent">XFree86</a>
+or
+<a href="http://freedesktop.org/wiki/Software_2fXserver" target="_parent">
+X.org</a>
+for more information.
+</p>
+</li>
+
+</ol>
+
+
+<p>
+Build Mesa and the DRI hardware drivers by running
 </p>
 <pre>
-    make linux-x86
+   make linux-dri
 </pre>
 <p>
-If you want to rebuild for a different configuration run
+There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>, 
+and <code>linux-ppc</code> configurations which are optimized for those
+architectures.
+</p>
+
+</li>
+</ul>
+
+
+<p>
+Later, if you want to rebuild for a different configuration run
 <code>make realclean</code> before rebuilding.
 </p>
 
@@ -73,7 +131,8 @@ If you want to rebuild for a different configuration run
 <h3>1.2 The libraries</h3>
 
 <p>
-When compilation has finished, look in the top-level <b>lib/</b> directory.
+When compilation has finished, look in the top-level <code>lib/</code>
+(or <code>lib64/</code>) directory.
 You'll see a set of library files similar to this:
 </p>
 <pre>
@@ -106,6 +165,28 @@ lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSM
 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 </p>
 
+<p>
+If you built the DRI hardware drivers, you'll also see the DRI drivers:
+</p>
+<pre>
+-rwxr-xr-x   1 brian users 15607851 Jul 21 12:11 ffb_dri.so*
+-rwxr-xr-x   1 brian users 15148747 Jul 21 12:11 i810_dri.so*
+-rwxr-xr-x   1 brian users 14497814 Jul 21 12:11 i830_dri.so*
+-rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so*
+-rwxr-xr-x   1 brian users 11320803 Jul 21 12:11 mach64_dri.so
+-rwxr-xr-x   1 brian users 11418014 Jul 21 12:12 mga_dri.so
+-rwxr-xr-x   1 brian users 11064426 Jul 21 12:12 r128_dri.so
+-rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
+-rwxr-xr-x   1 brian users 16050488 Jul 21 12:11 r300_dri.so*
+-rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
+-rwxr-xr-x   1 brian users 11232304 Jul 21 12:13 s3v_dri.so
+-rwxr-xr-x   1 brian users 11062970 Jul 21 12:13 savage_dri.so
+-rwxr-xr-x   1 brian users 11214212 Jul 21 12:13 sis_dri.so
+-rwxr-xr-x   1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
+-rwxr-xr-x   1 brian users 10598868 Jul 21 12:13 trident_dri.so
+-rwxr-xr-x   1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
+</pre>
+
 
 <h3>1.3 Running the demos</h3>
 
@@ -203,14 +284,16 @@ already installed, you'll have to choose different directories, like
 </p>
 
 <p>
-To install Mesa's headers and libraries, run <code>make install</code>
-You'll be prompted to enter alternative directories for the headers
-and libraries.
+To install Mesa's headers and libraries, run <code>make install</code>.
+But first, check the Mesa/configs/default file and examine the values
+of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
+Change them if needed, then run <code>make install</code>
 </p>
 
 <p>
-Note: at runtime, you can set the LD_LIBRARY_PATH (on Linux) to switch
-between the Mesa libs and another vendor libs whenever you want.
+Note: at runtime you can use the LD_LIBRARY_PATH environment variable
+(on Linux at least) to switch
+between the Mesa libraries and other vendor's libraries whenever you want.
 This is a handy way to compare multiple OpenGL implementations.
 </p>