OSDN Git Service

2009-11-04 Harsha Jagasia <harsha.jagasia@amd.com>
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
15 Free Software Foundation, Inc.
16
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.2 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``GNU General Public License'' and ``Funding
21 Free Software'', the Front-Cover texts being (a) (see below), and with
22 the Back-Cover Texts being (b) (see below).  A copy of the license is
23 included in the gfdl(7) man page.
24
25 (a) The FSF's Front-Cover Text is:
26
27      A GNU Manual
28
29 (b) The FSF's Back-Cover Text is:
30
31      You have freedom to copy and modify this GNU Manual, like GNU
32      software.  Copies published by the Free Software Foundation raise
33      funds for GNU development.
34 @c man end
35 @c Set file name and title for the man page.
36 @setfilename gcc
37 @settitle GNU project C and C++ compiler
38 @c man begin SYNOPSIS
39 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
40     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
41     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
42     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
43     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
44     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
45     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
46
47 Only the most useful options are listed here; see below for the
48 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
49 @c man end
50 @c man begin SEEALSO
51 gpl(7), gfdl(7), fsf-funding(7),
52 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
53 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
54 @file{ld}, @file{binutils} and @file{gdb}.
55 @c man end
56 @c man begin BUGS
57 For instructions on reporting bugs, see
58 @w{@value{BUGURL}}.
59 @c man end
60 @c man begin AUTHOR
61 See the Info entry for @command{gcc}, or
62 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
63 for contributors to GCC@.
64 @c man end
65 @end ignore
66
67 @node Invoking GCC
68 @chapter GCC Command Options
69 @cindex GCC command options
70 @cindex command options
71 @cindex options, GCC command
72
73 @c man begin DESCRIPTION
74 When you invoke GCC, it normally does preprocessing, compilation,
75 assembly and linking.  The ``overall options'' allow you to stop this
76 process at an intermediate stage.  For example, the @option{-c} option
77 says not to run the linker.  Then the output consists of object files
78 output by the assembler.
79
80 Other options are passed on to one stage of processing.  Some options
81 control the preprocessor and others the compiler itself.  Yet other
82 options control the assembler and linker; most of these are not
83 documented here, since you rarely need to use any of them.
84
85 @cindex C compilation options
86 Most of the command line options that you can use with GCC are useful
87 for C programs; when an option is only useful with another language
88 (usually C++), the explanation says so explicitly.  If the description
89 for a particular option does not mention a source language, you can use
90 that option with all supported languages.
91
92 @cindex C++ compilation options
93 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
94 options for compiling C++ programs.
95
96 @cindex grouping options
97 @cindex options, grouping
98 The @command{gcc} program accepts options and file names as operands.  Many
99 options have multi-letter names; therefore multiple single-letter options
100 may @emph{not} be grouped: @option{-dv} is very different from @w{@samp{-d
101 -v}}.
102
103 @cindex order of options
104 @cindex options, order
105 You can mix options and other arguments.  For the most part, the order
106 you use doesn't matter.  Order does matter when you use several
107 options of the same kind; for example, if you specify @option{-L} more
108 than once, the directories are searched in the order specified.  Also,
109 the placement of the @option{-l} option is significant.
110
111 Many options have long names starting with @samp{-f} or with
112 @samp{-W}---for example,
113 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
114 these have both positive and negative forms; the negative form of
115 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
116 only one of these two forms, whichever one is not the default.
117
118 @c man end
119
120 @xref{Option Index}, for an index to GCC's options.
121
122 @menu
123 * Option Summary::      Brief list of all options, without explanations.
124 * Overall Options::     Controlling the kind of output:
125                         an executable, object files, assembler files,
126                         or preprocessed source.
127 * Invoking G++::        Compiling C++ programs.
128 * C Dialect Options::   Controlling the variant of C language compiled.
129 * C++ Dialect Options:: Variations on C++.
130 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
131                         and Objective-C++.
132 * Language Independent Options:: Controlling how diagnostics should be
133                         formatted.
134 * Warning Options::     How picky should the compiler be?
135 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
136 * Optimize Options::    How much optimization?
137 * Preprocessor Options:: Controlling header files and macro definitions.
138                          Also, getting dependency information for Make.
139 * Assembler Options::   Passing options to the assembler.
140 * Link Options::        Specifying libraries and so on.
141 * Directory Options::   Where to find header files and libraries.
142                         Where to find the compiler executable files.
143 * Spec Files::          How to pass switches to sub-processes.
144 * Target Options::      Running a cross-compiler, or an old version of GCC.
145 * Submodel Options::    Specifying minor hardware or convention variations,
146                         such as 68010 vs 68020.
147 * Code Gen Options::    Specifying conventions for function calls, data layout
148                         and register usage.
149 * Environment Variables:: Env vars that affect GCC.
150 * Precompiled Headers:: Compiling a header once, and using it many times.
151 @end menu
152
153 @c man begin OPTIONS
154
155 @node Option Summary
156 @section Option Summary
157
158 Here is a summary of all the options, grouped by type.  Explanations are
159 in the following sections.
160
161 @table @emph
162 @item Overall Options
163 @xref{Overall Options,,Options Controlling the Kind of Output}.
164 @gccoptlist{-c  -S  -E  -o @var{file}  -combine  -no-canonical-prefixes  @gol
165 -pipe  -pass-exit-codes  @gol
166 -x @var{language}  -v  -###  --help@r{[}=@var{class}@r{[},@dots{}@r{]]}  --target-help  @gol
167 --version -wrapper@@@var{file} -fplugin=@var{file} -fplugin-arg-@var{name}=@var{arg}}
168
169 @item C Language Options
170 @xref{C Dialect Options,,Options Controlling C Dialect}.
171 @gccoptlist{-ansi  -std=@var{standard}  -fgnu89-inline @gol
172 -aux-info @var{filename} @gol
173 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
174 -fhosted  -ffreestanding -fopenmp -fms-extensions @gol
175 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
176 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
177 -fsigned-bitfields  -fsigned-char @gol
178 -funsigned-bitfields  -funsigned-char}
179
180 @item C++ Language Options
181 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
182 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
183 -fconserve-space  -ffriend-injection @gol
184 -fno-elide-constructors @gol
185 -fno-enforce-eh-specs @gol
186 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
187 -fno-implicit-templates @gol
188 -fno-implicit-inline-templates @gol
189 -fno-implement-inlines  -fms-extensions @gol
190 -fno-nonansi-builtins  -fno-operator-names @gol
191 -fno-optional-diags  -fpermissive @gol
192 -fno-pretty-templates @gol
193 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
194 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
195 -fno-default-inline  -fvisibility-inlines-hidden @gol
196 -fvisibility-ms-compat @gol
197 -Wabi  -Wctor-dtor-privacy @gol
198 -Wnon-virtual-dtor  -Wreorder @gol
199 -Weffc++  -Wstrict-null-sentinel @gol
200 -Wno-non-template-friend  -Wold-style-cast @gol
201 -Woverloaded-virtual  -Wno-pmf-conversions @gol
202 -Wsign-promo}
203
204 @item Objective-C and Objective-C++ Language Options
205 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
206 Objective-C and Objective-C++ Dialects}.
207 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
208 -fgnu-runtime  -fnext-runtime @gol
209 -fno-nil-receivers @gol
210 -fobjc-call-cxx-cdtors @gol
211 -fobjc-direct-dispatch @gol
212 -fobjc-exceptions @gol
213 -fobjc-gc @gol
214 -freplace-objc-classes @gol
215 -fzero-link @gol
216 -gen-decls @gol
217 -Wassign-intercept @gol
218 -Wno-protocol  -Wselector @gol
219 -Wstrict-selector-match @gol
220 -Wundeclared-selector}
221
222 @item Language Independent Options
223 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
224 @gccoptlist{-fmessage-length=@var{n}  @gol
225 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
226 -fdiagnostics-show-option}
227
228 @item Warning Options
229 @xref{Warning Options,,Options to Request or Suppress Warnings}.
230 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
231 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  -Warray-bounds @gol
232 -Wno-attributes -Wno-builtin-macro-redefined @gol
233 -Wc++-compat -Wc++0x-compat -Wcast-align  -Wcast-qual  @gol
234 -Wchar-subscripts -Wclobbered  -Wcomment @gol
235 -Wconversion  -Wcoverage-mismatch  -Wno-deprecated  @gol
236 -Wno-deprecated-declarations -Wdisabled-optimization  @gol
237 -Wno-div-by-zero -Wempty-body  -Wenum-compare -Wno-endif-labels @gol
238 -Werror  -Werror=* @gol
239 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
240 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
241 -Wformat-security  -Wformat-y2k @gol
242 -Wframe-larger-than=@var{len} -Wjump-misses-init -Wignored-qualifiers @gol
243 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
244 -Winit-self  -Winline @gol
245 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
246 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
247 -Wlogical-op -Wlong-long @gol
248 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
249 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
250 -Wmissing-noreturn  -Wno-mudflap @gol
251 -Wno-multichar  -Wnonnull  -Wno-overflow @gol
252 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
253 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
254 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
255 -Wredundant-decls @gol
256 -Wreturn-type  -Wsequence-point  -Wshadow @gol
257 -Wsign-compare  -Wsign-conversion  -Wstack-protector @gol
258 -Wstrict-aliasing -Wstrict-aliasing=n @gol
259 -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
260 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
261 -Wsystem-headers  -Wtrigraphs  -Wtype-limits  -Wundef  -Wuninitialized @gol
262 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
263 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
264 -Wunused-label  -Wunused-parameter -Wno-unused-result -Wunused-value  -Wunused-variable @gol
265 -Wvariadic-macros -Wvla @gol
266 -Wvolatile-register-var  -Wwrite-strings}
267
268 @item C and Objective-C-only Warning Options
269 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
270 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
271 -Wold-style-declaration  -Wold-style-definition @gol
272 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
273 -Wdeclaration-after-statement -Wpointer-sign}
274
275 @item Debugging Options
276 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
277 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
278 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
279 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
280 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
281 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
282 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
283 -fdump-statistics @gol
284 -fdump-tree-all @gol
285 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
286 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
287 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
288 -fdump-tree-ch @gol
289 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
291 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
292 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
293 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
294 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
295 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
296 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
297 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
298 -fdump-tree-nrv -fdump-tree-vect @gol
299 -fdump-tree-sink @gol
300 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
301 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
302 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
303 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
304 -ftree-vectorizer-verbose=@var{n} @gol
305 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
306 -fdump-final-insns=@var{file} @gol
307 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
308 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
309 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
310 -fenable-icf-debug @gol
311 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
312 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
313 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
314 -ftest-coverage  -ftime-report -fvar-tracking @gol
315 -fvar-tracking-assigments  -fvar-tracking-assignments-toggle @gol
316 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
317 -ggdb  -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
318 -gvms  -gxcoff  -gxcoff+ @gol
319 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
320 -fdebug-prefix-map=@var{old}=@var{new} @gol
321 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
322 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
323 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
324 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
325 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
326 -print-sysroot -print-sysroot-headers-suffix @gol
327 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
328
329 @item Optimization Options
330 @xref{Optimize Options,,Options that Control Optimization}.
331 @gccoptlist{
332 -falign-functions[=@var{n}] -falign-jumps[=@var{n}] @gol
333 -falign-labels[=@var{n}] -falign-loops[=@var{n}] -fassociative-math @gol
334 -fauto-inc-dec -fbranch-probabilities -fbranch-target-load-optimize @gol
335 -fbranch-target-load-optimize2 -fbtr-bb-exclusive -fcaller-saves @gol
336 -fcheck-data-deps -fconserve-stack -fcprop-registers -fcrossjumping @gol
337 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules -fcx-limited-range @gol
338 -fdata-sections -fdce -fdce @gol
339 -fdelayed-branch -fdelete-null-pointer-checks -fdse -fdse @gol
340 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffast-math @gol
341 -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
342 -fforward-propagate -ffunction-sections @gol
343 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm @gol
344 -fgcse-sm -fif-conversion -fif-conversion2 -findirect-inlining @gol
345 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
346 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-matrix-reorg -fipa-pta @gol
347 -fipa-pure-const -fipa-reference -fipa-struct-reorg @gol
348 -fipa-type-escape -fira-algorithm=@var{algorithm} @gol
349 -fira-region=@var{region} -fira-coalesce @gol
350 -fira-loop-pressure -fno-ira-share-save-slots @gol
351 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
352 -fivopts -fkeep-inline-functions -fkeep-static-consts @gol
353 -floop-block -floop-interchange -floop-strip-mine -fgraphite-identity @gol
354 -floop-parallelize-all -flto -flto-compression-level -flto-report -fltrans @gol
355 -fltrans-output-list -fmerge-all-constants -fmerge-constants -fmodulo-sched @gol
356 -fmodulo-sched-allow-regmoves -fmove-loop-invariants -fmudflap @gol
357 -fmudflapir -fmudflapth -fno-branch-count-reg -fno-default-inline @gol
358 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
359 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
360 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
361 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
362 -fomit-frame-pointer -foptimize-register-move -foptimize-sibling-calls @gol
363 -fpeel-loops -fpredictive-commoning -fprefetch-loop-arrays @gol
364 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
365 -fprofile-generate=@var{path} @gol
366 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
367 -freciprocal-math -fregmove -frename-registers -freorder-blocks @gol
368 -freorder-blocks-and-partition -freorder-functions @gol
369 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
370 -frounding-math -fsched2-use-superblocks @gol
371 -fsched2-use-traces -fsched-pressure @gol
372 -fsched-spec-load -fsched-spec-load-dangerous @gol
373 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
374 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
375 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
376 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
377 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
378 -fselective-scheduling -fselective-scheduling2 @gol
379 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
380 -fsignaling-nans -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
381 -fsplit-wide-types -fstack-protector -fstack-protector-all @gol
382 -fstrict-aliasing -fstrict-overflow -fthread-jumps -ftracer @gol
383 -ftree-builtin-call-dce -ftree-ccp -ftree-ch -ftree-copy-prop @gol
384 -ftree-copyrename -ftree-dce @gol
385 -ftree-dominator-opts -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-im @gol
386 -ftree-phiprop -ftree-loop-distribution @gol
387 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
388 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-pta -ftree-reassoc @gol
389 -ftree-sink -ftree-sra -ftree-switch-conversion @gol
390 -ftree-ter -ftree-vect-loop-version -ftree-vectorize -ftree-vrp @gol
391 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
392 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
393 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
394 -fwhole-program -fwhopr -fwpa -fuse-linker-plugin @gol
395 --param @var{name}=@var{value}
396 -O  -O0  -O1  -O2  -O3  -Os}
397
398 @item Preprocessor Options
399 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
400 @gccoptlist{-A@var{question}=@var{answer} @gol
401 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
402 -C  -dD  -dI  -dM  -dN @gol
403 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
404 -idirafter @var{dir} @gol
405 -include @var{file}  -imacros @var{file} @gol
406 -iprefix @var{file}  -iwithprefix @var{dir} @gol
407 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
408 -imultilib @var{dir} -isysroot @var{dir} @gol
409 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
410 -P  -fworking-directory  -remap @gol
411 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
412 -Xpreprocessor @var{option}}
413
414 @item Assembler Option
415 @xref{Assembler Options,,Passing Options to the Assembler}.
416 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
417
418 @item Linker Options
419 @xref{Link Options,,Options for Linking}.
420 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
421 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
422 -s  -static  -static-libgcc  -static-libstdc++ -shared  @gol
423 -shared-libgcc  -symbolic @gol
424 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
425 -u @var{symbol}}
426
427 @item Directory Options
428 @xref{Directory Options,,Options for Directory Search}.
429 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
430 -specs=@var{file}  -I- --sysroot=@var{dir}}
431
432 @item Target Options
433 @c I wrote this xref this way to avoid overfull hbox. -- rms
434 @xref{Target Options}.
435 @gccoptlist{-V @var{version}  -b @var{machine}}
436
437 @item Machine Dependent Options
438 @xref{Submodel Options,,Hardware Models and Configurations}.
439 @c This list is ordered alphanumerically by subsection name.
440 @c Try and put the significant identifier (CPU or system) first,
441 @c so users have a clue at guessing where the ones they want will be.
442
443 @emph{ARC Options}
444 @gccoptlist{-EB  -EL @gol
445 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
446 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
447
448 @emph{ARM Options}
449 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
450 -mabi=@var{name} @gol
451 -mapcs-stack-check  -mno-apcs-stack-check @gol
452 -mapcs-float  -mno-apcs-float @gol
453 -mapcs-reentrant  -mno-apcs-reentrant @gol
454 -msched-prolog  -mno-sched-prolog @gol
455 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
456 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
457 -mfp16-format=@var{name}
458 -mthumb-interwork  -mno-thumb-interwork @gol
459 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
460 -mstructure-size-boundary=@var{n} @gol
461 -mabort-on-noreturn @gol
462 -mlong-calls  -mno-long-calls @gol
463 -msingle-pic-base  -mno-single-pic-base @gol
464 -mpic-register=@var{reg} @gol
465 -mnop-fun-dllimport @gol
466 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
467 -mpoke-function-name @gol
468 -mthumb  -marm @gol
469 -mtpcs-frame  -mtpcs-leaf-frame @gol
470 -mcaller-super-interworking  -mcallee-super-interworking @gol
471 -mtp=@var{name} @gol
472 -mword-relocations @gol
473 -mfix-cortex-m3-ldrd}
474
475 @emph{AVR Options}
476 @gccoptlist{-mmcu=@var{mcu}  -mno-interrupts @gol
477 -mcall-prologues  -mtiny-stack  -mint8}
478
479 @emph{Blackfin Options}
480 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
481 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
482 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
483 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
484 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
485 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
486 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
487 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
488 -micplb}
489
490 @emph{CRIS Options}
491 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
492 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
493 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
494 -mstack-align  -mdata-align  -mconst-align @gol
495 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
496 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
497 -mmul-bug-workaround  -mno-mul-bug-workaround}
498
499 @emph{CRX Options}
500 @gccoptlist{-mmac -mpush-args}
501
502 @emph{Darwin Options}
503 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
504 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
505 -client_name  -compatibility_version  -current_version @gol
506 -dead_strip @gol
507 -dependency-file  -dylib_file  -dylinker_install_name @gol
508 -dynamic  -dynamiclib  -exported_symbols_list @gol
509 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
510 -force_flat_namespace  -headerpad_max_install_names @gol
511 -iframework @gol
512 -image_base  -init  -install_name  -keep_private_externs @gol
513 -multi_module  -multiply_defined  -multiply_defined_unused @gol
514 -noall_load   -no_dead_strip_inits_and_terms @gol
515 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
516 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
517 -private_bundle  -read_only_relocs  -sectalign @gol
518 -sectobjectsymbols  -whyload  -seg1addr @gol
519 -sectcreate  -sectobjectsymbols  -sectorder @gol
520 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
521 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
522 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
523 -single_module  -static  -sub_library  -sub_umbrella @gol
524 -twolevel_namespace  -umbrella  -undefined @gol
525 -unexported_symbols_list  -weak_reference_mismatches @gol
526 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
527 -mkernel -mone-byte-bool}
528
529 @emph{DEC Alpha Options}
530 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
531 -mieee  -mieee-with-inexact  -mieee-conformant @gol
532 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
533 -mtrap-precision=@var{mode}  -mbuild-constants @gol
534 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
535 -mbwx  -mmax  -mfix  -mcix @gol
536 -mfloat-vax  -mfloat-ieee @gol
537 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
538 -msmall-text  -mlarge-text @gol
539 -mmemory-latency=@var{time}}
540
541 @emph{DEC Alpha/VMS Options}
542 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
543
544 @emph{FR30 Options}
545 @gccoptlist{-msmall-model -mno-lsim}
546
547 @emph{FRV Options}
548 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
549 -mhard-float  -msoft-float @gol
550 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
551 -mdouble  -mno-double @gol
552 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
553 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
554 -mlinked-fp  -mlong-calls  -malign-labels @gol
555 -mlibrary-pic  -macc-4  -macc-8 @gol
556 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
557 -moptimize-membar -mno-optimize-membar @gol
558 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
559 -mvliw-branch  -mno-vliw-branch @gol
560 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
561 -mno-nested-cond-exec  -mtomcat-stats @gol
562 -mTLS -mtls @gol
563 -mcpu=@var{cpu}}
564
565 @emph{GNU/Linux Options}
566 @gccoptlist{-muclibc}
567
568 @emph{H8/300 Options}
569 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
570
571 @emph{HPPA Options}
572 @gccoptlist{-march=@var{architecture-type} @gol
573 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
574 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
575 -mfixed-range=@var{register-range} @gol
576 -mjump-in-delay -mlinker-opt -mlong-calls @gol
577 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
578 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
579 -mno-jump-in-delay  -mno-long-load-store @gol
580 -mno-portable-runtime  -mno-soft-float @gol
581 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
582 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
583 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
584 -munix=@var{unix-std}  -nolibdld  -static  -threads}
585
586 @emph{i386 and x86-64 Options}
587 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
588 -mfpmath=@var{unit} @gol
589 -masm=@var{dialect}  -mno-fancy-math-387 @gol
590 -mno-fp-ret-in-387  -msoft-float @gol
591 -mno-wide-multiply  -mrtd  -malign-double @gol
592 -mpreferred-stack-boundary=@var{num}
593 -mincoming-stack-boundary=@var{num}
594 -mcld -mcx16 -msahf -mmovbe -mcrc32 -mrecip @gol
595 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
596 -maes -mpclmul @gol
597 -msse4a -m3dnow -mpopcnt -mabm -mfma4 -mxop -mlwp @gol
598 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
599 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
600 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
601 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
602 -mveclibabi=@var{type} -mpc32 -mpc64 -mpc80 -mstackrealign @gol
603 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
604 -mcmodel=@var{code-model} -mabi=@var{name} @gol
605 -m32  -m64 -mlarge-data-threshold=@var{num} @gol
606 -msse2avx}
607
608 @emph{IA-64 Options}
609 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
610 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
611 -mconstant-gp  -mauto-pic  -mfused-madd @gol
612 -minline-float-divide-min-latency @gol
613 -minline-float-divide-max-throughput @gol
614 -mno-inline-float-divide @gol
615 -minline-int-divide-min-latency @gol
616 -minline-int-divide-max-throughput  @gol
617 -mno-inline-int-divide @gol
618 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
619 -mno-inline-sqrt @gol
620 -mdwarf2-asm -mearly-stop-bits @gol
621 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
622 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
623 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
624 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
625 -msched-spec-ldc -msched-spec-control-ldc @gol
626 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
627 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
628 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
629 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
630
631 @emph{IA-64/VMS Options}
632 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64}
633
634 @emph{M32R/D Options}
635 @gccoptlist{-m32r2 -m32rx -m32r @gol
636 -mdebug @gol
637 -malign-loops -mno-align-loops @gol
638 -missue-rate=@var{number} @gol
639 -mbranch-cost=@var{number} @gol
640 -mmodel=@var{code-size-model-type} @gol
641 -msdata=@var{sdata-type} @gol
642 -mno-flush-func -mflush-func=@var{name} @gol
643 -mno-flush-trap -mflush-trap=@var{number} @gol
644 -G @var{num}}
645
646 @emph{M32C Options}
647 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
648
649 @emph{M680x0 Options}
650 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
651 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
652 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
653 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
654 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
655 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
656 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
657 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
658 -mxgot -mno-xgot}
659
660 @emph{M68hc1x Options}
661 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
662 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
663 -msoft-reg-count=@var{count}}
664
665 @emph{MCore Options}
666 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
667 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
668 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
669 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
670 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
671
672 @emph{MeP Options}
673 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
674 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
675 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
676 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
677 -mtiny=@var{n}}
678
679 @emph{MIPS Options}
680 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
681 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
682 -mips64  -mips64r2 @gol
683 -mips16  -mno-mips16  -mflip-mips16 @gol
684 -minterlink-mips16  -mno-interlink-mips16 @gol
685 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
686 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
687 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
688 -msingle-float  -mdouble-float  -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
689 -mfpu=@var{fpu-type} @gol
690 -msmartmips  -mno-smartmips @gol
691 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
692 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
693 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
694 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
695 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
696 -membedded-data  -mno-embedded-data @gol
697 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
698 -mcode-readable=@var{setting} @gol
699 -msplit-addresses  -mno-split-addresses @gol
700 -mexplicit-relocs  -mno-explicit-relocs @gol
701 -mcheck-zero-division  -mno-check-zero-division @gol
702 -mdivide-traps  -mdivide-breaks @gol
703 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
704 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
705 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
706 -mfix-r10000 -mno-fix-r10000  -mfix-vr4120  -mno-fix-vr4120 @gol
707 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
708 -mflush-func=@var{func}  -mno-flush-func @gol
709 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
710 -mfp-exceptions -mno-fp-exceptions @gol
711 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
712 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
713
714 @emph{MMIX Options}
715 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
716 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
717 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
718 -mno-base-addresses  -msingle-exit  -mno-single-exit}
719
720 @emph{MN10300 Options}
721 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
722 -mam33  -mno-am33 @gol
723 -mam33-2  -mno-am33-2 @gol
724 -mreturn-pointer-on-d0 @gol
725 -mno-crt0  -mrelax}
726
727 @emph{PDP-11 Options}
728 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
729 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
730 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
731 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
732 -mbranch-expensive  -mbranch-cheap @gol
733 -msplit  -mno-split  -munix-asm  -mdec-asm}
734
735 @emph{picoChip Options}
736 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N}
737 -msymbol-as-address -mno-inefficient-warnings}
738
739 @emph{PowerPC Options}
740 See RS/6000 and PowerPC Options.
741
742 @emph{RS/6000 and PowerPC Options}
743 @gccoptlist{-mcpu=@var{cpu-type} @gol
744 -mtune=@var{cpu-type} @gol
745 -mpower  -mno-power  -mpower2  -mno-power2 @gol
746 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
747 -maltivec  -mno-altivec @gol
748 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
749 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
750 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
751 -mfprnd  -mno-fprnd @gol
752 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
753 -mnew-mnemonics  -mold-mnemonics @gol
754 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
755 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
756 -malign-power  -malign-natural @gol
757 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
758 -msingle-float -mdouble-float -msimple-fpu @gol
759 -mstring  -mno-string  -mupdate  -mno-update @gol
760 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
761 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
762 -mstrict-align  -mno-strict-align  -mrelocatable @gol
763 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
764 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
765 -mdynamic-no-pic  -maltivec -mswdiv @gol
766 -mprioritize-restricted-insns=@var{priority} @gol
767 -msched-costly-dep=@var{dependence_type} @gol
768 -minsert-sched-nops=@var{scheme} @gol
769 -mcall-sysv  -mcall-netbsd @gol
770 -maix-struct-return  -msvr4-struct-return @gol
771 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
772 -misel -mno-isel @gol
773 -misel=yes  -misel=no @gol
774 -mspe -mno-spe @gol
775 -mspe=yes  -mspe=no @gol
776 -mpaired @gol
777 -mgen-cell-microcode -mwarn-cell-microcode @gol
778 -mvrsave -mno-vrsave @gol
779 -mmulhw -mno-mulhw @gol
780 -mdlmzb -mno-dlmzb @gol
781 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
782 -mprototype  -mno-prototype @gol
783 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
784 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread}
785
786 @emph{RX Options}
787 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
788 -mcpu= -patch=@gol
789 -mbig-endian-data -mlittle-endian-data @gol
790 -msmall-data @gol
791 -msim  -mno-sim@gol
792 -mas100-syntax -mno-as100-syntax@gol
793 -mrelax@gol
794 -mmax-constant-size=@gol
795 -mint-register=@gol
796 -msave-acc-in-interrupts}
797
798 @emph{S/390 and zSeries Options}
799 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
800 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
801 -mlong-double-64 -mlong-double-128 @gol
802 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
803 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
804 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
805 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
806 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
807
808 @emph{Score Options}
809 @gccoptlist{-meb -mel @gol
810 -mnhwloop @gol
811 -muls @gol
812 -mmac @gol
813 -mscore5 -mscore5u -mscore7 -mscore7d}
814
815 @emph{SH Options}
816 @gccoptlist{-m1  -m2  -m2e @gol
817 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
818 -m3  -m3e @gol
819 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
820 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
821 -m5-64media  -m5-64media-nofpu @gol
822 -m5-32media  -m5-32media-nofpu @gol
823 -m5-compact  -m5-compact-nofpu @gol
824 -mb  -ml  -mdalign  -mrelax @gol
825 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
826 -mieee  -mbitops  -misize  -minline-ic_invalidate -mpadstruct  -mspace @gol
827 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
828 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
829 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
830 -minvalid-symbols}
831
832 @emph{SPARC Options}
833 @gccoptlist{-mcpu=@var{cpu-type} @gol
834 -mtune=@var{cpu-type} @gol
835 -mcmodel=@var{code-model} @gol
836 -m32  -m64  -mapp-regs  -mno-app-regs @gol
837 -mfaster-structs  -mno-faster-structs @gol
838 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
839 -mhard-quad-float  -msoft-quad-float @gol
840 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
841 -mstack-bias  -mno-stack-bias @gol
842 -munaligned-doubles  -mno-unaligned-doubles @gol
843 -mv8plus  -mno-v8plus  -mvis  -mno-vis
844 -threads -pthreads -pthread}
845
846 @emph{SPU Options}
847 @gccoptlist{-mwarn-reloc -merror-reloc @gol
848 -msafe-dma -munsafe-dma @gol
849 -mbranch-hints @gol
850 -msmall-mem -mlarge-mem -mstdmain @gol
851 -mfixed-range=@var{register-range} @gol
852 -mea32 -mea64 @gol
853 -maddress-space-conversion -mno-address-space-conversion @gol
854 -mcache-size=@var{cache-size} @gol
855 -matomic-updates -mno-atomic-updates}
856
857 @emph{System V Options}
858 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
859
860 @emph{V850 Options}
861 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
862 -mprolog-function  -mno-prolog-function  -mspace @gol
863 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
864 -mapp-regs  -mno-app-regs @gol
865 -mdisable-callt  -mno-disable-callt @gol
866 -mv850e1 @gol
867 -mv850e @gol
868 -mv850  -mbig-switch}
869
870 @emph{VAX Options}
871 @gccoptlist{-mg  -mgnu  -munix}
872
873 @emph{VxWorks Options}
874 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
875 -Xbind-lazy  -Xbind-now}
876
877 @emph{x86-64 Options}
878 See i386 and x86-64 Options.
879
880 @emph{i386 and x86-64 Windows Options}
881 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll
882 -mnop-fun-dllimport -mthread -municode -mwin32 -mwindows
883 -fno-set-stack-executable}
884
885 @emph{Xstormy16 Options}
886 @gccoptlist{-msim}
887
888 @emph{Xtensa Options}
889 @gccoptlist{-mconst16 -mno-const16 @gol
890 -mfused-madd  -mno-fused-madd @gol
891 -mserialize-volatile  -mno-serialize-volatile @gol
892 -mtext-section-literals  -mno-text-section-literals @gol
893 -mtarget-align  -mno-target-align @gol
894 -mlongcalls  -mno-longcalls}
895
896 @emph{zSeries Options}
897 See S/390 and zSeries Options.
898
899 @item Code Generation Options
900 @xref{Code Gen Options,,Options for Code Generation Conventions}.
901 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
902 -ffixed-@var{reg}  -fexceptions @gol
903 -fnon-call-exceptions  -funwind-tables @gol
904 -fasynchronous-unwind-tables @gol
905 -finhibit-size-directive  -finstrument-functions @gol
906 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
907 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
908 -fno-common  -fno-ident @gol
909 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
910 -fno-jump-tables @gol
911 -frecord-gcc-switches @gol
912 -freg-struct-return  -fshort-enums @gol
913 -fshort-double  -fshort-wchar @gol
914 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
915 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
916 -fno-stack-limit  -fargument-alias  -fargument-noalias @gol
917 -fargument-noalias-global  -fargument-noalias-anything @gol
918 -fleading-underscore  -ftls-model=@var{model} @gol
919 -ftrapv  -fwrapv  -fbounds-check @gol
920 -fvisibility}
921 @end table
922
923 @menu
924 * Overall Options::     Controlling the kind of output:
925                         an executable, object files, assembler files,
926                         or preprocessed source.
927 * C Dialect Options::   Controlling the variant of C language compiled.
928 * C++ Dialect Options:: Variations on C++.
929 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
930                         and Objective-C++.
931 * Language Independent Options:: Controlling how diagnostics should be
932                         formatted.
933 * Warning Options::     How picky should the compiler be?
934 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
935 * Optimize Options::    How much optimization?
936 * Preprocessor Options:: Controlling header files and macro definitions.
937                          Also, getting dependency information for Make.
938 * Assembler Options::   Passing options to the assembler.
939 * Link Options::        Specifying libraries and so on.
940 * Directory Options::   Where to find header files and libraries.
941                         Where to find the compiler executable files.
942 * Spec Files::          How to pass switches to sub-processes.
943 * Target Options::      Running a cross-compiler, or an old version of GCC.
944 @end menu
945
946 @node Overall Options
947 @section Options Controlling the Kind of Output
948
949 Compilation can involve up to four stages: preprocessing, compilation
950 proper, assembly and linking, always in that order.  GCC is capable of
951 preprocessing and compiling several files either into several
952 assembler input files, or into one assembler input file; then each
953 assembler input file produces an object file, and linking combines all
954 the object files (those newly compiled, and those specified as input)
955 into an executable file.
956
957 @cindex file name suffix
958 For any given input file, the file name suffix determines what kind of
959 compilation is done:
960
961 @table @gcctabopt
962 @item @var{file}.c
963 C source code which must be preprocessed.
964
965 @item @var{file}.i
966 C source code which should not be preprocessed.
967
968 @item @var{file}.ii
969 C++ source code which should not be preprocessed.
970
971 @item @var{file}.m
972 Objective-C source code.  Note that you must link with the @file{libobjc}
973 library to make an Objective-C program work.
974
975 @item @var{file}.mi
976 Objective-C source code which should not be preprocessed.
977
978 @item @var{file}.mm
979 @itemx @var{file}.M
980 Objective-C++ source code.  Note that you must link with the @file{libobjc}
981 library to make an Objective-C++ program work.  Note that @samp{.M} refers
982 to a literal capital M@.
983
984 @item @var{file}.mii
985 Objective-C++ source code which should not be preprocessed.
986
987 @item @var{file}.h
988 C, C++, Objective-C or Objective-C++ header file to be turned into a
989 precompiled header.
990
991 @item @var{file}.cc
992 @itemx @var{file}.cp
993 @itemx @var{file}.cxx
994 @itemx @var{file}.cpp
995 @itemx @var{file}.CPP
996 @itemx @var{file}.c++
997 @itemx @var{file}.C
998 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
999 the last two letters must both be literally @samp{x}.  Likewise,
1000 @samp{.C} refers to a literal capital C@.
1001
1002 @item @var{file}.mm
1003 @itemx @var{file}.M
1004 Objective-C++ source code which must be preprocessed.
1005
1006 @item @var{file}.mii
1007 Objective-C++ source code which should not be preprocessed.
1008
1009 @item @var{file}.hh
1010 @itemx @var{file}.H
1011 @itemx @var{file}.hp
1012 @itemx @var{file}.hxx
1013 @itemx @var{file}.hpp
1014 @itemx @var{file}.HPP
1015 @itemx @var{file}.h++
1016 @itemx @var{file}.tcc
1017 C++ header file to be turned into a precompiled header.
1018
1019 @item @var{file}.f
1020 @itemx @var{file}.for
1021 @itemx @var{file}.ftn
1022 Fixed form Fortran source code which should not be preprocessed.
1023
1024 @item @var{file}.F
1025 @itemx @var{file}.FOR
1026 @itemx @var{file}.fpp
1027 @itemx @var{file}.FPP
1028 @itemx @var{file}.FTN
1029 Fixed form Fortran source code which must be preprocessed (with the traditional
1030 preprocessor).
1031
1032 @item @var{file}.f90
1033 @itemx @var{file}.f95
1034 @itemx @var{file}.f03
1035 @itemx @var{file}.f08
1036 Free form Fortran source code which should not be preprocessed.
1037
1038 @item @var{file}.F90
1039 @itemx @var{file}.F95
1040 @itemx @var{file}.F03
1041 @itemx @var{file}.F08
1042 Free form Fortran source code which must be preprocessed (with the
1043 traditional preprocessor).
1044
1045 @c FIXME: Descriptions of Java file types.
1046 @c @var{file}.java
1047 @c @var{file}.class
1048 @c @var{file}.zip
1049 @c @var{file}.jar
1050
1051 @item @var{file}.ads
1052 Ada source code file which contains a library unit declaration (a
1053 declaration of a package, subprogram, or generic, or a generic
1054 instantiation), or a library unit renaming declaration (a package,
1055 generic, or subprogram renaming declaration).  Such files are also
1056 called @dfn{specs}.
1057
1058 @item @var{file}.adb
1059 Ada source code file containing a library unit body (a subprogram or
1060 package body).  Such files are also called @dfn{bodies}.
1061
1062 @c GCC also knows about some suffixes for languages not yet included:
1063 @c Pascal:
1064 @c @var{file}.p
1065 @c @var{file}.pas
1066 @c Ratfor:
1067 @c @var{file}.r
1068
1069 @item @var{file}.s
1070 Assembler code.
1071
1072 @item @var{file}.S
1073 @itemx @var{file}.sx
1074 Assembler code which must be preprocessed.
1075
1076 @item @var{other}
1077 An object file to be fed straight into linking.
1078 Any file name with no recognized suffix is treated this way.
1079 @end table
1080
1081 @opindex x
1082 You can specify the input language explicitly with the @option{-x} option:
1083
1084 @table @gcctabopt
1085 @item -x @var{language}
1086 Specify explicitly the @var{language} for the following input files
1087 (rather than letting the compiler choose a default based on the file
1088 name suffix).  This option applies to all following input files until
1089 the next @option{-x} option.  Possible values for @var{language} are:
1090 @smallexample
1091 c  c-header  c-cpp-output
1092 c++  c++-header  c++-cpp-output
1093 objective-c  objective-c-header  objective-c-cpp-output
1094 objective-c++ objective-c++-header objective-c++-cpp-output
1095 assembler  assembler-with-cpp
1096 ada
1097 f77  f77-cpp-input f95  f95-cpp-input
1098 java
1099 @end smallexample
1100
1101 @item -x none
1102 Turn off any specification of a language, so that subsequent files are
1103 handled according to their file name suffixes (as they are if @option{-x}
1104 has not been used at all).
1105
1106 @item -pass-exit-codes
1107 @opindex pass-exit-codes
1108 Normally the @command{gcc} program will exit with the code of 1 if any
1109 phase of the compiler returns a non-success return code.  If you specify
1110 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
1111 numerically highest error produced by any phase that returned an error
1112 indication.  The C, C++, and Fortran frontends return 4, if an internal
1113 compiler error is encountered.
1114 @end table
1115
1116 If you only want some of the stages of compilation, you can use
1117 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1118 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1119 @command{gcc} is to stop.  Note that some combinations (for example,
1120 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1121
1122 @table @gcctabopt
1123 @item -c
1124 @opindex c
1125 Compile or assemble the source files, but do not link.  The linking
1126 stage simply is not done.  The ultimate output is in the form of an
1127 object file for each source file.
1128
1129 By default, the object file name for a source file is made by replacing
1130 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1131
1132 Unrecognized input files, not requiring compilation or assembly, are
1133 ignored.
1134
1135 @item -S
1136 @opindex S
1137 Stop after the stage of compilation proper; do not assemble.  The output
1138 is in the form of an assembler code file for each non-assembler input
1139 file specified.
1140
1141 By default, the assembler file name for a source file is made by
1142 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1143
1144 Input files that don't require compilation are ignored.
1145
1146 @item -E
1147 @opindex E
1148 Stop after the preprocessing stage; do not run the compiler proper.  The
1149 output is in the form of preprocessed source code, which is sent to the
1150 standard output.
1151
1152 Input files which don't require preprocessing are ignored.
1153
1154 @cindex output file option
1155 @item -o @var{file}
1156 @opindex o
1157 Place output in file @var{file}.  This applies regardless to whatever
1158 sort of output is being produced, whether it be an executable file,
1159 an object file, an assembler file or preprocessed C code.
1160
1161 If @option{-o} is not specified, the default is to put an executable
1162 file in @file{a.out}, the object file for
1163 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1164 assembler file in @file{@var{source}.s}, a precompiled header file in
1165 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1166 standard output.
1167
1168 @item -v
1169 @opindex v
1170 Print (on standard error output) the commands executed to run the stages
1171 of compilation.  Also print the version number of the compiler driver
1172 program and of the preprocessor and the compiler proper.
1173
1174 @item -###
1175 @opindex ###
1176 Like @option{-v} except the commands are not executed and all command
1177 arguments are quoted.  This is useful for shell scripts to capture the
1178 driver-generated command lines.
1179
1180 @item -pipe
1181 @opindex pipe
1182 Use pipes rather than temporary files for communication between the
1183 various stages of compilation.  This fails to work on some systems where
1184 the assembler is unable to read from a pipe; but the GNU assembler has
1185 no trouble.
1186
1187 @item -combine
1188 @opindex combine
1189 If you are compiling multiple source files, this option tells the driver
1190 to pass all the source files to the compiler at once (for those
1191 languages for which the compiler can handle this).  This will allow
1192 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1193 language for which this is supported is C@.  If you pass source files for
1194 multiple languages to the driver, using this option, the driver will invoke
1195 the compiler(s) that support IMA once each, passing each compiler all the
1196 source files appropriate for it.  For those languages that do not support
1197 IMA this option will be ignored, and the compiler will be invoked once for
1198 each source file in that language.  If you use this option in conjunction
1199 with @option{-save-temps}, the compiler will generate multiple
1200 pre-processed files
1201 (one for each source file), but only one (combined) @file{.o} or
1202 @file{.s} file.
1203
1204 @item --help
1205 @opindex help
1206 Print (on the standard output) a description of the command line options
1207 understood by @command{gcc}.  If the @option{-v} option is also specified
1208 then @option{--help} will also be passed on to the various processes
1209 invoked by @command{gcc}, so that they can display the command line options
1210 they accept.  If the @option{-Wextra} option has also been specified
1211 (prior to the @option{--help} option), then command line options which
1212 have no documentation associated with them will also be displayed.
1213
1214 @item --target-help
1215 @opindex target-help
1216 Print (on the standard output) a description of target-specific command
1217 line options for each tool.  For some targets extra target-specific
1218 information may also be printed.
1219
1220 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1221 Print (on the standard output) a description of the command line
1222 options understood by the compiler that fit into all specified classes
1223 and qualifiers.  These are the supported classes:
1224
1225 @table @asis
1226 @item @samp{optimizers}
1227 This will display all of the optimization options supported by the
1228 compiler.
1229
1230 @item @samp{warnings}
1231 This will display all of the options controlling warning messages
1232 produced by the compiler.
1233
1234 @item @samp{target}
1235 This will display target-specific options.  Unlike the
1236 @option{--target-help} option however, target-specific options of the
1237 linker and assembler will not be displayed.  This is because those
1238 tools do not currently support the extended @option{--help=} syntax.
1239
1240 @item @samp{params}
1241 This will display the values recognized by the @option{--param}
1242 option.
1243
1244 @item @var{language}
1245 This will display the options supported for @var{language}, where
1246 @var{language} is the name of one of the languages supported in this
1247 version of GCC.
1248
1249 @item @samp{common}
1250 This will display the options that are common to all languages.
1251 @end table
1252
1253 These are the supported qualifiers:
1254
1255 @table @asis
1256 @item @samp{undocumented}
1257 Display only those options which are undocumented.
1258
1259 @item @samp{joined}
1260 Display options which take an argument that appears after an equal
1261 sign in the same continuous piece of text, such as:
1262 @samp{--help=target}.
1263
1264 @item @samp{separate}
1265 Display options which take an argument that appears as a separate word
1266 following the original option, such as: @samp{-o output-file}.
1267 @end table
1268
1269 Thus for example to display all the undocumented target-specific
1270 switches supported by the compiler the following can be used:
1271
1272 @smallexample
1273 --help=target,undocumented
1274 @end smallexample
1275
1276 The sense of a qualifier can be inverted by prefixing it with the
1277 @samp{^} character, so for example to display all binary warning
1278 options (i.e., ones that are either on or off and that do not take an
1279 argument), which have a description the following can be used:
1280
1281 @smallexample
1282 --help=warnings,^joined,^undocumented
1283 @end smallexample
1284
1285 The argument to @option{--help=} should not consist solely of inverted
1286 qualifiers.
1287
1288 Combining several classes is possible, although this usually
1289 restricts the output by so much that there is nothing to display.  One
1290 case where it does work however is when one of the classes is
1291 @var{target}.  So for example to display all the target-specific
1292 optimization options the following can be used:
1293
1294 @smallexample
1295 --help=target,optimizers
1296 @end smallexample
1297
1298 The @option{--help=} option can be repeated on the command line.  Each
1299 successive use will display its requested class of options, skipping
1300 those that have already been displayed.
1301
1302 If the @option{-Q} option appears on the command line before the
1303 @option{--help=} option, then the descriptive text displayed by
1304 @option{--help=} is changed.  Instead of describing the displayed
1305 options, an indication is given as to whether the option is enabled,
1306 disabled or set to a specific value (assuming that the compiler
1307 knows this at the point where the @option{--help=} option is used).
1308
1309 Here is a truncated example from the ARM port of @command{gcc}:
1310
1311 @smallexample
1312   % gcc -Q -mabi=2 --help=target -c
1313   The following options are target specific:
1314   -mabi=                                2
1315   -mabort-on-noreturn                   [disabled]
1316   -mapcs                                [disabled]
1317 @end smallexample
1318
1319 The output is sensitive to the effects of previous command line
1320 options, so for example it is possible to find out which optimizations
1321 are enabled at @option{-O2} by using:
1322
1323 @smallexample
1324 -Q -O2 --help=optimizers
1325 @end smallexample
1326
1327 Alternatively you can discover which binary optimizations are enabled
1328 by @option{-O3} by using:
1329
1330 @smallexample
1331 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1332 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1333 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1334 @end smallexample
1335
1336 @item -no-canonical-prefixes
1337 @opindex no-canonical-prefixes
1338 Do not expand any symbolic links, resolve references to @samp{/../}
1339 or @samp{/./}, or make the path absolute when generating a relative
1340 prefix.
1341
1342 @item --version
1343 @opindex version
1344 Display the version number and copyrights of the invoked GCC@.
1345
1346 @item -wrapper
1347 @opindex wrapper
1348 Invoke all subcommands under a wrapper program. It takes a single
1349 comma separated list as an argument, which will be used to invoke
1350 the wrapper:
1351
1352 @smallexample
1353 gcc -c t.c -wrapper gdb,--args
1354 @end smallexample
1355
1356 This will invoke all subprograms of gcc under "gdb --args",
1357 thus cc1 invocation will be "gdb --args cc1 ...".
1358
1359 @item -fplugin=@var{name}.so
1360 Load the plugin code in file @var{name}.so, assumed to be a
1361 shared object to be dlopen'd by the compiler.  The base name of
1362 the shared object file is used to identify the plugin for the
1363 purposes of argument parsing (See
1364 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1365 Each plugin should define the callback functions specified in the
1366 Plugins API.
1367
1368 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1369 Define an argument called @var{key} with a value of @var{value}
1370 for the plugin called @var{name}.
1371
1372 @include @value{srcdir}/../libiberty/at-file.texi
1373 @end table
1374
1375 @node Invoking G++
1376 @section Compiling C++ Programs
1377
1378 @cindex suffixes for C++ source
1379 @cindex C++ source file suffixes
1380 C++ source files conventionally use one of the suffixes @samp{.C},
1381 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1382 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1383 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1384 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1385 files with these names and compiles them as C++ programs even if you
1386 call the compiler the same way as for compiling C programs (usually
1387 with the name @command{gcc}).
1388
1389 @findex g++
1390 @findex c++
1391 However, the use of @command{gcc} does not add the C++ library.
1392 @command{g++} is a program that calls GCC and treats @samp{.c},
1393 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1394 files unless @option{-x} is used, and automatically specifies linking
1395 against the C++ library.  This program is also useful when
1396 precompiling a C header file with a @samp{.h} extension for use in C++
1397 compilations.  On many systems, @command{g++} is also installed with
1398 the name @command{c++}.
1399
1400 @cindex invoking @command{g++}
1401 When you compile C++ programs, you may specify many of the same
1402 command-line options that you use for compiling programs in any
1403 language; or command-line options meaningful for C and related
1404 languages; or options that are meaningful only for C++ programs.
1405 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1406 explanations of options for languages related to C@.
1407 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1408 explanations of options that are meaningful only for C++ programs.
1409
1410 @node C Dialect Options
1411 @section Options Controlling C Dialect
1412 @cindex dialect options
1413 @cindex language dialect options
1414 @cindex options, dialect
1415
1416 The following options control the dialect of C (or languages derived
1417 from C, such as C++, Objective-C and Objective-C++) that the compiler
1418 accepts:
1419
1420 @table @gcctabopt
1421 @cindex ANSI support
1422 @cindex ISO support
1423 @item -ansi
1424 @opindex ansi
1425 In C mode, this is equivalent to @samp{-std=c89}. In C++ mode, it is
1426 equivalent to @samp{-std=c++98}.
1427
1428 This turns off certain features of GCC that are incompatible with ISO
1429 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1430 such as the @code{asm} and @code{typeof} keywords, and
1431 predefined macros such as @code{unix} and @code{vax} that identify the
1432 type of system you are using.  It also enables the undesirable and
1433 rarely used ISO trigraph feature.  For the C compiler,
1434 it disables recognition of C++ style @samp{//} comments as well as
1435 the @code{inline} keyword.
1436
1437 The alternate keywords @code{__asm__}, @code{__extension__},
1438 @code{__inline__} and @code{__typeof__} continue to work despite
1439 @option{-ansi}.  You would not want to use them in an ISO C program, of
1440 course, but it is useful to put them in header files that might be included
1441 in compilations done with @option{-ansi}.  Alternate predefined macros
1442 such as @code{__unix__} and @code{__vax__} are also available, with or
1443 without @option{-ansi}.
1444
1445 The @option{-ansi} option does not cause non-ISO programs to be
1446 rejected gratuitously.  For that, @option{-pedantic} is required in
1447 addition to @option{-ansi}.  @xref{Warning Options}.
1448
1449 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1450 option is used.  Some header files may notice this macro and refrain
1451 from declaring certain functions or defining certain macros that the
1452 ISO standard doesn't call for; this is to avoid interfering with any
1453 programs that might use these names for other things.
1454
1455 Functions that would normally be built in but do not have semantics
1456 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1457 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1458 built-in functions provided by GCC}, for details of the functions
1459 affected.
1460
1461 @item -std=
1462 @opindex std
1463 Determine the language standard. @xref{Standards,,Language Standards
1464 Supported by GCC}, for details of these standard versions.  This option
1465 is currently only supported when compiling C or C++.
1466
1467 The compiler can accept several base standards, such as @samp{c89} or
1468 @samp{c++98}, and GNU dialects of those standards, such as
1469 @samp{gnu89} or @samp{gnu++98}.  By specifying a base standard, the
1470 compiler will accept all programs following that standard and those
1471 using GNU extensions that do not contradict it.  For example,
1472 @samp{-std=c89} turns off certain features of GCC that are
1473 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1474 keywords, but not other GNU extensions that do not have a meaning in
1475 ISO C90, such as omitting the middle term of a @code{?:}
1476 expression. On the other hand, by specifying a GNU dialect of a
1477 standard, all features the compiler support are enabled, even when
1478 those features change the meaning of the base standard and some
1479 strict-conforming programs may be rejected.  The particular standard
1480 is used by @option{-pedantic} to identify which features are GNU
1481 extensions given that version of the standard. For example
1482 @samp{-std=gnu89 -pedantic} would warn about C++ style @samp{//}
1483 comments, while @samp{-std=gnu99 -pedantic} would not.
1484
1485 A value for this option must be provided; possible values are
1486
1487 @table @samp
1488 @item c89
1489 @itemx iso9899:1990
1490 Support all ISO C90 programs (certain GNU extensions that conflict
1491 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1492
1493 @item iso9899:199409
1494 ISO C90 as modified in amendment 1.
1495
1496 @item c99
1497 @itemx c9x
1498 @itemx iso9899:1999
1499 @itemx iso9899:199x
1500 ISO C99.  Note that this standard is not yet fully supported; see
1501 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1502 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1503
1504 @item gnu89
1505 GNU dialect of ISO C90 (including some C99 features). This
1506 is the default for C code.
1507
1508 @item gnu99
1509 @itemx gnu9x
1510 GNU dialect of ISO C99.  When ISO C99 is fully implemented in GCC,
1511 this will become the default.  The name @samp{gnu9x} is deprecated.
1512
1513 @item c++98
1514 The 1998 ISO C++ standard plus amendments. Same as @option{-ansi} for
1515 C++ code.
1516
1517 @item gnu++98
1518 GNU dialect of @option{-std=c++98}.  This is the default for
1519 C++ code.
1520
1521 @item c++0x
1522 The working draft of the upcoming ISO C++0x standard. This option
1523 enables experimental features that are likely to be included in
1524 C++0x. The working draft is constantly changing, and any feature that is
1525 enabled by this flag may be removed from future versions of GCC if it is
1526 not part of the C++0x standard.
1527
1528 @item gnu++0x
1529 GNU dialect of @option{-std=c++0x}. This option enables
1530 experimental features that may be removed in future versions of GCC.
1531 @end table
1532
1533 @item -fgnu89-inline
1534 @opindex fgnu89-inline
1535 The option @option{-fgnu89-inline} tells GCC to use the traditional
1536 GNU semantics for @code{inline} functions when in C99 mode.
1537 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1538 is accepted and ignored by GCC versions 4.1.3 up to but not including
1539 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1540 C99 mode.  Using this option is roughly equivalent to adding the
1541 @code{gnu_inline} function attribute to all inline functions
1542 (@pxref{Function Attributes}).
1543
1544 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1545 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1546 specifies the default behavior).  This option was first supported in
1547 GCC 4.3.  This option is not supported in C89 or gnu89 mode.
1548
1549 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1550 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1551 in effect for @code{inline} functions.  @xref{Common Predefined
1552 Macros,,,cpp,The C Preprocessor}.
1553
1554 @item -aux-info @var{filename}
1555 @opindex aux-info
1556 Output to the given filename prototyped declarations for all functions
1557 declared and/or defined in a translation unit, including those in header
1558 files.  This option is silently ignored in any language other than C@.
1559
1560 Besides declarations, the file indicates, in comments, the origin of
1561 each declaration (source file and line), whether the declaration was
1562 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1563 @samp{O} for old, respectively, in the first character after the line
1564 number and the colon), and whether it came from a declaration or a
1565 definition (@samp{C} or @samp{F}, respectively, in the following
1566 character).  In the case of function definitions, a K&R-style list of
1567 arguments followed by their declarations is also provided, inside
1568 comments, after the declaration.
1569
1570 @item -fno-asm
1571 @opindex fno-asm
1572 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1573 keyword, so that code can use these words as identifiers.  You can use
1574 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1575 instead.  @option{-ansi} implies @option{-fno-asm}.
1576
1577 In C++, this switch only affects the @code{typeof} keyword, since
1578 @code{asm} and @code{inline} are standard keywords.  You may want to
1579 use the @option{-fno-gnu-keywords} flag instead, which has the same
1580 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1581 switch only affects the @code{asm} and @code{typeof} keywords, since
1582 @code{inline} is a standard keyword in ISO C99.
1583
1584 @item -fno-builtin
1585 @itemx -fno-builtin-@var{function}
1586 @opindex fno-builtin
1587 @cindex built-in functions
1588 Don't recognize built-in functions that do not begin with
1589 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1590 functions provided by GCC}, for details of the functions affected,
1591 including those which are not built-in functions when @option{-ansi} or
1592 @option{-std} options for strict ISO C conformance are used because they
1593 do not have an ISO standard meaning.
1594
1595 GCC normally generates special code to handle certain built-in functions
1596 more efficiently; for instance, calls to @code{alloca} may become single
1597 instructions that adjust the stack directly, and calls to @code{memcpy}
1598 may become inline copy loops.  The resulting code is often both smaller
1599 and faster, but since the function calls no longer appear as such, you
1600 cannot set a breakpoint on those calls, nor can you change the behavior
1601 of the functions by linking with a different library.  In addition,
1602 when a function is recognized as a built-in function, GCC may use
1603 information about that function to warn about problems with calls to
1604 that function, or to generate more efficient code, even if the
1605 resulting code still contains calls to that function.  For example,
1606 warnings are given with @option{-Wformat} for bad calls to
1607 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1608 known not to modify global memory.
1609
1610 With the @option{-fno-builtin-@var{function}} option
1611 only the built-in function @var{function} is
1612 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1613 function is named that is not built-in in this version of GCC, this
1614 option is ignored.  There is no corresponding
1615 @option{-fbuiltin-@var{function}} option; if you wish to enable
1616 built-in functions selectively when using @option{-fno-builtin} or
1617 @option{-ffreestanding}, you may define macros such as:
1618
1619 @smallexample
1620 #define abs(n)          __builtin_abs ((n))
1621 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1622 @end smallexample
1623
1624 @item -fhosted
1625 @opindex fhosted
1626 @cindex hosted environment
1627
1628 Assert that compilation takes place in a hosted environment.  This implies
1629 @option{-fbuiltin}.  A hosted environment is one in which the
1630 entire standard library is available, and in which @code{main} has a return
1631 type of @code{int}.  Examples are nearly everything except a kernel.
1632 This is equivalent to @option{-fno-freestanding}.
1633
1634 @item -ffreestanding
1635 @opindex ffreestanding
1636 @cindex hosted environment
1637
1638 Assert that compilation takes place in a freestanding environment.  This
1639 implies @option{-fno-builtin}.  A freestanding environment
1640 is one in which the standard library may not exist, and program startup may
1641 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1642 This is equivalent to @option{-fno-hosted}.
1643
1644 @xref{Standards,,Language Standards Supported by GCC}, for details of
1645 freestanding and hosted environments.
1646
1647 @item -fopenmp
1648 @opindex fopenmp
1649 @cindex openmp parallel
1650 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1651 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1652 compiler generates parallel code according to the OpenMP Application
1653 Program Interface v3.0 @w{@uref{http://www.openmp.org/}}.  This option
1654 implies @option{-pthread}, and thus is only supported on targets that
1655 have support for @option{-pthread}.
1656
1657 @item -fms-extensions
1658 @opindex fms-extensions
1659 Accept some non-standard constructs used in Microsoft header files.
1660
1661 Some cases of unnamed fields in structures and unions are only
1662 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1663 fields within structs/unions}, for details.
1664
1665 @item -trigraphs
1666 @opindex trigraphs
1667 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1668 options for strict ISO C conformance) implies @option{-trigraphs}.
1669
1670 @item -no-integrated-cpp
1671 @opindex no-integrated-cpp
1672 Performs a compilation in two passes: preprocessing and compiling.  This
1673 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1674 @option{-B} option.  The user supplied compilation step can then add in
1675 an additional preprocessing step after normal preprocessing but before
1676 compiling.  The default is to use the integrated cpp (internal cpp)
1677
1678 The semantics of this option will change if "cc1", "cc1plus", and
1679 "cc1obj" are merged.
1680
1681 @cindex traditional C language
1682 @cindex C language, traditional
1683 @item -traditional
1684 @itemx -traditional-cpp
1685 @opindex traditional-cpp
1686 @opindex traditional
1687 Formerly, these options caused GCC to attempt to emulate a pre-standard
1688 C compiler.  They are now only supported with the @option{-E} switch.
1689 The preprocessor continues to support a pre-standard mode.  See the GNU
1690 CPP manual for details.
1691
1692 @item -fcond-mismatch
1693 @opindex fcond-mismatch
1694 Allow conditional expressions with mismatched types in the second and
1695 third arguments.  The value of such an expression is void.  This option
1696 is not supported for C++.
1697
1698 @item -flax-vector-conversions
1699 @opindex flax-vector-conversions
1700 Allow implicit conversions between vectors with differing numbers of
1701 elements and/or incompatible element types.  This option should not be
1702 used for new code.
1703
1704 @item -funsigned-char
1705 @opindex funsigned-char
1706 Let the type @code{char} be unsigned, like @code{unsigned char}.
1707
1708 Each kind of machine has a default for what @code{char} should
1709 be.  It is either like @code{unsigned char} by default or like
1710 @code{signed char} by default.
1711
1712 Ideally, a portable program should always use @code{signed char} or
1713 @code{unsigned char} when it depends on the signedness of an object.
1714 But many programs have been written to use plain @code{char} and
1715 expect it to be signed, or expect it to be unsigned, depending on the
1716 machines they were written for.  This option, and its inverse, let you
1717 make such a program work with the opposite default.
1718
1719 The type @code{char} is always a distinct type from each of
1720 @code{signed char} or @code{unsigned char}, even though its behavior
1721 is always just like one of those two.
1722
1723 @item -fsigned-char
1724 @opindex fsigned-char
1725 Let the type @code{char} be signed, like @code{signed char}.
1726
1727 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1728 the negative form of @option{-funsigned-char}.  Likewise, the option
1729 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1730
1731 @item -fsigned-bitfields
1732 @itemx -funsigned-bitfields
1733 @itemx -fno-signed-bitfields
1734 @itemx -fno-unsigned-bitfields
1735 @opindex fsigned-bitfields
1736 @opindex funsigned-bitfields
1737 @opindex fno-signed-bitfields
1738 @opindex fno-unsigned-bitfields
1739 These options control whether a bit-field is signed or unsigned, when the
1740 declaration does not use either @code{signed} or @code{unsigned}.  By
1741 default, such a bit-field is signed, because this is consistent: the
1742 basic integer types such as @code{int} are signed types.
1743 @end table
1744
1745 @node C++ Dialect Options
1746 @section Options Controlling C++ Dialect
1747
1748 @cindex compiler options, C++
1749 @cindex C++ options, command line
1750 @cindex options, C++
1751 This section describes the command-line options that are only meaningful
1752 for C++ programs; but you can also use most of the GNU compiler options
1753 regardless of what language your program is in.  For example, you
1754 might compile a file @code{firstClass.C} like this:
1755
1756 @smallexample
1757 g++ -g -frepo -O -c firstClass.C
1758 @end smallexample
1759
1760 @noindent
1761 In this example, only @option{-frepo} is an option meant
1762 only for C++ programs; you can use the other options with any
1763 language supported by GCC@.
1764
1765 Here is a list of options that are @emph{only} for compiling C++ programs:
1766
1767 @table @gcctabopt
1768
1769 @item -fabi-version=@var{n}
1770 @opindex fabi-version
1771 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1772 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1773 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1774 the version that conforms most closely to the C++ ABI specification.
1775 Therefore, the ABI obtained using version 0 will change as ABI bugs
1776 are fixed.
1777
1778 The default is version 2.
1779
1780 @item -fno-access-control
1781 @opindex fno-access-control
1782 Turn off all access checking.  This switch is mainly useful for working
1783 around bugs in the access control code.
1784
1785 @item -fcheck-new
1786 @opindex fcheck-new
1787 Check that the pointer returned by @code{operator new} is non-null
1788 before attempting to modify the storage allocated.  This check is
1789 normally unnecessary because the C++ standard specifies that
1790 @code{operator new} will only return @code{0} if it is declared
1791 @samp{throw()}, in which case the compiler will always check the
1792 return value even without this option.  In all other cases, when
1793 @code{operator new} has a non-empty exception specification, memory
1794 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1795 @samp{new (nothrow)}.
1796
1797 @item -fconserve-space
1798 @opindex fconserve-space
1799 Put uninitialized or runtime-initialized global variables into the
1800 common segment, as C does.  This saves space in the executable at the
1801 cost of not diagnosing duplicate definitions.  If you compile with this
1802 flag and your program mysteriously crashes after @code{main()} has
1803 completed, you may have an object that is being destroyed twice because
1804 two definitions were merged.
1805
1806 This option is no longer useful on most targets, now that support has
1807 been added for putting variables into BSS without making them common.
1808
1809 @item -fno-deduce-init-list
1810 @opindex fno-deduce-init-list
1811 Disable deduction of a template type parameter as
1812 std::initializer_list from a brace-enclosed initializer list, i.e.
1813
1814 @smallexample
1815 template <class T> auto forward(T t) -> decltype (realfn (t))
1816 @{
1817   return realfn (t);
1818 @}
1819
1820 void f()
1821 @{
1822   forward(@{1,2@}); // call forward<std::initializer_list<int>>
1823 @}
1824 @end smallexample
1825
1826 This option is present because this deduction is an extension to the
1827 current specification in the C++0x working draft, and there was
1828 some concern about potential overload resolution problems.
1829
1830 @item -ffriend-injection
1831 @opindex ffriend-injection
1832 Inject friend functions into the enclosing namespace, so that they are
1833 visible outside the scope of the class in which they are declared.
1834 Friend functions were documented to work this way in the old Annotated
1835 C++ Reference Manual, and versions of G++ before 4.1 always worked
1836 that way.  However, in ISO C++ a friend function which is not declared
1837 in an enclosing scope can only be found using argument dependent
1838 lookup.  This option causes friends to be injected as they were in
1839 earlier releases.
1840
1841 This option is for compatibility, and may be removed in a future
1842 release of G++.
1843
1844 @item -fno-elide-constructors
1845 @opindex fno-elide-constructors
1846 The C++ standard allows an implementation to omit creating a temporary
1847 which is only used to initialize another object of the same type.
1848 Specifying this option disables that optimization, and forces G++ to
1849 call the copy constructor in all cases.
1850
1851 @item -fno-enforce-eh-specs
1852 @opindex fno-enforce-eh-specs
1853 Don't generate code to check for violation of exception specifications
1854 at runtime.  This option violates the C++ standard, but may be useful
1855 for reducing code size in production builds, much like defining
1856 @samp{NDEBUG}.  This does not give user code permission to throw
1857 exceptions in violation of the exception specifications; the compiler
1858 will still optimize based on the specifications, so throwing an
1859 unexpected exception will result in undefined behavior.
1860
1861 @item -ffor-scope
1862 @itemx -fno-for-scope
1863 @opindex ffor-scope
1864 @opindex fno-for-scope
1865 If @option{-ffor-scope} is specified, the scope of variables declared in
1866 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1867 as specified by the C++ standard.
1868 If @option{-fno-for-scope} is specified, the scope of variables declared in
1869 a @i{for-init-statement} extends to the end of the enclosing scope,
1870 as was the case in old versions of G++, and other (traditional)
1871 implementations of C++.
1872
1873 The default if neither flag is given to follow the standard,
1874 but to allow and give a warning for old-style code that would
1875 otherwise be invalid, or have different behavior.
1876
1877 @item -fno-gnu-keywords
1878 @opindex fno-gnu-keywords
1879 Do not recognize @code{typeof} as a keyword, so that code can use this
1880 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1881 @option{-ansi} implies @option{-fno-gnu-keywords}.
1882
1883 @item -fno-implicit-templates
1884 @opindex fno-implicit-templates
1885 Never emit code for non-inline templates which are instantiated
1886 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1887 @xref{Template Instantiation}, for more information.
1888
1889 @item -fno-implicit-inline-templates
1890 @opindex fno-implicit-inline-templates
1891 Don't emit code for implicit instantiations of inline templates, either.
1892 The default is to handle inlines differently so that compiles with and
1893 without optimization will need the same set of explicit instantiations.
1894
1895 @item -fno-implement-inlines
1896 @opindex fno-implement-inlines
1897 To save space, do not emit out-of-line copies of inline functions
1898 controlled by @samp{#pragma implementation}.  This will cause linker
1899 errors if these functions are not inlined everywhere they are called.
1900
1901 @item -fms-extensions
1902 @opindex fms-extensions
1903 Disable pedantic warnings about constructs used in MFC, such as implicit
1904 int and getting a pointer to member function via non-standard syntax.
1905
1906 @item -fno-nonansi-builtins
1907 @opindex fno-nonansi-builtins
1908 Disable built-in declarations of functions that are not mandated by
1909 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1910 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1911
1912 @item -fno-operator-names
1913 @opindex fno-operator-names
1914 Do not treat the operator name keywords @code{and}, @code{bitand},
1915 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1916 synonyms as keywords.
1917
1918 @item -fno-optional-diags
1919 @opindex fno-optional-diags
1920 Disable diagnostics that the standard says a compiler does not need to
1921 issue.  Currently, the only such diagnostic issued by G++ is the one for
1922 a name having multiple meanings within a class.
1923
1924 @item -fpermissive
1925 @opindex fpermissive
1926 Downgrade some diagnostics about nonconformant code from errors to
1927 warnings.  Thus, using @option{-fpermissive} will allow some
1928 nonconforming code to compile.
1929
1930 @item -fno-pretty-templates
1931 @opindex fno-pretty-templates
1932 When an error message refers to a specialization of a function
1933 template, the compiler will normally print the signature of the
1934 template followed by the template arguments and any typedefs or
1935 typenames in the signature (e.g. @code{void f(T) [with T = int]}
1936 rather than @code{void f(int)}) so that it's clear which template is
1937 involved.  When an error message refers to a specialization of a class
1938 template, the compiler will omit any template arguments which match
1939 the default template arguments for that template.  If either of these
1940 behaviors make it harder to understand the error message rather than
1941 easier, using @option{-fno-pretty-templates} will disable them.
1942
1943 @item -frepo
1944 @opindex frepo
1945 Enable automatic template instantiation at link time.  This option also
1946 implies @option{-fno-implicit-templates}.  @xref{Template
1947 Instantiation}, for more information.
1948
1949 @item -fno-rtti
1950 @opindex fno-rtti
1951 Disable generation of information about every class with virtual
1952 functions for use by the C++ runtime type identification features
1953 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1954 of the language, you can save some space by using this flag.  Note that
1955 exception handling uses the same information, but it will generate it as
1956 needed. The @samp{dynamic_cast} operator can still be used for casts that
1957 do not require runtime type information, i.e.@: casts to @code{void *} or to
1958 unambiguous base classes.
1959
1960 @item -fstats
1961 @opindex fstats
1962 Emit statistics about front-end processing at the end of the compilation.
1963 This information is generally only useful to the G++ development team.
1964
1965 @item -ftemplate-depth-@var{n}
1966 @opindex ftemplate-depth
1967 Set the maximum instantiation depth for template classes to @var{n}.
1968 A limit on the template instantiation depth is needed to detect
1969 endless recursions during template class instantiation.  ANSI/ISO C++
1970 conforming programs must not rely on a maximum depth greater than 17
1971 (changed to 1024 in C++0x).
1972
1973 @item -fno-threadsafe-statics
1974 @opindex fno-threadsafe-statics
1975 Do not emit the extra code to use the routines specified in the C++
1976 ABI for thread-safe initialization of local statics.  You can use this
1977 option to reduce code size slightly in code that doesn't need to be
1978 thread-safe.
1979
1980 @item -fuse-cxa-atexit
1981 @opindex fuse-cxa-atexit
1982 Register destructors for objects with static storage duration with the
1983 @code{__cxa_atexit} function rather than the @code{atexit} function.
1984 This option is required for fully standards-compliant handling of static
1985 destructors, but will only work if your C library supports
1986 @code{__cxa_atexit}.
1987
1988 @item -fno-use-cxa-get-exception-ptr
1989 @opindex fno-use-cxa-get-exception-ptr
1990 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1991 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1992 if the runtime routine is not available.
1993
1994 @item -fvisibility-inlines-hidden
1995 @opindex fvisibility-inlines-hidden
1996 This switch declares that the user does not attempt to compare
1997 pointers to inline methods where the addresses of the two functions
1998 were taken in different shared objects.
1999
2000 The effect of this is that GCC may, effectively, mark inline methods with
2001 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2002 appear in the export table of a DSO and do not require a PLT indirection
2003 when used within the DSO@.  Enabling this option can have a dramatic effect
2004 on load and link times of a DSO as it massively reduces the size of the
2005 dynamic export table when the library makes heavy use of templates.
2006
2007 The behavior of this switch is not quite the same as marking the
2008 methods as hidden directly, because it does not affect static variables
2009 local to the function or cause the compiler to deduce that
2010 the function is defined in only one shared object.
2011
2012 You may mark a method as having a visibility explicitly to negate the
2013 effect of the switch for that method.  For example, if you do want to
2014 compare pointers to a particular inline method, you might mark it as
2015 having default visibility.  Marking the enclosing class with explicit
2016 visibility will have no effect.
2017
2018 Explicitly instantiated inline methods are unaffected by this option
2019 as their linkage might otherwise cross a shared library boundary.
2020 @xref{Template Instantiation}.
2021
2022 @item -fvisibility-ms-compat
2023 @opindex fvisibility-ms-compat
2024 This flag attempts to use visibility settings to make GCC's C++
2025 linkage model compatible with that of Microsoft Visual Studio.
2026
2027 The flag makes these changes to GCC's linkage model:
2028
2029 @enumerate
2030 @item
2031 It sets the default visibility to @code{hidden}, like
2032 @option{-fvisibility=hidden}.
2033
2034 @item
2035 Types, but not their members, are not hidden by default.
2036
2037 @item
2038 The One Definition Rule is relaxed for types without explicit
2039 visibility specifications which are defined in more than one different
2040 shared object: those declarations are permitted if they would have
2041 been permitted when this option was not used.
2042 @end enumerate
2043
2044 In new code it is better to use @option{-fvisibility=hidden} and
2045 export those classes which are intended to be externally visible.
2046 Unfortunately it is possible for code to rely, perhaps accidentally,
2047 on the Visual Studio behavior.
2048
2049 Among the consequences of these changes are that static data members
2050 of the same type with the same name but defined in different shared
2051 objects will be different, so changing one will not change the other;
2052 and that pointers to function members defined in different shared
2053 objects may not compare equal.  When this flag is given, it is a
2054 violation of the ODR to define types with the same name differently.
2055
2056 @item -fno-weak
2057 @opindex fno-weak
2058 Do not use weak symbol support, even if it is provided by the linker.
2059 By default, G++ will use weak symbols if they are available.  This
2060 option exists only for testing, and should not be used by end-users;
2061 it will result in inferior code and has no benefits.  This option may
2062 be removed in a future release of G++.
2063
2064 @item -nostdinc++
2065 @opindex nostdinc++
2066 Do not search for header files in the standard directories specific to
2067 C++, but do still search the other standard directories.  (This option
2068 is used when building the C++ library.)
2069 @end table
2070
2071 In addition, these optimization, warning, and code generation options
2072 have meanings only for C++ programs:
2073
2074 @table @gcctabopt
2075 @item -fno-default-inline
2076 @opindex fno-default-inline
2077 Do not assume @samp{inline} for functions defined inside a class scope.
2078 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
2079 functions will have linkage like inline functions; they just won't be
2080 inlined by default.
2081
2082 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2083 @opindex Wabi
2084 @opindex Wno-abi
2085 Warn when G++ generates code that is probably not compatible with the
2086 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2087 all such cases, there are probably some cases that are not warned about,
2088 even though G++ is generating incompatible code.  There may also be
2089 cases where warnings are emitted even though the code that is generated
2090 will be compatible.
2091
2092 You should rewrite your code to avoid these warnings if you are
2093 concerned about the fact that code generated by G++ may not be binary
2094 compatible with code generated by other compilers.
2095
2096 The known incompatibilities at this point include:
2097
2098 @itemize @bullet
2099
2100 @item
2101 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2102 pack data into the same byte as a base class.  For example:
2103
2104 @smallexample
2105 struct A @{ virtual void f(); int f1 : 1; @};
2106 struct B : public A @{ int f2 : 1; @};
2107 @end smallexample
2108
2109 @noindent
2110 In this case, G++ will place @code{B::f2} into the same byte
2111 as@code{A::f1}; other compilers will not.  You can avoid this problem
2112 by explicitly padding @code{A} so that its size is a multiple of the
2113 byte size on your platform; that will cause G++ and other compilers to
2114 layout @code{B} identically.
2115
2116 @item
2117 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2118 tail padding when laying out virtual bases.  For example:
2119
2120 @smallexample
2121 struct A @{ virtual void f(); char c1; @};
2122 struct B @{ B(); char c2; @};
2123 struct C : public A, public virtual B @{@};
2124 @end smallexample
2125
2126 @noindent
2127 In this case, G++ will not place @code{B} into the tail-padding for
2128 @code{A}; other compilers will.  You can avoid this problem by
2129 explicitly padding @code{A} so that its size is a multiple of its
2130 alignment (ignoring virtual base classes); that will cause G++ and other
2131 compilers to layout @code{C} identically.
2132
2133 @item
2134 Incorrect handling of bit-fields with declared widths greater than that
2135 of their underlying types, when the bit-fields appear in a union.  For
2136 example:
2137
2138 @smallexample
2139 union U @{ int i : 4096; @};
2140 @end smallexample
2141
2142 @noindent
2143 Assuming that an @code{int} does not have 4096 bits, G++ will make the
2144 union too small by the number of bits in an @code{int}.
2145
2146 @item
2147 Empty classes can be placed at incorrect offsets.  For example:
2148
2149 @smallexample
2150 struct A @{@};
2151
2152 struct B @{
2153   A a;
2154   virtual void f ();
2155 @};
2156
2157 struct C : public B, public A @{@};
2158 @end smallexample
2159
2160 @noindent
2161 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
2162 it should be placed at offset zero.  G++ mistakenly believes that the
2163 @code{A} data member of @code{B} is already at offset zero.
2164
2165 @item
2166 Names of template functions whose types involve @code{typename} or
2167 template template parameters can be mangled incorrectly.
2168
2169 @smallexample
2170 template <typename Q>
2171 void f(typename Q::X) @{@}
2172
2173 template <template <typename> class Q>
2174 void f(typename Q<int>::X) @{@}
2175 @end smallexample
2176
2177 @noindent
2178 Instantiations of these templates may be mangled incorrectly.
2179
2180 @end itemize
2181
2182 It also warns psABI related changes.  The known psABI changes at this
2183 point include:
2184
2185 @itemize @bullet
2186
2187 @item
2188 For SYSV/x86-64, when passing union with long double, it is changed to
2189 pass in memory as specified in psABI.  For example:
2190
2191 @smallexample
2192 union U @{
2193   long double ld;
2194   int i;
2195 @};
2196 @end smallexample
2197
2198 @noindent
2199 @code{union U} will always be passed in memory.
2200
2201 @end itemize
2202
2203 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2204 @opindex Wctor-dtor-privacy
2205 @opindex Wno-ctor-dtor-privacy
2206 Warn when a class seems unusable because all the constructors or
2207 destructors in that class are private, and it has neither friends nor
2208 public static member functions.
2209
2210 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2211 @opindex Wnon-virtual-dtor
2212 @opindex Wno-non-virtual-dtor
2213 Warn when a class has virtual functions and accessible non-virtual
2214 destructor, in which case it would be possible but unsafe to delete
2215 an instance of a derived class through a pointer to the base class.
2216 This warning is also enabled if -Weffc++ is specified.
2217
2218 @item -Wreorder @r{(C++ and Objective-C++ only)}
2219 @opindex Wreorder
2220 @opindex Wno-reorder
2221 @cindex reordering, warning
2222 @cindex warning for reordering of member initializers
2223 Warn when the order of member initializers given in the code does not
2224 match the order in which they must be executed.  For instance:
2225
2226 @smallexample
2227 struct A @{
2228   int i;
2229   int j;
2230   A(): j (0), i (1) @{ @}
2231 @};
2232 @end smallexample
2233
2234 The compiler will rearrange the member initializers for @samp{i}
2235 and @samp{j} to match the declaration order of the members, emitting
2236 a warning to that effect.  This warning is enabled by @option{-Wall}.
2237 @end table
2238
2239 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2240
2241 @table @gcctabopt
2242 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2243 @opindex Weffc++
2244 @opindex Wno-effc++
2245 Warn about violations of the following style guidelines from Scott Meyers'
2246 @cite{Effective C++} book:
2247
2248 @itemize @bullet
2249 @item
2250 Item 11:  Define a copy constructor and an assignment operator for classes
2251 with dynamically allocated memory.
2252
2253 @item
2254 Item 12:  Prefer initialization to assignment in constructors.
2255
2256 @item
2257 Item 14:  Make destructors virtual in base classes.
2258
2259 @item
2260 Item 15:  Have @code{operator=} return a reference to @code{*this}.
2261
2262 @item
2263 Item 23:  Don't try to return a reference when you must return an object.
2264
2265 @end itemize
2266
2267 Also warn about violations of the following style guidelines from
2268 Scott Meyers' @cite{More Effective C++} book:
2269
2270 @itemize @bullet
2271 @item
2272 Item 6:  Distinguish between prefix and postfix forms of increment and
2273 decrement operators.
2274
2275 @item
2276 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
2277
2278 @end itemize
2279
2280 When selecting this option, be aware that the standard library
2281 headers do not obey all of these guidelines; use @samp{grep -v}
2282 to filter out those warnings.
2283
2284 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2285 @opindex Wstrict-null-sentinel
2286 @opindex Wno-strict-null-sentinel
2287 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
2288 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2289 to @code{__null}.  Although it is a null pointer constant not a null pointer,
2290 it is guaranteed to be of the same size as a pointer.  But this use is
2291 not portable across different compilers.
2292
2293 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2294 @opindex Wno-non-template-friend
2295 @opindex Wnon-template-friend
2296 Disable warnings when non-templatized friend functions are declared
2297 within a template.  Since the advent of explicit template specification
2298 support in G++, if the name of the friend is an unqualified-id (i.e.,
2299 @samp{friend foo(int)}), the C++ language specification demands that the
2300 friend declare or define an ordinary, nontemplate function.  (Section
2301 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2302 could be interpreted as a particular specialization of a templatized
2303 function.  Because this non-conforming behavior is no longer the default
2304 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2305 check existing code for potential trouble spots and is on by default.
2306 This new compiler behavior can be turned off with
2307 @option{-Wno-non-template-friend} which keeps the conformant compiler code
2308 but disables the helpful warning.
2309
2310 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2311 @opindex Wold-style-cast
2312 @opindex Wno-old-style-cast
2313 Warn if an old-style (C-style) cast to a non-void type is used within
2314 a C++ program.  The new-style casts (@samp{dynamic_cast},
2315 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2316 less vulnerable to unintended effects and much easier to search for.
2317
2318 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2319 @opindex Woverloaded-virtual
2320 @opindex Wno-overloaded-virtual
2321 @cindex overloaded virtual fn, warning
2322 @cindex warning for overloaded virtual fn
2323 Warn when a function declaration hides virtual functions from a
2324 base class.  For example, in:
2325
2326 @smallexample
2327 struct A @{
2328   virtual void f();
2329 @};
2330
2331 struct B: public A @{
2332   void f(int);
2333 @};
2334 @end smallexample
2335
2336 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2337 like:
2338
2339 @smallexample
2340 B* b;
2341 b->f();
2342 @end smallexample
2343
2344 will fail to compile.
2345
2346 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2347 @opindex Wno-pmf-conversions
2348 @opindex Wpmf-conversions
2349 Disable the diagnostic for converting a bound pointer to member function
2350 to a plain pointer.
2351
2352 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2353 @opindex Wsign-promo
2354 @opindex Wno-sign-promo
2355 Warn when overload resolution chooses a promotion from unsigned or
2356 enumerated type to a signed type, over a conversion to an unsigned type of
2357 the same size.  Previous versions of G++ would try to preserve
2358 unsignedness, but the standard mandates the current behavior.
2359
2360 @smallexample
2361 struct A @{
2362   operator int ();
2363   A& operator = (int);
2364 @};
2365
2366 main ()
2367 @{
2368   A a,b;
2369   a = b;
2370 @}
2371 @end smallexample
2372
2373 In this example, G++ will synthesize a default @samp{A& operator =
2374 (const A&);}, while cfront will use the user-defined @samp{operator =}.
2375 @end table
2376
2377 @node Objective-C and Objective-C++ Dialect Options
2378 @section Options Controlling Objective-C and Objective-C++ Dialects
2379
2380 @cindex compiler options, Objective-C and Objective-C++
2381 @cindex Objective-C and Objective-C++ options, command line
2382 @cindex options, Objective-C and Objective-C++
2383 (NOTE: This manual does not describe the Objective-C and Objective-C++
2384 languages themselves.  See @xref{Standards,,Language Standards
2385 Supported by GCC}, for references.)
2386
2387 This section describes the command-line options that are only meaningful
2388 for Objective-C and Objective-C++ programs, but you can also use most of
2389 the language-independent GNU compiler options.
2390 For example, you might compile a file @code{some_class.m} like this:
2391
2392 @smallexample
2393 gcc -g -fgnu-runtime -O -c some_class.m
2394 @end smallexample
2395
2396 @noindent
2397 In this example, @option{-fgnu-runtime} is an option meant only for
2398 Objective-C and Objective-C++ programs; you can use the other options with
2399 any language supported by GCC@.
2400
2401 Note that since Objective-C is an extension of the C language, Objective-C
2402 compilations may also use options specific to the C front-end (e.g.,
2403 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2404 C++-specific options (e.g., @option{-Wabi}).
2405
2406 Here is a list of options that are @emph{only} for compiling Objective-C
2407 and Objective-C++ programs:
2408
2409 @table @gcctabopt
2410 @item -fconstant-string-class=@var{class-name}
2411 @opindex fconstant-string-class
2412 Use @var{class-name} as the name of the class to instantiate for each
2413 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2414 class name is @code{NXConstantString} if the GNU runtime is being used, and
2415 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2416 @option{-fconstant-cfstrings} option, if also present, will override the
2417 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2418 to be laid out as constant CoreFoundation strings.
2419
2420 @item -fgnu-runtime
2421 @opindex fgnu-runtime
2422 Generate object code compatible with the standard GNU Objective-C
2423 runtime.  This is the default for most types of systems.
2424
2425 @item -fnext-runtime
2426 @opindex fnext-runtime
2427 Generate output compatible with the NeXT runtime.  This is the default
2428 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2429 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2430 used.
2431
2432 @item -fno-nil-receivers
2433 @opindex fno-nil-receivers
2434 Assume that all Objective-C message dispatches (e.g.,
2435 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2436 is not @code{nil}.  This allows for more efficient entry points in the runtime
2437 to be used.  Currently, this option is only available in conjunction with
2438 the NeXT runtime on Mac OS X 10.3 and later.
2439
2440 @item -fobjc-call-cxx-cdtors
2441 @opindex fobjc-call-cxx-cdtors
2442 For each Objective-C class, check if any of its instance variables is a
2443 C++ object with a non-trivial default constructor.  If so, synthesize a
2444 special @code{- (id) .cxx_construct} instance method that will run
2445 non-trivial default constructors on any such instance variables, in order,
2446 and then return @code{self}.  Similarly, check if any instance variable
2447 is a C++ object with a non-trivial destructor, and if so, synthesize a
2448 special @code{- (void) .cxx_destruct} method that will run
2449 all such default destructors, in reverse order.
2450
2451 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2452 thusly generated will only operate on instance variables declared in the
2453 current Objective-C class, and not those inherited from superclasses.  It
2454 is the responsibility of the Objective-C runtime to invoke all such methods
2455 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
2456 will be invoked by the runtime immediately after a new object
2457 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2458 be invoked immediately before the runtime deallocates an object instance.
2459
2460 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2461 support for invoking the @code{- (id) .cxx_construct} and
2462 @code{- (void) .cxx_destruct} methods.
2463
2464 @item -fobjc-direct-dispatch
2465 @opindex fobjc-direct-dispatch
2466 Allow fast jumps to the message dispatcher.  On Darwin this is
2467 accomplished via the comm page.
2468
2469 @item -fobjc-exceptions
2470 @opindex fobjc-exceptions
2471 Enable syntactic support for structured exception handling in Objective-C,
2472 similar to what is offered by C++ and Java.  This option is
2473 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2474 earlier.
2475
2476 @smallexample
2477   @@try @{
2478     @dots{}
2479        @@throw expr;
2480     @dots{}
2481   @}
2482   @@catch (AnObjCClass *exc) @{
2483     @dots{}
2484       @@throw expr;
2485     @dots{}
2486       @@throw;
2487     @dots{}
2488   @}
2489   @@catch (AnotherClass *exc) @{
2490     @dots{}
2491   @}
2492   @@catch (id allOthers) @{
2493     @dots{}
2494   @}
2495   @@finally @{
2496     @dots{}
2497       @@throw expr;
2498     @dots{}
2499   @}
2500 @end smallexample
2501
2502 The @code{@@throw} statement may appear anywhere in an Objective-C or
2503 Objective-C++ program; when used inside of a @code{@@catch} block, the
2504 @code{@@throw} may appear without an argument (as shown above), in which case
2505 the object caught by the @code{@@catch} will be rethrown.
2506
2507 Note that only (pointers to) Objective-C objects may be thrown and
2508 caught using this scheme.  When an object is thrown, it will be caught
2509 by the nearest @code{@@catch} clause capable of handling objects of that type,
2510 analogously to how @code{catch} blocks work in C++ and Java.  A
2511 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2512 any and all Objective-C exceptions not caught by previous @code{@@catch}
2513 clauses (if any).
2514
2515 The @code{@@finally} clause, if present, will be executed upon exit from the
2516 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2517 regardless of whether any exceptions are thrown, caught or rethrown
2518 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2519 of the @code{finally} clause in Java.
2520
2521 There are several caveats to using the new exception mechanism:
2522
2523 @itemize @bullet
2524 @item
2525 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2526 idioms provided by the @code{NSException} class, the new
2527 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2528 systems, due to additional functionality needed in the (NeXT) Objective-C
2529 runtime.
2530
2531 @item
2532 As mentioned above, the new exceptions do not support handling
2533 types other than Objective-C objects.   Furthermore, when used from
2534 Objective-C++, the Objective-C exception model does not interoperate with C++
2535 exceptions at this time.  This means you cannot @code{@@throw} an exception
2536 from Objective-C and @code{catch} it in C++, or vice versa
2537 (i.e., @code{throw @dots{} @@catch}).
2538 @end itemize
2539
2540 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2541 blocks for thread-safe execution:
2542
2543 @smallexample
2544   @@synchronized (ObjCClass *guard) @{
2545     @dots{}
2546   @}
2547 @end smallexample
2548
2549 Upon entering the @code{@@synchronized} block, a thread of execution shall
2550 first check whether a lock has been placed on the corresponding @code{guard}
2551 object by another thread.  If it has, the current thread shall wait until
2552 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2553 the current thread will place its own lock on it, execute the code contained in
2554 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2555 making @code{guard} available to other threads).
2556
2557 Unlike Java, Objective-C does not allow for entire methods to be marked
2558 @code{@@synchronized}.  Note that throwing exceptions out of
2559 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2560 to be unlocked properly.
2561
2562 @item -fobjc-gc
2563 @opindex fobjc-gc
2564 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2565
2566 @item -freplace-objc-classes
2567 @opindex freplace-objc-classes
2568 Emit a special marker instructing @command{ld(1)} not to statically link in
2569 the resulting object file, and allow @command{dyld(1)} to load it in at
2570 run time instead.  This is used in conjunction with the Fix-and-Continue
2571 debugging mode, where the object file in question may be recompiled and
2572 dynamically reloaded in the course of program execution, without the need
2573 to restart the program itself.  Currently, Fix-and-Continue functionality
2574 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2575 and later.
2576
2577 @item -fzero-link
2578 @opindex fzero-link
2579 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2580 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2581 compile time) with static class references that get initialized at load time,
2582 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2583 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2584 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2585 for individual class implementations to be modified during program execution.
2586
2587 @item -gen-decls
2588 @opindex gen-decls
2589 Dump interface declarations for all classes seen in the source file to a
2590 file named @file{@var{sourcename}.decl}.
2591
2592 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2593 @opindex Wassign-intercept
2594 @opindex Wno-assign-intercept
2595 Warn whenever an Objective-C assignment is being intercepted by the
2596 garbage collector.
2597
2598 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2599 @opindex Wno-protocol
2600 @opindex Wprotocol
2601 If a class is declared to implement a protocol, a warning is issued for
2602 every method in the protocol that is not implemented by the class.  The
2603 default behavior is to issue a warning for every method not explicitly
2604 implemented in the class, even if a method implementation is inherited
2605 from the superclass.  If you use the @option{-Wno-protocol} option, then
2606 methods inherited from the superclass are considered to be implemented,
2607 and no warning is issued for them.
2608
2609 @item -Wselector @r{(Objective-C and Objective-C++ only)}
2610 @opindex Wselector
2611 @opindex Wno-selector
2612 Warn if multiple methods of different types for the same selector are
2613 found during compilation.  The check is performed on the list of methods
2614 in the final stage of compilation.  Additionally, a check is performed
2615 for each selector appearing in a @code{@@selector(@dots{})}
2616 expression, and a corresponding method for that selector has been found
2617 during compilation.  Because these checks scan the method table only at
2618 the end of compilation, these warnings are not produced if the final
2619 stage of compilation is not reached, for example because an error is
2620 found during compilation, or because the @option{-fsyntax-only} option is
2621 being used.
2622
2623 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
2624 @opindex Wstrict-selector-match
2625 @opindex Wno-strict-selector-match
2626 Warn if multiple methods with differing argument and/or return types are
2627 found for a given selector when attempting to send a message using this
2628 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2629 is off (which is the default behavior), the compiler will omit such warnings
2630 if any differences found are confined to types which share the same size
2631 and alignment.
2632
2633 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
2634 @opindex Wundeclared-selector
2635 @opindex Wno-undeclared-selector
2636 Warn if a @code{@@selector(@dots{})} expression referring to an
2637 undeclared selector is found.  A selector is considered undeclared if no
2638 method with that name has been declared before the
2639 @code{@@selector(@dots{})} expression, either explicitly in an
2640 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2641 an @code{@@implementation} section.  This option always performs its
2642 checks as soon as a @code{@@selector(@dots{})} expression is found,
2643 while @option{-Wselector} only performs its checks in the final stage of
2644 compilation.  This also enforces the coding style convention
2645 that methods and selectors must be declared before being used.
2646
2647 @item -print-objc-runtime-info
2648 @opindex print-objc-runtime-info
2649 Generate C header describing the largest structure that is passed by
2650 value, if any.
2651
2652 @end table
2653
2654 @node Language Independent Options
2655 @section Options to Control Diagnostic Messages Formatting
2656 @cindex options to control diagnostics formatting
2657 @cindex diagnostic messages
2658 @cindex message formatting
2659
2660 Traditionally, diagnostic messages have been formatted irrespective of
2661 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2662 below can be used to control the diagnostic messages formatting
2663 algorithm, e.g.@: how many characters per line, how often source location
2664 information should be reported.  Right now, only the C++ front end can
2665 honor these options.  However it is expected, in the near future, that
2666 the remaining front ends would be able to digest them correctly.
2667
2668 @table @gcctabopt
2669 @item -fmessage-length=@var{n}
2670 @opindex fmessage-length
2671 Try to format error messages so that they fit on lines of about @var{n}
2672 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2673 the front ends supported by GCC@.  If @var{n} is zero, then no
2674 line-wrapping will be done; each error message will appear on a single
2675 line.
2676
2677 @opindex fdiagnostics-show-location
2678 @item -fdiagnostics-show-location=once
2679 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2680 reporter to emit @emph{once} source location information; that is, in
2681 case the message is too long to fit on a single physical line and has to
2682 be wrapped, the source location won't be emitted (as prefix) again,
2683 over and over, in subsequent continuation lines.  This is the default
2684 behavior.
2685
2686 @item -fdiagnostics-show-location=every-line
2687 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2688 messages reporter to emit the same source location information (as
2689 prefix) for physical lines that result from the process of breaking
2690 a message which is too long to fit on a single line.
2691
2692 @item -fdiagnostics-show-option
2693 @opindex fdiagnostics-show-option
2694 This option instructs the diagnostic machinery to add text to each
2695 diagnostic emitted, which indicates which command line option directly
2696 controls that diagnostic, when such an option is known to the
2697 diagnostic machinery.
2698
2699 @item -Wcoverage-mismatch
2700 @opindex Wcoverage-mismatch
2701 Warn if feedback profiles do not match when using the
2702 @option{-fprofile-use} option.
2703 If a source file was changed between @option{-fprofile-gen} and
2704 @option{-fprofile-use}, the files with the profile feedback can fail
2705 to match the source file and GCC can not use the profile feedback
2706 information.  By default, GCC emits an error message in this case.
2707 The option @option{-Wcoverage-mismatch} emits a warning instead of an
2708 error.  GCC does not use appropriate feedback profiles, so using this
2709 option can result in poorly optimized code.  This option is useful
2710 only in the case of very minor changes such as bug fixes to an
2711 existing code-base.
2712
2713 @end table
2714
2715 @node Warning Options
2716 @section Options to Request or Suppress Warnings
2717 @cindex options to control warnings
2718 @cindex warning messages
2719 @cindex messages, warning
2720 @cindex suppressing warnings
2721
2722 Warnings are diagnostic messages that report constructions which
2723 are not inherently erroneous but which are risky or suggest there
2724 may have been an error.
2725
2726 The following language-independent options do not enable specific
2727 warnings but control the kinds of diagnostics produced by GCC.
2728
2729 @table @gcctabopt
2730 @cindex syntax checking
2731 @item -fsyntax-only
2732 @opindex fsyntax-only
2733 Check the code for syntax errors, but don't do anything beyond that.
2734
2735 @item -w
2736 @opindex w
2737 Inhibit all warning messages.
2738
2739 @item -Werror
2740 @opindex Werror
2741 @opindex Wno-error
2742 Make all warnings into errors.
2743
2744 @item -Werror=
2745 @opindex Werror=
2746 @opindex Wno-error=
2747 Make the specified warning into an error.  The specifier for a warning
2748 is appended, for example @option{-Werror=switch} turns the warnings
2749 controlled by @option{-Wswitch} into errors.  This switch takes a
2750 negative form, to be used to negate @option{-Werror} for specific
2751 warnings, for example @option{-Wno-error=switch} makes
2752 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
2753 is in effect.  You can use the @option{-fdiagnostics-show-option}
2754 option to have each controllable warning amended with the option which
2755 controls it, to determine what to use with this option.
2756
2757 Note that specifying @option{-Werror=}@var{foo} automatically implies
2758 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
2759 imply anything.
2760
2761 @item -Wfatal-errors
2762 @opindex Wfatal-errors
2763 @opindex Wno-fatal-errors
2764 This option causes the compiler to abort compilation on the first error
2765 occurred rather than trying to keep going and printing further error
2766 messages.
2767
2768 @end table
2769
2770 You can request many specific warnings with options beginning
2771 @samp{-W}, for example @option{-Wimplicit} to request warnings on
2772 implicit declarations.  Each of these specific warning options also
2773 has a negative form beginning @samp{-Wno-} to turn off warnings; for
2774 example, @option{-Wno-implicit}.  This manual lists only one of the
2775 two forms, whichever is not the default.  For further,
2776 language-specific options also refer to @ref{C++ Dialect Options} and
2777 @ref{Objective-C and Objective-C++ Dialect Options}.
2778
2779 @table @gcctabopt
2780 @item -pedantic
2781 @opindex pedantic
2782 Issue all the warnings demanded by strict ISO C and ISO C++;
2783 reject all programs that use forbidden extensions, and some other
2784 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2785 version of the ISO C standard specified by any @option{-std} option used.
2786
2787 Valid ISO C and ISO C++ programs should compile properly with or without
2788 this option (though a rare few will require @option{-ansi} or a
2789 @option{-std} option specifying the required version of ISO C)@.  However,
2790 without this option, certain GNU extensions and traditional C and C++
2791 features are supported as well.  With this option, they are rejected.
2792
2793 @option{-pedantic} does not cause warning messages for use of the
2794 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2795 warnings are also disabled in the expression that follows
2796 @code{__extension__}.  However, only system header files should use
2797 these escape routes; application programs should avoid them.
2798 @xref{Alternate Keywords}.
2799
2800 Some users try to use @option{-pedantic} to check programs for strict ISO
2801 C conformance.  They soon find that it does not do quite what they want:
2802 it finds some non-ISO practices, but not all---only those for which
2803 ISO C @emph{requires} a diagnostic, and some others for which
2804 diagnostics have been added.
2805
2806 A feature to report any failure to conform to ISO C might be useful in
2807 some instances, but would require considerable additional work and would
2808 be quite different from @option{-pedantic}.  We don't have plans to
2809 support such a feature in the near future.
2810
2811 Where the standard specified with @option{-std} represents a GNU
2812 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2813 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2814 extended dialect is based.  Warnings from @option{-pedantic} are given
2815 where they are required by the base standard.  (It would not make sense
2816 for such warnings to be given only for features not in the specified GNU
2817 C dialect, since by definition the GNU dialects of C include all
2818 features the compiler supports with the given option, and there would be
2819 nothing to warn about.)
2820
2821 @item -pedantic-errors
2822 @opindex pedantic-errors
2823 Like @option{-pedantic}, except that errors are produced rather than
2824 warnings.
2825
2826 @item -Wall
2827 @opindex Wall
2828 @opindex Wno-all
2829 This enables all the warnings about constructions that some users
2830 consider questionable, and that are easy to avoid (or modify to
2831 prevent the warning), even in conjunction with macros.  This also
2832 enables some language-specific warnings described in @ref{C++ Dialect
2833 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
2834
2835 @option{-Wall} turns on the following warning flags:
2836
2837 @gccoptlist{-Waddress   @gol
2838 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
2839 -Wc++0x-compat  @gol
2840 -Wchar-subscripts  @gol
2841 -Wenum-compare @r{(in C/Objc; this is on by default in C++)} @gol
2842 -Wimplicit-int  @gol
2843 -Wimplicit-function-declaration  @gol
2844 -Wcomment  @gol
2845 -Wformat   @gol
2846 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
2847 -Wmissing-braces  @gol
2848 -Wnonnull  @gol
2849 -Wparentheses  @gol
2850 -Wpointer-sign  @gol
2851 -Wreorder   @gol
2852 -Wreturn-type  @gol
2853 -Wsequence-point  @gol
2854 -Wsign-compare @r{(only in C++)}  @gol
2855 -Wstrict-aliasing  @gol
2856 -Wstrict-overflow=1  @gol
2857 -Wswitch  @gol
2858 -Wtrigraphs  @gol
2859 -Wuninitialized  @gol
2860 -Wunknown-pragmas  @gol
2861 -Wunused-function  @gol
2862 -Wunused-label     @gol
2863 -Wunused-value     @gol
2864 -Wunused-variable  @gol
2865 -Wvolatile-register-var @gol
2866 }
2867
2868 Note that some warning flags are not implied by @option{-Wall}.  Some of
2869 them warn about constructions that users generally do not consider
2870 questionable, but which occasionally you might wish to check for;
2871 others warn about constructions that are necessary or hard to avoid in
2872 some cases, and there is no simple way to modify the code to suppress
2873 the warning. Some of them are enabled by @option{-Wextra} but many of
2874 them must be enabled individually.
2875
2876 @item -Wextra
2877 @opindex W
2878 @opindex Wextra
2879 @opindex Wno-extra
2880 This enables some extra warning flags that are not enabled by
2881 @option{-Wall}. (This option used to be called @option{-W}.  The older
2882 name is still supported, but the newer name is more descriptive.)
2883
2884 @gccoptlist{-Wclobbered  @gol
2885 -Wempty-body  @gol
2886 -Wignored-qualifiers @gol
2887 -Wmissing-field-initializers  @gol
2888 -Wmissing-parameter-type @r{(C only)}  @gol
2889 -Wold-style-declaration @r{(C only)}  @gol
2890 -Woverride-init  @gol
2891 -Wsign-compare  @gol
2892 -Wtype-limits  @gol
2893 -Wuninitialized  @gol
2894 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
2895 }
2896
2897 The option @option{-Wextra} also prints warning messages for the
2898 following cases:
2899
2900 @itemize @bullet
2901
2902 @item
2903 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2904 @samp{>}, or @samp{>=}.
2905
2906 @item
2907 (C++ only) An enumerator and a non-enumerator both appear in a
2908 conditional expression.
2909
2910 @item
2911 (C++ only) Ambiguous virtual bases.
2912
2913 @item
2914 (C++ only) Subscripting an array which has been declared @samp{register}.
2915
2916 @item
2917 (C++ only) Taking the address of a variable which has been declared
2918 @samp{register}.
2919
2920 @item
2921 (C++ only) A base class is not initialized in a derived class' copy
2922 constructor.
2923
2924 @end itemize
2925
2926 @item -Wchar-subscripts
2927 @opindex Wchar-subscripts
2928 @opindex Wno-char-subscripts
2929 Warn if an array subscript has type @code{char}.  This is a common cause
2930 of error, as programmers often forget that this type is signed on some
2931 machines.
2932 This warning is enabled by @option{-Wall}.
2933
2934 @item -Wcomment
2935 @opindex Wcomment
2936 @opindex Wno-comment
2937 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2938 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2939 This warning is enabled by @option{-Wall}.
2940
2941 @item -Wformat
2942 @opindex Wformat
2943 @opindex Wno-format
2944 @opindex ffreestanding
2945 @opindex fno-builtin
2946 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2947 the arguments supplied have types appropriate to the format string
2948 specified, and that the conversions specified in the format string make
2949 sense.  This includes standard functions, and others specified by format
2950 attributes (@pxref{Function Attributes}), in the @code{printf},
2951 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2952 not in the C standard) families (or other target-specific families).
2953 Which functions are checked without format attributes having been
2954 specified depends on the standard version selected, and such checks of
2955 functions without the attribute specified are disabled by
2956 @option{-ffreestanding} or @option{-fno-builtin}.
2957
2958 The formats are checked against the format features supported by GNU
2959 libc version 2.2.  These include all ISO C90 and C99 features, as well
2960 as features from the Single Unix Specification and some BSD and GNU
2961 extensions.  Other library implementations may not support all these
2962 features; GCC does not support warning about features that go beyond a
2963 particular library's limitations.  However, if @option{-pedantic} is used
2964 with @option{-Wformat}, warnings will be given about format features not
2965 in the selected standard version (but not for @code{strfmon} formats,
2966 since those are not in any version of the C standard).  @xref{C Dialect
2967 Options,,Options Controlling C Dialect}.
2968
2969 Since @option{-Wformat} also checks for null format arguments for
2970 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2971
2972 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2973 aspects of format checking, the options @option{-Wformat-y2k},
2974 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2975 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2976 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2977
2978 @item -Wformat-y2k
2979 @opindex Wformat-y2k
2980 @opindex Wno-format-y2k
2981 If @option{-Wformat} is specified, also warn about @code{strftime}
2982 formats which may yield only a two-digit year.
2983
2984 @item -Wno-format-contains-nul
2985 @opindex Wno-format-contains-nul
2986 @opindex Wformat-contains-nul
2987 If @option{-Wformat} is specified, do not warn about format strings that
2988 contain NUL bytes.
2989
2990 @item -Wno-format-extra-args
2991 @opindex Wno-format-extra-args
2992 @opindex Wformat-extra-args
2993 If @option{-Wformat} is specified, do not warn about excess arguments to a
2994 @code{printf} or @code{scanf} format function.  The C standard specifies
2995 that such arguments are ignored.
2996
2997 Where the unused arguments lie between used arguments that are
2998 specified with @samp{$} operand number specifications, normally
2999 warnings are still given, since the implementation could not know what
3000 type to pass to @code{va_arg} to skip the unused arguments.  However,
3001 in the case of @code{scanf} formats, this option will suppress the
3002 warning if the unused arguments are all pointers, since the Single
3003 Unix Specification says that such unused arguments are allowed.
3004
3005 @item -Wno-format-zero-length @r{(C and Objective-C only)}
3006 @opindex Wno-format-zero-length
3007 @opindex Wformat-zero-length
3008 If @option{-Wformat} is specified, do not warn about zero-length formats.
3009 The C standard specifies that zero-length formats are allowed.
3010
3011 @item -Wformat-nonliteral
3012 @opindex Wformat-nonliteral
3013 @opindex Wno-format-nonliteral
3014 If @option{-Wformat} is specified, also warn if the format string is not a
3015 string literal and so cannot be checked, unless the format function
3016 takes its format arguments as a @code{va_list}.
3017
3018 @item -Wformat-security
3019 @opindex Wformat-security
3020 @opindex Wno-format-security
3021 If @option{-Wformat} is specified, also warn about uses of format
3022 functions that represent possible security problems.  At present, this
3023 warns about calls to @code{printf} and @code{scanf} functions where the
3024 format string is not a string literal and there are no format arguments,
3025 as in @code{printf (foo);}.  This may be a security hole if the format
3026 string came from untrusted input and contains @samp{%n}.  (This is
3027 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3028 in future warnings may be added to @option{-Wformat-security} that are not
3029 included in @option{-Wformat-nonliteral}.)
3030
3031 @item -Wformat=2
3032 @opindex Wformat=2
3033 @opindex Wno-format=2
3034 Enable @option{-Wformat} plus format checks not included in
3035 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
3036 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
3037
3038 @item -Wnonnull @r{(C and Objective-C only)}
3039 @opindex Wnonnull
3040 @opindex Wno-nonnull
3041 Warn about passing a null pointer for arguments marked as
3042 requiring a non-null value by the @code{nonnull} function attribute.
3043
3044 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3045 can be disabled with the @option{-Wno-nonnull} option.
3046
3047 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3048 @opindex Winit-self
3049 @opindex Wno-init-self
3050 Warn about uninitialized variables which are initialized with themselves.
3051 Note this option can only be used with the @option{-Wuninitialized} option.
3052
3053 For example, GCC will warn about @code{i} being uninitialized in the
3054 following snippet only when @option{-Winit-self} has been specified:
3055 @smallexample
3056 @group
3057 int f()
3058 @{
3059   int i = i;
3060   return i;
3061 @}
3062 @end group
3063 @end smallexample
3064
3065 @item -Wimplicit-int @r{(C and Objective-C only)}
3066 @opindex Wimplicit-int
3067 @opindex Wno-implicit-int
3068 Warn when a declaration does not specify a type.
3069 This warning is enabled by @option{-Wall}.
3070
3071 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3072 @opindex Wimplicit-function-declaration
3073 @opindex Wno-implicit-function-declaration
3074 Give a warning whenever a function is used before being declared. In
3075 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3076 enabled by default and it is made into an error by
3077 @option{-pedantic-errors}. This warning is also enabled by
3078 @option{-Wall}.
3079
3080 @item -Wimplicit
3081 @opindex Wimplicit
3082 @opindex Wno-implicit
3083 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3084 This warning is enabled by @option{-Wall}.
3085
3086 @item -Wignored-qualifiers @r{(C and C++ only)}
3087 @opindex Wignored-qualifiers
3088 @opindex Wno-ignored-qualifiers
3089 Warn if the return type of a function has a type qualifier
3090 such as @code{const}.  For ISO C such a type qualifier has no effect,
3091 since the value returned by a function is not an lvalue.
3092 For C++, the warning is only emitted for scalar types or @code{void}.
3093 ISO C prohibits qualified @code{void} return types on function
3094 definitions, so such return types always receive a warning
3095 even without this option.
3096
3097 This warning is also enabled by @option{-Wextra}.
3098
3099 @item -Wmain
3100 @opindex Wmain
3101 @opindex Wno-main
3102 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3103 a function with external linkage, returning int, taking either zero
3104 arguments, two, or three arguments of appropriate types.  This warning
3105 is enabled by default in C++ and is enabled by either @option{-Wall}
3106 or @option{-pedantic}.
3107
3108 @item -Wmissing-braces
3109 @opindex Wmissing-braces
3110 @opindex Wno-missing-braces
3111 Warn if an aggregate or union initializer is not fully bracketed.  In
3112 the following example, the initializer for @samp{a} is not fully
3113 bracketed, but that for @samp{b} is fully bracketed.
3114
3115 @smallexample
3116 int a[2][2] = @{ 0, 1, 2, 3 @};
3117 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3118 @end smallexample
3119
3120 This warning is enabled by @option{-Wall}.
3121
3122 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3123 @opindex Wmissing-include-dirs
3124 @opindex Wno-missing-include-dirs
3125 Warn if a user-supplied include directory does not exist.
3126
3127 @item -Wparentheses
3128 @opindex Wparentheses
3129 @opindex Wno-parentheses
3130 Warn if parentheses are omitted in certain contexts, such
3131 as when there is an assignment in a context where a truth value
3132 is expected, or when operators are nested whose precedence people
3133 often get confused about.
3134
3135 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3136 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3137 interpretation from that of ordinary mathematical notation.
3138
3139 Also warn about constructions where there may be confusion to which
3140 @code{if} statement an @code{else} branch belongs.  Here is an example of
3141 such a case:
3142
3143 @smallexample
3144 @group
3145 @{
3146   if (a)
3147     if (b)
3148       foo ();
3149   else
3150     bar ();
3151 @}
3152 @end group
3153 @end smallexample
3154
3155 In C/C++, every @code{else} branch belongs to the innermost possible
3156 @code{if} statement, which in this example is @code{if (b)}.  This is
3157 often not what the programmer expected, as illustrated in the above
3158 example by indentation the programmer chose.  When there is the
3159 potential for this confusion, GCC will issue a warning when this flag
3160 is specified.  To eliminate the warning, add explicit braces around
3161 the innermost @code{if} statement so there is no way the @code{else}
3162 could belong to the enclosing @code{if}.  The resulting code would
3163 look like this:
3164
3165 @smallexample
3166 @group
3167 @{
3168   if (a)
3169     @{
3170       if (b)
3171         foo ();
3172       else
3173         bar ();
3174     @}
3175 @}
3176 @end group
3177 @end smallexample
3178
3179 This warning is enabled by @option{-Wall}.
3180
3181 @item -Wsequence-point
3182 @opindex Wsequence-point
3183 @opindex Wno-sequence-point
3184 Warn about code that may have undefined semantics because of violations
3185 of sequence point rules in the C and C++ standards.
3186
3187 The C and C++ standards defines the order in which expressions in a C/C++
3188 program are evaluated in terms of @dfn{sequence points}, which represent
3189 a partial ordering between the execution of parts of the program: those
3190 executed before the sequence point, and those executed after it.  These
3191 occur after the evaluation of a full expression (one which is not part
3192 of a larger expression), after the evaluation of the first operand of a
3193 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3194 function is called (but after the evaluation of its arguments and the
3195 expression denoting the called function), and in certain other places.
3196 Other than as expressed by the sequence point rules, the order of
3197 evaluation of subexpressions of an expression is not specified.  All
3198 these rules describe only a partial order rather than a total order,
3199 since, for example, if two functions are called within one expression
3200 with no sequence point between them, the order in which the functions
3201 are called is not specified.  However, the standards committee have
3202 ruled that function calls do not overlap.
3203
3204 It is not specified when between sequence points modifications to the
3205 values of objects take effect.  Programs whose behavior depends on this
3206 have undefined behavior; the C and C++ standards specify that ``Between
3207 the previous and next sequence point an object shall have its stored
3208 value modified at most once by the evaluation of an expression.
3209 Furthermore, the prior value shall be read only to determine the value
3210 to be stored.''.  If a program breaks these rules, the results on any
3211 particular implementation are entirely unpredictable.
3212
3213 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3214 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3215 diagnosed by this option, and it may give an occasional false positive
3216 result, but in general it has been found fairly effective at detecting
3217 this sort of problem in programs.
3218
3219 The standard is worded confusingly, therefore there is some debate
3220 over the precise meaning of the sequence point rules in subtle cases.
3221 Links to discussions of the problem, including proposed formal
3222 definitions, may be found on the GCC readings page, at
3223 @w{@uref{http://gcc.gnu.org/readings.html}}.
3224
3225 This warning is enabled by @option{-Wall} for C and C++.
3226
3227 @item -Wreturn-type
3228 @opindex Wreturn-type
3229 @opindex Wno-return-type
3230 Warn whenever a function is defined with a return-type that defaults
3231 to @code{int}.  Also warn about any @code{return} statement with no
3232 return-value in a function whose return-type is not @code{void}
3233 (falling off the end of the function body is considered returning
3234 without a value), and about a @code{return} statement with an
3235 expression in a function whose return-type is @code{void}.
3236
3237 For C++, a function without return type always produces a diagnostic
3238 message, even when @option{-Wno-return-type} is specified.  The only
3239 exceptions are @samp{main} and functions defined in system headers.
3240
3241 This warning is enabled by @option{-Wall}.
3242
3243 @item -Wswitch
3244 @opindex Wswitch
3245 @opindex Wno-switch
3246 Warn whenever a @code{switch} statement has an index of enumerated type
3247 and lacks a @code{case} for one or more of the named codes of that
3248 enumeration.  (The presence of a @code{default} label prevents this
3249 warning.)  @code{case} labels outside the enumeration range also
3250 provoke warnings when this option is used (even if there is a
3251 @code{default} label).
3252 This warning is enabled by @option{-Wall}.
3253
3254 @item -Wswitch-default
3255 @opindex Wswitch-default
3256 @opindex Wno-switch-default
3257 Warn whenever a @code{switch} statement does not have a @code{default}
3258 case.
3259
3260 @item -Wswitch-enum
3261 @opindex Wswitch-enum
3262 @opindex Wno-switch-enum
3263 Warn whenever a @code{switch} statement has an index of enumerated type
3264 and lacks a @code{case} for one or more of the named codes of that
3265 enumeration.  @code{case} labels outside the enumeration range also
3266 provoke warnings when this option is used.  The only difference
3267 between @option{-Wswitch} and this option is that this option gives a
3268 warning about an omitted enumeration code even if there is a
3269 @code{default} label.
3270
3271 @item -Wsync-nand @r{(C and C++ only)}
3272 @opindex Wsync-nand
3273 @opindex Wno-sync-nand
3274 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3275 built-in functions are used.  These functions changed semantics in GCC 4.4.
3276
3277 @item -Wtrigraphs
3278 @opindex Wtrigraphs
3279 @opindex Wno-trigraphs
3280 Warn if any trigraphs are encountered that might change the meaning of
3281 the program (trigraphs within comments are not warned about).
3282 This warning is enabled by @option{-Wall}.
3283
3284 @item -Wunused-function
3285 @opindex Wunused-function
3286 @opindex Wno-unused-function
3287 Warn whenever a static function is declared but not defined or a
3288 non-inline static function is unused.
3289 This warning is enabled by @option{-Wall}.
3290
3291 @item -Wunused-label
3292 @opindex Wunused-label
3293 @opindex Wno-unused-label
3294 Warn whenever a label is declared but not used.
3295 This warning is enabled by @option{-Wall}.
3296
3297 To suppress this warning use the @samp{unused} attribute
3298 (@pxref{Variable Attributes}).
3299
3300 @item -Wunused-parameter
3301 @opindex Wunused-parameter
3302 @opindex Wno-unused-parameter
3303 Warn whenever a function parameter is unused aside from its declaration.
3304
3305 To suppress this warning use the @samp{unused} attribute
3306 (@pxref{Variable Attributes}).
3307
3308 @item -Wno-unused-result
3309 @opindex Wunused-result
3310 @opindex Wno-unused-result
3311 Do not warn if a caller of a function marked with attribute
3312 @code{warn_unused_result} (@pxref{Variable Attributes}) does not use
3313 its return value. The default is @option{-Wunused-result}.
3314
3315 @item -Wunused-variable
3316 @opindex Wunused-variable
3317 @opindex Wno-unused-variable
3318 Warn whenever a local variable or non-constant static variable is unused
3319 aside from its declaration.
3320 This warning is enabled by @option{-Wall}.
3321
3322 To suppress this warning use the @samp{unused} attribute
3323 (@pxref{Variable Attributes}).
3324
3325 @item -Wunused-value
3326 @opindex Wunused-value
3327 @opindex Wno-unused-value
3328 Warn whenever a statement computes a result that is explicitly not
3329 used. To suppress this warning cast the unused expression to
3330 @samp{void}. This includes an expression-statement or the left-hand
3331 side of a comma expression that contains no side effects. For example,
3332 an expression such as @samp{x[i,j]} will cause a warning, while
3333 @samp{x[(void)i,j]} will not.
3334
3335 This warning is enabled by @option{-Wall}.
3336
3337 @item -Wunused
3338 @opindex Wunused
3339 @opindex Wno-unused
3340 All the above @option{-Wunused} options combined.
3341
3342 In order to get a warning about an unused function parameter, you must
3343 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
3344 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
3345
3346 @item -Wuninitialized
3347 @opindex Wuninitialized
3348 @opindex Wno-uninitialized
3349 Warn if an automatic variable is used without first being initialized
3350 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3351 warn if a non-static reference or non-static @samp{const} member
3352 appears in a class without constructors.
3353
3354 If you want to warn about code which uses the uninitialized value of the
3355 variable in its own initializer, use the @option{-Winit-self} option.
3356
3357 These warnings occur for individual uninitialized or clobbered
3358 elements of structure, union or array variables as well as for
3359 variables which are uninitialized or clobbered as a whole.  They do
3360 not occur for variables or elements declared @code{volatile}.  Because
3361 these warnings depend on optimization, the exact variables or elements
3362 for which there are warnings will depend on the precise optimization
3363 options and version of GCC used.
3364
3365 Note that there may be no warning about a variable that is used only
3366 to compute a value that itself is never used, because such
3367 computations may be deleted by data flow analysis before the warnings
3368 are printed.
3369
3370 These warnings are made optional because GCC is not smart
3371 enough to see all the reasons why the code might be correct
3372 despite appearing to have an error.  Here is one example of how
3373 this can happen:
3374
3375 @smallexample
3376 @group
3377 @{
3378   int x;
3379   switch (y)
3380     @{
3381     case 1: x = 1;
3382       break;
3383     case 2: x = 4;
3384       break;
3385     case 3: x = 5;
3386     @}
3387   foo (x);
3388 @}
3389 @end group
3390 @end smallexample
3391
3392 @noindent
3393 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3394 always initialized, but GCC doesn't know this.  Here is
3395 another common case:
3396
3397 @smallexample
3398 @{
3399   int save_y;
3400   if (change_y) save_y = y, y = new_y;
3401   @dots{}
3402   if (change_y) y = save_y;
3403 @}
3404 @end smallexample
3405
3406 @noindent
3407 This has no bug because @code{save_y} is used only if it is set.
3408
3409 @cindex @code{longjmp} warnings
3410 This option also warns when a non-volatile automatic variable might be
3411 changed by a call to @code{longjmp}.  These warnings as well are possible
3412 only in optimizing compilation.
3413
3414 The compiler sees only the calls to @code{setjmp}.  It cannot know
3415 where @code{longjmp} will be called; in fact, a signal handler could
3416 call it at any point in the code.  As a result, you may get a warning
3417 even when there is in fact no problem because @code{longjmp} cannot
3418 in fact be called at the place which would cause a problem.
3419
3420 Some spurious warnings can be avoided if you declare all the functions
3421 you use that never return as @code{noreturn}.  @xref{Function
3422 Attributes}.
3423
3424 This warning is enabled by @option{-Wall} or @option{-Wextra}.
3425
3426 @item -Wunknown-pragmas
3427 @opindex Wunknown-pragmas
3428 @opindex Wno-unknown-pragmas
3429 @cindex warning for unknown pragmas
3430 @cindex unknown pragmas, warning
3431 @cindex pragmas, warning of unknown
3432 Warn when a #pragma directive is encountered which is not understood by
3433 GCC@.  If this command line option is used, warnings will even be issued
3434 for unknown pragmas in system header files.  This is not the case if
3435 the warnings were only enabled by the @option{-Wall} command line option.
3436
3437 @item -Wno-pragmas
3438 @opindex Wno-pragmas
3439 @opindex Wpragmas
3440 Do not warn about misuses of pragmas, such as incorrect parameters,
3441 invalid syntax, or conflicts between pragmas.  See also
3442 @samp{-Wunknown-pragmas}.
3443
3444 @item -Wstrict-aliasing
3445 @opindex Wstrict-aliasing
3446 @opindex Wno-strict-aliasing
3447 This option is only active when @option{-fstrict-aliasing} is active.
3448 It warns about code which might break the strict aliasing rules that the
3449 compiler is using for optimization.  The warning does not catch all
3450 cases, but does attempt to catch the more common pitfalls.  It is
3451 included in @option{-Wall}.
3452 It is equivalent to @option{-Wstrict-aliasing=3}
3453
3454 @item -Wstrict-aliasing=n
3455 @opindex Wstrict-aliasing=n
3456 @opindex Wno-strict-aliasing=n
3457 This option is only active when @option{-fstrict-aliasing} is active.
3458 It warns about code which might break the strict aliasing rules that the
3459 compiler is using for optimization.
3460 Higher levels correspond to higher accuracy (fewer false positives).
3461 Higher levels also correspond to more effort, similar to the way -O works.
3462 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=n},
3463 with n=3.
3464
3465 Level 1: Most aggressive, quick, least accurate.
3466 Possibly useful when higher levels
3467 do not warn but -fstrict-aliasing still breaks the code, as it has very few
3468 false negatives.  However, it has many false positives.
3469 Warns for all pointer conversions between possibly incompatible types,
3470 even if never dereferenced.  Runs in the frontend only.
3471
3472 Level 2: Aggressive, quick, not too precise.
3473 May still have many false positives (not as many as level 1 though),
3474 and few false negatives (but possibly more than level 1).
3475 Unlike level 1, it only warns when an address is taken.  Warns about
3476 incomplete types.  Runs in the frontend only.
3477
3478 Level 3 (default for @option{-Wstrict-aliasing}):
3479 Should have very few false positives and few false
3480 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
3481 Takes care of the common punn+dereference pattern in the frontend:
3482 @code{*(int*)&some_float}.
3483 If optimization is enabled, it also runs in the backend, where it deals
3484 with multiple statement cases using flow-sensitive points-to information.
3485 Only warns when the converted pointer is dereferenced.
3486 Does not warn about incomplete types.
3487
3488 @item -Wstrict-overflow
3489 @itemx -Wstrict-overflow=@var{n}
3490 @opindex Wstrict-overflow
3491 @opindex Wno-strict-overflow
3492 This option is only active when @option{-fstrict-overflow} is active.
3493 It warns about cases where the compiler optimizes based on the
3494 assumption that signed overflow does not occur.  Note that it does not
3495 warn about all cases where the code might overflow: it only warns
3496 about cases where the compiler implements some optimization.  Thus
3497 this warning depends on the optimization level.
3498
3499 An optimization which assumes that signed overflow does not occur is
3500 perfectly safe if the values of the variables involved are such that
3501 overflow never does, in fact, occur.  Therefore this warning can
3502 easily give a false positive: a warning about code which is not
3503 actually a problem.  To help focus on important issues, several
3504 warning levels are defined.  No warnings are issued for the use of
3505 undefined signed overflow when estimating how many iterations a loop
3506 will require, in particular when determining whether a loop will be
3507 executed at all.
3508
3509 @table @gcctabopt
3510 @item -Wstrict-overflow=1
3511 Warn about cases which are both questionable and easy to avoid.  For
3512 example: @code{x + 1 > x}; with @option{-fstrict-overflow}, the
3513 compiler will simplify this to @code{1}.  This level of
3514 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
3515 are not, and must be explicitly requested.
3516
3517 @item -Wstrict-overflow=2
3518 Also warn about other cases where a comparison is simplified to a
3519 constant.  For example: @code{abs (x) >= 0}.  This can only be
3520 simplified when @option{-fstrict-overflow} is in effect, because
3521 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
3522 zero.  @option{-Wstrict-overflow} (with no level) is the same as
3523 @option{-Wstrict-overflow=2}.
3524
3525 @item -Wstrict-overflow=3
3526 Also warn about other cases where a comparison is simplified.  For
3527 example: @code{x + 1 > 1} will be simplified to @code{x > 0}.
3528
3529 @item -Wstrict-overflow=4
3530 Also warn about other simplifications not covered by the above cases.
3531 For example: @code{(x * 10) / 5} will be simplified to @code{x * 2}.
3532
3533 @item -Wstrict-overflow=5
3534 Also warn about cases where the compiler reduces the magnitude of a
3535 constant involved in a comparison.  For example: @code{x + 2 > y} will
3536 be simplified to @code{x + 1 >= y}.  This is reported only at the
3537 highest warning level because this simplification applies to many
3538 comparisons, so this warning level will give a very large number of
3539 false positives.
3540 @end table
3541
3542 @item -Warray-bounds
3543 @opindex Wno-array-bounds
3544 @opindex Warray-bounds
3545 This option is only active when @option{-ftree-vrp} is active
3546 (default for -O2 and above). It warns about subscripts to arrays
3547 that are always out of bounds. This warning is enabled by @option{-Wall}.
3548
3549 @item -Wno-div-by-zero
3550 @opindex Wno-div-by-zero
3551 @opindex Wdiv-by-zero
3552 Do not warn about compile-time integer division by zero.  Floating point
3553 division by zero is not warned about, as it can be a legitimate way of
3554 obtaining infinities and NaNs.
3555
3556 @item -Wsystem-headers
3557 @opindex Wsystem-headers
3558 @opindex Wno-system-headers
3559 @cindex warnings from system headers
3560 @cindex system headers, warnings from
3561 Print warning messages for constructs found in system header files.
3562 Warnings from system headers are normally suppressed, on the assumption
3563 that they usually do not indicate real problems and would only make the
3564 compiler output harder to read.  Using this command line option tells
3565 GCC to emit warnings from system headers as if they occurred in user
3566 code.  However, note that using @option{-Wall} in conjunction with this
3567 option will @emph{not} warn about unknown pragmas in system
3568 headers---for that, @option{-Wunknown-pragmas} must also be used.
3569
3570 @item -Wfloat-equal
3571 @opindex Wfloat-equal
3572 @opindex Wno-float-equal
3573 Warn if floating point values are used in equality comparisons.
3574
3575 The idea behind this is that sometimes it is convenient (for the
3576 programmer) to consider floating-point values as approximations to
3577 infinitely precise real numbers.  If you are doing this, then you need
3578 to compute (by analyzing the code, or in some other way) the maximum or
3579 likely maximum error that the computation introduces, and allow for it
3580 when performing comparisons (and when producing output, but that's a
3581 different problem).  In particular, instead of testing for equality, you
3582 would check to see whether the two values have ranges that overlap; and
3583 this is done with the relational operators, so equality comparisons are
3584 probably mistaken.
3585
3586 @item -Wtraditional @r{(C and Objective-C only)}
3587 @opindex Wtraditional
3588 @opindex Wno-traditional
3589 Warn about certain constructs that behave differently in traditional and
3590 ISO C@.  Also warn about ISO C constructs that have no traditional C
3591 equivalent, and/or problematic constructs which should be avoided.
3592
3593 @itemize @bullet
3594 @item
3595 Macro parameters that appear within string literals in the macro body.
3596 In traditional C macro replacement takes place within string literals,
3597 but does not in ISO C@.
3598
3599 @item
3600 In traditional C, some preprocessor directives did not exist.
3601 Traditional preprocessors would only consider a line to be a directive
3602 if the @samp{#} appeared in column 1 on the line.  Therefore
3603 @option{-Wtraditional} warns about directives that traditional C
3604 understands but would ignore because the @samp{#} does not appear as the
3605 first character on the line.  It also suggests you hide directives like
3606 @samp{#pragma} not understood by traditional C by indenting them.  Some
3607 traditional implementations would not recognize @samp{#elif}, so it
3608 suggests avoiding it altogether.
3609
3610 @item
3611 A function-like macro that appears without arguments.
3612
3613 @item
3614 The unary plus operator.
3615
3616 @item
3617 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3618 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
3619 constants.)  Note, these suffixes appear in macros defined in the system
3620 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3621 Use of these macros in user code might normally lead to spurious
3622 warnings, however GCC's integrated preprocessor has enough context to
3623 avoid warning in these cases.
3624
3625 @item
3626 A function declared external in one block and then used after the end of
3627 the block.
3628
3629 @item
3630 A @code{switch} statement has an operand of type @code{long}.
3631
3632 @item