* invoke.texi: Fix typo.
[official-gcc.git] / gcc / invoke.texi
blob519dd92cea503d051c3d89ddb304d6eb042d8359
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
11 Permission is granted to make and distribute verbatim copies of this
12 manual provided the copyright notice and this permission notice are
13 preserved on all copies.
15 Permission is granted to copy and distribute modified versions of this
16 manual under the conditions for verbatim copying, provided also that the
17 entire resulting derived work is distributed under the terms of a
18 permission notice identical to this one.
20 Permission is granted to copy and distribute translations of this manual
21 into another language, under the above conditions for modified versions,
22 except that this permission notice may be included in translations
23 approved by the Free Software Foundation instead of in the original
24 English.
25 @c man end
26 @c Set file name and title for the man page.
27 @setfilename gcc
28 @settitle GNU project C and C++ compiler
29 @c man begin SYNOPSIS
30 gcc [@samp{-c}|@samp{-S}|@samp{-E}] [@samp{-std=}@var{standard}]
31     [@samp{-g}] [@samp{-pg}] [@samp{-O}@var{level}]
32     [@samp{-W}@var{warn}...] [@samp{-pedantic}]
33     [@samp{-I}@var{dir}...] [@samp{-L}@var{dir}...]
34     [@samp{-D}@var{macro}[=@var{defn}]...] [@samp{-U}@var{macro}]
35     [@samp{-f}@var{option}...] [@samp{-m}@var{machine-option}...]
36     [@samp{-o} @var{outfile}] @var{infile}...
38 Only the most useful options are listed here; see below for the
39 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
40 @c man end
41 @c man begin SEEALSO
42 cpp(1), gcov(1), g77(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
43 and the Info entries for @file{gcc}, @file{cpp}, @file{g77}, @file{as},
44 @file{ld}, @file{binutils} and @file{gdb}.
45 @c man end
46 @c man begin BUGS
47 For instructions on reporting bugs, see
48 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
49 script to report bugs is recommended.
50 @c man end
51 @c man begin AUTHOR
52 See the Info entry for @file{gcc}, or
53 @w{@uref{http://gcc.gnu.org/thanks.html}}, for contributors to GCC.
54 @c man end
55 @end ignore
57 @node Invoking GCC
58 @chapter GCC Command Options
59 @cindex GCC command options
60 @cindex command options
61 @cindex options, GCC command
63 @c man begin DESCRIPTION
65 When you invoke GCC, it normally does preprocessing, compilation,
66 assembly and linking.  The ``overall options'' allow you to stop this
67 process at an intermediate stage.  For example, the @samp{-c} option
68 says not to run the linker.  Then the output consists of object files
69 output by the assembler.
71 Other options are passed on to one stage of processing.  Some options
72 control the preprocessor and others the compiler itself.  Yet other
73 options control the assembler and linker; most of these are not
74 documented here, since you rarely need to use any of them.
76 @cindex C compilation options
77 Most of the command line options that you can use with GCC are useful
78 for C programs; when an option is only useful with another language
79 (usually C++), the explanation says so explicitly.  If the description
80 for a particular option does not mention a source language, you can use
81 that option with all supported languages.
83 @cindex C++ compilation options
84 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
85 options for compiling C++ programs.
87 @cindex grouping options
88 @cindex options, grouping
89 The @command{gcc} program accepts options and file names as operands.  Many
90 options have multi-letter names; therefore multiple single-letter options
91 may @emph{not} be grouped: @samp{-dr} is very different from @w{@samp{-d
92 -r}}.
94 @cindex order of options
95 @cindex options, order
96 You can mix options and other arguments.  For the most part, the order
97 you use doesn't matter.  Order does matter when you use several options
98 of the same kind; for example, if you specify @samp{-L} more than once,
99 the directories are searched in the order specified.
101 Many options have long names starting with @samp{-f} or with
102 @samp{-W}---for example, @samp{-fforce-mem},
103 @samp{-fstrength-reduce}, @samp{-Wformat} and so on.  Most of
104 these have both positive and negative forms; the negative form of
105 @samp{-ffoo} would be @samp{-fno-foo}.  This manual documents
106 only one of these two forms, whichever one is not the default.
108 @c man end
110 @menu
111 * Option Summary::      Brief list of all options, without explanations.
112 * Overall Options::     Controlling the kind of output:
113                         an executable, object files, assembler files,
114                         or preprocessed source.
115 * Invoking G++::        Compiling C++ programs.
116 * C Dialect Options::   Controlling the variant of C language compiled.
117 * C++ Dialect Options:: Variations on C++.
118 * Language Independent Options:: Controlling how diagnostics should be
119                         formatted. 
120 * Warning Options::     How picky should the compiler be?
121 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
122 * Optimize Options::    How much optimization?
123 * Preprocessor Options:: Controlling header files and macro definitions.
124                          Also, getting dependency information for Make.
125 * Assembler Options::   Passing options to the assembler.
126 * Link Options::        Specifying libraries and so on.
127 * Directory Options::   Where to find header files and libraries.
128                         Where to find the compiler executable files.
129 * Spec Files::          How to pass switches to sub-processes.
130 * Target Options::      Running a cross-compiler, or an old version of GCC.
131 * Submodel Options::    Specifying minor hardware or convention variations,
132                         such as 68010 vs 68020.
133 * Code Gen Options::    Specifying conventions for function calls, data layout
134                         and register usage.
135 * Environment Variables:: Env vars that affect GCC.
136 * Running Protoize::    Automatically adding or removing function prototypes.
137 @end menu
139 @c man begin OPTIONS
141 @node Option Summary
142 @section Option Summary
144 Here is a summary of all the options, grouped by type.  Explanations are
145 in the following sections.
147 @table @emph
148 @item Overall Options
149 @xref{Overall Options,,Options Controlling the Kind of Output}.
150 @gccoptlist{
151 -c  -S  -E  -o @var{file}  -pipe  -pass-exit-codes  -x @var{language} @gol
152 -v  --target-help  --help}
154 @item C Language Options
155 @xref{C Dialect Options,,Options Controlling C Dialect}.
156 @gccoptlist{
157 -ansi  -std=@var{standard}  -fno-asm  -fno-builtin @gol
158 -fhosted  -ffreestanding @gol
159 -trigraphs  -traditional  -traditional-cpp @gol
160 -fallow-single-precision  -fcond-mismatch @gol
161 -fsigned-bitfields  -fsigned-char @gol
162 -funsigned-bitfields  -funsigned-char @gol
163 -fwritable-strings  -fshort-wchar}
165 @item C++ Language Options
166 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
167 @gccoptlist{
168 -fno-access-control  -fcheck-new  -fconserve-space @gol
169 -fdollars-in-identifiers  -fno-elide-constructors @gol
170 -fno-enforce-eh-specs  -fexternal-templates @gol
171 -falt-external-templates @gol
172 -ffor-scope  -fno-for-scope  -fno-gnu-keywords  -fhonor-std @gol
173 -fhuge-objects  -fno-implicit-templates @gol
174 -fno-implicit-inline-templates @gol
175 -fno-implement-inlines  -fms-extensions @gol
176 -fno-operator-names @gol
177 -fno-optional-diags  -fpermissive @gol
178 -frepo  -fno-rtti -ftemplate-depth-@var{n} @gol
179 -fuse-cxa-atexit  -fvtable-thunks  -nostdinc++ @gol
180 -fno-default-inline  -Wctor-dtor-privacy @gol
181 -Wnon-virtual-dtor  -Wreorder @gol
182 -Weffc++  -Wno-deprecated @gol
183 -Wno-non-template-friend  -Wold-style-cast @gol
184 -Woverloaded-virtual  -Wno-pmf-conversions @gol
185 -Wsign-promo  -Wsynth}
187 @item Language Independent Options
188 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
189 @gccoptlist{
190 -fmessage-length=@var{n}  @gol
191 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
193 @item Warning Options
194 @xref{Warning Options,,Options to Request or Suppress Warnings}.
195 @gccoptlist{
196 -fsyntax-only  -pedantic  -pedantic-errors @gol
197 -w  -W  -Wall  -Waggregate-return @gol
198 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
199 -Wconversion  -Wdisabled-optimization -Werror @gol
200 -Wfloat-equal  -Wformat  -Wformat=2 @gol
201 -Wformat-nonliteral -Wformat-security @gol
202 -Wid-clash-@var{len}  -Wimplicit -Wimplicit-int  @gol
203 -Wimplicit-function-declaration @gol
204 -Werror-implicit-function-declaration @gol
205 -Wimport  -Winline @gol
206 -Wlarger-than-@var{len}  -Wlong-long @gol
207 -Wmain  -Wmissing-declarations @gol
208 -Wmissing-format-attribute  -Wmissing-noreturn @gol
209 -Wmultichar  -Wno-format-extra-args -Wno-format-y2k @gol
210 -Wno-import  -Wpacked  -Wpadded @gol
211 -Wparentheses -Wpointer-arith  -Wredundant-decls @gol
212 -Wreturn-type  -Wsequence-point  -Wshadow @gol
213 -Wsign-compare  -Wswitch  -Wsystem-headers @gol
214 -Wtrigraphs  -Wundef  -Wuninitialized @gol
215 -Wunknown-pragmas  -Wunreachable-code @gol
216 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
217 -Wunused-value  -Wunused-variable  -Wwrite-strings}
219 @item C-only Warning Options
220 @gccoptlist{
221 -Wbad-function-cast -Wmissing-prototypes -Wnested-externs @gol
222 -Wstrict-prototypes -Wtraditional}
224 @item Debugging Options
225 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
226 @gccoptlist{
227 -a  -ax  -d@var{letters}  -fdump-unnumbered -fdump-translation-unit=@var{file} @gol
228 -fdump-class-layout=@var{file} -fpretend-float -fprofile-arcs  -ftest-coverage @gol
229 -g  -g@var{level}  -gcoff  -gdwarf  -gdwarf-1  -gdwarf-1+  -gdwarf-2 @gol
230 -ggdb  -gstabs  -gstabs+  -gxcoff  -gxcoff+ @gol
231 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
232 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
233 -save-temps  -time}
235 @item Optimization Options
236 @xref{Optimize Options,,Options that Control Optimization}.
237 @gccoptlist{
238 -falign-functions=@var{n}  -falign-jumps=@var{n} @gol
239 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
240 -fbranch-probabilities  -fcaller-saves @gol
241 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections  -fdce @gol
242 -fdelayed-branch  -fdelete-null-pointer-checks @gol
243 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
244 -fforce-addr  -fforce-mem  -ffunction-sections  -fgcse  @gol
245 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
246 -fkeep-static-consts  -fmove-all-movables @gol
247 -fno-default-inline  -fno-defer-pop @gol
248 -fno-function-cse   -fno-guess-branch-probability @gol
249 -fno-inline  -fno-math-errno  -fno-peephole @gol
250 -funsafe-math-optimizations -fno-trapping-math @gol
251 -fomit-frame-pointer  -foptimize-register-move @gol
252 -foptimize-sibling-calls  -freduce-all-givs @gol
253 -fregmove  -frename-registers @gol
254 -frerun-cse-after-loop  -frerun-loop-opt @gol
255 -fschedule-insns  -fschedule-insns2 @gol
256 -fsingle-precision-constant  -fssa @gol
257 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -ftrapv @gol
258 -funroll-all-loops  -funroll-loops  @gol
259 --param @var{name}=@var{value}
260 -O  -O0  -O1  -O2  -O3  -Os}
262 @item Preprocessor Options
263 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
264 @gccoptlist{
265 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
266 -C  -dD  -dI  -dM  -dN @gol
267 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
268 -idirafter @var{dir} @gol
269 -include @var{file}  -imacros @var{file} @gol
270 -iprefix @var{file}  -iwithprefix @var{dir} @gol
271 -iwithprefixbefore @var{dir}  -isystem @var{dir} -isystem-c++ @var{dir} @gol
272 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
273 -trigraphs  -undef  -U@var{macro}  -Wp\,@var{option}}
275 @item Assembler Option
276 @xref{Assembler Options,,Passing Options to the Assembler}.
277 @gccoptlist{
278 -Wa\,@var{option}}
280 @item Linker Options
281 @xref{Link Options,,Options for Linking}.
282 @gccoptlist{
283 @var{object-file-name}  -l@var{library} @gol
284 -nostartfiles  -nodefaultlibs  -nostdlib @gol
285 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
286 -Wl\,@var{option}  -Xlinker @var{option} @gol
287 -u @var{symbol}}
289 @item Directory Options
290 @xref{Directory Options,,Options for Directory Search}.
291 @gccoptlist{
292 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
294 @item Target Options
295 @c I wrote this xref this way to avoid overfull hbox. -- rms
296 @xref{Target Options}.
297 @gccoptlist{
298 -b @var{machine}  -V @var{version}}
300 @item Machine Dependent Options
301 @xref{Submodel Options,,Hardware Models and Configurations}.
302 @emph{M680x0 Options}
303 @gccoptlist{
304 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
305 -m68060  -mcpu32 -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
306 -mfpa -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
307 -malign-int -mstrict-align}
309 @emph{M68hc1x Options}
310 @gccoptlist{
311 -m6811  -m6812  -m68hc11  -m68hc12 @gol
312 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}}
314 @emph{VAX Options}
315 @gccoptlist{
316 -mg  -mgnu  -munix}
318 @emph{SPARC Options}
319 @gccoptlist{
320 -mcpu=@var{cpu type} @gol
321 -mtune=@var{cpu type} @gol
322 -mcmodel=@var{code model} @gol
323 -m32  -m64 @gol
324 -mapp-regs  -mbroken-saverestore  -mcypress @gol
325 -mepilogue -mfaster-structs -mflat @gol
326 -mfpu  -mhard-float  -mhard-quad-float @gol
327 -mimpure-text  -mlive-g0  -mno-app-regs @gol
328 -mno-epilogue -mno-faster-structs -mno-flat  -mno-fpu @gol
329 -mno-impure-text -mno-stack-bias  -mno-unaligned-doubles @gol
330 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
331 -msupersparc  -munaligned-doubles  -mv8}
333 @emph{Convex Options}
334 @gccoptlist{
335 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
336 -margcount  -mnoargcount @gol
337 -mlong32  -mlong64 @gol
338 -mvolatile-cache  -mvolatile-nocache}
340 @emph{AMD29K Options}
341 @gccoptlist{
342 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
343 -mlarge  -mnormal  -msmall @gol
344 -mkernel-registers  -mno-reuse-arg-regs @gol
345 -mno-stack-check  -mno-storem-bug @gol
346 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
347 -mstorem-bug  -muser-registers}
349 @emph{ARM Options}
350 @gccoptlist{
351 -mapcs-frame -mno-apcs-frame @gol
352 -mapcs-26 -mapcs-32 @gol
353 -mapcs-stack-check -mno-apcs-stack-check @gol
354 -mapcs-float -mno-apcs-float @gol
355 -mapcs-reentrant -mno-apcs-reentrant @gol
356 -msched-prolog -mno-sched-prolog @gol
357 -mlittle-endian -mbig-endian -mwords-little-endian @gol
358 -malignment-traps -mno-alignment-traps @gol
359 -msoft-float -mhard-float -mfpe @gol
360 -mthumb-interwork -mno-thumb-interwork @gol
361 -mcpu= -march= -mfpe=  @gol
362 -mstructure-size-boundary= @gol
363 -mbsd -mxopen -mno-symrename @gol
364 -mabort-on-noreturn @gol
365 -mlong-calls -mno-long-calls @gol
366 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
367 -msingle-pic-base -mno-single-pic-base @gol
368 -mpic-register=}
370 @emph{Thumb Options}
371 @gccoptlist{
372 -mtpcs-frame -mno-tpcs-frame @gol
373 -mtpcs-leaf-frame -mno-tpcs-leaf-frame @gol
374 -mlittle-endian  -mbig-endian @gol
375 -mthumb-interwork -mno-thumb-interwork @gol
376 -mstructure-size-boundary= @gol
377 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
378 -mcallee-super-interworking -mno-callee-super-interworking @gol
379 -mcaller-super-interworking -mno-caller-super-interworking @gol
380 -msingle-pic-base -mno-single-pic-base @gol
381 -mpic-register=}
383 @emph{MN10200 Options}
384 @gccoptlist{
385 -mrelax}
387 @emph{MN10300 Options}
388 @gccoptlist{
389 -mmult-bug @gol
390 -mno-mult-bug @gol
391 -mam33 @gol
392 -mno-am33 @gol
393 -mrelax}
395 @emph{M32R/D Options}
396 @gccoptlist{
397 -mcode-model=@var{model type}  -msdata=@var{sdata type} @gol
398 -G @var{num}}
400 @emph{M88K Options}
401 @gccoptlist{
402 -m88000  -m88100  -m88110  -mbig-pic @gol
403 -mcheck-zero-division  -mhandle-large-shift @gol
404 -midentify-revision  -mno-check-zero-division @gol
405 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
406 -mno-optimize-arg-area  -mno-serialize-volatile @gol
407 -mno-underscores  -mocs-debug-info @gol
408 -mocs-frame-position  -moptimize-arg-area @gol
409 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
410 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
411 -mversion-03.00  -mwarn-passed-structs}
413 @emph{RS/6000 and PowerPC Options}
414 @gccoptlist{
415 -mcpu=@var{cpu type} @gol
416 -mtune=@var{cpu type} @gol
417 -mpower  -mno-power  -mpower2  -mno-power2 @gol
418 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
419 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
420 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
421 -mnew-mnemonics  -mold-mnemonics @gol
422 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc @gol
423 -m64  -m32  -mxl-call  -mno-xl-call  -mthreads  -mpe @gol
424 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
425 -mstring  -mno-string  -mupdate  -mno-update @gol
426 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
427 -mstrict-align  -mno-strict-align  -mrelocatable @gol
428 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
429 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
430 -mcall-aix  -mcall-sysv  -mprototype  -mno-prototype @gol
431 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
432 -msdata=@var{opt}  -mvxworks -G @var{num}}
434 @emph{RT Options}
435 @gccoptlist{
436 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
437 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
438 -mminimum-fp-blocks  -mnohc-struct-return}
440 @emph{MIPS Options}
441 @gccoptlist{
442 -mabicalls  -mcpu=@var{cpu type}
443 -membedded-data  -muninit-const-in-rodata @gol
444 -membedded-pic  -mfp32  -mfp64  -mgas  -mgp32  -mgp64 @gol
445 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
446 -mips2  -mips3 -mips4 -mlong64  -mlong32 -mlong-calls  -mmemcpy @gol
447 -mmips-as  -mmips-tfile  -mno-abicalls @gol
448 -mno-embedded-data  -mno-uninit-const-in-rodata  -mno-embedded-pic @gol
449 -mno-gpopt  -mno-long-calls @gol
450 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
451 -mrnames  -msoft-float @gol
452 -m4650  -msingle-float  -mmad @gol
453 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
454 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
455 -mfix7000 -mno-crt0}
457 @emph{i386 Options}
458 @gccoptlist{
459 -mcpu=@var{cpu type} -march=@var{cpu type} @gol
460 -mintel-syntax -mieee-fp  -mno-fancy-math-387 @gol
461 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
462 -mno-wide-multiply  -mrtd  -malign-double @gol
463 -malign-jumps=@var{num}  -malign-loops=@var{num} @gol
464 -malign-functions=@var{num} -mpreferred-stack-boundary=@var{num} @gol
465 -mthreads -mno-align-stringops -minline-all-stringops @gol
466 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
467 -m96bit-long-double -mregparm=@var{num}}
469 @emph{HPPA Options}
470 @gccoptlist{
471 -march=@var{architecture type} @gol
472 -mbig-switch  -mdisable-fpregs  -mdisable-indexing   @gol
473 -mfast-indirect-calls -mgas  -mjump-in-delay   @gol
474 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
475 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
476 -mno-jump-in-delay  -mno-long-load-store   @gol
477 -mno-portable-runtime  -mno-soft-float @gol
478 -mno-space-regs  -msoft-float  -mpa-risc-1-0   @gol
479 -mpa-risc-1-1  -mpa-risc-2-0 -mportable-runtime @gol
480 -mschedule=@var{cpu type}  -mspace-regs}
482 @emph{Intel 960 Options}
483 @gccoptlist{
484 -m@var{cpu type}  -masm-compat  -mclean-linkage @gol
485 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
486 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
487 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
488 -mno-complex-addr  -mno-leaf-procedures @gol
489 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
490 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
491 -mtail-call}
493 @emph{DEC Alpha Options}
494 @gccoptlist{
495 -mfp-regs  -mno-fp-regs -mno-soft-float  -msoft-float @gol
496 -malpha-as -mgas @gol
497 -mieee  -mieee-with-inexact  -mieee-conformant @gol
498 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
499 -mtrap-precision=@var{mode}  -mbuild-constants @gol
500 -mcpu=@var{cpu type} @gol
501 -mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max @gol
502 -mmemory-latency=@var{time}}
504 @emph{Clipper Options}
505 @gccoptlist{
506 -mc300  -mc400}
508 @emph{H8/300 Options}
509 @gccoptlist{
510 -mrelax  -mh -ms -mint32  -malign-300}
512 @emph{SH Options}
513 @gccoptlist{
514 -m1  -m2  -m3  -m3e @gol
515 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
516 -mb  -ml  -mdalign  -mrelax @gol
517 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
518 -misize  -mpadstruct  -mspace @gol
519 -mprefergot
520 -musermode}
522 @emph{System V Options}
523 @gccoptlist{
524 -Qy  -Qn  -YP\,@var{paths}  -Ym\,@var{dir}}
526 @emph{ARC Options}
527 @gccoptlist{
528 -EB  -EL @gol
529 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text section} @gol
530 -mdata=@var{data section}  -mrodata=@var{readonly data section}}
532 @emph{TMS320C3x/C4x Options}
533 @gccoptlist{
534 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
535 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
536 -mrpts=@var{count}  -mrptb -mdb -mloop-unsigned @gol
537 -mparallel-insns -mparallel-mpy -mpreserve-float}
539 @emph{V850 Options}
540 @gccoptlist{
541 -mlong-calls -mno-long-calls -mep -mno-ep @gol
542 -mprolog-function -mno-prolog-function -mspace @gol
543 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
544 -mv850 -mbig-switch}
546 @emph{NS32K Options}
547 @gccoptlist{
548 -m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add @gol
549 -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb @gol
550 -mbitfield -mnobitfield -mhimem -mnohimem}
552 @emph{AVR Options}
553 @gccoptlist{
554 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
555 -mcall-prologues -mno-tablejump -mtiny-stack}
557 @emph{MCore Options}
558 @gccoptlist{
559 -mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates  @gol
560 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
561 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
562 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
563 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
565 @emph{IA-64 Options}
566 @gccoptlist{
567 -mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
568 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
569 -mconstant-gp -mauto-pic -minline-divide-min-latency @gol
570 -minline-divide-max-throughput -mno-dwarf2-asm @gol
571 -mfixed-range=@var{register range}}
573 @item Code Generation Options
574 @xref{Code Gen Options,,Options for Code Generation Conventions}.
575 @gccoptlist{
576 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
577 -fexceptions  -funwind-tables  -ffixed-@var{reg} @gol
578 -finhibit-size-directive  -finstrument-functions @gol
579 -fcheck-memory-usage  -fprefix-function-name @gol
580 -fno-common  -fno-ident  -fno-gnu-linker @gol
581 -fpcc-struct-return  -fpic  -fPIC @gol
582 -freg-struct-return  -fshared-data  -fshort-enums @gol
583 -fshort-double  -fvolatile  -fvolatile-global -fvolatile-static @gol
584 -fverbose-asm  -fpack-struct  -fstack-check @gol
585 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
586 -fargument-alias  -fargument-noalias @gol
587 -fargument-noalias-global @gol
588 -fleading-underscore}
589 @end table
591 @menu
592 * Overall Options::     Controlling the kind of output:
593                         an executable, object files, assembler files,
594                         or preprocessed source.
595 * C Dialect Options::   Controlling the variant of C language compiled.
596 * C++ Dialect Options:: Variations on C++.
597 * Language Independent Options:: Controlling how diagnostics should be
598                         formatted. 
599 * Warning Options::     How picky should the compiler be?
600 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
601 * Optimize Options::    How much optimization?
602 * Preprocessor Options:: Controlling header files and macro definitions.
603                          Also, getting dependency information for Make.
604 * Assembler Options::   Passing options to the assembler.
605 * Link Options::        Specifying libraries and so on.
606 * Directory Options::   Where to find header files and libraries.
607                         Where to find the compiler executable files.
608 * Spec Files::          How to pass switches to sub-processes.
609 * Target Options::      Running a cross-compiler, or an old version of GCC.
610 @end menu
612 @node Overall Options
613 @section Options Controlling the Kind of Output
615 Compilation can involve up to four stages: preprocessing, compilation
616 proper, assembly and linking, always in that order.  The first three
617 stages apply to an individual source file, and end by producing an
618 object file; linking combines all the object files (those newly
619 compiled, and those specified as input) into an executable file.
621 @cindex file name suffix
622 For any given input file, the file name suffix determines what kind of
623 compilation is done:
625 @table @gcctabopt
626 @item @var{file}.c
627 C source code which must be preprocessed.
629 @item @var{file}.i
630 C source code which should not be preprocessed.
632 @item @var{file}.ii
633 C++ source code which should not be preprocessed.
635 @item @var{file}.m
636 Objective-C source code.  Note that you must link with the library
637 @file{libobjc.a} to make an Objective-C program work.
639 @item @var{file}.mi
640 Objective-C source code which should not be preprocessed.
642 @item @var{file}.h
643 C header file (not to be compiled or linked).
645 @item @var{file}.cc
646 @itemx @var{file}.cp
647 @itemx @var{file}.cxx
648 @itemx @var{file}.cpp
649 @itemx @var{file}.c++
650 @itemx @var{file}.C
651 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
652 the last two letters must both be literally @samp{x}.  Likewise,
653 @samp{.C} refers to a literal capital C.
655 @item @var{file}.f
656 @itemx @var{file}.for
657 @itemx @var{file}.FOR
658 Fortran source code which should not be preprocessed.
660 @item @var{file}.F
661 @itemx @var{file}.fpp
662 @itemx @var{file}.FPP
663 Fortran source code which must be preprocessed (with the traditional
664 preprocessor).
666 @item @var{file}.r
667 Fortran source code which must be preprocessed with a RATFOR
668 preprocessor (not included with GCC).
670 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
671 Using and Porting GNU Fortran}, for more details of the handling of
672 Fortran input files.
674 @c FIXME: Descriptions of Java file types.
675 @c @var{file}.java
676 @c @var{file}.class
677 @c @var{file}.zip
678 @c @var{file}.jar
680 @c GCC also knows about some suffixes for languages not yet included:
681 @c Ada:
682 @c @var{file}.ads
683 @c @var{file}.adb
684 @c @var{file}.ada
685 @c Pascal:
686 @c @var{file}.p
687 @c @var{file}.pas
689 @item @var{file}.ch
690 @itemx @var{file}.chi
691 CHILL source code (preprocessed with the traditional preprocessor).
693 @item @var{file}.s
694 Assembler code.
696 @item @var{file}.S
697 Assembler code which must be preprocessed.
699 @item @var{other}
700 An object file to be fed straight into linking.
701 Any file name with no recognized suffix is treated this way.
702 @end table
704 You can specify the input language explicitly with the @samp{-x} option:
706 @table @gcctabopt
707 @item -x @var{language}
708 Specify explicitly the @var{language} for the following input files
709 (rather than letting the compiler choose a default based on the file
710 name suffix).  This option applies to all following input files until
711 the next @samp{-x} option.  Possible values for @var{language} are:
712 @example
713 c  c-header  cpp-output
714 c++  c++-cpp-output
715 objective-c  objc-cpp-output
716 assembler  assembler-with-cpp
717 f77  f77-cpp-input  ratfor
718 java  chill
719 @end example
720 @c Also f77-version, for internal use only.
722 @item -x none
723 Turn off any specification of a language, so that subsequent files are
724 handled according to their file name suffixes (as they are if @samp{-x}
725 has not been used at all).
727 @item -pass-exit-codes
728 Normally the @command{gcc} program will exit with the code of 1 if any
729 phase of the compiler returns a non-success return code.  If you specify
730 @samp{-pass-exit-codes}, the @command{gcc} program will instead return with
731 numerically highest error produced by any phase that returned an error
732 indication.
733 @end table
735 If you only want some of the stages of compilation, you can use
736 @samp{-x} (or filename suffixes) to tell @command{gcc} where to start, and
737 one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
738 @command{gcc} is to stop.  Note that some combinations (for example,
739 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
741 @table @gcctabopt
742 @item -c
743 Compile or assemble the source files, but do not link.  The linking
744 stage simply is not done.  The ultimate output is in the form of an
745 object file for each source file.
747 By default, the object file name for a source file is made by replacing
748 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
750 Unrecognized input files, not requiring compilation or assembly, are
751 ignored.
753 @item -S
754 Stop after the stage of compilation proper; do not assemble.  The output
755 is in the form of an assembler code file for each non-assembler input
756 file specified.
758 By default, the assembler file name for a source file is made by
759 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
761 Input files that don't require compilation are ignored.
763 @item -E
764 Stop after the preprocessing stage; do not run the compiler proper.  The
765 output is in the form of preprocessed source code, which is sent to the
766 standard output.
768 Input files which don't require preprocessing are ignored.
770 @cindex output file option
771 @item -o @var{file}
772 Place output in file @var{file}.  This applies regardless to whatever
773 sort of output is being produced, whether it be an executable file,
774 an object file, an assembler file or preprocessed C code.
776 Since only one output file can be specified, it does not make sense to
777 use @samp{-o} when compiling more than one input file, unless you are
778 producing an executable file as output.
780 If @samp{-o} is not specified, the default is to put an executable file
781 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
782 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
783 all preprocessed C source on standard output.@refill
785 @item -v
786 Print (on standard error output) the commands executed to run the stages
787 of compilation.  Also print the version number of the compiler driver
788 program and of the preprocessor and the compiler proper.
790 @item -pipe
791 Use pipes rather than temporary files for communication between the
792 various stages of compilation.  This fails to work on some systems where
793 the assembler is unable to read from a pipe; but the GNU assembler has
794 no trouble.
796 @item --help
797 Print (on the standard output) a description of the command line options
798 understood by @command{gcc}.  If the @option{-v} option is also specified
799 then @option{--help} will also be passed on to the various processes
800 invoked by @command{gcc}, so that they can display the command line options
801 they accept.  If the @option{-W} option is also specified then command
802 line options which have no documentation associated with them will also
803 be displayed.
805 @item --target-help
806 Print (on the standard output) a description of target specific command
807 line options for each tool.
808 @end table
810 @node Invoking G++
811 @section Compiling C++ Programs
813 @cindex suffixes for C++ source
814 @cindex C++ source file suffixes
815 C++ source files conventionally use one of the suffixes @samp{.C},
816 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
817 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
818 files with these names and compiles them as C++ programs even if you
819 call the compiler the same way as for compiling C programs (usually with
820 the name @command{gcc}).
822 @findex g++
823 @findex c++
824 However, C++ programs often require class libraries as well as a
825 compiler that understands the C++ language---and under some
826 circumstances, you might want to compile programs from standard input,
827 or otherwise without a suffix that flags them as C++ programs.
828 @command{g++} is a program that calls GCC with the default language
829 set to C++, and automatically specifies linking against the C++
830 library.  On many systems, @command{g++} is also
831 installed with the name @command{c++}.
833 @cindex invoking @command{g++}
834 When you compile C++ programs, you may specify many of the same
835 command-line options that you use for compiling programs in any
836 language; or command-line options meaningful for C and related
837 languages; or options that are meaningful only for C++ programs.
838 @xref{C Dialect Options,,Options Controlling C Dialect}, for
839 explanations of options for languages related to C.
840 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
841 explanations of options that are meaningful only for C++ programs.
843 @node C Dialect Options
844 @section Options Controlling C Dialect
845 @cindex dialect options
846 @cindex language dialect options
847 @cindex options, dialect
849 The following options control the dialect of C (or languages derived
850 from C, such as C++ and Objective C) that the compiler accepts:
852 @table @gcctabopt
853 @cindex ANSI support
854 @cindex ISO support
855 @item -ansi
856 In C mode, support all ISO C89 programs.  In C++ mode,
857 remove GNU extensions that conflict with ISO C++.
859 This turns off certain features of GCC that are incompatible with ISO
860 C (when compiling C code), or of standard C++ (when compiling C++ code),
861 such as the @code{asm} and @code{typeof} keywords, and
862 predefined macros such as @code{unix} and @code{vax} that identify the
863 type of system you are using.  It also enables the undesirable and
864 rarely used ISO trigraph feature.  For the C compiler, 
865 it disables recognition of C++ style @samp{//} comments as well as
866 the @code{inline} keyword.
868 The alternate keywords @code{__asm__}, @code{__extension__},
869 @code{__inline__} and @code{__typeof__} continue to work despite
870 @samp{-ansi}.  You would not want to use them in an ISO C program, of
871 course, but it is useful to put them in header files that might be included
872 in compilations done with @samp{-ansi}.  Alternate predefined macros
873 such as @code{__unix__} and @code{__vax__} are also available, with or
874 without @samp{-ansi}.
876 The @samp{-ansi} option does not cause non-ISO programs to be
877 rejected gratuitously.  For that, @samp{-pedantic} is required in
878 addition to @samp{-ansi}.  @xref{Warning Options}.
880 The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
881 option is used.  Some header files may notice this macro and refrain
882 from declaring certain functions or defining certain macros that the
883 ISO standard doesn't call for; this is to avoid interfering with any
884 programs that might use these names for other things.
886 Functions which would normally be builtin but do not have semantics
887 defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
888 functions with @samp{-ansi} is used.  @xref{Other Builtins,,Other
889 built-in functions provided by GNU CC}, for details of the functions
890 affected.
892 @item -std=
893 Determine the language standard.  A value for this option must be provided;
894 possible values are 
896 @table @samp
897 @item iso9899:1990
898 Same as @option{-ansi}
900 @item iso9899:199409
901 ISO C as modified in amend. 1
903 @item iso9899:1999
904 ISO C99.  Note that this standard is not yet fully supported; see
905 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.
907 @item c89
908 same as @option{-std=iso9899:1990}
910 @item c99
911 same as @option{-std=iso9899:1999}
913 @item gnu89
914 default, iso9899:1990 + gnu extensions
916 @item gnu99
917 iso9899:1999 + gnu extensions
919 @item iso9899:199x
920 same as @option{-std=iso9899:1999}, deprecated
922 @item c9x
923 same as @option{-std=iso9899:1999}, deprecated
925 @item gnu9x
926 same as @option{-std=gnu99}, deprecated
928 @end table
930 Even when this option is not specified, you can still use some of the
931 features of newer standards in so far as they do not conflict with
932 previous C standards.  For example, you may use @code{__restrict__} even
933 when @option{-std=c99} is not specified.
935 The @option{-std} options specifying some version of ISO C have the same
936 effects as @option{-ansi}, except that features that were not in ISO C89
937 but are in the specified version (for example, @samp{//} comments and
938 the @code{inline} keyword in ISO C99) are not disabled.
940 @xref{Standards,,Language Standards Supported by GCC}, for details of
941 these standard versions.
943 @item -fno-asm
944 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
945 keyword, so that code can use these words as identifiers.  You can use
946 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
947 instead.  @samp{-ansi} implies @samp{-fno-asm}.
949 In C++, this switch only affects the @code{typeof} keyword, since
950 @code{asm} and @code{inline} are standard keywords.  You may want to
951 use the @samp{-fno-gnu-keywords} flag instead, which has the same
952 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
953 switch only affects the @code{asm} and @code{typeof} keywords, since
954 @code{inline} is a standard keyword in ISO C99.
956 @item -fno-builtin
957 @cindex builtin functions
958 Don't recognize builtin functions that do not begin with
959 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
960 functions provided by GNU CC}, for details of the functions affected,
961 including those which are not builtin functions when @option{-ansi} or
962 @option{-std} options for strict ISO C conformance are used because they
963 do not have an ISO standard meaning.
965 GCC normally generates special code to handle certain builtin functions
966 more efficiently; for instance, calls to @code{alloca} may become single
967 instructions that adjust the stack directly, and calls to @code{memcpy}
968 may become inline copy loops.  The resulting code is often both smaller
969 and faster, but since the function calls no longer appear as such, you
970 cannot set a breakpoint on those calls, nor can you change the behavior
971 of the functions by linking with a different library.
973 @item -fhosted
974 @cindex hosted environment
976 Assert that compilation takes place in a hosted environment.  This implies
977 @samp{-fbuiltin}.  A hosted environment is one in which the
978 entire standard library is available, and in which @code{main} has a return
979 type of @code{int}.  Examples are nearly everything except a kernel.
980 This is equivalent to @samp{-fno-freestanding}.
982 @item -ffreestanding
983 @cindex hosted environment
985 Assert that compilation takes place in a freestanding environment.  This
986 implies @samp{-fno-builtin}.  A freestanding environment
987 is one in which the standard library may not exist, and program startup may
988 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
989 This is equivalent to @samp{-fno-hosted}.
991 @xref{Standards,,Language Standards Supported by GCC}, for details of
992 freestanding and hosted environments.
994 @item -trigraphs
995 Support ISO C trigraphs.  You don't want to know about this
996 brain-damage.  The @option{-ansi} option (and @option{-std} options for
997 strict ISO C conformance) implies @option{-trigraphs}.
999 @cindex traditional C language
1000 @cindex C language, traditional
1001 @item -traditional
1002 Attempt to support some aspects of traditional C compilers.
1003 Specifically:
1005 @itemize @bullet
1006 @item
1007 All @code{extern} declarations take effect globally even if they
1008 are written inside of a function definition.  This includes implicit
1009 declarations of functions.
1011 @item
1012 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1013 and @code{volatile} are not recognized.  (You can still use the
1014 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1015 so on.)
1017 @item
1018 Comparisons between pointers and integers are always allowed.
1020 @item
1021 Integer types @code{unsigned short} and @code{unsigned char} promote
1022 to @code{unsigned int}.
1024 @item
1025 Out-of-range floating point literals are not an error.
1027 @item
1028 Certain constructs which ISO regards as a single invalid preprocessing
1029 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1031 @item
1032 String ``constants'' are not necessarily constant; they are stored in
1033 writable space, and identical looking constants are allocated
1034 separately.  (This is the same as the effect of
1035 @samp{-fwritable-strings}.)
1037 @cindex @code{longjmp} and automatic variables
1038 @item
1039 All automatic variables not declared @code{register} are preserved by
1040 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1041 not declared @code{volatile} may be clobbered.
1043 @item
1044 @kindex \x
1045 @kindex \a
1046 @cindex escape sequences, traditional
1047 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1048 literal characters @samp{x} and @samp{a} respectively.  Without
1049 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1050 representation of a character, and @samp{\a} produces a bell.
1051 @end itemize
1053 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1054 if your program uses names that are normally GNU C builtin functions for
1055 other purposes of its own.
1057 You cannot use @samp{-traditional} if you include any header files that
1058 rely on ISO C features.  Some vendors are starting to ship systems with
1059 ISO C header files and you cannot use @samp{-traditional} on such
1060 systems to compile files that include any system headers.
1062 The @samp{-traditional} option also enables @samp{-traditional-cpp},
1063 which is described next.
1065 @item -traditional-cpp
1066 Attempt to support some aspects of traditional C preprocessors.
1067 Specifically:
1069 @itemize @bullet
1070 @item
1071 Comments convert to nothing at all, rather than to a space.  This allows
1072 traditional token concatenation.
1074 @item
1075 In a preprocessing directive, the @samp{#} symbol must appear as the first
1076 character of a line.
1078 @item
1079 Macro arguments are recognized within string constants in a macro
1080 definition (and their values are stringified, though without additional
1081 quote marks, when they appear in such a context).  The preprocessor
1082 always considers a string constant to end at a newline.
1084 @item
1085 @cindex detecting @w{@samp{-traditional}}
1086 The predefined macro @code{__STDC__} is not defined when you use
1087 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
1088 which @code{__GNUC__} indicates are not affected by
1089 @samp{-traditional}).  If you need to write header files that work
1090 differently depending on whether @samp{-traditional} is in use, by
1091 testing both of these predefined macros you can distinguish four
1092 situations: GNU C, traditional GNU C, other ISO C compilers, and other
1093 old C compilers.  The predefined macro @code{__STDC_VERSION__} is also
1094 not defined when you use @samp{-traditional}.  @xref{Standard
1095 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
1096 for more discussion of these and other predefined macros.
1098 @item
1099 @cindex string constants vs newline
1100 @cindex newline vs string constants
1101 The preprocessor considers a string constant to end at a newline (unless
1102 the newline is escaped with @samp{\}).  (Without @w{@samp{-traditional}},
1103 string constants can contain the newline character as typed.)
1104 @end itemize
1106 @item -fcond-mismatch
1107 Allow conditional expressions with mismatched types in the second and
1108 third arguments.  The value of such an expression is void.  This option
1109 is not supported for C++.
1111 @item -funsigned-char
1112 Let the type @code{char} be unsigned, like @code{unsigned char}.
1114 Each kind of machine has a default for what @code{char} should
1115 be.  It is either like @code{unsigned char} by default or like
1116 @code{signed char} by default.
1118 Ideally, a portable program should always use @code{signed char} or
1119 @code{unsigned char} when it depends on the signedness of an object.
1120 But many programs have been written to use plain @code{char} and
1121 expect it to be signed, or expect it to be unsigned, depending on the
1122 machines they were written for.  This option, and its inverse, let you
1123 make such a program work with the opposite default.
1125 The type @code{char} is always a distinct type from each of
1126 @code{signed char} or @code{unsigned char}, even though its behavior
1127 is always just like one of those two.
1129 @item -fsigned-char
1130 Let the type @code{char} be signed, like @code{signed char}.
1132 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
1133 the negative form of @samp{-funsigned-char}.  Likewise, the option
1134 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
1136 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1137 if your program uses names that are normally GNU C builtin functions for
1138 other purposes of its own.
1140 You cannot use @samp{-traditional} if you include any header files that
1141 rely on ISO C features.  Some vendors are starting to ship systems with
1142 ISO C header files and you cannot use @samp{-traditional} on such
1143 systems to compile files that include any system headers.
1145 @item -fsigned-bitfields
1146 @itemx -funsigned-bitfields
1147 @itemx -fno-signed-bitfields
1148 @itemx -fno-unsigned-bitfields
1149 These options control whether a bitfield is signed or unsigned, when the
1150 declaration does not use either @code{signed} or @code{unsigned}.  By
1151 default, such a bitfield is signed, because this is consistent: the
1152 basic integer types such as @code{int} are signed types.
1154 However, when @samp{-traditional} is used, bitfields are all unsigned
1155 no matter what.
1157 @item -fwritable-strings
1158 Store string constants in the writable data segment and don't uniquize
1159 them.  This is for compatibility with old programs which assume they can
1160 write into string constants.  The option @samp{-traditional} also has
1161 this effect.
1163 Writing into string constants is a very bad idea; ``constants'' should
1164 be constant.
1166 @item -fallow-single-precision
1167 Do not promote single precision math operations to double precision,
1168 even when compiling with @samp{-traditional}.
1170 Traditional K&R C promotes all floating point operations to double
1171 precision, regardless of the sizes of the operands.   On the
1172 architecture for which you are compiling, single precision may be faster
1173 than double precision.   If you must use @samp{-traditional}, but want
1174 to use single precision operations when the operands are single
1175 precision, use this option.   This option has no effect when compiling
1176 with ISO or GNU C conventions (the default).
1178 @item -fshort-wchar
1179 Override the underlying type for @samp{wchar_t} to be @samp{short
1180 unsigned int} instead of the default for the target.  This option is
1181 useful for building programs to run under WINE.
1182 @end table
1184 @node C++ Dialect Options
1185 @section Options Controlling C++ Dialect
1187 @cindex compiler options, C++
1188 @cindex C++ options, command line
1189 @cindex options, C++
1190 This section describes the command-line options that are only meaningful
1191 for C++ programs; but you can also use most of the GNU compiler options
1192 regardless of what language your program is in.  For example, you
1193 might compile a file @code{firstClass.C} like this:
1195 @example
1196 g++ -g -frepo -O -c firstClass.C
1197 @end example
1199 @noindent
1200 In this example, only @samp{-frepo} is an option meant
1201 only for C++ programs; you can use the other options with any
1202 language supported by GCC.
1204 Here is a list of options that are @emph{only} for compiling C++ programs:
1206 @table @gcctabopt
1207 @item -fno-access-control
1208 Turn off all access checking.  This switch is mainly useful for working
1209 around bugs in the access control code.
1211 @item -fcheck-new
1212 Check that the pointer returned by @code{operator new} is non-null
1213 before attempting to modify the storage allocated.  The current Working
1214 Paper requires that @code{operator new} never return a null pointer, so
1215 this check is normally unnecessary.
1217 An alternative to using this option is to specify that your
1218 @code{operator new} does not throw any exceptions; if you declare it
1219 @samp{throw()}, g++ will check the return value.  See also @samp{new
1220 (nothrow)}.
1222 @item -fconserve-space
1223 Put uninitialized or runtime-initialized global variables into the
1224 common segment, as C does.  This saves space in the executable at the
1225 cost of not diagnosing duplicate definitions.  If you compile with this
1226 flag and your program mysteriously crashes after @code{main()} has
1227 completed, you may have an object that is being destroyed twice because
1228 two definitions were merged.
1230 This option is no longer useful on most targets, now that support has
1231 been added for putting variables into BSS without making them common.
1233 @item -fdollars-in-identifiers
1234 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1235 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
1236 @samp{$} by default on most target systems, but there are a few exceptions.)
1237 Traditional C allowed the character @samp{$} to form part of
1238 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1240 @item -fno-elide-constructors
1241 The C++ standard allows an implementation to omit creating a temporary
1242 which is only used to initialize another object of the same type.
1243 Specifying this option disables that optimization, and forces g++ to
1244 call the copy constructor in all cases.
1246 @item -fno-enforce-eh-specs
1247 Don't check for violation of exception specifications at runtime.  This
1248 option violates the C++ standard, but may be useful for reducing code
1249 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1250 will still optimize based on the exception specifications.
1252 @item -fexternal-templates
1253 Cause template instantiations to obey @samp{#pragma interface} and
1254 @samp{implementation}; template instances are emitted or not according
1255 to the location of the template definition.  @xref{Template
1256 Instantiation}, for more information.
1258 This option is deprecated.
1260 @item -falt-external-templates
1261 Similar to -fexternal-templates, but template instances are emitted or
1262 not according to the place where they are first instantiated.
1263 @xref{Template Instantiation}, for more information.
1265 This option is deprecated.
1267 @item -ffor-scope
1268 @itemx -fno-for-scope
1269 If -ffor-scope is specified, the scope of variables declared in
1270 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1271 as specified by the C++ standard.
1272 If -fno-for-scope is specified, the scope of variables declared in
1273 a @i{for-init-statement} extends to the end of the enclosing scope,
1274 as was the case in old versions of gcc, and other (traditional)
1275 implementations of C++.
1277 The default if neither flag is given to follow the standard,
1278 but to allow and give a warning for old-style code that would
1279 otherwise be invalid, or have different behavior.
1281 @item -fno-gnu-keywords
1282 Do not recognize @code{typeof} as a keyword, so that code can use this
1283 word as an identifier. You can use the keyword @code{__typeof__} instead.  
1284 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1286 @item -fhonor-std
1287 Treat the @code{namespace std} as a namespace, instead of ignoring
1288 it. For compatibility with earlier versions of g++, the compiler will,
1289 by default, ignore @code{namespace-declarations},
1290 @code{using-declarations}, @code{using-directives}, and
1291 @code{namespace-names}, if they involve @code{std}.
1293 @item -fhuge-objects
1294 Support virtual function calls for objects that exceed the size
1295 representable by a @samp{short int}.  Users should not use this flag by
1296 default; if you need to use it, the compiler will tell you so.
1298 This flag is not useful when compiling with -fvtable-thunks.
1300 Like all options that change the ABI, all C++ code, @emph{including
1301 libgcc} must be built with the same setting of this option.
1303 @item -fno-implicit-templates
1304 Never emit code for non-inline templates which are instantiated
1305 implicitly (i.e. by use); only emit code for explicit instantiations.
1306 @xref{Template Instantiation}, for more information.
1308 @item -fno-implicit-inline-templates
1309 Don't emit code for implicit instantiations of inline templates, either.
1310 The default is to handle inlines differently so that compiles with and
1311 without optimization will need the same set of explicit instantiations.
1313 @item -fno-implement-inlines
1314 To save space, do not emit out-of-line copies of inline functions
1315 controlled by @samp{#pragma implementation}.  This will cause linker
1316 errors if these functions are not inlined everywhere they are called.
1318 @item -fms-extensions
1319 Disable pedantic warnings about constructs used in MFC, such as implicit
1320 int and getting a pointer to member function via non-standard syntax.
1322 @item -fno-operator-names
1323 Do not treat the operator name keywords @code{and}, @code{bitand},
1324 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1325 synonyms as keywords.
1327 @item -fno-optional-diags
1328 Disable diagnostics that the standard says a compiler does not need to
1329 issue.  Currently, the only such diagnostic issued by g++ is the one for
1330 a name having multiple meanings within a class.
1332 @item -fpermissive
1333 Downgrade messages about nonconformant code from errors to warnings.  By
1334 default, g++ effectively sets @samp{-pedantic-errors} without
1335 @samp{-pedantic}; this option reverses that.  This behavior and this
1336 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1338 @item -frepo
1339 Enable automatic template instantiation.  This option also implies
1340 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1341 information.
1343 @item -fno-rtti
1344 Disable generation of information about every class with virtual
1345 functions for use by the C++ runtime type identification features
1346 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1347 of the language, you can save some space by using this flag.  Note that
1348 exception handling uses the same information, but it will generate it as
1349 needed.
1351 @item -ftemplate-depth-@var{n}
1352 Set the maximum instantiation depth for template classes to @var{n}.
1353 A limit on the template instantiation depth is needed to detect
1354 endless recursions during template class instantiation. ANSI/ISO C++
1355 conforming programs must not rely on a maximum depth greater than 17.
1357 @item -fuse-cxa-atexit
1358 Register destructors for objects with static storage duration with the
1359 @code{__cxa_atexit} function rather than the @code{atexit} function.
1360 This option is required for fully standards-compliant handling of static
1361 destructors, but will only work if your C library supports
1362 @code{__cxa_atexit}.
1364 @item -fvtable-thunks
1365 Use @samp{thunks} to implement the virtual function dispatch table
1366 (@samp{vtable}).  The traditional (cfront-style) approach to
1367 implementing vtables was to store a pointer to the function and two
1368 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1369 implementations store a single pointer to a @samp{thunk} function which
1370 does any necessary adjustment and then calls the target function.
1372 This option also enables a heuristic for controlling emission of
1373 vtables; if a class has any non-inline virtual functions, the vtable
1374 will be emitted in the translation unit containing the first one of
1375 those.
1377 Like all options that change the ABI, all C++ code, @emph{including
1378 libgcc.a} must be built with the same setting of this option.
1380 @item -nostdinc++
1381 Do not search for header files in the standard directories specific to
1382 C++, but do still search the other standard directories.  (This option
1383 is used when building the C++ library.)
1384 @end table
1386 In addition, these optimization, warning, and code generation options
1387 have meanings only for C++ programs:
1389 @table @gcctabopt
1390 @item -fno-default-inline
1391 Do not assume @samp{inline} for functions defined inside a class scope.
1392 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1393 functions will have linkage like inline functions; they just won't be
1394 inlined by default.
1396 @item -Wctor-dtor-privacy (C++ only)
1397 Warn when a class seems unusable, because all the constructors or
1398 destructors in a class are private and the class has no friends or
1399 public static member functions.
1401 @item -Wnon-virtual-dtor (C++ only)
1402 Warn when a class declares a non-virtual destructor that should probably
1403 be virtual, because it looks like the class will be used polymorphically.
1405 @item -Wreorder (C++ only)
1406 @cindex reordering, warning
1407 @cindex warning for reordering of member initializers
1408 Warn when the order of member initializers given in the code does not
1409 match the order in which they must be executed.  For instance:
1411 @smallexample
1412 struct A @{
1413   int i;
1414   int j;
1415   A(): j (0), i (1) @{ @}
1417 @end smallexample
1419 Here the compiler will warn that the member initializers for @samp{i}
1420 and @samp{j} will be rearranged to match the declaration order of the
1421 members.
1422 @end table
1424 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1426 @table @gcctabopt
1427 @item -Weffc++ (C++ only)
1428 Warn about violations of various style guidelines from Scott Meyers'
1429 @cite{Effective C++} books.  If you use this option, you should be aware
1430 that the standard library headers do not obey all of these guidelines;
1431 you can use @samp{grep -v} to filter out those warnings.
1433 @item -Wno-deprecated (C++ only)
1434 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1436 @item -Wno-non-template-friend (C++ only)
1437 Disable warnings when non-templatized friend functions are declared
1438 within a template. With the advent of explicit template specification
1439 support in g++, if the name of the friend is an unqualified-id (ie,
1440 @samp{friend foo(int)}), the C++ language specification demands that the
1441 friend declare or define an ordinary, nontemplate function. (Section
1442 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1443 could be interpreted as a particular specialization of a templatized
1444 function. Because this non-conforming behavior is no longer the default
1445 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1446 check existing code for potential trouble spots, and is on by default.
1447 This new compiler behavior can be turned off with
1448 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1449 but disables the helpful warning.
1451 @item -Wold-style-cast (C++ only)
1452 Warn if an old-style (C-style) cast is used within a C++ program.  The
1453 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1454 @samp{const_cast}) are less vulnerable to unintended effects.
1456 @item -Woverloaded-virtual (C++ only)
1457 @cindex overloaded virtual fn, warning
1458 @cindex warning for overloaded virtual fn
1459 Warn when a function declaration hides virtual functions from a
1460 base class.  For example, in:
1462 @smallexample
1463 struct A @{
1464   virtual void f();
1467 struct B: public A @{
1468   void f(int);
1470 @end smallexample
1472 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1473 like this:
1475 @smallexample
1476 B* b;
1477 b->f();
1478 @end smallexample
1480 will fail to compile.
1482 @item -Wno-pmf-conversions (C++ only)
1483 Disable the diagnostic for converting a bound pointer to member function
1484 to a plain pointer.
1486 @item -Wsign-promo (C++ only)
1487 Warn when overload resolution chooses a promotion from unsigned or
1488 enumeral type to a signed type over a conversion to an unsigned type of
1489 the same size.  Previous versions of g++ would try to preserve
1490 unsignedness, but the standard mandates the current behavior.
1492 @item -Wsynth (C++ only)
1493 @cindex warning for synthesized methods
1494 @cindex synthesized methods, warning
1495 Warn when g++'s synthesis behavior does not match that of cfront.  For
1496 instance:
1498 @smallexample
1499 struct A @{
1500   operator int ();
1501   A& operator = (int);
1504 main ()
1506   A a,b;
1507   a = b;
1509 @end smallexample
1511 In this example, g++ will synthesize a default @samp{A& operator =
1512 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1513 @end table
1515 @node Language Independent Options
1516 @section Options to Control Diagnostic Messages Formatting
1517 @cindex options to control diagnostics formatting
1518 @cindex diagnostic messages
1519 @cindex message formatting
1521 Traditionally, diagnostic messages have been formatted irrespective of
1522 the output device's aspect (e.g. its width, ...).  The options described
1523 below can be used to control the diagnostic messages formatting
1524 algorithm, e.g. how many characters per line, how often source location
1525 information should be reported.  Right now, only the C++ front-end can
1526 honor these options.  However it is expected, in the near future, that
1527 the remaining front-ends would be able to digest them correctly. 
1529 @table @gcctabopt
1530 @item -fmessage-length=@var{n}
1531 Try to format error messages so that they fit on lines of about @var{n}
1532 characters.  The default is 72 characters for g++ and 0 for the rest of
1533 the front-ends supported by GCC.  If @var{n} is zero, then no
1534 line-wrapping will be done; each error message will appear on a single 
1535 line.
1537 @item -fdiagnostics-show-location=once
1538 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1539 reporter to emit @emph{once} source location information; that is, in
1540 case the message is too long to fit on a single physical line and has to
1541 be wrapped, the source location won't be emitted (as prefix) again,
1542 over and over, in subsequent continuation lines.  This is the default
1543 behaviour. 
1545 @item -fdiagnostics-show-location=every-line
1546 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1547 messages reporter to emit the same source location information (as
1548 prefix) for physical lines that result from the process of breaking a
1549 a message which is too long to fit on a single line.
1551 @end table
1553 @node Warning Options
1554 @section Options to Request or Suppress Warnings
1555 @cindex options to control warnings
1556 @cindex warning messages
1557 @cindex messages, warning
1558 @cindex suppressing warnings
1560 Warnings are diagnostic messages that report constructions which
1561 are not inherently erroneous but which are risky or suggest there
1562 may have been an error.
1564 You can request many specific warnings with options beginning @samp{-W},
1565 for example @samp{-Wimplicit} to request warnings on implicit
1566 declarations.  Each of these specific warning options also has a
1567 negative form beginning @samp{-Wno-} to turn off warnings;
1568 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1569 two forms, whichever is not the default.
1571 These options control the amount and kinds of warnings produced by GCC:
1573 @table @gcctabopt
1574 @cindex syntax checking
1575 @item -fsyntax-only
1576 Check the code for syntax errors, but don't do anything beyond that.
1578 @item -pedantic
1579 Issue all the warnings demanded by strict ISO C and ISO C++;
1580 reject all programs that use forbidden extensions, and some other
1581 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1582 version of the ISO C standard specified by any @samp{-std} option used.
1584 Valid ISO C and ISO C++ programs should compile properly with or without
1585 this option (though a rare few will require @option{-ansi} or a
1586 @option{-std} option specifying the required version of ISO C).  However,
1587 without this option, certain GNU extensions and traditional C and C++
1588 features are supported as well.  With this option, they are rejected.
1590 @samp{-pedantic} does not cause warning messages for use of the
1591 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1592 warnings are also disabled in the expression that follows
1593 @code{__extension__}.  However, only system header files should use
1594 these escape routes; application programs should avoid them.
1595 @xref{Alternate Keywords}.
1597 Some users try to use @samp{-pedantic} to check programs for strict ISO
1598 C conformance.  They soon find that it does not do quite what they want:
1599 it finds some non-ISO practices, but not all---only those for which
1600 ISO C @emph{requires} a diagnostic, and some others for which
1601 diagnostics have been added.
1603 A feature to report any failure to conform to ISO C might be useful in
1604 some instances, but would require considerable additional work and would
1605 be quite different from @samp{-pedantic}.  We don't have plans to
1606 support such a feature in the near future.
1608 @item -pedantic-errors
1609 Like @samp{-pedantic}, except that errors are produced rather than
1610 warnings.
1612 @item -w
1613 Inhibit all warning messages.
1615 @item -Wno-import
1616 Inhibit warning messages about the use of @samp{#import}.
1618 @item -Wchar-subscripts
1619 Warn if an array subscript has type @code{char}.  This is a common cause
1620 of error, as programmers often forget that this type is signed on some
1621 machines.
1623 @item -Wcomment
1624 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1625 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1627 @item -Wformat
1628 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1629 the arguments supplied have types appropriate to the format string
1630 specified, and that the conversions specified in the format string make
1631 sense.  This includes standard functions, and others specified by format
1632 attributes (@pxref{Function Attributes}), in the @code{printf},
1633 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1634 not in the C standard) families.
1636 The formats are checked against the format features supported by GNU
1637 libc version 2.2.  These include all ISO C89 and C99 features, as well
1638 as features from the Single Unix Specification and some BSD and GNU
1639 extensions.  Other library implementations may not support all these
1640 features; GCC does not support warning about features that go beyond a
1641 particular library's limitations.  However, if @samp{-pedantic} is used
1642 with @samp{-Wformat}, warnings will be given about format features not
1643 in the selected standard version (but not for @code{strfmon} formats,
1644 since those are not in any version of the C standard).  @xref{C Dialect
1645 Options,,Options Controlling C Dialect}.
1647 @samp{-Wformat} is included in @samp{-Wall}.  For more control over some
1648 aspects of format checking, the options @samp{-Wno-format-y2k},
1649 @samp{-Wno-format-extra-args}, @samp{-Wformat-nonliteral},
1650 @samp{-Wformat-security} and @samp{-Wformat=2} are available, but are
1651 not included in @samp{-Wall}.
1653 @item -Wno-format-y2k
1654 If @samp{-Wformat} is specified, do not warn about @code{strftime}
1655 formats which may yield only a two-digit year.
1657 @item -Wno-format-extra-args
1658 If @samp{-Wformat} is specified, do not warn about excess arguments to a
1659 @code{printf} or @code{scanf} format function.  The C standard specifies
1660 that such arguments are ignored.
1662 @item -Wformat-nonliteral
1663 If @samp{-Wformat} is specified, also warn if the format string is not a
1664 string literal and so cannot be checked, unless the format function
1665 takes its format arguments as a @code{va_list}.
1667 @item -Wformat-security
1668 If @samp{-Wformat} is specified, also warn about uses of format
1669 functions that represent possible security problems.  At present, this
1670 warns about calls to @code{printf} and @code{scanf} functions where the
1671 format string is not a string literal and there are no format arguments,
1672 as in @code{printf (foo);}.  This may be a security hole if the format
1673 string came from untrusted input and contains @samp{%n}.  (This is
1674 currently a subset of what @samp{-Wformat-nonliteral} warns about, but
1675 in future warnings may be added to @samp{-Wformat-security} that are not
1676 included in @samp{-Wformat-nonliteral}.)
1678 @item -Wformat=2
1679 Enable @samp{-Wformat} plus format checks not included in
1680 @samp{-Wformat}.  Currently equivalent to @samp{-Wformat
1681 -Wformat-nonliteral -Wformat-security}.
1683 @item -Wimplicit-int
1684 Warn when a declaration does not specify a type.
1686 @item -Wimplicit-function-declaration
1687 @itemx -Werror-implicit-function-declaration
1688 Give a warning (or error) whenever a function is used before being
1689 declared.
1691 @item -Wimplicit
1692 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1693 @samp{declaration}.
1695 @item -Wmain
1696 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1697 function with external linkage, returning int, taking either zero
1698 arguments, two, or three arguments of appropriate types.
1700 @item -Wmultichar
1701 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1702 indicate a typo in the user's code, as they have implementation-defined
1703 values, and should not be used in portable code.
1705 @item -Wparentheses
1706 Warn if parentheses are omitted in certain contexts, such
1707 as when there is an assignment in a context where a truth value
1708 is expected, or when operators are nested whose precedence people
1709 often get confused about.
1711 Also warn about constructions where there may be confusion to which
1712 @code{if} statement an @code{else} branch belongs.  Here is an example of
1713 such a case:
1715 @smallexample
1717   if (a)
1718     if (b)
1719       foo ();
1720   else
1721     bar ();
1723 @end smallexample
1725 In C, every @code{else} branch belongs to the innermost possible @code{if}
1726 statement, which in this example is @code{if (b)}.  This is often not
1727 what the programmer expected, as illustrated in the above example by
1728 indentation the programmer chose.  When there is the potential for this
1729 confusion, GNU C will issue a warning when this flag is specified.
1730 To eliminate the warning, add explicit braces around the innermost
1731 @code{if} statement so there is no way the @code{else} could belong to
1732 the enclosing @code{if}.  The resulting code would look like this:
1734 @smallexample
1736   if (a)
1737     @{
1738       if (b)
1739         foo ();
1740       else
1741         bar ();
1742     @}
1744 @end smallexample
1746 @item -Wsequence-point
1747 Warn about code that may have undefined semantics because of violations
1748 of sequence point rules in the C standard.
1750 The C standard defines the order in which expressions in a C program are
1751 evaluated in terms of @dfn{sequence points}, which represent a partial
1752 ordering between the execution of parts of the program: those executed
1753 before the sequence point, and those executed after it.  These occur
1754 after the evaluation of a full expression (one which is not part of a
1755 larger expression), after the evaluation of the first operand of a
1756 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1757 function is called (but after the evaluation of its arguments and the
1758 expression denoting the called function), and in certain other places.
1759 Other than as expressed by the sequence point rules, the order of
1760 evaluation of subexpressions of an expression is not specified.  All
1761 these rules describe only a partial order rather than a total order,
1762 since, for example, if two functions are called within one expression
1763 with no sequence point between them, the order in which the functions
1764 are called is not specified.  However, the standards committee have
1765 ruled that function calls do not overlap.
1767 It is not specified when between sequence points modifications to the
1768 values of objects take effect.  Programs whose behavior depends on this
1769 have undefined behavior; the C standard specifies that ``Between the
1770 previous and next sequence point an object shall have its stored value
1771 modified at most once by the evaluation of an expression.  Furthermore,
1772 the prior value shall be read only to determine the value to be
1773 stored.''.  If a program breaks these rules, the results on any
1774 particular implementation are entirely unpredictable.
1776 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1777 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1778 diagnosed by this option, and it may give an occasional false positive
1779 result, but in general it has been found fairly effective at detecting
1780 this sort of problem in programs.
1782 The present implementation of this option only works for C programs.  A
1783 future implementation may also work for C++ programs.
1785 There is some controversy over the precise meaning of the sequence point
1786 rules in subtle cases.  Alternative formal definitions may be found in
1787 Clive Feather's ``Annex S''
1788 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n925.htm}} and in
1789 Michael Norrish's thesis
1790 @w{@uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}}.
1791 Other discussions are by Raymond Mak
1792 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n926.htm}} and
1793 D. Hugh Redelmeier
1794 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n927.htm}}.
1796 @item -Wreturn-type
1797 Warn whenever a function is defined with a return-type that defaults to
1798 @code{int}.  Also warn about any @code{return} statement with no
1799 return-value in a function whose return-type is not @code{void}. 
1801 For C++, a function without return type always produces a diagnostic
1802 message, even when @samp{-Wno-return-type} is specified. The only
1803 exceptions are @samp{main} and functions defined in system headers.
1805 @item -Wswitch
1806 Warn whenever a @code{switch} statement has an index of enumeral type
1807 and lacks a @code{case} for one or more of the named codes of that
1808 enumeration.  (The presence of a @code{default} label prevents this
1809 warning.)  @code{case} labels outside the enumeration range also
1810 provoke warnings when this option is used.
1812 @item -Wtrigraphs
1813 Warn if any trigraphs are encountered that might change the meaning of
1814 the program (trigraphs within comments are not warned about).
1816 @item -Wunused-function
1817 Warn whenever a static function is declared but not defined or a
1818 non\-inline static function is unused.
1820 @item -Wunused-label
1821 Warn whenever a label is declared but not used.
1823 To suppress this warning use the @samp{unused} attribute
1824 (@pxref{Variable Attributes}).
1826 @item -Wunused-parameter
1827 Warn whenever a function parameter is unused aside from its declaration.
1829 To suppress this warning use the @samp{unused} attribute
1830 (@pxref{Variable Attributes}).
1832 @item -Wunused-variable
1833 Warn whenever a local variable or non-constant static variable is unused
1834 aside from its declaration
1836 To suppress this warning use the @samp{unused} attribute
1837 (@pxref{Variable Attributes}).
1839 @item -Wunused-value
1840 Warn whenever a statement computes a result that is explicitly not used.
1842 To suppress this warning cast the expression to @samp{void}.
1844 @item -Wunused
1845 All all the above @samp{-Wunused} options combined.
1847 In order to get a warning about an unused function parameter, you must
1848 either specify @samp{-W -Wunused} or separately specify
1849 @samp{-Wunused-parameter}.
1851 @item -Wuninitialized
1852 Warn if an automatic variable is used without first being initialized or
1853 if a variable may be clobbered by a @code{setjmp} call.
1855 These warnings are possible only in optimizing compilation,
1856 because they require data flow information that is computed only
1857 when optimizing.  If you don't specify @samp{-O}, you simply won't
1858 get these warnings.
1860 These warnings occur only for variables that are candidates for
1861 register allocation.  Therefore, they do not occur for a variable that
1862 is declared @code{volatile}, or whose address is taken, or whose size
1863 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1864 structures, unions or arrays, even when they are in registers.
1866 Note that there may be no warning about a variable that is used only
1867 to compute a value that itself is never used, because such
1868 computations may be deleted by data flow analysis before the warnings
1869 are printed.
1871 These warnings are made optional because GCC is not smart
1872 enough to see all the reasons why the code might be correct
1873 despite appearing to have an error.  Here is one example of how
1874 this can happen:
1876 @smallexample
1878   int x;
1879   switch (y)
1880     @{
1881     case 1: x = 1;
1882       break;
1883     case 2: x = 4;
1884       break;
1885     case 3: x = 5;
1886     @}
1887   foo (x);
1889 @end smallexample
1891 @noindent
1892 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1893 always initialized, but GCC doesn't know this.  Here is
1894 another common case:
1896 @smallexample
1898   int save_y;
1899   if (change_y) save_y = y, y = new_y;
1900   @dots{}
1901   if (change_y) y = save_y;
1903 @end smallexample
1905 @noindent
1906 This has no bug because @code{save_y} is used only if it is set.
1908 @cindex @code{longjmp} warnings
1909 This option also warns when a non-volatile automatic variable might be
1910 changed by a call to @code{longjmp}.  These warnings as well are possible
1911 only in optimizing compilation.
1913 The compiler sees only the calls to @code{setjmp}.  It cannot know
1914 where @code{longjmp} will be called; in fact, a signal handler could
1915 call it at any point in the code.  As a result, you may get a warning
1916 even when there is in fact no problem because @code{longjmp} cannot
1917 in fact be called at the place which would cause a problem.
1919 Some spurious warnings can be avoided if you declare all the functions
1920 you use that never return as @code{noreturn}.  @xref{Function
1921 Attributes}.
1923 @item -Wreorder (C++ only)
1924 @cindex reordering, warning
1925 @cindex warning for reordering of member initializers
1926 Warn when the order of member initializers given in the code does not
1927 match the order in which they must be executed.  For instance:
1929 @item -Wunknown-pragmas
1930 @cindex warning for unknown pragmas
1931 @cindex unknown pragmas, warning
1932 @cindex pragmas, warning of unknown
1933 Warn when a #pragma directive is encountered which is not understood by
1934 GCC.  If this command line option is used, warnings will even be issued
1935 for unknown pragmas in system header files.  This is not the case if
1936 the warnings were only enabled by the @samp{-Wall} command line option.
1938 @item -Wall
1939 All of the above @samp{-W} options combined.  This enables all the
1940 warnings about constructions that some users consider questionable, and
1941 that are easy to avoid (or modify to prevent the warning), even in
1942 conjunction with macros.
1944 @item -Wsystem-headers
1945 @cindex warnings from system headers
1946 @cindex system headers, warnings from
1947 Print warning messages for constructs found in system header files.
1948 Warnings from system headers are normally suppressed, on the assumption
1949 that they usually do not indicate real problems and would only make the
1950 compiler output harder to read.  Using this command line option tells
1951 GCC to emit warnings from system headers as if they occurred in user
1952 code.  However, note that using @samp{-Wall} in conjunction with this
1953 option will @emph{not} warn about unknown pragmas in system
1954 headers---for that, @samp{-Wunknown-pragmas} must also be used.
1955 @end table
1957 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1958 Some of them warn about constructions that users generally do not
1959 consider questionable, but which occasionally you might wish to check
1960 for; others warn about constructions that are necessary or hard to avoid
1961 in some cases, and there is no simple way to modify the code to suppress
1962 the warning.
1964 @table @gcctabopt
1965 @item -W
1966 Print extra warning messages for these events:
1968 @itemize @bullet
1969 @item
1970 A function can return either with or without a value.  (Falling
1971 off the end of the function body is considered returning without
1972 a value.)  For example, this function would evoke such a
1973 warning:
1975 @smallexample
1976 @group
1977 foo (a)
1979   if (a > 0)
1980     return a;
1982 @end group
1983 @end smallexample
1985 @item
1986 An expression-statement or the left-hand side of a comma expression
1987 contains no side effects.
1988 To suppress the warning, cast the unused expression to void.
1989 For example, an expression such as @samp{x[i,j]} will cause a warning,
1990 but @samp{x[(void)i,j]} will not.
1992 @item
1993 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
1995 @item
1996 A comparison like @samp{x<=y<=z} appears; this is equivalent to
1997 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
1998 that of ordinary mathematical notation.
2000 @item
2001 Storage-class specifiers like @code{static} are not the first things in
2002 a declaration.  According to the C Standard, this usage is obsolescent.
2004 @item
2005 The return type of a function has a type qualifier such as @code{const}.
2006 Such a type qualifier has no effect, since the value returned by a
2007 function is not an lvalue.  (But don't warn about the GNU extension of
2008 @code{volatile void} return types.  That extension will be warned about
2009 if @samp{-pedantic} is specified.)
2011 @item
2012 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
2013 arguments.
2015 @item
2016 A comparison between signed and unsigned values could produce an
2017 incorrect result when the signed value is converted to unsigned.
2018 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
2020 @item
2021 An aggregate has a partly bracketed initializer.
2022 For example, the following code would evoke such a warning,
2023 because braces are missing around the initializer for @code{x.h}:
2025 @smallexample
2026 struct s @{ int f, g; @};
2027 struct t @{ struct s h; int i; @};
2028 struct t x = @{ 1, 2, 3 @};
2029 @end smallexample
2031 @item
2032 An aggregate has an initializer which does not initialize all members.
2033 For example, the following code would cause such a warning, because
2034 @code{x.h} would be implicitly initialized to zero:
2036 @smallexample
2037 struct s @{ int f, g, h; @};
2038 struct s x = @{ 3, 4 @};
2039 @end smallexample
2040 @end itemize
2042 @item -Wfloat-equal
2043 Warn if floating point values are used in equality comparisons.
2045 The idea behind this is that sometimes it is convenient (for the
2046 programmer) to consider floating-point values as approximations to
2047 infinitely precise real numbers.  If you are doing this, then you need
2048 to compute (by analysing the code, or in some other way) the maximum or
2049 likely maximum error that the computation introduces, and allow for it
2050 when performing comparisons (and when producing output, but that's a
2051 different problem).  In particular, instead of testing for equality, you
2052 would check to see whether the two values have ranges that overlap; and
2053 this is done with the relational operators, so equality comparisons are
2054 probably mistaken.
2056 @item -Wtraditional (C only)
2057 Warn about certain constructs that behave differently in traditional and
2058 ISO C.
2060 @itemize @bullet
2061 @item
2062 Macro parameters that appear within string literals in the macro body.
2063 In traditional C macro replacement takes place within string literals,
2064 but does not in ISO C.
2066 @item
2067 In traditional C, some preprocessor directives did not exist.
2068 Traditional preprocessors would only consider a line to be a directive
2069 if the @samp{#} appeared in column 1 on the line.  Therefore
2070 @samp{-Wtraditional} warns about directives that traditional C
2071 understands but would ignore because the @samp{#} does not appear as the
2072 first character on the line.  It also suggests you hide directives like
2073 @samp{#pragma} not understood by traditional C by indenting them.  Some
2074 traditional implementations would not recognise @samp{#elif}, so it
2075 suggests avoiding it altogether.
2077 @item
2078 A function-like macro that appears without arguments.
2080 @item
2081 The unary plus operator.
2083 @item
2084 The `U' integer constant suffix, or the `F' or `L' floating point
2085 constant suffixes.  (Traditonal C does support the `L' suffix on integer
2086 constants.)  Note, these suffixes appear in macros defined in the system
2087 headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
2088 Use of these macros can lead to spurious warnings as they do not
2089 necessarily reflect whether the code in question is any less portable to
2090 traditional C given that suitable backup definitions are provided.
2092 @item
2093 A function declared external in one block and then used after the end of
2094 the block.
2096 @item
2097 A @code{switch} statement has an operand of type @code{long}.
2099 @item
2100 A non-@code{static} function declaration follows a @code{static} one.
2101 This construct is not accepted by some traditional C compilers.
2103 @item
2104 The ISO type of an integer constant has a different width or
2105 signedness from its traditional type.  This warning is only issued if
2106 the base of the constant is ten.  I.e. hexadecimal or octal values, which
2107 typically represent bit patterns, are not warned about.
2109 @item
2110 Usage of ISO string concatenation is detected.
2112 @item
2113 Initialization of automatic aggregates.
2115 @item
2116 Identifier conflicts with labels.  Traditional C lacks a separate
2117 namespace for labels.
2119 @item
2120 Initialization of unions.  If the initializer is zero, the warning is
2121 omitted.  This is done under the assumption that the zero initializer in
2122 user code appears conditioned on e.g. @code{__STDC__} to avoid missing
2123 initializer warnings and relies on default initialization to zero in the
2124 traditional C case.
2125 @end itemize
2127 @item -Wundef
2128 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2130 @item -Wshadow
2131 Warn whenever a local variable shadows another local variable.
2133 @item -Wid-clash-@var{len}
2134 Warn whenever two distinct identifiers match in the first @var{len}
2135 characters.  This may help you prepare a program that will compile
2136 with certain obsolete, brain-damaged compilers.
2138 @item -Wlarger-than-@var{len}
2139 Warn whenever an object of larger than @var{len} bytes is defined.
2141 @item -Wpointer-arith
2142 Warn about anything that depends on the ``size of'' a function type or
2143 of @code{void}.  GNU C assigns these types a size of 1, for
2144 convenience in calculations with @code{void *} pointers and pointers
2145 to functions.
2147 @item -Wbad-function-cast (C only)
2148 Warn whenever a function call is cast to a non-matching type.
2149 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2151 @item -Wcast-qual
2152 Warn whenever a pointer is cast so as to remove a type qualifier from
2153 the target type.  For example, warn if a @code{const char *} is cast
2154 to an ordinary @code{char *}.
2156 @item -Wcast-align
2157 Warn whenever a pointer is cast such that the required alignment of the
2158 target is increased.  For example, warn if a @code{char *} is cast to
2159 an @code{int *} on machines where integers can only be accessed at
2160 two- or four-byte boundaries.
2162 @item -Wwrite-strings
2163 Give string constants the type @code{const char[@var{length}]} so that
2164 copying the address of one into a non-@code{const} @code{char *}
2165 pointer will get a warning.  These warnings will help you find at
2166 compile time code that can try to write into a string constant, but
2167 only if you have been very careful about using @code{const} in
2168 declarations and prototypes.  Otherwise, it will just be a nuisance;
2169 this is why we did not make @samp{-Wall} request these warnings.
2171 @item -Wconversion
2172 Warn if a prototype causes a type conversion that is different from what
2173 would happen to the same argument in the absence of a prototype.  This
2174 includes conversions of fixed point to floating and vice versa, and
2175 conversions changing the width or signedness of a fixed point argument
2176 except when the same as the default promotion.
2178 Also, warn if a negative integer constant expression is implicitly
2179 converted to an unsigned type.  For example, warn about the assignment
2180 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2181 casts like @code{(unsigned) -1}.
2183 @item -Wsign-compare
2184 @cindex warning for comparison of signed and unsigned values
2185 @cindex comparison of signed and unsigned values, warning
2186 @cindex signed and unsigned values, comparison warning
2187 Warn when a comparison between signed and unsigned values could produce
2188 an incorrect result when the signed value is converted to unsigned.
2189 This warning is also enabled by @samp{-W}; to get the other warnings
2190 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2192 @item -Waggregate-return
2193 Warn if any functions that return structures or unions are defined or
2194 called.  (In languages where you can return an array, this also elicits
2195 a warning.)
2197 @item -Wstrict-prototypes (C only)
2198 Warn if a function is declared or defined without specifying the
2199 argument types.  (An old-style function definition is permitted without
2200 a warning if preceded by a declaration which specifies the argument
2201 types.)
2203 @item -Wmissing-prototypes (C only)
2204 Warn if a global function is defined without a previous prototype
2205 declaration.  This warning is issued even if the definition itself
2206 provides a prototype.  The aim is to detect global functions that fail
2207 to be declared in header files.
2209 @item -Wmissing-declarations
2210 Warn if a global function is defined without a previous declaration.
2211 Do so even if the definition itself provides a prototype.
2212 Use this option to detect global functions that are not declared in
2213 header files.
2215 @item -Wmissing-noreturn
2216 Warn about functions which might be candidates for attribute @code{noreturn}.
2217 Note these are only possible candidates, not absolute ones.  Care should
2218 be taken to manually verify functions actually do not ever return before
2219 adding the @code{noreturn} attribute, otherwise subtle code generation
2220 bugs could be introduced.  You will not get a warning for @code{main} in
2221 hosted C environments.
2223 @item -Wmissing-format-attribute
2224 If @samp{-Wformat} is enabled, also warn about functions which might be
2225 candidates for @code{format} attributes.  Note these are only possible
2226 candidates, not absolute ones.  GCC will guess that @code{format}
2227 attributes might be appropriate for any function that calls a function
2228 like @code{vprintf} or @code{vscanf}, but this might not always be the
2229 case, and some functions for which @code{format} attributes are
2230 appropriate may not be detected.  This option has no effect unless
2231 @samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2233 @item -Wpacked
2234 Warn if a structure is given the packed attribute, but the packed
2235 attribute has no effect on the layout or size of the structure.  
2236 Such structures may be mis-aligned for little benefit.  For
2237 instance, in this code, the variable @code{f.x} in @code{struct bar}
2238 will be misaligned even though @code{struct bar} does not itself
2239 have the packed attribute:
2241 @smallexample
2242 @group
2243 struct foo @{
2244   int x;
2245   char a, b, c, d;
2246 @} __attribute__((packed));
2247 struct bar @{
2248   char z;
2249   struct foo f;
2251 @end group
2252 @end smallexample
2254 @item -Wpadded
2255 Warn if padding is included in a structure, either to align an element
2256 of the structure or to align the whole structure.  Sometimes when this
2257 happens it is possible to rearrange the fields of the structure to
2258 reduce the padding and so make the structure smaller.
2260 @item -Wredundant-decls
2261 Warn if anything is declared more than once in the same scope, even in
2262 cases where multiple declaration is valid and changes nothing.
2264 @item -Wnested-externs (C only)
2265 Warn if an @code{extern} declaration is encountered within a function.
2267 @item -Wunreachable-code
2268 Warn if the compiler detects that code will never be executed.
2270 This option is intended to warn when the compiler detects that at
2271 least a whole line of source code will never be executed, because
2272 some condition is never satisfied or because it is after a
2273 procedure that never returns.
2275 It is possible for this option to produce a warning even though there
2276 are circumstances under which part of the affected line can be executed,
2277 so care should be taken when removing apparently-unreachable code.
2279 For instance, when a function is inlined, a warning may mean that the
2280 line is unreachable in only one inlined copy of the function.  
2282 This option is not made part of @samp{-Wall} because in a debugging
2283 version of a program there is often substantial code which checks
2284 correct functioning of the program and is, hopefully, unreachable
2285 because the program does work.  Another common use of unreachable
2286 code is to provide behaviour which is selectable at compile-time.
2288 @item -Winline
2289 Warn if a function can not be inlined and it was declared as inline.
2291 @item -Wlong-long
2292 Warn if @samp{long long} type is used.  This is default.  To inhibit
2293 the warning messages, use @samp{-Wno-long-long}.  Flags
2294 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2295 only when @samp{-pedantic} flag is used.
2297 @item -Wdisabled-optimization
2298 Warn if a requested optimization pass is disabled.  This warning does
2299 not generally indicate that there is anything wrong with your code; it
2300 merely indicates that GCC's optimizers were unable to handle the code
2301 effectively.  Often, the problem is that your code is too big or too
2302 complex; GCC will refuse to optimize programs when the optimization
2303 itself is likely to take inordinate amounts of time.
2305 @item -Werror
2306 Make all warnings into errors.
2307 @end table
2309 @node Debugging Options
2310 @section Options for Debugging Your Program or GCC
2311 @cindex options, debugging
2312 @cindex debugging information options
2314 GCC has various special options that are used for debugging
2315 either your program or GCC:
2317 @table @gcctabopt
2318 @item -g
2319 Produce debugging information in the operating system's native format
2320 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
2321 information.
2323 On most systems that use stabs format, @samp{-g} enables use of extra
2324 debugging information that only GDB can use; this extra information
2325 makes debugging work better in GDB but will probably make other debuggers
2326 crash or
2327 refuse to read the program.  If you want to control for certain whether
2328 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2329 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2330 (see below).
2332 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2333 @samp{-O}.  The shortcuts taken by optimized code may occasionally
2334 produce surprising results: some variables you declared may not exist
2335 at all; flow of control may briefly move where you did not expect it;
2336 some statements may not be executed because they compute constant
2337 results or their values were already at hand; some statements may
2338 execute in different places because they were moved out of loops.
2340 Nevertheless it proves possible to debug optimized output.  This makes
2341 it reasonable to use the optimizer for programs that might have bugs.
2343 The following options are useful when GCC is generated with the
2344 capability for more than one debugging format.
2346 @item -ggdb
2347 Produce debugging information for use by GDB.  This means to use the
2348 most expressive format available (DWARF 2, stabs, or the native format
2349 if neither of those are supported), including GDB extensions if at all
2350 possible.
2352 @item -gstabs
2353 Produce debugging information in stabs format (if that is supported),
2354 without GDB extensions.  This is the format used by DBX on most BSD
2355 systems.  On MIPS, Alpha and System V Release 4 systems this option
2356 produces stabs debugging output which is not understood by DBX or SDB.
2357 On System V Release 4 systems this option requires the GNU assembler.
2359 @item -gstabs+
2360 Produce debugging information in stabs format (if that is supported),
2361 using GNU extensions understood only by the GNU debugger (GDB).  The
2362 use of these extensions is likely to make other debuggers crash or
2363 refuse to read the program.
2365 @item -gcoff
2366 Produce debugging information in COFF format (if that is supported).
2367 This is the format used by SDB on most System V systems prior to
2368 System V Release 4.
2370 @item -gxcoff
2371 Produce debugging information in XCOFF format (if that is supported).
2372 This is the format used by the DBX debugger on IBM RS/6000 systems.
2374 @item -gxcoff+
2375 Produce debugging information in XCOFF format (if that is supported),
2376 using GNU extensions understood only by the GNU debugger (GDB).  The
2377 use of these extensions is likely to make other debuggers crash or
2378 refuse to read the program, and may cause assemblers other than the GNU
2379 assembler (GAS) to fail with an error.
2381 @item -gdwarf
2382 Produce debugging information in DWARF version 1 format (if that is
2383 supported).  This is the format used by SDB on most System V Release 4
2384 systems.
2386 @item -gdwarf+
2387 Produce debugging information in DWARF version 1 format (if that is
2388 supported), using GNU extensions understood only by the GNU debugger
2389 (GDB).  The use of these extensions is likely to make other debuggers
2390 crash or refuse to read the program.
2392 @item -gdwarf-2
2393 Produce debugging information in DWARF version 2 format (if that is
2394 supported).  This is the format used by DBX on IRIX 6.
2396 @item -g@var{level}
2397 @itemx -ggdb@var{level}
2398 @itemx -gstabs@var{level}
2399 @itemx -gcoff@var{level}
2400 @itemx -gxcoff@var{level}
2401 @itemx -gdwarf@var{level}
2402 @itemx -gdwarf-2@var{level}
2403 Request debugging information and also use @var{level} to specify how
2404 much information.  The default level is 2.
2406 Level 1 produces minimal information, enough for making backtraces in
2407 parts of the program that you don't plan to debug.  This includes
2408 descriptions of functions and external variables, but no information
2409 about local variables and no line numbers.
2411 Level 3 includes extra information, such as all the macro definitions
2412 present in the program.  Some debuggers support macro expansion when
2413 you use @samp{-g3}.
2415 @cindex @code{prof}
2416 @item -p
2417 Generate extra code to write profile information suitable for the
2418 analysis program @code{prof}.  You must use this option when compiling
2419 the source files you want data about, and you must also use it when
2420 linking.
2422 @cindex @code{gprof}
2423 @item -pg
2424 Generate extra code to write profile information suitable for the
2425 analysis program @code{gprof}.  You must use this option when compiling
2426 the source files you want data about, and you must also use it when
2427 linking.
2429 @cindex @code{tcov}
2430 @item -a
2431 Generate extra code to write profile information for basic blocks, which will
2432 record the number of times each basic block is executed, the basic block start
2433 address, and the function name containing the basic block.  If @samp{-g} is
2434 used, the line number and filename of the start of the basic block will also be
2435 recorded.  If not overridden by the machine description, the default action is
2436 to append to the text file @file{bb.out}.
2438 This data could be analyzed by a program like @code{tcov}.  Note,
2439 however, that the format of the data is not what @code{tcov} expects.
2440 Eventually GNU @code{gprof} should be extended to process this data.
2442 @item -Q
2443 Makes the compiler print out each function name as it is compiled, and
2444 print some statistics about each pass when it finishes.
2446 @item -ax
2447 Generate extra code to profile basic blocks.  Your executable will
2448 produce output that is a superset of that produced when @samp{-a} is
2449 used.  Additional output is the source and target address of the basic
2450 blocks where a jump takes place, the number of times a jump is executed,
2451 and (optionally) the complete sequence of basic blocks being executed.
2452 The output is appended to file @file{bb.out}.
2454 You can examine different profiling aspects without recompilation.  Your
2455 executable will read a list of function names from file @file{bb.in}.
2456 Profiling starts when a function on the list is entered and stops when
2457 that invocation is exited.  To exclude a function from profiling, prefix
2458 its name with `-'.  If a function name is not unique, you can
2459 disambiguate it by writing it in the form
2460 @samp{/path/filename.d:functionname}.  Your executable will write the
2461 available paths and filenames in file @file{bb.out}.
2463 Several function names have a special meaning:
2464 @table @code
2465 @item __bb_jumps__
2466 Write source, target and frequency of jumps to file @file{bb.out}.
2467 @item __bb_hidecall__
2468 Exclude function calls from frequency count.
2469 @item __bb_showret__
2470 Include function returns in frequency count.
2471 @item __bb_trace__
2472 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2473 The file will be compressed using the program @samp{gzip}, which must
2474 exist in your @env{PATH}.  On systems without the @samp{popen}
2475 function, the file will be named @file{bbtrace} and will not be
2476 compressed.  @strong{Profiling for even a few seconds on these systems
2477 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2478 @code{__bb_showret__} will not affect the sequence written to
2479 @file{bbtrace.gz}.
2480 @end table
2482 Here's a short example using different profiling parameters
2483 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2484 1 and 2 and is called twice from block 3 of function @code{main}.  After
2485 the calls, block 3 transfers control to block 4 of @code{main}.
2487 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2488 the following sequence of blocks is written to file @file{bbtrace.gz}:
2489 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2490 the return is to a point inside the block and not to the top.  The
2491 block address 0 always indicates, that control is transferred
2492 to the trace from somewhere outside the observed functions.  With
2493 @samp{-foo} added to @file{bb.in}, the blocks of function
2494 @code{foo} are removed from the trace, so only 0 3 4 remains.
2496 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2497 jump frequencies will be written to file @file{bb.out}.  The
2498 frequencies are obtained by constructing a trace of blocks
2499 and incrementing a counter for every neighbouring pair of blocks
2500 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2501 frequencies:
2503 @example
2504 Jump from block 0x0 to block 0x3 executed 1 time(s)
2505 Jump from block 0x3 to block 0x1 executed 1 time(s)
2506 Jump from block 0x1 to block 0x2 executed 2 time(s)
2507 Jump from block 0x2 to block 0x1 executed 1 time(s)
2508 Jump from block 0x2 to block 0x4 executed 1 time(s)
2509 @end example
2511 With @code{__bb_hidecall__}, control transfer due to call instructions
2512 is removed from the trace, that is the trace is cut into three parts: 0
2513 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2514 to return instructions is added to the trace.  The trace becomes: 0 3 1
2515 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2516 written to @file{bbtrace.gz}.  It is solely used for counting jump
2517 frequencies.
2519 @item -fprofile-arcs
2520 Instrument @dfn{arcs} during compilation.  For each function of your
2521 program, GCC creates a program flow graph, then finds a spanning tree
2522 for the graph.  Only arcs that are not on the spanning tree have to be
2523 instrumented: the compiler adds code to count the number of times that these
2524 arcs are executed.  When an arc is the only exit or only entrance to a
2525 block, the instrumentation code can be added to the block; otherwise, a
2526 new basic block must be created to hold the instrumentation code.
2528 Since not every arc in the program must be instrumented, programs
2529 compiled with this option run faster than programs compiled with
2530 @samp{-a}, which adds instrumentation code to every basic block in the
2531 program.  The tradeoff: since @code{gcov} does not have
2532 execution counts for all branches, it must start with the execution
2533 counts for the instrumented branches, and then iterate over the program
2534 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2535 runs a little more slowly than a program which uses information from
2536 @samp{-a}.
2538 @samp{-fprofile-arcs} also makes it possible to estimate branch
2539 probabilities, and to calculate basic block execution counts.  In
2540 general, basic block execution counts do not give enough information to
2541 estimate all branch probabilities.  When the compiled program exits, it
2542 saves the arc execution counts to a file called
2543 @file{@var{sourcename}.da}.  Use the compiler option
2544 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2545 Control Optimization}) when recompiling, to optimize using estimated
2546 branch probabilities.
2548 @need 2000
2549 @item -ftest-coverage
2550 Create data files for the @code{gcov} code-coverage utility
2551 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2552 The data file names begin with the name of your source file:
2554 @table @gcctabopt
2555 @item @var{sourcename}.bb
2556 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2557 associate basic block execution counts with line numbers.
2559 @item @var{sourcename}.bbg
2560 A list of all arcs in the program flow graph.  This allows @code{gcov}
2561 to reconstruct the program flow graph, so that it can compute all basic
2562 block and arc execution counts from the information in the
2563 @code{@var{sourcename}.da} file (this last file is the output from
2564 @samp{-fprofile-arcs}).
2565 @end table
2567 @item -d@var{letters}
2568 Says to make debugging dumps during compilation at times specified by
2569 @var{letters}.  This is used for debugging the compiler.  The file names
2570 for most of the dumps are made by appending a pass number and a word to
2571 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}). 
2572 Here are the possible letters for use in @var{letters}, and their meanings:
2574 @table @samp
2575 @item A
2576 Annotate the assembler output with miscellaneous debugging information.
2577 @item b
2578 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2579 @item B
2580 Dump after block reordering, to @file{@var{file}.26.bbro}.
2581 @item c
2582 Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2583 @item C
2584 Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
2585 @item d
2586 Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
2587 @item D
2588 Dump all macro definitions, at the end of preprocessing, in addition to
2589 normal output.
2590 @item e
2591 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2592 @file{@var{file}.06.ussa}.
2593 @item E
2594 Dump after the second if conversion, to @file{@var{file}.24.ce2}.
2595 @item f
2596 Dump after life analysis, to @file{@var{file}.13.life}.
2597 @item F
2598 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2599 @item g
2600 Dump after global register allocation, to @file{@var{file}.19.greg}.
2601 @item o
2602 Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
2603 @item G      
2604 Dump after GCSE, to @file{@var{file}.08.gcse}.
2605 @item i
2606 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2607 @item j
2608 Dump after the first jump optimization, to @file{@var{file}.02.jump}.
2609 @item J
2610 Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
2611 @item k
2612 Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
2613 @item l
2614 Dump after local register allocation, to @file{@var{file}.18.lreg}.
2615 @item L
2616 Dump after loop optimization, to @file{@var{file}.09.loop}.
2617 @item M
2618 Dump after performing the machine dependent reorganisation pass, to
2619 @file{@var{file}.28.mach}. 
2620 @item n
2621 Dump after register renumbering, to @file{@var{file}.23.rnreg}.
2622 @item N
2623 Dump after the register move pass, to @file{@var{file}.16.regmove}.
2624 @item r
2625 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2626 @item R
2627 Dump after the second instruction scheduling pass, to
2628 @file{@var{file}.25.sched2}.
2629 @item s
2630 Dump after CSE (including the jump optimization that sometimes follows
2631 CSE), to @file{@var{file}.03.cse}. 
2632 @item S
2633 Dump after the first instruction scheduling pass, to
2634 @file{@var{file}.17.sched}.
2635 @item t
2636 Dump after the second CSE pass (including the jump optimization that
2637 sometimes follows CSE), to @file{@var{file}.10.cse2}.
2638 @item w
2639 Dump after the second flow pass, to @file{@var{file}.21.flow2}.
2640 @item X
2641 Dump after dead code elimination, to @file{@var{file}.06.dce}.
2642 @item z
2643 Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
2644 @item a
2645 Produce all the dumps listed above.
2646 @item m
2647 Print statistics on memory usage, at the end of the run, to
2648 standard error.
2649 @item p
2650 Annotate the assembler output with a comment indicating which
2651 pattern and alternative was used.  The length of each instruction is
2652 also printed.
2653 @item P
2654 Dump the RTL in the assembler output as a comment before each instruction.
2655 Also turns on @samp{-dp} annotation.
2656 @item v
2657 For each of the other indicated dump files (except for
2658 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2659 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2660 @item x
2661 Just generate RTL for a function instead of compiling it.  Usually used
2662 with @samp{r}.
2663 @item y
2664 Dump debugging information during parsing, to standard error.
2665 @end table
2667 @item -fdump-unnumbered
2668 When doing debugging dumps (see -d option above), suppress instruction
2669 numbers and line number note output.  This makes it more feasible to
2670 use diff on debugging dumps for compiler invocations with different
2671 options, in particular with and without -g.
2673 @item -fdump-translation-unit=@var{file} (C and C++ only)
2674 Dump a representation of the tree structure for the entire translation
2675 unit to @var{file}.
2677 @item -fdump-class_layout=@var{file} (C++ only)
2678 @item -fdump-class_layout (C++ only)
2679 Dump a representation of each class's heirarchy to @var{file}, or
2680 @code{stderr} if not specified.
2682 @item -fpretend-float
2683 When running a cross-compiler, pretend that the target machine uses the
2684 same floating point format as the host machine.  This causes incorrect
2685 output of the actual floating constants, but the actual instruction
2686 sequence will probably be the same as GCC would make when running on
2687 the target machine.
2689 @item -save-temps
2690 Store the usual ``temporary'' intermediate files permanently; place them
2691 in the current directory and name them based on the source file.  Thus,
2692 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2693 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
2694 preprocessed @file{foo.i} output file even though the compiler now
2695 normally uses an integrated preprocessor.
2697 @item -time
2698 Report the CPU time taken by each subprocess in the compilation
2699 sequence.  For C source files, this is the compiler proper and assembler
2700 (plus the linker if linking is done).  The output looks like this:
2702 @smallexample
2703 # cc1 0.12 0.01
2704 # as 0.00 0.01
2705 @end smallexample
2707 The first number on each line is the ``user time,'' that is time spent
2708 executing the program itself.  The second number is ``system time,''
2709 time spent executing operating system routines on behalf of the program.
2710 Both numbers are in seconds.
2712 @item -print-file-name=@var{library}
2713 Print the full absolute name of the library file @var{library} that
2714 would be used when linking---and don't do anything else.  With this
2715 option, GCC does not compile or link anything; it just prints the
2716 file name.
2718 @item -print-prog-name=@var{program}
2719 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2721 @item -print-libgcc-file-name
2722 Same as @samp{-print-file-name=libgcc.a}.
2724 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2725 but you do want to link with @file{libgcc.a}.  You can do
2727 @example
2728 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2729 @end example
2731 @item -print-search-dirs
2732 Print the name of the configured installation directory and a list of
2733 program and library directories gcc will search---and don't do anything else.
2735 This is useful when gcc prints the error message
2736 @samp{installation problem, cannot exec cpp0: No such file or directory}.
2737 To resolve this you either need to put @file{cpp0} and the other compiler
2738 components where gcc expects to find them, or you can set the environment
2739 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
2740 Don't forget the trailing '/'.
2741 @xref{Environment Variables}.
2742 @end table
2744 @node Optimize Options
2745 @section Options That Control Optimization
2746 @cindex optimize options
2747 @cindex options, optimization
2749 These options control various sorts of optimizations:
2751 @table @gcctabopt
2752 @item -O
2753 @itemx -O1
2754 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2755 more memory for a large function.
2757 Without @samp{-O}, the compiler's goal is to reduce the cost of
2758 compilation and to make debugging produce the expected results.
2759 Statements are independent: if you stop the program with a breakpoint
2760 between statements, you can then assign a new value to any variable or
2761 change the program counter to any other statement in the function and
2762 get exactly the results you would expect from the source code.
2764 Without @samp{-O}, the compiler only allocates variables declared
2765 @code{register} in registers.  The resulting compiled code is a little
2766 worse than produced by PCC without @samp{-O}.
2768 With @samp{-O}, the compiler tries to reduce code size and execution
2769 time.
2771 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2772 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2773 @samp{-fdelayed-branch} on machines that have delay slots, and
2774 @samp{-fomit-frame-pointer} on machines that can support debugging even
2775 without a frame pointer.  On some machines the compiler also turns
2776 on other flags.@refill
2778 @item -O2
2779 Optimize even more.  GCC performs nearly all supported optimizations
2780 that do not involve a space-speed tradeoff.  The compiler does not
2781 perform loop unrolling or function inlining when you specify @samp{-O2}.
2782 As compared to @samp{-O}, this option increases both compilation time
2783 and the performance of the generated code.
2785 @samp{-O2} turns on all optional optimizations except for loop unrolling,
2786 function inlining, and register renaming.  It also turns on the
2787 @samp{-fforce-mem} option on all machines and frame pointer elimination
2788 on machines where doing so does not interfere with debugging.
2790 @item -O3
2791 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2792 @samp{-O2} and also turns on the @samp{-finline-functions} and
2793 @samp{-frename-registers} options.
2795 @item -O0
2796 Do not optimize.
2798 @item -Os
2799 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2800 do not typically increase code size.  It also performs further
2801 optimizations designed to reduce code size.
2803 If you use multiple @samp{-O} options, with or without level numbers,
2804 the last such option is the one that is effective.
2805 @end table
2807 Options of the form @samp{-f@var{flag}} specify machine-independent
2808 flags.  Most flags have both positive and negative forms; the negative
2809 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2810 only one of the forms is listed---the one which is not the default.
2811 You can figure out the other form by either removing @samp{no-} or
2812 adding it.
2814 @table @gcctabopt
2815 @item -ffloat-store
2816 Do not store floating point variables in registers, and inhibit other
2817 options that might change whether a floating point value is taken from a
2818 register or memory.
2820 @cindex floating point precision
2821 This option prevents undesirable excess precision on machines such as
2822 the 68000 where the floating registers (of the 68881) keep more
2823 precision than a @code{double} is supposed to have.  Similarly for the
2824 x86 architecture.  For most programs, the excess precision does only
2825 good, but a few programs rely on the precise definition of IEEE floating
2826 point.  Use @samp{-ffloat-store} for such programs, after modifying
2827 them to store all pertinent intermediate computations into variables.
2829 @item -fno-default-inline
2830 Do not make member functions inline by default merely because they are
2831 defined inside the class scope (C++ only).  Otherwise, when you specify
2832 @w{@samp{-O}}, member functions defined inside class scope are compiled
2833 inline by default; i.e., you don't need to add @samp{inline} in front of
2834 the member function name.
2836 @item -fno-defer-pop
2837 Always pop the arguments to each function call as soon as that function
2838 returns.  For machines which must pop arguments after a function call,
2839 the compiler normally lets arguments accumulate on the stack for several
2840 function calls and pops them all at once.
2842 @item -fforce-mem
2843 Force memory operands to be copied into registers before doing
2844 arithmetic on them.  This produces better code by making all memory
2845 references potential common subexpressions.  When they are not common
2846 subexpressions, instruction combination should eliminate the separate
2847 register-load.  The @samp{-O2} option turns on this option.
2849 @item -fforce-addr
2850 Force memory address constants to be copied into registers before
2851 doing arithmetic on them.  This may produce better code just as
2852 @samp{-fforce-mem} may.
2854 @item -fomit-frame-pointer
2855 Don't keep the frame pointer in a register for functions that
2856 don't need one.  This avoids the instructions to save, set up and
2857 restore frame pointers; it also makes an extra register available
2858 in many functions.  @strong{It also makes debugging impossible on
2859 some machines.}
2861 @ifset INTERNALS
2862 On some machines, such as the Vax, this flag has no effect, because
2863 the standard calling sequence automatically handles the frame pointer
2864 and nothing is saved by pretending it doesn't exist.  The
2865 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2866 whether a target machine supports this flag.  @xref{Registers}.@refill
2867 @end ifset
2868 @ifclear INTERNALS
2869 On some machines, such as the Vax, this flag has no effect, because
2870 the standard calling sequence automatically handles the frame pointer
2871 and nothing is saved by pretending it doesn't exist.  The
2872 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2873 whether a target machine supports this flag.  @xref{Registers,,Register
2874 Usage, gcc.info, Using and Porting GCC}.@refill
2875 @end ifclear
2877 @item -foptimize-sibling-calls
2878 Optimize sibling and tail recursive calls.
2880 @item -ftrapv
2881 This option generates traps for signed overflow on addition, subtraction,
2882 multiplication operations.
2884 @item -fno-inline
2885 Don't pay attention to the @code{inline} keyword.  Normally this option
2886 is used to keep the compiler from expanding any functions inline.
2887 Note that if you are not optimizing, no functions can be expanded inline.
2889 @item -finline-functions
2890 Integrate all simple functions into their callers.  The compiler
2891 heuristically decides which functions are simple enough to be worth
2892 integrating in this way.
2894 If all calls to a given function are integrated, and the function is
2895 declared @code{static}, then the function is normally not output as
2896 assembler code in its own right.
2898 @item -finline-limit=@var{n}
2899 By default, gcc limits the size of functions that can be inlined.  This flag
2900 allows the control of this limit for functions that are explicitly marked as
2901 inline (ie marked with the inline keyword or defined within the class 
2902 definition in c++).  @var{n} is the size of functions that can be inlined in 
2903 number of pseudo instructions (not counting parameter handling).  The default
2904 value of n is 10000.  Increasing this value can result in more inlined code at
2905 the cost of compilation time and memory consumption.  Decreasing usually makes
2906 the compilation faster and less code will be inlined (which presumably 
2907 means slower programs).  This option is particularly useful for programs that 
2908 use inlining heavily such as those based on recursive templates with c++.
2910 @emph{Note:} pseudo instruction represents, in this particular context, an
2911 abstract measurement of function's size.  In no way, it represents a count
2912 of assembly instructions and as such its exact meaning might change from one
2913 release to an another.
2915 @item -fkeep-inline-functions
2916 Even if all calls to a given function are integrated, and the function
2917 is declared @code{static}, nevertheless output a separate run-time
2918 callable version of the function.  This switch does not affect
2919 @code{extern inline} functions.
2921 @item -fkeep-static-consts
2922 Emit variables declared @code{static const} when optimization isn't turned
2923 on, even if the variables aren't referenced.
2925 GCC enables this option by default.  If you want to force the compiler to
2926 check if the variable was referenced, regardless of whether or not
2927 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2929 @item -fno-function-cse
2930 Do not put function addresses in registers; make each instruction that
2931 calls a constant function contain the function's address explicitly.
2933 This option results in less efficient code, but some strange hacks
2934 that alter the assembler output may be confused by the optimizations
2935 performed when this option is not used.
2937 @item -ffast-math
2938 Sets @samp{-fno-math-errno}, @samp{-funsafe-math-optimizations},
2939 and @samp{-fno-trapping-math}.
2941 This option causes the preprocessor macro __FAST_MATH__ to be defined.
2943 This option causes the preprocessor macro __FAST_MATH__ to be defined.
2945 This option should never be turned on by any @samp{-O} option since
2946 it can result in incorrect output for programs which depend on
2947 an exact implementation of IEEE or ISO rules/specifications for
2948 math functions.
2950 @item -fno-math-errno
2951 Do not set ERRNO after calling math functions that are executed
2952 with a single instruction, e.g., sqrt.  A program that relies on
2953 IEEE exceptions for math error handling may want to use this flag
2954 for speed while maintaining IEEE arithmetic compatibility.
2956 This option should never be turned on by any @samp{-O} option since
2957 it can result in incorrect output for programs which depend on
2958 an exact implementation of IEEE or ISO rules/specifications for
2959 math functions.
2961 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2962 sets @samp{-fno-math-errno}.
2964 @item -funsafe-math-optimizations
2965 Allow optimizations for floating-point arithmetic that (a) assume
2966 that arguments and results are valid and (b) may violate IEEE or
2967 ANSI standards.  
2969 This option should never be turned on by any @samp{-O} option since
2970 it can result in incorrect output for programs which depend on
2971 an exact implementation of IEEE or ISO rules/specifications for
2972 math functions.
2974 The default is @samp{-fno-unsafe-math-optimizations}.  The
2975 @samp{-ffast-math} option sets @samp{-funsafe-math-optimizations}.
2977 @item -fno-trapping-math
2978 Compile code assuming that floating-point operations cannot generate
2979 user-visible traps.  Setting this option may allow faster code
2980 if one relies on ``non-stop'' IEEE arithmetic, for example.
2982 This option should never be turned on by any @samp{-O} option since
2983 it can result in incorrect output for programs which depend on
2984 an exact implementation of IEEE or ISO rules/specifications for
2985 math functions.
2987 The default is @samp{-ftrapping-math}.  The @samp{-ffast-math}
2988 option sets @samp{-fno-trapping-math}.
2989 @end table
2991 @c following causes underfulls.. they don't look great, but we deal.
2992 @c --mew 26jan93
2993 The following options control specific optimizations.  The @samp{-O2}
2994 option turns on all of these optimizations except @samp{-funroll-loops}
2995 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2996 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2997 but specific machines may handle it differently.
2999 You can use the following flags in the rare cases when ``fine-tuning''
3000 of optimizations to be performed is desired.
3002 @table @gcctabopt
3003 @item -fstrength-reduce
3004 Perform the optimizations of loop strength reduction and
3005 elimination of iteration variables.
3007 @item -fthread-jumps
3008 Perform optimizations where we check to see if a jump branches to a
3009 location where another comparison subsumed by the first is found.  If
3010 so, the first branch is redirected to either the destination of the
3011 second branch or a point immediately following it, depending on whether
3012 the condition is known to be true or false.
3014 @item -fcse-follow-jumps
3015 In common subexpression elimination, scan through jump instructions
3016 when the target of the jump is not reached by any other path.  For
3017 example, when CSE encounters an @code{if} statement with an
3018 @code{else} clause, CSE will follow the jump when the condition
3019 tested is false.
3021 @item -fcse-skip-blocks
3022 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
3023 follow jumps which conditionally skip over blocks.  When CSE
3024 encounters a simple @code{if} statement with no else clause,
3025 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
3026 body of the @code{if}.
3028 @item -frerun-cse-after-loop
3029 Re-run common subexpression elimination after loop optimizations has been
3030 performed.
3032 @item -frerun-loop-opt
3033 Run the loop optimizer twice.
3035 @item -fgcse
3036 Perform a global common subexpression elimination pass.
3037 This pass also performs global constant and copy propagation.
3039 @item -fdelete-null-pointer-checks
3040 Use global dataflow analysis to identify and eliminate useless null
3041 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
3042 halting the program may not work properly with this option.  Use
3043 -fno-delete-null-pointer-checks to disable this optimizing for programs
3044 which depend on that behavior.
3046 @item -fexpensive-optimizations
3047 Perform a number of minor optimizations that are relatively expensive.
3049 @item -foptimize-register-move
3050 @itemx -fregmove
3051 Attempt to reassign register numbers in move instructions and as
3052 operands of other simple instructions in order to maximize the amount of
3053 register tying.  This is especially helpful on machines with two-operand
3054 instructions.  GCC enables this optimization by default with @samp{-O2}
3055 or higher.
3057 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3058 optimization.
3060 @item -fdelayed-branch
3061 If supported for the target machine, attempt to reorder instructions
3062 to exploit instruction slots available after delayed branch
3063 instructions.
3065 @item -fschedule-insns
3066 If supported for the target machine, attempt to reorder instructions to
3067 eliminate execution stalls due to required data being unavailable.  This
3068 helps machines that have slow floating point or memory load instructions
3069 by allowing other instructions to be issued until the result of the load
3070 or floating point instruction is required.
3072 @item -fschedule-insns2
3073 Similar to @samp{-fschedule-insns}, but requests an additional pass of
3074 instruction scheduling after register allocation has been done.  This is
3075 especially useful on machines with a relatively small number of
3076 registers and where memory load instructions take more than one cycle.
3078 @item -ffunction-sections
3079 @itemx -fdata-sections
3080 Place each function or data item into its own section in the output
3081 file if the target supports arbitrary sections.  The name of the
3082 function or the name of the data item determines the section's name
3083 in the output file.
3085 Use these options on systems where the linker can perform optimizations
3086 to improve locality of reference in the instruction space.  HPPA
3087 processors running HP-UX and Sparc processors running Solaris 2 have
3088 linkers with such optimizations.  Other systems using the ELF object format
3089 as well as AIX may have these optimizations in the future.
3091 Only use these options when there are significant benefits from doing
3092 so.  When you specify these options, the assembler and linker will
3093 create larger object and executable files and will also be slower.
3094 You will not be able to use @code{gprof} on all systems if you
3095 specify this option and you may have problems with debugging if
3096 you specify both this option and @samp{-g}.
3098 @item -fcaller-saves
3099 Enable values to be allocated in registers that will be clobbered by
3100 function calls, by emitting extra instructions to save and restore the
3101 registers around such calls.  Such allocation is done only when it
3102 seems to result in better code than would otherwise be produced.
3104 This option is always enabled by default on certain machines, usually
3105 those which have no call-preserved registers to use instead.
3107 For all machines, optimization level 2 and higher enables this flag by
3108 default.
3110 @item -funroll-loops
3111 Perform the optimization of loop unrolling.  This is only done for loops
3112 whose number of iterations can be determined at compile time or run time.
3113 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
3114 @samp{-frerun-cse-after-loop}.
3116 @item -funroll-all-loops
3117 Perform the optimization of loop unrolling.  This is done for all loops
3118 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
3119 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3121 @item -fmove-all-movables
3122 Forces all invariant computations in loops to be moved
3123 outside the loop.
3125 @item -freduce-all-givs
3126 Forces all general-induction variables in loops to be
3127 strength-reduced.
3129 @emph{Note:} When compiling programs written in Fortran,
3130 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
3131 by default when you use the optimizer.
3133 These options may generate better or worse code; results are highly
3134 dependent on the structure of loops within the source code.
3136 These two options are intended to be removed someday, once
3137 they have helped determine the efficacy of various
3138 approaches to improving loop optimizations.
3140 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3141 know how use of these options affects
3142 the performance of your production code.
3143 We're very interested in code that runs @emph{slower}
3144 when these options are @emph{enabled}.
3146 @item -fno-peephole
3147 Disable any machine-specific peephole optimizations.
3149 @item -fbranch-probabilities
3150 After running a program compiled with @samp{-fprofile-arcs}
3151 (@pxref{Debugging Options,, Options for Debugging Your Program or
3152 @command{gcc}}), you can compile it a second time using
3153 @samp{-fbranch-probabilities}, to improve optimizations based on
3154 guessing the path a branch might take.
3156 @ifset INTERNALS
3157 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3158 note on the first instruction of each basic block, and a
3159 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3160 These can be used to improve optimization.  Currently, they are only
3161 used in one place: in @file{reorg.c}, instead of guessing which path a
3162 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3163 exactly determine which path is taken more often.
3164 @end ifset
3166 @item -fno-guess-branch-probability
3167 Sometimes gcc will opt to guess branch probabilities when none are
3168 available from either profile directed feedback (@samp{-fprofile-arcs})
3169 or @samp{__builtin_expect}.  In a hard real-time system, people don't
3170 want different runs of the compiler to produce code that has different
3171 behavior; minimizing non-determinism is of paramount import.  This
3172 switch allows users to reduce non-determinism, possibly at the expense
3173 of inferior optimization.
3175 @item -fstrict-aliasing
3176 Allows the compiler to assume the strictest aliasing rules applicable to
3177 the language being compiled.  For C (and C++), this activates
3178 optimizations based on the type of expressions.  In particular, an
3179 object of one type is assumed never to reside at the same address as an
3180 object of a different type, unless the types are almost the same.  For
3181 example, an @code{unsigned int} can alias an @code{int}, but not a
3182 @code{void*} or a @code{double}.  A character type may alias any other
3183 type.  
3185 Pay special attention to code like this:
3186 @example
3187 union a_union @{ 
3188   int i;
3189   double d;
3192 int f() @{
3193   a_union t;
3194   t.d = 3.0;
3195   return t.i;
3197 @end example
3198 The practice of reading from a different union member than the one most
3199 recently written to (called ``type-punning'') is common.  Even with
3200 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3201 is accessed through the union type.  So, the code above will work as
3202 expected.  However, this code might not:
3203 @example
3204 int f() @{ 
3205   a_union t;
3206   int* ip;
3207   t.d = 3.0;
3208   ip = &t.i;
3209   return *ip;
3211 @end example
3213 @ifset INTERNALS
3214 Every language that wishes to perform language-specific alias analysis
3215 should define a function that computes, given an @code{tree}
3216 node, an alias set for the node.  Nodes in different alias sets are not
3217 allowed to alias.  For an example, see the C front-end function
3218 @code{c_get_alias_set}.
3219 @end ifset
3221 @item -falign-functions
3222 @itemx -falign-functions=@var{n}
3223 Align the start of functions to the next power-of-two greater than
3224 @var{n}, skipping up to @var{n} bytes.  For instance,
3225 @samp{-falign-functions=32} aligns functions to the next 32-byte
3226 boundary, but @samp{-falign-functions=24} would align to the next
3227 32-byte boundary only if this can be done by skipping 23 bytes or less.
3229 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
3230 equivalent and mean that functions will not be aligned.
3232 Some assemblers only support this flag when @var{n} is a power of two;
3233 in that case, it is rounded up.
3235 If @var{n} is not specified, use a machine-dependent default.
3237 @item -falign-labels
3238 @itemx -falign-labels=@var{n}
3239 Align all branch targets to a power-of-two boundary, skipping up to
3240 @var{n} bytes like @samp{-falign-functions}.  This option can easily
3241 make code slower, because it must insert dummy operations for when the
3242 branch target is reached in the usual flow of the code.
3244 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3245 are greater than this value, then their values are used instead.
3247 If @var{n} is not specified, use a machine-dependent default which is
3248 very likely to be @samp{1}, meaning no alignment.
3250 @item -falign-loops
3251 @itemx -falign-loops=@var{n}
3252 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3253 like @samp{-falign-functions}.  The hope is that the loop will be
3254 executed many times, which will make up for any execution of the dummy
3255 operations.
3257 If @var{n} is not specified, use a machine-dependent default.
3259 @item -falign-jumps
3260 @itemx -falign-jumps=@var{n}
3261 Align branch targets to a power-of-two boundary, for branch targets
3262 where the targets can only be reached by jumping, skipping up to @var{n}
3263 bytes like @samp{-falign-functions}.  In this case, no dummy operations
3264 need be executed.
3266 If @var{n} is not specified, use a machine-dependent default.
3268 @item -fssa
3269 Perform optimizations in static single assignment form.  Each function's
3270 flow graph is translated into SSA form, optimizations are performed, and
3271 the flow graph is translated back from SSA form.  User's should not
3272 specify this option, since it is not yet ready for production use.
3274 @item -fdce
3275 Perform dead-code elimination in SSA form.  Requires @samp{-fssa}.  Like
3276 @samp{-fssa}, this is an experimental feature.
3278 @item -fsingle-precision-constant
3279 Treat floating point constant as single precision constant instead of
3280 implicitly converting it to double precision constant.
3282 @item -frename-registers
3283 Attempt to avoid false dependancies in scheduled code by making use
3284 of registers left over after register allocation.  This optimization
3285 will most benefit processors with lots of registers.  It can, however,
3286 make debugging impossible, since variables will no longer stay in
3287 a ``home register''.
3289 @item --param @var{name}=@var{value}
3290 In some places, GCC uses various constants to control the amount of
3291 optimization that is done.  For example, GCC will not inline functions
3292 that contain more that a certain number of instructions.  You can
3293 control some of these constants on the command-line using the
3294 @samp{--param} option.  
3296 In each case, the @var{value} is a integer.  The allowable choices for
3297 @var{name} are given in the following table:
3299 @table @gcctabopt
3300 @item max-inline-insns
3301 If an function contains more than this many instructions, it
3302 will not be inlined.  This option is precisely equivalent to
3303 @samp{-finline-limit}.
3304 @end table
3306 @end table
3308 @node Preprocessor Options
3309 @section Options Controlling the Preprocessor
3310 @cindex preprocessor options
3311 @cindex options, preprocessor
3313 These options control the C preprocessor, which is run on each C source
3314 file before actual compilation.
3316 If you use the @samp{-E} option, nothing is done except preprocessing.
3317 Some of these options make sense only together with @samp{-E} because
3318 they cause the preprocessor output to be unsuitable for actual
3319 compilation.
3321 @table @gcctabopt
3322 @item -include @var{file}
3323 Process @var{file} as input before processing the regular input file.
3324 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
3325 and @samp{-U} options on the command line are always processed before
3326 @samp{-include @var{file}}, regardless of the order in which they are
3327 written.  All the @samp{-include} and @samp{-imacros} options are
3328 processed in the order in which they are written.
3330 @item -imacros @var{file}
3331 Process @var{file} as input, discarding the resulting output, before
3332 processing the regular input file.  Because the output generated from
3333 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3334 is to make the macros defined in @var{file} available for use in the
3335 main input.  All the @samp{-include} and @samp{-imacros} options are
3336 processed in the order in which they are written.
3338 @item -idirafter @var{dir}
3339 @cindex second include path
3340 Add the directory @var{dir} to the second include path.  The directories
3341 on the second include path are searched when a header file is not found
3342 in any of the directories in the main include path (the one that
3343 @samp{-I} adds to).
3345 @item -iprefix @var{prefix}
3346 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3347 options.
3349 @item -iwithprefix @var{dir}
3350 Add a directory to the second include path.  The directory's name is
3351 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3352 specified previously with @samp{-iprefix}.  If you have not specified a
3353 prefix yet, the directory containing the installed passes of the
3354 compiler is used as the default.
3356 @item -iwithprefixbefore @var{dir}
3357 Add a directory to the main include path.  The directory's name is made
3358 by concatenating @var{prefix} and @var{dir}, as in the case of
3359 @samp{-iwithprefix}.
3361 @item -isystem @var{dir}
3362 Add a directory to the beginning of the second include path, marking it
3363 as a system directory, so that it gets the same special treatment as
3364 is applied to the standard system directories.
3366 @item -nostdinc
3367 Do not search the standard system directories for header files.  Only
3368 the directories you have specified with @samp{-I} options (and the
3369 current directory, if appropriate) are searched.  @xref{Directory
3370 Options}, for information on @samp{-I}.
3372 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3373 search path to only those directories you specify explicitly.
3375 @item -remap
3376 @findex -remap
3377 When searching for a header file in a directory, remap file names if a
3378 file named @file{header.gcc} exists in that directory.  This can be used
3379 to work around limitations of file systems with file name restrictions.
3380 The @file{header.gcc} file should contain a series of lines with two
3381 tokens on each line: the first token is the name to map, and the second
3382 token is the actual name to use.
3384 @item -undef
3385 Do not predefine any nonstandard macros.  (Including architecture flags).
3387 @item -E
3388 Run only the C preprocessor.  Preprocess all the C source files
3389 specified and output the results to standard output or to the
3390 specified output file.
3392 @item -C
3393 Tell the preprocessor not to discard comments.  Used with the
3394 @samp{-E} option.
3396 @item -P
3397 Tell the preprocessor not to generate @samp{#line} directives.
3398 Used with the @samp{-E} option.
3400 @cindex make
3401 @cindex dependencies, make
3402 @item -M
3403 @findex -M
3404 Instead of outputting the result of preprocessing, output a rule
3405 suitable for @code{make} describing the dependencies of the main source
3406 file.  The preprocessor outputs one @code{make} rule containing the
3407 object file name for that source file, a colon, and the names of all the
3408 included files.  Unless overridden explicitly, the object file name
3409 consists of the basename of the source file with any suffix replaced with
3410 object file suffix. If there are many included files then the
3411 rule is split into several lines using @samp{\}-newline.
3413 @samp{-M} implies @samp{-E}.
3415 @item -MM
3416 @findex -MM
3417 Like @samp{-M}, but mention only the files included with @samp{#include
3418 "@var{file}"}.  System header files included with @samp{#include
3419 <@var{file}>} are omitted.
3421 @item -MD
3422 @findex -MD
3423 Like @samp{-M} but the dependency information is written to a file
3424 rather than stdout.  @code{gcc} will use the same file name and
3425 directory as the object file, but with the suffix ".d" instead.
3427 This is in addition to compiling the main file as specified ---
3428 @samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3429 unless you also specify @samp{-MG}.
3431 With Mach, you can use the utility @code{md} to merge multiple
3432 dependency files into a single dependency file suitable for using with
3433 the @samp{make} command.
3435 @item -MMD
3436 @findex -MMD
3437 Like @samp{-MD} except mention only user header files, not system
3438 -header files.
3440 @item -MF @var{file}
3441 @findex -MF
3442 When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3443 dependencies to.  This allows the preprocessor to write the preprocessed
3444 file to stdout normally.  If no @samp{-MF} switch is given, CPP sends
3445 the rules to stdout and suppresses normal preprocessed output.
3447 Another way to specify output of a @code{make} rule is by setting
3448 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3449 Variables}).
3451 @item -MG
3452 @findex -MG
3453 When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3454 header files as generated files and assume they live in the same
3455 directory as the source file.  It suppresses preprocessed output, as a
3456 missing header file is ordinarily an error.
3458 This feature is used in automatic updating of makefiles.
3460 @item -MP
3461 @findex -MP
3462 This option instructs CPP to add a phony target for each dependency
3463 other than the main file, causing each to depend on nothing.  These
3464 dummy rules work around errors @code{make} gives if you remove header
3465 files without updating the @code{Makefile} to match.
3467 This is typical output:-
3469 @smallexample
3470 /tmp/test.o: /tmp/test.c /tmp/test.h
3472 /tmp/test.h:
3473 @end smallexample
3475 @item -MQ @var{target}
3476 @item -MT @var{target}
3477 @findex -MQ
3478 @findex -MT
3479 By default CPP uses the main file name, including any path, and appends
3480 the object suffix, normally ``.o'', to it to obtain the name of the
3481 target for dependency generation.  With @samp{-MT} you can specify a
3482 target yourself, overriding the default one.
3484 If you want multiple targets, you can specify them as a single argument
3485 to @samp{-MT}, or use multiple @samp{-MT} options.
3487 The targets you specify are output in the order they appear on the
3488 command line.  @samp{-MQ} is identical to @samp{-MT}, except that the
3489 target name is quoted for Make, but with @samp{-MT} it isn't.  For
3490 example, -MT '$(objpfx)foo.o' gives
3492 @smallexample
3493 $(objpfx)foo.o: /tmp/foo.c
3494 @end smallexample
3496 but -MQ '$(objpfx)foo.o' gives
3498 @smallexample
3499 $$(objpfx)foo.o: /tmp/foo.c
3500 @end smallexample
3502 The default target is automatically quoted, as if it were given with
3503 @samp{-MQ}.
3505 @item -H
3506 Print the name of each header file used, in addition to other normal
3507 activities.
3509 @item -A@var{question}(@var{answer})
3510 Assert the answer @var{answer} for @var{question}, in case it is tested
3511 with a preprocessing conditional such as @samp{#if
3512 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3513 assertions that normally describe the target machine.
3515 @item -D@var{macro}
3516 Define macro @var{macro} with the string @samp{1} as its definition.
3518 @item -D@var{macro}=@var{defn}
3519 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3520 the command line are processed before any @samp{-U} options.
3522 Any @samp{-D} and @samp{-U} options on the command line are processed in
3523 order, and always before @samp{-imacros @var{file}}, regardless of the
3524 order in which they are written.
3526 @item -U@var{macro}
3527 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3528 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3529 options.
3531 Any @samp{-D} and @samp{-U} options on the command line are processed in
3532 order, and always before @samp{-imacros @var{file}}, regardless of the
3533 order in which they are written.
3535 @item -dM
3536 Tell the preprocessor to output only a list of the macro definitions
3537 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3538 option.
3540 @item -dD
3541 Tell the preprocessing to pass all macro definitions into the output, in
3542 their proper sequence in the rest of the output.
3544 @item -dN
3545 Like @samp{-dD} except that the macro arguments and contents are omitted.
3546 Only @samp{#define @var{name}} is included in the output.
3548 @item -dI
3549 @findex -dI
3550 Output @samp{#include} directives in addition to the result of
3551 preprocessing.
3553 @item -trigraphs
3554 @findex -trigraphs
3555 Process ISO standard trigraph sequences.  These are three-character
3556 sequences, all starting with @samp{??}, that are defined by ISO C to
3557 stand for single characters.  For example, @samp{??/} stands for
3558 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
3559 default, GCC ignores trigraphs, but in standard-conforming modes it
3560 converts them.  See the @samp{-std} and @samp{-ansi} options.
3562 The nine trigraph sequences are
3563 @table @samp
3564 @item ??(
3565 -> @samp{[}
3567 @item ??)
3568 -> @samp{]}
3570 @item ??<
3571 -> @samp{@{}
3573 @item ??>
3574 -> @samp{@}}
3576 @item ??=
3577 -> @samp{#}
3579 @item ??/
3580 -> @samp{\}
3582 @item ??'
3583 -> @samp{^}
3585 @item ??!
3586 -> @samp{|}
3588 @item ??-
3589 -> @samp{~}
3591 @end table
3593 Trigraph support is not popular, so many compilers do not implement it
3594 properly.  Portable code should not rely on trigraphs being either
3595 converted or ignored.
3597 @item -Wp\,@var{option}
3598 Pass @var{option} as an option to the preprocessor.  If @var{option}
3599 contains commas, it is split into multiple options at the commas.
3600 @end table
3602 @node Assembler Options
3603 @section Passing Options to the Assembler
3605 @c prevent bad page break with this line
3606 You can pass options to the assembler.
3608 @table @gcctabopt
3609 @item -Wa\,@var{option}
3610 Pass @var{option} as an option to the assembler.  If @var{option}
3611 contains commas, it is split into multiple options at the commas.
3612 @end table
3614 @node Link Options
3615 @section Options for Linking
3616 @cindex link options
3617 @cindex options, linking
3619 These options come into play when the compiler links object files into
3620 an executable output file.  They are meaningless if the compiler is
3621 not doing a link step.
3623 @table @gcctabopt
3624 @cindex file names
3625 @item @var{object-file-name}
3626 A file name that does not end in a special recognized suffix is
3627 considered to name an object file or library.  (Object files are
3628 distinguished from libraries by the linker according to the file
3629 contents.)  If linking is done, these object files are used as input
3630 to the linker.
3632 @item -c
3633 @itemx -S
3634 @itemx -E
3635 If any of these options is used, then the linker is not run, and
3636 object file names should not be used as arguments.  @xref{Overall
3637 Options}.
3639 @cindex Libraries
3640 @item -l@var{library}
3641 Search the library named @var{library} when linking.
3643 It makes a difference where in the command you write this option; the
3644 linker searches processes libraries and object files in the order they
3645 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3646 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3647 to functions in @samp{z}, those functions may not be loaded.
3649 The linker searches a standard list of directories for the library,
3650 which is actually a file named @file{lib@var{library}.a}.  The linker
3651 then uses this file as if it had been specified precisely by name.
3653 The directories searched include several standard system directories
3654 plus any that you specify with @samp{-L}.
3656 Normally the files found this way are library files---archive files
3657 whose members are object files.  The linker handles an archive file by
3658 scanning through it for members which define symbols that have so far
3659 been referenced but not defined.  But if the file that is found is an
3660 ordinary object file, it is linked in the usual fashion.  The only
3661 difference between using an @samp{-l} option and specifying a file name
3662 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3663 and searches several directories.
3665 @item -lobjc
3666 You need this special case of the @samp{-l} option in order to
3667 link an Objective C program.
3669 @item -nostartfiles
3670 Do not use the standard system startup files when linking.
3671 The standard system libraries are used normally, unless @option{-nostdlib}
3672 or @option{-nodefaultlibs} is used.
3674 @item -nodefaultlibs
3675 Do not use the standard system libraries when linking.
3676 Only the libraries you specify will be passed to the linker.
3677 The standard startup files are used normally, unless @option{-nostartfiles}
3678 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3679 for System V (and ISO C) environments or to bcopy and bzero for
3680 BSD environments.  These entries are usually resolved by entries in
3681 libc.  These entry points should be supplied through some other
3682 mechanism when this option is specified.
3684 @item -nostdlib
3685 Do not use the standard system startup files or libraries when linking.
3686 No startup files and only the libraries you specify will be passed to
3687 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3688 for System V (and ISO C) environments or to bcopy and bzero for
3689 BSD environments.  These entries are usually resolved by entries in
3690 libc.  These entry points should be supplied through some other
3691 mechanism when this option is specified.
3693 @cindex @code{-lgcc}, use with @code{-nostdlib}
3694 @cindex @code{-nostdlib} and unresolved references
3695 @cindex unresolved references and @code{-nostdlib}
3696 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3697 @cindex @code{-nodefaultlibs} and unresolved references
3698 @cindex unresolved references and @code{-nodefaultlibs}
3699 One of the standard libraries bypassed by @samp{-nostdlib} and
3700 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3701 that GCC uses to overcome shortcomings of particular machines, or special
3702 needs for some languages.
3703 @ifset INTERNALS
3704 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3705 @file{libgcc.a}.)
3706 @end ifset
3707 @ifclear INTERNALS
3708 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3709 for more discussion of @file{libgcc.a}.)
3710 @end ifclear
3711 In most cases, you need @file{libgcc.a} even when you want to avoid
3712 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3713 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3714 This ensures that you have no unresolved references to internal GCC
3715 library subroutines.  (For example, @samp{__main}, used to ensure C++
3716 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
3718 @item -s
3719 Remove all symbol table and relocation information from the executable.
3721 @item -static
3722 On systems that support dynamic linking, this prevents linking with the shared
3723 libraries.  On other systems, this option has no effect.
3725 @item -shared
3726 Produce a shared object which can then be linked with other objects to
3727 form an executable.  Not all systems support this option.  For predictable
3728 results, you must also specify the same set of options that were used to 
3729 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3730 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
3731 needs to build supplementary stub code for constructors to work. On
3732 multi-libbed systems, @samp{gcc -shared} must select the correct support
3733 libraries to link against.  Failing to supply the correct flags may lead
3734 to subtle defects. Supplying them in cases where they are not necessary
3735 is innocuous.}
3737 @item -shared-libgcc
3738 @itemx -static-libgcc
3739 On systems that provide @file{libgcc} as a shared library, these options
3740 force the use of either the shared or static version respectively.
3741 If no shared version of @file{libgcc} was built when the compiler was
3742 configured, these options have no effect.
3744 There are several situations in which an application should use the
3745 shared @file{libgcc} instead of the static version.  The most common
3746 of these is when the application wishes to throw and catch exceptions
3747 across different shared libraries.  In that case, each of the libraries
3748 as well as the application itself should use the shared @file{libgcc}.
3750 Therefore, whenever you specify the @samp{-shared} option, the GCC
3751 driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3752 specify @samp{-static-libgcc}.  The G++ driver automatically adds
3753 @samp{-shared-libgcc} when you build a main executable as well because
3754 for C++ programs that is typically the right thing to do.
3755 (Exception-handling will not work reliably otherwise.)
3757 However, when linking a main executable written in C, you must
3758 explicitly say @samp{-shared-libgcc} if you want to use the shared
3759 @file{libgcc}.
3761 @item -symbolic
3762 Bind references to global symbols when building a shared object.  Warn
3763 about any unresolved references (unless overridden by the link editor
3764 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3765 this option.
3767 @item -Xlinker @var{option}
3768 Pass @var{option} as an option to the linker.  You can use this to
3769 supply system-specific linker options which GCC does not know how to
3770 recognize.
3772 If you want to pass an option that takes an argument, you must use
3773 @samp{-Xlinker} twice, once for the option and once for the argument.
3774 For example, to pass @samp{-assert definitions}, you must write
3775 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3776 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3777 string as a single argument, which is not what the linker expects.
3779 @item -Wl\,@var{option}
3780 Pass @var{option} as an option to the linker.  If @var{option} contains
3781 commas, it is split into multiple options at the commas.
3783 @item -u @var{symbol}
3784 Pretend the symbol @var{symbol} is undefined, to force linking of
3785 library modules to define it.  You can use @samp{-u} multiple times with
3786 different symbols to force loading of additional library modules.
3787 @end table
3789 @node Directory Options
3790 @section Options for Directory Search
3791 @cindex directory options
3792 @cindex options, directory search
3793 @cindex search path
3795 These options specify directories to search for header files, for
3796 libraries and for parts of the compiler:
3798 @table @gcctabopt
3799 @item -I@var{dir}
3800 Add the directory @var{dir} to the head of the list of directories to be
3801 searched for header files.  This can be used to override a system header
3802 file, substituting your own version, since these directories are
3803 searched before the system header file directories.  However, you should
3804 not use this option to add directories that contain vendor-supplied
3805 system header files (use @samp{-isystem} for that). If you use more than
3806 one @samp{-I} option, the directories are scanned in left-to-right
3807 order; the standard system directories come after.
3809 @item -I-
3810 Any directories you specify with @samp{-I} options before the @samp{-I-}
3811 option are searched only for the case of @samp{#include "@var{file}"};
3812 they are not searched for @samp{#include <@var{file}>}.
3814 If additional directories are specified with @samp{-I} options after
3815 the @samp{-I-}, these directories are searched for all @samp{#include}
3816 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3817 this way.)
3819 In addition, the @samp{-I-} option inhibits the use of the current
3820 directory (where the current input file came from) as the first search
3821 directory for @samp{#include "@var{file}"}.  There is no way to
3822 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3823 searching the directory which was current when the compiler was
3824 invoked.  That is not exactly the same as what the preprocessor does
3825 by default, but it is often satisfactory.
3827 @samp{-I-} does not inhibit the use of the standard system directories
3828 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3829 independent.
3831 @item -L@var{dir}
3832 Add directory @var{dir} to the list of directories to be searched
3833 for @samp{-l}.
3835 @item -B@var{prefix}
3836 This option specifies where to find the executables, libraries,
3837 include files, and data files of the compiler itself.
3839 The compiler driver program runs one or more of the subprograms
3840 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3841 @var{prefix} as a prefix for each program it tries to run, both with and
3842 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3844 For each subprogram to be run, the compiler driver first tries the
3845 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3846 was not specified, the driver tries two standard prefixes, which are
3847 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3848 those results in a file name that is found, the unmodified program
3849 name is searched for using the directories specified in your
3850 @env{PATH} environment variable.
3852 @samp{-B} prefixes that effectively specify directory names also apply
3853 to libraries in the linker, because the compiler translates these
3854 options into @samp{-L} options for the linker.  They also apply to
3855 includes files in the preprocessor, because the compiler translates these
3856 options into @samp{-isystem} options for the preprocessor.  In this case,
3857 the compiler appends @samp{include} to the prefix.
3859 The run-time support file @file{libgcc.a} can also be searched for using
3860 the @samp{-B} prefix, if needed.  If it is not found there, the two
3861 standard prefixes above are tried, and that is all.  The file is left
3862 out of the link if it is not found by those means.
3864 Another way to specify a prefix much like the @samp{-B} prefix is to use
3865 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
3866 Variables}.
3868 @item -specs=@var{file}
3869 Process @var{file} after the compiler reads in the standard @file{specs}
3870 file, in order to override the defaults that the @file{gcc} driver
3871 program uses when determining what switches to pass to @file{cc1},
3872 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3873 @samp{-specs=}@var{file} can be specified on the command line, and they
3874 are processed in order, from left to right.
3875 @end table
3877 @c man end
3879 @node Spec Files
3880 @section Specifying subprocesses and the switches to pass to them
3881 @cindex Spec Files
3882 @command{gcc} is a driver program.  It performs its job by invoking a
3883 sequence of other programs to do the work of compiling, assembling and
3884 linking.  GCC interprets its command-line parameters and uses these to
3885 deduce which programs it should invoke, and which command-line options
3886 it ought to place on their command lines.  This behaviour is controlled
3887 by @dfn{spec strings}.  In most cases there is one spec string for each
3888 program that GCC can invoke, but a few programs have multiple spec
3889 strings to control their behaviour.  The spec strings built into GCC can
3890 be overridden by using the @samp{-specs=} command-line switch to specify
3891 a spec file.
3893 @dfn{Spec files} are plaintext files that are used to construct spec
3894 strings.  They consist of a sequence of directives separated by blank
3895 lines.  The type of directive is determined by the first non-whitespace
3896 character on the line and it can be one of the following:
3898 @table @code
3899 @item %@var{command}
3900 Issues a @var{command} to the spec file processor.  The commands that can
3901 appear here are: 
3903 @table @code
3904 @item %include <@var{file}>
3905 @cindex %include
3906 Search for @var{file} and insert its text at the current point in the
3907 specs file.
3909 @item %include_noerr <@var{file}>
3910 @cindex %include_noerr
3911 Just like @samp{%include}, but do not generate an error message if the include
3912 file cannot be found.
3914 @item %rename @var{old_name} @var{new_name}
3915 @cindex %rename
3916 Rename the spec string @var{old_name} to @var{new_name}.
3918 @end table
3920 @item *[@var{spec_name}]:
3921 This tells the compiler to create, override or delete the named spec
3922 string.  All lines after this directive up to the next directive or
3923 blank line are considered to be the text for the spec string.  If this
3924 results in an empty string then the spec will be deleted.  (Or, if the
3925 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3926 does not currently exist a new spec will be created.  If the spec does
3927 exist then its contents will be overridden by the text of this
3928 directive, unless the first character of that text is the @samp{+}
3929 character, in which case the text will be appended to the spec.
3931 @item [@var{suffix}]:
3932 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3933 and up to the next directive or blank line are considered to make up the
3934 spec string for the indicated suffix.  When the compiler encounters an 
3935 input file with the named suffix, it will processes the spec string in
3936 order to work out how to compile that file.  For example:
3938 @smallexample
3939 .ZZ:
3940 z-compile -input %i
3941 @end smallexample
3943 This says that any input file whose name ends in @samp{.ZZ} should be
3944 passed to the program @samp{z-compile}, which should be invoked with the
3945 command-line switch @samp{-input} and with the result of performing the
3946 @samp{%i} substitution.  (See below.)
3948 As an alternative to providing a spec string, the text that follows a
3949 suffix directive can be one of the following:
3951 @table @code
3952 @item @@@var{language}
3953 This says that the suffix is an alias for a known @var{language}.  This is
3954 similar to using the @option{-x} command-line switch to GCC to specify a
3955 language explicitly.  For example:
3957 @smallexample
3958 .ZZ:
3959 @@c++
3960 @end smallexample
3962 Says that .ZZ files are, in fact, C++ source files.
3964 @item #@var{name}
3965 This causes an error messages saying:
3967 @smallexample
3968 @var{name} compiler not installed on this system.
3969 @end smallexample
3970 @end table
3972 GCC already has an extensive list of suffixes built into it.
3973 This directive will add an entry to the end of the list of suffixes, but
3974 since the list is searched from the end backwards, it is effectively
3975 possible to override earlier entries using this technique.
3977 @end table
3979 GCC has the following spec strings built into it.  Spec files can
3980 override these strings or create their own.  Note that individual
3981 targets can also add their own spec strings to this list. 
3983 @smallexample
3984 asm          Options to pass to the assembler
3985 asm_final    Options to pass to the assembler post-processor
3986 cpp          Options to pass to the C preprocessor
3987 cc1          Options to pass to the C compiler
3988 cc1plus      Options to pass to the C++ compiler
3989 endfile      Object files to include at the end of the link
3990 link         Options to pass to the linker
3991 lib          Libraries to include on the command line to the linker
3992 libgcc       Decides which GCC support library to pass to the linker
3993 linker       Sets the name of the linker
3994 predefines   Defines to be passed to the C preprocessor
3995 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3996 startfile    Object files to include at the start of the link
3997 @end smallexample
3999 Here is a small example of a spec file:
4001 @smallexample
4002 %rename lib                 old_lib
4004 *lib:
4005 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4006 @end smallexample
4008 This example renames the spec called @samp{lib} to @samp{old_lib} and
4009 then overrides the previous definition of @samp{lib} with a new one.
4010 The new definition adds in some extra command-line options before
4011 including the text of the old definition.
4013 @dfn{Spec strings} are a list of command-line options to be passed to their
4014 corresponding program.  In addition, the spec strings can contain
4015 @samp{%}-prefixed sequences to substitute variable text or to
4016 conditionally insert text into the command line.  Using these constructs
4017 it is possible to generate quite complex command lines.
4019 Here is a table of all defined @samp{%}-sequences for spec
4020 strings.  Note that spaces are not generated automatically around the
4021 results of expanding these sequences.  Therefore you can concatenate them
4022 together or combine them with constant text in a single argument. 
4024 @table @code
4025 @item %%
4026 Substitute one @samp{%} into the program name or argument.
4028 @item %i
4029 Substitute the name of the input file being processed.
4031 @item %b
4032 Substitute the basename of the input file being processed.
4033 This is the substring up to (and not including) the last period
4034 and not including the directory.
4036 @item %B
4037 This is the same as @samp{%b}, but include the file suffix (text after
4038 the last period).
4040 @item %d
4041 Marks the argument containing or following the @samp{%d} as a
4042 temporary file name, so that that file will be deleted if GCC exits
4043 successfully.  Unlike @samp{%g}, this contributes no text to the
4044 argument. 
4046 @item %g@var{suffix}
4047 Substitute a file name that has suffix @var{suffix} and is chosen
4048 once per compilation, and mark the argument in the same way as
4049 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4050 name is now chosen in a way that is hard to predict even when previously 
4051 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
4052 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4053 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4054 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4055 was simply substituted with a file name chosen once per compilation,
4056 without regard to any appended suffix (which was therefore treated
4057 just like ordinary text), making such attacks more likely to succeed.
4059 @item %u@var{suffix}
4060 Like @samp{%g}, but generates a new temporary file name even if
4061 @samp{%u@var{suffix}} was already seen.
4063 @item %U@var{suffix}
4064 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4065 new one if there is no such last file name.  In the absence of any
4066 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4067 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4068 would involve the generation of two distinct file names, one
4069 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4070 simply substituted with a file name chosen for the previous @samp{%u},
4071 without regard to any appended suffix.
4073 @item %j@var{SUFFIX}
4074 Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is 
4075 writable, and if save-temps is off; otherwise, substitute the name
4076 of a temporary file, just like @samp{%u}.  This temporary file is not
4077 meant for communication between processes, but rather as a junk
4078 disposal mechanism.
4080 @item %.@var{SUFFIX}
4081 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4082 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4083 terminated by the next space or %.
4085 @item %w
4086 Marks the argument containing or following the @samp{%w} as the
4087 designated output file of this compilation.  This puts the argument
4088 into the sequence of arguments that @samp{%o} will substitute later.
4090 @item %o
4091 Substitutes the names of all the output files, with spaces
4092 automatically placed around them.  You should write spaces
4093 around the @samp{%o} as well or the results are undefined.
4094 @samp{%o} is for use in the specs for running the linker.
4095 Input files whose names have no recognized suffix are not compiled
4096 at all, but they are included among the output files, so they will
4097 be linked.
4099 @item %O
4100 Substitutes the suffix for object files.  Note that this is
4101 handled specially when it immediately follows @samp{%g, %u, or %U},
4102 because of the need for those to form complete file names.  The
4103 handling is such that @samp{%O} is treated exactly as if it had already
4104 been substituted, except that @samp{%g, %u, and %U} do not currently
4105 support additional @var{suffix} characters following @samp{%O} as they would
4106 following, for example, @samp{.o}.
4108 @item %p
4109 Substitutes the standard macro predefinitions for the
4110 current target machine.  Use this when running @code{cpp}.
4112 @item %P
4113 Like @samp{%p}, but puts @samp{__} before and after the name of each
4114 predefined macro, except for macros that start with @samp{__} or with
4115 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4116 C.  
4118 @item %I
4119 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4121 @item %s
4122 Current argument is the name of a library or startup file of some sort.
4123 Search for that file in a standard list of directories and substitute
4124 the full name found. 
4126 @item %e@var{str}
4127 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4128 Use this when inconsistent options are detected.
4130 @item %|
4131 Output @samp{-} if the input for the current command is coming from a pipe.
4133 @item %(@var{name})
4134 Substitute the contents of spec string @var{name} at this point.
4136 @item %[@var{name}]
4137 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4139 @item %x@{@var{option}@}
4140 Accumulate an option for @samp{%X}.
4142 @item %X
4143 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4144 spec string.
4146 @item %Y
4147 Output the accumulated assembler options specified by @samp{-Wa}.
4149 @item %Z
4150 Output the accumulated preprocessor options specified by @samp{-Wp}.
4152 @item %v1
4153 Substitute the major version number of GCC.
4154 (For version 2.9.5, this is 2.)
4156 @item %v2
4157 Substitute the minor version number of GCC.
4158 (For version 2.9.5, this is 9.)
4160 @item %v3
4161 Substitute the patch level number of GCC.
4162 (For version 2.9.5, this is 5.)
4164 @item %a
4165 Process the @code{asm} spec.  This is used to compute the
4166 switches to be passed to the assembler.
4168 @item %A
4169 Process the @code{asm_final} spec.  This is a spec string for
4170 passing switches to an assembler post-processor, if such a program is
4171 needed.
4173 @item %l
4174 Process the @code{link} spec.  This is the spec for computing the
4175 command line passed to the linker.  Typically it will make use of the
4176 @samp{%L %G %S %D and %E} sequences.
4178 @item %D
4179 Dump out a @samp{-L} option for each directory that GCC believes might
4180 contain startup files.  If the target supports multilibs then the
4181 current multilib directory will be prepended to each of these paths. 
4183 @item %M
4184 Output the multilib directory with directory seperators replaced with
4185 "_".  If multilib directories are not set, or the multilib directory is
4186 "." then this option emits nothing.
4188 @item %L
4189 Process the @code{lib} spec.  This is a spec string for deciding which
4190 libraries should be included on the command line to the linker. 
4192 @item %G
4193 Process the @code{libgcc} spec.  This is a spec string for deciding
4194 which GCC support library should be included on the command line to the linker. 
4196 @item %S
4197 Process the @code{startfile} spec.  This is a spec for deciding which
4198 object files should be the first ones passed to the linker.  Typically
4199 this might be a file named @file{crt0.o}. 
4201 @item %E
4202 Process the @code{endfile} spec.  This is a spec string that specifies
4203 the last object files that will be passed to the linker.  
4205 @item %C
4206 Process the @code{cpp} spec.  This is used to construct the arguments
4207 to be passed to the C preprocessor.
4209 @item %c
4210 Process the @code{signed_char} spec.  This is intended to be used
4211 to tell cpp whether a char is signed.  It typically has the definition: 
4212 @smallexample
4213 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4214 @end smallexample
4216 @item %1
4217 Process the @code{cc1} spec.  This is used to construct the options to be
4218 passed to the actual C compiler (@samp{cc1}).
4220 @item %2
4221 Process the @code{cc1plus} spec.  This is used to construct the options to be
4222 passed to the actual C++ compiler (@samp{cc1plus}).
4224 @item %*
4225 Substitute the variable part of a matched option.  See below.
4226 Note that each comma in the substituted string is replaced by
4227 a single space.
4229 @item %@{@code{S}@}
4230 Substitutes the @code{-S} switch, if that switch was given to GCC.
4231 If that switch was not specified, this substitutes nothing.  Note that
4232 the leading dash is omitted when specifying this option, and it is
4233 automatically inserted if the substitution is performed.  Thus the spec
4234 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4235 and would output the command line option @samp{-foo}.
4237 @item %W@{@code{S}@}
4238 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4239 deleted on failure. 
4241 @item %@{@code{S}*@}
4242 Substitutes all the switches specified to GCC whose names start
4243 with @code{-S}, but which also take an argument.  This is used for
4244 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
4245 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4246 text, including the space.  Thus two arguments would be generated. 
4248 @item %@{^@code{S}*@}
4249 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4250 argument.  Thus %@{^o*@} would only generate one argument, not two.
4252 @item %@{@code{S}*&@code{T}*@}
4253 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4254 (the order of @code{S} and @code{T} in the spec is not significant).
4255 There can be any number of ampersand-separated variables; for each the
4256 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4258 @item %@{<@code{S}@}
4259 Remove all occurrences of @code{-S} from the command line.  Note - this
4260 command is position dependent.  @samp{%} commands in the spec string
4261 before this option will see @code{-S}, @samp{%} commands in the spec
4262 string after this option will not.
4264 @item %@{@code{S}*:@code{X}@}
4265 Substitutes @code{X} if one or more switches whose names start with
4266 @code{-S} are specified to GCC.  Note that the tail part of the
4267 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4268 for each occurrence of @samp{%*} within @code{X}. 
4270 @item %@{@code{S}:@code{X}@}
4271 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4273 @item %@{!@code{S}:@code{X}@}
4274 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4276 @item %@{|@code{S}:@code{X}@}
4277 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4279 @item %@{|!@code{S}:@code{X}@}
4280 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4282 @item %@{.@code{S}:@code{X}@}
4283 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4285 @item %@{!.@code{S}:@code{X}@}
4286 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4288 @item %@{@code{S}|@code{P}:@code{X}@}
4289 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
4290 combined with @samp{!} and @samp{.} sequences as well, although they
4291 have a stronger binding than the @samp{|}.  For example a spec string
4292 like this:
4294 @smallexample
4295 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4296 @end smallexample
4298 will output the following command-line options from the following input
4299 command-line options:
4301 @smallexample
4302 fred.c        -foo -baz
4303 jim.d         -bar -boggle
4304 -d fred.c     -foo -baz -boggle
4305 -d jim.d      -bar -baz -boggle
4306 @end smallexample
4308 @end table
4310 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4311 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4312 or spaces, or even newlines.  They are processed as usual, as described
4313 above. 
4315 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4316 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4317 -W} switch is found later in the command line, the earlier switch
4318 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4319 letter, which passes all matching options.
4321 The character @samp{|} at the beginning of the predicate text is used to indicate
4322 that a command should be piped to the following command, but only if @samp{-pipe}
4323 is specified.
4325 It is built into GCC which switches take arguments and which do not.
4326 (You might think it would be useful to generalize this to allow each
4327 compiler's spec to say which switches take arguments.  But this cannot
4328 be done in a consistent fashion.  GCC cannot even decide which input
4329 files have been specified without knowing which switches take arguments,
4330 and it must know which input files to compile in order to tell which
4331 compilers to run). 
4333 GCC also knows implicitly that arguments starting in @samp{-l} are to be
4334 treated as compiler output files, and passed to the linker in their
4335 proper position among the other output files.
4337 @c man begin OPTIONS
4339 @node Target Options
4340 @section Specifying Target Machine and Compiler Version
4341 @cindex target options
4342 @cindex cross compiling
4343 @cindex specifying machine version
4344 @cindex specifying compiler version and target machine
4345 @cindex compiler version, specifying
4346 @cindex target machine, specifying
4348 By default, GCC compiles code for the same type of machine that you
4349 are using.  However, it can also be installed as a cross-compiler, to
4350 compile for some other type of machine.  In fact, several different
4351 configurations of GCC, for different target machines, can be
4352 installed side by side.  Then you specify which one to use with the
4353 @samp{-b} option.
4355 In addition, older and newer versions of GCC can be installed side
4356 by side.  One of them (probably the newest) will be the default, but
4357 you may sometimes wish to use another.
4359 @table @gcctabopt
4360 @item -b @var{machine}
4361 The argument @var{machine} specifies the target machine for compilation.
4362 This is useful when you have installed GCC as a cross-compiler.
4364 The value to use for @var{machine} is the same as was specified as the
4365 machine type when configuring GCC as a cross-compiler.  For
4366 example, if a cross-compiler was configured with @samp{configure
4367 i386v}, meaning to compile for an 80386 running System V, then you
4368 would specify @samp{-b i386v} to run that cross compiler.
4370 When you do not specify @samp{-b}, it normally means to compile for
4371 the same type of machine that you are using.
4373 @item -V @var{version}
4374 The argument @var{version} specifies which version of GCC to run.
4375 This is useful when multiple versions are installed.  For example,
4376 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4378 The default version, when you do not specify @samp{-V}, is the last
4379 version of GCC that you installed.
4380 @end table
4382 The @samp{-b} and @samp{-V} options actually work by controlling part of
4383 the file name used for the executable files and libraries used for
4384 compilation.  A given version of GCC, for a given target machine, is
4385 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4387 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4388 changing the names of these directories or adding alternate names (or
4389 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4390 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
4391 80386} becomes an alias for @samp{-b i386v}.
4393 In one respect, the @samp{-b} or @samp{-V} do not completely change
4394 to a different compiler: the top-level driver program @command{gcc}
4395 that you originally invoked continues to run and invoke the other
4396 executables (preprocessor, compiler per se, assembler and linker)
4397 that do the real work.  However, since no real work is done in the
4398 driver program, it usually does not matter that the driver program
4399 in use is not the one for the specified target.  It is common for the
4400 interface to the other executables to change incompatibly between
4401 compiler versions, so unless the version specified is very close to that
4402 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4403 version 3.0.1), use of @samp{-V} may not work; for example, using
4404 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
4406 The only way that the driver program depends on the target machine is
4407 in the parsing and handling of special machine-specific options.
4408 However, this is controlled by a file which is found, along with the
4409 other executables, in the directory for the specified version and
4410 target machine.  As a result, a single installed driver program adapts
4411 to any specified target machine, and sufficiently similar compiler
4412 versions.
4414 The driver program executable does control one significant thing,
4415 however: the default version and target machine.  Therefore, you can
4416 install different instances of the driver program, compiled for
4417 different targets or versions, under different names.
4419 For example, if the driver for version 2.0 is installed as @command{ogcc}
4420 and that for version 2.1 is installed as @command{gcc}, then the command
4421 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
4422 2.0 by default.  However, you can choose either version with either
4423 command with the @samp{-V} option.
4425 @node Submodel Options
4426 @section Hardware Models and Configurations
4427 @cindex submodel options
4428 @cindex specifying hardware config
4429 @cindex hardware models and configurations, specifying
4430 @cindex machine dependent options
4432 Earlier we discussed the standard option @samp{-b} which chooses among
4433 different installed compilers for completely different target
4434 machines, such as Vax vs. 68000 vs. 80386.
4436 In addition, each of these target machine types can have its own
4437 special options, starting with @samp{-m}, to choose among various
4438 hardware models or configurations---for example, 68010 vs 68020,
4439 floating coprocessor or none.  A single installed version of the
4440 compiler can compile for any model or configuration, according to the
4441 options specified.
4443 Some configurations of the compiler also support additional special
4444 options, usually for compatibility with other compilers on the same
4445 platform.
4447 @ifset INTERNALS
4448 These options are defined by the macro @code{TARGET_SWITCHES} in the
4449 machine description.  The default for the options is also defined by
4450 that macro, which enables you to change the defaults.
4451 @end ifset
4453 @menu
4454 * M680x0 Options::
4455 * M68hc1x Options::
4456 * VAX Options::
4457 * SPARC Options::
4458 * Convex Options::
4459 * AMD29K Options::
4460 * ARM Options::
4461 * Thumb Options::
4462 * MN10200 Options::
4463 * MN10300 Options::
4464 * M32R/D Options::
4465 * M88K Options::
4466 * RS/6000 and PowerPC Options::
4467 * RT Options::
4468 * MIPS Options::
4469 * i386 Options::
4470 * HPPA Options::
4471 * Intel 960 Options::
4472 * DEC Alpha Options::
4473 * Clipper Options::
4474 * H8/300 Options::
4475 * SH Options::
4476 * System V Options::
4477 * TMS320C3x/C4x Options::
4478 * V850 Options::
4479 * ARC Options::
4480 * NS32K Options::
4481 * AVR Options::
4482 * MCore Options::
4483 * IA-64 Options::
4484 * D30V Options::
4485 @end menu
4487 @node M680x0 Options
4488 @subsection M680x0 Options
4489 @cindex M680x0 options
4491 These are the @samp{-m} options defined for the 68000 series.  The default
4492 values for these options depends on which style of 68000 was selected when
4493 the compiler was configured; the defaults for the most common choices are
4494 given below.
4496 @table @gcctabopt
4497 @item -m68000
4498 @itemx -mc68000
4499 Generate output for a 68000.  This is the default
4500 when the compiler is configured for 68000-based systems.
4502 Use this option for microcontrollers with a 68000 or EC000 core,
4503 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4505 @item -m68020
4506 @itemx -mc68020
4507 Generate output for a 68020.  This is the default
4508 when the compiler is configured for 68020-based systems.
4510 @item -m68881
4511 Generate output containing 68881 instructions for floating point.
4512 This is the default for most 68020 systems unless @samp{-nfp} was
4513 specified when the compiler was configured.
4515 @item -m68030
4516 Generate output for a 68030.  This is the default when the compiler is
4517 configured for 68030-based systems.
4519 @item -m68040
4520 Generate output for a 68040.  This is the default when the compiler is
4521 configured for 68040-based systems.
4523 This option inhibits the use of 68881/68882 instructions that have to be
4524 emulated by software on the 68040.  Use this option if your 68040 does not
4525 have code to emulate those instructions.
4527 @item -m68060
4528 Generate output for a 68060.  This is the default when the compiler is
4529 configured for 68060-based systems.
4531 This option inhibits the use of 68020 and 68881/68882 instructions that
4532 have to be emulated by software on the 68060.  Use this option if your 68060
4533 does not have code to emulate those instructions.
4535 @item -mcpu32
4536 Generate output for a CPU32. This is the default
4537 when the compiler is configured for CPU32-based systems.
4539 Use this option for microcontrollers with a
4540 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4541 68336, 68340, 68341, 68349 and 68360.
4543 @item -m5200
4544 Generate output for a 520X "coldfire" family cpu.  This is the default
4545 when the compiler is configured for 520X-based systems.
4547 Use this option for microcontroller with a 5200 core, including 
4548 the MCF5202, MCF5203, MCF5204 and MCF5202.
4551 @item -m68020-40
4552 Generate output for a 68040, without using any of the new instructions.
4553 This results in code which can run relatively efficiently on either a
4554 68020/68881 or a 68030 or a 68040.  The generated code does use the
4555 68881 instructions that are emulated on the 68040.
4557 @item -m68020-60
4558 Generate output for a 68060, without using any of the new instructions.
4559 This results in code which can run relatively efficiently on either a
4560 68020/68881 or a 68030 or a 68040.  The generated code does use the
4561 68881 instructions that are emulated on the 68060.
4563 @item -mfpa
4564 Generate output containing Sun FPA instructions for floating point.
4566 @item -msoft-float
4567 Generate output containing library calls for floating point.
4568 @strong{Warning:} the requisite libraries are not available for all m68k
4569 targets.  Normally the facilities of the machine's usual C compiler are
4570 used, but this can't be done directly in cross-compilation.  You must
4571 make your own arrangements to provide suitable library functions for
4572 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
4573 @samp{m68k-*-coff} do provide software floating point support.
4575 @item -mshort
4576 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4578 @item -mnobitfield
4579 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
4580 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4582 @item -mbitfield
4583 Do use the bit-field instructions.  The @samp{-m68020} option implies
4584 @samp{-mbitfield}.  This is the default if you use a configuration
4585 designed for a 68020.
4587 @item -mrtd
4588 Use a different function-calling convention, in which functions
4589 that take a fixed number of arguments return with the @code{rtd}
4590 instruction, which pops their arguments while returning.  This
4591 saves one instruction in the caller since there is no need to pop
4592 the arguments there.
4594 This calling convention is incompatible with the one normally
4595 used on Unix, so you cannot use it if you need to call libraries
4596 compiled with the Unix compiler.
4598 Also, you must provide function prototypes for all functions that
4599 take variable numbers of arguments (including @code{printf});
4600 otherwise incorrect code will be generated for calls to those
4601 functions.
4603 In addition, seriously incorrect code will result if you call a
4604 function with too many arguments.  (Normally, extra arguments are
4605 harmlessly ignored.)
4607 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4608 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4610 @item -malign-int
4611 @itemx -mno-align-int
4612 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4613 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4614 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4615 Aligning variables on 32-bit boundaries produces code that runs somewhat
4616 faster on processors with 32-bit busses at the expense of more memory.
4618 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4619 align structures containing the above types  differently than
4620 most published application binary interface specifications for the m68k.
4622 @item -mpcrel
4623 Use the pc-relative addressing mode of the 68000 directly, instead of
4624 using a global offset table.  At present, this option implies -fpic,
4625 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4626 not presently supported with -mpcrel, though this could be supported for
4627 68020 and higher processors.
4629 @item -mno-strict-align
4630 @itemx -mstrict-align
4631 @kindex -mstrict-align
4632 Do not (do) assume that unaligned memory references will be handled by
4633 the system.
4635 @end table
4637 @node M68hc1x Options
4638 @subsection M68hc1x Options
4639 @cindex M68hc1x options
4641 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4642 microcontrollers.  The default values for these options depends on 
4643 which style of microcontroller was selected when the compiler was configured;
4644 the defaults for the most common choices are given below.
4646 @table @gcctabopt
4647 @item -m6811
4648 @itemx -m68hc11
4649 Generate output for a 68HC11.  This is the default
4650 when the compiler is configured for 68HC11-based systems.
4652 @item -m6812
4653 @itemx -m68hc12
4654 Generate output for a 68HC12.  This is the default
4655 when the compiler is configured for 68HC12-based systems.
4657 @item -mauto-incdec
4658 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4659 addressing modes.
4661 @item -mshort
4662 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4664 @item -msoft-reg-count=@var{count}
4665 Specify the number of pseudo-soft registers which are used for the
4666 code generation.  The maximum number is 32.  Using more pseudo-soft
4667 register may or may not result in better code depending on the program.
4668 The default is 4 for 68HC11 and 2 for 68HC12.
4670 @end table
4672 @node VAX Options
4673 @subsection VAX Options
4674 @cindex VAX options
4676 These @samp{-m} options are defined for the Vax:
4678 @table @gcctabopt
4679 @item -munix
4680 Do not output certain jump instructions (@code{aobleq} and so on)
4681 that the Unix assembler for the Vax cannot handle across long
4682 ranges.
4684 @item -mgnu
4685 Do output those jump instructions, on the assumption that you
4686 will assemble with the GNU assembler.
4688 @item -mg
4689 Output code for g-format floating point numbers instead of d-format.
4690 @end table
4692 @node SPARC Options
4693 @subsection SPARC Options
4694 @cindex SPARC options
4696 These @samp{-m} switches are supported on the SPARC:
4698 @table @gcctabopt
4699 @item -mno-app-regs
4700 @itemx -mapp-regs
4701 Specify @samp{-mapp-regs} to generate output using the global registers
4702 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4703 is the default.
4705 To be fully SVR4 ABI compliant at the cost of some performance loss,
4706 specify @samp{-mno-app-regs}.  You should compile libraries and system
4707 software with this option.
4709 @item -mfpu
4710 @itemx -mhard-float
4711 Generate output containing floating point instructions.  This is the
4712 default.
4714 @item -mno-fpu
4715 @itemx -msoft-float
4716 Generate output containing library calls for floating point.
4717 @strong{Warning:} the requisite libraries are not available for all SPARC
4718 targets.  Normally the facilities of the machine's usual C compiler are
4719 used, but this cannot be done directly in cross-compilation.  You must make
4720 your own arrangements to provide suitable library functions for
4721 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4722 @samp{sparclite-*-*} do provide software floating point support.
4724 @samp{-msoft-float} changes the calling convention in the output file;
4725 therefore, it is only useful if you compile @emph{all} of a program with
4726 this option.  In particular, you need to compile @file{libgcc.a}, the
4727 library that comes with GCC, with @samp{-msoft-float} in order for
4728 this to work.
4730 @item -mhard-quad-float
4731 Generate output containing quad-word (long double) floating point
4732 instructions.
4734 @item -msoft-quad-float
4735 Generate output containing library calls for quad-word (long double)
4736 floating point instructions.  The functions called are those specified
4737 in the SPARC ABI.  This is the default.
4739 As of this writing, there are no sparc implementations that have hardware
4740 support for the quad-word floating point instructions.  They all invoke
4741 a trap handler for one of these instructions, and then the trap handler
4742 emulates the effect of the instruction.  Because of the trap handler overhead,
4743 this is much slower than calling the ABI library routines.  Thus the
4744 @samp{-msoft-quad-float} option is the default.
4746 @item -mno-epilogue
4747 @itemx -mepilogue
4748 With @samp{-mepilogue} (the default), the compiler always emits code for
4749 function exit at the end of each function.  Any function exit in
4750 the middle of the function (such as a return statement in C) will
4751 generate a jump to the exit code at the end of the function.
4753 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4754 at every function exit.
4756 @item -mno-flat
4757 @itemx -mflat
4758 With @samp{-mflat}, the compiler does not generate save/restore instructions
4759 and will use a "flat" or single register window calling convention.
4760 This model uses %i7 as the frame pointer and is compatible with the normal
4761 register window model.  Code from either may be intermixed.
4762 The local registers and the input registers (0-5) are still treated as
4763 "call saved" registers and will be saved on the stack as necessary.
4765 With @samp{-mno-flat} (the default), the compiler emits save/restore
4766 instructions (except for leaf functions) and is the normal mode of operation.
4768 @item -mno-unaligned-doubles
4769 @itemx -munaligned-doubles
4770 Assume that doubles have 8 byte alignment.  This is the default.
4772 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4773 alignment only if they are contained in another type, or if they have an
4774 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4775 Specifying this option avoids some rare compatibility problems with code
4776 generated by other compilers.  It is not the default because it results
4777 in a performance loss, especially for floating point code.
4779 @item -mno-faster-structs
4780 @itemx -mfaster-structs
4781 With @samp{-mfaster-structs}, the compiler assumes that structures
4782 should have 8 byte alignment.  This enables the use of pairs of
4783 @code{ldd} and @code{std} instructions for copies in structure
4784 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4785 However, the use of this changed alignment directly violates the Sparc
4786 ABI.  Thus, it's intended only for use on targets where the developer
4787 acknowledges that their resulting code will not be directly in line with
4788 the rules of the ABI.
4790 @item -mv8
4791 @itemx -msparclite
4792 These two options select variations on the SPARC architecture.
4794 By default (unless specifically configured for the Fujitsu SPARClite),
4795 GCC generates code for the v7 variant of the SPARC architecture.
4797 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4798 code is that the compiler emits the integer multiply and integer
4799 divide instructions which exist in SPARC v8 but not in SPARC v7.
4801 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4802 multiply, integer divide step and scan (@code{ffs}) instructions which
4803 exist in SPARClite but not in SPARC v7.
4805 These options are deprecated and will be deleted in a future GCC release.
4806 They have been replaced with @samp{-mcpu=xxx}.
4808 @item -mcypress
4809 @itemx -msupersparc
4810 These two options select the processor for which the code is optimised.
4812 With @samp{-mcypress} (the default), the compiler optimizes code for the
4813 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4814 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4816 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4817 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4818 of the full SPARC v8 instruction set.
4820 These options are deprecated and will be deleted in a future GCC release.
4821 They have been replaced with @samp{-mcpu=xxx}.
4823 @item -mcpu=@var{cpu_type}
4824 Set the instruction set, register set, and instruction scheduling parameters
4825 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4826 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4827 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4828 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4830 Default instruction scheduling parameters are used for values that select
4831 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4832 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4834 Here is a list of each supported architecture and their supported
4835 implementations.
4837 @smallexample
4838     v7:             cypress
4839     v8:             supersparc, hypersparc
4840     sparclite:      f930, f934, sparclite86x
4841     sparclet:       tsc701
4842     v9:             ultrasparc
4843 @end smallexample
4845 @item -mtune=@var{cpu_type}
4846 Set the instruction scheduling parameters for machine type
4847 @var{cpu_type}, but do not set the instruction set or register set that the
4848 option @samp{-mcpu=}@var{cpu_type} would.
4850 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4851 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4852 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4853 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4854 @samp{tsc701}, @samp{ultrasparc}.
4856 @end table
4858 These @samp{-m} switches are supported in addition to the above
4859 on the SPARCLET processor.
4861 @table @gcctabopt
4862 @item -mlittle-endian
4863 Generate code for a processor running in little-endian mode.
4865 @item -mlive-g0
4866 Treat register @code{%g0} as a normal register.
4867 GCC will continue to clobber it as necessary but will not assume
4868 it always reads as 0.
4870 @item -mbroken-saverestore
4871 Generate code that does not use non-trivial forms of the @code{save} and
4872 @code{restore} instructions.  Early versions of the SPARCLET processor do
4873 not correctly handle @code{save} and @code{restore} instructions used with
4874 arguments.  They correctly handle them used without arguments.  A @code{save}
4875 instruction used without arguments increments the current window pointer
4876 but does not allocate a new stack frame.  It is assumed that the window
4877 overflow trap handler will properly handle this case as will interrupt
4878 handlers.
4879 @end table
4881 These @samp{-m} switches are supported in addition to the above
4882 on SPARC V9 processors in 64 bit environments.
4884 @table @gcctabopt
4885 @item -mlittle-endian
4886 Generate code for a processor running in little-endian mode.
4888 @item -m32
4889 @itemx -m64
4890 Generate code for a 32 bit or 64 bit environment.
4891 The 32 bit environment sets int, long and pointer to 32 bits.
4892 The 64 bit environment sets int to 32 bits and long and pointer
4893 to 64 bits.
4895 @item -mcmodel=medlow
4896 Generate code for the Medium/Low code model: the program must be linked
4897 in the low 32 bits of the address space.  Pointers are 64 bits.
4898 Programs can be statically or dynamically linked.
4900 @item -mcmodel=medmid
4901 Generate code for the Medium/Middle code model: the program must be linked
4902 in the low 44 bits of the address space, the text segment must be less than
4903 2G bytes, and data segment must be within 2G of the text segment.
4904 Pointers are 64 bits.
4906 @item -mcmodel=medany
4907 Generate code for the Medium/Anywhere code model: the program may be linked
4908 anywhere in the address space, the text segment must be less than
4909 2G bytes, and data segment must be within 2G of the text segment.
4910 Pointers are 64 bits.
4912 @item -mcmodel=embmedany
4913 Generate code for the Medium/Anywhere code model for embedded systems:
4914 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4915 (determined at link time).  Register %g4 points to the base of the
4916 data segment.  Pointers still 64 bits.
4917 Programs are statically linked, PIC is not supported.
4919 @item -mstack-bias
4920 @itemx -mno-stack-bias
4921 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4922 frame pointer if present, are offset by -2047 which must be added back
4923 when making stack frame references.
4924 Otherwise, assume no such offset is present.
4925 @end table
4927 @node Convex Options
4928 @subsection Convex Options
4929 @cindex Convex options
4931 These @samp{-m} options are defined for Convex:
4933 @table @gcctabopt
4934 @item -mc1
4935 Generate output for C1.  The code will run on any Convex machine.
4936 The preprocessor symbol @code{__convex__c1__} is defined.
4938 @item -mc2
4939 Generate output for C2.  Uses instructions not available on C1.
4940 Scheduling and other optimizations are chosen for max performance on C2.
4941 The preprocessor symbol @code{__convex_c2__} is defined.
4943 @item -mc32
4944 Generate output for C32xx.  Uses instructions not available on C1.
4945 Scheduling and other optimizations are chosen for max performance on C32.
4946 The preprocessor symbol @code{__convex_c32__} is defined.
4948 @item -mc34
4949 Generate output for C34xx.  Uses instructions not available on C1.
4950 Scheduling and other optimizations are chosen for max performance on C34.
4951 The preprocessor symbol @code{__convex_c34__} is defined.
4953 @item -mc38
4954 Generate output for C38xx.  Uses instructions not available on C1.
4955 Scheduling and other optimizations are chosen for max performance on C38.
4956 The preprocessor symbol @code{__convex_c38__} is defined.
4958 @item -margcount
4959 Generate code which puts an argument count in the word preceding each
4960 argument list.  This is compatible with regular CC, and a few programs
4961 may need the argument count word.  GDB and other source-level debuggers
4962 do not need it; this info is in the symbol table.
4964 @item -mnoargcount
4965 Omit the argument count word.  This is the default.
4967 @item -mvolatile-cache
4968 Allow volatile references to be cached.  This is the default.
4970 @item -mvolatile-nocache
4971 Volatile references bypass the data cache, going all the way to memory.
4972 This is only needed for multi-processor code that does not use standard
4973 synchronization instructions.  Making non-volatile references to volatile
4974 locations will not necessarily work.
4976 @item -mlong32
4977 Type long is 32 bits, the same as type int.  This is the default.
4979 @item -mlong64
4980 Type long is 64 bits, the same as type long long.  This option is useless,
4981 because no library support exists for it.
4982 @end table
4984 @node AMD29K Options
4985 @subsection AMD29K Options
4986 @cindex AMD29K options
4988 These @samp{-m} options are defined for the AMD Am29000:
4990 @table @gcctabopt
4991 @item -mdw
4992 @kindex -mdw
4993 @cindex DW bit (29k)
4994 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4995 halfword operations are directly supported by the hardware.  This is the
4996 default.
4998 @item -mndw
4999 @kindex -mndw
5000 Generate code that assumes the @code{DW} bit is not set.
5002 @item -mbw
5003 @kindex -mbw
5004 @cindex byte writes (29k)
5005 Generate code that assumes the system supports byte and halfword write
5006 operations.  This is the default.
5008 @item -mnbw
5009 @kindex -mnbw
5010 Generate code that assumes the systems does not support byte and
5011 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
5013 @item -msmall
5014 @kindex -msmall
5015 @cindex memory model (29k)
5016 Use a small memory model that assumes that all function addresses are
5017 either within a single 256 KB segment or at an absolute address of less
5018 than 256k.  This allows the @code{call} instruction to be used instead
5019 of a @code{const}, @code{consth}, @code{calli} sequence.
5021 @item -mnormal
5022 @kindex -mnormal
5023 Use the normal memory model: Generate @code{call} instructions only when
5024 calling functions in the same file and @code{calli} instructions
5025 otherwise.  This works if each file occupies less than 256 KB but allows
5026 the entire executable to be larger than 256 KB.  This is the default.
5028 @item -mlarge
5029 Always use @code{calli} instructions.  Specify this option if you expect
5030 a single file to compile into more than 256 KB of code.
5032 @item -m29050
5033 @kindex -m29050
5034 @cindex processor selection (29k)
5035 Generate code for the Am29050.
5037 @item -m29000
5038 @kindex -m29000
5039 Generate code for the Am29000.  This is the default.
5041 @item -mkernel-registers
5042 @kindex -mkernel-registers
5043 @cindex kernel and user registers (29k)
5044 Generate references to registers @code{gr64-gr95} instead of to
5045 registers @code{gr96-gr127}.  This option can be used when compiling
5046 kernel code that wants a set of global registers disjoint from that used
5047 by user-mode code.
5049 Note that when this option is used, register names in @samp{-f} flags
5050 must use the normal, user-mode, names.
5052 @item -muser-registers
5053 @kindex -muser-registers
5054 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5055 default.
5057 @item -mstack-check
5058 @itemx -mno-stack-check
5059 @kindex -mstack-check
5060 @cindex stack checks (29k)
5061 Insert (or do not insert) a call to @code{__msp_check} after each stack
5062 adjustment.  This is often used for kernel code.
5064 @item -mstorem-bug
5065 @itemx -mno-storem-bug
5066 @kindex -mstorem-bug
5067 @cindex storem bug (29k)
5068 @samp{-mstorem-bug} handles 29k processors which cannot handle the
5069 separation of a mtsrim insn and a storem instruction (most 29000 chips
5070 to date, but not the 29050).
5072 @item -mno-reuse-arg-regs
5073 @itemx -mreuse-arg-regs
5074 @kindex -mreuse-arg-regs
5075 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5076 registers for copying out arguments.  This helps detect calling a function
5077 with fewer arguments than it was declared with.
5079 @item -mno-impure-text
5080 @itemx -mimpure-text
5081 @kindex -mimpure-text
5082 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5083 not pass @samp{-assert pure-text} to the linker when linking a shared object.
5085 @item -msoft-float
5086 @kindex -msoft-float
5087 Generate output containing library calls for floating point.
5088 @strong{Warning:} the requisite libraries are not part of GCC.
5089 Normally the facilities of the machine's usual C compiler are used, but
5090 this can't be done directly in cross-compilation.  You must make your
5091 own arrangements to provide suitable library functions for
5092 cross-compilation.
5094 @item -mno-multm
5095 @kindex -mno-multm
5096 Do not generate multm or multmu instructions.  This is useful for some embedded
5097 systems which do not have trap handlers for these instructions.
5098 @end table
5100 @node ARM Options
5101 @subsection ARM Options
5102 @cindex ARM options
5104 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5105 architectures:
5107 @table @gcctabopt
5108 @item -mapcs-frame
5109 @kindex -mapcs-frame
5110 Generate a stack frame that is compliant with the ARM Procedure Call
5111 Standard for all functions, even if this is not strictly necessary for
5112 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
5113 with this option will cause the stack frames not to be generated for
5114 leaf functions.  The default is @samp{-mno-apcs-frame}.
5116 @item -mapcs
5117 @kindex -mapcs
5118 This is a synonym for @samp{-mapcs-frame}.
5120 @item -mapcs-26
5121 @kindex -mapcs-26
5122 Generate code for a processor running with a 26-bit program counter,
5123 and conforming to the function calling standards for the APCS 26-bit
5124 option.  This option replaces the @samp{-m2} and @samp{-m3} options
5125 of previous releases of the compiler.
5127 @item -mapcs-32
5128 @kindex -mapcs-32
5129 Generate code for a processor running with a 32-bit program counter,
5130 and conforming to the function calling standards for the APCS 32-bit
5131 option.  This option replaces the @samp{-m6} option of previous releases
5132 of the compiler.
5134 @item -mapcs-stack-check
5135 @kindex -mapcs-stack-check
5136 @kindex -mno-apcs-stack-check
5137 Generate code to check the amount of stack space available upon entry to
5138 every function (that actually uses some stack space).  If there is
5139 insufficient space available then either the function
5140 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5141 called, depending upon the amount of stack space required.  The run time
5142 system is required to provide these functions.  The default is
5143 @samp{-mno-apcs-stack-check}, since this produces smaller code.
5145 @item -mapcs-float
5146 @kindex -mapcs-float
5147 @kindex -mno-apcs-float
5148 Pass floating point arguments using the float point registers.  This is
5149 one of the variants of the APCS.  This option is recommended if the
5150 target hardware has a floating point unit or if a lot of floating point
5151 arithmetic is going to be performed by the code.  The default is
5152 @samp{-mno-apcs-float}, since integer only code is slightly increased in
5153 size if @samp{-mapcs-float} is used.
5155 @item -mapcs-reentrant
5156 @kindex -mapcs-reentrant
5157 @kindex -mno-apcs-reentrant
5158 Generate reentrant, position independent code.  This is the equivalent
5159 to specifying the @samp{-fpic} option.  The default is
5160 @samp{-mno-apcs-reentrant}.
5162 @item -mthumb-interwork
5163 @kindex -mthumb-interwork
5164 @kindex -mno-thumb-interwork
5165 Generate code which supports calling between the ARM and THUMB
5166 instruction sets.  Without this option the two instruction sets cannot
5167 be reliably used inside one program.  The default is
5168 @samp{-mno-thumb-interwork}, since slightly larger code is generated
5169 when @samp{-mthumb-interwork} is specified.
5171 @item -mno-sched-prolog
5172 @kindex -mno-sched-prolog
5173 @kindex -msched-prolog
5174 Prevent the reordering of instructions in the function prolog, or the
5175 merging of those instruction with the instructions in the function's
5176 body.  This means that all functions will start with a recognizable set
5177 of instructions (or in fact one of a choice from a small set of
5178 different function prologues), and this information can be used to
5179 locate the start if functions inside an executable piece of code.  The
5180 default is @samp{-msched-prolog}.
5182 @item -mhard-float
5183 Generate output containing floating point instructions.  This is the
5184 default.
5186 @item -msoft-float
5187 Generate output containing library calls for floating point.
5188 @strong{Warning:} the requisite libraries are not available for all ARM
5189 targets.  Normally the facilities of the machine's usual C compiler are
5190 used, but this cannot be done directly in cross-compilation.  You must make
5191 your own arrangements to provide suitable library functions for
5192 cross-compilation.
5194 @samp{-msoft-float} changes the calling convention in the output file;
5195 therefore, it is only useful if you compile @emph{all} of a program with
5196 this option.  In particular, you need to compile @file{libgcc.a}, the
5197 library that comes with GCC, with @samp{-msoft-float} in order for
5198 this to work.
5200 @item -mlittle-endian
5201 Generate code for a processor running in little-endian mode.  This is
5202 the default for all standard configurations.
5204 @item -mbig-endian
5205 Generate code for a processor running in big-endian mode; the default is
5206 to compile code for a little-endian processor.
5208 @item -mwords-little-endian
5209 This option only applies when generating code for big-endian processors.
5210 Generate code for a little-endian word order but a big-endian byte
5211 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5212 option should only be used if you require compatibility with code for
5213 big-endian ARM processors generated by versions of the compiler prior to
5214 2.8.
5216 @item -malignment-traps
5217 @kindex -malignment-traps
5218 Generate code that will not trap if the MMU has alignment traps enabled.
5219 On ARM architectures prior to ARMv4, there were no instructions to
5220 access half-word objects stored in memory.  However, when reading from
5221 memory a feature of the ARM architecture allows a word load to be used,
5222 even if the address is unaligned, and the processor core will rotate the
5223 data as it is being loaded.  This option tells the compiler that such
5224 misaligned accesses will cause a MMU trap and that it should instead
5225 synthesise the access as a series of byte accesses.  The compiler can
5226 still use word accesses to load half-word data if it knows that the
5227 address is aligned to a word boundary.
5229 This option is ignored when compiling for ARM architecture 4 or later,
5230 since these processors have instructions to directly access half-word
5231 objects in memory. 
5232         
5233 @item -mno-alignment-traps
5234 @kindex -mno-alignment-traps
5235 Generate code that assumes that the MMU will not trap unaligned
5236 accesses.  This produces better code when the target instruction set
5237 does not have half-word memory operations (implementations prior to
5238 ARMv4). 
5240 Note that you cannot use this option to access unaligned word objects,
5241 since the processor will only fetch one 32-bit aligned object from
5242 memory. 
5244 The default setting for most targets is -mno-alignment-traps, since
5245 this produces better code when there are no half-word memory
5246 instructions available. 
5248 @item -mshort-load-bytes
5249 @kindex -mshort-load-bytes
5250 This is a deprecated alias for @samp{-malignment-traps}.
5252 @item -mno-short-load-bytes
5253 @kindex -mno-short-load-bytes
5254 This is a deprecated alias for @samp{-mno-alignment-traps}.
5256 @item -mshort-load-words
5257 @kindex -mshort-load-words
5258 This is a deprecated alias for @samp{-mno-alignment-traps}.
5260 @item -mno-short-load-words
5261 @kindex -mno-short-load-words
5262 This is a deprecated alias for @samp{-malignment-traps}.
5264 @item -mbsd
5265 @kindex -mbsd
5266 This option only applies to RISC iX.  Emulate the native BSD-mode
5267 compiler.  This is the default if @samp{-ansi} is not specified.
5269 @item -mxopen
5270 @kindex -mxopen
5271 This option only applies to RISC iX.  Emulate the native X/Open-mode
5272 compiler.
5274 @item -mno-symrename
5275 @kindex -mno-symrename
5276 This option only applies to RISC iX.  Do not run the assembler
5277 post-processor, @samp{symrename}, after code has been assembled.
5278 Normally it is necessary to modify some of the standard symbols in
5279 preparation for linking with the RISC iX C library; this option
5280 suppresses this pass.  The post-processor is never run when the
5281 compiler is built for cross-compilation.
5283 @item -mcpu=<name>
5284 @kindex -mcpu=
5285 This specifies the name of the target ARM processor.  GCC uses this name
5286 to determine what kind of instructions it can use when generating
5287 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
5288 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5289 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
5290 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
5291 arm9, arm920, arm920t, arm9tdmi.
5293 @itemx -mtune=<name>
5294 @kindex -mtune=
5295 This option is very similar to the @samp{-mcpu=} option, except that
5296 instead of specifying the actual target processor type, and hence
5297 restricting which instructions can be used, it specifies that GCC should
5298 tune the performance of the code as if the target were of the type
5299 specified in this option, but still choosing the instructions that it
5300 will generate based on the cpu specified by a @samp{-mcpu=} option.
5301 For some arm implementations better performance can be obtained by using
5302 this option.
5304 @item -march=<name>
5305 @kindex -march=
5306 This specifies the name of the target ARM architecture.  GCC uses this
5307 name to determine what kind of instructions it can use when generating
5308 assembly code.  This option can be used in conjunction with or instead
5309 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
5310 armv3, armv3m, armv4, armv4t, armv5.
5312 @item -mfpe=<number>
5313 @itemx -mfp=<number>
5314 @kindex -mfpe=
5315 @kindex -mfp=
5316 This specifies the version of the floating point emulation available on
5317 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
5318 for @samp{-mfpe=} to support older versions of GCC.
5320 @item -mstructure-size-boundary=<n>
5321 @kindex -mstructure-size-boundary
5322 The size of all structures and unions will be rounded up to a multiple
5323 of the number of bits set by this option.  Permissible values are 8 and
5324 32.  The default value varies for different toolchains.  For the COFF
5325 targeted toolchain the default value is 8.  Specifying the larger number
5326 can produce faster, more efficient code, but can also increase the size
5327 of the program.  The two values are potentially incompatible.  Code
5328 compiled with one value cannot necessarily expect to work with code or
5329 libraries compiled with the other value, if they exchange information
5330 using structures or unions.  Programmers are encouraged to use the 32
5331 value as future versions of the toolchain may default to this value.
5333 @item -mabort-on-noreturn
5334 @kindex -mabort-on-noreturn
5335 @kindex -mnoabort-on-noreturn
5336 Generate a call to the function abort at the end of a noreturn function.
5337 It will be executed if the function tries to return.
5339 @item -mlong-calls
5340 @itemx -mno-long-calls
5341 Tells the compiler to perform function calls by first loading the
5342 address of the function into a register and then performing a subroutine
5343 call on this register.  This switch is needed if the target function
5344 will lie outside of the 64 megabyte addressing range of the offset based
5345 version of subroutine call instruction. 
5347 Even if this switch is enabled, not all function calls will be turned
5348 into long calls.  The heuristic is that static functions, functions
5349 which have the @samp{short-call} attribute, functions that are inside
5350 the scope of a @samp{#pragma no_long_calls} directive and functions whose
5351 definitions have already been compiled within the current compilation
5352 unit, will not be turned into long calls.  The exception to this rule is
5353 that weak function definitions, functions with the @samp{long-call}
5354 attribute or the @samp{section} attribute, and functions that are within
5355 the scope of a @samp{#pragma long_calls} directive, will always be
5356 turned into long calls.
5358 This feature is not enabled by default.  Specifying
5359 @samp{--no-long-calls} will restore the default behaviour, as will
5360 placing the function calls within the scope of a @samp{#pragma
5361 long_calls_off} directive.  Note these switches have no effect on how
5362 the compiler generates code to handle function calls via function
5363 pointers.  
5365 @item -mnop-fun-dllimport
5366 @kindex -mnop-fun-dllimport
5367 Disable the support for the @emph{dllimport} attribute.
5369 @item -msingle-pic-base
5370 @kindex -msingle-pic-base
5371 Treat the register used for PIC addressing as read-only, rather than
5372 loading it in the prologue for each function.  The run-time system is
5373 responsible for initialising this register with an appropriate value
5374 before execution begins.
5376 @item -mpic-register=<reg>
5377 @kindex -mpic-register=
5378 Specify the register to be used for PIC addressing.  The default is R10
5379 unless stack-checking is enabled, when R9 is used.
5381 @end table
5383 @node Thumb Options
5384 @subsection Thumb Options
5385 @cindex Thumb Options
5387 @table @gcctabopt
5389 @item -mthumb-interwork
5390 @kindex -mthumb-interwork
5391 @kindex -mno-thumb-interwork
5392 Generate code which supports calling between the THUMB and ARM
5393 instruction sets.  Without this option the two instruction sets cannot
5394 be reliably used inside one program.  The default is
5395 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
5396 with this option.
5398 @item -mtpcs-frame
5399 @kindex -mtpcs-frame
5400 @kindex -mno-tpcs-frame
5401 Generate a stack frame that is compliant with the Thumb Procedure Call
5402 Standard for all non-leaf functions.  (A leaf function is one that does
5403 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
5405 @item -mtpcs-leaf-frame
5406 @kindex -mtpcs-leaf-frame
5407 @kindex -mno-tpcs-leaf-frame
5408 Generate a stack frame that is compliant with the Thumb Procedure Call
5409 Standard for all leaf functions.  (A leaf function is one that does
5410 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
5412 @item -mlittle-endian
5413 @kindex -mlittle-endian
5414 Generate code for a processor running in little-endian mode.  This is
5415 the default for all standard configurations.
5417 @item -mbig-endian
5418 @kindex -mbig-endian
5419 Generate code for a processor running in big-endian mode.
5421 @item -mstructure-size-boundary=<n>
5422 @kindex -mstructure-size-boundary
5423 The size of all structures and unions will be rounded up to a multiple
5424 of the number of bits set by this option.  Permissible values are 8 and
5425 32.  The default value varies for different toolchains.  For the COFF
5426 targeted toolchain the default value is 8.  Specifying the larger number
5427 can produced faster, more efficient code, but can also increase the size
5428 of the program.  The two values are potentially incompatible.  Code
5429 compiled with one value cannot necessarily expect to work with code or
5430 libraries compiled with the other value, if they exchange information
5431 using structures or unions.  Programmers are encouraged to use the 32
5432 value as future versions of the toolchain may default to this value.
5434 @item -mnop-fun-dllimport
5435 @kindex -mnop-fun-dllimport
5436 Disable the support for the @emph{dllimport} attribute.
5438 @item -mcallee-super-interworking
5439 @kindex -mcallee-super-interworking
5440 Gives all externally visible functions in the file being compiled an ARM
5441 instruction set header which switches to Thumb mode before executing the
5442 rest of the function.  This allows these functions to be called from
5443 non-interworking code.
5445 @item -mcaller-super-interworking
5446 @kindex -mcaller-super-interworking
5447 Allows calls via function pointers (including virtual functions) to
5448 execute correctly regardless of whether the target code has been
5449 compiled for interworking or not.  There is a small overhead in the cost
5450 of executing a function pointer if this option is enabled.
5452 @item -msingle-pic-base
5453 @kindex -msingle-pic-base
5454 Treat the register used for PIC addressing as read-only, rather than
5455 loading it in the prologue for each function.  The run-time system is
5456 responsible for initialising this register with an appropriate value
5457 before execution begins.
5459 @item -mpic-register=<reg>
5460 @kindex -mpic-register=
5461 Specify the register to be used for PIC addressing.  The default is R10.
5463 @end table
5465 @node MN10200 Options
5466 @subsection MN10200 Options
5467 @cindex MN10200 options
5468 These @samp{-m} options are defined for Matsushita MN10200 architectures:
5469 @table @gcctabopt
5471 @item -mrelax
5472 Indicate to the linker that it should perform a relaxation optimization pass
5473 to shorten branches, calls and absolute memory addresses.  This option only
5474 has an effect when used on the command line for the final link step.
5476 This option makes symbolic debugging impossible. 
5477 @end table
5479 @node MN10300 Options
5480 @subsection MN10300 Options
5481 @cindex MN10300 options
5482 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5484 @table @gcctabopt
5485 @item -mmult-bug
5486 Generate code to avoid bugs in the multiply instructions for the MN10300
5487 processors.  This is the default.
5489 @item -mno-mult-bug
5490 Do not generate code to avoid bugs in the multiply instructions for the
5491 MN10300 processors.
5493 @item -mam33
5494 Generate code which uses features specific to the AM33 processor.
5496 @item -mno-am33
5497 Do not generate code which uses features specific to the AM33 processor.  This
5498 is the default.
5500 @item -mrelax
5501 Indicate to the linker that it should perform a relaxation optimization pass
5502 to shorten branches, calls and absolute memory addresses.  This option only
5503 has an effect when used on the command line for the final link step.
5505 This option makes symbolic debugging impossible. 
5506 @end table
5509 @node M32R/D Options
5510 @subsection M32R/D Options
5511 @cindex M32R/D options
5513 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5515 @table @gcctabopt
5516 @item -mcode-model=small
5517 Assume all objects live in the lower 16MB of memory (so that their addresses
5518 can be loaded with the @code{ld24} instruction), and assume all subroutines
5519 are reachable with the @code{bl} instruction.
5520 This is the default.
5522 The addressability of a particular object can be set with the
5523 @code{model} attribute.
5525 @item -mcode-model=medium
5526 Assume objects may be anywhere in the 32 bit address space (the compiler
5527 will generate @code{seth/add3} instructions to load their addresses), and
5528 assume all subroutines are reachable with the @code{bl} instruction.
5530 @item -mcode-model=large
5531 Assume objects may be anywhere in the 32 bit address space (the compiler
5532 will generate @code{seth/add3} instructions to load their addresses), and
5533 assume subroutines may not be reachable with the @code{bl} instruction
5534 (the compiler will generate the much slower @code{seth/add3/jl}
5535 instruction sequence).
5537 @item -msdata=none
5538 Disable use of the small data area.  Variables will be put into
5539 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5540 @code{section} attribute has been specified).
5541 This is the default.
5543 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5544 Objects may be explicitly put in the small data area with the
5545 @code{section} attribute using one of these sections.
5547 @item -msdata=sdata
5548 Put small global and static data in the small data area, but do not
5549 generate special code to reference them.
5551 @item -msdata=use
5552 Put small global and static data in the small data area, and generate
5553 special instructions to reference them.
5555 @item -G @var{num}
5556 @cindex smaller data references
5557 Put global and static objects less than or equal to @var{num} bytes
5558 into the small data or bss sections instead of the normal data or bss
5559 sections.  The default value of @var{num} is 8.
5560 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5561 for this option to have any effect.
5563 All modules should be compiled with the same @samp{-G @var{num}} value.
5564 Compiling with different values of @var{num} may or may not work; if it
5565 doesn't the linker will give an error message - incorrect code will not be
5566 generated.
5568 @end table
5570 @node M88K Options
5571 @subsection M88K Options
5572 @cindex M88k options
5574 These @samp{-m} options are defined for Motorola 88k architectures:
5576 @table @gcctabopt
5577 @item -m88000
5578 @kindex -m88000
5579 Generate code that works well on both the m88100 and the
5580 m88110.
5582 @item -m88100
5583 @kindex -m88100
5584 Generate code that works best for the m88100, but that also
5585 runs on the m88110.
5587 @item -m88110
5588 @kindex -m88110
5589 Generate code that works best for the m88110, and may not run
5590 on the m88100.
5592 @item -mbig-pic
5593 @kindex -mbig-pic
5594 Obsolete option to be removed from the next revision.
5595 Use @samp{-fPIC}.
5597 @item -midentify-revision
5598 @kindex -midentify-revision
5599 @kindex ident
5600 @cindex identifying source, compiler (88k)
5601 Include an @code{ident} directive in the assembler output recording the
5602 source file name, compiler name and version, timestamp, and compilation
5603 flags used.
5605 @item -mno-underscores
5606 @kindex -mno-underscores
5607 @cindex underscores, avoiding (88k)
5608 In assembler output, emit symbol names without adding an underscore
5609 character at the beginning of each name.  The default is to use an
5610 underscore as prefix on each name.
5612 @item -mocs-debug-info
5613 @itemx -mno-ocs-debug-info
5614 @kindex -mocs-debug-info
5615 @kindex -mno-ocs-debug-info
5616 @cindex OCS (88k)
5617 @cindex debugging, 88k OCS
5618 Include (or omit) additional debugging information (about registers used
5619 in each stack frame) as specified in the 88open Object Compatibility
5620 Standard, ``OCS''.  This extra information allows debugging of code that
5621 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
5622 Delta 88 SVr3.2 is to include this information; other 88k configurations
5623 omit this information by default.
5625 @item -mocs-frame-position
5626 @kindex -mocs-frame-position
5627 @cindex register positions in frame (88k)
5628 When emitting COFF debugging information for automatic variables and
5629 parameters stored on the stack, use the offset from the canonical frame
5630 address, which is the stack pointer (register 31) on entry to the
5631 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5632 @samp{-mocs-frame-position}; other 88k configurations have the default
5633 @samp{-mno-ocs-frame-position}.
5635 @item -mno-ocs-frame-position
5636 @kindex -mno-ocs-frame-position
5637 @cindex register positions in frame (88k)
5638 When emitting COFF debugging information for automatic variables and
5639 parameters stored on the stack, use the offset from the frame pointer
5640 register (register 30).  When this option is in effect, the frame
5641 pointer is not eliminated when debugging information is selected by the
5642 -g switch.
5644 @item -moptimize-arg-area
5645 @itemx -mno-optimize-arg-area
5646 @kindex -moptimize-arg-area
5647 @kindex -mno-optimize-arg-area
5648 @cindex arguments in frame (88k)
5649 Control how function arguments are stored in stack frames.
5650 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5651 conflicts with the 88open specifications.  The opposite alternative,
5652 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5653 GCC does not optimize the argument area.
5655 @item -mshort-data-@var{num}
5656 @kindex -mshort-data-@var{num}
5657 @cindex smaller data references (88k)
5658 @cindex r0-relative references (88k)
5659 Generate smaller data references by making them relative to @code{r0},
5660 which allows loading a value using a single instruction (rather than the
5661 usual two).  You control which data references are affected by
5662 specifying @var{num} with this option.  For example, if you specify
5663 @samp{-mshort-data-512}, then the data references affected are those
5664 involving displacements of less than 512 bytes.
5665 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5666 than 64k.
5668 @item -mserialize-volatile
5669 @kindex -mserialize-volatile
5670 @itemx -mno-serialize-volatile
5671 @kindex -mno-serialize-volatile
5672 @cindex sequential consistency on 88k
5673 Do, or don't, generate code to guarantee sequential consistency
5674 of volatile memory references.  By default, consistency is
5675 guaranteed.
5677 The order of memory references made by the MC88110 processor does
5678 not always match the order of the instructions requesting those
5679 references.  In particular, a load instruction may execute before
5680 a preceding store instruction.  Such reordering violates
5681 sequential consistency of volatile memory references, when there
5682 are multiple processors.   When consistency must be guaranteed,
5683 GNU C generates special instructions, as needed, to force
5684 execution in the proper order.
5686 The MC88100 processor does not reorder memory references and so
5687 always provides sequential consistency.  However, by default, GNU
5688 C generates the special instructions to guarantee consistency
5689 even when you use @samp{-m88100}, so that the code may be run on an
5690 MC88110 processor.  If you intend to run your code only on the
5691 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5693 The extra code generated to guarantee consistency may affect the
5694 performance of your application.  If you know that you can safely
5695 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5697 @item -msvr4
5698 @itemx -msvr3
5699 @kindex -msvr4
5700 @kindex -msvr3
5701 @cindex assembler syntax, 88k
5702 @cindex SVr4
5703 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5704 related to System V release 4 (SVr4).  This controls the following:
5706 @enumerate
5707 @item
5708 Which variant of the assembler syntax to emit.
5709 @item
5710 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5711 that is used on System V release 4.
5712 @item
5713 @samp{-msvr4} makes GCC issue additional declaration directives used in
5714 SVr4.
5715 @end enumerate
5717 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5718 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5719 other m88k configurations.
5721 @item -mversion-03.00
5722 @kindex -mversion-03.00
5723 This option is obsolete, and is ignored.
5724 @c ??? which asm syntax better for GAS?  option there too?
5726 @item -mno-check-zero-division
5727 @itemx -mcheck-zero-division
5728 @kindex -mno-check-zero-division
5729 @kindex -mcheck-zero-division
5730 @cindex zero division on 88k
5731 Do, or don't, generate code to guarantee that integer division by
5732 zero will be detected.  By default, detection is guaranteed.
5734 Some models of the MC88100 processor fail to trap upon integer
5735 division by zero under certain conditions.  By default, when
5736 compiling code that might be run on such a processor, GNU C
5737 generates code that explicitly checks for zero-valued divisors
5738 and traps with exception number 503 when one is detected.  Use of
5739 mno-check-zero-division suppresses such checking for code
5740 generated to run on an MC88100 processor.
5742 GNU C assumes that the MC88110 processor correctly detects all
5743 instances of integer division by zero.  When @samp{-m88110} is
5744 specified, both @samp{-mcheck-zero-division} and
5745 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5746 zero-valued divisors are generated.
5748 @item -muse-div-instruction
5749 @kindex -muse-div-instruction
5750 @cindex divide instruction, 88k
5751 Use the div instruction for signed integer division on the
5752 MC88100 processor.  By default, the div instruction is not used.
5754 On the MC88100 processor the signed integer division instruction
5755 div) traps to the operating system on a negative operand.  The
5756 operating system transparently completes the operation, but at a
5757 large cost in execution time.  By default, when compiling code
5758 that might be run on an MC88100 processor, GNU C emulates signed
5759 integer division using the unsigned integer division instruction
5760 divu), thereby avoiding the large penalty of a trap to the
5761 operating system.  Such emulation has its own, smaller, execution
5762 cost in both time and space.  To the extent that your code's
5763 important signed integer division operations are performed on two
5764 nonnegative operands, it may be desirable to use the div
5765 instruction directly.
5767 On the MC88110 processor the div instruction (also known as the
5768 divs instruction) processes negative operands without trapping to
5769 the operating system.  When @samp{-m88110} is specified,
5770 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5771 for signed integer division.
5773 Note that the result of dividing INT_MIN by -1 is undefined.  In
5774 particular, the behavior of such a division with and without
5775 @samp{-muse-div-instruction}  may differ.
5777 @item -mtrap-large-shift
5778 @itemx -mhandle-large-shift
5779 @kindex -mtrap-large-shift
5780 @kindex -mhandle-large-shift
5781 @cindex bit shift overflow (88k)
5782 @cindex large bit shifts (88k)
5783 Include code to detect bit-shifts of more than 31 bits; respectively,
5784 trap such shifts or emit code to handle them properly.  By default GCC
5785 makes no special provision for large bit shifts.
5787 @item -mwarn-passed-structs
5788 @kindex -mwarn-passed-structs
5789 @cindex structure passing (88k)
5790 Warn when a function passes a struct as an argument or result.
5791 Structure-passing conventions have changed during the evolution of the C
5792 language, and are often the source of portability problems.  By default,
5793 GCC issues no such warning.
5794 @end table
5796 @node RS/6000 and PowerPC Options
5797 @subsection IBM RS/6000 and PowerPC Options
5798 @cindex RS/6000 and PowerPC Options
5799 @cindex IBM RS/6000 and PowerPC Options
5801 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5802 @table @gcctabopt
5803 @item -mpower
5804 @itemx -mno-power
5805 @itemx -mpower2
5806 @itemx -mno-power2
5807 @itemx -mpowerpc
5808 @itemx -mno-powerpc
5809 @itemx -mpowerpc-gpopt
5810 @itemx -mno-powerpc-gpopt
5811 @itemx -mpowerpc-gfxopt
5812 @itemx -mno-powerpc-gfxopt
5813 @itemx -mpowerpc64
5814 @itemx -mno-powerpc64
5815 @kindex -mpower
5816 @kindex -mpower2
5817 @kindex -mpowerpc
5818 @kindex -mpowerpc-gpopt
5819 @kindex -mpowerpc-gfxopt
5820 @kindex -mpowerpc64
5821 GCC supports two related instruction set architectures for the
5822 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5823 instructions supported by the @samp{rios} chip set used in the original
5824 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5825 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5826 the IBM 4xx microprocessors.
5828 Neither architecture is a subset of the other.  However there is a
5829 large common subset of instructions supported by both.  An MQ
5830 register is included in processors supporting the POWER architecture.
5832 You use these options to specify which instructions are available on the
5833 processor you are using.  The default value of these options is
5834 determined when configuring GCC.  Specifying the
5835 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5836 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5837 rather than the options listed above.
5839 The @samp{-mpower} option allows GCC to generate instructions that
5840 are found only in the POWER architecture and to use the MQ register.
5841 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5842 to generate instructions that are present in the POWER2 architecture but
5843 not the original POWER architecture.
5845 The @samp{-mpowerpc} option allows GCC to generate instructions that
5846 are found only in the 32-bit subset of the PowerPC architecture.
5847 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5848 GCC to use the optional PowerPC architecture instructions in the
5849 General Purpose group, including floating-point square root.  Specifying
5850 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5851 use the optional PowerPC architecture instructions in the Graphics
5852 group, including floating-point select.
5854 The @samp{-mpowerpc64} option allows GCC to generate the additional
5855 64-bit instructions that are found in the full PowerPC64 architecture
5856 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5857 @samp{-mno-powerpc64}.
5859 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5860 will use only the instructions in the common subset of both
5861 architectures plus some special AIX common-mode calls, and will not use
5862 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5863 permits GCC to use any instruction from either architecture and to
5864 allow use of the MQ register; specify this for the Motorola MPC601.
5866 @item -mnew-mnemonics
5867 @itemx -mold-mnemonics
5868 @kindex -mnew-mnemonics
5869 @kindex -mold-mnemonics
5870 Select which mnemonics to use in the generated assembler code.
5871 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5872 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5873 requests the assembler mnemonics defined for the POWER architecture.
5874 Instructions defined in only one architecture have only one mnemonic;
5875 GCC uses that mnemonic irrespective of which of these options is
5876 specified.
5878 GCC defaults to the mnemonics appropriate for the architecture in
5879 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5880 value of these option.  Unless you are building a cross-compiler, you
5881 should normally not specify either @samp{-mnew-mnemonics} or
5882 @samp{-mold-mnemonics}, but should instead accept the default.
5884 @item -mcpu=@var{cpu_type}
5885 @kindex -mcpu
5886 Set architecture type, register usage, choice of mnemonics, and
5887 instruction scheduling parameters for machine type @var{cpu_type}.
5888 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5889 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5890 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5891 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5892 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5893 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5894 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5895 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5896 and 64-bit PowerPC architecture machine types, with an appropriate,
5897 generic processor model assumed for scheduling purposes.@refill
5899 Specifying any of the following options: 
5900 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5901 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5902 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5903 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5904 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5905 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5906 @samp{-mcpu=740}, and @samp{-mcpu=750}
5907 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5908 Exactly similarly, all of @samp{-mcpu=403},
5909 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5910 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5911 @samp{-mcpu=common} disables both the 
5912 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5914 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5915 that code will operate on all members of the RS/6000 POWER and PowerPC
5916 families.  In that case, GCC will use only the instructions in the
5917 common subset of both architectures plus some special AIX common-mode
5918 calls, and will not use the MQ register.  GCC assumes a generic
5919 processor model for scheduling purposes.
5921 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5922 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5923 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5924 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5925 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5926 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5927 the @samp{new-mnemonics} option.@refill
5929 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5930 enables the @samp{-msoft-float} option.
5932 @item -mtune=@var{cpu_type}
5933 Set the instruction scheduling parameters for machine type
5934 @var{cpu_type}, but do not set the architecture type, register usage,
5935 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5936 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5937 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5938 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5939 instruction scheduling parameters.
5941 @item -mfull-toc
5942 @itemx -mno-fp-in-toc
5943 @itemx -mno-sum-in-toc
5944 @itemx -mminimal-toc
5945 @kindex -mminimal-toc
5946 Modify generation of the TOC (Table Of Contents), which is created for
5947 every executable file.  The @samp{-mfull-toc} option is selected by
5948 default.  In that case, GCC will allocate at least one TOC entry for
5949 each unique non-automatic variable reference in your program.  GCC
5950 will also place floating-point constants in the TOC.  However, only
5951 16,384 entries are available in the TOC.
5953 If you receive a linker error message that saying you have overflowed
5954 the available TOC space, you can reduce the amount of TOC space used
5955 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5956 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5957 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5958 generate code to calculate the sum of an address and a constant at
5959 run-time instead of putting that sum into the TOC.  You may specify one
5960 or both of these options.  Each causes GCC to produce very slightly
5961 slower and larger code at the expense of conserving TOC space.
5963 If you still run out of space in the TOC even when you specify both of
5964 these options, specify @samp{-mminimal-toc} instead.  This option causes
5965 GCC to make only one TOC entry for every file.  When you specify this
5966 option, GCC will produce code that is slower and larger but which
5967 uses extremely little TOC space.  You may wish to use this option
5968 only on files that contain less frequently executed code. @refill
5970 @item -maix64
5971 @itemx -maix32
5972 @kindex -maix64
5973 @kindex -maix32
5974 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
5975 @code{long} type, and the infrastructure needed to support them.
5976 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
5977 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
5978 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
5980 @item -mxl-call
5981 @itemx -mno-xl-call
5982 @kindex -mxl-call
5983 On AIX, pass floating-point arguments to prototyped functions beyond the
5984 register save area (RSA) on the stack in addition to argument FPRs.  The
5985 AIX calling convention was extended but not initially documented to
5986 handle an obscure K&R C case of calling a function that takes the
5987 address of its arguments with fewer arguments than declared.  AIX XL
5988 compilers access floating point arguments which do not fit in the
5989 RSA from the stack when a subroutine is compiled without
5990 optimization.  Because always storing floating-point arguments on the
5991 stack is inefficient and rarely needed, this option is not enabled by
5992 default and only is necessary when calling subroutines compiled by AIX
5993 XL compilers without optimization.
5995 @item -mthreads
5996 @kindex -mthreads
5997 Support @dfn{AIX Threads}.  Link an application written to use
5998 @dfn{pthreads} with special libraries and startup code to enable the
5999 application to run.
6001 @item -mpe
6002 @kindex -mpe
6003 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
6004 application written to use message passing with special startup code to
6005 enable the application to run.  The system must have PE installed in the
6006 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6007 must be overridden with the @samp{-specs=} option to specify the
6008 appropriate directory location.  The Parallel Environment does not
6009 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
6010 option are incompatible.
6012 @item -msoft-float
6013 @itemx -mhard-float
6014 @kindex -msoft-float
6015 Generate code that does not use (uses) the floating-point register set.
6016 Software floating point emulation is provided if you use the
6017 @samp{-msoft-float} option, and pass the option to GCC when linking.
6019 @item -mmultiple
6020 @itemx -mno-multiple
6021 Generate code that uses (does not use) the load multiple word
6022 instructions and the store multiple word instructions.  These
6023 instructions are generated by default on POWER systems, and not
6024 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
6025 endian PowerPC systems, since those instructions do not work when the
6026 processor is in little endian mode.  The exceptions are PPC740 and
6027 PPC750 which permit the instructions usage in little endian mode.
6029 @item -mstring
6030 @itemx -mno-string
6031 @kindex -mstring
6032 Generate code that uses (does not use) the load string instructions
6033 and the store string word instructions to save multiple registers and
6034 do small block moves.  These instructions are generated by default on
6035 POWER systems, and not generated on PowerPC systems.  Do not use
6036 @samp{-mstring} on little endian PowerPC systems, since those
6037 instructions do not work when the processor is in little endian mode.
6038 The exceptions are PPC740 and PPC750 which permit the instructions
6039 usage in little endian mode.
6041 @item -mupdate
6042 @itemx -mno-update
6043 @kindex -mupdate
6044 Generate code that uses (does not use) the load or store instructions
6045 that update the base register to the address of the calculated memory
6046 location.  These instructions are generated by default.  If you use
6047 @samp{-mno-update}, there is a small window between the time that the
6048 stack pointer is updated and the address of the previous frame is
6049 stored, which means code that walks the stack frame across interrupts or
6050 signals may get corrupted data.
6052 @item -mfused-madd
6053 @itemx -mno-fused-madd
6054 @kindex -mfused-madd
6055 Generate code that uses (does not use) the floating point multiply and
6056 accumulate instructions.  These instructions are generated by default if
6057 hardware floating is used.
6059 @item -mno-bit-align
6060 @itemx -mbit-align
6061 @kindex -mbit-align
6062 On System V.4 and embedded PowerPC systems do not (do) force structures
6063 and unions that contain bit fields to be aligned to the base type of the
6064 bit field.
6066 For example, by default a structure containing nothing but 8
6067 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6068 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
6069 the structure would be aligned to a 1 byte boundary and be one byte in
6070 size.
6072 @item -mno-strict-align
6073 @itemx -mstrict-align
6074 @kindex -mstrict-align
6075 On System V.4 and embedded PowerPC systems do not (do) assume that
6076 unaligned memory references will be handled by the system.
6078 @item -mrelocatable
6079 @itemx -mno-relocatable
6080 @kindex -mrelocatable
6081 On embedded PowerPC systems generate code that allows (does not allow)
6082 the program to be relocated to a different address at runtime.  If you
6083 use @samp{-mrelocatable} on any module, all objects linked together must
6084 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6086 @item -mrelocatable-lib
6087 @itemx -mno-relocatable-lib
6088 On embedded PowerPC systems generate code that allows (does not allow)
6089 the program to be relocated to a different address at runtime.  Modules
6090 compiled with @samp{-mrelocatable-lib} can be linked with either modules
6091 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6092 with modules compiled with the @samp{-mrelocatable} options.
6094 @item -mno-toc
6095 @itemx -mtoc
6096 On System V.4 and embedded PowerPC systems do not (do) assume that
6097 register 2 contains a pointer to a global area pointing to the addresses
6098 used in the program.
6100 @item -mlittle
6101 @itemx -mlittle-endian
6102 On System V.4 and embedded PowerPC systems compile code for the
6103 processor in little endian mode.  The @samp{-mlittle-endian} option is
6104 the same as @samp{-mlittle}.
6106 @item -mbig
6107 @itemx -mbig-endian
6108 On System V.4 and embedded PowerPC systems compile code for the
6109 processor in big endian mode.  The @samp{-mbig-endian} option is
6110 the same as @samp{-mbig}.
6112 @item -mcall-sysv
6113 On System V.4 and embedded PowerPC systems compile code using calling
6114 conventions that adheres to the March 1995 draft of the System V
6115 Application Binary Interface, PowerPC processor supplement.  This is the
6116 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6118 @item -mcall-sysv-eabi
6119 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6121 @item -mcall-sysv-noeabi
6122 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6124 @item -mcall-aix
6125 On System V.4 and embedded PowerPC systems compile code using calling
6126 conventions that are similar to those used on AIX.  This is the
6127 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6129 @item -mcall-solaris
6130 On System V.4 and embedded PowerPC systems compile code for the Solaris
6131 operating system.
6133 @item -mcall-linux
6134 On System V.4 and embedded PowerPC systems compile code for the
6135 Linux-based GNU system.
6137 @item -mprototype
6138 @itemx -mno-prototype
6139 On System V.4 and embedded PowerPC systems assume that all calls to
6140 variable argument functions are properly prototyped.  Otherwise, the
6141 compiler must insert an instruction before every non prototyped call to
6142 set or clear bit 6 of the condition code register (@var{CR}) to
6143 indicate whether floating point values were passed in the floating point
6144 registers in case the function takes a variable arguments.  With
6145 @samp{-mprototype}, only calls to prototyped variable argument functions
6146 will set or clear the bit.
6148 @item -msim
6149 On embedded PowerPC systems, assume that the startup module is called
6150 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6151 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6152 configurations.
6154 @item -mmvme
6155 On embedded PowerPC systems, assume that the startup module is called
6156 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6157 @file{libc.a}.
6159 @item -mads
6160 On embedded PowerPC systems, assume that the startup module is called
6161 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6162 @file{libc.a}.
6164 @item -myellowknife
6165 On embedded PowerPC systems, assume that the startup module is called
6166 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6167 @file{libc.a}.
6169 @item -mvxworks
6170 On System V.4 and embedded PowerPC systems, specify that you are
6171 compiling for a VxWorks system.
6173 @item -memb
6174 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6175 header to indicate that @samp{eabi} extended relocations are used.
6177 @item -meabi
6178 @itemx -mno-eabi
6179 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6180 Embedded Applications Binary Interface (eabi) which is a set of
6181 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6182 means that the stack is aligned to an 8 byte boundary, a function
6183 @code{__eabi} is called to from @code{main} to set up the eabi
6184 environment, and the @samp{-msdata} option can use both @code{r2} and
6185 @code{r13} to point to two separate small data areas.  Selecting
6186 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6187 do not call an initialization function from @code{main}, and the
6188 @samp{-msdata} option will only use @code{r13} to point to a single
6189 small data area.  The @samp{-meabi} option is on by default if you
6190 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6192 @item -msdata=eabi
6193 On System V.4 and embedded PowerPC systems, put small initialized
6194 @code{const} global and static data in the @samp{.sdata2} section, which
6195 is pointed to by register @code{r2}.  Put small initialized
6196 non-@code{const} global and static data in the @samp{.sdata} section,
6197 which is pointed to by register @code{r13}.  Put small uninitialized
6198 global and static data in the @samp{.sbss} section, which is adjacent to
6199 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
6200 incompatible with the @samp{-mrelocatable} option.  The
6201 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
6203 @item -msdata=sysv
6204 On System V.4 and embedded PowerPC systems, put small global and static
6205 data in the @samp{.sdata} section, which is pointed to by register
6206 @code{r13}.  Put small uninitialized global and static data in the
6207 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6208 The @samp{-msdata=sysv} option is incompatible with the
6209 @samp{-mrelocatable} option.
6211 @item -msdata=default
6212 @itemx -msdata
6213 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6214 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6215 same as @samp{-msdata=sysv}.
6217 @item -msdata-data
6218 On System V.4 and embedded PowerPC systems, put small global and static
6219 data in the @samp{.sdata} section.  Put small uninitialized global and
6220 static data in the @samp{.sbss} section.  Do not use register @code{r13}
6221 to address small data however.  This is the default behavior unless
6222 other @samp{-msdata} options are used.
6224 @item -msdata=none
6225 @itemx -mno-sdata
6226 On embedded PowerPC systems, put all initialized global and static data
6227 in the @samp{.data} section, and all uninitialized data in the
6228 @samp{.bss} section.
6230 @item -G @var{num}
6231 @cindex smaller data references (PowerPC)
6232 @cindex .sdata/.sdata2 references (PowerPC)
6233 On embedded PowerPC systems, put global and static items less than or
6234 equal to @var{num} bytes into the small data or bss sections instead of
6235 the normal data or bss section.  By default, @var{num} is 8.  The
6236 @samp{-G @var{num}} switch is also passed to the linker.
6237 All modules should be compiled with the same @samp{-G @var{num}} value.
6239 @item -mregnames
6240 @itemx -mno-regnames
6241 On System V.4 and embedded PowerPC systems do (do not) emit register
6242 names in the assembly language output using symbolic forms.
6244 @end table
6246 @node RT Options
6247 @subsection IBM RT Options
6248 @cindex RT options
6249 @cindex IBM RT options
6251 These @samp{-m} options are defined for the IBM RT PC:
6253 @table @gcctabopt
6254 @item -min-line-mul
6255 Use an in-line code sequence for integer multiplies.  This is the
6256 default.
6258 @item -mcall-lib-mul
6259 Call @code{lmul$$} for integer multiples.
6261 @item -mfull-fp-blocks
6262 Generate full-size floating point data blocks, including the minimum
6263 amount of scratch space recommended by IBM.  This is the default.
6265 @item -mminimum-fp-blocks
6266 Do not include extra scratch space in floating point data blocks.  This
6267 results in smaller code, but slower execution, since scratch space must
6268 be allocated dynamically.
6270 @cindex @file{varargs.h} and RT PC
6271 @cindex @file{stdarg.h} and RT PC
6272 @item -mfp-arg-in-fpregs
6273 Use a calling sequence incompatible with the IBM calling convention in
6274 which floating point arguments are passed in floating point registers.
6275 Note that @code{varargs.h} and @code{stdargs.h} will not work with
6276 floating point operands if this option is specified.
6278 @item -mfp-arg-in-gregs
6279 Use the normal calling convention for floating point arguments.  This is
6280 the default.
6282 @item -mhc-struct-return
6283 Return structures of more than one word in memory, rather than in a
6284 register.  This provides compatibility with the MetaWare HighC (hc)
6285 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
6286 with the Portable C Compiler (pcc).
6288 @item -mnohc-struct-return
6289 Return some structures of more than one word in registers, when
6290 convenient.  This is the default.  For compatibility with the
6291 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6292 option @samp{-mhc-struct-return}.
6293 @end table
6295 @node MIPS Options
6296 @subsection MIPS Options
6297 @cindex MIPS options
6299 These @samp{-m} options are defined for the MIPS family of computers:
6301 @table @gcctabopt
6302 @item -mcpu=@var{cpu type}
6303 Assume the defaults for the machine type @var{cpu type} when scheduling
6304 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
6305 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6306 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6307 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
6308 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6309 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
6310 @var{cpu type} will schedule things appropriately for that particular
6311 chip, the compiler will not generate any code that does not meet level 1
6312 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6313 or @samp{-mabi} switch being used.
6315 @item -mips1
6316 Issue instructions from level 1 of the MIPS ISA.  This is the default.
6317 @samp{r3000} is the default @var{cpu type} at this ISA level.
6319 @item -mips2
6320 Issue instructions from level 2 of the MIPS ISA (branch likely, square
6321 root instructions).  @samp{r6000} is the default @var{cpu type} at this
6322 ISA level.
6324 @item -mips3
6325 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
6326 @samp{r4000} is the default @var{cpu type} at this ISA level.
6328 @item -mips4
6329 Issue instructions from level 4 of the MIPS ISA (conditional move,
6330 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
6331 @var{cpu type} at this ISA level.
6333 @item -mfp32
6334 Assume that 32 32-bit floating point registers are available.  This is
6335 the default.
6337 @item -mfp64
6338 Assume that 32 64-bit floating point registers are available.  This is
6339 the default when the @samp{-mips3} option is used.
6341 @item -mgp32
6342 Assume that 32 32-bit general purpose registers are available.  This is
6343 the default.
6345 @item -mgp64
6346 Assume that 32 64-bit general purpose registers are available.  This is
6347 the default when the @samp{-mips3} option is used.
6349 @item -mint64
6350 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
6351 explanation of the default, and the width of pointers.
6353 @item -mlong64
6354 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
6355 explanation of the default, and the width of pointers.
6357 @item -mlong32
6358 Force long, int, and pointer types to be 32 bits wide.
6360 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
6361 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
6362 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6363 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6364 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6365 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
6366 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
6367 the smaller of the width of longs or the width of general purpose
6368 registers (which in turn depends on the ISA).
6370 @item -mabi=32
6371 @itemx -mabi=o64
6372 @itemx -mabi=n32
6373 @itemx -mabi=64
6374 @itemx -mabi=eabi
6375 Generate code for the indicated ABI.  The default instruction level is
6376 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6377 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
6378 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6379 is @samp{64}.
6381 @item -mmips-as
6382 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6383 add normal debug information.  This is the default for all
6384 platforms except for the OSF/1 reference platform, using the OSF/rose
6385 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
6386 switches are used, the @file{mips-tfile} program will encapsulate the
6387 stabs within MIPS ECOFF.
6389 @item -mgas
6390 Generate code for the GNU assembler.  This is the default on the OSF/1
6391 reference platform, using the OSF/rose object format.  Also, this is
6392 the default if the configure option @samp{--with-gnu-as} is used.
6394 @item -msplit-addresses
6395 @itemx -mno-split-addresses
6396 Generate code to load the high and low parts of address constants separately.
6397 This allows @code{gcc} to optimize away redundant loads of the high order
6398 bits of addresses.  This optimization requires GNU as and GNU ld.
6399 This optimization is enabled by default for some embedded targets where
6400 GNU as and GNU ld are standard.
6402 @item -mrnames
6403 @itemx -mno-rnames
6404 The @samp{-mrnames} switch says to output code using the MIPS software
6405 names for the registers, instead of the hardware names (ie, @var{a0}
6406 instead of @var{$4}).  The only known assembler that supports this option
6407 is the Algorithmics assembler.
6409 @item -mgpopt
6410 @itemx -mno-gpopt
6411 The @samp{-mgpopt} switch says to write all of the data declarations
6412 before the instructions in the text section, this allows the MIPS
6413 assembler to generate one word memory references instead of using two
6414 words for short global or static data items.  This is on by default if
6415 optimization is selected.
6417 @item -mstats
6418 @itemx -mno-stats
6419 For each non-inline function processed, the @samp{-mstats} switch
6420 causes the compiler to emit one line to the standard error file to
6421 print statistics about the program (number of registers saved, stack
6422 size, etc.).
6424 @item -mmemcpy
6425 @itemx -mno-memcpy
6426 The @samp{-mmemcpy} switch makes all block moves call the appropriate
6427 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6428 generating inline code.
6430 @item -mmips-tfile
6431 @itemx -mno-mips-tfile
6432 The @samp{-mno-mips-tfile} switch causes the compiler not
6433 postprocess the object file with the @file{mips-tfile} program,
6434 after the MIPS assembler has generated it to add debug support.  If
6435 @file{mips-tfile} is not run, then no local variables will be
6436 available to the debugger.  In addition, @file{stage2} and
6437 @file{stage3} objects will have the temporary file names passed to the
6438 assembler embedded in the object file, which means the objects will
6439 not compare the same.  The @samp{-mno-mips-tfile} switch should only
6440 be used when there are bugs in the @file{mips-tfile} program that
6441 prevents compilation.
6443 @item -msoft-float
6444 Generate output containing library calls for floating point.
6445 @strong{Warning:} the requisite libraries are not part of GCC.
6446 Normally the facilities of the machine's usual C compiler are used, but
6447 this can't be done directly in cross-compilation.  You must make your
6448 own arrangements to provide suitable library functions for
6449 cross-compilation.
6451 @item -mhard-float
6452 Generate output containing floating point instructions.  This is the
6453 default if you use the unmodified sources.
6455 @item -mabicalls
6456 @itemx -mno-abicalls
6457 Emit (or do not emit) the pseudo operations @samp{.abicalls},
6458 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6459 position independent code.
6461 @item -mlong-calls
6462 @itemx -mno-long-calls
6463 Do all calls with the @samp{JALR} instruction, which requires
6464 loading up a function's address into a register before the call.
6465 You need to use this switch, if you call outside of the current
6466 512 megabyte segment to functions that are not through pointers.
6468 @item -mhalf-pic
6469 @itemx -mno-half-pic
6470 Put pointers to extern references into the data section and load them
6471 up, rather than put the references in the text section.
6473 @item -membedded-pic
6474 @itemx -mno-embedded-pic
6475 Generate PIC code suitable for some embedded systems.  All calls are
6476 made using PC relative address, and all data is addressed using the $gp
6477 register.  No more than 65536 bytes of global data may be used.  This
6478 requires GNU as and GNU ld which do most of the work.  This currently
6479 only works on targets which use ECOFF; it does not work with ELF.
6481 @item -membedded-data
6482 @itemx -mno-embedded-data
6483 Allocate variables to the read-only data section first if possible, then
6484 next in the small data section if possible, otherwise in data.  This gives
6485 slightly slower code than the default, but reduces the amount of RAM required
6486 when executing, and thus may be preferred for some embedded systems.
6488 @item -muninit-const-in-rodata
6489 @itemx -mno-uninit-const-in-rodata
6490 When used together with -membedded-data, it will always store uninitialized
6491 const variables in the read-only data section.
6492   
6493 @item -msingle-float
6494 @itemx -mdouble-float
6495 The @samp{-msingle-float} switch tells gcc to assume that the floating
6496 point coprocessor only supports single precision operations, as on the
6497 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
6498 double precision operations.  This is the default.
6500 @item -mmad
6501 @itemx -mno-mad
6502 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6503 as on the @samp{r4650} chip.
6505 @item -m4650
6506 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6507 @samp{-mcpu=r4650}.
6509 @item -mips16
6510 @itemx -mno-mips16
6511 Enable 16-bit instructions.
6513 @item -mentry
6514 Use the entry and exit pseudo ops.  This option can only be used with
6515 @samp{-mips16}.
6517 @item -EL
6518 Compile code for the processor in little endian mode.
6519 The requisite libraries are assumed to exist.
6521 @item -EB
6522 Compile code for the processor in big endian mode.
6523 The requisite libraries are assumed to exist.
6525 @item -G @var{num}
6526 @cindex smaller data references (MIPS)
6527 @cindex gp-relative references (MIPS)
6528 Put global and static items less than or equal to @var{num} bytes into
6529 the small data or bss sections instead of the normal data or bss
6530 section.  This allows the assembler to emit one word memory reference
6531 instructions based on the global pointer (@var{gp} or @var{$28}),
6532 instead of the normal two words used.  By default, @var{num} is 8 when
6533 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
6534 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6535 All modules should be compiled with the same @samp{-G @var{num}}
6536 value.
6538 @item -nocpp
6539 Tell the MIPS assembler to not run its preprocessor over user
6540 assembler files (with a @samp{.s} suffix) when assembling them.
6542 @item -mfix7000
6543 Pass an option to gas which will cause nops to be inserted if
6544 the read of the destination register of an mfhi or mflo instruction
6545 occurs in the following two instructions.
6547 @item -no-crt0
6548 Do not include the default crt0.
6549 @end table
6551 @ifset INTERNALS
6552 These options are defined by the macro
6553 @code{TARGET_SWITCHES} in the machine description.  The default for the
6554 options is also defined by that macro, which enables you to change the
6555 defaults.
6556 @end ifset
6558 @node i386 Options
6559 @subsection Intel 386 Options
6560 @cindex i386 Options
6561 @cindex Intel 386 Options
6563 These @samp{-m} options are defined for the i386 family of computers:
6565 @table @gcctabopt
6566 @item -mcpu=@var{cpu type}
6567 Assume the defaults for the machine type @var{cpu type} when scheduling
6568 instructions.  The choices for @var{cpu type} are @samp{i386},
6569 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
6570 @samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
6572 While picking a specific @var{cpu type} will schedule things appropriately
6573 for that particular chip, the compiler will not generate any code that
6574 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6575 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6576 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
6577 AMD chips as opposed to the Intel ones.
6579 @item -march=@var{cpu type}
6580 Generate instructions for the machine type @var{cpu type}.  The choices
6581 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
6582 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6584 @item -m386
6585 @itemx -m486
6586 @itemx -mpentium
6587 @itemx -mpentiumpro
6588 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6589 respectively.  These synonyms are deprecated.
6591 @item -mintel-syntax
6592 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6594 @item -mieee-fp
6595 @itemx -mno-ieee-fp
6596 Control whether or not the compiler uses IEEE floating point
6597 comparisons.  These handle correctly the case where the result of a
6598 comparison is unordered.
6600 @item -msoft-float
6601 Generate output containing library calls for floating point.
6602 @strong{Warning:} the requisite libraries are not part of GCC.
6603 Normally the facilities of the machine's usual C compiler are used, but
6604 this can't be done directly in cross-compilation.  You must make your
6605 own arrangements to provide suitable library functions for
6606 cross-compilation.
6608 On machines where a function returns floating point results in the 80387
6609 register stack, some floating point opcodes may be emitted even if
6610 @samp{-msoft-float} is used.
6612 @item -mno-fp-ret-in-387
6613 Do not use the FPU registers for return values of functions.
6615 The usual calling convention has functions return values of types
6616 @code{float} and @code{double} in an FPU register, even if there
6617 is no FPU.  The idea is that the operating system should emulate
6618 an FPU.
6620 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6621 in ordinary CPU registers instead.
6623 @item -mno-fancy-math-387
6624 Some 387 emulators do not support the @code{sin}, @code{cos} and
6625 @code{sqrt} instructions for the 387.  Specify this option to avoid
6626 generating those instructions. This option is the default on FreeBSD.
6627 As of revision 2.6.1, these instructions are not generated unless you
6628 also use the @samp{-funsafe-math-optimizations} switch.
6630 @item -malign-double
6631 @itemx -mno-align-double
6632 Control whether GCC aligns @code{double}, @code{long double}, and
6633 @code{long long} variables on a two word boundary or a one word
6634 boundary.  Aligning @code{double} variables on a two word boundary will
6635 produce code that runs somewhat faster on a @samp{Pentium} at the
6636 expense of more memory.
6638 @item -m128bit-long-double
6639 @itemx -m128bit-long-double
6640 Control the size of @code{long double} type. i386 application binary interface
6641 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6642 preffer @code{long double} aligned to 8 or 16 byte boundary.  This is
6643 impossible to reach with 12 byte long doubles in the array accesses.
6645 @strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6646 structures and arrays containing @code{long double} will change their size as
6647 well as function calling convention for function taking @code{long double}
6648 will be modified. 
6650 @item -m96bit-long-double
6651 @itemx -m96bit-long-double
6652 Set the size of @code{long double} to 96 bits as required by the i386
6653 application binary interface.  This is the default.
6655 @item -msvr3-shlib
6656 @itemx -mno-svr3-shlib
6657 Control whether GCC places uninitialized locals into @code{bss} or
6658 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6659 These options are meaningful only on System V Release 3.
6661 @item -mno-wide-multiply
6662 @itemx -mwide-multiply
6663 Control whether GCC uses the @code{mul} and @code{imul} that produce
6664 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6665 long} multiplies and 32-bit division by constants.
6667 @item -mrtd
6668 Use a different function-calling convention, in which functions that
6669 take a fixed number of arguments return with the @code{ret} @var{num}
6670 instruction, which pops their arguments while returning.  This saves one
6671 instruction in the caller since there is no need to pop the arguments
6672 there.
6674 You can specify that an individual function is called with this calling
6675 sequence with the function attribute @samp{stdcall}.  You can also
6676 override the @samp{-mrtd} option by using the function attribute
6677 @samp{cdecl}.  @xref{Function Attributes}.
6679 @strong{Warning:} this calling convention is incompatible with the one
6680 normally used on Unix, so you cannot use it if you need to call
6681 libraries compiled with the Unix compiler.
6683 Also, you must provide function prototypes for all functions that
6684 take variable numbers of arguments (including @code{printf});
6685 otherwise incorrect code will be generated for calls to those
6686 functions.
6688 In addition, seriously incorrect code will result if you call a
6689 function with too many arguments.  (Normally, extra arguments are
6690 harmlessly ignored.)
6692 @item -mregparm=@var{num}
6693 Control how many registers are used to pass integer arguments.  By
6694 default, no registers are used to pass arguments, and at most 3
6695 registers can be used.  You can control this behavior for a specific
6696 function by using the function attribute @samp{regparm}.
6697 @xref{Function Attributes}.
6699 @strong{Warning:} if you use this switch, and
6700 @var{num} is nonzero, then you must build all modules with the same
6701 value, including any libraries.  This includes the system libraries and
6702 startup modules.
6704 @item -malign-loops=@var{num}
6705 Align loops to a 2 raised to a @var{num} byte boundary.  If
6706 @samp{-malign-loops} is not specified, the default is 2 unless
6707 gas 2.8 (or later) is being used in which case the default is
6708 to align the loop on a 16 byte boundary if it is less than 8
6709 bytes away.
6711 @item -malign-jumps=@var{num}
6712 Align instructions that are only jumped to to a 2 raised to a @var{num}
6713 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6714 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6715 gas 2.8 (or later) is being used in which case the default is
6716 to align the instruction on a 16 byte boundary if it is less
6717 than 8 bytes away.
6719 @item -malign-functions=@var{num}
6720 Align the start of functions to a 2 raised to @var{num} byte boundary.
6721 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6722 for a 386, and 4 if optimizing for a 486.
6724 @item -mpreferred-stack-boundary=@var{num}
6725 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6726 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6727 the default is 4 (16 bytes or 128 bits).
6729 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6730 and PentiumPro, @code{double} and @code{long double} values should be
6731 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6732 significant run time performance penalties.  On Pentium III, the
6733 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6734 penalties if it is not 16 byte aligned.
6736 To ensure proper alignment of this values on the stack, the stack boundary
6737 must be as aligned as that required by any value stored on the stack. 
6738 Further, every function must be generated such that it keeps the stack
6739 aligned.  Thus calling a function compiled with a higher preferred
6740 stack boundary from a function compiled with a lower preferred stack
6741 boundary will most likely misalign the stack.  It is recommended that
6742 libraries that use callbacks always use the default setting.
6744 This extra alignment does consume extra stack space.  Code that is sensitive
6745 to stack space usage, such as embedded systems and operating system kernels,
6746 may want to reduce the preferred alignment to
6747 @samp{-mpreferred-stack-boundary=2}.
6749 @item -mpush-args
6750 @kindex -mpush-args
6751 Use PUSH operations to store outgoing parameters. This method is shorter
6752 and usually equally fast as method using SUB/MOV operations and is enabled
6753 by default. In some cases disabling it may improve performance because of
6754 improved scheduling and reduced dependencies.
6756 @item -maccumulate-outgoing-args
6757 @kindex -maccumulate-outgoing-args
6758 If enabled, the maximum amount of space required for outgoing arguments will be
6759 computed in the function prologue. This in faster on most modern CPUs
6760 because of reduced dependencies, improved scheduling and reduced stack usage
6761 when preferred stack boundary is not equal to 2.  The drawback is a notable
6762 increase in code size. This switch implies -mno-push-args.
6764 @item -mthreads
6765 @kindex -mthreads
6766 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6767 on thread-safe exception handling must compile and link all code with the 
6768 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6769 @samp{-D_MT}; when linking, it links in a special thread helper library 
6770 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6772 @item -mno-align-stringops
6773 @kindex -mno-align-stringops
6774 Do not align destination of inlined string operations. This switch reduces
6775 code size and improves performance in case the destination is already aligned,
6776 but gcc don't know about it.
6778 @item -minline-all-stringops
6779 @kindex -minline-all-stringops
6780 By default GCC inlines string operations only when destination is known to be
6781 aligned at least to 4 byte boundary. This enables more inlining, increase code
6782 size, but may improve performance of code that depends on fast memcpy, strlen
6783 and memset for short lengths.
6784 @end table
6786 @node HPPA Options
6787 @subsection HPPA Options
6788 @cindex HPPA Options
6790 These @samp{-m} options are defined for the HPPA family of computers:
6792 @table @gcctabopt
6793 @item -march=@var{architecture type}
6794 Generate code for the specified architecture.  The choices for
6795 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6796 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6797 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6798 architecture option for your machine.  Code compiled for lower numbered
6799 architectures will run on higher numbered architectures, but not the
6800 other way around.
6802 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6803 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6804 support.  
6806 @item -mpa-risc-1-0
6807 @itemx -mpa-risc-1-1
6808 @itemx -mpa-risc-2-0
6809 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6811 @item -mbig-switch
6812 Generate code suitable for big switch tables.  Use this option only if
6813 the assembler/linker complain about out of range branches within a switch
6814 table.
6816 @item -mjump-in-delay
6817 Fill delay slots of function calls with unconditional jump instructions
6818 by modifying the return pointer for the function call to be the target
6819 of the conditional jump.
6821 @item -mdisable-fpregs
6822 Prevent floating point registers from being used in any manner.  This is
6823 necessary for compiling kernels which perform lazy context switching of
6824 floating point registers.  If you use this option and attempt to perform
6825 floating point operations, the compiler will abort.
6827 @item -mdisable-indexing
6828 Prevent the compiler from using indexing address modes.  This avoids some
6829 rather obscure problems when compiling MIG generated code under MACH.
6831 @item -mno-space-regs
6832 Generate code that assumes the target has no space registers.  This allows
6833 GCC to generate faster indirect calls and use unscaled index address modes.
6835 Such code is suitable for level 0 PA systems and kernels.
6837 @item -mfast-indirect-calls
6838 Generate code that assumes calls never cross space boundaries.  This
6839 allows GCC to emit code which performs faster indirect calls.
6841 This option will not work in the presence of shared libraries or nested
6842 functions.
6844 @item -mlong-load-store
6845 Generate 3-instruction load and store sequences as sometimes required by
6846 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6847 the HP compilers.
6849 @item -mportable-runtime
6850 Use the portable calling conventions proposed by HP for ELF systems.
6852 @item -mgas
6853 Enable the use of assembler directives only GAS understands.
6855 @item -mschedule=@var{cpu type}
6856 Schedule code according to the constraints for the machine type
6857 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6858 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6859 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6860 proper scheduling option for your machine.
6862 @item -mlinker-opt
6863 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6864 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6865 in which they give bogus error messages when linking some programs.
6867 @item -msoft-float
6868 Generate output containing library calls for floating point.
6869 @strong{Warning:} the requisite libraries are not available for all HPPA
6870 targets.  Normally the facilities of the machine's usual C compiler are
6871 used, but this cannot be done directly in cross-compilation.  You must make
6872 your own arrangements to provide suitable library functions for
6873 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6874 does provide software floating point support.
6876 @samp{-msoft-float} changes the calling convention in the output file;
6877 therefore, it is only useful if you compile @emph{all} of a program with
6878 this option.  In particular, you need to compile @file{libgcc.a}, the
6879 library that comes with GCC, with @samp{-msoft-float} in order for
6880 this to work.
6881 @end table
6883 @node Intel 960 Options
6884 @subsection Intel 960 Options
6886 These @samp{-m} options are defined for the Intel 960 implementations:
6888 @table @gcctabopt
6889 @item -m@var{cpu type}
6890 Assume the defaults for the machine type @var{cpu type} for some of
6891 the other options, including instruction scheduling, floating point
6892 support, and addressing modes.  The choices for @var{cpu type} are
6893 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6894 @samp{sa}, and @samp{sb}.
6895 The default is
6896 @samp{kb}.
6898 @item -mnumerics
6899 @itemx -msoft-float
6900 The @samp{-mnumerics} option indicates that the processor does support
6901 floating-point instructions.  The @samp{-msoft-float} option indicates
6902 that floating-point support should not be assumed.
6904 @item -mleaf-procedures
6905 @itemx -mno-leaf-procedures
6906 Do (or do not) attempt to alter leaf procedures to be callable with the
6907 @code{bal} instruction as well as @code{call}.  This will result in more
6908 efficient code for explicit calls when the @code{bal} instruction can be
6909 substituted by the assembler or linker, but less efficient code in other
6910 cases, such as calls via function pointers, or using a linker that doesn't
6911 support this optimization.
6913 @item -mtail-call
6914 @itemx -mno-tail-call
6915 Do (or do not) make additional attempts (beyond those of the
6916 machine-independent portions of the compiler) to optimize tail-recursive
6917 calls into branches.  You may not want to do this because the detection of
6918 cases where this is not valid is not totally complete.  The default is
6919 @samp{-mno-tail-call}.
6921 @item -mcomplex-addr
6922 @itemx -mno-complex-addr
6923 Assume (or do not assume) that the use of a complex addressing mode is a
6924 win on this implementation of the i960.  Complex addressing modes may not
6925 be worthwhile on the K-series, but they definitely are on the C-series.
6926 The default is currently @samp{-mcomplex-addr} for all processors except
6927 the CB and CC.
6929 @item -mcode-align
6930 @itemx -mno-code-align
6931 Align code to 8-byte boundaries for faster fetching (or don't bother).
6932 Currently turned on by default for C-series implementations only.
6934 @ignore
6935 @item -mclean-linkage
6936 @itemx -mno-clean-linkage
6937 These options are not fully implemented.
6938 @end ignore
6940 @item -mic-compat
6941 @itemx -mic2.0-compat
6942 @itemx -mic3.0-compat
6943 Enable compatibility with iC960 v2.0 or v3.0.
6945 @item -masm-compat
6946 @itemx -mintel-asm
6947 Enable compatibility with the iC960 assembler.
6949 @item -mstrict-align
6950 @itemx -mno-strict-align
6951 Do not permit (do permit) unaligned accesses.
6953 @item -mold-align
6954 Enable structure-alignment compatibility with Intel's gcc release version
6955 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6957 @item -mlong-double-64
6958 Implement type @samp{long double} as 64-bit floating point numbers.
6959 Without the option @samp{long double} is implemented by 80-bit
6960 floating point numbers.  The only reason we have it because there is
6961 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6962 is only useful for people using soft-float targets.  Otherwise, we
6963 should recommend against use of it.
6965 @end table
6967 @node DEC Alpha Options
6968 @subsection DEC Alpha Options
6970 These @samp{-m} options are defined for the DEC Alpha implementations:
6972 @table @gcctabopt
6973 @item -mno-soft-float
6974 @itemx -msoft-float
6975 Use (do not use) the hardware floating-point instructions for
6976 floating-point operations.  When @option{-msoft-float} is specified,
6977 functions in @file{libgcc1.c} will be used to perform floating-point
6978 operations.  Unless they are replaced by routines that emulate the
6979 floating-point operations, or compiled in such a way as to call such
6980 emulations routines, these routines will issue floating-point
6981 operations.   If you are compiling for an Alpha without floating-point
6982 operations, you must ensure that the library is built so as not to call
6983 them.
6985 Note that Alpha implementations without floating-point operations are
6986 required to have floating-point registers.
6988 @item -mfp-reg
6989 @itemx -mno-fp-regs
6990 Generate code that uses (does not use) the floating-point register set.
6991 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
6992 register set is not used, floating point operands are passed in integer
6993 registers as if they were integers and floating-point results are passed
6994 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6995 function with a floating-point argument or return value called by code
6996 compiled with @option{-mno-fp-regs} must also be compiled with that
6997 option.
6999 A typical use of this option is building a kernel that does not use,
7000 and hence need not save and restore, any floating-point registers.
7002 @item -mieee
7003 The Alpha architecture implements floating-point hardware optimized for
7004 maximum performance.  It is mostly compliant with the IEEE floating
7005 point standard.  However, for full compliance, software assistance is
7006 required.  This option generates code fully IEEE compliant code
7007 @emph{except} that the @var{inexact flag} is not maintained (see below).
7008 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
7009 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
7010 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
7011 code is less efficient but is able to correctly support denormalized
7012 numbers and exceptional IEEE values such as not-a-number and plus/minus
7013 infinity.  Other Alpha compilers call this option
7014 @option{-ieee_with_no_inexact}.
7016 @item -mieee-with-inexact
7017 @c overfull hbox here --bob 22 jul96
7018 @c original text between ignore ... end ignore
7019 @ignore
7020 This is like @samp{-mieee} except the generated code also maintains the
7021 IEEE @var{inexact flag}.  Turning on this option causes the generated
7022 code to implement fully-compliant IEEE math.  The option is a shorthand
7023 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
7024 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
7025 implementations the resulting code may execute significantly slower than
7026 the code generated by default.  Since there is very little code that
7027 depends on the @var{inexact flag}, you should normally not specify this
7028 option.  Other Alpha compilers call this option
7029 @samp{-ieee_with_inexact}.
7030 @end ignore
7031 @c            changed paragraph
7032 This is like @samp{-mieee} except the generated code also maintains the
7033 IEEE @var{inexact flag}.  Turning on this option causes the generated
7034 code to implement fully-compliant IEEE math.  The option is a shorthand
7035 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
7036 @samp{-mieee-conformant},
7037 @samp{-mfp-trap-mode=sui}, 
7038 and @samp{-mtrap-precision=i}.  
7039 On some Alpha implementations the resulting code may execute
7040 significantly slower than the code generated by default.  Since there
7041 is very little code that depends on the @var{inexact flag}, you should
7042 normally not specify this option.  Other Alpha compilers call this
7043 option @samp{-ieee_with_inexact}.
7044 @c             end changes to prevent overfull hboxes
7046 @item -mfp-trap-mode=@var{trap mode}
7047 This option controls what floating-point related traps are enabled.
7048 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7049 The trap mode can be set to one of four values:
7051 @table @samp
7052 @item n
7053 This is the default (normal) setting.  The only traps that are enabled
7054 are the ones that cannot be disabled in software (e.g., division by zero
7055 trap).
7057 @item u
7058 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7059 as well.
7061 @item su
7062 Like @samp{su}, but the instructions are marked to be safe for software
7063 completion (see Alpha architecture manual for details).
7065 @item sui
7066 Like @samp{su}, but inexact traps are enabled as well.
7067 @end table
7069 @item -mfp-rounding-mode=@var{rounding mode}
7070 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7071 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
7074 @table @samp
7075 @item n
7076 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7077 the nearest machine number or towards the even machine number in case
7078 of a tie.
7080 @item m
7081 Round towards minus infinity.
7083 @item c
7084 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7086 @item d
7087 Dynamic rounding mode.  A field in the floating point control register
7088 (@var{fpcr}, see Alpha architecture reference manual) controls the
7089 rounding mode in effect.  The C library initializes this register for
7090 rounding towards plus infinity.  Thus, unless your program modifies the
7091 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7092 @end table
7094 @item -mtrap-precision=@var{trap precision}
7095 In the Alpha architecture, floating point traps are imprecise.  This
7096 means without software assistance it is impossible to recover from a
7097 floating trap and program execution normally needs to be terminated.
7098 GCC can generate code that can assist operating system trap handlers
7099 in determining the exact location that caused a floating point trap.
7100 Depending on the requirements of an application, different levels of
7101 precisions can be selected:
7103 @table @samp
7104 @item p
7105 Program precision.  This option is the default and means a trap handler
7106 can only identify which program caused a floating point exception.
7108 @item f
7109 Function precision.  The trap handler can determine the function that
7110 caused a floating point exception.
7112 @item i
7113 Instruction precision.  The trap handler can determine the exact
7114 instruction that caused a floating point exception.
7115 @end table
7117 Other Alpha compilers provide the equivalent options called
7118 @samp{-scope_safe} and @samp{-resumption_safe}.
7120 @item -mieee-conformant
7121 This option marks the generated code as IEEE conformant.  You must not
7122 use this option unless you also specify @samp{-mtrap-precision=i} and either
7123 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
7124 is to emit the line @samp{.eflag 48} in the function prologue of the
7125 generated assembly file.  Under DEC Unix, this has the effect that
7126 IEEE-conformant math library routines will be linked in.
7128 @item -mbuild-constants
7129 Normally GCC examines a 32- or 64-bit integer constant to
7130 see if it can construct it from smaller constants in two or three
7131 instructions.  If it cannot, it will output the constant as a literal and
7132 generate code to load it from the data segment at runtime.
7134 Use this option to require GCC to construct @emph{all} integer constants
7135 using code, even if it takes more instructions (the maximum is six).
7137 You would typically use this option to build a shared library dynamic
7138 loader.  Itself a shared library, it must relocate itself in memory
7139 before it can find the variables and constants in its own data segment.
7141 @item -malpha-as
7142 @itemx -mgas
7143 Select whether to generate code to be assembled by the vendor-supplied
7144 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7146 @item -mbwx
7147 @itemx -mno-bwx
7148 @itemx -mcix
7149 @itemx -mno-cix
7150 @itemx -mmax
7151 @itemx -mno-max
7152 Indicate whether GCC should generate code to use the optional BWX,
7153 CIX, and MAX instruction sets.  The default is to use the instruction sets
7154 supported by the CPU type specified via @samp{-mcpu=} option or that
7155 of the CPU on which GCC was built if none was specified.
7157 @item -mcpu=@var{cpu_type}
7158 Set the instruction set, register set, and instruction scheduling
7159 parameters for machine type @var{cpu_type}.  You can specify either the
7160 @samp{EV} style name or the corresponding chip number.  GCC
7161 supports scheduling parameters for the EV4 and EV5 family of processors
7162 and will choose the default values for the instruction set from
7163 the processor you specify.  If you do not specify a processor type,
7164 GCC will default to the processor on which the compiler was built.
7166 Supported values for @var{cpu_type} are
7168 @table @samp
7169 @item ev4
7170 @itemx 21064
7171 Schedules as an EV4 and has no instruction set extensions.
7173 @item ev5
7174 @itemx 21164
7175 Schedules as an EV5 and has no instruction set extensions.
7177 @item ev56
7178 @itemx 21164a
7179 Schedules as an EV5 and supports the BWX extension.
7181 @item pca56
7182 @itemx 21164pc
7183 @itemx 21164PC
7184 Schedules as an EV5 and supports the BWX and MAX extensions.
7186 @item ev6
7187 @itemx 21264
7188 Schedules as an EV5 (until Digital releases the scheduling parameters
7189 for the EV6) and supports the BWX, CIX, and MAX extensions.
7190 @end table
7192 @item -mmemory-latency=@var{time}
7193 Sets the latency the scheduler should assume for typical memory
7194 references as seen by the application.  This number is highly
7195 dependent on the memory access patterns used by the application
7196 and the size of the external cache on the machine.
7198 Valid options for @var{time} are
7200 @table @samp
7201 @item @var{number}
7202 A decimal number representing clock cycles.
7204 @item L1
7205 @itemx L2
7206 @itemx L3
7207 @itemx main
7208 The compiler contains estimates of the number of clock cycles for
7209 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7210 (also called Dcache, Scache, and Bcache), as well as to main memory.
7211 Note that L3 is only valid for EV5.
7213 @end table
7214 @end table
7216 @node Clipper Options
7217 @subsection Clipper Options
7219 These @samp{-m} options are defined for the Clipper implementations:
7221 @table @gcctabopt
7222 @item -mc300
7223 Produce code for a C300 Clipper processor. This is the default.
7225 @item -mc400
7226 Produce code for a C400 Clipper processor i.e. use floating point
7227 registers f8..f15.
7228 @end table
7230 @node H8/300 Options
7231 @subsection H8/300 Options
7233 These @samp{-m} options are defined for the H8/300 implementations:
7235 @table @gcctabopt
7236 @item -mrelax
7237 Shorten some address references at link time, when possible; uses the
7238 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7239 ld.info, Using ld}, for a fuller description.
7241 @item -mh
7242 Generate code for the H8/300H.
7244 @item -ms
7245 Generate code for the H8/S.
7247 @item -ms2600
7248 Generate code for the H8/S2600.  This switch must be used with -ms.
7250 @item -mint32
7251 Make @code{int} data 32 bits by default.
7253 @item -malign-300
7254 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7255 The default for the H8/300H and H8/S is to align longs and floats on 4
7256 byte boundaries.
7257 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
7258 This option has no effect on the H8/300.
7259 @end table
7261 @node SH Options
7262 @subsection SH Options
7264 These @samp{-m} options are defined for the SH implementations:
7266 @table @gcctabopt
7267 @item -m1
7268 Generate code for the SH1.
7270 @item -m2
7271 Generate code for the SH2.
7273 @item -m3
7274 Generate code for the SH3.
7276 @item -m3e
7277 Generate code for the SH3e.
7279 @item -m4-nofpu
7280 Generate code for the SH4 without a floating-point unit.
7282 @item -m4-single-only
7283 Generate code for the SH4 with a floating-point unit that only
7284 supports single-precision arithmentic.
7286 @item -m4-single
7287 Generate code for the SH4 assuming the floating-point unit is in
7288 single-precision mode by default.
7290 @item -m4
7291 Generate code for the SH4.
7293 @item -mb
7294 Compile code for the processor in big endian mode.
7296 @item -ml
7297 Compile code for the processor in little endian mode.
7299 @item -mdalign
7300 Align doubles at 64 bit boundaries.  Note that this changes the calling
7301 conventions, and thus some functions from the standard C library will
7302 not work unless you recompile it first with -mdalign.
7304 @item -mrelax
7305 Shorten some address references at link time, when possible; uses the
7306 linker option @samp{-relax}.
7308 @item -mbigtable
7309 Use 32-bit offsets in @code{switch} tables.  The default is to use
7310 16-bit offsets.
7312 @item -mfmovd
7313 Enable the use of the instruction @code{fmovd}.
7315 @item -mhitachi
7316 Comply with the calling conventions defined by Hitachi.
7318 @item -mnomacsave
7319 Mark the @code{MAC} register as call-clobbered, even if
7320 @option{-mhitachi} is given.
7322 @item -misize
7323 Dump instruction size and location in the assembly code.
7325 @item -mpadstruct
7326 This option is deprecated.  It pads structures to multiple of 4 bytes,
7327 which is incompatible with the SH ABI.
7329 @item -mspace
7330 Optimize for space instead of speed.  Implied by @option{-Os}.
7332 @item -mprefergot
7333 When generating position-independent code, emit function calls using
7334 the Global Offset Table instead of the Procedure Linkage Table.
7336 @item -musermode
7337 Generate a library function call to invalidate instruction cache
7338 entries, after fixing up a trampoline.  This library function call
7339 doesn't assume it can write to the whole memory address space.  This
7340 is the default when the target is @code{sh-*-linux*}.
7341 @end table
7343 @node System V Options
7344 @subsection Options for System V
7346 These additional options are available on System V Release 4 for
7347 compatibility with other compilers on those systems:
7349 @table @gcctabopt
7350 @item -G
7351 Create a shared object.
7352 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7354 @item -Qy
7355 Identify the versions of each tool used by the compiler, in a
7356 @code{.ident} assembler directive in the output.
7358 @item -Qn
7359 Refrain from adding @code{.ident} directives to the output file (this is
7360 the default).
7362 @item -YP\,@var{dirs}
7363 Search the directories @var{dirs}, and no others, for libraries
7364 specified with @samp{-l}.
7366 @item -Ym\,@var{dir}
7367 Look in the directory @var{dir} to find the M4 preprocessor.
7368 The assembler uses this option.
7369 @c This is supposed to go with a -Yd for predefined M4 macro files, but
7370 @c the generic assembler that comes with Solaris takes just -Ym.
7371 @end table
7373 @node TMS320C3x/C4x Options
7374 @subsection TMS320C3x/C4x Options
7375 @cindex TMS320C3x/C4x Options
7377 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7379 @table @gcctabopt
7381 @item -mcpu=@var{cpu_type}
7382 Set the instruction set, register set, and instruction scheduling
7383 parameters for machine type @var{cpu_type}.  Supported values for
7384 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7385 @samp{c44}.  The default is @samp{c40} to generate code for the
7386 TMS320C40.
7388 @item -mbig-memory
7389 @item -mbig
7390 @itemx -msmall-memory
7391 @itemx -msmall
7392 Generates code for the big or small memory model.  The small memory
7393 model assumed that all data fits into one 64K word page.  At run-time
7394 the data page (DP) register must be set to point to the 64K page
7395 containing the .bss and .data program sections.  The big memory model is
7396 the default and requires reloading of the DP register for every direct
7397 memory access.
7399 @item -mbk
7400 @itemx -mno-bk
7401 Allow (disallow) allocation of general integer operands into the block
7402 count register BK. 
7404 @item -mdb
7405 @itemx -mno-db
7406 Enable (disable) generation of code using decrement and branch,
7407 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
7408 on the safe side, this is disabled for the C3x, since the maximum
7409 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
7410 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
7411 that it can utilise the decrement and branch instruction, but will give
7412 up if there is more than one memory reference in the loop.  Thus a loop
7413 where the loop counter is decremented can generate slightly more
7414 efficient code, in cases where the RPTB instruction cannot be utilised.
7416 @item -mdp-isr-reload
7417 @itemx -mparanoid
7418 Force the DP register to be saved on entry to an interrupt service
7419 routine (ISR), reloaded to point to the data section, and restored on
7420 exit from the ISR.  This should not be required unless someone has
7421 violated the small memory model by modifying the DP register, say within
7422 an object library.
7424 @item -mmpyi
7425 @itemx -mno-mpyi
7426 For the C3x use the 24-bit MPYI instruction for integer multiplies
7427 instead of a library call to guarantee 32-bit results.  Note that if one
7428 of the operands is a constant, then the multiplication will be performed
7429 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
7430 then squaring operations are performed inline instead of a library call.
7432 @item -mfast-fix
7433 @itemx -mno-fast-fix
7434 The C3x/C4x FIX instruction to convert a floating point value to an
7435 integer value chooses the nearest integer less than or equal to the
7436 floating point value rather than to the nearest integer.  Thus if the
7437 floating point number is negative, the result will be incorrectly
7438 truncated an additional code is necessary to detect and correct this
7439 case.  This option can be used to disable generation of the additional
7440 code required to correct the result.
7442 @item -mrptb
7443 @itemx -mno-rptb
7444 Enable (disable) generation of repeat block sequences using the RPTB
7445 instruction for zero overhead looping.  The RPTB construct is only used
7446 for innermost loops that do not call functions or jump across the loop
7447 boundaries.  There is no advantage having nested RPTB loops due to the
7448 overhead required to save and restore the RC, RS, and RE registers.
7449 This is enabled by default with -O2.
7451 @item -mrpts=@var{count}
7452 @itemx -mno-rpts
7453 Enable (disable) the use of the single instruction repeat instruction
7454 RPTS.  If a repeat block contains a single instruction, and the loop
7455 count can be guaranteed to be less than the value @var{count}, GCC will
7456 emit a RPTS instruction instead of a RPTB.  If no value is specified,
7457 then a RPTS will be emitted even if the loop count cannot be determined
7458 at compile time.  Note that the repeated instruction following RPTS does
7459 not have to be reloaded from memory each iteration, thus freeing up the
7460 CPU buses for operands.  However, since interrupts are blocked by this
7461 instruction, it is disabled by default.
7463 @item -mloop-unsigned
7464 @itemx -mno-loop-unsigned
7465 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7466 is 2^31 + 1 since these instructions test if the iteration count is
7467 negative to terminate the loop.  If the iteration count is unsigned
7468 there is a possibility than the 2^31 + 1 maximum iteration count may be
7469 exceeded.  This switch allows an unsigned iteration count.
7471 @item -mti
7472 Try to emit an assembler syntax that the TI assembler (asm30) is happy
7473 with.  This also enforces compatibility with the API employed by the TI
7474 C3x C compiler.  For example, long doubles are passed as structures
7475 rather than in floating point registers.
7477 @item -mregparm
7478 @itemx -mmemparm
7479 Generate code that uses registers (stack) for passing arguments to functions.
7480 By default, arguments are passed in registers where possible rather
7481 than by pushing arguments on to the stack.
7483 @item -mparallel-insns
7484 @itemx -mno-parallel-insns
7485 Allow the generation of parallel instructions.  This is enabled by
7486 default with -O2.
7488 @item -mparallel-mpy
7489 @itemx -mno-parallel-mpy
7490 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7491 provided -mparallel-insns is also specified.  These instructions have
7492 tight register constraints which can pessimize the code generation
7493 of large functions.
7495 @end table
7497 @node V850 Options
7498 @subsection V850 Options
7499 @cindex V850 Options
7501 These @samp{-m} options are defined for V850 implementations:
7503 @table @gcctabopt
7504 @item -mlong-calls
7505 @itemx -mno-long-calls
7506 Treat all calls as being far away (near).  If calls are assumed to be
7507 far away, the compiler will always load the functions address up into a
7508 register, and call indirect through the pointer.
7510 @item -mno-ep
7511 @itemx -mep
7512 Do not optimize (do optimize) basic blocks that use the same index
7513 pointer 4 or more times to copy pointer into the @code{ep} register, and
7514 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
7515 option is on by default if you optimize.
7517 @item -mno-prolog-function
7518 @itemx -mprolog-function
7519 Do not use (do use) external functions to save and restore registers at
7520 the prolog and epilog of a function.  The external functions are slower,
7521 but use less code space if more than one function saves the same number
7522 of registers.  The @samp{-mprolog-function} option is on by default if
7523 you optimize.
7525 @item -mspace
7526 Try to make the code as small as possible.  At present, this just turns
7527 on the @samp{-mep} and @samp{-mprolog-function} options.
7529 @item -mtda=@var{n}
7530 Put static or global variables whose size is @var{n} bytes or less into
7531 the tiny data area that register @code{ep} points to.  The tiny data
7532 area can hold up to 256 bytes in total (128 bytes for byte references).
7534 @item -msda=@var{n}
7535 Put static or global variables whose size is @var{n} bytes or less into
7536 the small data area that register @code{gp} points to.  The small data
7537 area can hold up to 64 kilobytes.
7539 @item -mzda=@var{n}
7540 Put static or global variables whose size is @var{n} bytes or less into
7541 the first 32 kilobytes of memory.
7543 @item -mv850
7544 Specify that the target processor is the V850.
7546 @item -mbig-switch
7547 Generate code suitable for big switch tables.  Use this option only if
7548 the assembler/linker complain about out of range branches within a switch
7549 table.
7550 @end table
7552 @node ARC Options
7553 @subsection ARC Options
7554 @cindex ARC Options
7556 These options are defined for ARC implementations:
7558 @table @gcctabopt
7559 @item -EL
7560 Compile code for little endian mode.  This is the default.
7562 @item -EB
7563 Compile code for big endian mode.
7565 @item -mmangle-cpu
7566 Prepend the name of the cpu to all public symbol names.
7567 In multiple-processor systems, there are many ARC variants with different
7568 instruction and register set characteristics.  This flag prevents code
7569 compiled for one cpu to be linked with code compiled for another.
7570 No facility exists for handling variants that are "almost identical".
7571 This is an all or nothing option.
7573 @item -mcpu=@var{cpu}
7574 Compile code for ARC variant @var{cpu}.
7575 Which variants are supported depend on the configuration.
7576 All variants support @samp{-mcpu=base}, this is the default.
7578 @item -mtext=@var{text section}
7579 @itemx -mdata=@var{data section}
7580 @itemx -mrodata=@var{readonly data section}
7581 Put functions, data, and readonly data in @var{text section},
7582 @var{data section}, and @var{readonly data section} respectively
7583 by default.  This can be overridden with the @code{section} attribute.
7584 @xref{Variable Attributes}.
7586 @end table
7588 @node NS32K Options
7589 @subsection NS32K Options
7590 @cindex NS32K options
7592 These are the @samp{-m} options defined for the 32000 series.  The default
7593 values for these options depends on which style of 32000 was selected when
7594 the compiler was configured; the defaults for the most common choices are
7595 given below.
7597 @table @gcctabopt
7598 @item -m32032
7599 @itemx -m32032
7600 Generate output for a 32032.  This is the default
7601 when the compiler is configured for 32032 and 32016 based systems.
7603 @item -m32332
7604 @itemx -m32332
7605 Generate output for a 32332.  This is the default
7606 when the compiler is configured for 32332-based systems.
7608 @item -m32532
7609 @itemx -m32532
7610 Generate output for a 32532.  This is the default
7611 when the compiler is configured for 32532-based systems.
7613 @item -m32081
7614 Generate output containing 32081 instructions for floating point.
7615 This is the default for all systems.
7617 @item -m32381
7618 Generate output containing 32381 instructions for floating point.  This
7619 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7620 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7622 @item -mmulti-add
7623 Try and generate multiply-add floating point instructions @code{polyF}
7624 and @code{dotF}. This option is only available if the @samp{-m32381}
7625 option is in effect. Using these instructions requires changes to to
7626 register allocation which generally has a negative impact on
7627 performance.  This option should only be enabled when compiling code
7628 particularly likely to make heavy use of multiply-add instructions.
7630 @item -mnomulti-add
7631 Do not try and generate multiply-add floating point instructions
7632 @code{polyF} and @code{dotF}. This is the default on all platforms.
7634 @item -msoft-float
7635 Generate output containing library calls for floating point.
7636 @strong{Warning:} the requisite libraries may not be available.
7638 @item -mnobitfield
7639 Do not use the bit-field instructions. On some machines it is faster to
7640 use shifting and masking operations. This is the default for the pc532.
7642 @item -mbitfield
7643 Do use the bit-field instructions. This is the default for all platforms
7644 except the pc532.
7646 @item -mrtd
7647 Use a different function-calling convention, in which functions
7648 that take a fixed number of arguments return pop their
7649 arguments on return with the @code{ret} instruction.
7651 This calling convention is incompatible with the one normally
7652 used on Unix, so you cannot use it if you need to call libraries
7653 compiled with the Unix compiler.
7655 Also, you must provide function prototypes for all functions that
7656 take variable numbers of arguments (including @code{printf});
7657 otherwise incorrect code will be generated for calls to those
7658 functions.
7660 In addition, seriously incorrect code will result if you call a
7661 function with too many arguments.  (Normally, extra arguments are
7662 harmlessly ignored.)
7664 This option takes its name from the 680x0 @code{rtd} instruction.
7667 @item -mregparam
7668 Use a different function-calling convention where the first two arguments
7669 are passed in registers.
7671 This calling convention is incompatible with the one normally
7672 used on Unix, so you cannot use it if you need to call libraries
7673 compiled with the Unix compiler.
7675 @item -mnoregparam
7676 Do not pass any arguments in registers. This is the default for all
7677 targets.
7679 @item -msb
7680 It is OK to use the sb as an index register which is always loaded with
7681 zero. This is the default for the pc532-netbsd target.
7683 @item -mnosb
7684 The sb register is not available for use or has not been initialized to
7685 zero by the run time system. This is the default for all targets except
7686 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7687 @samp{-fpic} is set.
7689 @item -mhimem
7690 Many ns32000 series addressing modes use displacements of up to 512MB.
7691 If an address is above 512MB then displacements from zero can not be used.
7692 This option causes code to be generated which can be loaded above 512MB.
7693 This may be useful for operating systems or ROM code.
7695 @item -mnohimem
7696 Assume code will be loaded in the first 512MB of virtual address space.
7697 This is the default for all platforms.
7700 @end table
7702 @node AVR Options
7703 @subsection AVR Options
7704 @cindex AVR Options
7706 These options are defined for AVR implementations:
7708 @table @gcctabopt
7709 @item -mmcu=@var{mcu}
7710 Specify ATMEL AVR instruction set or MCU type.
7712 Instruction set avr1 is for the minimal AVR core, not supported by the C
7713 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7714 attiny11, attiny12, attiny15, attiny28).
7716 Instruction set avr2 (default) is for the classic AVR core with up to
7717 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7718 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7719 at90c8534, at90s8535).
7721 Instruction set avr3 is for the classic AVR core with up to 128K program
7722 memory space (MCU types: atmega103, atmega603).
7724 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7725 memory space (MCU types: atmega83, atmega85).
7727 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7728 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
7730 @item -msize
7731 Output instruction sizes to the asm file.
7733 @item -minit-stack=@var{N}
7734 Specify the initial stack address, which may be a symbol or numeric value,
7735 __stack is the default.
7737 @item -mno-interrupts
7738 Generated code is not compatible with hardware interrupts.
7739 Code size will be smaller.
7741 @item -mcall-prologues
7742 Functions prologues/epilogues expanded as call to appropriate
7743 subroutines. Code size will be smaller.
7745 @item -mno-tablejump
7746 Do not generate tablejump insns which sometimes increase code size.
7748 @item -mtiny-stack
7749 Change only the low 8 bits of the stack pointer.
7750 @end table
7752 @node MCore Options
7753 @subsection MCore Options
7754 @cindex MCore options
7756 These are the @samp{-m} options defined for the Motorola M*Core
7757 processors.  
7759 @table @gcctabopt
7761 @item -mhardlit
7762 @itemx -mhardlit
7763 @itemx -mno-hardlit
7764 Inline constants into the code stream if it can be done in two
7765 instructions or less.
7767 @item -mdiv
7768 @itemx -mdiv
7769 @itemx -mno-div
7770 Use the divide instruction.  (Enabled by default).
7772 @item -mrelax-immediate
7773 @itemx -mrelax-immediate
7774 @itemx -mno-relax-immediate
7775 Allow arbitrary sized immediates in bit operations.
7777 @item -mwide-bitfields
7778 @itemx -mwide-bitfields
7779 @itemx -mno-wide-bitfields
7780 Always treat bitfields as int-sized.
7782 @item -m4byte-functions
7783 @itemx -m4byte-functions
7784 @itemx -mno-4byte-functions
7785 Force all functions to be aligned to a four byte boundary.
7787 @item -mcallgraph-data
7788 @itemx -mcallgraph-data
7789 @itemx -mno-callgraph-data
7790 Emit callgraph information.
7792 @item -mslow-bytes
7793 @itemx -mslow-bytes
7794 @itemx -mno-slow-bytes
7795 Prefer word access when reading byte quantities.
7797 @item -mlittle-endian
7798 @itemx -mlittle-endian
7799 @itemx -mbig-endian
7800 Generate code for a little endian target.
7802 @item -m210
7803 @itemx -m210
7804 @itemx -m340
7805 Generate code for the 210 processor.
7806 @end table
7808 @node IA-64 Options
7809 @subsection IA-64 Options
7810 @cindex IA-64 Options
7812 These are the @samp{-m} options defined for the Intel IA-64 architecture.
7814 @table @gcctabopt
7815 @item -mbig-endian
7816 Generate code for a big endian target.  This is the default for HPUX.
7818 @item -mlittle-endian
7819 Generate code for a little endian target.  This is the default for AIX5
7820 and Linux.
7822 @item -mgnu-as
7823 @itemx -mno-gnu-as
7824 Generate (or don't) code for the GNU assembler.  This is the default.
7825 @c Also, this is the default if the configure option @samp{--with-gnu-as}
7826 @c is used.
7828 @item -mgnu-ld
7829 @itemx -mno-gnu-ld
7830 Generate (or don't) code for the GNU linker.  This is the default.
7831 @c Also, this is the default if the configure option @samp{--with-gnu-ld}
7832 @c is used.
7834 @item -mno-pic
7835 Generate code that does not use a global pointer register.  The result
7836 is not position independent code, and violates the IA-64 ABI.
7838 @item -mvolatile-asm-stop
7839 @itemx -mno-volatile-asm-stop
7840 Generate (or don't) a stop bit immediately before and after volatile asm
7841 statements.
7843 @item -mb-step
7844 Generate code that works around Itanium B step errata.
7846 @item -mregister-names
7847 @itemx -mno-register-names
7848 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7849 the stacked registers.  This may make assembler output more readable.
7851 @item -mno-sdata
7852 @itemx -msdata
7853 Disable (or enable) optimizations that use the small data section.  This may
7854 be useful for working around optimizer bugs.
7856 @item -mconstant-gp
7857 Generate code that uses a single constant global pointer value.  This is
7858 useful when compiling kernel code.
7860 @item -mauto-pic
7861 Generate code that is self-relocatable.  This implies @samp{-mconstant-gp}.
7862 This is useful when compiling firmware code.
7864 @item -minline-divide-min-latency
7865 Generate code for inline divides using the minimum latency algorithm.
7867 @item -minline-divide-max-throughput
7868 Generate code for inline divides using the maximum throughput algorithm.
7870 @item -mno-dwarf2-asm
7871 @itemx -mdwarf2-asm
7872 Don't (or do) generate assembler code for the DWARF2 line number debugging
7873 info.  This may be useful when not using the GNU assembler.
7875 @item -mfixed-range=@var{register range}
7876 Generate code treating the given register range as fixed registers.
7877 A fixed register is one that the register allocator can not use.  This is
7878 useful when compiling kernel code.  A register range is specified as
7879 two registers separated by a dash.  Multiple register ranges can be
7880 specified separated by a comma.
7881 @end table
7883 @node D30V Options
7884 @subsection D30V Options
7885 @cindex D30V Options
7887 These @samp{-m} options are defined for D30V implementations:
7889 @table @gcctabopt
7890 @item -mextmem
7891 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7892 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7893 memory, which starts at location @code{0x80000000}.
7895 @item -mextmemory
7896 Same as the @samp{-mextmem} switch.
7898 @item -monchip
7899 Link the @samp{.text} section into onchip text memory, which starts at
7900 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
7901 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7902 into onchip data memory, which starts at location @code{0x20000000}.
7904 @item -mno-asm-optimize
7905 @itemx -masm-optimize
7906 Disable (enable) passing @samp{-O} to the assembler when optimizing.
7907 The assembler uses the @samp{-O} option to automatically parallelize
7908 adjacent short instructions where possible.
7910 @item -mbranch-cost=@var{n}
7911 Increase the internal costs of branches to @var{n}.  Higher costs means
7912 that the compiler will issue more instructions to avoid doing a branch.
7913 The default is 2.
7915 @item -mcond-exec=@var{n}
7916 Specify the maximum number of conditionally executed instructions that
7917 replace a branch.  The default is 4.
7918 @end table
7920 @node Code Gen Options
7921 @section Options for Code Generation Conventions
7922 @cindex code generation conventions
7923 @cindex options, code generation
7924 @cindex run-time options
7926 These machine-independent options control the interface conventions
7927 used in code generation.
7929 Most of them have both positive and negative forms; the negative form
7930 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7931 one of the forms is listed---the one which is not the default.  You
7932 can figure out the other form by either removing @samp{no-} or adding
7935 @table @gcctabopt
7936 @item -fexceptions
7937 Enable exception handling. Generates extra code needed to propagate
7938 exceptions.  For some targets, this implies GNU CC will generate frame
7939 unwind information for all functions, which can produce significant data
7940 size overhead, although it does not affect execution.  If you do not
7941 specify this option, GNU CC will enable it by default for languages like
7942 C++ which normally require exception handling, and disable itfor
7943 languages like C that do not normally require it.  However, you may need
7944 to enable this option when compiling C code that needs to interoperate
7945 properly with exception handlers written in C++.  You may also wish to
7946 disable this option if you are compiling older C++ programs that don't
7947 use exception handling.
7949 @item -funwind-tables
7950 Similar to @option{-fexceptions}, except that it will just generate any needed
7951 static data, but will not affect the generated code in any other way.
7952 You will normally not enable this option; instead, a language processor
7953 that needs this handling would enable it on your behalf.
7955 @item -fpcc-struct-return
7956 Return ``short'' @code{struct} and @code{union} values in memory like
7957 longer ones, rather than in registers.  This convention is less
7958 efficient, but it has the advantage of allowing intercallability between
7959 GCC-compiled files and files compiled with other compilers.
7961 The precise convention for returning structures in memory depends
7962 on the target configuration macros.
7964 Short structures and unions are those whose size and alignment match
7965 that of some integer type.
7967 @item -freg-struct-return
7968 Use the convention that @code{struct} and @code{union} values are
7969 returned in registers when possible.  This is more efficient for small
7970 structures than @samp{-fpcc-struct-return}.
7972 If you specify neither @samp{-fpcc-struct-return} nor its contrary
7973 @samp{-freg-struct-return}, GCC defaults to whichever convention is
7974 standard for the target.  If there is no standard convention, GCC
7975 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
7976 is the principal compiler.  In those cases, we can choose the standard,
7977 and we chose the more efficient register return alternative.
7979 @item -fshort-enums
7980 Allocate to an @code{enum} type only as many bytes as it needs for the
7981 declared range of possible values.  Specifically, the @code{enum} type
7982 will be equivalent to the smallest integer type which has enough room.
7984 @item -fshort-double
7985 Use the same size for @code{double} as for @code{float}.
7987 @item -fshared-data
7988 Requests that the data and non-@code{const} variables of this
7989 compilation be shared data rather than private data.  The distinction
7990 makes sense only on certain operating systems, where shared data is
7991 shared between processes running the same program, while private data
7992 exists in one copy per process.
7994 @item -fno-common
7995 Allocate even uninitialized global variables in the data section of the
7996 object file, rather than generating them as common blocks.  This has the
7997 effect that if the same variable is declared (without @code{extern}) in
7998 two different compilations, you will get an error when you link them.
7999 The only reason this might be useful is if you wish to verify that the
8000 program will work on other systems which always work this way.
8002 @item -fno-ident
8003 Ignore the @samp{#ident} directive.
8005 @item -fno-gnu-linker
8006 Do not output global initializations (such as C++ constructors and
8007 destructors) in the form used by the GNU linker (on systems where the GNU
8008 linker is the standard method of handling them).  Use this option when
8009 you want to use a non-GNU linker, which also requires using the
8010 @command{collect2} program to make sure the system linker includes
8011 constructors and destructors.  (@command{collect2} is included in the GCC
8012 distribution.)  For systems which @emph{must} use @command{collect2}, the
8013 compiler driver @command{gcc} is configured to do this automatically.
8015 @item -finhibit-size-directive
8016 Don't output a @code{.size} assembler directive, or anything else that
8017 would cause trouble if the function is split in the middle, and the
8018 two halves are placed at locations far apart in memory.  This option is
8019 used when compiling @file{crtstuff.c}; you should not need to use it
8020 for anything else.
8022 @item -fverbose-asm
8023 Put extra commentary information in the generated assembly code to
8024 make it more readable.  This option is generally only of use to those
8025 who actually need to read the generated assembly code (perhaps while
8026 debugging the compiler itself).
8028 @samp{-fno-verbose-asm}, the default, causes the
8029 extra information to be omitted and is useful when comparing two assembler
8030 files.
8032 @item -fvolatile
8033 Consider all memory references through pointers to be volatile.
8035 @item -fvolatile-global
8036 Consider all memory references to extern and global data items to
8037 be volatile.  GCC does not consider static data items to be volatile
8038 because of this switch.
8040 @item -fvolatile-static
8041 Consider all memory references to static data to be volatile.
8043 @item -fpic
8044 @cindex global offset table
8045 @cindex PIC
8046 Generate position-independent code (PIC) suitable for use in a shared
8047 library, if supported for the target machine.  Such code accesses all
8048 constant addresses through a global offset table (GOT).  The dynamic
8049 loader resolves the GOT entries when the program starts (the dynamic
8050 loader is not part of GCC; it is part of the operating system).  If
8051 the GOT size for the linked executable exceeds a machine-specific
8052 maximum size, you get an error message from the linker indicating that
8053 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8054 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8055 on the m68k and RS/6000.  The 386 has no such limit.)
8057 Position-independent code requires special support, and therefore works
8058 only on certain machines.  For the 386, GCC supports PIC for System V
8059 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
8060 position-independent.
8062 @item -fPIC
8063 If supported for the target machine, emit position-independent code,
8064 suitable for dynamic linking and avoiding any limit on the size of the
8065 global offset table.  This option makes a difference on the m68k, m88k,
8066 and the Sparc.
8068 Position-independent code requires special support, and therefore works
8069 only on certain machines.
8071 @item -ffixed-@var{reg}
8072 Treat the register named @var{reg} as a fixed register; generated code
8073 should never refer to it (except perhaps as a stack pointer, frame
8074 pointer or in some other fixed role).
8076 @var{reg} must be the name of a register.  The register names accepted
8077 are machine-specific and are defined in the @code{REGISTER_NAMES}
8078 macro in the machine description macro file.
8080 This flag does not have a negative form, because it specifies a
8081 three-way choice.
8083 @item -fcall-used-@var{reg}
8084 Treat the register named @var{reg} as an allocable register that is
8085 clobbered by function calls.  It may be allocated for temporaries or
8086 variables that do not live across a call.  Functions compiled this way
8087 will not save and restore the register @var{reg}.
8089 It is an error to used this flag with the frame pointer or stack pointer.
8090 Use of this flag for other registers that have fixed pervasive roles in
8091 the machine's execution model will produce disastrous results.
8093 This flag does not have a negative form, because it specifies a
8094 three-way choice.
8096 @item -fcall-saved-@var{reg}
8097 Treat the register named @var{reg} as an allocable register saved by
8098 functions.  It may be allocated even for temporaries or variables that
8099 live across a call.  Functions compiled this way will save and restore
8100 the register @var{reg} if they use it.
8102 It is an error to used this flag with the frame pointer or stack pointer.
8103 Use of this flag for other registers that have fixed pervasive roles in
8104 the machine's execution model will produce disastrous results.
8106 A different sort of disaster will result from the use of this flag for
8107 a register in which function values may be returned.
8109 This flag does not have a negative form, because it specifies a
8110 three-way choice.
8112 @item -fpack-struct
8113 Pack all structure members together without holes.  Usually you would
8114 not want to use this option, since it makes the code suboptimal, and
8115 the offsets of structure members won't agree with system libraries.
8117 @item -fcheck-memory-usage
8118 Generate extra code to check each memory access.  GCC will generate
8119 code that is suitable for a detector of bad memory accesses such as
8120 @file{Checker}.
8122 Normally, you should compile all, or none, of your code with this option.
8124 If you do mix code compiled with and without this option,
8125 you must ensure that all code that has side effects
8126 and that is called by code compiled with this option
8127 is, itself, compiled with this option.
8128 If you do not, you might get erroneous messages from the detector.
8130 If you use functions from a library that have side-effects (such as
8131 @code{read}), you might not be able to recompile the library and
8132 specify this option.  In that case, you can enable the
8133 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
8134 your code and make other functions look as if they were compiled with
8135 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
8136 which are provided by the detector.  If you cannot find or build
8137 stubs for every function you call, you might have to specify
8138 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8140 If you specify this option, you can not use the @code{asm} or
8141 @code{__asm__} keywords in functions with memory checking enabled.  GNU
8142 CC cannot understand what the @code{asm} statement may do, and therefore
8143 cannot generate the appropriate code, so it will reject it.  However, if
8144 you specify the function attribute @code{no_check_memory_usage}
8145 (@pxref{Function Attributes}), GNU CC will disable memory checking within a
8146 function; you may use @code{asm} statements inside such functions.  You
8147 may have an inline expansion of a non-checked function within a checked
8148 function; in that case GNU CC will not generate checks for the inlined
8149 function's memory accesses.
8151 If you move your @code{asm} statements to non-checked inline functions
8152 and they do access memory, you can add calls to the support code in your
8153 inline function, to indicate any reads, writes, or copies being done.
8154 These calls would be similar to those done in the stubs described above.
8156 @item -fprefix-function-name
8157 Request GCC to add a prefix to the symbols generated for function names.
8158 GCC adds a prefix to the names of functions defined as well as
8159 functions called.  Code compiled with this option and code compiled
8160 without the option can't be linked together, unless stubs are used.
8162 If you compile the following code with @samp{-fprefix-function-name}
8163 @example
8164 extern void bar (int);
8165 void
8166 foo (int a)
8168   return bar (a + 5);
8170 @end example
8172 @noindent
8173 GCC will compile the code as if it was written:
8174 @example
8175 extern void prefix_bar (int);
8176 void
8177 prefix_foo (int a)
8179   return prefix_bar (a + 5);
8181 @end example
8182 This option is designed to be used with @samp{-fcheck-memory-usage}.
8184 @item -finstrument-functions
8185 Generate instrumentation calls for entry and exit to functions.  Just
8186 after function entry and just before function exit, the following
8187 profiling functions will be called with the address of the current
8188 function and its call site.  (On some platforms,
8189 @code{__builtin_return_address} does not work beyond the current
8190 function, so the call site information may not be available to the
8191 profiling functions otherwise.)
8193 @example
8194 void __cyg_profile_func_enter (void *this_fn, void *call_site);
8195 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
8196 @end example
8198 The first argument is the address of the start of the current function,
8199 which may be looked up exactly in the symbol table.
8201 This instrumentation is also done for functions expanded inline in other
8202 functions.  The profiling calls will indicate where, conceptually, the
8203 inline function is entered and exited.  This means that addressable
8204 versions of such functions must be available.  If all your uses of a
8205 function are expanded inline, this may mean an additional expansion of
8206 code size.  If you use @samp{extern inline} in your C code, an
8207 addressable version of such functions must be provided.  (This is
8208 normally the case anyways, but if you get lucky and the optimizer always
8209 expands the functions inline, you might have gotten away without
8210 providing static copies.)
8212 A function may be given the attribute @code{no_instrument_function}, in
8213 which case this instrumentation will not be done.  This can be used, for
8214 example, for the profiling functions listed above, high-priority
8215 interrupt routines, and any functions from which the profiling functions
8216 cannot safely be called (perhaps signal handlers, if the profiling
8217 routines generate output or allocate memory).
8219 @item -fstack-check
8220 Generate code to verify that you do not go beyond the boundary of the
8221 stack.  You should specify this flag if you are running in an
8222 environment with multiple threads, but only rarely need to specify it in
8223 a single-threaded environment since stack overflow is automatically
8224 detected on nearly all systems if there is only one stack.
8226 Note that this switch does not actually cause checking to be done; the
8227 operating system must do that.  The switch causes generation of code
8228 to ensure that the operating system sees the stack being extended.
8230 @item -fstack-limit-register=@var{reg}
8231 @itemx -fstack-limit-symbol=@var{sym}
8232 @itemx -fno-stack-limit
8233 Generate code to ensure that the stack does not grow beyond a certain value,
8234 either the value of a register or the address of a symbol.  If the stack
8235 would grow beyond the value, a signal is raised.  For most targets,
8236 the signal is raised before the stack overruns the boundary, so
8237 it is possible to catch the signal without taking special precautions.
8239 For instance, if the stack starts at address @samp{0x80000000} and grows
8240 downwards you can use the flags
8241 @samp{-fstack-limit-symbol=__stack_limit}
8242 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8243 limit of 128K.
8245 @cindex aliasing of parameters
8246 @cindex parameters, aliased
8247 @item -fargument-alias
8248 @itemx -fargument-noalias
8249 @itemx -fargument-noalias-global
8250 Specify the possible relationships among parameters and between
8251 parameters and global data.
8253 @samp{-fargument-alias} specifies that arguments (parameters) may
8254 alias each other and may alias global storage.
8255 @samp{-fargument-noalias} specifies that arguments do not alias
8256 each other, but may alias global storage.
8257 @samp{-fargument-noalias-global} specifies that arguments do not
8258 alias each other and do not alias global storage.
8260 Each language will automatically use whatever option is required by
8261 the language standard.  You should not need to use these options yourself.
8263 @item -fleading-underscore
8264 This option and its counterpart, -fno-leading-underscore, forcibly
8265 change the way C symbols are represented in the object file.  One use
8266 is to help link with legacy assembly code.
8268 Be warned that you should know what you are doing when invoking this
8269 option, and that not all targets provide complete support for it.
8270 @end table
8272 @c man end
8274 @node Environment Variables
8275 @section Environment Variables Affecting GCC
8276 @cindex environment variables
8278 @c man begin ENVIRONMENT
8280 This section describes several environment variables that affect how GCC
8281 operates.  Some of them work by specifying directories or prefixes to use
8282 when searching for various kinds of files. Some are used to specify other
8283 aspects of the compilation environment.
8285 @ifclear INTERNALS
8286 Note that you can also specify places to search using options such as
8287 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8288 take precedence over places specified using environment variables, which
8289 in turn take precedence over those specified by the configuration of GCC.
8291 @end ifclear
8292 @ifset INTERNALS
8293 Note that you can also specify places to search using options such as
8294 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8295 take precedence over places specified using environment variables, which
8296 in turn take precedence over those specified by the configuration of GCC.
8297 @xref{Driver}.
8298 @end ifset
8300 @table @env
8301 @item LANG
8302 @itemx LC_CTYPE
8303 @c @itemx LC_COLLATE
8304 @itemx LC_MESSAGES
8305 @c @itemx LC_MONETARY
8306 @c @itemx LC_NUMERIC
8307 @c @itemx LC_TIME
8308 @itemx LC_ALL
8309 @findex LANG
8310 @findex LC_CTYPE
8311 @c @findex LC_COLLATE
8312 @findex LC_MESSAGES
8313 @c @findex LC_MONETARY
8314 @c @findex LC_NUMERIC
8315 @c @findex LC_TIME
8316 @findex LC_ALL
8317 @cindex locale
8318 These environment variables control the way that GCC uses
8319 localization information that allow GCC to work with different
8320 national conventions.  GCC inspects the locale categories
8321 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
8322 so.  These locale categories can be set to any value supported by your
8323 installation.  A typical value is @samp{en_UK} for English in the United
8324 Kingdom.
8326 The @env{LC_CTYPE} environment variable specifies character
8327 classification.  GCC uses it to determine the character boundaries in
8328 a string; this is needed for some multibyte encodings that contain quote
8329 and escape characters that would otherwise be interpreted as a string
8330 end or escape.
8332 The @env{LC_MESSAGES} environment variable specifies the language to
8333 use in diagnostic messages.
8335 If the @env{LC_ALL} environment variable is set, it overrides the value
8336 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8337 and @env{LC_MESSAGES} default to the value of the @env{LANG}
8338 environment variable.  If none of these variables are set, GCC
8339 defaults to traditional C English behavior.
8341 @item TMPDIR
8342 @findex TMPDIR
8343 If @env{TMPDIR} is set, it specifies the directory to use for temporary
8344 files.  GCC uses temporary files to hold the output of one stage of
8345 compilation which is to be used as input to the next stage: for example,
8346 the output of the preprocessor, which is the input to the compiler
8347 proper.
8349 @item GCC_EXEC_PREFIX
8350 @findex GCC_EXEC_PREFIX
8351 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
8352 names of the subprograms executed by the compiler.  No slash is added
8353 when this prefix is combined with the name of a subprogram, but you can
8354 specify a prefix that ends with a slash if you wish.
8356 If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
8357 an appropriate prefix to use based on the pathname it was invoked with.
8359 If GCC cannot find the subprogram using the specified prefix, it
8360 tries looking in the usual places for the subprogram.
8362 The default value of @env{GCC_EXEC_PREFIX} is
8363 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8364 of @code{prefix} when you ran the @file{configure} script.
8366 Other prefixes specified with @samp{-B} take precedence over this prefix.
8368 This prefix is also used for finding files such as @file{crt0.o} that are
8369 used for linking.
8371 In addition, the prefix is used in an unusual way in finding the
8372 directories to search for header files.  For each of the standard
8373 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
8374 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
8375 replacing that beginning with the specified prefix to produce an
8376 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
8377 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8378 These alternate directories are searched first; the standard directories
8379 come next.
8381 @item COMPILER_PATH
8382 @findex COMPILER_PATH
8383 The value of @env{COMPILER_PATH} is a colon-separated list of
8384 directories, much like @env{PATH}.  GCC tries the directories thus
8385 specified when searching for subprograms, if it can't find the
8386 subprograms using @env{GCC_EXEC_PREFIX}.
8388 @item LIBRARY_PATH
8389 @findex LIBRARY_PATH
8390 The value of @env{LIBRARY_PATH} is a colon-separated list of
8391 directories, much like @env{PATH}.  When configured as a native compiler,
8392 GCC tries the directories thus specified when searching for special
8393 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
8394 using GCC also uses these directories when searching for ordinary
8395 libraries for the @samp{-l} option (but directories specified with
8396 @samp{-L} come first).
8398 @item C_INCLUDE_PATH
8399 @itemx CPLUS_INCLUDE_PATH
8400 @itemx OBJC_INCLUDE_PATH
8401 @findex C_INCLUDE_PATH
8402 @findex CPLUS_INCLUDE_PATH
8403 @findex OBJC_INCLUDE_PATH
8404 @c @itemx OBJCPLUS_INCLUDE_PATH
8405 These environment variables pertain to particular languages.  Each
8406 variable's value is a colon-separated list of directories, much like
8407 @env{PATH}.  When GCC searches for header files, it tries the
8408 directories listed in the variable for the language you are using, after
8409 the directories specified with @samp{-I} but before the standard header
8410 file directories.
8412 @item DEPENDENCIES_OUTPUT
8413 @findex DEPENDENCIES_OUTPUT
8414 @cindex dependencies for make as output
8415 If this variable is set, its value specifies how to output dependencies
8416 for Make based on the header files processed by the compiler.  This
8417 output looks much like the output from the @samp{-M} option
8418 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
8419 in addition to the usual results of compilation.
8421 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
8422 which case the Make rules are written to that file, guessing the target
8423 name from the source file name.  Or the value can have the form
8424 @samp{@var{file} @var{target}}, in which case the rules are written to
8425 file @var{file} using @var{target} as the target name.
8427 @item LANG
8428 @findex LANG
8429 @cindex locale definition
8430 This variable is used to pass locale information to the compiler. One way in
8431 which this information is used is to determine the character set to be used
8432 when character literals, string literals and comments are parsed in C and C++.
8433 When the compiler is configured to allow multibyte characters,
8434 the following values for @env{LANG} are recognized:
8436 @table @samp
8437 @item C-JIS
8438 Recognize JIS characters.
8439 @item C-SJIS
8440 Recognize SJIS characters.
8441 @item C-EUCJP
8442 Recognize EUCJP characters.
8443 @end table
8445 If @env{LANG} is not defined, or if it has some other value, then the
8446 compiler will use mblen and mbtowc as defined by the default locale to
8447 recognize and translate multibyte characters.
8448 @end table
8450 @c man end
8452 @node Running Protoize
8453 @section Running Protoize
8455 The program @code{protoize} is an optional part of GNU C.  You can use
8456 it to add prototypes to a program, thus converting the program to ISO
8457 C in one respect.  The companion program @code{unprotoize} does the
8458 reverse: it removes argument types from any prototypes that are found.
8460 When you run these programs, you must specify a set of source files as
8461 command line arguments.  The conversion programs start out by compiling
8462 these files to see what functions they define.  The information gathered
8463 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8465 After scanning comes actual conversion.  The specified files are all
8466 eligible to be converted; any files they include (whether sources or
8467 just headers) are eligible as well.
8469 But not all the eligible files are converted.  By default,
8470 @code{protoize} and @code{unprotoize} convert only source and header
8471 files in the current directory.  You can specify additional directories
8472 whose files should be converted with the @samp{-d @var{directory}}
8473 option.  You can also specify particular files to exclude with the
8474 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
8475 directory name matches one of the specified directory names, and its
8476 name within the directory has not been excluded.
8478 Basic conversion with @code{protoize} consists of rewriting most
8479 function definitions and function declarations to specify the types of
8480 the arguments.  The only ones not rewritten are those for varargs
8481 functions.
8483 @code{protoize} optionally inserts prototype declarations at the
8484 beginning of the source file, to make them available for any calls that
8485 precede the function's definition.  Or it can insert prototype
8486 declarations with block scope in the blocks where undeclared functions
8487 are called.
8489 Basic conversion with @code{unprotoize} consists of rewriting most
8490 function declarations to remove any argument types, and rewriting
8491 function definitions to the old-style pre-ISO form.
8493 Both conversion programs print a warning for any function declaration or
8494 definition that they can't convert.  You can suppress these warnings
8495 with @samp{-q}.
8497 The output from @code{protoize} or @code{unprotoize} replaces the
8498 original source file.  The original file is renamed to a name ending
8499 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
8500 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
8501 for DOS) file already exists, then the source file is simply discarded.
8503 @code{protoize} and @code{unprotoize} both depend on GCC itself to
8504 scan the program and collect information about the functions it uses.
8505 So neither of these programs will work until GCC is installed.
8507 Here is a table of the options you can use with @code{protoize} and
8508 @code{unprotoize}.  Each option works with both programs unless
8509 otherwise stated.
8511 @table @code
8512 @item -B @var{directory}
8513 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8514 usual directory (normally @file{/usr/local/lib}).  This file contains
8515 prototype information about standard system functions.  This option
8516 applies only to @code{protoize}.
8518 @item -c @var{compilation-options}
8519 Use  @var{compilation-options} as the options when running @code{gcc} to
8520 produce the @samp{.X} files.  The special option @samp{-aux-info} is
8521 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8523 Note that the compilation options must be given as a single argument to
8524 @code{protoize} or @code{unprotoize}.  If you want to specify several
8525 @code{gcc} options, you must quote the entire set of compilation options
8526 to make them a single word in the shell.
8528 There are certain @code{gcc} arguments that you cannot use, because they
8529 would produce the wrong kind of output.  These include @samp{-g},
8530 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8531 the @var{compilation-options}, they are ignored.
8533 @item -C
8534 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8535 systems) instead of @samp{.c}.  This is convenient if you are converting 
8536 a C program to C++.  This option applies only to @code{protoize}.
8538 @item -g
8539 Add explicit global declarations.  This means inserting explicit
8540 declarations at the beginning of each source file for each function
8541 that is called in the file and was not declared.  These declarations
8542 precede the first function definition that contains a call to an
8543 undeclared function.  This option applies only to @code{protoize}.
8545 @item -i @var{string}
8546 Indent old-style parameter declarations with the string @var{string}.
8547 This option applies only to @code{protoize}.
8549 @code{unprotoize} converts prototyped function definitions to old-style
8550 function definitions, where the arguments are declared between the
8551 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
8552 uses five spaces as the indentation.  If you want to indent with just
8553 one space instead, use @samp{-i " "}.
8555 @item -k
8556 Keep the @samp{.X} files.  Normally, they are deleted after conversion
8557 is finished.
8559 @item -l
8560 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
8561 a prototype declaration for each function in each block which calls the
8562 function without any declaration.  This option applies only to
8563 @code{protoize}.
8565 @item -n
8566 Make no real changes.  This mode just prints information about the conversions
8567 that would have been done without @samp{-n}.
8569 @item -N
8570 Make no @samp{.save} files.  The original files are simply deleted.
8571 Use this option with caution.
8573 @item -p @var{program}
8574 Use the program @var{program} as the compiler.  Normally, the name
8575 @file{gcc} is used.
8577 @item -q
8578 Work quietly.  Most warnings are suppressed.
8580 @item -v
8581 Print the version number, just like @samp{-v} for @code{gcc}.
8582 @end table
8584 If you need special compiler options to compile one of your program's
8585 source files, then you should generate that file's @samp{.X} file
8586 specially, by running @code{gcc} on that source file with the
8587 appropriate options and the option @samp{-aux-info}.  Then run
8588 @code{protoize} on the entire set of files.  @code{protoize} will use
8589 the existing @samp{.X} file because it is newer than the source file.
8590 For example:
8592 @example
8593 gcc -Dfoo=bar file1.c -aux-info
8594 protoize *.c
8595 @end example
8597 @noindent
8598 You need to include the special files along with the rest in the
8599 @code{protoize} command, even though their @samp{.X} files already
8600 exist, because otherwise they won't get converted.
8602 @xref{Protoize Caveats}, for more information on how to use
8603 @code{protoize} successfully.