OSDN Git Service

2008-01-18 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / doc / doxygen / Intro.3
1 .\" t
2 .\" This man page is released under the FDL as part of libstdc++.
3 .TH C++Intro 3 "20 May 2004" "GNU libstdc++" "Standard C++ Library"
4 .SH NAME
5 C++Intro \- Introduction to the GNU libstdc++ man pages
6 .SH DESCRIPTION
7 This man page serves as a brief introduction to the GNU implementation of
8 the Standard C++ Library.  For a better introduction and more complete
9 documentation, see the
10 .B libstdc++
11 homepage listed at the end.
12 .P
13 All standard library entities are declared within
14 .I namespace std
15 and have manual entries beginning with "std::".  For example, to see
16 documentation of the template class
17 .I std::vector
18 one would use "man std::vector".  Some entities do not have a separate man
19 page; for those see the main listing in "man Namespace_std".
20 .P
21 All the man pages are automatically generated by Doxygen.  For more
22 information on this tool, see the HTML counterpart to these man pages.
23 .P
24 Some man pages do not correspond to individual classes or functions.  Rather
25 they describe categories of the Standard Library.  (For a more thorough
26 introduction to the various categories, consult a text such as Josuttis'
27 or Austern's.)  These category pages are:
28 .P
29 .\" These are separated by ONE TAB.  Nothing else.  I don't like it either.
30 .TS
31 lB l.
32 C++Intro        This page.
33 Namespace_std   A listing of the contents of std::.
34 Namespace___gnu_cxx     A listing of the contents of __gnu_cxx::.
35 Containers      An introduction to container classes.
36 Sequences       Linear containers.
37 Assoc_containers        Key-based containers.
38 Iterator_types  Programatically distinguishing iterators/pointers.
39 Intro_functors  An introduction to function objects, or functors.
40 Arithmetic_functors     Functors for basic math.
41 Binder_functors Functors which "remember" an argument.
42 Comparison_functors     Functors wrapping built-in comparisons.
43 Func_ptr_functors       Functors for use with pointers to functions.
44 Logical_functors        Functors wrapping the Boolean operations.
45 Member_ptr_functor      Functors for use with pointers to members.
46 Negation_functors       Functors which negate their contents.
47 SGIextensions   A list of the extensions from the SGI STL subset.
48
49 .TE
50 .P
51 The HTML documentation typically goes into much more depth.
52 .SH FILES
53 Lots!
54 .SS Standard Headers
55 These headers will be found automatically, unless you instruct the compiler
56 otherwise.
57 .TS
58 lB lB lB lB.
59 <algorithm>  <csignal>     <iomanip>   <ostream>
60 <bitset>     <cstdarg>     <ios>       <queue>
61 <cassert>    <cstddef>     <iosfwd>    <set>
62 <cctype>     <cstdio>      <iostream>  <sstream>
63 <cerrno>     <cstdlib>     <istream>   <stack>
64 <cfloat>     <cstring>     <iterator>  <stdexcept>
65 <ciso>646    <ctime>       <limits>    <streambuf>
66 <climits>    <cwchar>      <list>      <string>
67 <clocale>    <cwctype>     <locale>    <utility>
68 <cmath>      <deque>       <map>       <valarray>
69 <complex>    <fstream>     <memory>    <vector>
70 <csetjmp>    <functional>  <numeric>
71 .TE
72 .SS Backwards-Compatibility Headers
73 For GCC 3.0 these headers will be found automatically, unless you instruct
74 the compiler otherwise.  You should not depend on this, instead you should
75 read FAQ 5.4 and use a
76 .B backward/
77 prefix.
78 .TS
79 lB lB lB lB.
80 <strstream>
81 .TE
82 .SS Extension Headers
83 These headers will only be found automatically if you include the leading
84 .B ext/
85 in the name.  Otherwise you need to read FAQ 5.4.
86 .\" Easy way to generate these columns of headers is to use GNU ls(1):
87 .\" ls -w 40 file1 file2... | sed 's=[a-z_][a-z_]*=<ext/&>=g'
88 .TS
89 lB lB.
90 <ext/algorithm>            <ext/numeric>            
91 <ext/functional>           <ext/iterator>
92 <ext/slist>                <ext/rb_tree>  
93 <ext/rope>                 <ext/memory>               
94 <ext/bitmap_allocator.h>   <ext/debug_allocator.h>    
95 <ext/malloc_allocator.h>   <ext/mt_allocator.h>     
96 <ext/pool_allocator.h>     <ext/pod_char_traits.h>    
97 <ext/stdio_filebuf.h>      <ext/stdio_sync_filebuf.h>
98 .TE
99 .SS Libraries
100 .TP
101 .I libstdc++.a
102 The library implementation in static archive form.  If you did not configure
103 libstdc++ to use shared libraries, this will always be used.  Otherwise
104 it will only be used if the user requests it.
105 .TP
106 .I libsupc++.a
107 This library contains C++ language support routines.  Usually you will never
108 need to know about it, but it can be useful.  See FAQ 2.5.
109 .TP
110 .I libstdc++.so[.N]
111 The library implementation in shared object form.  This will be used in
112 preference to the static archive form by default.  N will be a number equal
113 to or greater than 3.  If N is in the 2.x series, then you are looking at
114 the old libstdc++-v2 library, which we do not maintain.
115 .TP
116 .I libstdc++.la
117 .TP
118 .I libsupc++.la
119 These are Libtool library files, and should only be used when working with
120 that tool.
121 .SH CONFORMING TO
122 Almost conforming to
123 .BI "International Standard ISO/IEC 14882:1998(E), " "Programming Languages --- C++"
124 (aka the C++ standard), in addition to corrections proposed by the Library
125 Working Group,
126 .SM JTC1/SC22/WG21.
127 .SH SEE ALSO
128 .UR
129 http://gcc.gnu.org/libstdc++/
130 .UE
131 for the Frequently Asked Questions, online documentation, and much, much more!
132 .\" vim:ts=8:noet: