Merge commit 'origin/gallium-0.1' into gallium-0.2
[mesa.git] / docs / install.html
index 129daced42717d88d14f1679ab3327d3e6e6768c..16ef013688aaa3a04b8a9e3b87229142b25159d8 100644 (file)
 <a name="unix-x11">
 <H2>1. Unix/X11 Compilation and Installation</H1>
 
-<h3>1.1 Compilation</h3>
+
+<h3>1.1 Prerequisites for DRI and Hardware Acceleration</h3>
+
+<p>
+To build Mesa 7.1 with DRI-based hardware acceleration you must first have
+the <a href="http://dri.freedesktop.org/libdrm/" target="_parent">DRM version 2.3.1</a>.
+</p>
+
+<p>
+You should also be using the Xorg server version 1.4 or 1.5.
+</p>
+
+
+
+<h3>1.2 Autoconf Compilation</h3>
+
+<p>
+Mesa may be <a href="autoconf.html">built using autoconf</a>.
+This should work well on most GNU-based systems.
+When that fails, the traditional Mesa build system is available.
+
+
+
+<h3>1.3 Traditional Compilation</h3>
+
+<p>
+The traditional Mesa build system is based on a collection of pre-defined
+system configurations.
+</p>
+<p>
+To see the list of configurations, type <b>make</b> alone.
+Then choose a configuration from the list and type <b>make configname</b>.
+</p>
 
 <p>
-Mesa may be compiled in several different ways:
+Mesa may be built in several different ways using the predefined configurations:
 </p>
 <ul>
-<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa is compiled as
+<li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
 a software renderer using Xlib to do all rendering.
-libGL.so is a self-contained rendering library.
+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>
 To compile stand-alone Mesa type <b>make</b> in the top-level directory.
 You'll see a list of supported system configurations.
@@ -41,52 +76,30 @@ Choose one from the list (such as linux-x86), and type:
 <p>This will produce libGL.so and several other libraries</p>
 </li>
 
-<li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers (for ATI,
-Intel, Matrox, etc) are built.
-libGL.so implements the GLX extension and dynamically loads the DRI drivers.
-<p>
-To build the DRI drivers you'll first need to have the DRM (Direct
-Rendering Manager) kernel drivers and header files.
-They're available from the <a href="http://dri.sf.net/" target="_parent">DRI</a> project.
-</p>
-<p>
-You can get them from CVS by doing:
-<pre>
-cvs -d:pserver:anonymous@pds.freedesktop.org:/cvs/dri login
-(hit enter when prompted for a password)
-cvs -z3 -d:pserver:anonymous@pdx.freedesktop.org:/cvs/dri co drm
-</pre>
-<p>
-Make note of the directory in which the drm files are placed.
-</p>
-<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.
-</p>
-<p>
-Next, in the <code>Mesa-x.y.z/configs/default</code> file, set the
-<code>DRM_SOURCE_PATH</code> variable to indicate where the DRM files
-are located.
-</p>
+<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>
-Now build Mesa and the DRI drivers by running
+Build Mesa and the DRI hardware drivers by running
 </p>
 <pre>
-make linux-dri
+   make linux-dri
 </pre>
 <p>
 There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>, 
-and <code>linux-ppc</code> configurations, optimized for those architectures.
+and <code>linux-ppc</code> configurations which are optimized for those
+architectures.
 </p>
-
 <p>
-Finally, you'll need a DRI-enabled X server from
-<a href="http://freedesktop.org/wiki/Software_2fXserver" target="_parent">
-X.org</a> or <a href="http://www.xfree86.org" target="_parent">XFree86</a>.
-Visit those projects' home pages for more information.
+Make sure you have the prerequisite versions of DRM and Xserver mentioned
+above.
 </p>
 
 </li>
+
 </ul>
 
 
@@ -96,11 +109,11 @@ Later, if you want to rebuild for a different configuration run
 </p>
 
 
-<h3>1.2 The libraries</h3>
+<h3>1.4 The libraries</h3>
 
 <p>
 When compilation has finished, look in the top-level <code>lib/</code>
-directory.
+(or <code>lib64/</code>) directory.
 You'll see a set of library files similar to this:
 </p>
 <pre>
@@ -137,10 +150,15 @@ lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSM
 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
@@ -151,7 +169,7 @@ If you built the DRI hardware drivers, you'll also see the DRI drivers:
 </pre>
 
 
-<h3>1.3 Running the demos</h3>
+<h3>1.5 Running the demos</h3>
 
 <p>
 If you downloaded/unpacked the MesaDemos-x.y.z.tar.gz archive or
@@ -160,18 +178,15 @@ bunch of demonstration programs.
 </p>
 
 <p>
-Before running a demo, you may have to set an environment variable
-(such as <b>LD_LIBRARY_PATH</b> on Linux) to indicate where the
-libraries are located.  For example:
+Before running a demo, you'll probably have to set two environment variables
+to indicate where the libraries are located.  For example:
 <p>
 <blockquote>
-<b>cd</b> into the Mesa <b>lib/</b> directory.
-<br>
-<b>setenv LD_LIBRARY_PATH ${cwd}</b>   (if using csh or tcsh shell)
+<b>cd lib/</b>
 <br>
-or,
+<b>export LD_LIBRARY_PATH=${PWD}</b>
 <br>
-<b>export LD_LIBRARY_PATH=${PWD}</b>   (if using bash or sh shell)
+<b>export LIBGL_DRIVERS_PATH=${PWD}</b> (if using DRI drivers)
 </blockquote>
 
 <p>
@@ -229,7 +244,7 @@ Retrace your steps if this doesn't look right.
 </p>
 
 
-<H3>1.4 Installing the header and library files</H3>
+<H3>1.6 Installing the header and library files</H3>
 
 <p>
 The standard location for the OpenGL header files on Unix-type systems is
@@ -247,18 +262,48 @@ 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>
+The variable
+<b>DESTDIR</b> may also be used to install the contents to a temporary
+staging directory.
+This can be useful for package management.
+For example: <code>make install DESTDIR=/somepath/</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>
 
 
+<H3>1.7 Building OpenGL Programs With pkg-config</H3>
+
+<p>
+Running <code>make install</code> will install package configuration files
+for the pkg-config utility.
+</p>
+
+<p>
+When compiling your OpenGL application you can use pkg-config to determine
+the proper compiler and linker flags.
+</p>
+
+<p>
+For example, compiling and linking a GLUT application can be done with:
+</p>
+<pre>
+   gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
+</pre>
+
+<br>
 
 <a name="windows">
 <H2>2. Windows Compilation and Installation</H1>