[thirdparty/gcc.git] / libstdc++-v3 / docs / doxygen / Intro.3

.\" t
.\" This man page is released under the FDL as part of libstdc++.
.TH C++Intro 3 "20 May 2004" "GNU libstdc++" "Standard C++ Library"
.SH NAME
C++Intro \- Introduction to the GNU libstdc++ man pages
.SH DESCRIPTION
This man page serves as a brief introduction to the GNU implementation of
the Standard C++ Library.  For a better introduction and more complete
documentation, see the
.B libstdc++
homepage listed at the end.
.P
All standard library entities are declared within
.I namespace std
and have manual entries beginning with "std::".  For example, to see
documentation of the template class
.I std::vector
one would use "man std::vector".  Some entities do not have a separate man
page; for those see the main listing in "man Namespace_std".
.P
All the man pages are automatically generated by Doxygen.  For more
information on this tool, see the HTML counterpart to these man pages.
.P
Some man pages do not correspond to individual classes or functions.  Rather
they describe categories of the Standard Library.  (For a more thorough
introduction to the various categories, consult a text such as Josuttis'
or Austern's.)  These category pages are:
.P
.\" These are separated by ONE TAB.  Nothing else.  I don't like it either.
.TS
lB l.
C++Intro	This page.
Namespace_std	A listing of the contents of std::.
Namespace___gnu_cxx	A listing of the contents of __gnu_cxx::.
Containers	An introduction to container classes.
Sequences	Linear containers.
Assoc_containers	Key-based containers.
Iterator_types	Programatically distinguishing iterators/pointers.
Intro_functors	An introduction to function objects, or functors.
Arithmetic_functors	Functors for basic math.
Binder_functors	Functors which "remember" an argument.
Comparison_functors	Functors wrapping built-in comparisons.
Func_ptr_functors	Functors for use with pointers to functions.
Logical_functors	Functors wrapping the Boolean operations.
Member_ptr_functor	Functors for use with pointers to members.
Negation_functors	Functors which negate their contents.
SGIextensions	A list of the extensions from the SGI STL subset.

.TE
.P
The HTML documentation typically goes into much more depth.
.SH FILES
Lots!
.SS Standard Headers
These headers will be found automatically, unless you instruct the compiler
otherwise.
.TS
lB lB lB lB.
<algorithm>  <csignal>     <iomanip>   <ostream>
<bitset>     <cstdarg>     <ios>       <queue>
<cassert>    <cstddef>     <iosfwd>    <set>
<cctype>     <cstdio>      <iostream>  <sstream>
<cerrno>     <cstdlib>     <istream>   <stack>
<cfloat>     <cstring>     <iterator>  <stdexcept>
<ciso>646    <ctime>       <limits>    <streambuf>
<climits>    <cwchar>      <list>      <string>
<clocale>    <cwctype>     <locale>    <utility>
<cmath>      <deque>       <map>       <valarray>
<complex>    <fstream>     <memory>    <vector>
<csetjmp>    <functional>  <numeric>
.TE
.SS Backwards-Compatibility Headers
For GCC 3.0 these headers will be found automatically, unless you instruct
the compiler otherwise.  You should not depend on this, instead you should
read FAQ 5.4 and use a
.B backward/
prefix.
.TS
lB lB lB lB.
<strstream>
.TE
.SS Extension Headers
These headers will only be found automatically if you include the leading
.B ext/
in the name.  Otherwise you need to read FAQ 5.4.
.\" Easy way to generate these columns of headers is to use GNU ls(1):
.\" ls -w 40 file1 file2... | sed 's=[a-z_][a-z_]*=<ext/&>=g'
.TS
lB lB.
<ext/algorithm>            <ext/numeric>            
<ext/functional>           <ext/iterator>
<ext/slist>                <ext/rb_tree>  
<ext/rope>                 <ext/memory>               
<ext/bitmap_allocator.h>   <ext/debug_allocator.h>    
<ext/malloc_allocator.h>   <ext/mt_allocator.h>     
<ext/pool_allocator.h>     <ext/pod_char_traits.h>    
<ext/stdio_filebuf.h>      <ext/stdio_sync_filebuf.h>
.TE
.SS Libraries
.TP
.I libstdc++.a
The library implementation in static archive form.  If you did not configure
libstdc++ to use shared libraries, this will always be used.  Otherwise
it will only be used if the user requests it.
.TP
.I libsupc++.a
This library contains C++ language support routines.  Usually you will never
need to know about it, but it can be useful.  See FAQ 2.5.
.TP
.I libstdc++.so[.N]
The library implementation in shared object form.  This will be used in
preference to the static archive form by default.  N will be a number equal
to or greater than 3.  If N is in the 2.x series, then you are looking at
the old libstdc++-v2 library, which we do not maintain.
.TP
.I libstdc++.la
.TP
.I libsupc++.la
These are Libtool library files, and should only be used when working with
that tool.
.SH CONFORMING TO
Almost conforming to
.BI "International Standard ISO/IEC 14882:1998(E), " "Programming Languages --- C++"
(aka the C++ standard), in addition to corrections proposed by the Library
Working Group,
.SM JTC1/SC22/WG21.
.SH SEE ALSO
.UR
http://gcc.gnu.org/libstdc++/
.UE
for the Frequently Asked Questions, online documentation, and much, much more!
.\" vim:ts=8:noet:
Commit	Line	Data
729e3d3f	1	.\" t
78a53887 BK	2	.\" This man page is released under the FDL as part of libstdc++.
78a53887 BK	3	.TH C++Intro 3 "20 May 2004" "GNU libstdc++" "Standard C++ Library"
2f9d51b8	4	.SH NAME
78a53887	5	C++Intro \- Introduction to the GNU libstdc++ man pages
2f9d51b8	6	.SH DESCRIPTION
729e3d3f PE	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
78a53887	10	.B libstdc++
729e3d3f PE	11	homepage listed at the end.
	12	.P
	13	All standard library entities are declared within
	14	.I namespace std
bd2726e0	15	and have manual entries beginning with "std::". For example, to see
729e3d3f PE	16	documentation of the template class
729e3d3f PE	17	.I std::vector
bd2726e0	18	one would use "man std::vector". Some entities do not have a separate man
66fda8b2	19	page; for those see the main listing in "man Namespace_std".
729e3d3f PE	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
ffe94f83 PE	25	they describe categories of the Standard Library. (For a more thorough
ffe94f83 PE	26	introduction to the various categories, consult a text such as Josuttis'
729e3d3f PE	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.
66fda8b2 BK	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.
729e3d3f	37	Assoc_containers Key-based containers.
66fda8b2 BK	38	Iterator_types Programatically distinguishing iterators/pointers.
	39	Intro_functors An introduction to function objects, or functors.
	40	Arithmetic_functors Functors for basic math.
729e3d3f PE	41	Binder_functors Functors which "remember" an argument.
729e3d3f PE	42	Comparison_functors Functors wrapping built-in comparisons.
729e3d3f	43	Func_ptr_functors Functors for use with pointers to functions.
729e3d3f PE	44	Logical_functors Functors wrapping the Boolean operations.
729e3d3f PE	45	Member_ptr_functor Functors for use with pointers to members.
729e3d3f PE	46	Negation_functors Functors which negate their contents.
729e3d3f PE	47	SGIextensions A list of the extensions from the SGI STL subset.
66fda8b2	48
729e3d3f PE	49	.TE
729e3d3f PE	50	.P
04b7c941	51	The HTML documentation typically goes into much more depth.
2f9d51b8	52	.SH FILES
729e3d3f PE	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
c5504edb	72	.SS Backwards-Compatibility Headers
729e3d3f PE	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.
e63637ea	80	<strstream>
729e3d3f PE	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.
ffe94f83 PE	86	.\" Easy way to generate these columns of headers is to use GNU ls(1):
ffe94f83 PE	87	.\" ls -w 40 file1 file2... \| sed 's=[a-z_][a-z_]*=<ext/&>=g'
729e3d3f	88	.TS
66fda8b2 BK	89	lB lB.
	90	<ext/algorithm> <ext/numeric>
	91	<ext/functional> <ext/iterator>
	92	<ext/slist> <ext/rb_tree>
66fda8b2 BK	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>
729e3d3f PE	98	.TE
	99	.SS Libraries
	100	.TP
	101	.I libstdc++.a
	102	The library implementation in static archive form. If you did not configure
78a53887	103	libstdc++ to use shared libraries, this will always be used. Otherwise
729e3d3f PE	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
bd2726e0 PE	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.
729e3d3f PE	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.
2f9d51b8 PE	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
729e3d3f PE	131	for the Frequently Asked Questions, online documentation, and much, much more!
729e3d3f PE	132	.\" vim:ts=8:noet: