docs/install.html

   1 <HTML>
   2
   3 <TITLE>Compilation and Installation</TITLE>
   4
   5 <link rel="stylesheet" type="text/css" href="mesa.css"></head>
   6
   7 <BODY>
   8
   9
  10 <H1>Compilation and Installation</H1>
  11
  12 <ol>
  13 <li><a href="#unix-x11">Unix / X11</a>
  14 <li><a href="#windows">Windows</a>
  15 <li><a href="#vms">VMS</a>
  16 <li><a href="#other">Other</a>
  17 </ol>
  18
  19
  20
  21 <a name="unix-x11">
  22 <H2>1. Unix/X11 Compilation and Installation</H1>
  23
  24
  25 <h3>1.1 Prerequisites for DRI and Hardware Acceleration</h3>
  26
  27 <p>
  28 To build Mesa 7.1 with DRI-based hardware acceleration you must first have
  29 the <a href="http://dri.freedesktop.org/libdrm/" target="_parent">DRM version 2.3.1</a>.
  30 </p>
  31
  32 <p>
  33 You should also be using the Xorg server version 1.4 or 1.5.
  34 </p>
  35
  36
  37
  38 <h3>1.2 Autoconf Compilation</h3>
  39
  40 <p>
  41 Mesa may be <a href="autoconf.html">built using autoconf</a>.
  42 This should work well on most GNU-based systems.
  43 When that fails, the traditional Mesa build system is available.
  44
  45
  46
  47 <h3>1.3 Traditional Compilation</h3>
  48
  49 <p>
  50 The traditional Mesa build system is based on a collection of pre-defined
  51 system configurations.
  52 </p>
  53 <p>
  54 To see the list of configurations, type <b>make</b> alone.
  55 Then choose a configuration from the list and type <b>make configname</b>.
  56 </p>
  57
  58 <p>
  59 Mesa may be built in several different ways using the predefined configurations:
  60 </p>
  61 <ul>
  62 <li><b><em>Stand-alone/Xlib mode</em></b> - Mesa will be compiled as
  63 a software renderer using Xlib to do all rendering.
  64 The libGL.so library will be a self-contained rendering library that will
  65 allow you to run OpenGL/GLX applications on any X server (regardless of
  66 whether it supports the GLX X server extension).
  67 You will <em>not</em> be able to use hardware 3D acceleration.
  68 <p>
  69 To compile stand-alone Mesa type <b>make</b> in the top-level directory.
  70 You'll see a list of supported system configurations.
  71 Choose one from the list (such as linux-x86), and type:
  72 </p>
  73 <pre>
  74     make linux-x86
  75 </pre>
  76 <p>This will produce libGL.so and several other libraries</p>
  77 </li>
  78
  79 <li><b><em>DRI/accelerated</em></b> - The DRI hardware drivers for
  80 accelerated OpenGL rendering (for ATI, Intel, Matrox, etc) will be built.
  81 The libGL.so library will support the GLX extension and will load/use
  82 the DRI hardware drivers.
  83
  84
  85 <p>
  86 Build Mesa and the DRI hardware drivers by running
  87 </p>
  88 <pre>
  89    make linux-dri
  90 </pre>
  91 <p>
  92 There are also <code>linux-dri-x86</code>, <code>linux-dri-x86-64</code>,
  93 and <code>linux-ppc</code> configurations which are optimized for those
  94 architectures.
  95 </p>
  96 <p>
  97 Make sure you have the prerequisite versions of DRM and Xserver mentioned
  98 above.
  99 </p>
 100
 101 </li>
 102
 103 </ul>
 104
 105
 106 <p>
 107 Later, if you want to rebuild for a different configuration run
 108 <code>make realclean</code> before rebuilding.
 109 </p>
 110
 111
 112 <h3>1.4 The libraries</h3>
 113
 114 <p>
 115 When compilation has finished, look in the top-level <code>lib/</code>
 116 (or <code>lib64/</code>) directory.
 117 You'll see a set of library files similar to this:
 118 </p>
 119 <pre>
 120 lrwxrwxrwx    1 brian    users          10 Mar 26 07:53 libGL.so -> libGL.so.1*
 121 lrwxrwxrwx    1 brian    users          19 Mar 26 07:53 libGL.so.1 -> libGL.so.1.5.060100*
 122 -rwxr-xr-x    1 brian    users     3375861 Mar 26 07:53 libGL.so.1.5.060100*
 123 lrwxrwxrwx    1 brian    users          11 Mar 26 07:53 libGLU.so -> libGLU.so.1*
 124 lrwxrwxrwx    1 brian    users          20 Mar 26 07:53 libGLU.so.1 -> libGLU.so.1.3.060100*
 125 -rwxr-xr-x    1 brian    users      549269 Mar 26 07:53 libGLU.so.1.3.060100*
 126 lrwxrwxrwx    1 brian    users          12 Mar 26 07:53 libglut.so -> libglut.so.3*
 127 lrwxrwxrwx    1 brian    users          16 Mar 26 07:53 libglut.so.3 -> libglut.so.3.7.1*
 128 -rwxr-xr-x    1 brian    users      597754 Mar 26 07:53 libglut.so.3.7.1*
 129 lrwxrwxrwx    1 brian    users          11 Mar 26 08:04 libGLw.so -> libGLw.so.1*
 130 lrwxrwxrwx    1 brian    users          15 Mar 26 08:04 libGLw.so.1 -> libGLw.so.1.0.0*
 131 -rwxr-xr-x    1 brian    users       20750 Mar 26 08:04 libGLw.so.1.0.0*
 132 lrwxrwxrwx    1 brian    users          14 Mar 26 07:53 libOSMesa.so -> libOSMesa.so.6*
 133 lrwxrwxrwx    1 brian    users          23 Mar 26 07:53 libOSMesa.so.6 -> libOSMesa.so.6.1.060100*
 134 -rwxr-xr-x    1 brian    users       23871 Mar 26 07:53 libOSMesa.so.6.1.060100*
 135 </pre>
 136
 137 <p>
 138 <b>libGL</b> is the main OpenGL library (i.e. Mesa).
 139 <br>
 140 <b>libGLU</b> is the OpenGL Utility library.
 141 <br>
 142 <b>libglut</b> is the GLUT library.
 143 <br>
 144 <b>libGLw</b> is the Xt/Motif OpenGL drawing area widget library.
 145 <br>
 146 <b>libOSMesa</b> is the OSMesa (Off-Screen) interface library.
 147 </p>
 148
 149 <p>
 150 If you built the DRI hardware drivers, you'll also see the DRI drivers:
 151 </p>
 152 <pre>
 153 -rwxr-xr-x   1 brian users 15607851 Jul 21 12:11 ffb_dri.so
 154 -rwxr-xr-x   1 brian users 15148747 Jul 21 12:11 i810_dri.so
 155 -rwxr-xr-x   1 brian users 14497814 Jul 21 12:11 i830_dri.so
 156 -rwxr-xr-x   1 brian users 16895413 Jul 21 12:11 i915_dri.so
 157 -rwxr-xr-x   1 brian users 11320803 Jul 21 12:11 mach64_dri.so
 158 -rwxr-xr-x   1 brian users 11418014 Jul 21 12:12 mga_dri.so
 159 -rwxr-xr-x   1 brian users 11064426 Jul 21 12:12 r128_dri.so
 160 -rwxr-xr-x   1 brian users 11849858 Jul 21 12:12 r200_dri.so
 161 -rwxr-xr-x   1 brian users 16050488 Jul 21 12:11 r300_dri.so
 162 -rwxr-xr-x   1 brian users 11757388 Jul 21 12:12 radeon_dri.so
 163 -rwxr-xr-x   1 brian users 11232304 Jul 21 12:13 s3v_dri.so
 164 -rwxr-xr-x   1 brian users 11062970 Jul 21 12:13 savage_dri.so
 165 -rwxr-xr-x   1 brian users 11214212 Jul 21 12:13 sis_dri.so
 166 -rwxr-xr-x   1 brian users 11368736 Jul 21 12:13 tdfx_dri.so
 167 -rwxr-xr-x   1 brian users 10598868 Jul 21 12:13 trident_dri.so
 168 -rwxr-xr-x   1 brian users 10997120 Jul 21 12:13 unichrome_dri.so
 169 </pre>
 170
 171
 172 <h3>1.5 Running the demos</h3>
 173
 174 <p>
 175 If you downloaded/unpacked the MesaDemos-x.y.z.tar.gz archive or
 176 obtained Mesa from CVS, the <b>progs/</b> directory will contain a
 177 bunch of demonstration programs.
 178 </p>
 179
 180 <p>
 181 Before running a demo, you'll probably have to set two environment variables
 182 to indicate where the libraries are located.  For example:
 183 <p>
 184 <blockquote>
 185 <b>cd lib/</b>
 186 <br>
 187 <b>export LD_LIBRARY_PATH=${PWD}</b>
 188 <br>
 189 <b>export LIBGL_DRIVERS_PATH=${PWD}</b> (if using DRI drivers)
 190 </blockquote>
 191
 192 <p>
 193 Next, change to the Mesa/demos/ directory:
 194 </p>
 195 <blockquote>
 196 <b>cd ../progs/demos</b>
 197 </blockquote>
 198
 199 <p>
 200 Run a demo such as gears:
 201 </p>
 202 <blockquote>
 203 <b>./gears</b>
 204 </blockquote>
 205
 206 <p>
 207 If this doesn't work, try the <b>Mesa/progs/xdemos/glxinfo</b> program
 208 and see that it prints the expected Mesa version number.
 209 </p>
 210
 211 <p>
 212 If you're using Linux or a similar OS, verify that the demo program is
 213 being linked with the proper library files:
 214 </p>
 215 <blockquote>
 216 <b>ldd gears</b>
 217 </blockquote>
 218
 219 <p>
 220 You should see something like this:
 221 </p>
 222 <pre>
 223         libglut.so.3 => /home/brian/Mesa/lib/libglut.so.3 (0x40013000)
 224         libGLU.so.1 => /home/brian/Mesa/lib/libGLU.so.1 (0x40051000)
 225         libGL.so.1 => /home/brian/Mesa/lib/libGL.so.1 (0x400e0000)
 226         libc.so.6 => /lib/i686/libc.so.6 (0x42000000)
 227         libm.so.6 => /lib/i686/libm.so.6 (0x403da000)
 228         libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x403fc000)
 229         libXmu.so.6 => /usr/X11R6/lib/libXmu.so.6 (0x404da000)
 230         libXt.so.6 => /usr/X11R6/lib/libXt.so.6 (0x404f1000)
 231         libXi.so.6 => /usr/X11R6/lib/libXi.so.6 (0x40543000)
 232         libstdc++.so.5 => /usr/lib/libstdc++.so.5 (0x4054b000)
 233         libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x405fd000)
 234         libXext.so.6 => /usr/X11R6/lib/libXext.so.6 (0x40605000)
 235         libpthread.so.0 => /lib/i686/libpthread.so.0 (0x40613000)
 236         /lib/ld-linux.so.2 => /lib/ld-linux.so.2 (0x40000000)
 237         libdl.so.2 => /lib/libdl.so.2 (0x40644000)
 238         libSM.so.6 => /usr/X11R6/lib/libSM.so.6 (0x40647000)
 239         libICE.so.6 => /usr/X11R6/lib/libICE.so.6 (0x40650000)
 240 </pre>
 241
 242 <p>
 243 Retrace your steps if this doesn't look right.
 244 </p>
 245
 246
 247 <H3>1.6 Installing the header and library files</H3>
 248
 249 <p>
 250 The standard location for the OpenGL header files on Unix-type systems is
 251 in <code>/usr/include/GL/</code>.
 252 The standard location for the libraries is <code>/usr/lib/</code>.
 253 For more information see, the
 254 <a href="http://oss.sgi.com/projects/ogl-sample/ABI/" target="_parent">
 255 Linux/OpenGL ABI specification</a>.
 256 </p>
 257
 258 <p>
 259 If you'd like Mesa to co-exist with another implementation of OpenGL that's
 260 already installed, you'll have to choose different directories, like
 261 <code>/usr/local/include/GL/</code> and <code>/usr/local/lib/</code>.
 262 </p>
 263
 264 <p>
 265 To install Mesa's headers and libraries, run <code>make install</code>.
 266 But first, check the Mesa/configs/default file and examine the values
 267 of the <b>INSTALL_DIR</b> and <b>DRI_DRIVER_INSTALL_DIR</b> variables.
 268 Change them if needed, then run <code>make install</code>.
 269 </p>
 270
 271 <p>
 272 The variable
 273 <b>DESTDIR</b> may also be used to install the contents to a temporary
 274 staging directory.
 275 This can be useful for package management.
 276 For example: <code>make install DESTDIR=/somepath/</code>
 277 </p>
 278
 279 <p>
 280 Note: at runtime you can use the LD_LIBRARY_PATH environment variable
 281 (on Linux at least) to switch
 282 between the Mesa libraries and other vendor's libraries whenever you want.
 283 This is a handy way to compare multiple OpenGL implementations.
 284 </p>
 285
 286
 287 <H3>1.7 Building OpenGL Programs With pkg-config</H3>
 288
 289 <p>
 290 Running <code>make install</code> will install package configuration files
 291 for the pkg-config utility.
 292 </p>
 293
 294 <p>
 295 When compiling your OpenGL application you can use pkg-config to determine
 296 the proper compiler and linker flags.
 297 </p>
 298
 299 <p>
 300 For example, compiling and linking a GLUT application can be done with:
 301 </p>
 302 <pre>
 303    gcc `pkg-config --cflags --libs glut` mydemo.c -o mydemo
 304 </pre>
 305
 306 <br>
 307
 308 <a name="windows">
 309 <H2>2. Windows Compilation and Installation</H1>
 310
 311 <p>
 312 Please see the <a href="README.WIN32">README.WIN32</a> file.
 313 </p>
 314
 315
 316
 317
 318 <a name="vms">
 319 <H2>3. VMS Compilation and Installation</H1>
 320
 321 <p>
 322 Please see the <a href="README.VMS">README.VMS</a> file.
 323 </p>
 324
 325
 326
 327
 328 <a name="other">
 329 <H2>4. Other systems</H1>
 330
 331 <p>
 332 Documentation for other environments (some may be very out of date):
 333 </p>
 334
 335 <UL>
 336 <LI><A HREF="README.GGI">README.GGI</A> - GGI
 337 <LI><A HREF="README.3DFX">README.3DFX</A> - 3Dfx/Glide driver
 338 <LI><A HREF="README.AMIWIN">README.AMIWIN</A> - Amiga Amiwin
 339 <LI><A HREF="README.BEOS">README.BEOS</A> - BeOS
 340 <LI><A HREF="README.D3D">README.D3D</A> - Direct3D driver
 341 <LI><A HREF="README.DJ">README.DJ</A> - DJGPP
 342 <LI><A HREF="README.LYNXOS">README.LYNXOS</A> - LynxOS
 343 <LI><A HREF="README.MINGW32">README.MINGW32</A> - Mingw32
 344 <LI><A HREF="README.NeXT">README.NeXT</A> - NeXT
 345 <LI><A HREF="README.OpenStep">README.OpenStep</A> - OpenStep
 346 <LI><A HREF="README.OS2">README.OS2</A> - OS/2
 347 <LI><A HREF="README.WINDML">README.WINDML</A> - WindML
 348 </UL>
 349
 350
 351
 352
 353 </body>
 354 </html>