docs/autoconf.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html lang="en">
   3 <head>
   4   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   5   <title>Compilation and Installation using Autoconf</title>
   6   <link rel="stylesheet" type="text/css" href="mesa.css">
   7 </head>
   8 <body>
   9
  10 <div class="header">
  11   <h1>The Mesa 3D Graphics Library</h1>
  12 </div>
  13
  14 <iframe src="contents.html"></iframe>
  15 <div class="content">
  16
  17 <h1>Compilation and Installation using Autoconf</h1>
  18
  19 <ol>
  20 <li><p><a href="#basic">Basic Usage</a></li>
  21 <li><p><a href="#driver">Driver Options</a>
  22   <ul>
  23   <li><a href="#xlib">Xlib Driver Options</a></li>
  24   <li><a href="#dri">DRI Driver Options</a></li>
  25   <li><a href="#osmesa">OSMesa Driver Options</a></li>
  26   </ul>
  27 </ol>
  28
  29
  30 <h2 id="basic">1. Basic Usage</h2>
  31
  32 <p>
  33 The autoconf generated configure script can be used to guess your
  34 platform and change various options for building Mesa. To use the
  35 configure script, type:
  36 </p>
  37
  38 <pre>
  39     ./configure
  40 </pre>
  41
  42 <p>
  43 To see a short description of all the options, type <code>./configure
  44 --help</code>. If you are using a development snapshot and the configure
  45 script does not exist, type <code>./autogen.sh</code> to generate it
  46 first. If you know the options you want to pass to
  47 <code>configure</code>, you can pass them to <code>autogen.sh</code>. It
  48 will run <code>configure</code> with these options after it is
  49 generated. Once you have run <code>configure</code> and set the options
  50 to your preference, type:
  51 </p>
  52
  53 <pre>
  54     make
  55 </pre>
  56
  57 <p>
  58 This will produce libGL.so and several other libraries depending on the
  59 options you have chosen. Later, if you want to rebuild for a different
  60 configuration run <code>make realclean</code> before rebuilding.
  61 </p>
  62
  63 <p>
  64 Some of the generic autoconf options are used with Mesa:
  65 </p>
  66 <dl>
  67 <dt><code>--prefix=PREFIX</code></dt>
  68 <dd><p>This is the root directory where
  69 files will be installed by <code>make install</code>. The default is
  70 <code>/usr/local</code>.</p>
  71 </dd>
  72
  73 <dt><code>--exec-prefix=EPREFIX</code></dt>
  74 <dd><p>This is the root directory
  75 where architecture-dependent files will be installed. In Mesa, this is
  76 only used to derive the directory for the libraries. The default is
  77 <code>${prefix}</code>.</p>
  78 </dd>
  79
  80 <dt><code>--libdir=LIBDIR</code></dt>
  81 <dd><p>This option specifies the directory
  82 where the GL libraries will be installed. The default is
  83 <code>${exec_prefix}/lib</code>. It also serves as the name of the
  84 library staging area in the source tree. For instance, if the option
  85 <code>--libdir=/usr/local/lib64</code> is used, the libraries will be
  86 created in a <code>lib64</code> directory at the top of the Mesa source
  87 tree.</p>
  88 </dd>
  89
  90 <dt><code>--sysconfdir=DIR</code></dt>
  91 <dd><p>This option specifies the directory where the configuration
  92 files will be installed. The default is <code>${prefix}/etc</code>.
  93 Currently there's only one config file provided when dri drivers are
  94 enabled - it's <code>drirc</code>.</p>
  95 </dd>
  96
  97 <dt><code>--enable-static, --disable-shared</code></dt>
  98 <dd><p>By default, Mesa
  99 will build shared libraries. Either of these options will force static
 100 libraries to be built. It is not currently possible to build static and
 101 shared libraries in a single pass.</p>
 102 </dd>
 103
 104 <dt><code>CC, CFLAGS, CXX, CXXFLAGS</code></dt>
 105 <dd><p>These environment variables
 106 control the C and C++ compilers used during the build. By default,
 107 <code>gcc</code> and <code>g++</code> are used and the debug/optimisation
 108 level is left unchanged.</p>
 109 </dd>
 110
 111 <dt><code>LDFLAGS</code></dt>
 112 <dd><p>An environment variable specifying flags to
 113 pass when linking programs. These should be empty and
 114 <code>PKG_CONFIG_PATH</code> is recommended to be used instead. If needed
 115 it can be used to direct the linker to use libraries in nonstandard
 116 directories. For example, <code>LDFLAGS="-L/usr/X11R6/lib"</code>.</p>
 117 </dd>
 118
 119 <dt><code>PKG_CONFIG_PATH</code></dt>
 120 <dd><p>The
 121 <code>pkg-config</code> utility is a hard requirement for cofiguring and
 122 building mesa. It is used to search for external libraries
 123 on the system. This environment variable is used to control the search
 124 path for <code>pkg-config</code>. For instance, setting
 125 <code>PKG_CONFIG_PATH=/usr/X11R6/lib/pkgconfig</code> will search for
 126 package metadata in <code>/usr/X11R6</code> before the standard
 127 directories.</p>
 128 </dd>
 129 </dl>
 130
 131 <p>
 132 There are also a few general options for altering the Mesa build:
 133 </p>
 134 <dl>
 135 <dt><code>--enable-debug</code></dt>
 136 <dd><p>This option will enable compiler
 137 options and macros to aid in debugging the Mesa libraries.</p>
 138 </dd>
 139
 140 <dt><code>--disable-asm</code></dt>
 141 <dd><p>There are assembly routines
 142 available for a few architectures. These will be used by default if
 143 one of these architectures is detected. This option ensures that
 144 assembly will not be used.</p>
 145 </dd>
 146
 147 <dt><code>--build=</code></dt>
 148 <dt><code>--host=</code></dt>
 149 <dd><p>By default, the build will compile code for the architecture that
 150 it's running on. In order to build cross-compile Mesa on a x86-64 machine
 151 that is to run on a i686, one would need to set the options to:</p>
 152
 153 <p><code>--build=x86_64-pc-linux-gnu --host=i686-pc-linux-gnu</code></p>
 154
 155 Note that these can vary from distribution to distribution. For more
 156 information check with the
 157 <a href="https://www.gnu.org/savannah-checkouts/gnu/autoconf/manual/autoconf-2.69/html_node/Specifying-Target-Triplets.html">
 158 autoconf manual</a>.
 159 Note that you will need to correctly set <code>PKG_CONFIG_PATH</code> as well.
 160
 161
 162 <p>In some cases a single compiler is capable of handling both architectures
 163 (multilib) in that case one would need to set the <code>CC,CXX</code> variables
 164 appending the correct machine options. Seek your compiler documentation for
 165 further information -
 166 <a href="https://gcc.gnu.org/onlinedocs/gcc/Submodel-Options.html"> gcc
 167 machine dependent options</a></p>
 168
 169 <p>In addition to specifying correct <code>PKG_CONFIG_PATH</code> for the target
 170 architecture, the following should be sufficient to configure multilib Mesa</p>
 171
 172 <code>./configure CC="gcc -m32" CXX="g++ -m32" --build=x86_64-pc-linux-gnu --host=i686-pc-linux-gnu ...</code>
 173 </dd>
 174 </dl>
 175
 176
 177 <h2 id="driver">2. Driver Options</h2>
 178
 179 <p>
 180 There are several different driver modes that Mesa can use. These are
 181 described in more detail in the <a href="install.html">basic
 182 installation instructions</a>. The Mesa driver is controlled through the
 183 configure options <code>--enable-xlib-glx</code>, <code>--enable-osmesa</code>,
 184 and <code>--enable-dri</code>.
 185 </p>
 186
 187 <h3 id="xlib">Xlib</h3><p>
 188 It uses Xlib as a software renderer to do all rendering. It corresponds
 189 to the option <code>--enable-xlib-glx</code>. The libX11 and libXext
 190 libraries, as well as the X11 development headers, will be need to
 191 support the Xlib driver.
 192
 193 <h3 id="dri">DRI</h3><p>This mode uses the DRI hardware drivers for
 194 accelerated OpenGL rendering. Enable the DRI drivers with the option
 195 <code>--enable-dri</code>. See the <a href="install.html">basic
 196 installation instructions</a> for details on prerequisites for the DRI
 197 drivers.
 198
 199 <!-- DRI specific options -->
 200 <dl>
 201 <dt><code>--with-dri-driverdir=DIR</code>
 202 <dd><p> This option specifies the
 203 location the DRI drivers will be installed to and the location libGL
 204 will search for DRI drivers. The default is <code>${libdir}/dri</code>.
 205 <dt><code>--with-dri-drivers=DRIVER,DRIVER,...</code>
 206 <dd><p> This option
 207 allows a specific set of DRI drivers to be built. For example,
 208 <code>--with-dri-drivers="swrast,i965,radeon,nouveau"</code>. By
 209 default, the drivers will be chosen depending on the target platform.
 210 See the directory <code>src/mesa/drivers/dri</code> in the source tree
 211 for available drivers. Beware that the swrast DRI driver is used by both
 212 libGL and the X.Org xserver GLX module to do software rendering, so you
 213 may run into problems if it is not available.
 214 <!-- This explanation might be totally bogus. Kristian? -->
 215 <dt><code>--disable-driglx-direct</code>
 216 <dd><p> Disable direct rendering in
 217 GLX. Normally, direct hardware rendering through the DRI drivers and
 218 indirect software rendering are enabled in GLX. This option disables
 219 direct rendering entirely. It can be useful on architectures where
 220 kernel DRM modules are not available.
 221 <dt><code>--enable-glx-tls</code> <dd><p>
 222 Enable Thread Local Storage (TLS) in
 223 GLX.
 224 <dt><code>--with-expat=DIR</code>
 225 <dd><p><strong>DEPRECATED</strong>, use <code>PKG_CONFIG_PATH</code> instead.</p>
 226 <p>The DRI-enabled libGL uses expat to
 227 parse the DRI configuration files in <code>${sysconfdir}/drirc</code> and
 228 <code>~/.drirc</code>. This option allows a specific expat installation
 229 to be used. For example, <code>--with-expat=/usr/local</code> will
 230 search for expat headers and libraries in <code>/usr/local/include</code>
 231 and <code>/usr/local/lib</code>, respectively.
 232 </dl>
 233
 234 <h3 id="osmesa">OSMesa </h3><p> No libGL is built in this
 235 mode. Instead, the driver code is built into the Off-Screen Mesa
 236 (OSMesa) library. See the <a href="osmesa.html">Off-Screen Rendering</a>
 237 page for more details.  It corresponds to the option
 238 <code>--enable-osmesa</code>.
 239
 240 <!-- OSMesa specific options -->
 241 <dl>
 242 <dt><code>--with-osmesa-bits=BITS</code>
 243 <dd><p> This option allows the size
 244 of the color channel in bits to be specified. By default, an 8-bit
 245 channel will be used, and the driver will be named libOSMesa. Other
 246 options are 16- and 32-bit color channels, which will add the bit size
 247 to the library name. For example, <code>--with-osmesa-bits=16</code>
 248 will create the libOSMesa16 library with a 16-bit color channel.
 249 </dl>
 250
 251
 252 <h2 id="library">3. Library Options</h2>
 253
 254 <p>
 255 The configure script provides more fine grained control over the GL
 256 libraries that will be built. More details on the specific GL libraries
 257 can be found in the <a href="install.html">basic installation
 258 instructions</a>.
 259
 260 </div>
 261 </body>
 262 </html>