OSDN Git Service

2bb87440a5cd955672dfea16f4ce6f8b967272c5
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, @option{-fforce-mem},
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol  -Wselector -Wundeclared-selector}
205
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
210
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -Wextra  -Wall  -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
218 -Werror  -Werror-implicit-function-declaration @gol
219 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wno-format-extra-args -Wformat-nonliteral @gol
221 -Wformat-security  -Wformat-y2k @gol
222 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
223 -Wimport  -Wno-import  -Winit-self  -Winline @gol
224 -Wno-int-to-pointer-cast @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
232 -Wredundant-decls @gol
233 -Wreturn-type  -Wsequence-point  -Wshadow @gol
234 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
235 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
236 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
237 -Wunknown-pragmas  -Wunreachable-code @gol
238 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
239 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
240 -Wvariadic-macros}
241
242 @item C-only Warning Options
243 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
244 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
245 -Wstrict-prototypes  -Wtraditional @gol
246 -Wdeclaration-after-statement -Wno-pointer-sign}
247
248 @item Debugging Options
249 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
250 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
251 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
252 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
253 -fdump-ipa-all -fdump-ipa-cgraph @gol
254 -fdump-tree-all @gol
255 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
256 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
258 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
259 -fdump-tree-ch @gol
260 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-nrv -fdump-tree-vect @gol
269 -fdump-tree-sink @gol
270 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-salias @gol
272 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
273 -ftree-vectorizer-verbose=@var{n} @gol
274 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
275 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
276 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
277 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
278 -ftest-coverage  -ftime-report -fvar-tracking @gol
279 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
280 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
281 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
282 -print-multi-directory  -print-multi-lib @gol
283 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
284 -save-temps  -time}
285
286 @item Optimization Options
287 @xref{Optimize Options,,Options that Control Optimization}.
288 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
289 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
290 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
291 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
292 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
293 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
294 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
295 -fdelayed-branch  -fdelete-null-pointer-checks @gol
296 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
297 -fforce-addr  -fforce-mem  -ffunction-sections @gol
298 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
299 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
300 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
301 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
302 -fmodulo-sched -fno-branch-count-reg @gol
303 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
304 -fno-function-cse  -fno-guess-branch-probability @gol
305 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
306 -funsafe-math-optimizations  -ffinite-math-only @gol
307 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
308 -fomit-frame-pointer  -foptimize-register-move @gol
309 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
310 -fprofile-generate -fprofile-use @gol
311 -fregmove  -frename-registers @gol
312 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
313 -frerun-cse-after-loop  -frerun-loop-opt @gol
314 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
315 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
316 -fsched-spec-load-dangerous  @gol
317 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
318 -fsched2-use-superblocks @gol
319 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
320 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
321 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
322 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
323 -fsplit-ivs-in-unroller -funswitch-loops @gol
324 -fvariable-expansion-in-unroller @gol
325 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
326 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
327 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
328 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
329 -ftree-salias -fweb @gol
330 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop @gol
331 --param @var{name}=@var{value}
332 -O  -O0  -O1  -O2  -O3  -Os}
333
334 @item Preprocessor Options
335 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
336 @gccoptlist{-A@var{question}=@var{answer} @gol
337 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
338 -C  -dD  -dI  -dM  -dN @gol
339 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
340 -idirafter @var{dir} @gol
341 -include @var{file}  -imacros @var{file} @gol
342 -iprefix @var{file}  -iwithprefix @var{dir} @gol
343 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
344 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
345 -P  -fworking-directory  -remap @gol
346 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
347 -Xpreprocessor @var{option}}
348
349 @item Assembler Option
350 @xref{Assembler Options,,Passing Options to the Assembler}.
351 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
352
353 @item Linker Options
354 @xref{Link Options,,Options for Linking}.
355 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
356 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
357 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
358 -Wl,@var{option}  -Xlinker @var{option} @gol
359 -u @var{symbol}}
360
361 @item Directory Options
362 @xref{Directory Options,,Options for Directory Search}.
363 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
364
365 @item Target Options
366 @c I wrote this xref this way to avoid overfull hbox. -- rms
367 @xref{Target Options}.
368 @gccoptlist{-V @var{version}  -b @var{machine}}
369
370 @item Machine Dependent Options
371 @xref{Submodel Options,,Hardware Models and Configurations}.
372 @c This list is ordered alphanumerically by subsection name.
373 @c Try and put the significant identifier (CPU or system) first,
374 @c so users have a clue at guessing where the ones they want will be.
375
376 @emph{ARC Options}
377 @gccoptlist{-EB  -EL @gol
378 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
379 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
380
381 @emph{ARM Options}
382 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
383 -mabi=@var{name} @gol
384 -mapcs-stack-check  -mno-apcs-stack-check @gol
385 -mapcs-float  -mno-apcs-float @gol
386 -mapcs-reentrant  -mno-apcs-reentrant @gol
387 -msched-prolog  -mno-sched-prolog @gol
388 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
389 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
390 -mthumb-interwork  -mno-thumb-interwork @gol
391 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
392 -mstructure-size-boundary=@var{n} @gol
393 -mabort-on-noreturn @gol
394 -mlong-calls  -mno-long-calls @gol
395 -msingle-pic-base  -mno-single-pic-base @gol
396 -mpic-register=@var{reg} @gol
397 -mnop-fun-dllimport @gol
398 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
399 -mpoke-function-name @gol
400 -mthumb  -marm @gol
401 -mtpcs-frame  -mtpcs-leaf-frame @gol
402 -mcaller-super-interworking  -mcallee-super-interworking}
403
404 @emph{AVR Options}
405 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
406 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
407
408 @emph{Blackfin Options}
409 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer -mcsync @gol
410 -mno-csync -mlow-64k -mno-low64k -mid-shared-library @gol
411 -mno-id-shared-library -mshared-library-id=@var{n} @gol}
412
413 @emph{CRIS Options}
414 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
415 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
416 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
417 -mstack-align  -mdata-align  -mconst-align @gol
418 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
419 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
420 -mmul-bug-workaround  -mno-mul-bug-workaround}
421
422 @emph{Darwin Options}
423 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
424 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
425 -client_name  -compatibility_version  -current_version @gol
426 -dead_strip @gol
427 -dependency-file  -dylib_file  -dylinker_install_name @gol
428 -dynamic  -dynamiclib  -exported_symbols_list @gol
429 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
430 -force_flat_namespace  -headerpad_max_install_names @gol
431 -image_base  -init  -install_name  -keep_private_externs @gol
432 -multi_module  -multiply_defined  -multiply_defined_unused @gol
433 -noall_load   -no_dead_strip_inits_and_terms @gol
434 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
435 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
436 -private_bundle  -read_only_relocs  -sectalign @gol
437 -sectobjectsymbols  -whyload  -seg1addr @gol
438 -sectcreate  -sectobjectsymbols  -sectorder @gol
439 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
440 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
441 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
442 -single_module  -static  -sub_library  -sub_umbrella @gol
443 -twolevel_namespace  -umbrella  -undefined @gol
444 -unexported_symbols_list  -weak_reference_mismatches @gol
445 -whatsloaded -F -gused -gfull -mone-byte-bool}
446
447 @emph{DEC Alpha Options}
448 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
449 -mieee  -mieee-with-inexact  -mieee-conformant @gol
450 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
451 -mtrap-precision=@var{mode}  -mbuild-constants @gol
452 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
453 -mbwx  -mmax  -mfix  -mcix @gol
454 -mfloat-vax  -mfloat-ieee @gol
455 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
456 -msmall-text  -mlarge-text @gol
457 -mmemory-latency=@var{time}}
458
459 @emph{DEC Alpha/VMS Options}
460 @gccoptlist{-mvms-return-codes}
461
462 @emph{FRV Options}
463 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
464 -mhard-float  -msoft-float @gol
465 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
466 -mdouble  -mno-double @gol
467 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
468 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
469 -mlinked-fp  -mlong-calls  -malign-labels @gol
470 -mlibrary-pic  -macc-4  -macc-8 @gol
471 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
472 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
473 -mvliw-branch  -mno-vliw-branch @gol
474 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
475 -mno-nested-cond-exec  -mtomcat-stats @gol
476 -mTLS -mtls @gol
477 -mcpu=@var{cpu}}
478
479 @emph{H8/300 Options}
480 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
481
482 @emph{HPPA Options}
483 @gccoptlist{-march=@var{architecture-type} @gol
484 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
485 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
486 -mfixed-range=@var{register-range} @gol
487 -mjump-in-delay -mlinker-opt -mlong-calls @gol
488 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
489 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
490 -mno-jump-in-delay  -mno-long-load-store @gol
491 -mno-portable-runtime  -mno-soft-float @gol
492 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
493 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
494 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
495 -munix=@var{unix-std}  -nolibdld  -static  -threads}
496
497 @emph{i386 and x86-64 Options}
498 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
499 -mfpmath=@var{unit} @gol
500 -masm=@var{dialect}  -mno-fancy-math-387 @gol
501 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
502 -mno-wide-multiply  -mrtd  -malign-double @gol
503 -mpreferred-stack-boundary=@var{num} @gol
504 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
505 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
506 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
507 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
508 -mno-red-zone -mno-tls-direct-seg-refs @gol
509 -mcmodel=@var{code-model} @gol
510 -m32  -m64}
511
512 @emph{IA-64 Options}
513 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
514 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
515 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
516 -minline-float-divide-max-throughput @gol
517 -minline-int-divide-min-latency @gol
518 -minline-int-divide-max-throughput  @gol
519 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
520 -mno-dwarf2-asm -mearly-stop-bits @gol
521 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
522 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
523
524 @emph{M32R/D Options}
525 @gccoptlist{-m32r2 -m32rx -m32r @gol
526 -mdebug @gol
527 -malign-loops -mno-align-loops @gol
528 -missue-rate=@var{number} @gol
529 -mbranch-cost=@var{number} @gol
530 -mmodel=@var{code-size-model-type} @gol
531 -msdata=@var{sdata-type} @gol
532 -mno-flush-func -mflush-func=@var{name} @gol
533 -mno-flush-trap -mflush-trap=@var{number} @gol
534 -G @var{num}}
535
536 @emph{M680x0 Options}
537 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
538 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
539 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
540 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
541 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
542
543 @emph{M68hc1x Options}
544 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
545 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
546 -msoft-reg-count=@var{count}}
547
548 @emph{MCore Options}
549 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
550 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
551 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
552 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
553 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
554
555 @emph{MIPS Options}
556 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
557 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
558 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
559 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
560 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
561 -mpaired-single  -mips3d @gol
562 -mint64  -mlong64  -mlong32  -msym32  -mno-sym32 @gol
563 -G@var{num}  -membedded-data  -mno-embedded-data @gol
564 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
565 -msplit-addresses  -mno-split-addresses  @gol
566 -mexplicit-relocs  -mno-explicit-relocs  @gol
567 -mcheck-zero-division  -mno-check-zero-division @gol
568 -mdivide-traps  -mdivide-breaks @gol
569 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
570 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
571 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
572 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
573 -mfix-sb1  -mno-fix-sb1 @gol
574 -mflush-func=@var{func}  -mno-flush-func @gol
575 -mbranch-likely  -mno-branch-likely @gol
576 -mfp-exceptions -mno-fp-exceptions @gol
577 -mvr4130-align -mno-vr4130-align}
578
579 @emph{MMIX Options}
580 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
581 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
582 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
583 -mno-base-addresses  -msingle-exit  -mno-single-exit}
584
585 @emph{MN10300 Options}
586 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
587 -mam33  -mno-am33 @gol
588 -mam33-2  -mno-am33-2 @gol
589 -mno-crt0  -mrelax}
590
591 @emph{NS32K Options}
592 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
593 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
594 -mregparam  -mnoregparam  -msb  -mnosb @gol
595 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
596
597 @emph{PDP-11 Options}
598 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
599 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
600 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
601 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
602 -mbranch-expensive  -mbranch-cheap @gol
603 -msplit  -mno-split  -munix-asm  -mdec-asm}
604
605 @emph{PowerPC Options}
606 See RS/6000 and PowerPC Options.
607
608 @emph{RS/6000 and PowerPC Options}
609 @gccoptlist{-mcpu=@var{cpu-type} @gol
610 -mtune=@var{cpu-type} @gol
611 -mpower  -mno-power  -mpower2  -mno-power2 @gol
612 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
613 -maltivec  -mno-altivec @gol
614 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
615 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
616 -mnew-mnemonics  -mold-mnemonics @gol
617 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
618 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
619 -malign-power  -malign-natural @gol
620 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
621 -mstring  -mno-string  -mupdate  -mno-update @gol
622 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
623 -mstrict-align  -mno-strict-align  -mrelocatable @gol
624 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
625 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
626 -mdynamic-no-pic @gol
627 -mprioritize-restricted-insns=@var{priority} @gol
628 -msched-costly-dep=@var{dependence_type} @gol
629 -minsert-sched-nops=@var{scheme} @gol
630 -mcall-sysv  -mcall-netbsd @gol
631 -maix-struct-return  -msvr4-struct-return @gol
632 -mabi=altivec  -mabi=no-altivec @gol
633 -mabi=spe  -mabi=no-spe @gol
634 -misel=yes  -misel=no @gol
635 -mspe=yes  -mspe=no @gol
636 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
637 -mprototype  -mno-prototype @gol
638 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
639 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
640
641 @emph{S/390 and zSeries Options}
642 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
643 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
644 -mpacked-stack  -mno-packed-stack @gol
645 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
646 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
647 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
648 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
649
650 @emph{SH Options}
651 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
652 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
653 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
654 -m5-64media  -m5-64media-nofpu @gol
655 -m5-32media  -m5-32media-nofpu @gol
656 -m5-compact  -m5-compact-nofpu @gol
657 -mb  -ml  -mdalign  -mrelax @gol
658 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
659 -mieee  -misize  -mpadstruct  -mspace @gol
660 -mprefergot  -musermode}
661
662 @emph{SPARC Options}
663 @gccoptlist{-mcpu=@var{cpu-type} @gol
664 -mtune=@var{cpu-type} @gol
665 -mcmodel=@var{code-model} @gol
666 -m32  -m64  -mapp-regs  -mno-app-regs @gol
667 -mfaster-structs  -mno-faster-structs @gol
668 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
669 -mhard-quad-float  -msoft-quad-float @gol
670 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
671 -mstack-bias  -mno-stack-bias @gol
672 -munaligned-doubles  -mno-unaligned-doubles @gol
673 -mv8plus  -mno-v8plus  -mvis  -mno-vis
674 -threads -pthreads}
675
676 @emph{System V Options}
677 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
678
679 @emph{TMS320C3x/C4x Options}
680 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
681 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
682 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
683 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
684
685 @emph{V850 Options}
686 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
687 -mprolog-function  -mno-prolog-function  -mspace @gol
688 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
689 -mapp-regs  -mno-app-regs @gol
690 -mdisable-callt  -mno-disable-callt @gol
691 -mv850e1 @gol
692 -mv850e @gol
693 -mv850  -mbig-switch}
694
695 @emph{VAX Options}
696 @gccoptlist{-mg  -mgnu  -munix}
697
698 @emph{x86-64 Options}
699 See i386 and x86-64 Options.
700
701 @emph{Xstormy16 Options}
702 @gccoptlist{-msim}
703
704 @emph{Xtensa Options}
705 @gccoptlist{-mconst16 -mno-const16 @gol
706 -mfused-madd  -mno-fused-madd @gol
707 -mtext-section-literals  -mno-text-section-literals @gol
708 -mtarget-align  -mno-target-align @gol
709 -mlongcalls  -mno-longcalls}
710
711 @emph{zSeries Options}
712 See S/390 and zSeries Options.
713
714 @item Code Generation Options
715 @xref{Code Gen Options,,Options for Code Generation Conventions}.
716 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
717 -ffixed-@var{reg}  -fexceptions @gol
718 -fnon-call-exceptions  -funwind-tables @gol
719 -fasynchronous-unwind-tables @gol
720 -finhibit-size-directive  -finstrument-functions @gol
721 -fno-common  -fno-ident @gol
722 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
723 -freg-struct-return  -fshared-data  -fshort-enums @gol
724 -fshort-double  -fshort-wchar @gol
725 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
726 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
727 -fargument-alias  -fargument-noalias @gol
728 -fargument-noalias-global  -fleading-underscore @gol
729 -ftls-model=@var{model} @gol
730 -ftrapv  -fwrapv  -fbounds-check @gol
731 -fvisibility}
732 @end table
733
734 @menu
735 * Overall Options::     Controlling the kind of output:
736                         an executable, object files, assembler files,
737                         or preprocessed source.
738 * C Dialect Options::   Controlling the variant of C language compiled.
739 * C++ Dialect Options:: Variations on C++.
740 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
741                         and Objective-C++.
742 * Language Independent Options:: Controlling how diagnostics should be
743                         formatted.
744 * Warning Options::     How picky should the compiler be?
745 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
746 * Optimize Options::    How much optimization?
747 * Preprocessor Options:: Controlling header files and macro definitions.
748                          Also, getting dependency information for Make.
749 * Assembler Options::   Passing options to the assembler.
750 * Link Options::        Specifying libraries and so on.
751 * Directory Options::   Where to find header files and libraries.
752                         Where to find the compiler executable files.
753 * Spec Files::          How to pass switches to sub-processes.
754 * Target Options::      Running a cross-compiler, or an old version of GCC.
755 @end menu
756
757 @node Overall Options
758 @section Options Controlling the Kind of Output
759
760 Compilation can involve up to four stages: preprocessing, compilation
761 proper, assembly and linking, always in that order.  GCC is capable of
762 preprocessing and compiling several files either into several
763 assembler input files, or into one assembler input file; then each
764 assembler input file produces an object file, and linking combines all
765 the object files (those newly compiled, and those specified as input)
766 into an executable file.
767
768 @cindex file name suffix
769 For any given input file, the file name suffix determines what kind of
770 compilation is done:
771
772 @table @gcctabopt
773 @item @var{file}.c
774 C source code which must be preprocessed.
775
776 @item @var{file}.i
777 C source code which should not be preprocessed.
778
779 @item @var{file}.ii
780 C++ source code which should not be preprocessed.
781
782 @item @var{file}.m
783 Objective-C source code.  Note that you must link with the @file{libobjc}
784 library to make an Objective-C program work.
785
786 @item @var{file}.mi
787 Objective-C source code which should not be preprocessed.
788
789 @item @var{file}.mm
790 @itemx @var{file}.M
791 Objective-C++ source code.  Note that you must link with the @file{libobjc}
792 library to make an Objective-C++ program work.  Note that @samp{.M} refers
793 to a literal capital M@.
794
795 @item @var{file}.mii
796 Objective-C++ source code which should not be preprocessed.
797
798 @item @var{file}.h
799 C, C++, Objective-C or Objective-C++ header file to be turned into a
800 precompiled header.
801
802 @item @var{file}.cc
803 @itemx @var{file}.cp
804 @itemx @var{file}.cxx
805 @itemx @var{file}.cpp
806 @itemx @var{file}.CPP
807 @itemx @var{file}.c++
808 @itemx @var{file}.C
809 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
810 the last two letters must both be literally @samp{x}.  Likewise,
811 @samp{.C} refers to a literal capital C@.
812
813 @item @var{file}.hh
814 @itemx @var{file}.H
815 C++ header file to be turned into a precompiled header.
816
817 @item @var{file}.f
818 @itemx @var{file}.for
819 @itemx @var{file}.FOR
820 Fortran source code which should not be preprocessed.
821
822 @item @var{file}.F
823 @itemx @var{file}.fpp
824 @itemx @var{file}.FPP
825 Fortran source code which must be preprocessed (with the traditional
826 preprocessor).
827
828 @item @var{file}.r
829 Fortran source code which must be preprocessed with a RATFOR
830 preprocessor (not included with GCC)@.
831
832 @item @var{file}.f90
833 @itemx @var{file}.f95
834 Fortran 90/95 source code which should not be preprocessed.
835
836 @c FIXME: Descriptions of Java file types.
837 @c @var{file}.java
838 @c @var{file}.class
839 @c @var{file}.zip
840 @c @var{file}.jar
841
842 @item @var{file}.ads
843 Ada source code file which contains a library unit declaration (a
844 declaration of a package, subprogram, or generic, or a generic
845 instantiation), or a library unit renaming declaration (a package,
846 generic, or subprogram renaming declaration).  Such files are also
847 called @dfn{specs}.
848
849 @itemx @var{file}.adb
850 Ada source code file containing a library unit body (a subprogram or
851 package body).  Such files are also called @dfn{bodies}.
852
853 @c GCC also knows about some suffixes for languages not yet included:
854 @c Pascal:
855 @c @var{file}.p
856 @c @var{file}.pas
857
858 @item @var{file}.s
859 Assembler code.
860
861 @item @var{file}.S
862 Assembler code which must be preprocessed.
863
864 @item @var{other}
865 An object file to be fed straight into linking.
866 Any file name with no recognized suffix is treated this way.
867 @end table
868
869 @opindex x
870 You can specify the input language explicitly with the @option{-x} option:
871
872 @table @gcctabopt
873 @item -x @var{language}
874 Specify explicitly the @var{language} for the following input files
875 (rather than letting the compiler choose a default based on the file
876 name suffix).  This option applies to all following input files until
877 the next @option{-x} option.  Possible values for @var{language} are:
878 @smallexample
879 c  c-header  c-cpp-output
880 c++  c++-header  c++-cpp-output
881 objective-c  objective-c-header  objective-c-cpp-output
882 objective-c++ objective-c++-header objective-c++-cpp-output
883 assembler  assembler-with-cpp
884 ada
885 f77  f77-cpp-input  ratfor
886 f95
887 java
888 treelang
889 @end smallexample
890
891 @item -x none
892 Turn off any specification of a language, so that subsequent files are
893 handled according to their file name suffixes (as they are if @option{-x}
894 has not been used at all).
895
896 @item -pass-exit-codes
897 @opindex pass-exit-codes
898 Normally the @command{gcc} program will exit with the code of 1 if any
899 phase of the compiler returns a non-success return code.  If you specify
900 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
901 numerically highest error produced by any phase that returned an error
902 indication.
903 @end table
904
905 If you only want some of the stages of compilation, you can use
906 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
907 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
908 @command{gcc} is to stop.  Note that some combinations (for example,
909 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
910
911 @table @gcctabopt
912 @item -c
913 @opindex c
914 Compile or assemble the source files, but do not link.  The linking
915 stage simply is not done.  The ultimate output is in the form of an
916 object file for each source file.
917
918 By default, the object file name for a source file is made by replacing
919 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
920
921 Unrecognized input files, not requiring compilation or assembly, are
922 ignored.
923
924 @item -S
925 @opindex S
926 Stop after the stage of compilation proper; do not assemble.  The output
927 is in the form of an assembler code file for each non-assembler input
928 file specified.
929
930 By default, the assembler file name for a source file is made by
931 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
932
933 Input files that don't require compilation are ignored.
934
935 @item -E
936 @opindex E
937 Stop after the preprocessing stage; do not run the compiler proper.  The
938 output is in the form of preprocessed source code, which is sent to the
939 standard output.
940
941 Input files which don't require preprocessing are ignored.
942
943 @cindex output file option
944 @item -o @var{file}
945 @opindex o
946 Place output in file @var{file}.  This applies regardless to whatever
947 sort of output is being produced, whether it be an executable file,
948 an object file, an assembler file or preprocessed C code.
949
950 If @option{-o} is not specified, the default is to put an executable
951 file in @file{a.out}, the object file for
952 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
953 assembler file in @file{@var{source}.s}, a precompiled header file in
954 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
955 standard output.
956
957 @item -v
958 @opindex v
959 Print (on standard error output) the commands executed to run the stages
960 of compilation.  Also print the version number of the compiler driver
961 program and of the preprocessor and the compiler proper.
962
963 @item -###
964 @opindex ###
965 Like @option{-v} except the commands are not executed and all command
966 arguments are quoted.  This is useful for shell scripts to capture the
967 driver-generated command lines.
968
969 @item -pipe
970 @opindex pipe
971 Use pipes rather than temporary files for communication between the
972 various stages of compilation.  This fails to work on some systems where
973 the assembler is unable to read from a pipe; but the GNU assembler has
974 no trouble.
975
976 @item -combine
977 @opindex combine
978 If you are compiling multiple source files, this option tells the driver
979 to pass all the source files to the compiler at once (for those
980 languages for which the compiler can handle this).  This will allow
981 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
982 language for which this is supported is C@.  If you pass source files for
983 multiple languages to the driver, using this option, the driver will invoke
984 the compiler(s) that support IMA once each, passing each compiler all the
985 source files appropriate for it.  For those languages that do not support
986 IMA this option will be ignored, and the compiler will be invoked once for
987 each source file in that language.  If you use this option in conjunction
988 with @option{-save-temps}, the compiler will generate multiple
989 pre-processed files
990 (one for each source file), but only one (combined) @file{.o} or
991 @file{.s} file.
992
993 @item --help
994 @opindex help
995 Print (on the standard output) a description of the command line options
996 understood by @command{gcc}.  If the @option{-v} option is also specified
997 then @option{--help} will also be passed on to the various processes
998 invoked by @command{gcc}, so that they can display the command line options
999 they accept.  If the @option{-Wextra} option is also specified then command
1000 line options which have no documentation associated with them will also
1001 be displayed.
1002
1003 @item --target-help
1004 @opindex target-help
1005 Print (on the standard output) a description of target specific command
1006 line options for each tool.
1007
1008 @item --version
1009 @opindex version
1010 Display the version number and copyrights of the invoked GCC@.
1011 @end table
1012
1013 @node Invoking G++
1014 @section Compiling C++ Programs
1015
1016 @cindex suffixes for C++ source
1017 @cindex C++ source file suffixes
1018 C++ source files conventionally use one of the suffixes @samp{.C},
1019 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1020 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1021 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1022 files with these names and compiles them as C++ programs even if you
1023 call the compiler the same way as for compiling C programs (usually
1024 with the name @command{gcc}).
1025
1026 @findex g++
1027 @findex c++
1028 However, C++ programs often require class libraries as well as a
1029 compiler that understands the C++ language---and under some
1030 circumstances, you might want to compile programs or header files from
1031 standard input, or otherwise without a suffix that flags them as C++
1032 programs.  You might also like to precompile a C header file with a
1033 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1034 program that calls GCC with the default language set to C++, and
1035 automatically specifies linking against the C++ library.  On many
1036 systems, @command{g++} is also installed with the name @command{c++}.
1037
1038 @cindex invoking @command{g++}
1039 When you compile C++ programs, you may specify many of the same
1040 command-line options that you use for compiling programs in any
1041 language; or command-line options meaningful for C and related
1042 languages; or options that are meaningful only for C++ programs.
1043 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1044 explanations of options for languages related to C@.
1045 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1046 explanations of options that are meaningful only for C++ programs.
1047
1048 @node C Dialect Options
1049 @section Options Controlling C Dialect
1050 @cindex dialect options
1051 @cindex language dialect options
1052 @cindex options, dialect
1053
1054 The following options control the dialect of C (or languages derived
1055 from C, such as C++, Objective-C and Objective-C++) that the compiler
1056 accepts:
1057
1058 @table @gcctabopt
1059 @cindex ANSI support
1060 @cindex ISO support
1061 @item -ansi
1062 @opindex ansi
1063 In C mode, support all ISO C90 programs.  In C++ mode,
1064 remove GNU extensions that conflict with ISO C++.
1065
1066 This turns off certain features of GCC that are incompatible with ISO
1067 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1068 such as the @code{asm} and @code{typeof} keywords, and
1069 predefined macros such as @code{unix} and @code{vax} that identify the
1070 type of system you are using.  It also enables the undesirable and
1071 rarely used ISO trigraph feature.  For the C compiler,
1072 it disables recognition of C++ style @samp{//} comments as well as
1073 the @code{inline} keyword.
1074
1075 The alternate keywords @code{__asm__}, @code{__extension__},
1076 @code{__inline__} and @code{__typeof__} continue to work despite
1077 @option{-ansi}.  You would not want to use them in an ISO C program, of
1078 course, but it is useful to put them in header files that might be included
1079 in compilations done with @option{-ansi}.  Alternate predefined macros
1080 such as @code{__unix__} and @code{__vax__} are also available, with or
1081 without @option{-ansi}.
1082
1083 The @option{-ansi} option does not cause non-ISO programs to be
1084 rejected gratuitously.  For that, @option{-pedantic} is required in
1085 addition to @option{-ansi}.  @xref{Warning Options}.
1086
1087 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1088 option is used.  Some header files may notice this macro and refrain
1089 from declaring certain functions or defining certain macros that the
1090 ISO standard doesn't call for; this is to avoid interfering with any
1091 programs that might use these names for other things.
1092
1093 Functions which would normally be built in but do not have semantics
1094 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1095 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1096 built-in functions provided by GCC}, for details of the functions
1097 affected.
1098
1099 @item -std=
1100 @opindex std
1101 Determine the language standard.  This option is currently only
1102 supported when compiling C or C++.  A value for this option must be
1103 provided; possible values are
1104
1105 @table @samp
1106 @item c89
1107 @itemx iso9899:1990
1108 ISO C90 (same as @option{-ansi}).
1109
1110 @item iso9899:199409
1111 ISO C90 as modified in amendment 1.
1112
1113 @item c99
1114 @itemx c9x
1115 @itemx iso9899:1999
1116 @itemx iso9899:199x
1117 ISO C99.  Note that this standard is not yet fully supported; see
1118 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1119 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1120
1121 @item gnu89
1122 Default, ISO C90 plus GNU extensions (including some C99 features).
1123
1124 @item gnu99
1125 @itemx gnu9x
1126 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1127 this will become the default.  The name @samp{gnu9x} is deprecated.
1128
1129 @item c++98
1130 The 1998 ISO C++ standard plus amendments.
1131
1132 @item gnu++98
1133 The same as @option{-std=c++98} plus GNU extensions.  This is the
1134 default for C++ code.
1135 @end table
1136
1137 Even when this option is not specified, you can still use some of the
1138 features of newer standards in so far as they do not conflict with
1139 previous C standards.  For example, you may use @code{__restrict__} even
1140 when @option{-std=c99} is not specified.
1141
1142 The @option{-std} options specifying some version of ISO C have the same
1143 effects as @option{-ansi}, except that features that were not in ISO C90
1144 but are in the specified version (for example, @samp{//} comments and
1145 the @code{inline} keyword in ISO C99) are not disabled.
1146
1147 @xref{Standards,,Language Standards Supported by GCC}, for details of
1148 these standard versions.
1149
1150 @item -aux-info @var{filename}
1151 @opindex aux-info
1152 Output to the given filename prototyped declarations for all functions
1153 declared and/or defined in a translation unit, including those in header
1154 files.  This option is silently ignored in any language other than C@.
1155
1156 Besides declarations, the file indicates, in comments, the origin of
1157 each declaration (source file and line), whether the declaration was
1158 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1159 @samp{O} for old, respectively, in the first character after the line
1160 number and the colon), and whether it came from a declaration or a
1161 definition (@samp{C} or @samp{F}, respectively, in the following
1162 character).  In the case of function definitions, a K&R-style list of
1163 arguments followed by their declarations is also provided, inside
1164 comments, after the declaration.
1165
1166 @item -fno-asm
1167 @opindex fno-asm
1168 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1169 keyword, so that code can use these words as identifiers.  You can use
1170 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1171 instead.  @option{-ansi} implies @option{-fno-asm}.
1172
1173 In C++, this switch only affects the @code{typeof} keyword, since
1174 @code{asm} and @code{inline} are standard keywords.  You may want to
1175 use the @option{-fno-gnu-keywords} flag instead, which has the same
1176 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1177 switch only affects the @code{asm} and @code{typeof} keywords, since
1178 @code{inline} is a standard keyword in ISO C99.
1179
1180 @item -fno-builtin
1181 @itemx -fno-builtin-@var{function}
1182 @opindex fno-builtin
1183 @cindex built-in functions
1184 Don't recognize built-in functions that do not begin with
1185 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1186 functions provided by GCC}, for details of the functions affected,
1187 including those which are not built-in functions when @option{-ansi} or
1188 @option{-std} options for strict ISO C conformance are used because they
1189 do not have an ISO standard meaning.
1190
1191 GCC normally generates special code to handle certain built-in functions
1192 more efficiently; for instance, calls to @code{alloca} may become single
1193 instructions that adjust the stack directly, and calls to @code{memcpy}
1194 may become inline copy loops.  The resulting code is often both smaller
1195 and faster, but since the function calls no longer appear as such, you
1196 cannot set a breakpoint on those calls, nor can you change the behavior
1197 of the functions by linking with a different library.  In addition,
1198 when a function is recognized as a built-in function, GCC may use
1199 information about that function to warn about problems with calls to
1200 that function, or to generate more efficient code, even if the
1201 resulting code still contains calls to that function.  For example,
1202 warnings are given with @option{-Wformat} for bad calls to
1203 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1204 known not to modify global memory.
1205
1206 With the @option{-fno-builtin-@var{function}} option
1207 only the built-in function @var{function} is
1208 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1209 function is named this is not built-in in this version of GCC, this
1210 option is ignored.  There is no corresponding
1211 @option{-fbuiltin-@var{function}} option; if you wish to enable
1212 built-in functions selectively when using @option{-fno-builtin} or
1213 @option{-ffreestanding}, you may define macros such as:
1214
1215 @smallexample
1216 #define abs(n)          __builtin_abs ((n))
1217 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1218 @end smallexample
1219
1220 @item -fhosted
1221 @opindex fhosted
1222 @cindex hosted environment
1223
1224 Assert that compilation takes place in a hosted environment.  This implies
1225 @option{-fbuiltin}.  A hosted environment is one in which the
1226 entire standard library is available, and in which @code{main} has a return
1227 type of @code{int}.  Examples are nearly everything except a kernel.
1228 This is equivalent to @option{-fno-freestanding}.
1229
1230 @item -ffreestanding
1231 @opindex ffreestanding
1232 @cindex hosted environment
1233
1234 Assert that compilation takes place in a freestanding environment.  This
1235 implies @option{-fno-builtin}.  A freestanding environment
1236 is one in which the standard library may not exist, and program startup may
1237 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1238 This is equivalent to @option{-fno-hosted}.
1239
1240 @xref{Standards,,Language Standards Supported by GCC}, for details of
1241 freestanding and hosted environments.
1242
1243 @item -fms-extensions
1244 @opindex fms-extensions
1245 Accept some non-standard constructs used in Microsoft header files.
1246
1247 Some cases of unnamed fields in structures and unions are only
1248 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1249 fields within structs/unions}, for details.
1250
1251 @item -trigraphs
1252 @opindex trigraphs
1253 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1254 options for strict ISO C conformance) implies @option{-trigraphs}.
1255
1256 @item -no-integrated-cpp
1257 @opindex no-integrated-cpp
1258 Performs a compilation in two passes: preprocessing and compiling.  This
1259 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1260 @option{-B} option.  The user supplied compilation step can then add in
1261 an additional preprocessing step after normal preprocessing but before
1262 compiling.  The default is to use the integrated cpp (internal cpp)
1263
1264 The semantics of this option will change if "cc1", "cc1plus", and
1265 "cc1obj" are merged.
1266
1267 @cindex traditional C language
1268 @cindex C language, traditional
1269 @item -traditional
1270 @itemx -traditional-cpp
1271 @opindex traditional-cpp
1272 @opindex traditional
1273 Formerly, these options caused GCC to attempt to emulate a pre-standard
1274 C compiler.  They are now only supported with the @option{-E} switch.
1275 The preprocessor continues to support a pre-standard mode.  See the GNU
1276 CPP manual for details.
1277
1278 @item -fcond-mismatch
1279 @opindex fcond-mismatch
1280 Allow conditional expressions with mismatched types in the second and
1281 third arguments.  The value of such an expression is void.  This option
1282 is not supported for C++.
1283
1284 @item -funsigned-char
1285 @opindex funsigned-char
1286 Let the type @code{char} be unsigned, like @code{unsigned char}.
1287
1288 Each kind of machine has a default for what @code{char} should
1289 be.  It is either like @code{unsigned char} by default or like
1290 @code{signed char} by default.
1291
1292 Ideally, a portable program should always use @code{signed char} or
1293 @code{unsigned char} when it depends on the signedness of an object.
1294 But many programs have been written to use plain @code{char} and
1295 expect it to be signed, or expect it to be unsigned, depending on the
1296 machines they were written for.  This option, and its inverse, let you
1297 make such a program work with the opposite default.
1298
1299 The type @code{char} is always a distinct type from each of
1300 @code{signed char} or @code{unsigned char}, even though its behavior
1301 is always just like one of those two.
1302
1303 @item -fsigned-char
1304 @opindex fsigned-char
1305 Let the type @code{char} be signed, like @code{signed char}.
1306
1307 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1308 the negative form of @option{-funsigned-char}.  Likewise, the option
1309 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1310
1311 @item -fsigned-bitfields
1312 @itemx -funsigned-bitfields
1313 @itemx -fno-signed-bitfields
1314 @itemx -fno-unsigned-bitfields
1315 @opindex fsigned-bitfields
1316 @opindex funsigned-bitfields
1317 @opindex fno-signed-bitfields
1318 @opindex fno-unsigned-bitfields
1319 These options control whether a bit-field is signed or unsigned, when the
1320 declaration does not use either @code{signed} or @code{unsigned}.  By
1321 default, such a bit-field is signed, because this is consistent: the
1322 basic integer types such as @code{int} are signed types.
1323 @end table
1324
1325 @node C++ Dialect Options
1326 @section Options Controlling C++ Dialect
1327
1328 @cindex compiler options, C++
1329 @cindex C++ options, command line
1330 @cindex options, C++
1331 This section describes the command-line options that are only meaningful
1332 for C++ programs; but you can also use most of the GNU compiler options
1333 regardless of what language your program is in.  For example, you
1334 might compile a file @code{firstClass.C} like this:
1335
1336 @smallexample
1337 g++ -g -frepo -O -c firstClass.C
1338 @end smallexample
1339
1340 @noindent
1341 In this example, only @option{-frepo} is an option meant
1342 only for C++ programs; you can use the other options with any
1343 language supported by GCC@.
1344
1345 Here is a list of options that are @emph{only} for compiling C++ programs:
1346
1347 @table @gcctabopt
1348
1349 @item -fabi-version=@var{n}
1350 @opindex fabi-version
1351 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1352 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1353 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1354 the version that conforms most closely to the C++ ABI specification.
1355 Therefore, the ABI obtained using version 0 will change as ABI bugs
1356 are fixed.
1357
1358 The default is version 2.
1359
1360 @item -fno-access-control
1361 @opindex fno-access-control
1362 Turn off all access checking.  This switch is mainly useful for working
1363 around bugs in the access control code.
1364
1365 @item -fcheck-new
1366 @opindex fcheck-new
1367 Check that the pointer returned by @code{operator new} is non-null
1368 before attempting to modify the storage allocated.  This check is
1369 normally unnecessary because the C++ standard specifies that
1370 @code{operator new} will only return @code{0} if it is declared
1371 @samp{throw()}, in which case the compiler will always check the
1372 return value even without this option.  In all other cases, when
1373 @code{operator new} has a non-empty exception specification, memory
1374 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1375 @samp{new (nothrow)}.
1376
1377 @item -fconserve-space
1378 @opindex fconserve-space
1379 Put uninitialized or runtime-initialized global variables into the
1380 common segment, as C does.  This saves space in the executable at the
1381 cost of not diagnosing duplicate definitions.  If you compile with this
1382 flag and your program mysteriously crashes after @code{main()} has
1383 completed, you may have an object that is being destroyed twice because
1384 two definitions were merged.
1385
1386 This option is no longer useful on most targets, now that support has
1387 been added for putting variables into BSS without making them common.
1388
1389 @item -fno-const-strings
1390 @opindex fno-const-strings
1391 Give string constants type @code{char *} instead of type @code{const
1392 char *}.  By default, G++ uses type @code{const char *} as required by
1393 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1394 actually modify the value of a string constant.
1395
1396 This option might be removed in a future release of G++.  For maximum
1397 portability, you should structure your code so that it works with
1398 string constants that have type @code{const char *}.
1399
1400 @item -fno-elide-constructors
1401 @opindex fno-elide-constructors
1402 The C++ standard allows an implementation to omit creating a temporary
1403 which is only used to initialize another object of the same type.
1404 Specifying this option disables that optimization, and forces G++ to
1405 call the copy constructor in all cases.
1406
1407 @item -fno-enforce-eh-specs
1408 @opindex fno-enforce-eh-specs
1409 Don't check for violation of exception specifications at runtime.  This
1410 option violates the C++ standard, but may be useful for reducing code
1411 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1412 will still optimize based on the exception specifications.
1413
1414 @item -ffor-scope
1415 @itemx -fno-for-scope
1416 @opindex ffor-scope
1417 @opindex fno-for-scope
1418 If @option{-ffor-scope} is specified, the scope of variables declared in
1419 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1420 as specified by the C++ standard.
1421 If @option{-fno-for-scope} is specified, the scope of variables declared in
1422 a @i{for-init-statement} extends to the end of the enclosing scope,
1423 as was the case in old versions of G++, and other (traditional)
1424 implementations of C++.
1425
1426 The default if neither flag is given to follow the standard,
1427 but to allow and give a warning for old-style code that would
1428 otherwise be invalid, or have different behavior.
1429
1430 @item -fno-gnu-keywords
1431 @opindex fno-gnu-keywords
1432 Do not recognize @code{typeof} as a keyword, so that code can use this
1433 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1434 @option{-ansi} implies @option{-fno-gnu-keywords}.
1435
1436 @item -fno-implicit-templates
1437 @opindex fno-implicit-templates
1438 Never emit code for non-inline templates which are instantiated
1439 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1440 @xref{Template Instantiation}, for more information.
1441
1442 @item -fno-implicit-inline-templates
1443 @opindex fno-implicit-inline-templates
1444 Don't emit code for implicit instantiations of inline templates, either.
1445 The default is to handle inlines differently so that compiles with and
1446 without optimization will need the same set of explicit instantiations.
1447
1448 @item -fno-implement-inlines
1449 @opindex fno-implement-inlines
1450 To save space, do not emit out-of-line copies of inline functions
1451 controlled by @samp{#pragma implementation}.  This will cause linker
1452 errors if these functions are not inlined everywhere they are called.
1453
1454 @item -fms-extensions
1455 @opindex fms-extensions
1456 Disable pedantic warnings about constructs used in MFC, such as implicit
1457 int and getting a pointer to member function via non-standard syntax.
1458
1459 @item -fno-nonansi-builtins
1460 @opindex fno-nonansi-builtins
1461 Disable built-in declarations of functions that are not mandated by
1462 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1463 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1464
1465 @item -fno-operator-names
1466 @opindex fno-operator-names
1467 Do not treat the operator name keywords @code{and}, @code{bitand},
1468 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1469 synonyms as keywords.
1470
1471 @item -fno-optional-diags
1472 @opindex fno-optional-diags
1473 Disable diagnostics that the standard says a compiler does not need to
1474 issue.  Currently, the only such diagnostic issued by G++ is the one for
1475 a name having multiple meanings within a class.
1476
1477 @item -fpermissive
1478 @opindex fpermissive
1479 Downgrade some diagnostics about nonconformant code from errors to
1480 warnings.  Thus, using @option{-fpermissive} will allow some
1481 nonconforming code to compile.
1482
1483 @item -frepo
1484 @opindex frepo
1485 Enable automatic template instantiation at link time.  This option also
1486 implies @option{-fno-implicit-templates}.  @xref{Template
1487 Instantiation}, for more information.
1488
1489 @item -fno-rtti
1490 @opindex fno-rtti
1491 Disable generation of information about every class with virtual
1492 functions for use by the C++ runtime type identification features
1493 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1494 of the language, you can save some space by using this flag.  Note that
1495 exception handling uses the same information, but it will generate it as
1496 needed.
1497
1498 @item -fstats
1499 @opindex fstats
1500 Emit statistics about front-end processing at the end of the compilation.
1501 This information is generally only useful to the G++ development team.
1502
1503 @item -ftemplate-depth-@var{n}
1504 @opindex ftemplate-depth
1505 Set the maximum instantiation depth for template classes to @var{n}.
1506 A limit on the template instantiation depth is needed to detect
1507 endless recursions during template class instantiation.  ANSI/ISO C++
1508 conforming programs must not rely on a maximum depth greater than 17.
1509
1510 @item -fno-threadsafe-statics
1511 @opindex fno-threadsafe-statics
1512 Do not emit the extra code to use the routines specified in the C++
1513 ABI for thread-safe initialization of local statics.  You can use this
1514 option to reduce code size slightly in code that doesn't need to be
1515 thread-safe.
1516
1517 @item -fuse-cxa-atexit
1518 @opindex fuse-cxa-atexit
1519 Register destructors for objects with static storage duration with the
1520 @code{__cxa_atexit} function rather than the @code{atexit} function.
1521 This option is required for fully standards-compliant handling of static
1522 destructors, but will only work if your C library supports
1523 @code{__cxa_atexit}.
1524
1525 @item -fvisibility-inlines-hidden
1526 @opindex fvisibility-inlines-hidden
1527 Causes all inlined methods to be marked with
1528 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1529 appear in the export table of a DSO and do not require a PLT indirection
1530 when used within the DSO@.  Enabling this option can have a dramatic effect
1531 on load and link times of a DSO as it massively reduces the size of the
1532 dynamic export table when the library makes heavy use of templates.  While
1533 it can cause bloating through duplication of code within each DSO where
1534 it is used, often the wastage is less than the considerable space occupied
1535 by a long symbol name in the export table which is typical when using
1536 templates and namespaces.  For even more savings, combine with the
1537 @option{-fvisibility=hidden} switch.
1538
1539 @item -fno-weak
1540 @opindex fno-weak
1541 Do not use weak symbol support, even if it is provided by the linker.
1542 By default, G++ will use weak symbols if they are available.  This
1543 option exists only for testing, and should not be used by end-users;
1544 it will result in inferior code and has no benefits.  This option may
1545 be removed in a future release of G++.
1546
1547 @item -nostdinc++
1548 @opindex nostdinc++
1549 Do not search for header files in the standard directories specific to
1550 C++, but do still search the other standard directories.  (This option
1551 is used when building the C++ library.)
1552 @end table
1553
1554 In addition, these optimization, warning, and code generation options
1555 have meanings only for C++ programs:
1556
1557 @table @gcctabopt
1558 @item -fno-default-inline
1559 @opindex fno-default-inline
1560 Do not assume @samp{inline} for functions defined inside a class scope.
1561 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1562 functions will have linkage like inline functions; they just won't be
1563 inlined by default.
1564
1565 @item -Wabi @r{(C++ only)}
1566 @opindex Wabi
1567 Warn when G++ generates code that is probably not compatible with the
1568 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1569 all such cases, there are probably some cases that are not warned about,
1570 even though G++ is generating incompatible code.  There may also be
1571 cases where warnings are emitted even though the code that is generated
1572 will be compatible.
1573
1574 You should rewrite your code to avoid these warnings if you are
1575 concerned about the fact that code generated by G++ may not be binary
1576 compatible with code generated by other compilers.
1577
1578 The known incompatibilities at this point include:
1579
1580 @itemize @bullet
1581
1582 @item
1583 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1584 pack data into the same byte as a base class.  For example:
1585
1586 @smallexample
1587 struct A @{ virtual void f(); int f1 : 1; @};
1588 struct B : public A @{ int f2 : 1; @};
1589 @end smallexample
1590
1591 @noindent
1592 In this case, G++ will place @code{B::f2} into the same byte
1593 as@code{A::f1}; other compilers will not.  You can avoid this problem
1594 by explicitly padding @code{A} so that its size is a multiple of the
1595 byte size on your platform; that will cause G++ and other compilers to
1596 layout @code{B} identically.
1597
1598 @item
1599 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1600 tail padding when laying out virtual bases.  For example:
1601
1602 @smallexample
1603 struct A @{ virtual void f(); char c1; @};
1604 struct B @{ B(); char c2; @};
1605 struct C : public A, public virtual B @{@};
1606 @end smallexample
1607
1608 @noindent
1609 In this case, G++ will not place @code{B} into the tail-padding for
1610 @code{A}; other compilers will.  You can avoid this problem by
1611 explicitly padding @code{A} so that its size is a multiple of its
1612 alignment (ignoring virtual base classes); that will cause G++ and other
1613 compilers to layout @code{C} identically.
1614
1615 @item
1616 Incorrect handling of bit-fields with declared widths greater than that
1617 of their underlying types, when the bit-fields appear in a union.  For
1618 example:
1619
1620 @smallexample
1621 union U @{ int i : 4096; @};
1622 @end smallexample
1623
1624 @noindent
1625 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1626 union too small by the number of bits in an @code{int}.
1627
1628 @item
1629 Empty classes can be placed at incorrect offsets.  For example:
1630
1631 @smallexample
1632 struct A @{@};
1633
1634 struct B @{
1635   A a;
1636   virtual void f ();
1637 @};
1638
1639 struct C : public B, public A @{@};
1640 @end smallexample
1641
1642 @noindent
1643 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1644 it should be placed at offset zero.  G++ mistakenly believes that the
1645 @code{A} data member of @code{B} is already at offset zero.
1646
1647 @item
1648 Names of template functions whose types involve @code{typename} or
1649 template template parameters can be mangled incorrectly.
1650
1651 @smallexample
1652 template <typename Q>
1653 void f(typename Q::X) @{@}
1654
1655 template <template <typename> class Q>
1656 void f(typename Q<int>::X) @{@}
1657 @end smallexample
1658
1659 @noindent
1660 Instantiations of these templates may be mangled incorrectly.
1661
1662 @end itemize
1663
1664 @item -Wctor-dtor-privacy @r{(C++ only)}
1665 @opindex Wctor-dtor-privacy
1666 Warn when a class seems unusable because all the constructors or
1667 destructors in that class are private, and it has neither friends nor
1668 public static member functions.
1669
1670 @item -Wnon-virtual-dtor @r{(C++ only)}
1671 @opindex Wnon-virtual-dtor
1672 Warn when a class appears to be polymorphic, thereby requiring a virtual
1673 destructor, yet it declares a non-virtual one.
1674 This warning is enabled by @option{-Wall}.
1675
1676 @item -Wreorder @r{(C++ only)}
1677 @opindex Wreorder
1678 @cindex reordering, warning
1679 @cindex warning for reordering of member initializers
1680 Warn when the order of member initializers given in the code does not
1681 match the order in which they must be executed.  For instance:
1682
1683 @smallexample
1684 struct A @{
1685   int i;
1686   int j;
1687   A(): j (0), i (1) @{ @}
1688 @};
1689 @end smallexample
1690
1691 The compiler will rearrange the member initializers for @samp{i}
1692 and @samp{j} to match the declaration order of the members, emitting
1693 a warning to that effect.  This warning is enabled by @option{-Wall}.
1694 @end table
1695
1696 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1697
1698 @table @gcctabopt
1699 @item -Weffc++ @r{(C++ only)}
1700 @opindex Weffc++
1701 Warn about violations of the following style guidelines from Scott Meyers'
1702 @cite{Effective C++} book:
1703
1704 @itemize @bullet
1705 @item
1706 Item 11:  Define a copy constructor and an assignment operator for classes
1707 with dynamically allocated memory.
1708
1709 @item
1710 Item 12:  Prefer initialization to assignment in constructors.
1711
1712 @item
1713 Item 14:  Make destructors virtual in base classes.
1714
1715 @item
1716 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1717
1718 @item
1719 Item 23:  Don't try to return a reference when you must return an object.
1720
1721 @end itemize
1722
1723 Also warn about violations of the following style guidelines from
1724 Scott Meyers' @cite{More Effective C++} book:
1725
1726 @itemize @bullet
1727 @item
1728 Item 6:  Distinguish between prefix and postfix forms of increment and
1729 decrement operators.
1730
1731 @item
1732 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1733
1734 @end itemize
1735
1736 When selecting this option, be aware that the standard library
1737 headers do not obey all of these guidelines; use @samp{grep -v}
1738 to filter out those warnings.
1739
1740 @item -Wno-deprecated @r{(C++ only)}
1741 @opindex Wno-deprecated
1742 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1743
1744 @item -Wstrict-null-sentinel @r{(C++ only)}
1745 @opindex Wstrict-null-sentinel
1746 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1747 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1748 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1749 it is guaranteed to of the same size as a pointer.  But this use is
1750 not portable across different compilers.
1751
1752 @item -Wno-non-template-friend @r{(C++ only)}
1753 @opindex Wno-non-template-friend
1754 Disable warnings when non-templatized friend functions are declared
1755 within a template.  Since the advent of explicit template specification
1756 support in G++, if the name of the friend is an unqualified-id (i.e.,
1757 @samp{friend foo(int)}), the C++ language specification demands that the
1758 friend declare or define an ordinary, nontemplate function.  (Section
1759 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1760 could be interpreted as a particular specialization of a templatized
1761 function.  Because this non-conforming behavior is no longer the default
1762 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1763 check existing code for potential trouble spots and is on by default.
1764 This new compiler behavior can be turned off with
1765 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1766 but disables the helpful warning.
1767
1768 @item -Wold-style-cast @r{(C++ only)}
1769 @opindex Wold-style-cast
1770 Warn if an old-style (C-style) cast to a non-void type is used within
1771 a C++ program.  The new-style casts (@samp{static_cast},
1772 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1773 unintended effects and much easier to search for.
1774
1775 @item -Woverloaded-virtual @r{(C++ only)}
1776 @opindex Woverloaded-virtual
1777 @cindex overloaded virtual fn, warning
1778 @cindex warning for overloaded virtual fn
1779 Warn when a function declaration hides virtual functions from a
1780 base class.  For example, in:
1781
1782 @smallexample
1783 struct A @{
1784   virtual void f();
1785 @};
1786
1787 struct B: public A @{
1788   void f(int);
1789 @};
1790 @end smallexample
1791
1792 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1793 like:
1794
1795 @smallexample
1796 B* b;
1797 b->f();
1798 @end smallexample
1799
1800 will fail to compile.
1801
1802 @item -Wno-pmf-conversions @r{(C++ only)}
1803 @opindex Wno-pmf-conversions
1804 Disable the diagnostic for converting a bound pointer to member function
1805 to a plain pointer.
1806
1807 @item -Wsign-promo @r{(C++ only)}
1808 @opindex Wsign-promo
1809 Warn when overload resolution chooses a promotion from unsigned or
1810 enumerated type to a signed type, over a conversion to an unsigned type of
1811 the same size.  Previous versions of G++ would try to preserve
1812 unsignedness, but the standard mandates the current behavior.
1813
1814 @smallexample
1815 struct A @{
1816   operator int ();
1817   A& operator = (int);
1818 @};
1819
1820 main ()
1821 @{
1822   A a,b;
1823   a = b;
1824 @}
1825 @end smallexample
1826
1827 In this example, G++ will synthesize a default @samp{A& operator =
1828 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1829 @end table
1830
1831 @node Objective-C and Objective-C++ Dialect Options
1832 @section Options Controlling Objective-C and Objective-C++ Dialects
1833
1834 @cindex compiler options, Objective-C and Objective-C++
1835 @cindex Objective-C and Objective-C++ options, command line
1836 @cindex options, Objective-C and Objective-C++
1837 (NOTE: This manual does not describe the Objective-C and Objective-C++
1838 languages themselves.  See @xref{Standards,,Language Standards
1839 Supported by GCC}, for references.)
1840
1841 This section describes the command-line options that are only meaningful
1842 for Objective-C and Objective-C++ programs, but you can also use most of
1843 the language-independent GNU compiler options.
1844 For example, you might compile a file @code{some_class.m} like this:
1845
1846 @smallexample
1847 gcc -g -fgnu-runtime -O -c some_class.m
1848 @end smallexample
1849
1850 @noindent
1851 In this example, @option{-fgnu-runtime} is an option meant only for
1852 Objective-C and Objective-C++ programs; you can use the other options with
1853 any language supported by GCC@.
1854
1855 Note that since Objective-C is an extension of the C language, Objective-C
1856 compilations may also use options specific to the C front-end (e.g.,
1857 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1858 C++-specific options (e.g., @option{-Wabi}).
1859
1860 Here is a list of options that are @emph{only} for compiling Objective-C
1861 and Objective-C++ programs:
1862
1863 @table @gcctabopt
1864 @item -fconstant-string-class=@var{class-name}
1865 @opindex fconstant-string-class
1866 Use @var{class-name} as the name of the class to instantiate for each
1867 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1868 class name is @code{NXConstantString} if the GNU runtime is being used, and
1869 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1870 @option{-fconstant-cfstrings} option, if also present, will override the
1871 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1872 to be laid out as constant CoreFoundation strings.
1873
1874 @item -fgnu-runtime
1875 @opindex fgnu-runtime
1876 Generate object code compatible with the standard GNU Objective-C
1877 runtime.  This is the default for most types of systems.
1878
1879 @item -fnext-runtime
1880 @opindex fnext-runtime
1881 Generate output compatible with the NeXT runtime.  This is the default
1882 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1883 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1884 used.
1885
1886 @item -fno-nil-receivers
1887 @opindex fno-nil-receivers
1888 Assume that all Objective-C message dispatches (e.g.,
1889 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1890 is not @code{nil}.  This allows for more efficient entry points in the runtime
1891 to be used.  Currently, this option is only available in conjunction with
1892 the NeXT runtime on Mac OS X 10.3 and later.
1893
1894 @item -fobjc-exceptions
1895 @opindex fobjc-exceptions
1896 Enable syntactic support for structured exception handling in Objective-C,
1897 similar to what is offered by C++ and Java.  Currently, this option is only
1898 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1899
1900 @smallexample
1901   @@try @{
1902     @dots{}
1903        @@throw expr;
1904     @dots{}
1905   @}
1906   @@catch (AnObjCClass *exc) @{
1907     @dots{}
1908       @@throw expr;
1909     @dots{}
1910       @@throw;
1911     @dots{}
1912   @}
1913   @@catch (AnotherClass *exc) @{
1914     @dots{}
1915   @}
1916   @@catch (id allOthers) @{
1917     @dots{}
1918   @}
1919   @@finally @{
1920     @dots{}
1921       @@throw expr;
1922     @dots{}
1923   @}
1924 @end smallexample
1925
1926 The @code{@@throw} statement may appear anywhere in an Objective-C or
1927 Objective-C++ program; when used inside of a @code{@@catch} block, the
1928 @code{@@throw} may appear without an argument (as shown above), in which case
1929 the object caught by the @code{@@catch} will be rethrown.
1930
1931 Note that only (pointers to) Objective-C objects may be thrown and
1932 caught using this scheme.  When an object is thrown, it will be caught
1933 by the nearest @code{@@catch} clause capable of handling objects of that type,
1934 analogously to how @code{catch} blocks work in C++ and Java.  A
1935 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1936 any and all Objective-C exceptions not caught by previous @code{@@catch}
1937 clauses (if any).
1938
1939 The @code{@@finally} clause, if present, will be executed upon exit from the
1940 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1941 regardless of whether any exceptions are thrown, caught or rethrown
1942 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1943 of the @code{finally} clause in Java.
1944
1945 There are several caveats to using the new exception mechanism:
1946
1947 @itemize @bullet
1948 @item
1949 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1950 idioms provided by the @code{NSException} class, the new
1951 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1952 systems, due to additional functionality needed in the (NeXT) Objective-C
1953 runtime.
1954
1955 @item
1956 As mentioned above, the new exceptions do not support handling
1957 types other than Objective-C objects.   Furthermore, when used from
1958 Objective-C++, the Objective-C exception model does not interoperate with C++
1959 exceptions at this time.  This means you cannot @code{@@throw} an exception
1960 from Objective-C and @code{catch} it in C++, or vice versa
1961 (i.e., @code{throw @dots{} @@catch}).
1962 @end itemize
1963
1964 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1965 blocks for thread-safe execution:
1966
1967 @smallexample
1968   @@synchronized (ObjCClass *guard) @{
1969     @dots{}
1970   @}
1971 @end smallexample
1972
1973 Upon entering the @code{@@synchronized} block, a thread of execution shall
1974 first check whether a lock has been placed on the corresponding @code{guard}
1975 object by another thread.  If it has, the current thread shall wait until
1976 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1977 the current thread will place its own lock on it, execute the code contained in
1978 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1979 making @code{guard} available to other threads).
1980
1981 Unlike Java, Objective-C does not allow for entire methods to be marked
1982 @code{@@synchronized}.  Note that throwing exceptions out of
1983 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1984 to be unlocked properly.
1985
1986 @item -freplace-objc-classes
1987 @opindex freplace-objc-classes
1988 Emit a special marker instructing @command{ld(1)} not to statically link in
1989 the resulting object file, and allow @command{dyld(1)} to load it in at
1990 run time instead.  This is used in conjunction with the Fix-and-Continue
1991 debugging mode, where the object file in question may be recompiled and
1992 dynamically reloaded in the course of program execution, without the need
1993 to restart the program itself.  Currently, Fix-and-Continue functionality
1994 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1995 and later.
1996
1997 @item -fzero-link
1998 @opindex fzero-link
1999 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2000 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2001 compile time) with static class references that get initialized at load time,
2002 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2003 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2004 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2005 for individual class implementations to be modified during program execution.
2006
2007 @item -gen-decls
2008 @opindex gen-decls
2009 Dump interface declarations for all classes seen in the source file to a
2010 file named @file{@var{sourcename}.decl}.
2011
2012 @item -Wno-protocol
2013 @opindex Wno-protocol
2014 If a class is declared to implement a protocol, a warning is issued for
2015 every method in the protocol that is not implemented by the class.  The
2016 default behavior is to issue a warning for every method not explicitly
2017 implemented in the class, even if a method implementation is inherited
2018 from the superclass.  If you use the @option{-Wno-protocol} option, then
2019 methods inherited from the superclass are considered to be implemented,
2020 and no warning is issued for them.
2021
2022 @item -Wselector
2023 @opindex Wselector
2024 Warn if multiple methods of different types for the same selector are
2025 found during compilation.  The check is performed on the list of methods
2026 in the final stage of compilation.  Additionally, a check is performed
2027 for each selector appearing in a @code{@@selector(@dots{})}
2028 expression, and a corresponding method for that selector has been found
2029 during compilation.  Because these checks scan the method table only at
2030 the end of compilation, these warnings are not produced if the final
2031 stage of compilation is not reached, for example because an error is
2032 found during compilation, or because the @option{-fsyntax-only} option is
2033 being used.
2034
2035 @item -Wundeclared-selector
2036 @opindex Wundeclared-selector
2037 Warn if a @code{@@selector(@dots{})} expression referring to an
2038 undeclared selector is found.  A selector is considered undeclared if no
2039 method with that name has been declared before the
2040 @code{@@selector(@dots{})} expression, either explicitly in an
2041 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2042 an @code{@@implementation} section.  This option always performs its
2043 checks as soon as a @code{@@selector(@dots{})} expression is found,
2044 while @option{-Wselector} only performs its checks in the final stage of
2045 compilation.  This also enforces the coding style convention
2046 that methods and selectors must be declared before being used.
2047
2048 @item -print-objc-runtime-info
2049 @opindex print-objc-runtime-info
2050 Generate C header describing the largest structure that is passed by
2051 value, if any.
2052
2053 @end table
2054
2055 @node Language Independent Options
2056 @section Options to Control Diagnostic Messages Formatting
2057 @cindex options to control diagnostics formatting
2058 @cindex diagnostic messages
2059 @cindex message formatting
2060
2061 Traditionally, diagnostic messages have been formatted irrespective of
2062 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2063 below can be used to control the diagnostic messages formatting
2064 algorithm, e.g.@: how many characters per line, how often source location
2065 information should be reported.  Right now, only the C++ front end can
2066 honor these options.  However it is expected, in the near future, that
2067 the remaining front ends would be able to digest them correctly.
2068
2069 @table @gcctabopt
2070 @item -fmessage-length=@var{n}
2071 @opindex fmessage-length
2072 Try to format error messages so that they fit on lines of about @var{n}
2073 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2074 the front ends supported by GCC@.  If @var{n} is zero, then no
2075 line-wrapping will be done; each error message will appear on a single
2076 line.
2077
2078 @opindex fdiagnostics-show-location
2079 @item -fdiagnostics-show-location=once
2080 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2081 reporter to emit @emph{once} source location information; that is, in
2082 case the message is too long to fit on a single physical line and has to
2083 be wrapped, the source location won't be emitted (as prefix) again,
2084 over and over, in subsequent continuation lines.  This is the default
2085 behavior.
2086
2087 @item -fdiagnostics-show-location=every-line
2088 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2089 messages reporter to emit the same source location information (as
2090 prefix) for physical lines that result from the process of breaking
2091 a message which is too long to fit on a single line.
2092
2093 @end table
2094
2095 @node Warning Options
2096 @section Options to Request or Suppress Warnings
2097 @cindex options to control warnings
2098 @cindex warning messages
2099 @cindex messages, warning
2100 @cindex suppressing warnings
2101
2102 Warnings are diagnostic messages that report constructions which
2103 are not inherently erroneous but which are risky or suggest there
2104 may have been an error.
2105
2106 You can request many specific warnings with options beginning @samp{-W},
2107 for example @option{-Wimplicit} to request warnings on implicit
2108 declarations.  Each of these specific warning options also has a
2109 negative form beginning @samp{-Wno-} to turn off warnings;
2110 for example, @option{-Wno-implicit}.  This manual lists only one of the
2111 two forms, whichever is not the default.
2112
2113 The following options control the amount and kinds of warnings produced
2114 by GCC; for further, language-specific options also refer to
2115 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2116 Options}.
2117
2118 @table @gcctabopt
2119 @cindex syntax checking
2120 @item -fsyntax-only
2121 @opindex fsyntax-only
2122 Check the code for syntax errors, but don't do anything beyond that.
2123
2124 @item -pedantic
2125 @opindex pedantic
2126 Issue all the warnings demanded by strict ISO C and ISO C++;
2127 reject all programs that use forbidden extensions, and some other
2128 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2129 version of the ISO C standard specified by any @option{-std} option used.
2130
2131 Valid ISO C and ISO C++ programs should compile properly with or without
2132 this option (though a rare few will require @option{-ansi} or a
2133 @option{-std} option specifying the required version of ISO C)@.  However,
2134 without this option, certain GNU extensions and traditional C and C++
2135 features are supported as well.  With this option, they are rejected.
2136
2137 @option{-pedantic} does not cause warning messages for use of the
2138 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2139 warnings are also disabled in the expression that follows
2140 @code{__extension__}.  However, only system header files should use
2141 these escape routes; application programs should avoid them.
2142 @xref{Alternate Keywords}.
2143
2144 Some users try to use @option{-pedantic} to check programs for strict ISO
2145 C conformance.  They soon find that it does not do quite what they want:
2146 it finds some non-ISO practices, but not all---only those for which
2147 ISO C @emph{requires} a diagnostic, and some others for which
2148 diagnostics have been added.
2149
2150 A feature to report any failure to conform to ISO C might be useful in
2151 some instances, but would require considerable additional work and would
2152 be quite different from @option{-pedantic}.  We don't have plans to
2153 support such a feature in the near future.
2154
2155 Where the standard specified with @option{-std} represents a GNU
2156 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2157 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2158 extended dialect is based.  Warnings from @option{-pedantic} are given
2159 where they are required by the base standard.  (It would not make sense
2160 for such warnings to be given only for features not in the specified GNU
2161 C dialect, since by definition the GNU dialects of C include all
2162 features the compiler supports with the given option, and there would be
2163 nothing to warn about.)
2164
2165 @item -pedantic-errors
2166 @opindex pedantic-errors
2167 Like @option{-pedantic}, except that errors are produced rather than
2168 warnings.
2169
2170 @item -w
2171 @opindex w
2172 Inhibit all warning messages.
2173
2174 @item -Wno-import
2175 @opindex Wno-import
2176 Inhibit warning messages about the use of @samp{#import}.
2177
2178 @item -Wchar-subscripts
2179 @opindex Wchar-subscripts
2180 Warn if an array subscript has type @code{char}.  This is a common cause
2181 of error, as programmers often forget that this type is signed on some
2182 machines.
2183 This warning is enabled by @option{-Wall}.
2184
2185 @item -Wcomment
2186 @opindex Wcomment
2187 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2188 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2189 This warning is enabled by @option{-Wall}.
2190
2191 @item -Wfatal-errors
2192 @opindex Wfatal-errors
2193 This option causes the compiler to abort compilation on the first error
2194 occurred rather than trying to keep going and printing further error
2195 messages.
2196
2197 @item -Wformat
2198 @opindex Wformat
2199 @opindex ffreestanding
2200 @opindex fno-builtin
2201 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2202 the arguments supplied have types appropriate to the format string
2203 specified, and that the conversions specified in the format string make
2204 sense.  This includes standard functions, and others specified by format
2205 attributes (@pxref{Function Attributes}), in the @code{printf},
2206 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2207 not in the C standard) families (or other target-specific families).
2208 Which functions are checked without format attributes having been
2209 specified depends on the standard version selected, and such checks of
2210 functions without the attribute specified are disabled by
2211 @option{-ffreestanding} or @option{-fno-builtin}.
2212
2213 The formats are checked against the format features supported by GNU
2214 libc version 2.2.  These include all ISO C90 and C99 features, as well
2215 as features from the Single Unix Specification and some BSD and GNU
2216 extensions.  Other library implementations may not support all these
2217 features; GCC does not support warning about features that go beyond a
2218 particular library's limitations.  However, if @option{-pedantic} is used
2219 with @option{-Wformat}, warnings will be given about format features not
2220 in the selected standard version (but not for @code{strfmon} formats,
2221 since those are not in any version of the C standard).  @xref{C Dialect
2222 Options,,Options Controlling C Dialect}.
2223
2224 Since @option{-Wformat} also checks for null format arguments for
2225 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2226
2227 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2228 aspects of format checking, the options @option{-Wformat-y2k},
2229 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2230 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2231 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2232
2233 @item -Wformat-y2k
2234 @opindex Wformat-y2k
2235 If @option{-Wformat} is specified, also warn about @code{strftime}
2236 formats which may yield only a two-digit year.
2237
2238 @item -Wno-format-extra-args
2239 @opindex Wno-format-extra-args
2240 If @option{-Wformat} is specified, do not warn about excess arguments to a
2241 @code{printf} or @code{scanf} format function.  The C standard specifies
2242 that such arguments are ignored.
2243
2244 Where the unused arguments lie between used arguments that are
2245 specified with @samp{$} operand number specifications, normally
2246 warnings are still given, since the implementation could not know what
2247 type to pass to @code{va_arg} to skip the unused arguments.  However,
2248 in the case of @code{scanf} formats, this option will suppress the
2249 warning if the unused arguments are all pointers, since the Single
2250 Unix Specification says that such unused arguments are allowed.
2251
2252 @item -Wno-format-zero-length
2253 @opindex Wno-format-zero-length
2254 If @option{-Wformat} is specified, do not warn about zero-length formats.
2255 The C standard specifies that zero-length formats are allowed.
2256
2257 @item -Wformat-nonliteral
2258 @opindex Wformat-nonliteral
2259 If @option{-Wformat} is specified, also warn if the format string is not a
2260 string literal and so cannot be checked, unless the format function
2261 takes its format arguments as a @code{va_list}.
2262
2263 @item -Wformat-security
2264 @opindex Wformat-security
2265 If @option{-Wformat} is specified, also warn about uses of format
2266 functions that represent possible security problems.  At present, this
2267 warns about calls to @code{printf} and @code{scanf} functions where the
2268 format string is not a string literal and there are no format arguments,
2269 as in @code{printf (foo);}.  This may be a security hole if the format
2270 string came from untrusted input and contains @samp{%n}.  (This is
2271 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2272 in future warnings may be added to @option{-Wformat-security} that are not
2273 included in @option{-Wformat-nonliteral}.)
2274
2275 @item -Wformat=2
2276 @opindex Wformat=2
2277 Enable @option{-Wformat} plus format checks not included in
2278 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2279 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2280
2281 @item -Wnonnull
2282 @opindex Wnonnull
2283 Warn about passing a null pointer for arguments marked as
2284 requiring a non-null value by the @code{nonnull} function attribute.
2285
2286 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2287 can be disabled with the @option{-Wno-nonnull} option.
2288
2289 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2290 @opindex Winit-self
2291 Warn about uninitialized variables which are initialized with themselves.
2292 Note this option can only be used with the @option{-Wuninitialized} option,
2293 which in turn only works with @option{-O1} and above.
2294
2295 For example, GCC will warn about @code{i} being uninitialized in the
2296 following snippet only when @option{-Winit-self} has been specified:
2297 @smallexample
2298 @group
2299 int f()
2300 @{
2301   int i = i;
2302   return i;
2303 @}
2304 @end group
2305 @end smallexample
2306
2307 @item -Wimplicit-int
2308 @opindex Wimplicit-int
2309 Warn when a declaration does not specify a type.
2310 This warning is enabled by @option{-Wall}.
2311
2312 @item -Wimplicit-function-declaration
2313 @itemx -Werror-implicit-function-declaration
2314 @opindex Wimplicit-function-declaration
2315 @opindex Werror-implicit-function-declaration
2316 Give a warning (or error) whenever a function is used before being
2317 declared.  The form @option{-Wno-error-implicit-function-declaration}
2318 is not supported.
2319 This warning is enabled by @option{-Wall} (as a warning, not an error).
2320
2321 @item -Wimplicit
2322 @opindex Wimplicit
2323 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2324 This warning is enabled by @option{-Wall}.
2325
2326 @item -Wmain
2327 @opindex Wmain
2328 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2329 function with external linkage, returning int, taking either zero
2330 arguments, two, or three arguments of appropriate types.
2331 This warning is enabled by @option{-Wall}.
2332
2333 @item -Wmissing-braces
2334 @opindex Wmissing-braces
2335 Warn if an aggregate or union initializer is not fully bracketed.  In
2336 the following example, the initializer for @samp{a} is not fully
2337 bracketed, but that for @samp{b} is fully bracketed.
2338
2339 @smallexample
2340 int a[2][2] = @{ 0, 1, 2, 3 @};
2341 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2342 @end smallexample
2343
2344 This warning is enabled by @option{-Wall}.
2345
2346 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2347 @opindex Wmissing-include-dirs
2348 Warn if a user-supplied include directory does not exist.
2349
2350 @item -Wparentheses
2351 @opindex Wparentheses
2352 Warn if parentheses are omitted in certain contexts, such
2353 as when there is an assignment in a context where a truth value
2354 is expected, or when operators are nested whose precedence people
2355 often get confused about.  Only the warning for an assignment used as
2356 a truth value is supported when compiling C++; the other warnings are
2357 only supported when compiling C@.
2358
2359 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2360 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2361 interpretation from that of ordinary mathematical notation.
2362
2363 Also warn about constructions where there may be confusion to which
2364 @code{if} statement an @code{else} branch belongs.  Here is an example of
2365 such a case:
2366
2367 @smallexample
2368 @group
2369 @{
2370   if (a)
2371     if (b)
2372       foo ();
2373   else
2374     bar ();
2375 @}
2376 @end group
2377 @end smallexample
2378
2379 In C, every @code{else} branch belongs to the innermost possible @code{if}
2380 statement, which in this example is @code{if (b)}.  This is often not
2381 what the programmer expected, as illustrated in the above example by
2382 indentation the programmer chose.  When there is the potential for this
2383 confusion, GCC will issue a warning when this flag is specified.
2384 To eliminate the warning, add explicit braces around the innermost
2385 @code{if} statement so there is no way the @code{else} could belong to
2386 the enclosing @code{if}.  The resulting code would look like this:
2387
2388 @smallexample
2389 @group
2390 @{
2391   if (a)
2392     @{
2393       if (b)
2394         foo ();
2395       else
2396         bar ();
2397     @}
2398 @}
2399 @end group
2400 @end smallexample
2401
2402 This warning is enabled by @option{-Wall}.
2403
2404 @item -Wsequence-point
2405 @opindex Wsequence-point
2406 Warn about code that may have undefined semantics because of violations
2407 of sequence point rules in the C standard.
2408
2409 The C standard defines the order in which expressions in a C program are
2410 evaluated in terms of @dfn{sequence points}, which represent a partial
2411 ordering between the execution of parts of the program: those executed
2412 before the sequence point, and those executed after it.  These occur
2413 after the evaluation of a full expression (one which is not part of a
2414 larger expression), after the evaluation of the first operand of a
2415 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2416 function is called (but after the evaluation of its arguments and the
2417 expression denoting the called function), and in certain other places.
2418 Other than as expressed by the sequence point rules, the order of
2419 evaluation of subexpressions of an expression is not specified.  All
2420 these rules describe only a partial order rather than a total order,
2421 since, for example, if two functions are called within one expression
2422 with no sequence point between them, the order in which the functions
2423 are called is not specified.  However, the standards committee have
2424 ruled that function calls do not overlap.
2425
2426 It is not specified when between sequence points modifications to the
2427 values of objects take effect.  Programs whose behavior depends on this
2428 have undefined behavior; the C standard specifies that ``Between the
2429 previous and next sequence point an object shall have its stored value
2430 modified at most once by the evaluation of an expression.  Furthermore,
2431 the prior value shall be read only to determine the value to be
2432 stored.''.  If a program breaks these rules, the results on any
2433 particular implementation are entirely unpredictable.
2434
2435 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2436 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2437 diagnosed by this option, and it may give an occasional false positive
2438 result, but in general it has been found fairly effective at detecting
2439 this sort of problem in programs.
2440
2441 The present implementation of this option only works for C programs.  A
2442 future implementation may also work for C++ programs.
2443
2444 The C standard is worded confusingly, therefore there is some debate
2445 over the precise meaning of the sequence point rules in subtle cases.
2446 Links to discussions of the problem, including proposed formal
2447 definitions, may be found on the GCC readings page, at
2448 @w{@uref{http://gcc.gnu.org/readings.html}}.
2449
2450 This warning is enabled by @option{-Wall}.
2451
2452 @item -Wreturn-type
2453 @opindex Wreturn-type
2454 Warn whenever a function is defined with a return-type that defaults to
2455 @code{int}.  Also warn about any @code{return} statement with no
2456 return-value in a function whose return-type is not @code{void}.
2457
2458 For C, also warn if the return type of a function has a type qualifier
2459 such as @code{const}.  Such a type qualifier has no effect, since the
2460 value returned by a function is not an lvalue.  ISO C prohibits
2461 qualified @code{void} return types on function definitions, so such
2462 return types always receive a warning even without this option.
2463
2464 For C++, a function without return type always produces a diagnostic
2465 message, even when @option{-Wno-return-type} is specified.  The only
2466 exceptions are @samp{main} and functions defined in system headers.
2467
2468 This warning is enabled by @option{-Wall}.
2469
2470 @item -Wswitch
2471 @opindex Wswitch
2472 Warn whenever a @code{switch} statement has an index of enumerated type
2473 and lacks a @code{case} for one or more of the named codes of that
2474 enumeration.  (The presence of a @code{default} label prevents this
2475 warning.)  @code{case} labels outside the enumeration range also
2476 provoke warnings when this option is used.
2477 This warning is enabled by @option{-Wall}.
2478
2479 @item -Wswitch-default
2480 @opindex Wswitch-switch
2481 Warn whenever a @code{switch} statement does not have a @code{default}
2482 case.
2483
2484 @item -Wswitch-enum
2485 @opindex Wswitch-enum
2486 Warn whenever a @code{switch} statement has an index of enumerated type
2487 and lacks a @code{case} for one or more of the named codes of that
2488 enumeration.  @code{case} labels outside the enumeration range also
2489 provoke warnings when this option is used.
2490
2491 @item -Wtrigraphs
2492 @opindex Wtrigraphs
2493 Warn if any trigraphs are encountered that might change the meaning of
2494 the program (trigraphs within comments are not warned about).
2495 This warning is enabled by @option{-Wall}.
2496
2497 @item -Wunused-function
2498 @opindex Wunused-function
2499 Warn whenever a static function is declared but not defined or a
2500 non\-inline static function is unused.
2501 This warning is enabled by @option{-Wall}.
2502
2503 @item -Wunused-label
2504 @opindex Wunused-label
2505 Warn whenever a label is declared but not used.
2506 This warning is enabled by @option{-Wall}.
2507
2508 To suppress this warning use the @samp{unused} attribute
2509 (@pxref{Variable Attributes}).
2510
2511 @item -Wunused-parameter
2512 @opindex Wunused-parameter
2513 Warn whenever a function parameter is unused aside from its declaration.
2514
2515 To suppress this warning use the @samp{unused} attribute
2516 (@pxref{Variable Attributes}).
2517
2518 @item -Wunused-variable
2519 @opindex Wunused-variable
2520 Warn whenever a local variable or non-constant static variable is unused
2521 aside from its declaration
2522 This warning is enabled by @option{-Wall}.
2523
2524 To suppress this warning use the @samp{unused} attribute
2525 (@pxref{Variable Attributes}).
2526
2527 @item -Wunused-value
2528 @opindex Wunused-value
2529 Warn whenever a statement computes a result that is explicitly not used.
2530 This warning is enabled by @option{-Wall}.
2531
2532 To suppress this warning cast the expression to @samp{void}.
2533
2534 @item -Wunused
2535 @opindex Wunused
2536 All the above @option{-Wunused} options combined.
2537
2538 In order to get a warning about an unused function parameter, you must
2539 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2540 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2541
2542 @item -Wuninitialized
2543 @opindex Wuninitialized
2544 Warn if an automatic variable is used without first being initialized or
2545 if a variable may be clobbered by a @code{setjmp} call.
2546
2547 These warnings are possible only in optimizing compilation,
2548 because they require data flow information that is computed only
2549 when optimizing.  If you don't specify @option{-O}, you simply won't
2550 get these warnings.
2551
2552 If you want to warn about code which uses the uninitialized value of the
2553 variable in its own initializer, use the @option{-Winit-self} option.
2554
2555 These warnings occur only for variables that are candidates for
2556 register allocation.  Therefore, they do not occur for a variable that
2557 is declared @code{volatile}, or whose address is taken, or whose size
2558 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2559 structures, unions or arrays, even when they are in registers.
2560
2561 Note that there may be no warning about a variable that is used only
2562 to compute a value that itself is never used, because such
2563 computations may be deleted by data flow analysis before the warnings
2564 are printed.
2565
2566 These warnings are made optional because GCC is not smart
2567 enough to see all the reasons why the code might be correct
2568 despite appearing to have an error.  Here is one example of how
2569 this can happen:
2570
2571 @smallexample
2572 @group
2573 @{
2574   int x;
2575   switch (y)
2576     @{
2577     case 1: x = 1;
2578       break;
2579     case 2: x = 4;
2580       break;
2581     case 3: x = 5;
2582     @}
2583   foo (x);
2584 @}
2585 @end group
2586 @end smallexample
2587
2588 @noindent
2589 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2590 always initialized, but GCC doesn't know this.  Here is
2591 another common case:
2592
2593 @smallexample
2594 @{
2595   int save_y;
2596   if (change_y) save_y = y, y = new_y;
2597   @dots{}
2598   if (change_y) y = save_y;
2599 @}
2600 @end smallexample
2601
2602 @noindent
2603 This has no bug because @code{save_y} is used only if it is set.
2604
2605 @cindex @code{longjmp} warnings
2606 This option also warns when a non-volatile automatic variable might be
2607 changed by a call to @code{longjmp}.  These warnings as well are possible
2608 only in optimizing compilation.
2609
2610 The compiler sees only the calls to @code{setjmp}.  It cannot know
2611 where @code{longjmp} will be called; in fact, a signal handler could
2612 call it at any point in the code.  As a result, you may get a warning
2613 even when there is in fact no problem because @code{longjmp} cannot
2614 in fact be called at the place which would cause a problem.
2615
2616 Some spurious warnings can be avoided if you declare all the functions
2617 you use that never return as @code{noreturn}.  @xref{Function
2618 Attributes}.
2619
2620 This warning is enabled by @option{-Wall}.
2621
2622 @item -Wunknown-pragmas
2623 @opindex Wunknown-pragmas
2624 @cindex warning for unknown pragmas
2625 @cindex unknown pragmas, warning
2626 @cindex pragmas, warning of unknown
2627 Warn when a #pragma directive is encountered which is not understood by
2628 GCC@.  If this command line option is used, warnings will even be issued
2629 for unknown pragmas in system header files.  This is not the case if
2630 the warnings were only enabled by the @option{-Wall} command line option.
2631
2632 @item -Wstrict-aliasing
2633 @opindex Wstrict-aliasing
2634 This option is only active when @option{-fstrict-aliasing} is active.
2635 It warns about code which might break the strict aliasing rules that the
2636 compiler is using for optimization.  The warning does not catch all
2637 cases, but does attempt to catch the more common pitfalls.  It is
2638 included in @option{-Wall}.
2639
2640 @item -Wstrict-aliasing=2
2641 @opindex Wstrict-aliasing=2
2642 This option is only active when @option{-fstrict-aliasing} is active.
2643 It warns about all code which might break the strict aliasing rules that the
2644 compiler is using for optimization.  This warning catches all cases, but
2645 it will also give a warning for some ambiguous cases that are safe.
2646
2647 @item -Wall
2648 @opindex Wall
2649 All of the above @samp{-W} options combined.  This enables all the
2650 warnings about constructions that some users consider questionable, and
2651 that are easy to avoid (or modify to prevent the warning), even in
2652 conjunction with macros.  This also enables some language-specific
2653 warnings described in @ref{C++ Dialect Options} and
2654 @ref{Objective-C and Objective-C++ Dialect Options}.
2655 @end table
2656
2657 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2658 Some of them warn about constructions that users generally do not
2659 consider questionable, but which occasionally you might wish to check
2660 for; others warn about constructions that are necessary or hard to avoid
2661 in some cases, and there is no simple way to modify the code to suppress
2662 the warning.
2663
2664 @table @gcctabopt
2665 @item -Wextra
2666 @opindex W
2667 @opindex Wextra
2668 (This option used to be called @option{-W}.  The older name is still
2669 supported, but the newer name is more descriptive.)  Print extra warning
2670 messages for these events:
2671
2672 @itemize @bullet
2673 @item
2674 A function can return either with or without a value.  (Falling
2675 off the end of the function body is considered returning without
2676 a value.)  For example, this function would evoke such a
2677 warning:
2678
2679 @smallexample
2680 @group
2681 foo (a)
2682 @{
2683   if (a > 0)
2684     return a;
2685 @}
2686 @end group
2687 @end smallexample
2688
2689 @item
2690 An expression-statement or the left-hand side of a comma expression
2691 contains no side effects.
2692 To suppress the warning, cast the unused expression to void.
2693 For example, an expression such as @samp{x[i,j]} will cause a warning,
2694 but @samp{x[(void)i,j]} will not.
2695
2696 @item
2697 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2698
2699 @item
2700 Storage-class specifiers like @code{static} are not the first things in
2701 a declaration.  According to the C Standard, this usage is obsolescent.
2702
2703 @item
2704 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2705 arguments.
2706
2707 @item
2708 A comparison between signed and unsigned values could produce an
2709 incorrect result when the signed value is converted to unsigned.
2710 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2711
2712 @item
2713 An aggregate has an initializer which does not initialize all members.
2714 This warning can be independently controlled by
2715 @option{-Wmissing-field-initializers}.
2716
2717 @item
2718 A function parameter is declared without a type specifier in K&R-style
2719 functions:
2720
2721 @smallexample
2722 void foo(bar) @{ @}
2723 @end smallexample
2724
2725 @item
2726 An empty body occurs in an @samp{if} or @samp{else} statement.
2727
2728 @item
2729 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2730 @samp{>}, or @samp{>=}.
2731
2732 @item
2733 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2734
2735 @item
2736 Any of several floating-point events that often indicate errors, such as
2737 overflow, underflow, loss of precision, etc.
2738
2739 @item @r{(C++ only)}
2740 An enumerator and a non-enumerator both appear in a conditional expression.
2741
2742 @item @r{(C++ only)}
2743 A non-static reference or non-static @samp{const} member appears in a
2744 class without constructors.
2745
2746 @item @r{(C++ only)}
2747 Ambiguous virtual bases.
2748
2749 @item @r{(C++ only)}
2750 Subscripting an array which has been declared @samp{register}.
2751
2752 @item @r{(C++ only)}
2753 Taking the address of a variable which has been declared @samp{register}.
2754
2755 @item @r{(C++ only)}
2756 A base class is not initialized in a derived class' copy constructor.
2757 @end itemize
2758
2759 @item -Wno-div-by-zero
2760 @opindex Wno-div-by-zero
2761 @opindex Wdiv-by-zero
2762 Do not warn about compile-time integer division by zero.  Floating point
2763 division by zero is not warned about, as it can be a legitimate way of
2764 obtaining infinities and NaNs.
2765
2766 @item -Wsystem-headers
2767 @opindex Wsystem-headers
2768 @cindex warnings from system headers
2769 @cindex system headers, warnings from
2770 Print warning messages for constructs found in system header files.
2771 Warnings from system headers are normally suppressed, on the assumption
2772 that they usually do not indicate real problems and would only make the
2773 compiler output harder to read.  Using this command line option tells
2774 GCC to emit warnings from system headers as if they occurred in user
2775 code.  However, note that using @option{-Wall} in conjunction with this
2776 option will @emph{not} warn about unknown pragmas in system
2777 headers---for that, @option{-Wunknown-pragmas} must also be used.
2778
2779 @item -Wfloat-equal
2780 @opindex Wfloat-equal
2781 Warn if floating point values are used in equality comparisons.
2782
2783 The idea behind this is that sometimes it is convenient (for the
2784 programmer) to consider floating-point values as approximations to
2785 infinitely precise real numbers.  If you are doing this, then you need
2786 to compute (by analyzing the code, or in some other way) the maximum or
2787 likely maximum error that the computation introduces, and allow for it
2788 when performing comparisons (and when producing output, but that's a
2789 different problem).  In particular, instead of testing for equality, you
2790 would check to see whether the two values have ranges that overlap; and
2791 this is done with the relational operators, so equality comparisons are
2792 probably mistaken.
2793
2794 @item -Wtraditional @r{(C only)}
2795 @opindex Wtraditional
2796 Warn about certain constructs that behave differently in traditional and
2797 ISO C@.  Also warn about ISO C constructs that have no traditional C
2798 equivalent, and/or problematic constructs which should be avoided.
2799
2800 @itemize @bullet
2801 @item
2802 Macro parameters that appear within string literals in the macro body.
2803 In traditional C macro replacement takes place within string literals,
2804 but does not in ISO C@.
2805
2806 @item
2807 In traditional C, some preprocessor directives did not exist.
2808 Traditional preprocessors would only consider a line to be a directive
2809 if the @samp{#} appeared in column 1 on the line.  Therefore
2810 @option{-Wtraditional} warns about directives that traditional C
2811 understands but would ignore because the @samp{#} does not appear as the
2812 first character on the line.  It also suggests you hide directives like
2813 @samp{#pragma} not understood by traditional C by indenting them.  Some
2814 traditional implementations would not recognize @samp{#elif}, so it
2815 suggests avoiding it altogether.
2816
2817 @item
2818 A function-like macro that appears without arguments.
2819
2820 @item
2821 The unary plus operator.
2822
2823 @item
2824 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2825 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2826 constants.)  Note, these suffixes appear in macros defined in the system
2827 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2828 Use of these macros in user code might normally lead to spurious
2829 warnings, however GCC's integrated preprocessor has enough context to
2830 avoid warning in these cases.
2831
2832 @item
2833 A function declared external in one block and then used after the end of
2834 the block.
2835
2836 @item
2837 A @code{switch} statement has an operand of type @code{long}.
2838
2839 @item
2840 A non-@code{static} function declaration follows a @code{static} one.
2841 This construct is not accepted by some traditional C compilers.
2842
2843 @item
2844 The ISO type of an integer constant has a different width or
2845 signedness from its traditional type.  This warning is only issued if
2846 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2847 typically represent bit patterns, are not warned about.
2848
2849 @item
2850 Usage of ISO string concatenation is detected.
2851
2852 @item
2853 Initialization of automatic aggregates.
2854
2855 @item
2856 Identifier conflicts with labels.  Traditional C lacks a separate
2857 namespace for labels.
2858
2859 @item
2860 Initialization of unions.  If the initializer is zero, the warning is
2861 omitted.  This is done under the assumption that the zero initializer in
2862 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2863 initializer warnings and relies on default initialization to zero in the
2864 traditional C case.
2865
2866 @item
2867 Conversions by prototypes between fixed/floating point values and vice
2868 versa.  The absence of these prototypes when compiling with traditional
2869 C would cause serious problems.  This is a subset of the possible
2870 conversion warnings, for the full set use @option{-Wconversion}.
2871
2872 @item
2873 Use of ISO C style function definitions.  This warning intentionally is
2874 @emph{not} issued for prototype declarations or variadic functions
2875 because these ISO C features will appear in your code when using
2876 libiberty's traditional C compatibility macros, @code{PARAMS} and
2877 @code{VPARAMS}.  This warning is also bypassed for nested functions
2878 because that feature is already a GCC extension and thus not relevant to
2879 traditional C compatibility.
2880 @end itemize
2881
2882 @item -Wdeclaration-after-statement @r{(C only)}
2883 @opindex Wdeclaration-after-statement
2884 Warn when a declaration is found after a statement in a block.  This
2885 construct, known from C++, was introduced with ISO C99 and is by default
2886 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2887 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2888
2889 @item -Wundef
2890 @opindex Wundef
2891 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2892
2893 @item -Wno-endif-labels
2894 @opindex Wno-endif-labels
2895 @opindex Wendif-labels
2896 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2897
2898 @item -Wshadow
2899 @opindex Wshadow
2900 Warn whenever a local variable shadows another local variable, parameter or
2901 global variable or whenever a built-in function is shadowed.
2902
2903 @item -Wlarger-than-@var{len}
2904 @opindex Wlarger-than
2905 Warn whenever an object of larger than @var{len} bytes is defined.
2906
2907 @item -Wpointer-arith
2908 @opindex Wpointer-arith
2909 Warn about anything that depends on the ``size of'' a function type or
2910 of @code{void}.  GNU C assigns these types a size of 1, for
2911 convenience in calculations with @code{void *} pointers and pointers
2912 to functions.
2913
2914 @item -Wbad-function-cast @r{(C only)}
2915 @opindex Wbad-function-cast
2916 Warn whenever a function call is cast to a non-matching type.
2917 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2918
2919 @item -Wcast-qual
2920 @opindex Wcast-qual
2921 Warn whenever a pointer is cast so as to remove a type qualifier from
2922 the target type.  For example, warn if a @code{const char *} is cast
2923 to an ordinary @code{char *}.
2924
2925 @item -Wcast-align
2926 @opindex Wcast-align
2927 Warn whenever a pointer is cast such that the required alignment of the
2928 target is increased.  For example, warn if a @code{char *} is cast to
2929 an @code{int *} on machines where integers can only be accessed at
2930 two- or four-byte boundaries.
2931
2932 @item -Wwrite-strings
2933 @opindex Wwrite-strings
2934 When compiling C, give string constants the type @code{const
2935 char[@var{length}]} so that
2936 copying the address of one into a non-@code{const} @code{char *}
2937 pointer will get a warning; when compiling C++, warn about the
2938 deprecated conversion from string constants to @code{char *}.
2939 These warnings will help you find at
2940 compile time code that can try to write into a string constant, but
2941 only if you have been very careful about using @code{const} in
2942 declarations and prototypes.  Otherwise, it will just be a nuisance;
2943 this is why we did not make @option{-Wall} request these warnings.
2944
2945 @item -Wconversion
2946 @opindex Wconversion
2947 Warn if a prototype causes a type conversion that is different from what
2948 would happen to the same argument in the absence of a prototype.  This
2949 includes conversions of fixed point to floating and vice versa, and
2950 conversions changing the width or signedness of a fixed point argument
2951 except when the same as the default promotion.
2952
2953 Also, warn if a negative integer constant expression is implicitly
2954 converted to an unsigned type.  For example, warn about the assignment
2955 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2956 casts like @code{(unsigned) -1}.
2957
2958 @item -Wsign-compare
2959 @opindex Wsign-compare
2960 @cindex warning for comparison of signed and unsigned values
2961 @cindex comparison of signed and unsigned values, warning
2962 @cindex signed and unsigned values, comparison warning
2963 Warn when a comparison between signed and unsigned values could produce
2964 an incorrect result when the signed value is converted to unsigned.
2965 This warning is also enabled by @option{-Wextra}; to get the other warnings
2966 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2967
2968 @item -Waggregate-return
2969 @opindex Waggregate-return
2970 Warn if any functions that return structures or unions are defined or
2971 called.  (In languages where you can return an array, this also elicits
2972 a warning.)
2973
2974 @item -Wstrict-prototypes @r{(C only)}
2975 @opindex Wstrict-prototypes
2976 Warn if a function is declared or defined without specifying the
2977 argument types.  (An old-style function definition is permitted without
2978 a warning if preceded by a declaration which specifies the argument
2979 types.)
2980
2981 @item -Wold-style-definition @r{(C only)}
2982 @opindex Wold-style-definition
2983 Warn if an old-style function definition is used.  A warning is given
2984 even if there is a previous prototype.
2985
2986 @item -Wmissing-prototypes @r{(C only)}
2987 @opindex Wmissing-prototypes
2988 Warn if a global function is defined without a previous prototype
2989 declaration.  This warning is issued even if the definition itself
2990 provides a prototype.  The aim is to detect global functions that fail
2991 to be declared in header files.
2992
2993 @item -Wmissing-declarations @r{(C only)}
2994 @opindex Wmissing-declarations
2995 Warn if a global function is defined without a previous declaration.
2996 Do so even if the definition itself provides a prototype.
2997 Use this option to detect global functions that are not declared in
2998 header files.
2999
3000 @item -Wmissing-field-initializers
3001 @opindex Wmissing-field-initializers
3002 @opindex W
3003 @opindex Wextra
3004 Warn if a structure's initializer has some fields missing.  For
3005 example, the following code would cause such a warning, because
3006 @code{x.h} is implicitly zero:
3007
3008 @smallexample
3009 struct s @{ int f, g, h; @};
3010 struct s x = @{ 3, 4 @};
3011 @end smallexample
3012
3013 This option does not warn about designated initializers, so the following
3014 modification would not trigger a warning:
3015
3016 @smallexample
3017 struct s @{ int f, g, h; @};
3018 struct s x = @{ .f = 3, .g = 4 @};
3019 @end smallexample
3020
3021 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3022 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3023
3024 @item -Wmissing-noreturn
3025 @opindex Wmissing-noreturn
3026 Warn about functions which might be candidates for attribute @code{noreturn}.
3027 Note these are only possible candidates, not absolute ones.  Care should
3028 be taken to manually verify functions actually do not ever return before
3029 adding the @code{noreturn} attribute, otherwise subtle code generation
3030 bugs could be introduced.  You will not get a warning for @code{main} in
3031 hosted C environments.
3032
3033 @item -Wmissing-format-attribute
3034 @opindex Wmissing-format-attribute
3035 @opindex Wformat
3036 If @option{-Wformat} is enabled, also warn about functions which might be
3037 candidates for @code{format} attributes.  Note these are only possible
3038 candidates, not absolute ones.  GCC will guess that @code{format}
3039 attributes might be appropriate for any function that calls a function
3040 like @code{vprintf} or @code{vscanf}, but this might not always be the
3041 case, and some functions for which @code{format} attributes are
3042 appropriate may not be detected.  This option has no effect unless
3043 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3044
3045 @item -Wno-multichar
3046 @opindex Wno-multichar
3047 @opindex Wmultichar
3048 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3049 Usually they indicate a typo in the user's code, as they have
3050 implementation-defined values, and should not be used in portable code.
3051
3052 @item -Wnormalized=<none|id|nfc|nfkc>
3053 @opindex Wnormalized
3054 @cindex NFC
3055 @cindex NFKC
3056 @cindex character set, input normalization
3057 In ISO C and ISO C++, two identifiers are different if they are
3058 different sequences of characters.  However, sometimes when characters
3059 outside the basic ASCII character set are used, you can have two
3060 different character sequences that look the same.  To avoid confusion,
3061 the ISO 10646 standard sets out some @dfn{normalization rules} which
3062 when applied ensure that two sequences that look the same are turned into
3063 the same sequence.  GCC can warn you if you are using identifiers which
3064 have not been normalized; this option controls that warning.
3065
3066 There are four levels of warning that GCC supports.  The default is
3067 @option{-Wnormalized=nfc}, which warns about any identifier which is
3068 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3069 recommended form for most uses.
3070
3071 Unfortunately, there are some characters which ISO C and ISO C++ allow
3072 in identifiers that when turned into NFC aren't allowable as
3073 identifiers.  That is, there's no way to use these symbols in portable
3074 ISO C or C++ and have all your identifiers in NFC.
3075 @option{-Wnormalized=id} suppresses the warning for these characters.
3076 It is hoped that future versions of the standards involved will correct
3077 this, which is why this option is not the default.
3078
3079 You can switch the warning off for all characters by writing
3080 @option{-Wnormalized=none}.  You would only want to do this if you
3081 were using some other normalization scheme (like ``D''), because
3082 otherwise you can easily create bugs that are literally impossible to see.
3083
3084 Some characters in ISO 10646 have distinct meanings but look identical
3085 in some fonts or display methodologies, especially once formatting has
3086 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3087 LETTER N'', will display just like a regular @code{n} which has been
3088 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3089 normalisation scheme to convert all these into a standard form as
3090 well, and GCC will warn if your code is not in NFKC if you use
3091 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3092 about every identifier that contains the letter O because it might be
3093 confused with the digit 0, and so is not the default, but may be
3094 useful as a local coding convention if the programming environment is
3095 unable to be fixed to display these characters distinctly.
3096
3097 @item -Wno-deprecated-declarations
3098 @opindex Wno-deprecated-declarations
3099 Do not warn about uses of functions, variables, and types marked as
3100 deprecated by using the @code{deprecated} attribute.
3101 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3102 @pxref{Type Attributes}.)
3103
3104 @item -Wpacked
3105 @opindex Wpacked
3106 Warn if a structure is given the packed attribute, but the packed
3107 attribute has no effect on the layout or size of the structure.
3108 Such structures may be mis-aligned for little benefit.  For
3109 instance, in this code, the variable @code{f.x} in @code{struct bar}
3110 will be misaligned even though @code{struct bar} does not itself
3111 have the packed attribute:
3112
3113 @smallexample
3114 @group
3115 struct foo @{
3116   int x;
3117   char a, b, c, d;
3118 @} __attribute__((packed));
3119 struct bar @{
3120   char z;
3121   struct foo f;
3122 @};
3123 @end group
3124 @end smallexample
3125
3126 @item -Wpadded
3127 @opindex Wpadded
3128 Warn if padding is included in a structure, either to align an element
3129 of the structure or to align the whole structure.  Sometimes when this
3130 happens it is possible to rearrange the fields of the structure to
3131 reduce the padding and so make the structure smaller.
3132
3133 @item -Wredundant-decls
3134 @opindex Wredundant-decls
3135 Warn if anything is declared more than once in the same scope, even in
3136 cases where multiple declaration is valid and changes nothing.
3137
3138 @item -Wnested-externs @r{(C only)}
3139 @opindex Wnested-externs
3140 Warn if an @code{extern} declaration is encountered within a function.
3141
3142 @item -Wunreachable-code
3143 @opindex Wunreachable-code
3144 Warn if the compiler detects that code will never be executed.
3145
3146 This option is intended to warn when the compiler detects that at
3147 least a whole line of source code will never be executed, because
3148 some condition is never satisfied or because it is after a
3149 procedure that never returns.
3150
3151 It is possible for this option to produce a warning even though there
3152 are circumstances under which part of the affected line can be executed,
3153 so care should be taken when removing apparently-unreachable code.
3154
3155 For instance, when a function is inlined, a warning may mean that the
3156 line is unreachable in only one inlined copy of the function.
3157
3158 This option is not made part of @option{-Wall} because in a debugging
3159 version of a program there is often substantial code which checks
3160 correct functioning of the program and is, hopefully, unreachable
3161 because the program does work.  Another common use of unreachable
3162 code is to provide behavior which is selectable at compile-time.
3163
3164 @item -Winline
3165 @opindex Winline
3166 Warn if a function can not be inlined and it was declared as inline.
3167 Even with this option, the compiler will not warn about failures to
3168 inline functions declared in system headers.
3169
3170 The compiler uses a variety of heuristics to determine whether or not
3171 to inline a function.  For example, the compiler takes into account
3172 the size of the function being inlined and the amount of inlining
3173 that has already been done in the current function.  Therefore,
3174 seemingly insignificant changes in the source program can cause the
3175 warnings produced by @option{-Winline} to appear or disappear.
3176
3177 @item -Wno-invalid-offsetof @r{(C++ only)}
3178 @opindex Wno-invalid-offsetof
3179 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3180 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3181 to a non-POD type is undefined.  In existing C++ implementations,
3182 however, @samp{offsetof} typically gives meaningful results even when
3183 applied to certain kinds of non-POD types. (Such as a simple
3184 @samp{struct} that fails to be a POD type only by virtue of having a
3185 constructor.)  This flag is for users who are aware that they are
3186 writing nonportable code and who have deliberately chosen to ignore the
3187 warning about it.
3188
3189 The restrictions on @samp{offsetof} may be relaxed in a future version
3190 of the C++ standard.
3191
3192 @item -Wno-int-to-pointer-cast @r{(C only)}
3193 @opindex Wno-int-to-pointer-cast
3194 Suppress warnings from casts to pointer type of an integer of a
3195 different size.
3196
3197 @item -Wno-pointer-to-int-cast @r{(C only)}
3198 @opindex Wno-pointer-to-int-cast
3199 Suppress warnings from casts from a pointer to an integer type of a
3200 different size.
3201
3202 @item -Winvalid-pch
3203 @opindex Winvalid-pch
3204 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3205 the search path but can't be used.
3206
3207 @item -Wlong-long
3208 @opindex Wlong-long
3209 @opindex Wno-long-long
3210 Warn if @samp{long long} type is used.  This is default.  To inhibit
3211 the warning messages, use @option{-Wno-long-long}.  Flags
3212 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3213 only when @option{-pedantic} flag is used.
3214
3215 @item -Wvariadic-macros
3216 @opindex Wvariadic-macros
3217 @opindex Wno-variadic-macros
3218 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3219 alternate syntax when in pedantic ISO C99 mode.  This is default.
3220 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3221
3222 @item -Wdisabled-optimization
3223 @opindex Wdisabled-optimization
3224 Warn if a requested optimization pass is disabled.  This warning does
3225 not generally indicate that there is anything wrong with your code; it
3226 merely indicates that GCC's optimizers were unable to handle the code
3227 effectively.  Often, the problem is that your code is too big or too
3228 complex; GCC will refuse to optimize programs when the optimization
3229 itself is likely to take inordinate amounts of time.
3230
3231 @item -Wno-pointer-sign
3232 @opindex Wno-pointer-sign
3233 Don't warn for pointer argument passing or assignment with different signedness.
3234 Only useful in the negative form since this warning is enabled by default.
3235 This option is only supported for C and Objective-C@.
3236
3237 @item -Werror
3238 @opindex Werror
3239 Make all warnings into errors.
3240 @end table
3241
3242 @node Debugging Options
3243 @section Options for Debugging Your Program or GCC
3244 @cindex options, debugging
3245 @cindex debugging information options
3246
3247 GCC has various special options that are used for debugging
3248 either your program or GCC:
3249
3250 @table @gcctabopt
3251 @item -g
3252 @opindex g
3253 Produce debugging information in the operating system's native format
3254 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3255 information.
3256
3257 On most systems that use stabs format, @option{-g} enables use of extra
3258 debugging information that only GDB can use; this extra information
3259 makes debugging work better in GDB but will probably make other debuggers
3260 crash or
3261 refuse to read the program.  If you want to control for certain whether
3262 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3263 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3264
3265 GCC allows you to use @option{-g} with
3266 @option{-O}.  The shortcuts taken by optimized code may occasionally
3267 produce surprising results: some variables you declared may not exist
3268 at all; flow of control may briefly move where you did not expect it;
3269 some statements may not be executed because they compute constant
3270 results or their values were already at hand; some statements may
3271 execute in different places because they were moved out of loops.
3272
3273 Nevertheless it proves possible to debug optimized output.  This makes
3274 it reasonable to use the optimizer for programs that might have bugs.
3275
3276 The following options are useful when GCC is generated with the
3277 capability for more than one debugging format.
3278
3279 @item -ggdb
3280 @opindex ggdb
3281 Produce debugging information for use by GDB@.  This means to use the
3282 most expressive format available (DWARF 2, stabs, or the native format
3283 if neither of those are supported), including GDB extensions if at all
3284 possible.
3285
3286 @item -gstabs
3287 @opindex gstabs
3288 Produce debugging information in stabs format (if that is supported),
3289 without GDB extensions.  This is the format used by DBX on most BSD
3290 systems.  On MIPS, Alpha and System V Release 4 systems this option
3291 produces stabs debugging output which is not understood by DBX or SDB@.
3292 On System V Release 4 systems this option requires the GNU assembler.
3293
3294 @item -feliminate-unused-debug-symbols
3295 @opindex feliminate-unused-debug-symbols
3296 Produce debugging information in stabs format (if that is supported),
3297 for only symbols that are actually used.
3298
3299 @item -gstabs+
3300 @opindex gstabs+
3301 Produce debugging information in stabs format (if that is supported),
3302 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3303 use of these extensions is likely to make other debuggers crash or
3304 refuse to read the program.
3305
3306 @item -gcoff
3307 @opindex gcoff
3308 Produce debugging information in COFF format (if that is supported).
3309 This is the format used by SDB on most System V systems prior to
3310 System V Release 4.
3311
3312 @item -gxcoff
3313 @opindex gxcoff
3314 Produce debugging information in XCOFF format (if that is supported).
3315 This is the format used by the DBX debugger on IBM RS/6000 systems.
3316
3317 @item -gxcoff+
3318 @opindex gxcoff+
3319 Produce debugging information in XCOFF format (if that is supported),
3320 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3321 use of these extensions is likely to make other debuggers crash or
3322 refuse to read the program, and may cause assemblers other than the GNU
3323 assembler (GAS) to fail with an error.
3324
3325 @item -gdwarf-2
3326 @opindex gdwarf-2
3327 Produce debugging information in DWARF version 2 format (if that is
3328 supported).  This is the format used by DBX on IRIX 6.  With this
3329 option, GCC uses features of DWARF version 3 when they are useful;
3330 version 3 is upward compatible with version 2, but may still cause
3331 problems for older debuggers.
3332
3333 @item -gvms
3334 @opindex gvms
3335 Produce debugging information in VMS debug format (if that is
3336 supported).  This is the format used by DEBUG on VMS systems.
3337
3338 @item -g@var{level}
3339 @itemx -ggdb@var{level}
3340 @itemx -gstabs@var{level}
3341 @itemx -gcoff@var{level}
3342 @itemx -gxcoff@var{level}
3343 @itemx -gvms@var{level}
3344 Request debugging information and also use @var{level} to specify how
3345 much information.  The default level is 2.
3346
3347 Level 1 produces minimal information, enough for making backtraces in
3348 parts of the program that you don't plan to debug.  This includes
3349 descriptions of functions and external variables, but no information
3350 about local variables and no line numbers.
3351
3352 Level 3 includes extra information, such as all the macro definitions
3353 present in the program.  Some debuggers support macro expansion when
3354 you use @option{-g3}.
3355
3356 @option{-gdwarf-2} does not accept a concatenated debug level, because
3357 GCC used to support an option @option{-gdwarf} that meant to generate
3358 debug information in version 1 of the DWARF format (which is very
3359 different from version 2), and it would have been too confusing.  That
3360 debug format is long obsolete, but the option cannot be changed now.
3361 Instead use an additional @option{-g@var{level}} option to change the
3362 debug level for DWARF2.
3363
3364 @item -feliminate-dwarf2-dups
3365 @opindex feliminate-dwarf2-dups
3366 Compress DWARF2 debugging information by eliminating duplicated
3367 information about each symbol.  This option only makes sense when
3368 generating DWARF2 debugging information with @option{-gdwarf-2}.
3369
3370 @cindex @command{prof}
3371 @item -p
3372 @opindex p
3373 Generate extra code to write profile information suitable for the
3374 analysis program @command{prof}.  You must use this option when compiling
3375 the source files you want data about, and you must also use it when
3376 linking.
3377
3378 @cindex @command{gprof}
3379 @item -pg
3380 @opindex pg
3381 Generate extra code to write profile information suitable for the
3382 analysis program @command{gprof}.  You must use this option when compiling
3383 the source files you want data about, and you must also use it when
3384 linking.
3385
3386 @item -Q
3387 @opindex Q
3388 Makes the compiler print out each function name as it is compiled, and
3389 print some statistics about each pass when it finishes.
3390
3391 @item -ftime-report
3392 @opindex ftime-report
3393 Makes the compiler print some statistics about the time consumed by each
3394 pass when it finishes.
3395
3396 @item -fmem-report
3397 @opindex fmem-report
3398 Makes the compiler print some statistics about permanent memory
3399 allocation when it finishes.
3400
3401 @item -fprofile-arcs
3402 @opindex fprofile-arcs
3403 Add code so that program flow @dfn{arcs} are instrumented.  During
3404 execution the program records how many times each branch and call is
3405 executed and how many times it is taken or returns.  When the compiled
3406 program exits it saves this data to a file called
3407 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3408 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3409 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3410 @var{auxname} is generated from the name of the output file, if
3411 explicitly specified and it is not the final executable, otherwise it is
3412 the basename of the source file.  In both cases any suffix is removed
3413 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3414 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3415
3416 @cindex @command{gcov}
3417 @item --coverage
3418 @opindex coverage
3419
3420 This option is used to compile and link code instrumented for coverage
3421 analysis.  The option is a synonym for @option{-fprofile-arcs}
3422 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3423 linking).  See the documentation for those options for more details.
3424
3425 @itemize
3426
3427 @item
3428 Compile the source files with @option{-fprofile-arcs} plus optimization
3429 and code generation options.  For test coverage analysis, use the
3430 additional @option{-ftest-coverage} option.  You do not need to profile
3431 every source file in a program.
3432
3433 @item
3434 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3435 (the latter implies the former).
3436
3437 @item
3438 Run the program on a representative workload to generate the arc profile
3439 information.  This may be repeated any number of times.  You can run
3440 concurrent instances of your program, and provided that the file system
3441 supports locking, the data files will be correctly updated.  Also
3442 @code{fork} calls are detected and correctly handled (double counting
3443 will not happen).
3444
3445 @item
3446 For profile-directed optimizations, compile the source files again with
3447 the same optimization and code generation options plus
3448 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3449 Control Optimization}).
3450
3451 @item
3452 For test coverage analysis, use @command{gcov} to produce human readable
3453 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3454 @command{gcov} documentation for further information.
3455
3456 @end itemize
3457
3458 With @option{-fprofile-arcs}, for each function of your program GCC
3459 creates a program flow graph, then finds a spanning tree for the graph.
3460 Only arcs that are not on the spanning tree have to be instrumented: the
3461 compiler adds code to count the number of times that these arcs are
3462 executed.  When an arc is the only exit or only entrance to a block, the
3463 instrumentation code can be added to the block; otherwise, a new basic
3464 block must be created to hold the instrumentation code.
3465
3466 @item -ftree-based-profiling
3467 @opindex ftree-based-profiling
3468 This option is used in addition to @option{-fprofile-arcs} or
3469 @option{-fbranch-probabilities} to control whether those optimizations
3470 are performed on a tree-based or rtl-based internal representation.
3471 If you use this option when compiling with @option{-fprofile-arcs},
3472 you must also use it when compiling later with @option{-fbranch-probabilities}.
3473 Currently the tree-based optimization is in an early stage of
3474 development, and this option is recommended only for those people
3475 working on improving it.
3476
3477 @need 2000
3478 @item -ftest-coverage
3479 @opindex ftest-coverage
3480 Produce a notes file that the @command{gcov} code-coverage utility
3481 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3482 show program coverage.  Each source file's note file is called
3483 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3484 above for a description of @var{auxname} and instructions on how to
3485 generate test coverage data.  Coverage data will match the source files
3486 more closely, if you do not optimize.
3487
3488 @item -d@var{letters}
3489 @item -fdump-rtl-@var{pass}
3490 @opindex d
3491 Says to make debugging dumps during compilation at times specified by
3492 @var{letters}.    This is used for debugging the RTL-based passes of the
3493 compiler.  The file names for most of the dumps are made by appending a
3494 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3495 from the name of the output file, if explicitly specified and it is not
3496 an executable, otherwise it is the basename of the source file.
3497
3498 Most debug dumps can be enabled either passing a letter to the @option{-d}
3499 option, or with a long @option{-fdump-rtl} switch; here are the possible
3500 letters for use in @var{letters} and @var{pass}, and their meanings:
3501
3502 @table @gcctabopt
3503 @item -dA
3504 @opindex dA
3505 Annotate the assembler output with miscellaneous debugging information.
3506
3507 @item -db
3508 @itemx -fdump-rtl-bp
3509 @opindex db
3510 @opindex fdump-rtl-bp
3511 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3512
3513 @item -dB
3514 @itemx -fdump-rtl-bbro
3515 @opindex dB
3516 @opindex fdump-rtl-bbro
3517 Dump after block reordering, to @file{@var{file}.30.bbro}.
3518
3519 @item -dc
3520 @itemx -fdump-rtl-combine
3521 @opindex dc
3522 @opindex fdump-rtl-combine
3523 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3524
3525 @item -dC
3526 @itemx -fdump-rtl-ce1
3527 @itemx -fdump-rtl-ce2
3528 @opindex dC
3529 @opindex fdump-rtl-ce1
3530 @opindex fdump-rtl-ce2
3531 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3532 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3533 and @option{-fdump-rtl-ce2} enable dumping after the second if
3534 conversion, to the file @file{@var{file}.18.ce2}.
3535
3536 @item -dd
3537 @itemx -fdump-rtl-btl
3538 @itemx -fdump-rtl-dbr
3539 @opindex dd
3540 @opindex fdump-rtl-btl
3541 @opindex fdump-rtl-dbr
3542 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3543 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3544 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3545 scheduling, to @file{@var{file}.36.dbr}.
3546
3547 @item -dD
3548 @opindex dD
3549 Dump all macro definitions, at the end of preprocessing, in addition to
3550 normal output.
3551
3552 @item -dE
3553 @itemx -fdump-rtl-ce3
3554 @opindex dE
3555 @opindex fdump-rtl-ce3
3556 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3557
3558 @item -df
3559 @itemx -fdump-rtl-cfg
3560 @itemx -fdump-rtl-life
3561 @opindex df
3562 @opindex fdump-rtl-cfg
3563 @opindex fdump-rtl-life
3564 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3565 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3566 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3567 to @file{@var{file}.16.life}.
3568
3569 @item -dg
3570 @itemx -fdump-rtl-greg
3571 @opindex dg
3572 @opindex fdump-rtl-greg
3573 Dump after global register allocation, to @file{@var{file}.23.greg}.
3574
3575 @item -dG
3576 @itemx -fdump-rtl-gcse
3577 @itemx -fdump-rtl-bypass
3578 @opindex dG
3579 @opindex fdump-rtl-gcse
3580 @opindex fdump-rtl-bypass
3581 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3582 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3583 enable dumping after jump bypassing and control flow optimizations, to
3584 @file{@var{file}.07.bypass}.
3585
3586 @item -dh
3587 @itemx -fdump-rtl-eh
3588 @opindex dh
3589 @opindex fdump-rtl-eh
3590 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3591
3592 @item -di
3593 @itemx -fdump-rtl-sibling
3594 @opindex di
3595 @opindex fdump-rtl-sibling
3596 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3597
3598 @item -dj
3599 @itemx -fdump-rtl-jump
3600 @opindex dj
3601 @opindex fdump-rtl-jump
3602 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3603
3604 @item -dk
3605 @itemx -fdump-rtl-stack
3606 @opindex dk
3607 @opindex fdump-rtl-stack
3608 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3609
3610 @item -dl
3611 @itemx -fdump-rtl-lreg
3612 @opindex dl
3613 @opindex fdump-rtl-lreg
3614 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3615
3616 @item -dL
3617 @itemx -fdump-rtl-loop
3618 @itemx -fdump-rtl-loop2
3619 @opindex dL
3620 @opindex fdump-rtl-loop
3621 @opindex fdump-rtl-loop2
3622 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3623 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3624 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3625 @file{@var{file}.13.loop2}.
3626
3627 @item -dm
3628 @itemx -fdump-rtl-sms
3629 @opindex dm
3630 @opindex fdump-rtl-sms
3631 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3632
3633 @item -dM
3634 @itemx -fdump-rtl-mach
3635 @opindex dM
3636 @opindex fdump-rtl-mach
3637 Dump after performing the machine dependent reorganization pass, to
3638 @file{@var{file}.35.mach}.
3639
3640 @item -dn
3641 @itemx -fdump-rtl-rnreg
3642 @opindex dn
3643 @opindex fdump-rtl-rnreg
3644 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3645
3646 @item -dN
3647 @itemx -fdump-rtl-regmove
3648 @opindex dN
3649 @opindex fdump-rtl-regmove
3650 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3651
3652 @item -do
3653 @itemx -fdump-rtl-postreload
3654 @opindex do
3655 @opindex fdump-rtl-postreload
3656 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3657
3658 @item -dr
3659 @itemx -fdump-rtl-expand
3660 @opindex dr
3661 @opindex fdump-rtl-expand
3662 Dump after RTL generation, to @file{@var{file}.00.expand}.
3663
3664 @item -dR
3665 @itemx -fdump-rtl-sched2
3666 @opindex dR
3667 @opindex fdump-rtl-sched2
3668 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3669
3670 @item -ds
3671 @itemx -fdump-rtl-cse
3672 @opindex ds
3673 @opindex fdump-rtl-cse
3674 Dump after CSE (including the jump optimization that sometimes follows
3675 CSE), to @file{@var{file}.04.cse}.
3676
3677 @item -dS
3678 @itemx -fdump-rtl-sched
3679 @opindex dS
3680 @opindex fdump-rtl-sched
3681 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3682
3683 @item -dt
3684 @itemx -fdump-rtl-cse2
3685 @opindex dt
3686 @opindex fdump-rtl-cse2
3687 Dump after the second CSE pass (including the jump optimization that
3688 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3689
3690 @item -dT
3691 @itemx -fdump-rtl-tracer
3692 @opindex dT
3693 @opindex fdump-rtl-tracer
3694 Dump after running tracer, to @file{@var{file}.12.tracer}.
3695
3696 @item -dV
3697 @itemx -fdump-rtl-vpt
3698 @itemx -fdump-rtl-vartrack
3699 @opindex dV
3700 @opindex fdump-rtl-vpt
3701 @opindex fdump-rtl-vartrack
3702 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3703 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3704 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3705 to @file{@var{file}.34.vartrack}.
3706
3707 @item -dw
3708 @itemx -fdump-rtl-flow2
3709 @opindex dw
3710 @opindex fdump-rtl-flow2
3711 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3712
3713 @item -dz
3714 @itemx -fdump-rtl-peephole2
3715 @opindex dz
3716 @opindex fdump-rtl-peephole2
3717 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3718
3719 @item -dZ
3720 @itemx -fdump-rtl-web
3721 @opindex dZ
3722 @opindex fdump-rtl-web
3723 Dump after live range splitting, to @file{@var{file}.14.web}.
3724
3725 @item -da
3726 @itemx -fdump-rtl-all
3727 @opindex da
3728 @opindex fdump-rtl-all
3729 Produce all the dumps listed above.
3730
3731 @item -dH
3732 @opindex dH
3733 Produce a core dump whenever an error occurs.
3734
3735 @item -dm
3736 @opindex dm
3737 Print statistics on memory usage, at the end of the run, to
3738 standard error.
3739
3740 @item -dp
3741 @opindex dp
3742 Annotate the assembler output with a comment indicating which
3743 pattern and alternative was used.  The length of each instruction is
3744 also printed.
3745
3746 @item -dP
3747 @opindex dP
3748 Dump the RTL in the assembler output as a comment before each instruction.
3749 Also turns on @option{-dp} annotation.
3750
3751 @item -dv
3752 @opindex dv
3753 For each of the other indicated dump files (either with @option{-d} or
3754 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3755 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3756
3757 @item -dx
3758 @opindex dx
3759 Just generate RTL for a function instead of compiling it.  Usually used
3760 with @samp{r} (@option{-fdump-rtl-expand}).
3761
3762 @item -dy
3763 @opindex dy
3764 Dump debugging information during parsing, to standard error.
3765 @end table
3766
3767 @item -fdump-unnumbered
3768 @opindex fdump-unnumbered
3769 When doing debugging dumps (see @option{-d} option above), suppress instruction
3770 numbers and line number note output.  This makes it more feasible to
3771 use diff on debugging dumps for compiler invocations with different
3772 options, in particular with and without @option{-g}.
3773
3774 @item -fdump-translation-unit @r{(C and C++ only)}
3775 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3776 @opindex fdump-translation-unit
3777 Dump a representation of the tree structure for the entire translation
3778 unit to a file.  The file name is made by appending @file{.tu} to the
3779 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3780 controls the details of the dump as described for the
3781 @option{-fdump-tree} options.
3782
3783 @item -fdump-class-hierarchy @r{(C++ only)}
3784 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3785 @opindex fdump-class-hierarchy
3786 Dump a representation of each class's hierarchy and virtual function
3787 table layout to a file.  The file name is made by appending @file{.class}
3788 to the source file name.  If the @samp{-@var{options}} form is used,
3789 @var{options} controls the details of the dump as described for the
3790 @option{-fdump-tree} options.
3791
3792 @item -fdump-ipa-@var{switch}
3793 @opindex fdump-ipa
3794 Control the dumping at various stages of inter-procedural analysis
3795 language tree to a file.  The file name is generated by appending a switch
3796 specific suffix to the source file name.  The following dumps are possible:
3797
3798 @table @samp
3799 @item all
3800 Enables all inter-procedural analysis dumps; currently the only produced
3801 dump is the @samp{cgraph} dump.
3802
3803 @item cgraph
3804 Dumps information about call-graph optimization, unused function removal,
3805 and inlining decisions.
3806 @end table
3807
3808 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3809 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3810 @opindex fdump-tree
3811 Control the dumping at various stages of processing the intermediate
3812 language tree to a file.  The file name is generated by appending a switch
3813 specific suffix to the source file name.  If the @samp{-@var{options}}
3814 form is used, @var{options} is a list of @samp{-} separated options that
3815 control the details of the dump.  Not all options are applicable to all
3816 dumps, those which are not meaningful will be ignored.  The following
3817 options are available
3818
3819 @table @samp
3820 @item address
3821 Print the address of each node.  Usually this is not meaningful as it
3822 changes according to the environment and source file.  Its primary use
3823 is for tying up a dump file with a debug environment.
3824 @item slim
3825 Inhibit dumping of members of a scope or body of a function merely
3826 because that scope has been reached.  Only dump such items when they
3827 are directly reachable by some other path.  When dumping pretty-printed
3828 trees, this option inhibits dumping the bodies of control structures.
3829 @item raw
3830 Print a raw representation of the tree.  By default, trees are
3831 pretty-printed into a C-like representation.
3832 @item details
3833 Enable more detailed dumps (not honored by every dump option).
3834 @item stats
3835 Enable dumping various statistics about the pass (not honored by every dump
3836 option).
3837 @item blocks
3838 Enable showing basic block boundaries (disabled in raw dumps).
3839 @item vops
3840 Enable showing virtual operands for every statement.
3841 @item lineno
3842 Enable showing line numbers for statements.
3843 @item uid
3844 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3845 @item all
3846 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3847 @end table
3848
3849 The following tree dumps are possible:
3850 @table @samp
3851
3852 @item original
3853 Dump before any tree based optimization, to @file{@var{file}.original}.
3854
3855 @item optimized
3856 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3857
3858 @item inlined
3859 Dump after function inlining, to @file{@var{file}.inlined}.
3860
3861 @item gimple
3862 @opindex fdump-tree-gimple
3863 Dump each function before and after the gimplification pass to a file.  The
3864 file name is made by appending @file{.gimple} to the source file name.
3865
3866 @item cfg
3867 @opindex fdump-tree-cfg
3868 Dump the control flow graph of each function to a file.  The file name is
3869 made by appending @file{.cfg} to the source file name.
3870
3871 @item vcg
3872 @opindex fdump-tree-vcg
3873 Dump the control flow graph of each function to a file in VCG format.  The
3874 file name is made by appending @file{.vcg} to the source file name.  Note
3875 that if the file contains more than one function, the generated file cannot
3876 be used directly by VCG@.  You will need to cut and paste each function's
3877 graph into its own separate file first.
3878
3879 @item ch
3880 @opindex fdump-tree-ch
3881 Dump each function after copying loop headers.  The file name is made by
3882 appending @file{.ch} to the source file name.
3883
3884 @item ssa
3885 @opindex fdump-tree-ssa
3886 Dump SSA related information to a file.  The file name is made by appending
3887 @file{.ssa} to the source file name.
3888
3889 @item salias
3890 @opindex fdump-tree-salias
3891 Dump structure aliasing variable information to a file.  This file name
3892 is made by appending @file{.salias} to the source file name.
3893
3894 @item alias
3895 @opindex fdump-tree-alias
3896 Dump aliasing information for each function.  The file name is made by
3897 appending @file{.alias} to the source file name.
3898
3899 @item ccp
3900 @opindex fdump-tree-ccp
3901 Dump each function after CCP@.  The file name is made by appending
3902 @file{.ccp} to the source file name.
3903
3904 @item storeccp
3905 @opindex fdump-tree-storeccp
3906 Dump each function after STORE-CCP.  The file name is made by appending
3907 @file{.storeccp} to the source file name.
3908
3909 @item pre
3910 @opindex fdump-tree-pre
3911 Dump trees after partial redundancy elimination.  The file name is made
3912 by appending @file{.pre} to the source file name.
3913
3914 @item fre
3915 @opindex fdump-tree-fre
3916 Dump trees after full redundancy elimination.  The file name is made
3917 by appending @file{.fre} to the source file name.
3918
3919 @item copyprop
3920 @opindex fdump-tree-copyprop
3921 Dump trees after copy propagation.  The file name is made
3922 by appending @file{.copyprop} to the source file name.
3923
3924 @item store_copyprop
3925 @opindex fdump-tree-store_copyprop
3926 Dump trees after store copy-propagation.  The file name is made
3927 by appending @file{.store_copyprop} to the source file name.
3928
3929 @item dce
3930 @opindex fdump-tree-dce
3931 Dump each function after dead code elimination.  The file name is made by
3932 appending @file{.dce} to the source file name.
3933
3934 @item mudflap
3935 @opindex fdump-tree-mudflap
3936 Dump each function after adding mudflap instrumentation.  The file name is
3937 made by appending @file{.mudflap} to the source file name.
3938
3939 @item sra
3940 @opindex fdump-tree-sra
3941 Dump each function after performing scalar replacement of aggregates.  The
3942 file name is made by appending @file{.sra} to the source file name.
3943
3944 @item sink
3945 @opindex fdump-tree-sink
3946 Dump each function after performing code sinking.  The file name is made
3947 by appending @file{.sink} to the source file name. 
3948
3949 @item dom
3950 @opindex fdump-tree-dom
3951 Dump each function after applying dominator tree optimizations.  The file
3952 name is made by appending @file{.dom} to the source file name.
3953
3954 @item dse
3955 @opindex fdump-tree-dse
3956 Dump each function after applying dead store elimination.  The file
3957 name is made by appending @file{.dse} to the source file name.
3958
3959 @item phiopt
3960 @opindex fdump-tree-phiopt
3961 Dump each function after optimizing PHI nodes into straightline code.  The file
3962 name is made by appending @file{.phiopt} to the source file name.
3963
3964 @item forwprop
3965 @opindex fdump-tree-forwprop
3966 Dump each function after forward propagating single use variables.  The file
3967 name is made by appending @file{.forwprop} to the source file name.
3968
3969 @item copyrename
3970 @opindex fdump-tree-copyrename
3971 Dump each function after applying the copy rename optimization.  The file
3972 name is made by appending @file{.copyrename} to the source file name.
3973
3974 @item nrv
3975 @opindex fdump-tree-nrv
3976 Dump each function after applying the named return value optimization on
3977 generic trees.  The file name is made by appending @file{.nrv} to the source
3978 file name.
3979
3980 @item vect
3981 @opindex fdump-tree-vect
3982 Dump each function after applying vectorization of loops.  The file name is
3983 made by appending @file{.vect} to the source file name.
3984
3985 @item all
3986 @opindex fdump-tree-all
3987 Enable all the available tree dumps with the flags provided in this option.
3988 @end table
3989
3990 @item -ftree-vectorizer-verbose=@var{n}
3991 @opindex ftree-vectorizer-verbose
3992 This option controls the amount of debugging output the vectorizer prints.
3993 This information is written to standard error, unless @option{-fdump-tree-all}
3994 or @option{-fdump-tree-vect} is specified, in which case it is output to the
3995 usual dump listing file, @file{.vect}.
3996
3997 @item -frandom-seed=@var{string}
3998 @opindex frandom-string
3999 This option provides a seed that GCC uses when it would otherwise use
4000 random numbers.  It is used to generate certain symbol names
4001 that have to be different in every compiled file.  It is also used to
4002 place unique stamps in coverage data files and the object files that
4003 produce them.  You can use the @option{-frandom-seed} option to produce
4004 reproducibly identical object files.
4005
4006 The @var{string} should be different for every file you compile.
4007
4008 @item -fsched-verbose=@var{n}
4009 @opindex fsched-verbose
4010 On targets that use instruction scheduling, this option controls the
4011 amount of debugging output the scheduler prints.  This information is
4012 written to standard error, unless @option{-dS} or @option{-dR} is
4013 specified, in which case it is output to the usual dump
4014 listing file, @file{.sched} or @file{.sched2} respectively.  However
4015 for @var{n} greater than nine, the output is always printed to standard
4016 error.
4017
4018 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4019 same information as @option{-dRS}.  For @var{n} greater than one, it
4020 also output basic block probabilities, detailed ready list information
4021 and unit/insn info.  For @var{n} greater than two, it includes RTL
4022 at abort point, control-flow and regions info.  And for @var{n} over
4023 four, @option{-fsched-verbose} also includes dependence info.
4024
4025 @item -save-temps
4026 @opindex save-temps
4027 Store the usual ``temporary'' intermediate files permanently; place them
4028 in the current directory and name them based on the source file.  Thus,
4029 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4030 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4031 preprocessed @file{foo.i} output file even though the compiler now
4032 normally uses an integrated preprocessor.
4033
4034 When used in combination with the @option{-x} command line option,
4035 @option{-save-temps} is sensible enough to avoid over writing an
4036 input source file with the same extension as an intermediate file.
4037 The corresponding intermediate file may be obtained by renaming the
4038 source file before using @option{-save-temps}.
4039
4040 @item -time
4041 @opindex time
4042 Report the CPU time taken by each subprocess in the compilation
4043 sequence.  For C source files, this is the compiler proper and assembler
4044 (plus the linker if linking is done).  The output looks like this:
4045
4046 @smallexample
4047 # cc1 0.12 0.01
4048 # as 0.00 0.01
4049 @end smallexample
4050
4051 The first number on each line is the ``user time'', that is time spent
4052 executing the program itself.  The second number is ``system time'',
4053 time spent executing operating system routines on behalf of the program.
4054 Both numbers are in seconds.
4055
4056 @item -fvar-tracking
4057 @opindex fvar-tracking
4058 Run variable tracking pass.  It computes where variables are stored at each
4059 position in code.  Better debugging information is then generated
4060 (if the debugging information format supports this information).
4061
4062 It is enabled by default when compiling with optimization (@option{-Os},
4063 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4064 the debug info format supports it.
4065
4066 @item -print-file-name=@var{library}
4067 @opindex print-file-name
4068 Print the full absolute name of the library file @var{library} that
4069 would be used when linking---and don't do anything else.  With this
4070 option, GCC does not compile or link anything; it just prints the
4071 file name.
4072
4073 @item -print-multi-directory
4074 @opindex print-multi-directory
4075 Print the directory name corresponding to the multilib selected by any
4076 other switches present in the command line.  This directory is supposed
4077 to exist in @env{GCC_EXEC_PREFIX}.
4078
4079 @item -print-multi-lib
4080 @opindex print-multi-lib
4081 Print the mapping from multilib directory names to compiler switches
4082 that enable them.  The directory name is separated from the switches by
4083 @samp{;}, and each switch starts with an @samp{@@} instead of the
4084 @samp{-}, without spaces between multiple switches.  This is supposed to
4085 ease shell-processing.
4086
4087 @item -print-prog-name=@var{program}
4088 @opindex print-prog-name
4089 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4090
4091 @item -print-libgcc-file-name
4092 @opindex print-libgcc-file-name
4093 Same as @option{-print-file-name=libgcc.a}.
4094
4095 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4096 but you do want to link with @file{libgcc.a}.  You can do
4097
4098 @smallexample
4099 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4100 @end smallexample
4101
4102 @item -print-search-dirs
4103 @opindex print-search-dirs
4104 Print the name of the configured installation directory and a list of
4105 program and library directories @command{gcc} will search---and don't do anything else.
4106
4107 This is useful when @command{gcc} prints the error message
4108 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4109 To resolve this you either need to put @file{cpp0} and the other compiler
4110 components where @command{gcc} expects to find them, or you can set the environment
4111 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4112 Don't forget the trailing @samp{/}.
4113 @xref{Environment Variables}.
4114
4115 @item -dumpmachine
4116 @opindex dumpmachine
4117 Print the compiler's target machine (for example,
4118 @samp{i686-pc-linux-gnu})---and don't do anything else.
4119
4120 @item -dumpversion
4121 @opindex dumpversion
4122 Print the compiler version (for example, @samp{3.0})---and don't do
4123 anything else.
4124
4125 @item -dumpspecs
4126 @opindex dumpspecs
4127 Print the compiler's built-in specs---and don't do anything else.  (This
4128 is used when GCC itself is being built.)  @xref{Spec Files}.
4129
4130 @item -feliminate-unused-debug-types
4131 @opindex feliminate-unused-debug-types
4132 Normally, when producing DWARF2 output, GCC will emit debugging
4133 information for all types declared in a compilation
4134 unit, regardless of whether or not they are actually used
4135 in that compilation unit.  Sometimes this is useful, such as
4136 if, in the debugger, you want to cast a value to a type that is
4137 not actually used in your program (but is declared).  More often,
4138 however, this results in a significant amount of wasted space.
4139 With this option, GCC will avoid producing debug symbol output
4140 for types that are nowhere used in the source file being compiled.
4141 @end table
4142
4143 @node Optimize Options
4144 @section Options That Control Optimization
4145 @cindex optimize options
4146 @cindex options, optimization
4147
4148 These options control various sorts of optimizations.
4149
4150 Without any optimization option, the compiler's goal is to reduce the
4151 cost of compilation and to make debugging produce the expected
4152 results.  Statements are independent: if you stop the program with a
4153 breakpoint between statements, you can then assign a new value to any
4154 variable or change the program counter to any other statement in the
4155 function and get exactly the results you would expect from the source
4156 code.
4157
4158 Turning on optimization flags makes the compiler attempt to improve
4159 the performance and/or code size at the expense of compilation time
4160 and possibly the ability to debug the program.
4161
4162 The compiler performs optimization based on the knowledge it has of
4163 the program.  Optimization levels @option{-O2} and above, in
4164 particular, enable @emph{unit-at-a-time} mode, which allows the
4165 compiler to consider information gained from later functions in
4166 the file when compiling a function.  Compiling multiple files at
4167 once to a single output file in @emph{unit-at-a-time} mode allows
4168 the compiler to use information gained from all of the files when
4169 compiling each of them.
4170
4171 Not all optimizations are controlled directly by a flag.  Only
4172 optimizations that have a flag are listed.
4173
4174 @table @gcctabopt
4175 @item -O
4176 @itemx -O1
4177 @opindex O
4178 @opindex O1
4179 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4180 more memory for a large function.
4181
4182 With @option{-O}, the compiler tries to reduce code size and execution
4183 time, without performing any optimizations that take a great deal of
4184 compilation time.
4185
4186 @option{-O} turns on the following optimization flags:
4187 @gccoptlist{-fdefer-pop @gol
4188 -fdelayed-branch @gol
4189 -fguess-branch-probability @gol
4190 -fcprop-registers @gol
4191 -floop-optimize @gol
4192 -fif-conversion @gol
4193 -fif-conversion2 @gol
4194 -ftree-ccp @gol
4195 -ftree-dce @gol
4196 -ftree-dominator-opts @gol
4197 -ftree-dse @gol
4198 -ftree-ter @gol
4199 -ftree-lrs @gol
4200 -ftree-sra @gol
4201 -ftree-copyrename @gol
4202 -ftree-fre @gol
4203 -ftree-ch @gol
4204 -fmerge-constants}
4205
4206 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4207 where doing so does not interfere with debugging.
4208
4209 @item -O2
4210 @opindex O2
4211 Optimize even more.  GCC performs nearly all supported optimizations
4212 that do not involve a space-speed tradeoff.  The compiler does not
4213 perform loop unrolling or function inlining when you specify @option{-O2}.
4214 As compared to @option{-O}, this option increases both compilation time
4215 and the performance of the generated code.
4216
4217 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4218 also turns on the following optimization flags:
4219 @gccoptlist{-fthread-jumps @gol
4220 -fcrossjumping @gol
4221 -foptimize-sibling-calls @gol
4222 -fcse-follow-jumps  -fcse-skip-blocks @gol
4223 -fgcse  -fgcse-lm  @gol
4224 -fexpensive-optimizations @gol
4225 -fstrength-reduce @gol
4226 -frerun-cse-after-loop  -frerun-loop-opt @gol
4227 -fcaller-saves @gol
4228 -fforce-mem @gol
4229 -fpeephole2 @gol
4230 -fschedule-insns  -fschedule-insns2 @gol
4231 -fsched-interblock  -fsched-spec @gol
4232 -fregmove @gol
4233 -fstrict-aliasing @gol
4234 -fdelete-null-pointer-checks @gol
4235 -freorder-blocks  -freorder-functions @gol
4236 -funit-at-a-time @gol
4237 -falign-functions  -falign-jumps @gol
4238 -falign-loops  -falign-labels @gol
4239 -ftree-pre}
4240
4241 Please note the warning under @option{-fgcse} about
4242 invoking @option{-O2} on programs that use computed gotos.
4243
4244 @item -O3
4245 @opindex O3
4246 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4247 @option{-O2} and also turns on the @option{-finline-functions},
4248 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4249
4250 @item -O0
4251 @opindex O0
4252 Do not optimize.  This is the default.
4253
4254 @item -Os
4255 @opindex Os
4256 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4257 do not typically increase code size.  It also performs further
4258 optimizations designed to reduce code size.
4259
4260 @option{-Os} disables the following optimization flags:
4261 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4262 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4263
4264 If you use multiple @option{-O} options, with or without level numbers,
4265 the last such option is the one that is effective.
4266 @end table
4267
4268 Options of the form @option{-f@var{flag}} specify machine-independent
4269 flags.  Most flags have both positive and negative forms; the negative
4270 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4271 below, only one of the forms is listed---the one you typically will
4272 use.  You can figure out the other form by either removing @samp{no-}
4273 or adding it.
4274
4275 The following options control specific optimizations.  They are either
4276 activated by @option{-O} options or are related to ones that are.  You
4277 can use the following flags in the rare cases when ``fine-tuning'' of
4278 optimizations to be performed is desired.
4279
4280 @table @gcctabopt
4281 @item -fno-default-inline
4282 @opindex fno-default-inline
4283 Do not make member functions inline by default merely because they are
4284 defined inside the class scope (C++ only).  Otherwise, when you specify
4285 @w{@option{-O}}, member functions defined inside class scope are compiled
4286 inline by default; i.e., you don't need to add @samp{inline} in front of
4287 the member function name.
4288
4289 @item -fno-defer-pop
4290 @opindex fno-defer-pop
4291 Always pop the arguments to each function call as soon as that function
4292 returns.  For machines which must pop arguments after a function call,
4293 the compiler normally lets arguments accumulate on the stack for several
4294 function calls and pops them all at once.
4295
4296 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4297
4298 @item -fforce-mem
4299 @opindex fforce-mem
4300 Force memory operands to be copied into registers before doing
4301 arithmetic on them.  This produces better code by making all memory
4302 references potential common subexpressions.  When they are not common
4303 subexpressions, instruction combination should eliminate the separate
4304 register-load.
4305
4306 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4307
4308 @item -fforce-addr