2018-01-10 François Dumont <fdumont@gcc.gnu.org>
[official-gcc.git] / gcc / doc / gcc.texi
blob2572eb0ab90b38605dfc87d0f92acb6f313539f6
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-2018 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 * gcov-tool: (gcc) Gcov-tool.  @command{gcov-tool}---an offline gcda profile processing program.
70 * gcov-dump: (gcc) Gcov-dump.  @command{gcov-dump}---an offline gcda and gcno profile dump tool.
71 @end direntry
72 This file documents the use of the GNU compilers.
73 @sp 1
74 @insertcopying
75 @sp 1
76 @end ifnottex
78 @setchapternewpage odd
79 @titlepage
80 @title Using the GNU Compiler Collection
81 @versionsubtitle
82 @author Richard M. Stallman and the @sc{GCC} Developer Community
83 @page
84 @vskip 0pt plus 1filll
85 Published by:
86 @multitable @columnfractions 0.5 0.5
87 @item GNU Press
88 @tab Website: @uref{http://www.gnupress.org}
89 @item a division of the
90 @tab General: @email{press@@gnu.org}
91 @item Free Software Foundation
92 @tab Orders:  @email{sales@@gnu.org}
93 @item 51 Franklin Street, Fifth Floor
94 @tab Tel 617-542-5942
95 @item Boston, MA 02110-1301 USA
96 @tab Fax 617-542-2652
97 @end multitable
98 @sp 2
99 @ifset FSFPRINT
100 @c Update this ISBN when printing a new edition.
101 @acronym{ISBN} 1-882114-39-6
103 Cover art by Gary M. Torrisi.  Cover design by Jonathan Richard.
104 @end ifset
105 @ifclear FSFPRINT
106 Last printed October 2003 for GCC 3.3.1.@*
107 Printed copies are available for $45 each.
108 @end ifclear
109 @sp 1
110 @insertcopying
111 @end titlepage
112 @summarycontents
113 @contents
114 @page
116 @node Top, G++ and GCC
117 @top Introduction
118 @cindex introduction
120 This manual documents how to use the GNU compilers,
121 as well as their features and incompatibilities, and how to report
122 bugs.  It corresponds to the compilers
123 @ifset VERSION_PACKAGE
124 @value{VERSION_PACKAGE}
125 @end ifset
126 version @value{version-GCC}.
127 The internals of the GNU compilers, including how to port them to new
128 targets and some information about how to write front ends for new
129 languages, are documented in a separate manual.  @xref{Top,,
130 Introduction, gccint, GNU Compiler Collection (GCC) Internals}.
132 @menu
133 * G++ and GCC::     You can compile C or C++ programs.
134 * Standards::       Language standards supported by GCC.
135 * Invoking GCC::    Command options supported by @samp{gcc}.
136 * C Implementation:: How GCC implements the ISO C specification.
137 * C++ Implementation:: How GCC implements the ISO C++ specification.
138 * C Extensions::    GNU extensions to the C language family.
139 * C++ Extensions::  GNU extensions to the C++ language.
140 * Objective-C::     GNU Objective-C runtime features.
141 * Compatibility::   Binary Compatibility
142 * Gcov::            @command{gcov}---a test coverage program.
143 * Gcov-tool::       @command{gcov-tool}---an offline gcda profile processing program.
144 * Gcov-dump::       @command{gcov-dump}---an offline gcda and gcno profile dump tool.
145 * Trouble::         If you have trouble using GCC.
146 * Bugs::            How, why and where to report bugs.
147 * Service::         How To Get Help with GCC
148 * Contributing::    How to contribute to testing and developing GCC.
150 * Funding::         How to help assure funding for free software.
151 * GNU Project::     The GNU Project and GNU/Linux.
153 * Copying::         GNU General Public License says
154                     how you can copy and share GCC.
155 * GNU Free Documentation License:: How you can copy and share this manual.
156 * Contributors::    People who have contributed to GCC.
158 * Option Index::    Index to command line options.
159 * Keyword Index::   Index of concepts and symbol names.
160 @end menu
162 @include frontends.texi
163 @include standards.texi
164 @include invoke.texi
165 @include implement-c.texi
166 @include implement-cxx.texi
167 @include extend.texi
168 @include objc.texi
169 @include compat.texi
170 @include gcov.texi
171 @include gcov-tool.texi
172 @include gcov-dump.texi
173 @include trouble.texi
174 @include bugreport.texi
175 @include service.texi
176 @include contribute.texi
178 @include funding.texi
179 @include gnu.texi
180 @include gpl_v3.texi
182 @c ---------------------------------------------------------------------
183 @c GFDL
184 @c ---------------------------------------------------------------------
186 @include fdl.texi
188 @include contrib.texi
190 @c ---------------------------------------------------------------------
191 @c Indexes
192 @c ---------------------------------------------------------------------
194 @node Option Index
195 @unnumbered Option Index
197 GCC's command line options are indexed here without any initial @samp{-}
198 or @samp{--}.  Where an option has both positive and negative forms
199 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
200 relevant entries in the manual are indexed under the most appropriate
201 form; it may sometimes be useful to look up both forms.
203 @printindex op
205 @node Keyword Index
206 @unnumbered Keyword Index
208 @printindex cp
210 @c ---------------------------------------------------------------------
211 @c Epilogue
212 @c ---------------------------------------------------------------------
214 @bye