OSDN Git Service

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