OSDN Git Service

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