2013-12-29 Janus Weil <janus@gcc.gnu.org>
[official-gcc.git] / gcc / doc / gcc.texi
blob55307cd35eed330ed9c681916a5570d0fec236d7
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-2013 Free Software Foundation, Inc.
45 Permission is granted to copy, distribute and/or modify this document
46 under the terms of the GNU Free Documentation License, Version 1.3 or
47 any later version published by the Free Software Foundation; with the
48 Invariant Sections being ``Funding Free Software'', the Front-Cover
49 Texts being (a) (see below), and with the Back-Cover Texts being (b)
50 (see below).  A copy of the license is included in the section entitled
51 ``GNU Free Documentation License''.
53 (a) The FSF's Front-Cover Text is:
55      A GNU Manual
57 (b) The FSF's Back-Cover Text is:
59      You have freedom to copy and modify this GNU Manual, like GNU
60      software.  Copies published by the Free Software Foundation raise
61      funds for GNU development.
62 @end copying
63 @ifnottex
64 @dircategory Software development
65 @direntry
66 * gcc: (gcc).                  The GNU Compiler Collection.
67 * g++: (gcc).                  The GNU C++ compiler.
68 * gcov: (gcc) Gcov.            @command{gcov}---a test coverage program.
69 @end direntry
70 This file documents the use of the GNU compilers.
71 @sp 1
72 @insertcopying
73 @sp 1
74 @end ifnottex
76 @setchapternewpage odd
77 @titlepage
78 @title Using the GNU Compiler Collection
79 @versionsubtitle
80 @author Richard M. Stallman and the @sc{GCC} Developer Community
81 @page
82 @vskip 0pt plus 1filll
83 Published by:
84 @multitable @columnfractions 0.5 0.5
85 @item GNU Press
86 @tab Website: @uref{http://www.gnupress.org}
87 @item a division of the
88 @tab General: @email{press@@gnu.org}
89 @item Free Software Foundation
90 @tab Orders:  @email{sales@@gnu.org}
91 @item 51 Franklin Street, Fifth Floor
92 @tab Tel 617-542-5942
93 @item Boston, MA 02110-1301 USA
94 @tab Fax 617-542-2652
95 @end multitable
96 @sp 2
97 @ifset FSFPRINT
98 @c Update this ISBN when printing a new edition.
99 @acronym{ISBN} 1-882114-39-6
101 Cover art by Gary M. Torrisi.  Cover design by Jonathan Richard.
102 @end ifset
103 @ifclear FSFPRINT
104 Last printed October 2003 for GCC 3.3.1.@*
105 Printed copies are available for $45 each.
106 @end ifclear
107 @sp 1
108 @insertcopying
109 @end titlepage
110 @summarycontents
111 @contents
112 @page
114 @node Top, G++ and GCC,, (DIR)
115 @top Introduction
116 @cindex introduction
118 This manual documents how to use the GNU compilers,
119 as well as their features and incompatibilities, and how to report
120 bugs.  It corresponds to the compilers
121 @ifset VERSION_PACKAGE
122 @value{VERSION_PACKAGE}
123 @end ifset
124 version @value{version-GCC}.
125 The internals of the GNU compilers, including how to port them to new
126 targets and some information about how to write front ends for new
127 languages, are documented in a separate manual.  @xref{Top,,
128 Introduction, gccint, GNU Compiler Collection (GCC) Internals}.
130 @menu
131 * G++ and GCC::     You can compile C or C++ programs.
132 * Standards::       Language standards supported by GCC.
133 * Invoking GCC::    Command options supported by @samp{gcc}.
134 * C Implementation:: How GCC implements the ISO C specification.
135 * C++ Implementation:: How GCC implements the ISO C++ specification.
136 * C Extensions::    GNU extensions to the C language family.
137 * C++ Extensions::  GNU extensions to the C++ language.
138 * Objective-C::     GNU Objective-C runtime features.
139 * Compatibility::   Binary Compatibility
140 * Gcov::            @command{gcov}---a test coverage program.
141 * Trouble::         If you have trouble using GCC.
142 * Bugs::            How, why and where to report bugs.
143 * Service::         How to find suppliers of support for GCC.
144 * Contributing::    How to contribute to testing and developing GCC.
146 * Funding::         How to help assure funding for free software.
147 * GNU Project::     The GNU Project and GNU/Linux.
149 * Copying::         GNU General Public License says
150                     how you can copy and share GCC.
151 * GNU Free Documentation License:: How you can copy and share this manual.
152 * Contributors::    People who have contributed to GCC.
154 * Option Index::    Index to command line options.
155 * Keyword Index::   Index of concepts and symbol names.
156 @end menu
158 @include frontends.texi
159 @include standards.texi
160 @include invoke.texi
161 @include implement-c.texi
162 @include implement-cxx.texi
163 @include extend.texi
164 @include objc.texi
165 @include compat.texi
166 @include gcov.texi
167 @include trouble.texi
168 @include bugreport.texi
169 @include service.texi
170 @include contribute.texi
172 @include funding.texi
173 @include gnu.texi
174 @include gpl_v3.texi
176 @c ---------------------------------------------------------------------
177 @c GFDL
178 @c ---------------------------------------------------------------------
180 @include fdl.texi
182 @include contrib.texi
184 @c ---------------------------------------------------------------------
185 @c Indexes
186 @c ---------------------------------------------------------------------
188 @node Option Index
189 @unnumbered Option Index
191 GCC's command line options are indexed here without any initial @samp{-}
192 or @samp{--}.  Where an option has both positive and negative forms
193 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
194 relevant entries in the manual are indexed under the most appropriate
195 form; it may sometimes be useful to look up both forms.
197 @printindex op
199 @node Keyword Index
200 @unnumbered Keyword Index
202 @printindex cp
204 @c ---------------------------------------------------------------------
205 @c Epilogue
206 @c ---------------------------------------------------------------------
208 @bye