2010-07-27 Paolo Carlini <paolo.carlini@oracle.com>
[official-gcc/alias-decl.git] / gcc / doc / gcc.texi
blob0e167bae004736759ae3dfbd59a70b4b71afbfe8
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename gcc.info
4 @c INTERNALS is used by md.texi to determine whether to include the
5 @c whole of that file, in the internals manual, or only the part
6 @c dealing with constraints, in the user manual.
7 @clear INTERNALS
9 @c NOTE: checks/things to do:
11 @c -have bob do a search in all seven files for "mew" (ideally --mew,
12 @c  but i may have forgotten the occasional "--"..).
13 @c     Just checked... all have `--'!  Bob 22Jul96
14 @c     Use this to search:   grep -n '\-\-mew' *.texi
15 @c -item/itemx, text after all (sub/sub)section titles, etc..
16 @c -consider putting the lists of options on pp 17--> etc in columns or
17 @c  some such.
18 @c -overfulls.  do a search for "mew" in the files, and you will see
19 @c   overfulls that i noted but could not deal with.
20 @c -have to add text:  beginning of chapter 8
23 @c anything else?                       --mew 10feb93
25 @include gcc-common.texi
27 @settitle Using the GNU Compiler Collection (GCC)
29 @c Create a separate index for command line options.
30 @defcodeindex op
31 @c Merge the standard indexes into a single one.
32 @syncodeindex fn cp
33 @syncodeindex vr cp
34 @syncodeindex ky cp
35 @syncodeindex pg cp
36 @syncodeindex tp cp
38 @paragraphindent 1
40 @c %**end of header
42 @copying
43 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
44 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
45 2010 Free Software Foundation, Inc.
47 Permission is granted to copy, distribute and/or modify this document
48 under the terms of the GNU Free Documentation License, Version 1.3 or
49 any later version published by the Free Software Foundation; with the
50 Invariant Sections being ``Funding Free Software'', the Front-Cover
51 Texts being (a) (see below), and with the Back-Cover Texts being (b)
52 (see below).  A copy of the license is included in the section entitled
53 ``GNU Free Documentation License''.
55 (a) The FSF's Front-Cover Text is:
57      A GNU Manual
59 (b) The FSF's Back-Cover Text is:
61      You have freedom to copy and modify this GNU Manual, like GNU
62      software.  Copies published by the Free Software Foundation raise
63      funds for GNU development.
64 @end copying
65 @ifnottex
66 @dircategory Software development
67 @direntry
68 * gcc: (gcc).                  The GNU Compiler Collection.
69 * g++: (gcc).                  The GNU C++ compiler.
70 @end direntry
71 This file documents the use of the GNU compilers.
72 @sp 1
73 @insertcopying
74 @sp 1
75 @end ifnottex
77 @setchapternewpage odd
78 @titlepage
79 @title Using the GNU Compiler Collection
80 @versionsubtitle
81 @author Richard M. Stallman and the @sc{GCC} Developer Community
82 @page
83 @vskip 0pt plus 1filll
84 Published by:
85 @multitable @columnfractions 0.5 0.5
86 @item GNU Press
87 @tab Website: www.gnupress.org
88 @item a division of the
89 @tab General: @tex press@@gnu.org @end tex
90 @item Free Software Foundation
91 @tab Orders:  @tex sales@@gnu.org @end tex
92 @item 51 Franklin Street, Fifth Floor
93 @tab Tel 617-542-5942
94 @item Boston, MA 02110-1301 USA
95 @tab Fax 617-542-2652
96 @end multitable
97 @sp 2
98 @ifset FSFPRINT
99 @c Update this ISBN when printing a new edition.
100 @acronym{ISBN} 1-882114-39-6
102 Cover art by Gary M. Torrisi.  Cover design by Jonathan Richard.
103 @end ifset
104 @ifclear FSFPRINT
105 Last printed October 2003 for GCC 3.3.1.@*
106 Printed copies are available for $45 each.
107 @end ifclear
108 @sp 1
109 @insertcopying
110 @end titlepage
111 @summarycontents
112 @contents
113 @page
115 @node Top, G++ and GCC,, (DIR)
116 @top Introduction
117 @cindex introduction
119 This manual documents how to use the GNU compilers,
120 as well as their features and incompatibilities, and how to report
121 bugs.  It corresponds to the compilers
122 @ifset VERSION_PACKAGE
123 @value{VERSION_PACKAGE}
124 @end ifset
125 version @value{version-GCC}.
126 The internals of the GNU compilers, including how to port them to new
127 targets and some information about how to write front ends for new
128 languages, are documented in a separate manual.  @xref{Top,,
129 Introduction, gccint, GNU Compiler Collection (GCC) Internals}.
131 @menu
132 * G++ and GCC::     You can compile C or C++ programs.
133 * Standards::       Language standards supported by GCC.
134 * Invoking GCC::    Command options supported by @samp{gcc}.
135 * C Implementation:: How GCC implements the ISO C specification.
136 * C Extensions::    GNU extensions to the C language family.
137 * C++ Implementation:: How GCC implements the ISO C++ specification.
138 * C++ Extensions::  GNU extensions to the C++ language.
139 * Objective-C::     GNU Objective-C runtime features.
140 * Compatibility::   Binary Compatibility
141 * Gcov::            @command{gcov}---a test coverage program.
142 * Trouble::         If you have trouble using GCC.
143 * Bugs::            How, why and where to report bugs.
144 * Service::         How to find suppliers of support for GCC.
145 * Contributing::    How to contribute to testing and developing GCC.
147 * Funding::         How to help assure funding for free software.
148 * GNU Project::     The GNU Project and GNU/Linux.
150 * Copying::         GNU General Public License says
151                     how you can copy and share GCC.
152 * GNU Free Documentation License:: How you can copy and share this manual.
153 * Contributors::    People who have contributed to GCC.
155 * Option Index::    Index to command line options.
156 * Keyword Index::   Index of concepts and symbol names.
157 @end menu
159 @include frontends.texi
160 @include standards.texi
161 @include invoke.texi
162 @include implement-c.texi
163 @include implement-cxx.texi
164 @include extend.texi
165 @include objc.texi
166 @include compat.texi
167 @include gcov.texi
168 @include trouble.texi
169 @include bugreport.texi
170 @include service.texi
171 @include contribute.texi
173 @include funding.texi
174 @include gnu.texi
175 @include gpl_v3.texi
177 @c ---------------------------------------------------------------------
178 @c GFDL
179 @c ---------------------------------------------------------------------
181 @include fdl.texi
183 @include contrib.texi
185 @c ---------------------------------------------------------------------
186 @c Indexes
187 @c ---------------------------------------------------------------------
189 @node Option Index
190 @unnumbered Option Index
192 GCC's command line options are indexed here without any initial @samp{-}
193 or @samp{--}.  Where an option has both positive and negative forms
194 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
195 relevant entries in the manual are indexed under the most appropriate
196 form; it may sometimes be useful to look up both forms.
198 @printindex op
200 @node Keyword Index
201 @unnumbered Keyword Index
203 @printindex cp
205 @c ---------------------------------------------------------------------
206 @c Epilogue
207 @c ---------------------------------------------------------------------
209 @bye