intel: Initialize color and spec arrays in LOCAL_VARS macro.
[mesa.git] / docs / install.html
index 4087750a725f39c3ceea0d9086c10afcd5e22d8a..10688d8ca8a208c925300c754dc01cc17388961c 100644 (file)
 <h3>1.1 Compilation</h3>
 
 <p>
-Mesa may be compiled in several different ways:
+Mesa is built by reading Makefile stubs from the configs directory.
+There are configurations for many Unix variants and different Mesa
+options. Type <b>make</b> from the top-level directory to see a list of
+supported system configurations. Alternatively, an autoconf system can
+be used to create a Makefile stub for your system. See the <a
+href="autoconf.html">autoconf instructions</a> for more details. Mesa
+may be compiled in several 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,41 +50,59 @@ 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.
+<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>
-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.
+<b>Prerequisites:</b>
 </p>
+
+<ol>
+
+<li>
 <p>
-Your distribution should already have both the kernel modules and support
-library already installed.  If not, you can get them from CVS by doing:
-<pre>
-cvs -z3 -d:pserver:anonymous@anoncvs.freedesktop.org:/cvs/dri co drm
-</pre>
+For Mesa 7.0.2 <a href="http://dri.freedesktop.org/libdrm/">
+DRM version 2.3</a> is required.
+</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.  Mesa
-6.5 requires at least libdrm 2.0.1 or greater.
+To check if you already have it, run:
+<br>
+<code>pkg-config --modversion libdrm</code>
 </p>
 <p>
-Build Mesa and the DRI drivers by running
+You can download and install a <a href="http://dri.freedesktop.org/libdrm/">
+tarball release</a> or get the code from git with:
+<br>
+<code>git clone git://anongit.freedesktop.org/git/mesa/drm</code>
+<br>
+Then revert to the drm-2.3.0 tag with:
+<br>
+<code>git-reset --hard drm-2.3.0</code>
+</p>
+</li>
+
+<li>
+Relatively recent
+<a href="http://freedesktop.org/wiki/Software_2fXserver" target="_parent">
+X.org</a> release.
+Mesa depends on a number of X header and library files.
+</li>
+
+</ol>
+
+
+<p>
+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.
-</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.
+and <code>linux-ppc</code> configurations which are optimized for those
+architectures.
 </p>
 
 </li>
@@ -92,7 +119,7 @@ Later, if you want to rebuild for a different configuration run
 
 <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>
@@ -129,10 +156,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
@@ -239,18 +271,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.5 pkg-config support</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>