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