OSDN Git Service

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