Merge branch 'mesa_7_7_branch'
[mesa.git] / docs / install.html
index 16ef013688aaa3a04b8a9e3b87229142b25159d8..5aea92e0b5119dbbb526fee67d665435f6b84187 100644 (file)
@@ -1,58 +1,74 @@
 <HTML>
 
-<TITLE>Compilation and Installation</TITLE>
+<TITLE>Compiling and Installing</TITLE>
 
 <link rel="stylesheet" type="text/css" href="mesa.css"></head>
 
 <BODY>
 
 
-<H1>Compilation and Installation</H1>
+<H1>Compiling and Installing</H1>
 
 <ol>
 <li><a href="#unix-x11">Unix / X11</a>
+  <ul>
+  <li><a href="#prereq">Prerequisites for DRI and hardware acceleration</a>
+  <li><a href="#autoconf">Building with autoconf</a>
+  <li><a href="#traditional">Building with traditional Makefiles</a>
+  <li><a href="#libs">The Libraries</a>
+  <li><a href="#demos">Running the demos
+  <li><a href="#install">Installing the header and library files
+  <li><a href="#pkg-config">Building OpenGL programs with pkg-config
+  </ul>
 <li><a href="#windows">Windows</a>
-<li><a href="#vms">VMS</a>
+<li><a href="#scons">SCons</a>
 <li><a href="#other">Other</a>
 </ol>
-
+<br>
 
 
 <a name="unix-x11">
 <H2>1. Unix/X11 Compilation and Installation</H1>
 
 
-<h3>1.1 Prerequisites for DRI and Hardware Acceleration</h3>
+<a name="prereq">
+<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>.
+The following are required for DRI-based hardware acceleration with Mesa:
 </p>
 
-<p>
-You should also be using the Xorg server version 1.4 or 1.5.
+<ul>
+<li><a href="http://xorg.freedesktop.org/releases/individual/proto/">dri2proto</a> version 1.99.3 or later
+<li>Linux 2.6.28
+<li><a href="http://dri.freedesktop.org/libdrm/" target="_parent">libDRM</a>
+version 2.4.15 or later
+<li>Xorg server version 1.5 or later
+</ul>
 </p>
 
 
-
-<h3>1.2 Autoconf Compilation</h3>
+<a name="autoconf">
+<h3>1.2 Building with Autoconf</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.
+If that fails the traditional Mesa build system is available.
 
 
 
-<h3>1.3 Traditional Compilation</h3>
+<a name="traditional">
+<h3>1.3 Building with traditional Makefiles</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>.
+To see the list of configurations, just type <code>make</code>.
+Then choose a configuration from the list and type <code>make</code>
+<em>configname</em>.
 </p>
 
 <p>
@@ -66,7 +82,7 @@ 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.
+To compile stand-alone Mesa type <code>make</code> 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>
@@ -109,6 +125,7 @@ Later, if you want to rebuild for a different configuration run
 </p>
 
 
+<a name="libs">
 <h3>1.4 The libraries</h3>
 
 <p>
@@ -169,6 +186,7 @@ If you built the DRI hardware drivers, you'll also see the DRI drivers:
 </pre>
 
 
+<a name="demos">
 <h3>1.5 Running the demos</h3>
 
 <p>
@@ -244,6 +262,7 @@ Retrace your steps if this doesn't look right.
 </p>
 
 
+<a name="install">
 <H3>1.6 Installing the header and library files</H3>
 
 <p>
@@ -284,7 +303,8 @@ This is a handy way to compare multiple OpenGL implementations.
 </p>
 
 
-<H3>1.7 Building OpenGL Programs With pkg-config</H3>
+<a name="pkg-config">
+<H3>1.7 Building OpenGL programs with pkg-config</H3>
 
 <p>
 Running <code>make install</code> will install package configuration files
@@ -309,20 +329,47 @@ For example, compiling and linking a GLUT application can be done with:
 <H2>2. Windows Compilation and Installation</H1>
 
 <p>
-Please see the <a href="README.WIN32">README.WIN32</a> file.
+Please see the <a href="#scons">instructions on building with SCons</a>.
+Alternatively see <a href="README.WIN32">README.WIN32</a> file.
 </p>
 
 
 
-
-<a name="vms">
-<H2>3. VMS Compilation and Installation</H1>
+<a name="scons">
+<H2>3. Building with SCons</H1>
 
 <p>
-Please see the <a href="README.VMS">README.VMS</a> file.
+To build Mesa with SCons on Linux or Windows do
+</p>
+<pre>
+    scons
+</pre>
+<p>
+The build output will be placed in
+build/<i>platform</i>-<i>machine</i>-<i>debug</i>/..., where <i>platform</i> is for
+example linux or windows, <i>machine</i> is x86 or x86_64, optionally followed
+by -debug for debug builds.
 </p>
 
-
+<p>
+To build Mesa with SCons for Windows on Linux using the MinGW crosscompiler toolchain do
+</p>
+<pre>
+    scons platform=windows toolchain=crossmingw machine=x86 statetrackers=mesa drivers=softpipe,trace winsys=gdi
+</pre>
+<p>
+This will create:
+</p>
+<ul>
+<li>build/windows-x86-debug/gallium/winsys/gdi/opengl32.dll &mdash; Mesa + Gallium + softpipe, binary compatible with Windows's opengl32.dll 
+<li>build/windows-x86-debug/glut/glx/glut32.dll
+<li>progs/build/windows-x86-debug/wgl/wglinfo.exe
+<li>progs/build/windows-x86-debug/trivial/tri.exe
+<li>and many other samples in progs/build/windows-x86-debug/...
+</ul>
+<p>
+Put them all in the same directory to test them.
+</p>
 
 
 <a name="other">
@@ -333,6 +380,7 @@ Documentation for other environments (some may be very out of date):
 </p>
 
 <UL>
+<li><A HREF="README.VMS">README.VMS</A> - VMS
 <LI><A HREF="README.GGI">README.GGI</A> - GGI
 <LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
 <LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin