OSDN Git Service

2004-08-30 Phil Edwards <phil@codesourcery.com>
[pf3gnuchains/gcc-fork.git] / 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" type="text/css" />
14 <link rel="Copyright" href="17_intro/license.html" type="text/html" />
15 </head>
16 <body>
17
18 <h1 class="centered"><a name="top">Getting started: configure, build, install</a></h1>
19
20 <p class="fineprint"><em>
21    The latest version of this document is always available at
22    <a href="http://gcc.gnu.org/onlinedocs/libstdc++/install.html">
23    http://gcc.gnu.org/onlinedocs/libstdc++/install.html</a>.
24 </em></p>
25
26 <p><em>
27    To the <a href="http://gcc.gnu.org/libstdc++/">libstdc++-v3 homepage</a>.
28 </em></p>
29
30
31 <!-- ####################################################### -->
32 <hr />
33 <h2>Contents</h2>
34
35 <p>Because libstdc++-v3 is part of GCC, the primary source for
36    installation instructions is
37    <a href="http://gcc.gnu.org/install/">the GCC install page</a>.
38    Additional data is given here only where it applies to libstdc++-v3.
39 </p>
40
41 <ul>
42    <li><a href="#prereqs">Tools you will need beforehand</a></li>
43    <li><a href="#config">Configuring</a></li>
44    <li><a href="#usage">Using the library</a></li>
45 </ul>
46
47 <hr />
48
49 <!-- ####################################################### -->
50
51 <h2><a name="prereqs">Tools you will need beforehand</a></h2>
52    <p>The list of software needed to build the library is kept with the
53       rest of the compiler, at
54       <a href="http://gcc.gnu.org/install/prerequisites.html">
55       http://gcc.gnu.org/install/prerequisites.html</a>.  The same page
56       also lists the tools you will need if you wish to modify the source.
57    </p>
58
59    <p>As of June 19, 2000, libstdc++ attempts to use tricky and
60       space-saving features of the GNU toolchain, enabled with
61       <code>-ffunction-sections -fdata-sections -Wl,--gc-sections</code>.
62       To obtain maximum benefit from this, binutils after this date should
63       also be used (bugs were fixed with C++ exception handling related
64       to this change in libstdc++-v3).  The version of these tools should
65       be <code>2.10.90</code>, or later, and you can get snapshots (as
66       well as releases) of binutils
67       <a href="ftp://sources.redhat.com/pub/binutils">here</a>. The
68       configure process will automatically detect and use these features
69       if the underlying support is present.
70    </p>
71
72    <p>Finally, a few system-specific requirements: </p>
73    <dl>
74       <dt> linux </dt>
75
76       <dd>If gcc 3.1.0 or later on is being used on linux, an attempt
77       will be made to use "C" library functionality necessary for C++
78       named locale support.  For gcc 3.2.1 and later, this means that
79       glibc 2.2.5 or later is required.
80
81       <p>
82       The configure option --enable-clocale can be used force a
83       particular behavior.
84       </p>
85
86       <p>
87       If the 'gnu' locale model is being used, the following locales
88       are used and tested in the libstdc++ testsuites.  The first column
89       is the name of the locale, the second is the character set it is
90       expected to use.
91       </p>
92 <pre>
93 de_DE               ISO-8859-1
94 de_DE@euro          ISO-8859-15
95 en_HK               ISO-8859-1
96 en_PH               ISO-8859-1
97 en_US               ISO-8859-1
98 en_US.ISO-8859-1    ISO-8859-1
99 en_US.ISO-8859-15   ISO-8859-15
100 en_US.UTF-8         UTF-8
101 es_MX               ISO-8859-1
102 fr_FR               ISO-8859-1
103 fr_FR@euro          ISO-8859-15
104 is_IS               UTF-8
105 it_IT               ISO-8859-1
106 ja_JP.eucjp         EUC-JP
107 se_NO.UTF-8         UTF-8
108 ta_IN               UTF-8
109 zh_TW               BIG5
110 </pre>
111       <p>Failure to have the underlying "C" library locale
112       information installed will mean that C++ named locales for the
113       above regions will not work: because of this, the libstdc++
114       testsuite will not pass the named locale tests. If this isn't an
115       issue, don't worry about it. If named locales are needed, the
116       underlying locale information must be installed. Note that
117       rebuilding libstdc++ after the "C" locales are installed is not
118       necessary.
119       </p>
120
121       <p>To install support for locales, do only one of the following:
122       </p>
123
124       <ul>
125         <li> install all locales
126           <ul>
127             <li>with RedHat Linux:
128         <p> <code> export LC_ALL=C </code> </p>
129         <p> <code> rpm -e glibc-common --nodeps </code> </p>
130         <p> <code> rpm -i --define "_install_langs all"
131                    glibc-common-2.2.5-34.i386.rpm </code> </p>
132              </li>
133              <li> (instructions for other operating systems solicited) </li>
134           </ul>
135         </li>
136         <li> install just the necessary locales
137           <ul>
138             <li>with Debian Linux:
139         <p> Add the above list, as shown, to the file
140             <code>/etc/locale.gen</code> </p>
141         <p> run <code>/usr/sbin/locale-gen</code> </p>
142             </li>
143             <li> on most Unix-like operating systems:
144         <p> <code> localedef -i de_DE -f ISO-8859-1 de_DE </code> </p>
145         <p> (repeat for each entry in the above list) </p>
146             </li>
147             <li> (instructions for other operating systems solicited) </li>
148           </ul>
149         </li>
150       </ul>
151       </dd>
152    </dl>
153
154 <hr />
155
156 <h2><a name="config">Configuring</a></h2>
157    <p>If you have never done this before, you should read the basic
158       <a href="http://gcc.gnu.org/install/">GCC Installation
159       Instructions</a> first.  Read <em>all of them</em>.
160       <strong>Twice.</strong>
161    </p>
162    <p>When building libstdc++-v3 you'll have to configure
163       the entire <em>gccsrcdir</em> directory.  The full list of libstdc++-v3
164       specific configuration options, not dependent on the specific compiler
165       release being used, can be found <a href="configopts.html">here</a>.
166    </p>
167    <p>Consider possibly using --enable-languages=c++ to save time by only
168       building the C++ language parts.
169    </p>
170
171    <pre>
172    cd <em>gccbuilddir</em>
173    <em>gccsrcdir</em>/configure --prefix=<em>destdir</em> --other-opts...</pre>
174
175
176 <hr />
177 <h2><a name="usage">Using the library</a></h2>
178    <h3>Find the new library at runtime (shared linking only)</h3>
179        <p>If you only built a static library (libstdc++.a), or if you
180           specified static linking, you don't have to worry about this.
181           But if you built a shared library (libstdc++.so) and linked
182           against it, then you will need to find that library when you
183           run the executable.
184        </p>
185        <p>Methods vary for different platforms and different styles, but
186           the usual ones are printed to the screen during installation.
187           They include:
188        </p>
189        <ul>
190           <li>At runtime set LD_LIBRARY_PATH in your environment correctly,
191               so that the shared library for libstdc++ can be found and
192               loaded.  Be certain that you understand all of the other
193               implications and behavior of LD_LIBRARY_PATH first (few
194               people do, and they get into trouble).
195           </li>
196           <li>Compile the path to find the library at runtime into the
197               program.  This can be done by passing certain options to g++,
198               which will in turn pass them on to the linker.  The exact
199               format of the options is dependent on which linker you use:
200               <ul>
201   <li>GNU ld (default on Linux):<code>  -Wl,--rpath,<em>destdir</em>/lib</code></li>
202   <li>IRIX ld:<code>  -Wl,-rpath,<em>destdir</em>/lib</code></li>
203   <li>Solaris ld:<code>  -Wl,-R<em>destdir</em>/lib</code></li>
204   <li>More...?  Let us know!</li>
205               </ul>
206           </li>
207        </ul>
208        <p>Use the <code>ldd(1)</code> utility to show which library the system
209           thinks it will get at runtime.
210        </p>
211        <p>A libstdc++.la file is also installed, for use with Libtool.  If
212           you use Libtool to create your executables, these details are
213           taken care of for you.
214        </p>
215
216
217 <!--
218 <hr />
219 <h2><a name=""></a></h2>
220    <p>
221    </p>
222
223 -->
224
225 <!-- ####################################################### -->
226
227 <hr />
228 <p class="fineprint"><em>
229 See <a href="17_intro/license.html">license.html</a> for copying conditions.
230 Comments and suggestions are welcome, and may be sent to
231 <a href="mailto:libstdc++@gcc.gnu.org">the libstdc++ mailing list</a>.
232 </em></p>
233
234
235 </body>
236 </html>
237