OSDN Git Service

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