libstdc++-v3/docs/html/install.html

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html
   3           PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8    <meta name="AUTHOR" content="pme@gcc.gnu.org (Phil Edwards)" />
   9    <meta name="KEYWORDS" content="libstdc++, libstdc++-v3, GCC, g++" />
  10    <meta name="DESCRIPTION" content="README for the GNU libstdc++ effort." />
  11    <meta name="GENERATOR" content="vi and eight fingers" />
  12    <title>libstdc++-v3 Installation Instructions</title>
  13 <link rel="StyleSheet" href="lib3styles.css" />
  14 </head>
  15 <body>
  16
  17 <h1 class="centered"><a name="top">libstdc++-v3 INSTALL</a></h1>
  18
  19 <p>The latest version of this document is always available at
  20    <a href="http://gcc.gnu.org/onlinedocs/libstdc++/install.html">
  21    http://gcc.gnu.org/onlinedocs/libstdc++/install.html</a>.
  22 </p>
  23
  24 <p>To the <a href="http://gcc.gnu.org/libstdc++/">libstdc++-v3 homepage</a>.
  25 </p>
  26
  27
  28 <!-- ####################################################### -->
  29 <hr />
  30 <h2>Contents</h2>
  31 <ul>
  32    <li><a href="#prereqs">Tools you will need beforehand</a></li>
  33    <li><a href="#srcsetup">Setting up the source directories</a></li>
  34    <li><a href="#config">Configuring</a></li>
  35    <li><a href="#install">Building and installing the library</a></li>
  36    <li><a href="#postinstall">Post-installation</a></li>
  37    <li><a href="#usage">Using the library</a></li>
  38 </ul>
  39
  40 <hr />
  41
  42 <!-- ####################################################### -->
  43
  44 <h2><a name="prereqs">Tools you will need beforehand</a></h2>
  45    <p>You will need a recent version of g++ to compile the snapshot of
  46       libstdc++, such as one of the GCC 3.x snapshots (insert standard
  47       caveat about using snapshots rather than formal releases).  You will
  48       need the full source distribution to whatever compiler release you are
  49       using.  The GCC snapshots can be had from one of the sites on their
  50       <a href="http://gcc.gnu.org/mirrors.html">mirror list</a>.  If you are
  51       using a 2.x compiler, see
  52       <a href="http://gcc.gnu.org/libstdc++/status.html">the status page</a>
  53       first.
  54    </p>
  55
  56    <p>In addition, if you plan to modify the makefiles or regenerate the
  57       configure scripts you'll need recent versions of the GNU Autotools:
  58       autoconf (version 2.50 or later),
  59       automake (version 1.4 or later),    <!-- special version? -->
  60       and libtool (multilanguage, version 1.4 or later),  <!-- really? -->
  61       in order to rebuild the files.
  62       These tools are all required to be installed in the same location
  63       (most linux distributions install these tools by default, so no
  64       worries as long as the versions are correct).
  65    </p>
  66
  67    <p>To test your build, you will need either DejaGNU 1.4 (to run
  68       <code>'make check'</code> like
  69       <a href="http://gcc.gnu.org/install/test.html">the rest of GCC</a>),
  70       or Bash 2.x (to run <code>'make check-script'</code>).
  71    </p>
  72
  73    <p>As of June 19, 2000, libstdc++ attempts to use tricky and
  74       space-saving features of the GNU toolchain, enabled with
  75       <code>-ffunction-sections -fdata-sections
  76       -Wl,--gc-sections</code>.  To obtain maximum benefit from this,
  77       binutils after this date should also be used (bugs were fixed
  78       with C++ exception handling related to this change in
  79       libstdc++-v3).  The version of these tools should be
  80       <code>2.10.90</code>, or later, and you can get snapshots (as
  81       well as releases) of binutils
  82       <a href="ftp://sources.redhat.com/pub/binutils">here</a>. The
  83       configure process will automatically detect and use these
  84       features if the underlying support is present.
  85    </p>
  86
  87    <p>If you are using a 3.1-series libstdc++ snapshot, then the
  88       requirements are slightly more stringent: the compiler sources
  89       must also be 3.1 or later (for both technical and licensing
  90       reasons), and your binutils must be 2.11.95 or later if you want
  91       to use symbol versioning in shared libraries. Again, the
  92       configure process will automatically detect and use these
  93       features if the underlying support is present.
  94    </p>
  95
  96    <p>Finally, a few system-specific requirements: </p>
  97    <dl>
  98       <dt> linux </dt>
  99
 100       <dd>If gcc 3.1.0 or later on is being used on linux, an attempt
 101       will be made to use "C" library functionality necessary for C++
 102       named locale support.
 103
 104       <p>
 105       The configure option --enable-clocale can be used force a
 106       particular behavior.
 107       </p>
 108
 109       <p>
 110       If the 'gnu' locale model is being used, the following locales
 111       are used and tested in the libstdc++ testsuites: en_HK, en_US,
 112       fr_FR, fr_FR@euro, de_DE, de_DE@euro, ja_JP.eucjp, es_MX, en_PH,
 113       and it_IT. Failure to have the underlying "C" library locale
 114       information installed will mean that C++ named locales for the
 115       above regions will not work: because of this, the libstdc++
 116       testsuite will not pass the named locale tests. If this isn't an
 117       issue, don't worry about it. If named locales are needed, the
 118       underlying locale information must be installed. Note that
 119       rebuilding libstdc++ after the "C" locales are installed is not
 120       necessary.
 121       </p>
 122
 123       <p> To install
 124       support for locales, do only one of the following: </p>
 125       <ul>
 126         <li> install all locales
 127         <p> <code> export LC_ALL=C </code> </p>
 128         <p> <code> rpm -e glibc-common --nodeps </code> </p>
 129         <p> <code> rpm -i --define "_install_langs all"
 130                    glibc-common-2.2.5-34.i386.rpm </code> </p>
 131         </li>
 132         <li> install just the necessary locales
 133         <p> <code> localedef -i de_DE -f ISO-8859-1 de_DE </code> </p>
 134         </li>
 135       </ul>
 136       </dd>
 137    </dl>
 138
 139 <hr />
 140
 141 <h2><a name="srcsetup">Setting up the source directories</a></h2>
 142    <p>The following definitions will be used throughout the rest of this
 143       document:
 144    </p>
 145       <ul>
 146          <li><em>gccsrcdir</em>:  The directory holding the source of the
 147                  compiler.  It should have several subdirectories like
 148                  <em>gccsrcdir</em>/libiberty and <em>gccsrcdir</em>/gcc.
 149          </li>
 150          <li><em>libsrcdir</em>:  The directory holding the source of the
 151                  C++ library.
 152          </li>
 153          <li><em>gccbuilddir</em>:  The build directory for the compiler
 154                  in <em>gccsrcdir</em>.  GCC requires that it be built in
 155                  a different directory than its sources.
 156          </li>
 157          <li><em>libbuilddir</em>:  The build directory for libstdc++.
 158          </li>
 159          <li><em>destdir</em>:  The eventual installation directory for
 160                  the compiler/libraries, set with the --prefix option to
 161                  the configure script.
 162          </li>
 163       </ul>
 164       <p> Note: </p>
 165       <ol>
 166          <li>The 3.0 version and following are intended to replace the
 167              library that comes with the compiler, so <em>libsrcdir</em>
 168              and <em>libbuilddir</em> must be contained under
 169              <em>gccsrcdir</em> and <em>gccbuilddir</em>, respectively.
 170          </li>
 171          <li>The source, build, and installation directories should
 172              not be parents of one another; i.e., these should all be
 173              separate directories. Please don't build out of the
 174              source directory.
 175          </li>
 176       </ol>
 177
 178    <p>Check out or download the GCC sources: the resulting source directory
 179       (<code>gcc</code> or <code>gcc-3.0.3</code>, for example) is
 180       <em>gccsrcdir</em>.
 181       Once in <em>gccsrcdir</em>, you'll need to rename or delete the
 182       libstdc++-v3 directory which comes with that snapshot:
 183    </p>
 184    <pre>
 185    mv libstdc++-v3 libstdc++-v3-previous  <strong>[OR]</strong>
 186    rm -r libstdc++-v3</pre>
 187    <p>Next, unpack the libstdc++-v3 library tarball into this
 188       <em>gccsrcdir</em> directory; it will create a
 189       <em>libsrcdir</em> called <code>libstdc++-<em>version</em></code>:
 190    </p>
 191    <pre>
 192    gzip -dc libstdc++-version.tar.gz | tar xf -</pre>
 193    <p>Finally, rename <em>libsrcdir</em> to <code>libstdc++-v3</code> so that
 194       gcc's configure flags will be able to deal with the new library.
 195    </p>
 196    <pre>
 197    mv <em>libsrcdir</em> libstdc++-v3</pre>
 198
 199
 200 <hr />
 201 <h2><a name="config">Configuring</a></h2>
 202    <p>If you have never done this before, you should read the basic
 203       <a href="http://gcc.gnu.org/install/">GCC Installation
 204       Instructions</a> first.  Read <em>all of them</em>.
 205       <strong>Twice.</strong>
 206    </p>
 207    <p>When building libstdc++-v3 you'll have to configure
 208       the entire <em>gccsrcdir</em> directory.  The full list of libstdc++-v3
 209       specific configuration options, not dependent on the specific compiler
 210       release being used, can be found <a href="configopts.html">here</a>.
 211    </p>
 212    <p>Consider possibly using --enable-languages=c++ to save time by only
 213       building the C++ language parts.
 214    </p>
 215
 216    <pre>
 217    cd <em>gccbuilddir</em>
 218    <em>gccsrcdir</em>/configure --prefix=<em>destdir</em> --other-opts...</pre>
 219
 220
 221 <hr />
 222 <h2><a name="install">Building and installing the library</a></h2>
 223    <p>Now you have a few options:</p>
 224    <h3>[re]building <em>everything</em></h3>
 225    <p>If you're building GCC from scratch, you can do the usual
 226       <code> 'make bootstrap' </code> here, and libstdc++-v3 will be built
 227       as its default C++ library.  The generated g++ will magically
 228       use the correct headers, link against the correct library
 229       binary, and in general using libstdc++-v3 will be a piece of
 230       cake.  You're done; run <code>'make install'</code> (see the GCC
 231       installation instructions) to put the new compiler and libraries
 232       into place.
 233    </p>
 234
 235    <h3>[re]building only libstdc++</h3>
 236    <p>To rebuild just libstdc++, use: </p>
 237    <pre>
 238    make all-target-libstdc++-v3</pre>
 239    <p>
 240       This will configure and build the C++ library in the
 241       <em>gccbuilddir/cpu-vendor-os/</em>libstdc++ directory.
 242    </p>
 243    <p>If you are rebuilding from a previous build [attempt], some
 244       information is kept in a cache file.  This is stored in
 245       <em>gccbuilddir/cpu-vendor-os/</em> if you are building with
 246       multilibs (the default), or in
 247       <em>gccbuilddir/cpu-vendor-os/</em>libstdc++-v3 if you have
 248       multilibs disabled.  The filename is config.cache; if previous
 249       information is causing problems, you can delete it entirely, or
 250       simply edit it and remove lines.
 251    </p>
 252    <p>You're done.  Now install the rebuilt pieces with</p>
 253    <pre>
 254    make install</pre>
 255    <p>or</p>
 256    <pre>
 257    make install-gcc
 258    make install-target-libstdc++-v3</pre>
 259
 260
 261 <hr />
 262 <h2><a name="postinstall">Post-installation</a></h2>
 263    <p>Installation will create the <em>destdir</em> directory and
 264       populate it with subdirectories:
 265    </p>
 266    <pre>
 267    lib/
 268    include/c++/<em>gcc-version</em>
 269       backward/
 270       bits/
 271       <em>cpu-vendor-os</em>/bits/
 272       ext/</pre>
 273    <p>If you used the version-specific-libs configure option, then most of
 274       the headers and library files will be moved under
 275       <code>lib/gcc-lib/</code> instead.
 276    </p>
 277    <p>You can check the status of the build without installing it using</p>
 278    <pre>
 279    make check</pre>
 280    <p>or you can check the status of the installed library using</p>
 281    <pre>
 282    make check-install</pre>
 283    <p>in the <em>libbuilddir</em> directory.
 284       These commands will create a 'testsuite' directory underneath
 285       <em>libbuilddir</em> containing the results of the tests.  We are
 286       interested in any strange failures of the testsuite; please see
 287       <a href="faq/index.html#2_4">FAQ 2.4</a> for which files to examine.
 288    </p>
 289
 290    <p> In addition, there are some testing options that are mostly of
 291    interest to library maintainers and system integrators. As such,
 292    these tests may not work on all cpu and host combinations. These
 293    options include, but are not necessarily limited to, the following:
 294    </p>
 295
 296    <p>The library ABI can be tested using</p>
 297    <pre>
 298    make check-abi</pre>
 299
 300    <p>The library can also be tested using a bash script, instead of
 301    the default dejagnu test harness</p>
 302    <pre>
 303    make check-script</pre>
 304    <p>or</p>
 305    <pre>
 306    make check-script-install</pre>
 307
 308 <hr />
 309 <h2><a name="usage">Using the library</a></h2>
 310    <h3>Find the new library at runtime (shared linking only)</h3>
 311        <p>If you only built a static library (libstdc++.a), or if you
 312           specified static linking, you don't have to worry about this.
 313           But if you built a shared library (libstdc++.so) and linked
 314           against it, then you will need to find that library when you
 315           run the executable.
 316        </p>
 317        <p>Methods vary for different platforms and different styles, but
 318           the usual ones are printed to the screen during installation.
 319           They include:
 320        </p>
 321        <ul>
 322           <li>At runtime set LD_LIBRARY_PATH in your environment correctly,
 323               so that the shared library for libstdc++ can be found and
 324               loaded.  Be certain that you understand all of the other
 325               implications and behavior of LD_LIBRARY_PATH first (few
 326               people do, and they get into trouble).
 327           </li>
 328           <li>Compile the path to find the library at runtime into the
 329               program.  This can be done by passing certain options to g++,
 330               which will in turn pass them on to the linker.  The exact
 331               format of the options is dependent on which linker you use:
 332               <ul>
 333   <li>GNU ld (default on Linux):<code>  -Wl,--rpath,<em>destdir</em>/lib</code></li>
 334   <li>IRIX ld:<code>  -Wl,-rpath,<em>destdir</em>/lib</code></li>
 335   <li>Solaris ld:<code>  -Wl,-R<em>destdir</em>/lib</code></li>
 336   <li>More...?  Let us know!</li>
 337               </ul>
 338           </li>
 339        </ul>
 340        <p>Use the <code>ldd(1)</code> utility to show which library the system
 341           thinks it will get at runtime.
 342        </p>
 343        <p>A libstdc++.la file is also installed, for use with Libtool.  If
 344           you use Libtool to create your executables, these details are
 345           taken care of for you.
 346        </p>
 347
 348
 349 <!--
 350 <hr />
 351 <h2><a name=""></a></h2>
 352    <p>
 353    </p>
 354
 355 -->
 356
 357 <!-- ####################################################### -->
 358
 359 <hr />
 360 <p class="fineprint"><em>
 361 See <a href="17_intro/license.html">license.html</a> for copying conditions.
 362 Comments and suggestions are welcome, and may be sent to
 363 <a href="mailto:libstdc++@gcc.gnu.org">the libstdc++ mailing list</a>.
 364 </em></p>
 365
 366
 367 </body>
 368 </html>
 369