OSDN Git Service

PR c/12802
[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 Some cases of unnamed fields in structures and unions are only
1227 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1228 fields within structs/unions}, for details.
1229
1230 @item -trigraphs
1231 @opindex trigraphs
1232 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1233 options for strict ISO C conformance) implies @option{-trigraphs}.
1234
1235 @item -no-integrated-cpp
1236 @opindex no-integrated-cpp
1237 Performs a compilation in two passes: preprocessing and compiling.  This
1238 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1239 @option{-B} option. The user supplied compilation step can then add in
1240 an additional preprocessing step after normal preprocessing but before
1241 compiling. The default is to use the integrated cpp (internal cpp)
1242
1243 The semantics of this option will change if "cc1", "cc1plus", and
1244 "cc1obj" are merged.
1245
1246 @cindex traditional C language
1247 @cindex C language, traditional
1248 @item -traditional
1249 @itemx -traditional-cpp
1250 @opindex traditional-cpp
1251 @opindex traditional
1252 Formerly, these options caused GCC to attempt to emulate a pre-standard
1253 C compiler.  They are now only supported with the @option{-E} switch.
1254 The preprocessor continues to support a pre-standard mode.  See the GNU
1255 CPP manual for details.
1256
1257 @item -fcond-mismatch
1258 @opindex fcond-mismatch
1259 Allow conditional expressions with mismatched types in the second and
1260 third arguments.  The value of such an expression is void.  This option
1261 is not supported for C++.
1262
1263 @item -funsigned-char
1264 @opindex funsigned-char
1265 Let the type @code{char} be unsigned, like @code{unsigned char}.
1266
1267 Each kind of machine has a default for what @code{char} should
1268 be.  It is either like @code{unsigned char} by default or like
1269 @code{signed char} by default.
1270
1271 Ideally, a portable program should always use @code{signed char} or
1272 @code{unsigned char} when it depends on the signedness of an object.
1273 But many programs have been written to use plain @code{char} and
1274 expect it to be signed, or expect it to be unsigned, depending on the
1275 machines they were written for.  This option, and its inverse, let you
1276 make such a program work with the opposite default.
1277
1278 The type @code{char} is always a distinct type from each of
1279 @code{signed char} or @code{unsigned char}, even though its behavior
1280 is always just like one of those two.
1281
1282 @item -fsigned-char
1283 @opindex fsigned-char
1284 Let the type @code{char} be signed, like @code{signed char}.
1285
1286 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1287 the negative form of @option{-funsigned-char}.  Likewise, the option
1288 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1289
1290 @item -fsigned-bitfields
1291 @itemx -funsigned-bitfields
1292 @itemx -fno-signed-bitfields
1293 @itemx -fno-unsigned-bitfields
1294 @opindex fsigned-bitfields
1295 @opindex funsigned-bitfields
1296 @opindex fno-signed-bitfields
1297 @opindex fno-unsigned-bitfields
1298 These options control whether a bit-field is signed or unsigned, when the
1299 declaration does not use either @code{signed} or @code{unsigned}.  By
1300 default, such a bit-field is signed, because this is consistent: the
1301 basic integer types such as @code{int} are signed types.
1302 @end table
1303
1304 @node C++ Dialect Options
1305 @section Options Controlling C++ Dialect
1306
1307 @cindex compiler options, C++
1308 @cindex C++ options, command line
1309 @cindex options, C++
1310 This section describes the command-line options that are only meaningful
1311 for C++ programs; but you can also use most of the GNU compiler options
1312 regardless of what language your program is in.  For example, you
1313 might compile a file @code{firstClass.C} like this:
1314
1315 @smallexample
1316 g++ -g -frepo -O -c firstClass.C
1317 @end smallexample
1318
1319 @noindent
1320 In this example, only @option{-frepo} is an option meant
1321 only for C++ programs; you can use the other options with any
1322 language supported by GCC@.
1323
1324 Here is a list of options that are @emph{only} for compiling C++ programs:
1325
1326 @table @gcctabopt
1327
1328 @item -fabi-version=@var{n}
1329 @opindex fabi-version
1330 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1331 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1332 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1333 the version that conforms most closely to the C++ ABI specification.
1334 Therefore, the ABI obtained using version 0 will change as ABI bugs
1335 are fixed.
1336
1337 The default is version 2.
1338
1339 @item -fno-access-control
1340 @opindex fno-access-control
1341 Turn off all access checking.  This switch is mainly useful for working
1342 around bugs in the access control code.
1343
1344 @item -fcheck-new
1345 @opindex fcheck-new
1346 Check that the pointer returned by @code{operator new} is non-null
1347 before attempting to modify the storage allocated.  This check is
1348 normally unnecessary because the C++ standard specifies that
1349 @code{operator new} will only return @code{0} if it is declared
1350 @samp{throw()}, in which case the compiler will always check the
1351 return value even without this option.  In all other cases, when
1352 @code{operator new} has a non-empty exception specification, memory
1353 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1354 @samp{new (nothrow)}.
1355
1356 @item -fconserve-space
1357 @opindex fconserve-space
1358 Put uninitialized or runtime-initialized global variables into the
1359 common segment, as C does.  This saves space in the executable at the
1360 cost of not diagnosing duplicate definitions.  If you compile with this
1361 flag and your program mysteriously crashes after @code{main()} has
1362 completed, you may have an object that is being destroyed twice because
1363 two definitions were merged.
1364
1365 This option is no longer useful on most targets, now that support has
1366 been added for putting variables into BSS without making them common.
1367
1368 @item -fno-const-strings
1369 @opindex fno-const-strings
1370 Give string constants type @code{char *} instead of type @code{const
1371 char *}.  By default, G++ uses type @code{const char *} as required by
1372 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1373 actually modify the value of a string constant.
1374
1375 This option might be removed in a future release of G++.  For maximum
1376 portability, you should structure your code so that it works with
1377 string constants that have type @code{const char *}.
1378
1379 @item -fno-elide-constructors
1380 @opindex fno-elide-constructors
1381 The C++ standard allows an implementation to omit creating a temporary
1382 which is only used to initialize another object of the same type.
1383 Specifying this option disables that optimization, and forces G++ to
1384 call the copy constructor in all cases.
1385
1386 @item -fno-enforce-eh-specs
1387 @opindex fno-enforce-eh-specs
1388 Don't check for violation of exception specifications at runtime.  This
1389 option violates the C++ standard, but may be useful for reducing code
1390 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1391 will still optimize based on the exception specifications.
1392
1393 @item -ffor-scope
1394 @itemx -fno-for-scope
1395 @opindex ffor-scope
1396 @opindex fno-for-scope
1397 If @option{-ffor-scope} is specified, the scope of variables declared in
1398 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1399 as specified by the C++ standard.
1400 If @option{-fno-for-scope} is specified, the scope of variables declared in
1401 a @i{for-init-statement} extends to the end of the enclosing scope,
1402 as was the case in old versions of G++, and other (traditional)
1403 implementations of C++.
1404
1405 The default if neither flag is given to follow the standard,
1406 but to allow and give a warning for old-style code that would
1407 otherwise be invalid, or have different behavior.
1408
1409 @item -fno-gnu-keywords
1410 @opindex fno-gnu-keywords
1411 Do not recognize @code{typeof} as a keyword, so that code can use this
1412 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1413 @option{-ansi} implies @option{-fno-gnu-keywords}.
1414
1415 @item -fno-implicit-templates
1416 @opindex fno-implicit-templates
1417 Never emit code for non-inline templates which are instantiated
1418 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1419 @xref{Template Instantiation}, for more information.
1420
1421 @item -fno-implicit-inline-templates
1422 @opindex fno-implicit-inline-templates
1423 Don't emit code for implicit instantiations of inline templates, either.
1424 The default is to handle inlines differently so that compiles with and
1425 without optimization will need the same set of explicit instantiations.
1426
1427 @item -fno-implement-inlines
1428 @opindex fno-implement-inlines
1429 To save space, do not emit out-of-line copies of inline functions
1430 controlled by @samp{#pragma implementation}.  This will cause linker
1431 errors if these functions are not inlined everywhere they are called.
1432
1433 @item -fms-extensions
1434 @opindex fms-extensions
1435 Disable pedantic warnings about constructs used in MFC, such as implicit
1436 int and getting a pointer to member function via non-standard syntax.
1437
1438 @item -fno-nonansi-builtins
1439 @opindex fno-nonansi-builtins
1440 Disable built-in declarations of functions that are not mandated by
1441 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1442 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1443
1444 @item -fno-operator-names
1445 @opindex fno-operator-names
1446 Do not treat the operator name keywords @code{and}, @code{bitand},
1447 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1448 synonyms as keywords.
1449
1450 @item -fno-optional-diags
1451 @opindex fno-optional-diags
1452 Disable diagnostics that the standard says a compiler does not need to
1453 issue.  Currently, the only such diagnostic issued by G++ is the one for
1454 a name having multiple meanings within a class.
1455
1456 @item -fpermissive
1457 @opindex fpermissive
1458 Downgrade some diagnostics about nonconformant code from errors to
1459 warnings.  Thus, using @option{-fpermissive} will allow some
1460 nonconforming code to compile.
1461
1462 @item -frepo
1463 @opindex frepo
1464 Enable automatic template instantiation at link time.  This option also
1465 implies @option{-fno-implicit-templates}.  @xref{Template
1466 Instantiation}, for more information.
1467
1468 @item -fno-rtti
1469 @opindex fno-rtti
1470 Disable generation of information about every class with virtual
1471 functions for use by the C++ runtime type identification features
1472 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1473 of the language, you can save some space by using this flag.  Note that
1474 exception handling uses the same information, but it will generate it as
1475 needed.
1476
1477 @item -fstats
1478 @opindex fstats
1479 Emit statistics about front-end processing at the end of the compilation.
1480 This information is generally only useful to the G++ development team.
1481
1482 @item -ftemplate-depth-@var{n}
1483 @opindex ftemplate-depth
1484 Set the maximum instantiation depth for template classes to @var{n}.
1485 A limit on the template instantiation depth is needed to detect
1486 endless recursions during template class instantiation.  ANSI/ISO C++
1487 conforming programs must not rely on a maximum depth greater than 17.
1488
1489 @item -fno-threadsafe-statics
1490 @opindex fno-threadsafe-statics
1491 Do not emit the extra code to use the routines specified in the C++
1492 ABI for thread-safe initialization of local statics.  You can use this
1493 option to reduce code size slightly in code that doesn't need to be
1494 thread-safe.
1495
1496 @item -fuse-cxa-atexit
1497 @opindex fuse-cxa-atexit
1498 Register destructors for objects with static storage duration with the
1499 @code{__cxa_atexit} function rather than the @code{atexit} function.
1500 This option is required for fully standards-compliant handling of static
1501 destructors, but will only work if your C library supports
1502 @code{__cxa_atexit}.
1503
1504 @item -fvisibility-inlines-hidden
1505 @opindex fvisibility-inlines-hidden
1506 Causes all inlined methods to be marked with
1507 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1508 appear in the export table of a DSO and do not require a PLT indirection
1509 when used within the DSO. Enabling this option can have a dramatic effect
1510 on load and link times of a DSO as it massively reduces the size of the
1511 dynamic export table when the library makes heavy use of templates. While
1512 it can cause bloating through duplication of code within each DSO where
1513 it is used, often the wastage is less than the considerable space occupied
1514 by a long symbol name in the export table which is typical when using
1515 templates and namespaces. For even more savings, combine with the
1516 @option{-fvisibility=hidden} switch.
1517
1518 @item -fno-weak
1519 @opindex fno-weak
1520 Do not use weak symbol support, even if it is provided by the linker.
1521 By default, G++ will use weak symbols if they are available.  This
1522 option exists only for testing, and should not be used by end-users;
1523 it will result in inferior code and has no benefits.  This option may
1524 be removed in a future release of G++.
1525
1526 @item -nostdinc++
1527 @opindex nostdinc++
1528 Do not search for header files in the standard directories specific to
1529 C++, but do still search the other standard directories.  (This option
1530 is used when building the C++ library.)
1531 @end table
1532
1533 In addition, these optimization, warning, and code generation options
1534 have meanings only for C++ programs:
1535
1536 @table @gcctabopt
1537 @item -fno-default-inline
1538 @opindex fno-default-inline
1539 Do not assume @samp{inline} for functions defined inside a class scope.
1540 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1541 functions will have linkage like inline functions; they just won't be
1542 inlined by default.
1543
1544 @item -Wabi @r{(C++ only)}
1545 @opindex Wabi
1546 Warn when G++ generates code that is probably not compatible with the
1547 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1548 all such cases, there are probably some cases that are not warned about,
1549 even though G++ is generating incompatible code.  There may also be
1550 cases where warnings are emitted even though the code that is generated
1551 will be compatible.
1552
1553 You should rewrite your code to avoid these warnings if you are
1554 concerned about the fact that code generated by G++ may not be binary
1555 compatible with code generated by other compilers.
1556
1557 The known incompatibilities at this point include:
1558
1559 @itemize @bullet
1560
1561 @item
1562 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1563 pack data into the same byte as a base class.  For example:
1564
1565 @smallexample
1566 struct A @{ virtual void f(); int f1 : 1; @};
1567 struct B : public A @{ int f2 : 1; @};
1568 @end smallexample
1569
1570 @noindent
1571 In this case, G++ will place @code{B::f2} into the same byte
1572 as@code{A::f1}; other compilers will not.  You can avoid this problem
1573 by explicitly padding @code{A} so that its size is a multiple of the
1574 byte size on your platform; that will cause G++ and other compilers to
1575 layout @code{B} identically.
1576
1577 @item
1578 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1579 tail padding when laying out virtual bases.  For example:
1580
1581 @smallexample
1582 struct A @{ virtual void f(); char c1; @};
1583 struct B @{ B(); char c2; @};
1584 struct C : public A, public virtual B @{@};
1585 @end smallexample
1586
1587 @noindent
1588 In this case, G++ will not place @code{B} into the tail-padding for
1589 @code{A}; other compilers will.  You can avoid this problem by
1590 explicitly padding @code{A} so that its size is a multiple of its
1591 alignment (ignoring virtual base classes); that will cause G++ and other
1592 compilers to layout @code{C} identically.
1593
1594 @item
1595 Incorrect handling of bit-fields with declared widths greater than that
1596 of their underlying types, when the bit-fields appear in a union.  For
1597 example:
1598
1599 @smallexample
1600 union U @{ int i : 4096; @};
1601 @end smallexample
1602
1603 @noindent
1604 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1605 union too small by the number of bits in an @code{int}.
1606
1607 @item
1608 Empty classes can be placed at incorrect offsets.  For example:
1609
1610 @smallexample
1611 struct A @{@};
1612
1613 struct B @{
1614   A a;
1615   virtual void f ();
1616 @};
1617
1618 struct C : public B, public A @{@};
1619 @end smallexample
1620
1621 @noindent
1622 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1623 it should be placed at offset zero.  G++ mistakenly believes that the
1624 @code{A} data member of @code{B} is already at offset zero.
1625
1626 @item
1627 Names of template functions whose types involve @code{typename} or
1628 template template parameters can be mangled incorrectly.
1629
1630 @smallexample
1631 template <typename Q>
1632 void f(typename Q::X) @{@}
1633
1634 template <template <typename> class Q>
1635 void f(typename Q<int>::X) @{@}
1636 @end smallexample
1637
1638 @noindent
1639 Instantiations of these templates may be mangled incorrectly.
1640
1641 @end itemize
1642
1643 @item -Wctor-dtor-privacy @r{(C++ only)}
1644 @opindex Wctor-dtor-privacy
1645 Warn when a class seems unusable because all the constructors or
1646 destructors in that class are private, and it has neither friends nor
1647 public static member functions.
1648
1649 @item -Wnon-virtual-dtor @r{(C++ only)}
1650 @opindex Wnon-virtual-dtor
1651 Warn when a class appears to be polymorphic, thereby requiring a virtual
1652 destructor, yet it declares a non-virtual one.
1653 This warning is enabled by @option{-Wall}.
1654
1655 @item -Wreorder @r{(C++ only)}
1656 @opindex Wreorder
1657 @cindex reordering, warning
1658 @cindex warning for reordering of member initializers
1659 Warn when the order of member initializers given in the code does not
1660 match the order in which they must be executed.  For instance:
1661
1662 @smallexample
1663 struct A @{
1664   int i;
1665   int j;
1666   A(): j (0), i (1) @{ @}
1667 @};
1668 @end smallexample
1669
1670 The compiler will rearrange the member initializers for @samp{i}
1671 and @samp{j} to match the declaration order of the members, emitting
1672 a warning to that effect.  This warning is enabled by @option{-Wall}.
1673 @end table
1674
1675 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1676
1677 @table @gcctabopt
1678 @item -Weffc++ @r{(C++ only)}
1679 @opindex Weffc++
1680 Warn about violations of the following style guidelines from Scott Meyers'
1681 @cite{Effective C++} book:
1682
1683 @itemize @bullet
1684 @item
1685 Item 11:  Define a copy constructor and an assignment operator for classes
1686 with dynamically allocated memory.
1687
1688 @item
1689 Item 12:  Prefer initialization to assignment in constructors.
1690
1691 @item
1692 Item 14:  Make destructors virtual in base classes.
1693
1694 @item
1695 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1696
1697 @item
1698 Item 23:  Don't try to return a reference when you must return an object.
1699
1700 @end itemize
1701
1702 Also warn about violations of the following style guidelines from
1703 Scott Meyers' @cite{More Effective C++} book:
1704
1705 @itemize @bullet
1706 @item
1707 Item 6:  Distinguish between prefix and postfix forms of increment and
1708 decrement operators.
1709
1710 @item
1711 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1712
1713 @end itemize
1714
1715 When selecting this option, be aware that the standard library
1716 headers do not obey all of these guidelines; use @samp{grep -v}
1717 to filter out those warnings.
1718
1719 @item -Wno-deprecated @r{(C++ only)}
1720 @opindex Wno-deprecated
1721 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1722
1723 @item -Wno-non-template-friend @r{(C++ only)}
1724 @opindex Wno-non-template-friend
1725 Disable warnings when non-templatized friend functions are declared
1726 within a template.  Since the advent of explicit template specification
1727 support in G++, if the name of the friend is an unqualified-id (i.e.,
1728 @samp{friend foo(int)}), the C++ language specification demands that the
1729 friend declare or define an ordinary, nontemplate function.  (Section
1730 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1731 could be interpreted as a particular specialization of a templatized
1732 function.  Because this non-conforming behavior is no longer the default
1733 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1734 check existing code for potential trouble spots and is on by default.
1735 This new compiler behavior can be turned off with
1736 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1737 but disables the helpful warning.
1738
1739 @item -Wold-style-cast @r{(C++ only)}
1740 @opindex Wold-style-cast
1741 Warn if an old-style (C-style) cast to a non-void type is used within
1742 a C++ program.  The new-style casts (@samp{static_cast},
1743 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1744 unintended effects and much easier to search for.
1745
1746 @item -Woverloaded-virtual @r{(C++ only)}
1747 @opindex Woverloaded-virtual
1748 @cindex overloaded virtual fn, warning
1749 @cindex warning for overloaded virtual fn
1750 Warn when a function declaration hides virtual functions from a
1751 base class.  For example, in:
1752
1753 @smallexample
1754 struct A @{
1755   virtual void f();
1756 @};
1757
1758 struct B: public A @{
1759   void f(int);
1760 @};
1761 @end smallexample
1762
1763 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1764 like:
1765
1766 @smallexample
1767 B* b;
1768 b->f();
1769 @end smallexample
1770
1771 will fail to compile.
1772
1773 @item -Wno-pmf-conversions @r{(C++ only)}
1774 @opindex Wno-pmf-conversions
1775 Disable the diagnostic for converting a bound pointer to member function
1776 to a plain pointer.
1777
1778 @item -Wsign-promo @r{(C++ only)}
1779 @opindex Wsign-promo
1780 Warn when overload resolution chooses a promotion from unsigned or
1781 enumerated type to a signed type, over a conversion to an unsigned type of
1782 the same size.  Previous versions of G++ would try to preserve
1783 unsignedness, but the standard mandates the current behavior.
1784
1785 @item -Wsynth @r{(C++ only)}
1786 @opindex Wsynth
1787 @cindex warning for synthesized methods
1788 @cindex synthesized methods, warning
1789 Warn when G++'s synthesis behavior does not match that of cfront.  For
1790 instance:
1791
1792 @smallexample
1793 struct A @{
1794   operator int ();
1795   A& operator = (int);
1796 @};
1797
1798 main ()
1799 @{
1800   A a,b;
1801   a = b;
1802 @}
1803 @end smallexample
1804
1805 In this example, G++ will synthesize a default @samp{A& operator =
1806 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1807 @end table
1808
1809 @node Objective-C and Objective-C++ Dialect Options
1810 @section Options Controlling Objective-C and Objective-C++ Dialects
1811
1812 @cindex compiler options, Objective-C and Objective-C++
1813 @cindex Objective-C and Objective-C++ options, command line
1814 @cindex options, Objective-C and Objective-C++
1815 (NOTE: This manual does not describe the Objective-C and Objective-C++
1816 languages themselves.  See @xref{Standards,,Language Standards
1817 Supported by GCC}, for references.)
1818
1819 This section describes the command-line options that are only meaningful
1820 for Objective-C and Objective-C++ programs, but you can also use most of
1821 the language-independent GNU compiler options.
1822 For example, you might compile a file @code{some_class.m} like this:
1823
1824 @smallexample
1825 gcc -g -fgnu-runtime -O -c some_class.m
1826 @end smallexample
1827
1828 @noindent
1829 In this example, @option{-fgnu-runtime} is an option meant only for
1830 Objective-C and Objective-C++ programs; you can use the other options with
1831 any language supported by GCC@.
1832
1833 Note that since Objective-C is an extension of the C language, Objective-C
1834 compilations may also use options specific to the C front-end (e.g., 
1835 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1836 C++-specific options (e.g., @option{-Wabi}).
1837
1838 Here is a list of options that are @emph{only} for compiling Objective-C
1839 and Objective-C++ programs:
1840
1841 @table @gcctabopt
1842 @item -fconstant-string-class=@var{class-name}
1843 @opindex fconstant-string-class
1844 Use @var{class-name} as the name of the class to instantiate for each
1845 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1846 class name is @code{NXConstantString} if the GNU runtime is being used, and
1847 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1848 @option{-fconstant-cfstrings} option, if also present, will override the
1849 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1850 to be laid out as constant CoreFoundation strings.
1851
1852 @item -fgnu-runtime
1853 @opindex fgnu-runtime
1854 Generate object code compatible with the standard GNU Objective-C
1855 runtime.  This is the default for most types of systems.
1856
1857 @item -fnext-runtime
1858 @opindex fnext-runtime
1859 Generate output compatible with the NeXT runtime.  This is the default
1860 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1861 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1862 used.
1863
1864 @item -fno-nil-receivers
1865 @opindex fno-nil-receivers
1866 Assume that all Objective-C message dispatches (e.g.,
1867 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1868 is not @code{nil}.  This allows for more efficient entry points in the runtime
1869 to be used.  Currently, this option is only available in conjunction with
1870 the NeXT runtime on Mac OS X 10.3 and later.
1871
1872 @item -fobjc-exceptions
1873 @opindex fobjc-exceptions
1874 Enable syntactic support for structured exception handling in Objective-C,
1875 similar to what is offered by C++ and Java.  Currently, this option is only
1876 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1877
1878 @smallexample
1879   @@try @{
1880     @dots{}
1881        @@throw expr;
1882     @dots{}
1883   @}
1884   @@catch (AnObjCClass *exc) @{
1885     @dots{}
1886       @@throw expr;
1887     @dots{}
1888       @@throw;
1889     @dots{}
1890   @}
1891   @@catch (AnotherClass *exc) @{
1892     @dots{}
1893   @}
1894   @@catch (id allOthers) @{
1895     @dots{}
1896   @}
1897   @@finally @{
1898     @dots{}
1899       @@throw expr;
1900     @dots{}
1901   @}
1902 @end smallexample
1903
1904 The @code{@@throw} statement may appear anywhere in an Objective-C or
1905 Objective-C++ program; when used inside of a @code{@@catch} block, the
1906 @code{@@throw} may appear without an argument (as shown above), in which case
1907 the object caught by the @code{@@catch} will be rethrown.
1908
1909 Note that only (pointers to) Objective-C objects may be thrown and
1910 caught using this scheme.  When an object is thrown, it will be caught
1911 by the nearest @code{@@catch} clause capable of handling objects of that type,
1912 analogously to how @code{catch} blocks work in C++ and Java.  A
1913 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1914 any and all Objective-C exceptions not caught by previous @code{@@catch}
1915 clauses (if any).
1916
1917 The @code{@@finally} clause, if present, will be executed upon exit from the
1918 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1919 regardless of whether any exceptions are thrown, caught or rethrown
1920 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1921 of the @code{finally} clause in Java.
1922
1923 There are several caveats to using the new exception mechanism:
1924
1925 @itemize @bullet
1926 @item
1927 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1928 idioms provided by the @code{NSException} class, the new
1929 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1930 systems, due to additional functionality needed in the (NeXT) Objective-C
1931 runtime.
1932
1933 @item
1934 As mentioned above, the new exceptions do not support handling
1935 types other than Objective-C objects.   Furthermore, when used from
1936 Objective-C++, the Objective-C exception model does not interoperate with C++
1937 exceptions at this time.  This means you cannot @code{@@throw} an exception
1938 from Objective-C and @code{catch} it in C++, or vice versa
1939 (i.e., @code{throw @dots{} @@catch}).
1940 @end itemize
1941
1942 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1943 blocks for thread-safe execution:
1944
1945 @smallexample
1946   @@synchronized (ObjCClass *guard) @{
1947     @dots{}
1948   @}
1949 @end smallexample
1950
1951 Upon entering the @code{@@synchronized} block, a thread of execution shall
1952 first check whether a lock has been placed on the corresponding @code{guard}
1953 object by another thread.  If it has, the current thread shall wait until
1954 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1955 the current thread will place its own lock on it, execute the code contained in
1956 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1957 making @code{guard} available to other threads).
1958
1959 Unlike Java, Objective-C does not allow for entire methods to be marked
1960 @code{@@synchronized}.  Note that throwing exceptions out of
1961 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1962 to be unlocked properly.
1963
1964 @item -freplace-objc-classes
1965 @opindex freplace-objc-classes
1966 Emit a special marker instructing @command{ld(1)} not to statically link in
1967 the resulting object file, and allow @command{dyld(1)} to load it in at
1968 run time instead.  This is used in conjunction with the Fix-and-Continue
1969 debugging mode, where the object file in question may be recompiled and
1970 dynamically reloaded in the course of program execution, without the need
1971 to restart the program itself.  Currently, Fix-and-Continue functionality
1972 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1973 and later.
1974
1975 @item -fzero-link
1976 @opindex fzero-link
1977 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1978 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1979 compile time) with static class references that get initialized at load time,
1980 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1981 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1982 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1983 for individual class implementations to be modified during program execution.
1984
1985 @item -gen-decls
1986 @opindex gen-decls
1987 Dump interface declarations for all classes seen in the source file to a
1988 file named @file{@var{sourcename}.decl}.
1989
1990 @item -Wno-protocol
1991 @opindex Wno-protocol
1992 If a class is declared to implement a protocol, a warning is issued for
1993 every method in the protocol that is not implemented by the class.  The
1994 default behavior is to issue a warning for every method not explicitly
1995 implemented in the class, even if a method implementation is inherited
1996 from the superclass.  If you use the @option{-Wno-protocol} option, then
1997 methods inherited from the superclass are considered to be implemented,
1998 and no warning is issued for them.
1999
2000 @item -Wselector
2001 @opindex Wselector
2002 Warn if multiple methods of different types for the same selector are
2003 found during compilation.  The check is performed on the list of methods
2004 in the final stage of compilation.  Additionally, a check is performed
2005 for each selector appearing in a @code{@@selector(@dots{})}
2006 expression, and a corresponding method for that selector has been found
2007 during compilation.  Because these checks scan the method table only at
2008 the end of compilation, these warnings are not produced if the final
2009 stage of compilation is not reached, for example because an error is
2010 found during compilation, or because the @option{-fsyntax-only} option is
2011 being used.
2012
2013 @item -Wundeclared-selector
2014 @opindex Wundeclared-selector
2015 Warn if a @code{@@selector(@dots{})} expression referring to an
2016 undeclared selector is found.  A selector is considered undeclared if no
2017 method with that name has been declared before the
2018 @code{@@selector(@dots{})} expression, either explicitly in an
2019 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2020 an @code{@@implementation} section.  This option always performs its
2021 checks as soon as a @code{@@selector(@dots{})} expression is found,
2022 while @option{-Wselector} only performs its checks in the final stage of
2023 compilation.  This also enforces the coding style convention
2024 that methods and selectors must be declared before being used.
2025
2026 @item -print-objc-runtime-info
2027 @opindex print-objc-runtime-info
2028 Generate C header describing the largest structure that is passed by
2029 value, if any.
2030
2031 @end table
2032
2033 @node Language Independent Options
2034 @section Options to Control Diagnostic Messages Formatting
2035 @cindex options to control diagnostics formatting
2036 @cindex diagnostic messages
2037 @cindex message formatting
2038
2039 Traditionally, diagnostic messages have been formatted irrespective of
2040 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2041 below can be used to control the diagnostic messages formatting
2042 algorithm, e.g.@: how many characters per line, how often source location
2043 information should be reported.  Right now, only the C++ front end can
2044 honor these options.  However it is expected, in the near future, that
2045 the remaining front ends would be able to digest them correctly.
2046
2047 @table @gcctabopt
2048 @item -fmessage-length=@var{n}
2049 @opindex fmessage-length
2050 Try to format error messages so that they fit on lines of about @var{n}
2051 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2052 the front ends supported by GCC@.  If @var{n} is zero, then no
2053 line-wrapping will be done; each error message will appear on a single
2054 line.
2055
2056 @opindex fdiagnostics-show-location
2057 @item -fdiagnostics-show-location=once
2058 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2059 reporter to emit @emph{once} source location information; that is, in
2060 case the message is too long to fit on a single physical line and has to
2061 be wrapped, the source location won't be emitted (as prefix) again,
2062 over and over, in subsequent continuation lines.  This is the default
2063 behavior.
2064
2065 @item -fdiagnostics-show-location=every-line
2066 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2067 messages reporter to emit the same source location information (as
2068 prefix) for physical lines that result from the process of breaking
2069 a message which is too long to fit on a single line.
2070
2071 @end table
2072
2073 @node Warning Options
2074 @section Options to Request or Suppress Warnings
2075 @cindex options to control warnings
2076 @cindex warning messages
2077 @cindex messages, warning
2078 @cindex suppressing warnings
2079
2080 Warnings are diagnostic messages that report constructions which
2081 are not inherently erroneous but which are risky or suggest there
2082 may have been an error.
2083
2084 You can request many specific warnings with options beginning @samp{-W},
2085 for example @option{-Wimplicit} to request warnings on implicit
2086 declarations.  Each of these specific warning options also has a
2087 negative form beginning @samp{-Wno-} to turn off warnings;
2088 for example, @option{-Wno-implicit}.  This manual lists only one of the
2089 two forms, whichever is not the default.
2090
2091 The following options control the amount and kinds of warnings produced
2092 by GCC; for further, language-specific options also refer to
2093 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2094 Options}.
2095
2096 @table @gcctabopt
2097 @cindex syntax checking
2098 @item -fsyntax-only
2099 @opindex fsyntax-only
2100 Check the code for syntax errors, but don't do anything beyond that.
2101
2102 @item -pedantic
2103 @opindex pedantic
2104 Issue all the warnings demanded by strict ISO C and ISO C++;
2105 reject all programs that use forbidden extensions, and some other
2106 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2107 version of the ISO C standard specified by any @option{-std} option used.
2108
2109 Valid ISO C and ISO C++ programs should compile properly with or without
2110 this option (though a rare few will require @option{-ansi} or a
2111 @option{-std} option specifying the required version of ISO C)@.  However,
2112 without this option, certain GNU extensions and traditional C and C++
2113 features are supported as well.  With this option, they are rejected.
2114
2115 @option{-pedantic} does not cause warning messages for use of the
2116 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2117 warnings are also disabled in the expression that follows
2118 @code{__extension__}.  However, only system header files should use
2119 these escape routes; application programs should avoid them.
2120 @xref{Alternate Keywords}.
2121
2122 Some users try to use @option{-pedantic} to check programs for strict ISO
2123 C conformance.  They soon find that it does not do quite what they want:
2124 it finds some non-ISO practices, but not all---only those for which
2125 ISO C @emph{requires} a diagnostic, and some others for which
2126 diagnostics have been added.
2127
2128 A feature to report any failure to conform to ISO C might be useful in
2129 some instances, but would require considerable additional work and would
2130 be quite different from @option{-pedantic}.  We don't have plans to
2131 support such a feature in the near future.
2132
2133 Where the standard specified with @option{-std} represents a GNU
2134 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2135 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2136 extended dialect is based.  Warnings from @option{-pedantic} are given
2137 where they are required by the base standard.  (It would not make sense
2138 for such warnings to be given only for features not in the specified GNU
2139 C dialect, since by definition the GNU dialects of C include all
2140 features the compiler supports with the given option, and there would be
2141 nothing to warn about.)
2142
2143 @item -pedantic-errors
2144 @opindex pedantic-errors
2145 Like @option{-pedantic}, except that errors are produced rather than
2146 warnings.
2147
2148 @item -w
2149 @opindex w
2150 Inhibit all warning messages.
2151
2152 @item -Wno-import
2153 @opindex Wno-import
2154 Inhibit warning messages about the use of @samp{#import}.
2155
2156 @item -Wchar-subscripts
2157 @opindex Wchar-subscripts
2158 Warn if an array subscript has type @code{char}.  This is a common cause
2159 of error, as programmers often forget that this type is signed on some
2160 machines.
2161
2162 @item -Wcomment
2163 @opindex Wcomment
2164 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2165 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2166
2167 @item -Wfatal-errors
2168 @opindex Wfatal-errors
2169 This option causes the compiler to abort compilation on the first error
2170 occurred rather than trying to keep going and printing further error
2171 messages.
2172
2173 @item -Wformat
2174 @opindex Wformat
2175 @opindex ffreestanding
2176 @opindex fno-builtin
2177 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2178 the arguments supplied have types appropriate to the format string
2179 specified, and that the conversions specified in the format string make
2180 sense.  This includes standard functions, and others specified by format
2181 attributes (@pxref{Function Attributes}), in the @code{printf},
2182 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2183 not in the C standard) families (or other target-specific families).
2184 Which functions are checked without format attributes having been
2185 specified depends on the standard version selected, and such checks of
2186 functions without the attribute specified are disabled by
2187 @option{-ffreestanding} or @option{-fno-builtin}.
2188
2189 The formats are checked against the format features supported by GNU
2190 libc version 2.2.  These include all ISO C90 and C99 features, as well
2191 as features from the Single Unix Specification and some BSD and GNU
2192 extensions.  Other library implementations may not support all these
2193 features; GCC does not support warning about features that go beyond a
2194 particular library's limitations.  However, if @option{-pedantic} is used
2195 with @option{-Wformat}, warnings will be given about format features not
2196 in the selected standard version (but not for @code{strfmon} formats,
2197 since those are not in any version of the C standard).  @xref{C Dialect
2198 Options,,Options Controlling C Dialect}.
2199
2200 Since @option{-Wformat} also checks for null format arguments for
2201 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2202
2203 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2204 aspects of format checking, the options @option{-Wformat-y2k},
2205 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2206 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2207 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2208
2209 @item -Wformat-y2k
2210 @opindex Wformat-y2k
2211 If @option{-Wformat} is specified, also warn about @code{strftime}
2212 formats which may yield only a two-digit year.
2213
2214 @item -Wno-format-extra-args
2215 @opindex Wno-format-extra-args
2216 If @option{-Wformat} is specified, do not warn about excess arguments to a
2217 @code{printf} or @code{scanf} format function.  The C standard specifies
2218 that such arguments are ignored.
2219
2220 Where the unused arguments lie between used arguments that are
2221 specified with @samp{$} operand number specifications, normally
2222 warnings are still given, since the implementation could not know what
2223 type to pass to @code{va_arg} to skip the unused arguments.  However,
2224 in the case of @code{scanf} formats, this option will suppress the
2225 warning if the unused arguments are all pointers, since the Single
2226 Unix Specification says that such unused arguments are allowed.
2227
2228 @item -Wno-format-zero-length
2229 @opindex Wno-format-zero-length
2230 If @option{-Wformat} is specified, do not warn about zero-length formats.
2231 The C standard specifies that zero-length formats are allowed.
2232
2233 @item -Wformat-nonliteral
2234 @opindex Wformat-nonliteral
2235 If @option{-Wformat} is specified, also warn if the format string is not a
2236 string literal and so cannot be checked, unless the format function
2237 takes its format arguments as a @code{va_list}.
2238
2239 @item -Wformat-security
2240 @opindex Wformat-security
2241 If @option{-Wformat} is specified, also warn about uses of format
2242 functions that represent possible security problems.  At present, this
2243 warns about calls to @code{printf} and @code{scanf} functions where the
2244 format string is not a string literal and there are no format arguments,
2245 as in @code{printf (foo);}.  This may be a security hole if the format
2246 string came from untrusted input and contains @samp{%n}.  (This is
2247 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2248 in future warnings may be added to @option{-Wformat-security} that are not
2249 included in @option{-Wformat-nonliteral}.)
2250
2251 @item -Wformat=2
2252 @opindex Wformat=2
2253 Enable @option{-Wformat} plus format checks not included in
2254 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2255 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2256
2257 @item -Wnonnull
2258 @opindex Wnonnull
2259 Warn about passing a null pointer for arguments marked as
2260 requiring a non-null value by the @code{nonnull} function attribute.
2261
2262 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2263 can be disabled with the @option{-Wno-nonnull} option.
2264
2265 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2266 @opindex Winit-self
2267 Warn about uninitialized variables which are initialized with themselves.
2268 Note this option can only be used with the @option{-Wuninitialized} option,
2269 which in turn only works with @option{-O1} and above.
2270
2271 For example, GCC will warn about @code{i} being uninitialized in the
2272 following snippet only when @option{-Winit-self} has been specified:
2273 @smallexample
2274 @group
2275 int f()
2276 @{
2277   int i = i;
2278   return i;
2279 @}
2280 @end group
2281 @end smallexample
2282
2283 @item -Wimplicit-int
2284 @opindex Wimplicit-int
2285 Warn when a declaration does not specify a type.
2286
2287 @item -Wimplicit-function-declaration
2288 @itemx -Werror-implicit-function-declaration
2289 @opindex Wimplicit-function-declaration
2290 @opindex Werror-implicit-function-declaration
2291 Give a warning (or error) whenever a function is used before being
2292 declared.
2293
2294 @item -Wimplicit
2295 @opindex Wimplicit
2296 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2297
2298 @item -Wmain
2299 @opindex Wmain
2300 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2301 function with external linkage, returning int, taking either zero
2302 arguments, two, or three arguments of appropriate types.
2303
2304 @item -Wmissing-braces
2305 @opindex Wmissing-braces
2306 Warn if an aggregate or union initializer is not fully bracketed.  In
2307 the following example, the initializer for @samp{a} is not fully
2308 bracketed, but that for @samp{b} is fully bracketed.
2309
2310 @smallexample
2311 int a[2][2] = @{ 0, 1, 2, 3 @};
2312 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2313 @end smallexample
2314
2315 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2316 @opindex Wmissing-include-dirs
2317 Warn if a user-supplied include directory does not exist.
2318
2319 @item -Wparentheses
2320 @opindex Wparentheses
2321 Warn if parentheses are omitted in certain contexts, such
2322 as when there is an assignment in a context where a truth value
2323 is expected, or when operators are nested whose precedence people
2324 often get confused about.  Only the warning for an assignment used as
2325 a truth value is supported when compiling C++; the other warnings are
2326 only supported when compiling C@.
2327
2328 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2329 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2330 interpretation from that of ordinary mathematical notation.
2331
2332 Also warn about constructions where there may be confusion to which
2333 @code{if} statement an @code{else} branch belongs.  Here is an example of
2334 such a case:
2335
2336 @smallexample
2337 @group
2338 @{
2339   if (a)
2340     if (b)
2341       foo ();
2342   else
2343     bar ();
2344 @}
2345 @end group
2346 @end smallexample
2347
2348 In C, every @code{else} branch belongs to the innermost possible @code{if}
2349 statement, which in this example is @code{if (b)}.  This is often not
2350 what the programmer expected, as illustrated in the above example by
2351 indentation the programmer chose.  When there is the potential for this
2352 confusion, GCC will issue a warning when this flag is specified.
2353 To eliminate the warning, add explicit braces around the innermost
2354 @code{if} statement so there is no way the @code{else} could belong to
2355 the enclosing @code{if}.  The resulting code would look like this:
2356
2357 @smallexample
2358 @group
2359 @{
2360   if (a)
2361     @{
2362       if (b)
2363         foo ();
2364       else
2365         bar ();
2366     @}
2367 @}
2368 @end group
2369 @end smallexample
2370
2371 @item -Wsequence-point
2372 @opindex Wsequence-point
2373 Warn about code that may have undefined semantics because of violations
2374 of sequence point rules in the C standard.
2375
2376 The C standard defines the order in which expressions in a C program are
2377 evaluated in terms of @dfn{sequence points}, which represent a partial
2378 ordering between the execution of parts of the program: those executed
2379 before the sequence point, and those executed after it.  These occur
2380 after the evaluation of a full expression (one which is not part of a
2381 larger expression), after the evaluation of the first operand of a
2382 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2383 function is called (but after the evaluation of its arguments and the
2384 expression denoting the called function), and in certain other places.
2385 Other than as expressed by the sequence point rules, the order of
2386 evaluation of subexpressions of an expression is not specified.  All
2387 these rules describe only a partial order rather than a total order,
2388 since, for example, if two functions are called within one expression
2389 with no sequence point between them, the order in which the functions
2390 are called is not specified.  However, the standards committee have
2391 ruled that function calls do not overlap.
2392
2393 It is not specified when between sequence points modifications to the
2394 values of objects take effect.  Programs whose behavior depends on this
2395 have undefined behavior; the C standard specifies that ``Between the
2396 previous and next sequence point an object shall have its stored value
2397 modified at most once by the evaluation of an expression.  Furthermore,
2398 the prior value shall be read only to determine the value to be
2399 stored.''.  If a program breaks these rules, the results on any
2400 particular implementation are entirely unpredictable.
2401
2402 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2403 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2404 diagnosed by this option, and it may give an occasional false positive
2405 result, but in general it has been found fairly effective at detecting
2406 this sort of problem in programs.
2407
2408 The present implementation of this option only works for C programs.  A
2409 future implementation may also work for C++ programs.
2410
2411 The C standard is worded confusingly, therefore there is some debate
2412 over the precise meaning of the sequence point rules in subtle cases.
2413 Links to discussions of the problem, including proposed formal
2414 definitions, may be found on the GCC readings page, at
2415 @w{@uref{http://gcc.gnu.org/readings.html}}.
2416
2417 @item -Wreturn-type
2418 @opindex Wreturn-type
2419 Warn whenever a function is defined with a return-type that defaults to
2420 @code{int}.  Also warn about any @code{return} statement with no
2421 return-value in a function whose return-type is not @code{void}.
2422
2423 For C, also warn if the return type of a function has a type qualifier
2424 such as @code{const}.  Such a type qualifier has no effect, since the
2425 value returned by a function is not an lvalue.  ISO C prohibits
2426 qualified @code{void} return types on function definitions, so such
2427 return types always receive a warning even without this option.
2428
2429 For C++, a function without return type always produces a diagnostic
2430 message, even when @option{-Wno-return-type} is specified.  The only
2431 exceptions are @samp{main} and functions defined in system headers.
2432
2433 @item -Wswitch
2434 @opindex Wswitch
2435 Warn whenever a @code{switch} statement has an index of enumerated type
2436 and lacks a @code{case} for one or more of the named codes of that
2437 enumeration.  (The presence of a @code{default} label prevents this
2438 warning.)  @code{case} labels outside the enumeration range also
2439 provoke warnings when this option is used.
2440
2441 @item -Wswitch-default
2442 @opindex Wswitch-switch
2443 Warn whenever a @code{switch} statement does not have a @code{default}
2444 case.
2445
2446 @item -Wswitch-enum
2447 @opindex Wswitch-enum
2448 Warn whenever a @code{switch} statement has an index of enumerated type
2449 and lacks a @code{case} for one or more of the named codes of that
2450 enumeration.  @code{case} labels outside the enumeration range also
2451 provoke warnings when this option is used.
2452
2453 @item -Wtrigraphs
2454 @opindex Wtrigraphs
2455 Warn if any trigraphs are encountered that might change the meaning of
2456 the program (trigraphs within comments are not warned about).
2457
2458 @item -Wunused-function
2459 @opindex Wunused-function
2460 Warn whenever a static function is declared but not defined or a
2461 non\-inline static function is unused.
2462
2463 @item -Wunused-label
2464 @opindex Wunused-label
2465 Warn whenever a label is declared but not used.
2466
2467 To suppress this warning use the @samp{unused} attribute
2468 (@pxref{Variable Attributes}).
2469
2470 @item -Wunused-parameter
2471 @opindex Wunused-parameter
2472 Warn whenever a function parameter is unused aside from its declaration.
2473
2474 To suppress this warning use the @samp{unused} attribute
2475 (@pxref{Variable Attributes}).
2476
2477 @item -Wunused-variable
2478 @opindex Wunused-variable
2479 Warn whenever a local variable or non-constant static variable is unused
2480 aside from its declaration
2481
2482 To suppress this warning use the @samp{unused} attribute
2483 (@pxref{Variable Attributes}).
2484
2485 @item -Wunused-value
2486 @opindex Wunused-value
2487 Warn whenever a statement computes a result that is explicitly not used.
2488
2489 To suppress this warning cast the expression to @samp{void}.
2490
2491 @item -Wunused
2492 @opindex Wunused
2493 All the above @option{-Wunused} options combined.
2494
2495 In order to get a warning about an unused function parameter, you must
2496 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2497 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2498
2499 @item -Wuninitialized
2500 @opindex Wuninitialized
2501 Warn if an automatic variable is used without first being initialized or
2502 if a variable may be clobbered by a @code{setjmp} call.
2503
2504 These warnings are possible only in optimizing compilation,
2505 because they require data flow information that is computed only
2506 when optimizing.  If you don't specify @option{-O}, you simply won't
2507 get these warnings.
2508
2509 If you want to warn about code which uses the uninitialized value of the
2510 variable in its own initializer, use the @option{-Winit-self} option.
2511
2512 These warnings occur only for variables that are candidates for
2513 register allocation.  Therefore, they do not occur for a variable that
2514 is declared @code{volatile}, or whose address is taken, or whose size
2515 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2516 structures, unions or arrays, even when they are in registers.
2517
2518 Note that there may be no warning about a variable that is used only
2519 to compute a value that itself is never used, because such
2520 computations may be deleted by data flow analysis before the warnings
2521 are printed.
2522
2523 These warnings are made optional because GCC is not smart
2524 enough to see all the reasons why the code might be correct
2525 despite appearing to have an error.  Here is one example of how
2526 this can happen:
2527
2528 @smallexample
2529 @group
2530 @{
2531   int x;
2532   switch (y)
2533     @{
2534     case 1: x = 1;
2535       break;
2536     case 2: x = 4;
2537       break;
2538     case 3: x = 5;
2539     @}
2540   foo (x);
2541 @}
2542 @end group
2543 @end smallexample
2544
2545 @noindent
2546 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2547 always initialized, but GCC doesn't know this.  Here is
2548 another common case:
2549
2550 @smallexample
2551 @{
2552   int save_y;
2553   if (change_y) save_y = y, y = new_y;
2554   @dots{}
2555   if (change_y) y = save_y;
2556 @}
2557 @end smallexample
2558
2559 @noindent
2560 This has no bug because @code{save_y} is used only if it is set.
2561
2562 @cindex @code{longjmp} warnings
2563 This option also warns when a non-volatile automatic variable might be
2564 changed by a call to @code{longjmp}.  These warnings as well are possible
2565 only in optimizing compilation.
2566
2567 The compiler sees only the calls to @code{setjmp}.  It cannot know
2568 where @code{longjmp} will be called; in fact, a signal handler could
2569 call it at any point in the code.  As a result, you may get a warning
2570 even when there is in fact no problem because @code{longjmp} cannot
2571 in fact be called at the place which would cause a problem.
2572
2573 Some spurious warnings can be avoided if you declare all the functions
2574 you use that never return as @code{noreturn}.  @xref{Function
2575 Attributes}.
2576
2577 @item -Wunknown-pragmas
2578 @opindex Wunknown-pragmas
2579 @cindex warning for unknown pragmas
2580 @cindex unknown pragmas, warning
2581 @cindex pragmas, warning of unknown
2582 Warn when a #pragma directive is encountered which is not understood by
2583 GCC@.  If this command line option is used, warnings will even be issued
2584 for unknown pragmas in system header files.  This is not the case if
2585 the warnings were only enabled by the @option{-Wall} command line option.
2586
2587 @item -Wstrict-aliasing
2588 @opindex Wstrict-aliasing
2589 This option is only active when @option{-fstrict-aliasing} is active.
2590 It warns about code which might break the strict aliasing rules that the
2591 compiler is using for optimization. The warning does not catch all
2592 cases, but does attempt to catch the more common pitfalls. It is
2593 included in @option{-Wall}.
2594
2595 @item -Wstrict-aliasing=2
2596 @opindex Wstrict-aliasing=2
2597 This option is only active when @option{-fstrict-aliasing} is active.
2598 It warns about all code which might break the strict aliasing rules that the
2599 compiler is using for optimization.  This warning catches all cases, but
2600 it will also give a warning for some ambiguous cases that are safe.
2601
2602 @item -Wall
2603 @opindex Wall
2604 All of the above @samp{-W} options combined.  This enables all the
2605 warnings about constructions that some users consider questionable, and
2606 that are easy to avoid (or modify to prevent the warning), even in
2607 conjunction with macros.  This also enables some language-specific
2608 warnings described in @ref{C++ Dialect Options} and
2609 @ref{Objective-C and Objective-C++ Dialect Options}.
2610 @end table
2611
2612 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2613 Some of them warn about constructions that users generally do not
2614 consider questionable, but which occasionally you might wish to check
2615 for; others warn about constructions that are necessary or hard to avoid
2616 in some cases, and there is no simple way to modify the code to suppress
2617 the warning.
2618
2619 @table @gcctabopt
2620 @item -Wextra
2621 @opindex W
2622 @opindex Wextra
2623 (This option used to be called @option{-W}.  The older name is still
2624 supported, but the newer name is more descriptive.)  Print extra warning
2625 messages for these events:
2626
2627 @itemize @bullet
2628 @item
2629 A function can return either with or without a value.  (Falling
2630 off the end of the function body is considered returning without
2631 a value.)  For example, this function would evoke such a
2632 warning:
2633
2634 @smallexample
2635 @group
2636 foo (a)
2637 @{
2638   if (a > 0)
2639     return a;
2640 @}
2641 @end group
2642 @end smallexample
2643
2644 @item
2645 An expression-statement or the left-hand side of a comma expression
2646 contains no side effects.
2647 To suppress the warning, cast the unused expression to void.
2648 For example, an expression such as @samp{x[i,j]} will cause a warning,
2649 but @samp{x[(void)i,j]} will not.
2650
2651 @item
2652 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2653
2654 @item
2655 Storage-class specifiers like @code{static} are not the first things in
2656 a declaration.  According to the C Standard, this usage is obsolescent.
2657
2658 @item
2659 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2660 arguments.
2661
2662 @item
2663 A comparison between signed and unsigned values could produce an
2664 incorrect result when the signed value is converted to unsigned.
2665 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2666
2667 @item
2668 An aggregate has an initializer which does not initialize all members.
2669 This warning can be independently controlled by
2670 @option{-Wmissing-field-initializers}.
2671
2672 @item
2673 A function parameter is declared without a type specifier in K&R-style
2674 functions:
2675
2676 @smallexample
2677 void foo(bar) @{ @}
2678 @end smallexample
2679
2680 @item
2681 An empty body occurs in an @samp{if} or @samp{else} statement.
2682
2683 @item
2684 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2685 @samp{>}, or @samp{>=}.
2686
2687 @item
2688 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2689
2690 @item
2691 Any of several floating-point events that often indicate errors, such as
2692 overflow, underflow, loss of precision, etc.
2693
2694 @item @r{(C++ only)}
2695 An enumerator and a non-enumerator both appear in a conditional expression.
2696
2697 @item @r{(C++ only)}
2698 A non-static reference or non-static @samp{const} member appears in a
2699 class without constructors.
2700
2701 @item @r{(C++ only)}
2702 Ambiguous virtual bases.
2703
2704 @item @r{(C++ only)}
2705 Subscripting an array which has been declared @samp{register}.
2706
2707 @item @r{(C++ only)}
2708 Taking the address of a variable which has been declared @samp{register}.
2709
2710 @item @r{(C++ only)}
2711 A base class is not initialized in a derived class' copy constructor.
2712 @end itemize
2713
2714 @item -Wno-div-by-zero
2715 @opindex Wno-div-by-zero
2716 @opindex Wdiv-by-zero
2717 Do not warn about compile-time integer division by zero.  Floating point
2718 division by zero is not warned about, as it can be a legitimate way of
2719 obtaining infinities and NaNs.
2720
2721 @item -Wsystem-headers
2722 @opindex Wsystem-headers
2723 @cindex warnings from system headers
2724 @cindex system headers, warnings from
2725 Print warning messages for constructs found in system header files.
2726 Warnings from system headers are normally suppressed, on the assumption
2727 that they usually do not indicate real problems and would only make the
2728 compiler output harder to read.  Using this command line option tells
2729 GCC to emit warnings from system headers as if they occurred in user
2730 code.  However, note that using @option{-Wall} in conjunction with this
2731 option will @emph{not} warn about unknown pragmas in system
2732 headers---for that, @option{-Wunknown-pragmas} must also be used.
2733
2734 @item -Wfloat-equal
2735 @opindex Wfloat-equal
2736 Warn if floating point values are used in equality comparisons.
2737
2738 The idea behind this is that sometimes it is convenient (for the
2739 programmer) to consider floating-point values as approximations to
2740 infinitely precise real numbers.  If you are doing this, then you need
2741 to compute (by analyzing the code, or in some other way) the maximum or
2742 likely maximum error that the computation introduces, and allow for it
2743 when performing comparisons (and when producing output, but that's a
2744 different problem).  In particular, instead of testing for equality, you
2745 would check to see whether the two values have ranges that overlap; and
2746 this is done with the relational operators, so equality comparisons are
2747 probably mistaken.
2748
2749 @item -Wtraditional @r{(C only)}
2750 @opindex Wtraditional
2751 Warn about certain constructs that behave differently in traditional and
2752 ISO C@.  Also warn about ISO C constructs that have no traditional C
2753 equivalent, and/or problematic constructs which should be avoided.
2754
2755 @itemize @bullet
2756 @item
2757 Macro parameters that appear within string literals in the macro body.
2758 In traditional C macro replacement takes place within string literals,
2759 but does not in ISO C@.
2760
2761 @item
2762 In traditional C, some preprocessor directives did not exist.
2763 Traditional preprocessors would only consider a line to be a directive
2764 if the @samp{#} appeared in column 1 on the line.  Therefore
2765 @option{-Wtraditional} warns about directives that traditional C
2766 understands but would ignore because the @samp{#} does not appear as the
2767 first character on the line.  It also suggests you hide directives like
2768 @samp{#pragma} not understood by traditional C by indenting them.  Some
2769 traditional implementations would not recognize @samp{#elif}, so it
2770 suggests avoiding it altogether.
2771
2772 @item
2773 A function-like macro that appears without arguments.
2774
2775 @item
2776 The unary plus operator.
2777
2778 @item
2779 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2780 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2781 constants.)  Note, these suffixes appear in macros defined in the system
2782 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2783 Use of these macros in user code might normally lead to spurious
2784 warnings, however GCC's integrated preprocessor has enough context to
2785 avoid warning in these cases.
2786
2787 @item
2788 A function declared external in one block and then used after the end of
2789 the block.
2790
2791 @item
2792 A @code{switch} statement has an operand of type @code{long}.
2793
2794 @item
2795 A non-@code{static} function declaration follows a @code{static} one.
2796 This construct is not accepted by some traditional C compilers.
2797
2798 @item
2799 The ISO type of an integer constant has a different width or
2800 signedness from its traditional type.  This warning is only issued if
2801 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2802 typically represent bit patterns, are not warned about.
2803
2804 @item
2805 Usage of ISO string concatenation is detected.
2806
2807 @item
2808 Initialization of automatic aggregates.
2809
2810 @item
2811 Identifier conflicts with labels.  Traditional C lacks a separate
2812 namespace for labels.
2813
2814 @item
2815 Initialization of unions.  If the initializer is zero, the warning is
2816 omitted.  This is done under the assumption that the zero initializer in
2817 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2818 initializer warnings and relies on default initialization to zero in the
2819 traditional C case.
2820
2821 @item
2822 Conversions by prototypes between fixed/floating point values and vice
2823 versa.  The absence of these prototypes when compiling with traditional
2824 C would cause serious problems.  This is a subset of the possible
2825 conversion warnings, for the full set use @option{-Wconversion}.
2826
2827 @item
2828 Use of ISO C style function definitions.  This warning intentionally is
2829 @emph{not} issued for prototype declarations or variadic functions
2830 because these ISO C features will appear in your code when using
2831 libiberty's traditional C compatibility macros, @code{PARAMS} and
2832 @code{VPARAMS}.  This warning is also bypassed for nested functions
2833 because that feature is already a GCC extension and thus not relevant to
2834 traditional C compatibility.
2835 @end itemize
2836
2837 @item -Wdeclaration-after-statement @r{(C only)}
2838 @opindex Wdeclaration-after-statement
2839 Warn when a declaration is found after a statement in a block.  This
2840 construct, known from C++, was introduced with ISO C99 and is by default
2841 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2842 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2843
2844 @item -Wundef
2845 @opindex Wundef
2846 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2847
2848 @item -Wendif-labels
2849 @opindex Wendif-labels
2850 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2851
2852 @item -Wshadow
2853 @opindex Wshadow
2854 Warn whenever a local variable shadows another local variable, parameter or
2855 global variable or whenever a built-in function is shadowed.
2856
2857 @item -Wlarger-than-@var{len}
2858 @opindex Wlarger-than
2859 Warn whenever an object of larger than @var{len} bytes is defined.
2860
2861 @item -Wpointer-arith
2862 @opindex Wpointer-arith
2863 Warn about anything that depends on the ``size of'' a function type or
2864 of @code{void}.  GNU C assigns these types a size of 1, for
2865 convenience in calculations with @code{void *} pointers and pointers
2866 to functions.
2867
2868 @item -Wbad-function-cast @r{(C only)}
2869 @opindex Wbad-function-cast
2870 Warn whenever a function call is cast to a non-matching type.
2871 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2872
2873 @item -Wcast-qual
2874 @opindex Wcast-qual
2875 Warn whenever a pointer is cast so as to remove a type qualifier from
2876 the target type.  For example, warn if a @code{const char *} is cast
2877 to an ordinary @code{char *}.
2878
2879 @item -Wcast-align
2880 @opindex Wcast-align
2881 Warn whenever a pointer is cast such that the required alignment of the
2882 target is increased.  For example, warn if a @code{char *} is cast to
2883 an @code{int *} on machines where integers can only be accessed at
2884 two- or four-byte boundaries.
2885
2886 @item -Wwrite-strings
2887 @opindex Wwrite-strings
2888 When compiling C, give string constants the type @code{const
2889 char[@var{length}]} so that
2890 copying the address of one into a non-@code{const} @code{char *}
2891 pointer will get a warning; when compiling C++, warn about the
2892 deprecated conversion from string constants to @code{char *}.
2893 These warnings will help you find at
2894 compile time code that can try to write into a string constant, but
2895 only if you have been very careful about using @code{const} in
2896 declarations and prototypes.  Otherwise, it will just be a nuisance;
2897 this is why we did not make @option{-Wall} request these warnings.
2898
2899 @item -Wconversion
2900 @opindex Wconversion
2901 Warn if a prototype causes a type conversion that is different from what
2902 would happen to the same argument in the absence of a prototype.  This
2903 includes conversions of fixed point to floating and vice versa, and
2904 conversions changing the width or signedness of a fixed point argument
2905 except when the same as the default promotion.
2906
2907 Also, warn if a negative integer constant expression is implicitly
2908 converted to an unsigned type.  For example, warn about the assignment
2909 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2910 casts like @code{(unsigned) -1}.
2911
2912 @item -Wsign-compare
2913 @opindex Wsign-compare
2914 @cindex warning for comparison of signed and unsigned values
2915 @cindex comparison of signed and unsigned values, warning
2916 @cindex signed and unsigned values, comparison warning
2917 Warn when a comparison between signed and unsigned values could produce
2918 an incorrect result when the signed value is converted to unsigned.
2919 This warning is also enabled by @option{-Wextra}; to get the other warnings
2920 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2921
2922 @item -Waggregate-return
2923 @opindex Waggregate-return
2924 Warn if any functions that return structures or unions are defined or
2925 called.  (In languages where you can return an array, this also elicits
2926 a warning.)
2927
2928 @item -Wstrict-prototypes @r{(C only)}
2929 @opindex Wstrict-prototypes
2930 Warn if a function is declared or defined without specifying the
2931 argument types.  (An old-style function definition is permitted without
2932 a warning if preceded by a declaration which specifies the argument
2933 types.)
2934
2935 @item -Wold-style-definition @r{(C only)}
2936 @opindex Wold-style-definition
2937 Warn if an old-style function definition is used.  A warning is given
2938 even if there is a previous prototype.
2939
2940 @item -Wmissing-prototypes @r{(C only)}
2941 @opindex Wmissing-prototypes
2942 Warn if a global function is defined without a previous prototype
2943 declaration.  This warning is issued even if the definition itself
2944 provides a prototype.  The aim is to detect global functions that fail
2945 to be declared in header files.
2946
2947 @item -Wmissing-declarations @r{(C only)}
2948 @opindex Wmissing-declarations
2949 Warn if a global function is defined without a previous declaration.
2950 Do so even if the definition itself provides a prototype.
2951 Use this option to detect global functions that are not declared in
2952 header files.
2953
2954 @item -Wmissing-field-initializers
2955 @opindex Wmissing-field-initializers
2956 @opindex W
2957 @opindex Wextra
2958 Warn if a structure's initializer has some fields missing.  For
2959 example, the following code would cause such a warning, because
2960 @code{x.h} is implicitly zero:
2961
2962 @smallexample
2963 struct s @{ int f, g, h; @};
2964 struct s x = @{ 3, 4 @};
2965 @end smallexample
2966
2967 This option does not warn about designated initializers, so the following
2968 modification would not trigger a warning:
2969
2970 @smallexample
2971 struct s @{ int f, g, h; @};
2972 struct s x = @{ .f = 3, .g = 4 @};
2973 @end smallexample
2974
2975 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2976 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2977
2978 @item -Wmissing-noreturn
2979 @opindex Wmissing-noreturn
2980 Warn about functions which might be candidates for attribute @code{noreturn}.
2981 Note these are only possible candidates, not absolute ones.  Care should
2982 be taken to manually verify functions actually do not ever return before
2983 adding the @code{noreturn} attribute, otherwise subtle code generation
2984 bugs could be introduced.  You will not get a warning for @code{main} in
2985 hosted C environments.
2986
2987 @item -Wmissing-format-attribute
2988 @opindex Wmissing-format-attribute
2989 @opindex Wformat
2990 If @option{-Wformat} is enabled, also warn about functions which might be
2991 candidates for @code{format} attributes.  Note these are only possible
2992 candidates, not absolute ones.  GCC will guess that @code{format}
2993 attributes might be appropriate for any function that calls a function
2994 like @code{vprintf} or @code{vscanf}, but this might not always be the
2995 case, and some functions for which @code{format} attributes are
2996 appropriate may not be detected.  This option has no effect unless
2997 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2998
2999 @item -Wno-multichar
3000 @opindex Wno-multichar
3001 @opindex Wmultichar
3002 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3003 Usually they indicate a typo in the user's code, as they have
3004 implementation-defined values, and should not be used in portable code.
3005
3006 @item -Wno-deprecated-declarations
3007 @opindex Wno-deprecated-declarations
3008 Do not warn about uses of functions, variables, and types marked as
3009 deprecated by using the @code{deprecated} attribute.
3010 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3011 @pxref{Type Attributes}.)
3012
3013 @item -Wpacked
3014 @opindex Wpacked
3015 Warn if a structure is given the packed attribute, but the packed
3016 attribute has no effect on the layout or size of the structure.
3017 Such structures may be mis-aligned for little benefit.  For
3018 instance, in this code, the variable @code{f.x} in @code{struct bar}
3019 will be misaligned even though @code{struct bar} does not itself
3020 have the packed attribute:
3021
3022 @smallexample
3023 @group
3024 struct foo @{
3025   int x;
3026   char a, b, c, d;
3027 @} __attribute__((packed));
3028 struct bar @{
3029   char z;
3030   struct foo f;
3031 @};
3032 @end group
3033 @end smallexample
3034
3035 @item -Wpadded
3036 @opindex Wpadded
3037 Warn if padding is included in a structure, either to align an element
3038 of the structure or to align the whole structure.  Sometimes when this
3039 happens it is possible to rearrange the fields of the structure to
3040 reduce the padding and so make the structure smaller.
3041
3042 @item -Wredundant-decls
3043 @opindex Wredundant-decls
3044 Warn if anything is declared more than once in the same scope, even in
3045 cases where multiple declaration is valid and changes nothing.
3046
3047 @item -Wnested-externs @r{(C only)}
3048 @opindex Wnested-externs
3049 Warn if an @code{extern} declaration is encountered within a function.
3050
3051 @item -Wunreachable-code
3052 @opindex Wunreachable-code
3053 Warn if the compiler detects that code will never be executed.
3054
3055 This option is intended to warn when the compiler detects that at
3056 least a whole line of source code will never be executed, because
3057 some condition is never satisfied or because it is after a
3058 procedure that never returns.
3059
3060 It is possible for this option to produce a warning even though there
3061 are circumstances under which part of the affected line can be executed,
3062 so care should be taken when removing apparently-unreachable code.
3063
3064 For instance, when a function is inlined, a warning may mean that the
3065 line is unreachable in only one inlined copy of the function.
3066
3067 This option is not made part of @option{-Wall} because in a debugging
3068 version of a program there is often substantial code which checks
3069 correct functioning of the program and is, hopefully, unreachable
3070 because the program does work.  Another common use of unreachable
3071 code is to provide behavior which is selectable at compile-time.
3072
3073 @item -Winline
3074 @opindex Winline
3075 Warn if a function can not be inlined and it was declared as inline.
3076 Even with this option, the compiler will not warn about failures to
3077 inline functions declared in system headers.
3078
3079 The compiler uses a variety of heuristics to determine whether or not
3080 to inline a function.  For example, the compiler takes into account
3081 the size of the function being inlined and the the amount of inlining
3082 that has already been done in the current function.  Therefore,
3083 seemingly insignificant changes in the source program can cause the
3084 warnings produced by @option{-Winline} to appear or disappear.
3085
3086 @item -Wno-invalid-offsetof @r{(C++ only)}
3087 @opindex Wno-invalid-offsetof
3088 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3089 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3090 to a non-POD type is undefined.  In existing C++ implementations,
3091 however, @samp{offsetof} typically gives meaningful results even when
3092 applied to certain kinds of non-POD types. (Such as a simple
3093 @samp{struct} that fails to be a POD type only by virtue of having a
3094 constructor.)  This flag is for users who are aware that they are
3095 writing nonportable code and who have deliberately chosen to ignore the
3096 warning about it.
3097
3098 The restrictions on @samp{offsetof} may be relaxed in a future version
3099 of the C++ standard.
3100
3101 @item -Winvalid-pch
3102 @opindex Winvalid-pch
3103 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3104 the search path but can't be used.
3105
3106 @item -Wlong-long
3107 @opindex Wlong-long
3108 @opindex Wno-long-long
3109 Warn if @samp{long long} type is used.  This is default.  To inhibit
3110 the warning messages, use @option{-Wno-long-long}.  Flags
3111 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3112 only when @option{-pedantic} flag is used.
3113
3114 @item -Wvariadic-macros
3115 @opindex Wvariadic-macros
3116 @opindex Wno-variadic-macros
3117 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3118 alternate syntax when in pedantic ISO C99 mode.  This is default.
3119 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3120
3121 @item -Wdisabled-optimization
3122 @opindex Wdisabled-optimization
3123 Warn if a requested optimization pass is disabled.  This warning does
3124 not generally indicate that there is anything wrong with your code; it
3125 merely indicates that GCC's optimizers were unable to handle the code
3126 effectively.  Often, the problem is that your code is too big or too
3127 complex; GCC will refuse to optimize programs when the optimization
3128 itself is likely to take inordinate amounts of time.
3129
3130 @item -Werror
3131 @opindex Werror
3132 Make all warnings into errors.
3133 @end table
3134
3135 @node Debugging Options
3136 @section Options for Debugging Your Program or GCC
3137 @cindex options, debugging
3138 @cindex debugging information options
3139
3140 GCC has various special options that are used for debugging
3141 either your program or GCC:
3142
3143 @table @gcctabopt
3144 @item -g
3145 @opindex g
3146 Produce debugging information in the operating system's native format
3147 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3148 information.
3149
3150 On most systems that use stabs format, @option{-g} enables use of extra
3151 debugging information that only GDB can use; this extra information
3152 makes debugging work better in GDB but will probably make other debuggers
3153 crash or
3154 refuse to read the program.  If you want to control for certain whether
3155 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3156 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3157
3158 GCC allows you to use @option{-g} with
3159 @option{-O}.  The shortcuts taken by optimized code may occasionally
3160 produce surprising results: some variables you declared may not exist
3161 at all; flow of control may briefly move where you did not expect it;
3162 some statements may not be executed because they compute constant
3163 results or their values were already at hand; some statements may
3164 execute in different places because they were moved out of loops.
3165
3166 Nevertheless it proves possible to debug optimized output.  This makes
3167 it reasonable to use the optimizer for programs that might have bugs.
3168
3169 The following options are useful when GCC is generated with the
3170 capability for more than one debugging format.
3171
3172 @item -ggdb
3173 @opindex ggdb
3174 Produce debugging information for use by GDB@.  This means to use the
3175 most expressive format available (DWARF 2, stabs, or the native format
3176 if neither of those are supported), including GDB extensions if at all
3177 possible.
3178
3179 @item -gstabs
3180 @opindex gstabs
3181 Produce debugging information in stabs format (if that is supported),
3182 without GDB extensions.  This is the format used by DBX on most BSD
3183 systems.  On MIPS, Alpha and System V Release 4 systems this option
3184 produces stabs debugging output which is not understood by DBX or SDB@.
3185 On System V Release 4 systems this option requires the GNU assembler.
3186
3187 @item -feliminate-unused-debug-symbols
3188 @opindex feliminate-unused-debug-symbols
3189 Produce debugging information in stabs format (if that is supported),
3190 for only symbols that are actually used.
3191
3192 @item -gstabs+
3193 @opindex gstabs+
3194 Produce debugging information in stabs format (if that is supported),
3195 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3196 use of these extensions is likely to make other debuggers crash or
3197 refuse to read the program.
3198
3199 @item -gcoff
3200 @opindex gcoff
3201 Produce debugging information in COFF format (if that is supported).
3202 This is the format used by SDB on most System V systems prior to
3203 System V Release 4.
3204
3205 @item -gxcoff
3206 @opindex gxcoff
3207 Produce debugging information in XCOFF format (if that is supported).
3208 This is the format used by the DBX debugger on IBM RS/6000 systems.
3209
3210 @item -gxcoff+
3211 @opindex gxcoff+
3212 Produce debugging information in XCOFF format (if that is supported),
3213 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3214 use of these extensions is likely to make other debuggers crash or
3215 refuse to read the program, and may cause assemblers other than the GNU
3216 assembler (GAS) to fail with an error.
3217
3218 @item -gdwarf-2
3219 @opindex gdwarf-2
3220 Produce debugging information in DWARF version 2 format (if that is
3221 supported).  This is the format used by DBX on IRIX 6.  With this
3222 option, GCC uses features of DWARF version 3 when they are useful;
3223 version 3 is upward compatible with version 2, but may still cause
3224 problems for older debuggers.
3225
3226 @item -gvms
3227 @opindex gvms
3228 Produce debugging information in VMS debug format (if that is
3229 supported).  This is the format used by DEBUG on VMS systems.
3230
3231 @item -g@var{level}
3232 @itemx -ggdb@var{level}
3233 @itemx -gstabs@var{level}
3234 @itemx -gcoff@var{level}
3235 @itemx -gxcoff@var{level}
3236 @itemx -gvms@var{level}
3237 Request debugging information and also use @var{level} to specify how
3238 much information.  The default level is 2.
3239
3240 Level 1 produces minimal information, enough for making backtraces in
3241 parts of the program that you don't plan to debug.  This includes
3242 descriptions of functions and external variables, but no information
3243 about local variables and no line numbers.
3244
3245 Level 3 includes extra information, such as all the macro definitions
3246 present in the program.  Some debuggers support macro expansion when
3247 you use @option{-g3}.
3248
3249 @option{-gdwarf-2} does not accept a concatenated debug level, because
3250 GCC used to support an option @option{-gdwarf} that meant to generate
3251 debug information in version 1 of the DWARF format (which is very
3252 different from version 2), and it would have been too confusing.  That
3253 debug format is long obsolete, but the option cannot be changed now.
3254 Instead use an additional @option{-g@var{level}} option to change the
3255 debug level for DWARF2.
3256
3257 @item -feliminate-dwarf2-dups
3258 @opindex feliminate-dwarf2-dups
3259 Compress DWARF2 debugging information by eliminating duplicated
3260 information about each symbol.  This option only makes sense when
3261 generating DWARF2 debugging information with @option{-gdwarf-2}.
3262
3263 @cindex @command{prof}
3264 @item -p
3265 @opindex p
3266 Generate extra code to write profile information suitable for the
3267 analysis program @command{prof}.  You must use this option when compiling
3268 the source files you want data about, and you must also use it when
3269 linking.
3270
3271 @cindex @command{gprof}
3272 @item -pg
3273 @opindex pg
3274 Generate extra code to write profile information suitable for the
3275 analysis program @command{gprof}.  You must use this option when compiling
3276 the source files you want data about, and you must also use it when
3277 linking.
3278
3279 @item -Q
3280 @opindex Q
3281 Makes the compiler print out each function name as it is compiled, and
3282 print some statistics about each pass when it finishes.
3283
3284 @item -ftime-report
3285 @opindex ftime-report
3286 Makes the compiler print some statistics about the time consumed by each
3287 pass when it finishes.
3288
3289 @item -fmem-report
3290 @opindex fmem-report
3291 Makes the compiler print some statistics about permanent memory
3292 allocation when it finishes.
3293
3294 @item -fprofile-arcs
3295 @opindex fprofile-arcs
3296 Add code so that program flow @dfn{arcs} are instrumented.  During
3297 execution the program records how many times each branch and call is
3298 executed and how many times it is taken or returns.  When the compiled
3299 program exits it saves this data to a file called
3300 @file{@var{auxname}.gcda} for each source file. The data may be used for
3301 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3302 test coverage analysis (@option{-ftest-coverage}). Each object file's
3303 @var{auxname} is generated from the name of the output file, if
3304 explicitly specified and it is not the final executable, otherwise it is
3305 the basename of the source file. In both cases any suffix is removed
3306 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3307 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3308
3309 @itemize
3310
3311 @item
3312 Compile the source files with @option{-fprofile-arcs} plus optimization
3313 and code generation options. For test coverage analysis, use the
3314 additional @option{-ftest-coverage} option. You do not need to profile
3315 every source file in a program.
3316
3317 @item
3318 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3319 (the latter implies the former).
3320
3321 @item
3322 Run the program on a representative workload to generate the arc profile
3323 information. This may be repeated any number of times. You can run
3324 concurrent instances of your program, and provided that the file system
3325 supports locking, the data files will be correctly updated. Also
3326 @code{fork} calls are detected and correctly handled (double counting
3327 will not happen).
3328
3329 @item
3330 For profile-directed optimizations, compile the source files again with
3331 the same optimization and code generation options plus
3332 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3333 Control Optimization}).
3334
3335 @item
3336 For test coverage analysis, use @command{gcov} to produce human readable
3337 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3338 @command{gcov} documentation for further information.
3339
3340 @end itemize
3341
3342 With @option{-fprofile-arcs}, for each function of your program GCC
3343 creates a program flow graph, then finds a spanning tree for the graph.
3344 Only arcs that are not on the spanning tree have to be instrumented: the
3345 compiler adds code to count the number of times that these arcs are
3346 executed.  When an arc is the only exit or only entrance to a block, the
3347 instrumentation code can be added to the block; otherwise, a new basic
3348 block must be created to hold the instrumentation code.
3349
3350 @item -ftree-based-profiling
3351 @opindex ftree-based-profiling
3352 This option is used in addition to @option{-fprofile-arcs} or
3353 @option{-fbranch-probabilities} to control whether those optimizations
3354 are performed on a tree-based or rtl-based internal representation.
3355 If you use this option when compiling with @option{-fprofile-arcs},
3356 you must also use it when compiling later with @option{-fbranch-probabilities}.
3357 Currently the tree-based optimization is in an early stage of
3358 development, and this option is recommended only for those people
3359 working on improving it.
3360
3361 @need 2000
3362 @item -ftest-coverage
3363 @opindex ftest-coverage
3364 Produce a notes file that the @command{gcov} code-coverage utility
3365 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3366 show program coverage. Each source file's note file is called
3367 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3368 above for a description of @var{auxname} and instructions on how to
3369 generate test coverage data. Coverage data will match the source files
3370 more closely, if you do not optimize.
3371
3372 @item -d@var{letters}
3373 @item -fdump-rtl-@var{pass}
3374 @opindex d
3375 Says to make debugging dumps during compilation at times specified by
3376 @var{letters}.    This is used for debugging the RTL-based passes of the
3377 compiler.  The file names for most of the dumps are made by appending a
3378 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3379 from the name of the output file, if explicitly specified and it is not
3380 an executable, otherwise it is the basename of the source file.
3381
3382 Most debug dumps can be enabled either passing a letter to the @option{-d}
3383 option, or with a long @option{-fdump-rtl} switch; here are the possible
3384 letters for use in @var{letters} and @var{pass}, and their meanings:
3385
3386 @table @gcctabopt
3387 @item -dA
3388 @opindex dA
3389 Annotate the assembler output with miscellaneous debugging information.
3390
3391 @item -db
3392 @itemx -fdump-rtl-bp
3393 @opindex db
3394 @opindex fdump-rtl-bp
3395 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3396
3397 @item -dB
3398 @itemx -fdump-rtl-bbro
3399 @opindex dB
3400 @opindex fdump-rtl-bbro
3401 Dump after block reordering, to @file{@var{file}.30.bbro}.
3402
3403 @item -dc
3404 @itemx -fdump-rtl-combine
3405 @opindex dc
3406 @opindex fdump-rtl-combine
3407 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3408
3409 @item -dC
3410 @itemx -fdump-rtl-ce1
3411 @itemx -fdump-rtl-ce2
3412 @opindex dC
3413 @opindex fdump-rtl-ce1
3414 @opindex fdump-rtl-ce2
3415 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3416 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3417 and @option{-fdump-rtl-ce2} enable dumping after the second if
3418 conversion, to the file @file{@var{file}.18.ce2}.
3419
3420 @item -dd
3421 @itemx -fdump-rtl-btl
3422 @itemx -fdump-rtl-dbr
3423 @opindex dd
3424 @opindex fdump-rtl-btl
3425 @opindex fdump-rtl-dbr
3426 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3427 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3428 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3429 scheduling, to @file{@var{file}.36.dbr}.
3430
3431 @item -dD
3432 @opindex dD
3433 Dump all macro definitions, at the end of preprocessing, in addition to
3434 normal output.
3435
3436 @item -dE
3437 @itemx -fdump-rtl-ce3
3438 @opindex dE
3439 @opindex fdump-rtl-ce3
3440 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3441
3442 @item -df
3443 @itemx -fdump-rtl-cfg
3444 @itemx -fdump-rtl-life
3445 @opindex df
3446 @opindex fdump-rtl-cfg
3447 @opindex fdump-rtl-life
3448 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3449 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3450 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3451 to @file{@var{file}.16.life}.
3452
3453 @item -dg
3454 @itemx -fdump-rtl-greg
3455 @opindex dg
3456 @opindex fdump-rtl-greg
3457 Dump after global register allocation, to @file{@var{file}.23.greg}.
3458
3459 @item -dG
3460 @itemx -fdump-rtl-gcse
3461 @itemx -fdump-rtl-bypass
3462 @opindex dG
3463 @opindex fdump-rtl-gcse
3464 @opindex fdump-rtl-bypass
3465 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3466 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3467 enable dumping after jump bypassing and control flow optimizations, to
3468 @file{@var{file}.07.bypass}.
3469
3470 @item -dh
3471 @itemx -fdump-rtl-eh
3472 @opindex dh
3473 @opindex fdump-rtl-eh
3474 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3475
3476 @item -di
3477 @itemx -fdump-rtl-sibling
3478 @opindex di
3479 @opindex fdump-rtl-sibling
3480 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3481
3482 @item -dj
3483 @itemx -fdump-rtl-jump
3484 @opindex dj
3485 @opindex fdump-rtl-jump
3486 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3487
3488 @item -dk
3489 @itemx -fdump-rtl-stack
3490 @opindex dk
3491 @opindex fdump-rtl-stack
3492 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3493
3494 @item -dl
3495 @itemx -fdump-rtl-lreg
3496 @opindex dl
3497 @opindex fdump-rtl-lreg
3498 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3499
3500 @item -dL
3501 @itemx -fdump-rtl-loop
3502 @itemx -fdump-rtl-loop2
3503 @opindex dL
3504 @opindex fdump-rtl-loop
3505 @opindex fdump-rtl-loop2
3506 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3507 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3508 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3509 @file{@var{file}.13.loop2}.
3510
3511 @item -dm
3512 @itemx -fdump-rtl-sms
3513 @opindex dm
3514 @opindex fdump-rtl-sms
3515 Dump after modulo scheduling, to @file{@var{file}.20.sms}. 
3516
3517 @item -dM
3518 @itemx -fdump-rtl-mach
3519 @opindex dM
3520 @opindex fdump-rtl-mach
3521 Dump after performing the machine dependent reorganization pass, to
3522 @file{@var{file}.35.mach}.
3523
3524 @item -dn
3525 @itemx -fdump-rtl-rnreg
3526 @opindex dn
3527 @opindex fdump-rtl-rnreg
3528 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3529
3530 @item -dN
3531 @itemx -fdump-rtl-regmove
3532 @opindex dN
3533 @opindex fdump-rtl-regmove
3534 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3535
3536 @item -do
3537 @itemx -fdump-rtl-postreload
3538 @opindex do
3539 @opindex fdump-rtl-postreload
3540 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3541
3542 @item -dr
3543 @itemx -fdump-rtl-expand
3544 @opindex dr
3545 @opindex fdump-rtl-expand
3546 Dump after RTL generation, to @file{@var{file}.00.expand}.
3547
3548 @item -dR
3549 @itemx -fdump-rtl-sched2
3550 @opindex dR
3551 @opindex fdump-rtl-sched2
3552 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3553
3554 @item -ds
3555 @itemx -fdump-rtl-cse
3556 @opindex ds
3557 @opindex fdump-rtl-cse
3558 Dump after CSE (including the jump optimization that sometimes follows
3559 CSE), to @file{@var{file}.04.cse}.
3560
3561 @item -dS
3562 @itemx -fdump-rtl-sched
3563 @opindex dS
3564 @opindex fdump-rtl-sched
3565 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3566
3567 @item -dt
3568 @itemx -fdump-rtl-cse2
3569 @opindex dt
3570 @opindex fdump-rtl-cse2
3571 Dump after the second CSE pass (including the jump optimization that
3572 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3573
3574 @item -dT
3575 @itemx -fdump-rtl-tracer
3576 @opindex dT
3577 @opindex fdump-rtl-tracer
3578 Dump after running tracer, to @file{@var{file}.12.tracer}.
3579
3580 @item -dV
3581 @itemx -fdump-rtl-vpt
3582 @itemx -fdump-rtl-vartrack
3583 @opindex dV
3584 @opindex fdump-rtl-vpt
3585 @opindex fdump-rtl-vartrack
3586 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3587 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3588 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3589 to @file{@var{file}.34.vartrack}.
3590
3591 @item -dw
3592 @itemx -fdump-rtl-flow2
3593 @opindex dw
3594 @opindex fdump-rtl-flow2
3595 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3596
3597 @item -dz
3598 @itemx -fdump-rtl-peephole2
3599 @opindex dz
3600 @opindex fdump-rtl-peephole2
3601 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3602
3603 @item -dZ
3604 @itemx -fdump-rtl-web
3605 @opindex dZ
3606 @opindex fdump-rtl-web
3607 Dump after live range splitting, to @file{@var{file}.14.web}.
3608
3609 @item -da
3610 @itemx -fdump-rtl-all
3611 @opindex da
3612 @opindex fdump-rtl-all
3613 Produce all the dumps listed above.
3614
3615 @item -dH
3616 @opindex dH
3617 Produce a core dump whenever an error occurs.
3618
3619 @item -dm
3620 @opindex dm
3621 Print statistics on memory usage, at the end of the run, to
3622 standard error.
3623
3624 @item -dp
3625 @opindex dp
3626 Annotate the assembler output with a comment indicating which
3627 pattern and alternative was used.  The length of each instruction is
3628 also printed.
3629
3630 @item -dP
3631 @opindex dP
3632 Dump the RTL in the assembler output as a comment before each instruction.
3633 Also turns on @option{-dp} annotation.
3634
3635 @item -dv
3636 @opindex dv
3637 For each of the other indicated dump files (either with @option{-d} or
3638 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3639 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3640
3641 @item -dx
3642 @opindex dx
3643 Just generate RTL for a function instead of compiling it.  Usually used
3644 with @samp{r} (@option{-fdump-rtl-expand}).