libstdc++-v3/docs/doxygen/Intro.3

   1 .\" t
   2 .\" This man page is released under the FDL as part of libstdc++-v3.
   3 .TH Intro 3 "27 March 2002" "GNU libstdc++-v3" "Standard C++ Library"
   4 .SH NAME
   5 Intro \- Introduction to the GNU libstdc++-v3 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++-v3
  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 .\" Keep them alphabatized.
  31 .TS
  32 lB l.
  33 Allocators      Classes encapsulating memory allocation schemes.
  34 Arithmetic_functors     Functors for basic math.
  35 Assoc_containers        Key-based containers.
  36 Binder_functors Functors which "remember" an argument.
  37 Comparison_functors     Functors wrapping built-in comparisons.
  38 Containers      An introduction to container classes.
  39 Func_ptr_functors       Functors for use with pointers to functions.
  40 Intro   This page.
  41 Intro_functors  An introduction to function objects, or functors.
  42 Iterator_types  Programatically distinguishing iterators/pointers.
  43 Logical_functors        Functors wrapping the Boolean operations.
  44 Member_ptr_functor      Functors for use with pointers to members.
  45 Namespace_Std   A listing of the contents of std::.
  46 Negation_functors       Functors which negate their contents.
  47 SGIextensions   A list of the extensions from the SGI STL subset.
  48 Sequences       Linear containers.
  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 <algo.h>      <hash_map.h>   <map.h>       <slist.h>
  81 <algobase.h>  <hash_set.h>   <multimap.h>  <stack.h>
  82 <alloc.h>     <hashtable.h>  <multiset.h>  <stream.h>
  83 <bvector.h>   <heap.h>       <new.h>       <streambuf.h>
  84 <complex.h>   <iomanip.h>    <ostream.h>   <strstream>
  85 <defalloc.h>  <iostream.h>   <pair.h>      <strstream.h>
  86 <deque.h>     <istream.h>    <queue.h>     <tempbuf.h>
  87 <fstream.h>   <iterator.h>   <rope.h>      <tree.h>
  88 <function.h>  <list.h>       <set.h>       <vector.h>
  89 .TE
  90 .SS Extension Headers
  91 These headers will only be found automatically if you include the leading
  92 .B ext/
  93 in the name.  Otherwise you need to read FAQ 5.4.
  94 .\" Easy way to generate these columns of headers is to use GNU ls(1):
  95 .\" ls -w 40 file1 file2... | sed 's=[a-z_][a-z_]*=<ext/&>=g'
  96 .TS
  97 lB.
  98 <ext/algorithm>   <ext/hash_set>  <ext/numeric>  <ext/slist>
  99 <ext/functional>  <ext/iterator>  <ext/rb_tree>
 100 <ext/hash_map>    <ext/memory>    <ext/rope>
 101 .TE
 102 .SS Libraries
 103 .TP
 104 .I libstdc++.a
 105 The library implementation in static archive form.  If you did not configure
 106 libstdc++-v3 to use shared libraries, this will always be used.  Otherwise
 107 it will only be used if the user requests it.
 108 .TP
 109 .I libsupc++.a
 110 This library contains C++ language support routines.  Usually you will never
 111 need to know about it, but it can be useful.  See FAQ 2.5.
 112 .TP
 113 .I libstdc++.so[.N]
 114 The library implementation in shared object form.  This will be used in
 115 preference to the static archive form by default.  Currently N will either
 116 start with 3 or with 4, but your system vendor may change the name as they
 117 see fit.  If N is in the 2.x series, then you are looking at the old
 118 libstdc++-v2 library, which we do not maintain.
 119 .TP
 120 .I libstdc++.la
 121 .TP
 122 .I libsupc++.la
 123 These are Libtool library files, and should only be used when working with
 124 that tool.
 125 .SH CONFORMING TO
 126 Almost conforming to
 127 .BI "International Standard ISO/IEC 14882:1998(E), " "Programming Languages --- C++"
 128 (aka the C++ standard), in addition to corrections proposed by the Library
 129 Working Group,
 130 .SM JTC1/SC22/WG21.
 131 .SH SEE ALSO
 132 .UR
 133 http://gcc.gnu.org/libstdc++/
 134 .UE
 135 for the Frequently Asked Questions, online documentation, and much, much more!
 136 .\" vim:ts=8:noet: