* configure.in: Don't check for putenv.
[official-gcc.git] / gcc / invoke.texi
blob72fc1c8671546fed6dd393915aa7f499df939fa5
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 should never be turned on by any @samp{-O} option since
2944 it can result in incorrect output for programs which depend on
2945 an exact implementation of IEEE or ISO rules/specifications for
2946 math functions.
2948 @item -fno-math-errno
2949 Do not set ERRNO after calling math functions that are executed
2950 with a single instruction, e.g., sqrt.  A program that relies on
2951 IEEE exceptions for math error handling may want to use this flag
2952 for speed while maintaining IEEE arithmetic compatibility.
2954 This option should never be turned on by any @samp{-O} option since
2955 it can result in incorrect output for programs which depend on
2956 an exact implementation of IEEE or ISO rules/specifications for
2957 math functions.
2959 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2960 sets @samp{-fno-math-errno}.
2962 @item -funsafe-math-optimizations
2963 Allow optimizations for floating-point arithmetic that (a) assume
2964 that arguments and results are valid and (b) may violate IEEE or
2965 ANSI standards.  
2967 This option should never be turned on by any @samp{-O} option since
2968 it can result in incorrect output for programs which depend on
2969 an exact implementation of IEEE or ISO rules/specifications for
2970 math functions.
2972 The default is @samp{-fno-unsafe-math-optimizations}.  The
2973 @samp{-ffast-math} option sets @samp{-funsafe-math-optimizations}.
2975 @item -fno-trapping-math
2976 Compile code assuming that floating-point operations cannot generate
2977 user-visible traps.  Setting this option may allow faster code
2978 if one relies on ``non-stop'' IEEE arithmetic, for example.
2980 This option should never be turned on by any @samp{-O} option since
2981 it can result in incorrect output for programs which depend on
2982 an exact implementation of IEEE or ISO rules/specifications for
2983 math functions.
2985 The default is @samp{-ftrapping-math}.  The @samp{-ffast-math}
2986 option sets @samp{-fno-trapping-math}.
2987 @end table
2989 @c following causes underfulls.. they don't look great, but we deal.
2990 @c --mew 26jan93
2991 The following options control specific optimizations.  The @samp{-O2}
2992 option turns on all of these optimizations except @samp{-funroll-loops}
2993 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2994 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2995 but specific machines may handle it differently.
2997 You can use the following flags in the rare cases when ``fine-tuning''
2998 of optimizations to be performed is desired.
3000 @table @gcctabopt
3001 @item -fstrength-reduce
3002 Perform the optimizations of loop strength reduction and
3003 elimination of iteration variables.
3005 @item -fthread-jumps
3006 Perform optimizations where we check to see if a jump branches to a
3007 location where another comparison subsumed by the first is found.  If
3008 so, the first branch is redirected to either the destination of the
3009 second branch or a point immediately following it, depending on whether
3010 the condition is known to be true or false.
3012 @item -fcse-follow-jumps
3013 In common subexpression elimination, scan through jump instructions
3014 when the target of the jump is not reached by any other path.  For
3015 example, when CSE encounters an @code{if} statement with an
3016 @code{else} clause, CSE will follow the jump when the condition
3017 tested is false.
3019 @item -fcse-skip-blocks
3020 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
3021 follow jumps which conditionally skip over blocks.  When CSE
3022 encounters a simple @code{if} statement with no else clause,
3023 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
3024 body of the @code{if}.
3026 @item -frerun-cse-after-loop
3027 Re-run common subexpression elimination after loop optimizations has been
3028 performed.
3030 @item -frerun-loop-opt
3031 Run the loop optimizer twice.
3033 @item -fgcse
3034 Perform a global common subexpression elimination pass.
3035 This pass also performs global constant and copy propagation.
3037 @item -fdelete-null-pointer-checks
3038 Use global dataflow analysis to identify and eliminate useless null
3039 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
3040 halting the program may not work properly with this option.  Use
3041 -fno-delete-null-pointer-checks to disable this optimizing for programs
3042 which depend on that behavior.
3044 @item -fexpensive-optimizations
3045 Perform a number of minor optimizations that are relatively expensive.
3047 @item -foptimize-register-move
3048 @itemx -fregmove
3049 Attempt to reassign register numbers in move instructions and as
3050 operands of other simple instructions in order to maximize the amount of
3051 register tying.  This is especially helpful on machines with two-operand
3052 instructions.  GCC enables this optimization by default with @samp{-O2}
3053 or higher.
3055 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3056 optimization.
3058 @item -fdelayed-branch
3059 If supported for the target machine, attempt to reorder instructions
3060 to exploit instruction slots available after delayed branch
3061 instructions.
3063 @item -fschedule-insns
3064 If supported for the target machine, attempt to reorder instructions to
3065 eliminate execution stalls due to required data being unavailable.  This
3066 helps machines that have slow floating point or memory load instructions
3067 by allowing other instructions to be issued until the result of the load
3068 or floating point instruction is required.
3070 @item -fschedule-insns2
3071 Similar to @samp{-fschedule-insns}, but requests an additional pass of
3072 instruction scheduling after register allocation has been done.  This is
3073 especially useful on machines with a relatively small number of
3074 registers and where memory load instructions take more than one cycle.
3076 @item -ffunction-sections
3077 @itemx -fdata-sections
3078 Place each function or data item into its own section in the output
3079 file if the target supports arbitrary sections.  The name of the
3080 function or the name of the data item determines the section's name
3081 in the output file.
3083 Use these options on systems where the linker can perform optimizations
3084 to improve locality of reference in the instruction space.  HPPA
3085 processors running HP-UX and Sparc processors running Solaris 2 have
3086 linkers with such optimizations.  Other systems using the ELF object format
3087 as well as AIX may have these optimizations in the future.
3089 Only use these options when there are significant benefits from doing
3090 so.  When you specify these options, the assembler and linker will
3091 create larger object and executable files and will also be slower.
3092 You will not be able to use @code{gprof} on all systems if you
3093 specify this option and you may have problems with debugging if
3094 you specify both this option and @samp{-g}.
3096 @item -fcaller-saves
3097 Enable values to be allocated in registers that will be clobbered by
3098 function calls, by emitting extra instructions to save and restore the
3099 registers around such calls.  Such allocation is done only when it
3100 seems to result in better code than would otherwise be produced.
3102 This option is always enabled by default on certain machines, usually
3103 those which have no call-preserved registers to use instead.
3105 For all machines, optimization level 2 and higher enables this flag by
3106 default.
3108 @item -funroll-loops
3109 Perform the optimization of loop unrolling.  This is only done for loops
3110 whose number of iterations can be determined at compile time or run time.
3111 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
3112 @samp{-frerun-cse-after-loop}.
3114 @item -funroll-all-loops
3115 Perform the optimization of loop unrolling.  This is done for all loops
3116 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
3117 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3119 @item -fmove-all-movables
3120 Forces all invariant computations in loops to be moved
3121 outside the loop.
3123 @item -freduce-all-givs
3124 Forces all general-induction variables in loops to be
3125 strength-reduced.
3127 @emph{Note:} When compiling programs written in Fortran,
3128 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
3129 by default when you use the optimizer.
3131 These options may generate better or worse code; results are highly
3132 dependent on the structure of loops within the source code.
3134 These two options are intended to be removed someday, once
3135 they have helped determine the efficacy of various
3136 approaches to improving loop optimizations.
3138 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3139 know how use of these options affects
3140 the performance of your production code.
3141 We're very interested in code that runs @emph{slower}
3142 when these options are @emph{enabled}.
3144 @item -fno-peephole
3145 Disable any machine-specific peephole optimizations.
3147 @item -fbranch-probabilities
3148 After running a program compiled with @samp{-fprofile-arcs}
3149 (@pxref{Debugging Options,, Options for Debugging Your Program or
3150 @command{gcc}}), you can compile it a second time using
3151 @samp{-fbranch-probabilities}, to improve optimizations based on
3152 guessing the path a branch might take.
3154 @ifset INTERNALS
3155 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3156 note on the first instruction of each basic block, and a
3157 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3158 These can be used to improve optimization.  Currently, they are only
3159 used in one place: in @file{reorg.c}, instead of guessing which path a
3160 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3161 exactly determine which path is taken more often.
3162 @end ifset
3164 @item -fno-guess-branch-probability
3165 Sometimes gcc will opt to guess branch probabilities when none are
3166 available from either profile directed feedback (@samp{-fprofile-arcs})
3167 or @samp{__builtin_expect}.  In a hard real-time system, people don't
3168 want different runs of the compiler to produce code that has different
3169 behavior; minimizing non-determinism is of paramount import.  This
3170 switch allows users to reduce non-determinism, possibly at the expense
3171 of inferior optimization.
3173 @item -fstrict-aliasing
3174 Allows the compiler to assume the strictest aliasing rules applicable to
3175 the language being compiled.  For C (and C++), this activates
3176 optimizations based on the type of expressions.  In particular, an
3177 object of one type is assumed never to reside at the same address as an
3178 object of a different type, unless the types are almost the same.  For
3179 example, an @code{unsigned int} can alias an @code{int}, but not a
3180 @code{void*} or a @code{double}.  A character type may alias any other
3181 type.  
3183 Pay special attention to code like this:
3184 @example
3185 union a_union @{ 
3186   int i;
3187   double d;
3190 int f() @{
3191   a_union t;
3192   t.d = 3.0;
3193   return t.i;
3195 @end example
3196 The practice of reading from a different union member than the one most
3197 recently written to (called ``type-punning'') is common.  Even with
3198 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3199 is accessed through the union type.  So, the code above will work as
3200 expected.  However, this code might not:
3201 @example
3202 int f() @{ 
3203   a_union t;
3204   int* ip;
3205   t.d = 3.0;
3206   ip = &t.i;
3207   return *ip;
3209 @end example
3211 @ifset INTERNALS
3212 Every language that wishes to perform language-specific alias analysis
3213 should define a function that computes, given an @code{tree}
3214 node, an alias set for the node.  Nodes in different alias sets are not
3215 allowed to alias.  For an example, see the C front-end function
3216 @code{c_get_alias_set}.
3217 @end ifset
3219 @item -falign-functions
3220 @itemx -falign-functions=@var{n}
3221 Align the start of functions to the next power-of-two greater than
3222 @var{n}, skipping up to @var{n} bytes.  For instance,
3223 @samp{-falign-functions=32} aligns functions to the next 32-byte
3224 boundary, but @samp{-falign-functions=24} would align to the next
3225 32-byte boundary only if this can be done by skipping 23 bytes or less.
3227 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
3228 equivalent and mean that functions will not be aligned.
3230 Some assemblers only support this flag when @var{n} is a power of two;
3231 in that case, it is rounded up.
3233 If @var{n} is not specified, use a machine-dependent default.
3235 @item -falign-labels
3236 @itemx -falign-labels=@var{n}
3237 Align all branch targets to a power-of-two boundary, skipping up to
3238 @var{n} bytes like @samp{-falign-functions}.  This option can easily
3239 make code slower, because it must insert dummy operations for when the
3240 branch target is reached in the usual flow of the code.
3242 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3243 are greater than this value, then their values are used instead.
3245 If @var{n} is not specified, use a machine-dependent default which is
3246 very likely to be @samp{1}, meaning no alignment.
3248 @item -falign-loops
3249 @itemx -falign-loops=@var{n}
3250 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3251 like @samp{-falign-functions}.  The hope is that the loop will be
3252 executed many times, which will make up for any execution of the dummy
3253 operations.
3255 If @var{n} is not specified, use a machine-dependent default.
3257 @item -falign-jumps
3258 @itemx -falign-jumps=@var{n}
3259 Align branch targets to a power-of-two boundary, for branch targets
3260 where the targets can only be reached by jumping, skipping up to @var{n}
3261 bytes like @samp{-falign-functions}.  In this case, no dummy operations
3262 need be executed.
3264 If @var{n} is not specified, use a machine-dependent default.
3266 @item -fssa
3267 Perform optimizations in static single assignment form.  Each function's
3268 flow graph is translated into SSA form, optimizations are performed, and
3269 the flow graph is translated back from SSA form.  User's should not
3270 specify this option, since it is not yet ready for production use.
3272 @item -fdce
3273 Perform dead-code elimination in SSA form.  Requires @samp{-fssa}.  Like
3274 @samp{-fssa}, this is an experimental feature.
3276 @item -fsingle-precision-constant
3277 Treat floating point constant as single precision constant instead of
3278 implicitly converting it to double precision constant.
3280 @item -frename-registers
3281 Attempt to avoid false dependancies in scheduled code by making use
3282 of registers left over after register allocation.  This optimization
3283 will most benefit processors with lots of registers.  It can, however,
3284 make debugging impossible, since variables will no longer stay in
3285 a ``home register''.
3287 @item --param @var{name}=@var{value}
3288 In some places, GCC uses various constants to control the amount of
3289 optimization that is done.  For example, GCC will not inline functions
3290 that contain more that a certain number of instructions.  You can
3291 control some of these constants on the command-line using the
3292 @samp{--param} option.  
3294 In each case, the @var{value} is a integer.  The allowable choices for
3295 @var{name} are given in the following table:
3297 @table @gcctabopt
3298 @item max-inline-insns
3299 If an function contains more than this many instructions, it
3300 will not be inlined.  This option is precisely equivalent to
3301 @samp{-finline-limit}.
3302 @end table
3304 @end table
3306 @node Preprocessor Options
3307 @section Options Controlling the Preprocessor
3308 @cindex preprocessor options
3309 @cindex options, preprocessor
3311 These options control the C preprocessor, which is run on each C source
3312 file before actual compilation.
3314 If you use the @samp{-E} option, nothing is done except preprocessing.
3315 Some of these options make sense only together with @samp{-E} because
3316 they cause the preprocessor output to be unsuitable for actual
3317 compilation.
3319 @table @gcctabopt
3320 @item -include @var{file}
3321 Process @var{file} as input before processing the regular input file.
3322 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
3323 and @samp{-U} options on the command line are always processed before
3324 @samp{-include @var{file}}, regardless of the order in which they are
3325 written.  All the @samp{-include} and @samp{-imacros} options are
3326 processed in the order in which they are written.
3328 @item -imacros @var{file}
3329 Process @var{file} as input, discarding the resulting output, before
3330 processing the regular input file.  Because the output generated from
3331 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3332 is to make the macros defined in @var{file} available for use in the
3333 main input.  All the @samp{-include} and @samp{-imacros} options are
3334 processed in the order in which they are written.
3336 @item -idirafter @var{dir}
3337 @cindex second include path
3338 Add the directory @var{dir} to the second include path.  The directories
3339 on the second include path are searched when a header file is not found
3340 in any of the directories in the main include path (the one that
3341 @samp{-I} adds to).
3343 @item -iprefix @var{prefix}
3344 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3345 options.
3347 @item -iwithprefix @var{dir}
3348 Add a directory to the second include path.  The directory's name is
3349 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3350 specified previously with @samp{-iprefix}.  If you have not specified a
3351 prefix yet, the directory containing the installed passes of the
3352 compiler is used as the default.
3354 @item -iwithprefixbefore @var{dir}
3355 Add a directory to the main include path.  The directory's name is made
3356 by concatenating @var{prefix} and @var{dir}, as in the case of
3357 @samp{-iwithprefix}.
3359 @item -isystem @var{dir}
3360 Add a directory to the beginning of the second include path, marking it
3361 as a system directory, so that it gets the same special treatment as
3362 is applied to the standard system directories.
3364 @item -nostdinc
3365 Do not search the standard system directories for header files.  Only
3366 the directories you have specified with @samp{-I} options (and the
3367 current directory, if appropriate) are searched.  @xref{Directory
3368 Options}, for information on @samp{-I}.
3370 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3371 search path to only those directories you specify explicitly.
3373 @item -remap
3374 @findex -remap
3375 When searching for a header file in a directory, remap file names if a
3376 file named @file{header.gcc} exists in that directory.  This can be used
3377 to work around limitations of file systems with file name restrictions.
3378 The @file{header.gcc} file should contain a series of lines with two
3379 tokens on each line: the first token is the name to map, and the second
3380 token is the actual name to use.
3382 @item -undef
3383 Do not predefine any nonstandard macros.  (Including architecture flags).
3385 @item -E
3386 Run only the C preprocessor.  Preprocess all the C source files
3387 specified and output the results to standard output or to the
3388 specified output file.
3390 @item -C
3391 Tell the preprocessor not to discard comments.  Used with the
3392 @samp{-E} option.
3394 @item -P
3395 Tell the preprocessor not to generate @samp{#line} directives.
3396 Used with the @samp{-E} option.
3398 @cindex make
3399 @cindex dependencies, make
3400 @item -M
3401 @findex -M
3402 Instead of outputting the result of preprocessing, output a rule
3403 suitable for @code{make} describing the dependencies of the main source
3404 file.  The preprocessor outputs one @code{make} rule containing the
3405 object file name for that source file, a colon, and the names of all the
3406 included files.  Unless overridden explicitly, the object file name
3407 consists of the basename of the source file with any suffix replaced with
3408 object file suffix. If there are many included files then the
3409 rule is split into several lines using @samp{\}-newline.
3411 @samp{-M} implies @samp{-E}.
3413 @item -MM
3414 @findex -MM
3415 Like @samp{-M}, but mention only the files included with @samp{#include
3416 "@var{file}"}.  System header files included with @samp{#include
3417 <@var{file}>} are omitted.
3419 @item -MD
3420 @findex -MD
3421 Like @samp{-M} but the dependency information is written to a file
3422 rather than stdout.  @code{gcc} will use the same file name and
3423 directory as the object file, but with the suffix ".d" instead.
3425 This is in addition to compiling the main file as specified ---
3426 @samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3427 unless you also specify @samp{-MG}.
3429 With Mach, you can use the utility @code{md} to merge multiple
3430 dependency files into a single dependency file suitable for using with
3431 the @samp{make} command.
3433 @item -MMD
3434 @findex -MMD
3435 Like @samp{-MD} except mention only user header files, not system
3436 -header files.
3438 @item -MF @var{file}
3439 @findex -MF
3440 When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3441 dependencies to.  This allows the preprocessor to write the preprocessed
3442 file to stdout normally.  If no @samp{-MF} switch is given, CPP sends
3443 the rules to stdout and suppresses normal preprocessed output.
3445 Another way to specify output of a @code{make} rule is by setting
3446 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3447 Variables}).
3449 @item -MG
3450 @findex -MG
3451 When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3452 header files as generated files and assume they live in the same
3453 directory as the source file.  It suppresses preprocessed output, as a
3454 missing header file is ordinarily an error.
3456 This feature is used in automatic updating of makefiles.
3458 @item -MP
3459 @findex -MP
3460 This option instructs CPP to add a phony target for each dependency
3461 other than the main file, causing each to depend on nothing.  These
3462 dummy rules work around errors @code{make} gives if you remove header
3463 files without updating the @code{Makefile} to match.
3465 This is typical output:-
3467 @smallexample
3468 /tmp/test.o: /tmp/test.c /tmp/test.h
3470 /tmp/test.h:
3471 @end smallexample
3473 @item -MQ @var{target}
3474 @item -MT @var{target}
3475 @findex -MQ
3476 @findex -MT
3477 By default CPP uses the main file name, including any path, and appends
3478 the object suffix, normally ``.o'', to it to obtain the name of the
3479 target for dependency generation.  With @samp{-MT} you can specify a
3480 target yourself, overriding the default one.
3482 If you want multiple targets, you can specify them as a single argument
3483 to @samp{-MT}, or use multiple @samp{-MT} options.
3485 The targets you specify are output in the order they appear on the
3486 command line.  @samp{-MQ} is identical to @samp{-MT}, except that the
3487 target name is quoted for Make, but with @samp{-MT} it isn't.  For
3488 example, -MT '$(objpfx)foo.o' gives
3490 @smallexample
3491 $(objpfx)foo.o: /tmp/foo.c
3492 @end smallexample
3494 but -MQ '$(objpfx)foo.o' gives
3496 @smallexample
3497 $$(objpfx)foo.o: /tmp/foo.c
3498 @end smallexample
3500 The default target is automatically quoted, as if it were given with
3501 @samp{-MQ}.
3503 @item -H
3504 Print the name of each header file used, in addition to other normal
3505 activities.
3507 @item -A@var{question}(@var{answer})
3508 Assert the answer @var{answer} for @var{question}, in case it is tested
3509 with a preprocessing conditional such as @samp{#if
3510 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3511 assertions that normally describe the target machine.
3513 @item -D@var{macro}
3514 Define macro @var{macro} with the string @samp{1} as its definition.
3516 @item -D@var{macro}=@var{defn}
3517 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3518 the command line are processed before any @samp{-U} options.
3520 Any @samp{-D} and @samp{-U} options on the command line are processed in
3521 order, and always before @samp{-imacros @var{file}}, regardless of the
3522 order in which they are written.
3524 @item -U@var{macro}
3525 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3526 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3527 options.
3529 Any @samp{-D} and @samp{-U} options on the command line are processed in
3530 order, and always before @samp{-imacros @var{file}}, regardless of the
3531 order in which they are written.
3533 @item -dM
3534 Tell the preprocessor to output only a list of the macro definitions
3535 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3536 option.
3538 @item -dD
3539 Tell the preprocessing to pass all macro definitions into the output, in
3540 their proper sequence in the rest of the output.
3542 @item -dN
3543 Like @samp{-dD} except that the macro arguments and contents are omitted.
3544 Only @samp{#define @var{name}} is included in the output.
3546 @item -dI
3547 @findex -dI
3548 Output @samp{#include} directives in addition to the result of
3549 preprocessing.
3551 @item -trigraphs
3552 @findex -trigraphs
3553 Process ISO standard trigraph sequences.  These are three-character
3554 sequences, all starting with @samp{??}, that are defined by ISO C to
3555 stand for single characters.  For example, @samp{??/} stands for
3556 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
3557 default, GCC ignores trigraphs, but in standard-conforming modes it
3558 converts them.  See the @samp{-std} and @samp{-ansi} options.
3560 The nine trigraph sequences are
3561 @table @samp
3562 @item ??(
3563 -> @samp{[}
3565 @item ??)
3566 -> @samp{]}
3568 @item ??<
3569 -> @samp{@{}
3571 @item ??>
3572 -> @samp{@}}
3574 @item ??=
3575 -> @samp{#}
3577 @item ??/
3578 -> @samp{\}
3580 @item ??'
3581 -> @samp{^}
3583 @item ??!
3584 -> @samp{|}
3586 @item ??-
3587 -> @samp{~}
3589 @end table
3591 Trigraph support is not popular, so many compilers do not implement it
3592 properly.  Portable code should not rely on trigraphs being either
3593 converted or ignored.
3595 @item -Wp\,@var{option}
3596 Pass @var{option} as an option to the preprocessor.  If @var{option}
3597 contains commas, it is split into multiple options at the commas.
3598 @end table
3600 @node Assembler Options
3601 @section Passing Options to the Assembler
3603 @c prevent bad page break with this line
3604 You can pass options to the assembler.
3606 @table @gcctabopt
3607 @item -Wa\,@var{option}
3608 Pass @var{option} as an option to the assembler.  If @var{option}
3609 contains commas, it is split into multiple options at the commas.
3610 @end table
3612 @node Link Options
3613 @section Options for Linking
3614 @cindex link options
3615 @cindex options, linking
3617 These options come into play when the compiler links object files into
3618 an executable output file.  They are meaningless if the compiler is
3619 not doing a link step.
3621 @table @gcctabopt
3622 @cindex file names
3623 @item @var{object-file-name}
3624 A file name that does not end in a special recognized suffix is
3625 considered to name an object file or library.  (Object files are
3626 distinguished from libraries by the linker according to the file
3627 contents.)  If linking is done, these object files are used as input
3628 to the linker.
3630 @item -c
3631 @itemx -S
3632 @itemx -E
3633 If any of these options is used, then the linker is not run, and
3634 object file names should not be used as arguments.  @xref{Overall
3635 Options}.
3637 @cindex Libraries
3638 @item -l@var{library}
3639 Search the library named @var{library} when linking.
3641 It makes a difference where in the command you write this option; the
3642 linker searches processes libraries and object files in the order they
3643 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3644 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3645 to functions in @samp{z}, those functions may not be loaded.
3647 The linker searches a standard list of directories for the library,
3648 which is actually a file named @file{lib@var{library}.a}.  The linker
3649 then uses this file as if it had been specified precisely by name.
3651 The directories searched include several standard system directories
3652 plus any that you specify with @samp{-L}.
3654 Normally the files found this way are library files---archive files
3655 whose members are object files.  The linker handles an archive file by
3656 scanning through it for members which define symbols that have so far
3657 been referenced but not defined.  But if the file that is found is an
3658 ordinary object file, it is linked in the usual fashion.  The only
3659 difference between using an @samp{-l} option and specifying a file name
3660 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3661 and searches several directories.
3663 @item -lobjc
3664 You need this special case of the @samp{-l} option in order to
3665 link an Objective C program.
3667 @item -nostartfiles
3668 Do not use the standard system startup files when linking.
3669 The standard system libraries are used normally, unless @option{-nostdlib}
3670 or @option{-nodefaultlibs} is used.
3672 @item -nodefaultlibs
3673 Do not use the standard system libraries when linking.
3674 Only the libraries you specify will be passed to the linker.
3675 The standard startup files are used normally, unless @option{-nostartfiles}
3676 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3677 for System V (and ISO C) environments or to bcopy and bzero for
3678 BSD environments.  These entries are usually resolved by entries in
3679 libc.  These entry points should be supplied through some other
3680 mechanism when this option is specified.
3682 @item -nostdlib
3683 Do not use the standard system startup files or libraries when linking.
3684 No startup files and only the libraries you specify will be passed to
3685 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3686 for System V (and ISO C) environments or to bcopy and bzero for
3687 BSD environments.  These entries are usually resolved by entries in
3688 libc.  These entry points should be supplied through some other
3689 mechanism when this option is specified.
3691 @cindex @code{-lgcc}, use with @code{-nostdlib}
3692 @cindex @code{-nostdlib} and unresolved references
3693 @cindex unresolved references and @code{-nostdlib}
3694 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3695 @cindex @code{-nodefaultlibs} and unresolved references
3696 @cindex unresolved references and @code{-nodefaultlibs}
3697 One of the standard libraries bypassed by @samp{-nostdlib} and
3698 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3699 that GCC uses to overcome shortcomings of particular machines, or special
3700 needs for some languages.
3701 @ifset INTERNALS
3702 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3703 @file{libgcc.a}.)
3704 @end ifset
3705 @ifclear INTERNALS
3706 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3707 for more discussion of @file{libgcc.a}.)
3708 @end ifclear
3709 In most cases, you need @file{libgcc.a} even when you want to avoid
3710 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3711 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3712 This ensures that you have no unresolved references to internal GCC
3713 library subroutines.  (For example, @samp{__main}, used to ensure C++
3714 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
3716 @item -s
3717 Remove all symbol table and relocation information from the executable.
3719 @item -static
3720 On systems that support dynamic linking, this prevents linking with the shared
3721 libraries.  On other systems, this option has no effect.
3723 @item -shared
3724 Produce a shared object which can then be linked with other objects to
3725 form an executable.  Not all systems support this option.  For predictable
3726 results, you must also specify the same set of options that were used to 
3727 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3728 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
3729 needs to build supplementary stub code for constructors to work. On
3730 multi-libbed systems, @samp{gcc -shared} must select the correct support
3731 libraries to link against.  Failing to supply the correct flags may lead
3732 to subtle defects. Supplying them in cases where they are not necessary
3733 is innocuous.}
3735 @item -shared-libgcc
3736 @itemx -static-libgcc
3737 On systems that provide @file{libgcc} as a shared library, these options
3738 force the use of either the shared or static version respectively.
3739 If no shared version of @file{libgcc} was built when the compiler was
3740 configured, these options have no effect.
3742 There are several situations in which an application should use the
3743 shared @file{libgcc} instead of the static version.  The most common
3744 of these is when the application wishes to throw and catch exceptions
3745 across different shared libraries.  In that case, each of the libraries
3746 as well as the application itself should use the shared @file{libgcc}.
3748 Therefore, whenever you specify the @samp{-shared} option, the GCC
3749 driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3750 specify @samp{-static-libgcc}.  The G++ driver automatically adds
3751 @samp{-shared-libgcc} when you build a main executable as well because
3752 for C++ programs that is typically the right thing to do.
3753 (Exception-handling will not work reliably otherwise.)
3755 However, when linking a main executable written in C, you must
3756 explicitly say @samp{-shared-libgcc} if you want to use the shared
3757 @file{libgcc}.
3759 @item -symbolic
3760 Bind references to global symbols when building a shared object.  Warn
3761 about any unresolved references (unless overridden by the link editor
3762 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3763 this option.
3765 @item -Xlinker @var{option}
3766 Pass @var{option} as an option to the linker.  You can use this to
3767 supply system-specific linker options which GCC does not know how to
3768 recognize.
3770 If you want to pass an option that takes an argument, you must use
3771 @samp{-Xlinker} twice, once for the option and once for the argument.
3772 For example, to pass @samp{-assert definitions}, you must write
3773 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3774 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3775 string as a single argument, which is not what the linker expects.
3777 @item -Wl\,@var{option}
3778 Pass @var{option} as an option to the linker.  If @var{option} contains
3779 commas, it is split into multiple options at the commas.
3781 @item -u @var{symbol}
3782 Pretend the symbol @var{symbol} is undefined, to force linking of
3783 library modules to define it.  You can use @samp{-u} multiple times with
3784 different symbols to force loading of additional library modules.
3785 @end table
3787 @node Directory Options
3788 @section Options for Directory Search
3789 @cindex directory options
3790 @cindex options, directory search
3791 @cindex search path
3793 These options specify directories to search for header files, for
3794 libraries and for parts of the compiler:
3796 @table @gcctabopt
3797 @item -I@var{dir}
3798 Add the directory @var{dir} to the head of the list of directories to be
3799 searched for header files.  This can be used to override a system header
3800 file, substituting your own version, since these directories are
3801 searched before the system header file directories.  However, you should
3802 not use this option to add directories that contain vendor-supplied
3803 system header files (use @samp{-isystem} for that). If you use more than
3804 one @samp{-I} option, the directories are scanned in left-to-right
3805 order; the standard system directories come after.
3807 @item -I-
3808 Any directories you specify with @samp{-I} options before the @samp{-I-}
3809 option are searched only for the case of @samp{#include "@var{file}"};
3810 they are not searched for @samp{#include <@var{file}>}.
3812 If additional directories are specified with @samp{-I} options after
3813 the @samp{-I-}, these directories are searched for all @samp{#include}
3814 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3815 this way.)
3817 In addition, the @samp{-I-} option inhibits the use of the current
3818 directory (where the current input file came from) as the first search
3819 directory for @samp{#include "@var{file}"}.  There is no way to
3820 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3821 searching the directory which was current when the compiler was
3822 invoked.  That is not exactly the same as what the preprocessor does
3823 by default, but it is often satisfactory.
3825 @samp{-I-} does not inhibit the use of the standard system directories
3826 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3827 independent.
3829 @item -L@var{dir}
3830 Add directory @var{dir} to the list of directories to be searched
3831 for @samp{-l}.
3833 @item -B@var{prefix}
3834 This option specifies where to find the executables, libraries,
3835 include files, and data files of the compiler itself.
3837 The compiler driver program runs one or more of the subprograms
3838 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3839 @var{prefix} as a prefix for each program it tries to run, both with and
3840 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3842 For each subprogram to be run, the compiler driver first tries the
3843 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3844 was not specified, the driver tries two standard prefixes, which are
3845 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3846 those results in a file name that is found, the unmodified program
3847 name is searched for using the directories specified in your
3848 @env{PATH} environment variable.
3850 @samp{-B} prefixes that effectively specify directory names also apply
3851 to libraries in the linker, because the compiler translates these
3852 options into @samp{-L} options for the linker.  They also apply to
3853 includes files in the preprocessor, because the compiler translates these
3854 options into @samp{-isystem} options for the preprocessor.  In this case,
3855 the compiler appends @samp{include} to the prefix.
3857 The run-time support file @file{libgcc.a} can also be searched for using
3858 the @samp{-B} prefix, if needed.  If it is not found there, the two
3859 standard prefixes above are tried, and that is all.  The file is left
3860 out of the link if it is not found by those means.
3862 Another way to specify a prefix much like the @samp{-B} prefix is to use
3863 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
3864 Variables}.
3866 @item -specs=@var{file}
3867 Process @var{file} after the compiler reads in the standard @file{specs}
3868 file, in order to override the defaults that the @file{gcc} driver
3869 program uses when determining what switches to pass to @file{cc1},
3870 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3871 @samp{-specs=}@var{file} can be specified on the command line, and they
3872 are processed in order, from left to right.
3873 @end table
3875 @c man end
3877 @node Spec Files
3878 @section Specifying subprocesses and the switches to pass to them
3879 @cindex Spec Files
3880 @command{gcc} is a driver program.  It performs its job by invoking a
3881 sequence of other programs to do the work of compiling, assembling and
3882 linking.  GCC interprets its command-line parameters and uses these to
3883 deduce which programs it should invoke, and which command-line options
3884 it ought to place on their command lines.  This behaviour is controlled
3885 by @dfn{spec strings}.  In most cases there is one spec string for each
3886 program that GCC can invoke, but a few programs have multiple spec
3887 strings to control their behaviour.  The spec strings built into GCC can
3888 be overridden by using the @samp{-specs=} command-line switch to specify
3889 a spec file.
3891 @dfn{Spec files} are plaintext files that are used to construct spec
3892 strings.  They consist of a sequence of directives separated by blank
3893 lines.  The type of directive is determined by the first non-whitespace
3894 character on the line and it can be one of the following:
3896 @table @code
3897 @item %@var{command}
3898 Issues a @var{command} to the spec file processor.  The commands that can
3899 appear here are: 
3901 @table @code
3902 @item %include <@var{file}>
3903 @cindex %include
3904 Search for @var{file} and insert its text at the current point in the
3905 specs file.
3907 @item %include_noerr <@var{file}>
3908 @cindex %include_noerr
3909 Just like @samp{%include}, but do not generate an error message if the include
3910 file cannot be found.
3912 @item %rename @var{old_name} @var{new_name}
3913 @cindex %rename
3914 Rename the spec string @var{old_name} to @var{new_name}.
3916 @end table
3918 @item *[@var{spec_name}]:
3919 This tells the compiler to create, override or delete the named spec
3920 string.  All lines after this directive up to the next directive or
3921 blank line are considered to be the text for the spec string.  If this
3922 results in an empty string then the spec will be deleted.  (Or, if the
3923 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3924 does not currently exist a new spec will be created.  If the spec does
3925 exist then its contents will be overridden by the text of this
3926 directive, unless the first character of that text is the @samp{+}
3927 character, in which case the text will be appended to the spec.
3929 @item [@var{suffix}]:
3930 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3931 and up to the next directive or blank line are considered to make up the
3932 spec string for the indicated suffix.  When the compiler encounters an 
3933 input file with the named suffix, it will processes the spec string in
3934 order to work out how to compile that file.  For example:
3936 @smallexample
3937 .ZZ:
3938 z-compile -input %i
3939 @end smallexample
3941 This says that any input file whose name ends in @samp{.ZZ} should be
3942 passed to the program @samp{z-compile}, which should be invoked with the
3943 command-line switch @samp{-input} and with the result of performing the
3944 @samp{%i} substitution.  (See below.)
3946 As an alternative to providing a spec string, the text that follows a
3947 suffix directive can be one of the following:
3949 @table @code
3950 @item @@@var{language}
3951 This says that the suffix is an alias for a known @var{language}.  This is
3952 similar to using the @option{-x} command-line switch to GCC to specify a
3953 language explicitly.  For example:
3955 @smallexample
3956 .ZZ:
3957 @@c++
3958 @end smallexample
3960 Says that .ZZ files are, in fact, C++ source files.
3962 @item #@var{name}
3963 This causes an error messages saying:
3965 @smallexample
3966 @var{name} compiler not installed on this system.
3967 @end smallexample
3968 @end table
3970 GCC already has an extensive list of suffixes built into it.
3971 This directive will add an entry to the end of the list of suffixes, but
3972 since the list is searched from the end backwards, it is effectively
3973 possible to override earlier entries using this technique.
3975 @end table
3977 GCC has the following spec strings built into it.  Spec files can
3978 override these strings or create their own.  Note that individual
3979 targets can also add their own spec strings to this list. 
3981 @smallexample
3982 asm          Options to pass to the assembler
3983 asm_final    Options to pass to the assembler post-processor
3984 cpp          Options to pass to the C preprocessor
3985 cc1          Options to pass to the C compiler
3986 cc1plus      Options to pass to the C++ compiler
3987 endfile      Object files to include at the end of the link
3988 link         Options to pass to the linker
3989 lib          Libraries to include on the command line to the linker
3990 libgcc       Decides which GCC support library to pass to the linker
3991 linker       Sets the name of the linker
3992 predefines   Defines to be passed to the C preprocessor
3993 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3994 startfile    Object files to include at the start of the link
3995 @end smallexample
3997 Here is a small example of a spec file:
3999 @smallexample
4000 %rename lib                 old_lib
4002 *lib:
4003 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
4004 @end smallexample
4006 This example renames the spec called @samp{lib} to @samp{old_lib} and
4007 then overrides the previous definition of @samp{lib} with a new one.
4008 The new definition adds in some extra command-line options before
4009 including the text of the old definition.
4011 @dfn{Spec strings} are a list of command-line options to be passed to their
4012 corresponding program.  In addition, the spec strings can contain
4013 @samp{%}-prefixed sequences to substitute variable text or to
4014 conditionally insert text into the command line.  Using these constructs
4015 it is possible to generate quite complex command lines.
4017 Here is a table of all defined @samp{%}-sequences for spec
4018 strings.  Note that spaces are not generated automatically around the
4019 results of expanding these sequences.  Therefore you can concatenate them
4020 together or combine them with constant text in a single argument. 
4022 @table @code
4023 @item %%
4024 Substitute one @samp{%} into the program name or argument.
4026 @item %i
4027 Substitute the name of the input file being processed.
4029 @item %b
4030 Substitute the basename of the input file being processed.
4031 This is the substring up to (and not including) the last period
4032 and not including the directory.
4034 @item %B
4035 This is the same as @samp{%b}, but include the file suffix (text after
4036 the last period).
4038 @item %d
4039 Marks the argument containing or following the @samp{%d} as a
4040 temporary file name, so that that file will be deleted if GCC exits
4041 successfully.  Unlike @samp{%g}, this contributes no text to the
4042 argument. 
4044 @item %g@var{suffix}
4045 Substitute a file name that has suffix @var{suffix} and is chosen
4046 once per compilation, and mark the argument in the same way as
4047 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4048 name is now chosen in a way that is hard to predict even when previously 
4049 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
4050 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4051 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4052 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4053 was simply substituted with a file name chosen once per compilation,
4054 without regard to any appended suffix (which was therefore treated
4055 just like ordinary text), making such attacks more likely to succeed.
4057 @item %u@var{suffix}
4058 Like @samp{%g}, but generates a new temporary file name even if
4059 @samp{%u@var{suffix}} was already seen.
4061 @item %U@var{suffix}
4062 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4063 new one if there is no such last file name.  In the absence of any
4064 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4065 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4066 would involve the generation of two distinct file names, one
4067 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4068 simply substituted with a file name chosen for the previous @samp{%u},
4069 without regard to any appended suffix.
4071 @item %j@var{SUFFIX}
4072 Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is 
4073 writable, and if save-temps is off; otherwise, substitute the name
4074 of a temporary file, just like @samp{%u}.  This temporary file is not
4075 meant for communication between processes, but rather as a junk
4076 disposal mechanism.
4078 @item %.@var{SUFFIX}
4079 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4080 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4081 terminated by the next space or %.
4083 @item %w
4084 Marks the argument containing or following the @samp{%w} as the
4085 designated output file of this compilation.  This puts the argument
4086 into the sequence of arguments that @samp{%o} will substitute later.
4088 @item %o
4089 Substitutes the names of all the output files, with spaces
4090 automatically placed around them.  You should write spaces
4091 around the @samp{%o} as well or the results are undefined.
4092 @samp{%o} is for use in the specs for running the linker.
4093 Input files whose names have no recognized suffix are not compiled
4094 at all, but they are included among the output files, so they will
4095 be linked.
4097 @item %O
4098 Substitutes the suffix for object files.  Note that this is
4099 handled specially when it immediately follows @samp{%g, %u, or %U},
4100 because of the need for those to form complete file names.  The
4101 handling is such that @samp{%O} is treated exactly as if it had already
4102 been substituted, except that @samp{%g, %u, and %U} do not currently
4103 support additional @var{suffix} characters following @samp{%O} as they would
4104 following, for example, @samp{.o}.
4106 @item %p
4107 Substitutes the standard macro predefinitions for the
4108 current target machine.  Use this when running @code{cpp}.
4110 @item %P
4111 Like @samp{%p}, but puts @samp{__} before and after the name of each
4112 predefined macro, except for macros that start with @samp{__} or with
4113 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4114 C.  
4116 @item %I
4117 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4119 @item %s
4120 Current argument is the name of a library or startup file of some sort.
4121 Search for that file in a standard list of directories and substitute
4122 the full name found. 
4124 @item %e@var{str}
4125 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4126 Use this when inconsistent options are detected.
4128 @item %|
4129 Output @samp{-} if the input for the current command is coming from a pipe.
4131 @item %(@var{name})
4132 Substitute the contents of spec string @var{name} at this point.
4134 @item %[@var{name}]
4135 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4137 @item %x@{@var{option}@}
4138 Accumulate an option for @samp{%X}.
4140 @item %X
4141 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4142 spec string.
4144 @item %Y
4145 Output the accumulated assembler options specified by @samp{-Wa}.
4147 @item %Z
4148 Output the accumulated preprocessor options specified by @samp{-Wp}.
4150 @item %v1
4151 Substitute the major version number of GCC.
4152 (For version 2.9.5, this is 2.)
4154 @item %v2
4155 Substitute the minor version number of GCC.
4156 (For version 2.9.5, this is 9.)
4158 @item %v3
4159 Substitute the patch level number of GCC.
4160 (For version 2.9.5, this is 5.)
4162 @item %a
4163 Process the @code{asm} spec.  This is used to compute the
4164 switches to be passed to the assembler.
4166 @item %A
4167 Process the @code{asm_final} spec.  This is a spec string for
4168 passing switches to an assembler post-processor, if such a program is
4169 needed.
4171 @item %l
4172 Process the @code{link} spec.  This is the spec for computing the
4173 command line passed to the linker.  Typically it will make use of the
4174 @samp{%L %G %S %D and %E} sequences.
4176 @item %D
4177 Dump out a @samp{-L} option for each directory that GCC believes might
4178 contain startup files.  If the target supports multilibs then the
4179 current multilib directory will be prepended to each of these paths. 
4181 @item %M
4182 Output the multilib directory with directory seperators replaced with
4183 "_".  If multilib directories are not set, or the multilib directory is
4184 "." then this option emits nothing.
4186 @item %L
4187 Process the @code{lib} spec.  This is a spec string for deciding which
4188 libraries should be included on the command line to the linker. 
4190 @item %G
4191 Process the @code{libgcc} spec.  This is a spec string for deciding
4192 which GCC support library should be included on the command line to the linker. 
4194 @item %S
4195 Process the @code{startfile} spec.  This is a spec for deciding which
4196 object files should be the first ones passed to the linker.  Typically
4197 this might be a file named @file{crt0.o}. 
4199 @item %E
4200 Process the @code{endfile} spec.  This is a spec string that specifies
4201 the last object files that will be passed to the linker.  
4203 @item %C
4204 Process the @code{cpp} spec.  This is used to construct the arguments
4205 to be passed to the C preprocessor.
4207 @item %c
4208 Process the @code{signed_char} spec.  This is intended to be used
4209 to tell cpp whether a char is signed.  It typically has the definition: 
4210 @smallexample
4211 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4212 @end smallexample
4214 @item %1
4215 Process the @code{cc1} spec.  This is used to construct the options to be
4216 passed to the actual C compiler (@samp{cc1}).
4218 @item %2
4219 Process the @code{cc1plus} spec.  This is used to construct the options to be
4220 passed to the actual C++ compiler (@samp{cc1plus}).
4222 @item %*
4223 Substitute the variable part of a matched option.  See below.
4224 Note that each comma in the substituted string is replaced by
4225 a single space.
4227 @item %@{@code{S}@}
4228 Substitutes the @code{-S} switch, if that switch was given to GCC.
4229 If that switch was not specified, this substitutes nothing.  Note that
4230 the leading dash is omitted when specifying this option, and it is
4231 automatically inserted if the substitution is performed.  Thus the spec
4232 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4233 and would output the command line option @samp{-foo}.
4235 @item %W@{@code{S}@}
4236 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4237 deleted on failure. 
4239 @item %@{@code{S}*@}
4240 Substitutes all the switches specified to GCC whose names start
4241 with @code{-S}, but which also take an argument.  This is used for
4242 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
4243 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4244 text, including the space.  Thus two arguments would be generated. 
4246 @item %@{^@code{S}*@}
4247 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4248 argument.  Thus %@{^o*@} would only generate one argument, not two.
4250 @item %@{@code{S}*&@code{T}*@}
4251 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4252 (the order of @code{S} and @code{T} in the spec is not significant).
4253 There can be any number of ampersand-separated variables; for each the
4254 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4256 @item %@{<@code{S}@}
4257 Remove all occurrences of @code{-S} from the command line.  Note - this
4258 command is position dependent.  @samp{%} commands in the spec string
4259 before this option will see @code{-S}, @samp{%} commands in the spec
4260 string after this option will not.
4262 @item %@{@code{S}*:@code{X}@}
4263 Substitutes @code{X} if one or more switches whose names start with
4264 @code{-S} are specified to GCC.  Note that the tail part of the
4265 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4266 for each occurrence of @samp{%*} within @code{X}. 
4268 @item %@{@code{S}:@code{X}@}
4269 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4271 @item %@{!@code{S}:@code{X}@}
4272 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4274 @item %@{|@code{S}:@code{X}@}
4275 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4277 @item %@{|!@code{S}:@code{X}@}
4278 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4280 @item %@{.@code{S}:@code{X}@}
4281 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4283 @item %@{!.@code{S}:@code{X}@}
4284 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4286 @item %@{@code{S}|@code{P}:@code{X}@}
4287 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
4288 combined with @samp{!} and @samp{.} sequences as well, although they
4289 have a stronger binding than the @samp{|}.  For example a spec string
4290 like this:
4292 @smallexample
4293 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4294 @end smallexample
4296 will output the following command-line options from the following input
4297 command-line options:
4299 @smallexample
4300 fred.c        -foo -baz
4301 jim.d         -bar -boggle
4302 -d fred.c     -foo -baz -boggle
4303 -d jim.d      -bar -baz -boggle
4304 @end smallexample
4306 @end table
4308 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4309 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4310 or spaces, or even newlines.  They are processed as usual, as described
4311 above. 
4313 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4314 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4315 -W} switch is found later in the command line, the earlier switch
4316 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4317 letter, which passes all matching options.
4319 The character @samp{|} at the beginning of the predicate text is used to indicate
4320 that a command should be piped to the following command, but only if @samp{-pipe}
4321 is specified.
4323 It is built into GCC which switches take arguments and which do not.
4324 (You might think it would be useful to generalize this to allow each
4325 compiler's spec to say which switches take arguments.  But this cannot
4326 be done in a consistent fashion.  GCC cannot even decide which input
4327 files have been specified without knowing which switches take arguments,
4328 and it must know which input files to compile in order to tell which
4329 compilers to run). 
4331 GCC also knows implicitly that arguments starting in @samp{-l} are to be
4332 treated as compiler output files, and passed to the linker in their
4333 proper position among the other output files.
4335 @c man begin OPTIONS
4337 @node Target Options
4338 @section Specifying Target Machine and Compiler Version
4339 @cindex target options
4340 @cindex cross compiling
4341 @cindex specifying machine version
4342 @cindex specifying compiler version and target machine
4343 @cindex compiler version, specifying
4344 @cindex target machine, specifying
4346 By default, GCC compiles code for the same type of machine that you
4347 are using.  However, it can also be installed as a cross-compiler, to
4348 compile for some other type of machine.  In fact, several different
4349 configurations of GCC, for different target machines, can be
4350 installed side by side.  Then you specify which one to use with the
4351 @samp{-b} option.
4353 In addition, older and newer versions of GCC can be installed side
4354 by side.  One of them (probably the newest) will be the default, but
4355 you may sometimes wish to use another.
4357 @table @gcctabopt
4358 @item -b @var{machine}
4359 The argument @var{machine} specifies the target machine for compilation.
4360 This is useful when you have installed GCC as a cross-compiler.
4362 The value to use for @var{machine} is the same as was specified as the
4363 machine type when configuring GCC as a cross-compiler.  For
4364 example, if a cross-compiler was configured with @samp{configure
4365 i386v}, meaning to compile for an 80386 running System V, then you
4366 would specify @samp{-b i386v} to run that cross compiler.
4368 When you do not specify @samp{-b}, it normally means to compile for
4369 the same type of machine that you are using.
4371 @item -V @var{version}
4372 The argument @var{version} specifies which version of GCC to run.
4373 This is useful when multiple versions are installed.  For example,
4374 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4376 The default version, when you do not specify @samp{-V}, is the last
4377 version of GCC that you installed.
4378 @end table
4380 The @samp{-b} and @samp{-V} options actually work by controlling part of
4381 the file name used for the executable files and libraries used for
4382 compilation.  A given version of GCC, for a given target machine, is
4383 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4385 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4386 changing the names of these directories or adding alternate names (or
4387 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4388 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
4389 80386} becomes an alias for @samp{-b i386v}.
4391 In one respect, the @samp{-b} or @samp{-V} do not completely change
4392 to a different compiler: the top-level driver program @command{gcc}
4393 that you originally invoked continues to run and invoke the other
4394 executables (preprocessor, compiler per se, assembler and linker)
4395 that do the real work.  However, since no real work is done in the
4396 driver program, it usually does not matter that the driver program
4397 in use is not the one for the specified target.  It is common for the
4398 interface to the other executables to change incompatibly between
4399 compiler versions, so unless the version specified is very close to that
4400 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4401 version 3.0.1), use of @samp{-V} may not work; for example, using
4402 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
4404 The only way that the driver program depends on the target machine is
4405 in the parsing and handling of special machine-specific options.
4406 However, this is controlled by a file which is found, along with the
4407 other executables, in the directory for the specified version and
4408 target machine.  As a result, a single installed driver program adapts
4409 to any specified target machine, and sufficiently similar compiler
4410 versions.
4412 The driver program executable does control one significant thing,
4413 however: the default version and target machine.  Therefore, you can
4414 install different instances of the driver program, compiled for
4415 different targets or versions, under different names.
4417 For example, if the driver for version 2.0 is installed as @command{ogcc}
4418 and that for version 2.1 is installed as @command{gcc}, then the command
4419 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
4420 2.0 by default.  However, you can choose either version with either
4421 command with the @samp{-V} option.
4423 @node Submodel Options
4424 @section Hardware Models and Configurations
4425 @cindex submodel options
4426 @cindex specifying hardware config
4427 @cindex hardware models and configurations, specifying
4428 @cindex machine dependent options
4430 Earlier we discussed the standard option @samp{-b} which chooses among
4431 different installed compilers for completely different target
4432 machines, such as Vax vs. 68000 vs. 80386.
4434 In addition, each of these target machine types can have its own
4435 special options, starting with @samp{-m}, to choose among various
4436 hardware models or configurations---for example, 68010 vs 68020,
4437 floating coprocessor or none.  A single installed version of the
4438 compiler can compile for any model or configuration, according to the
4439 options specified.
4441 Some configurations of the compiler also support additional special
4442 options, usually for compatibility with other compilers on the same
4443 platform.
4445 @ifset INTERNALS
4446 These options are defined by the macro @code{TARGET_SWITCHES} in the
4447 machine description.  The default for the options is also defined by
4448 that macro, which enables you to change the defaults.
4449 @end ifset
4451 @menu
4452 * M680x0 Options::
4453 * M68hc1x Options::
4454 * VAX Options::
4455 * SPARC Options::
4456 * Convex Options::
4457 * AMD29K Options::
4458 * ARM Options::
4459 * Thumb Options::
4460 * MN10200 Options::
4461 * MN10300 Options::
4462 * M32R/D Options::
4463 * M88K Options::
4464 * RS/6000 and PowerPC Options::
4465 * RT Options::
4466 * MIPS Options::
4467 * i386 Options::
4468 * HPPA Options::
4469 * Intel 960 Options::
4470 * DEC Alpha Options::
4471 * Clipper Options::
4472 * H8/300 Options::
4473 * SH Options::
4474 * System V Options::
4475 * TMS320C3x/C4x Options::
4476 * V850 Options::
4477 * ARC Options::
4478 * NS32K Options::
4479 * AVR Options::
4480 * MCore Options::
4481 * IA-64 Options::
4482 * D30V Options::
4483 @end menu
4485 @node M680x0 Options
4486 @subsection M680x0 Options
4487 @cindex M680x0 options
4489 These are the @samp{-m} options defined for the 68000 series.  The default
4490 values for these options depends on which style of 68000 was selected when
4491 the compiler was configured; the defaults for the most common choices are
4492 given below.
4494 @table @gcctabopt
4495 @item -m68000
4496 @itemx -mc68000
4497 Generate output for a 68000.  This is the default
4498 when the compiler is configured for 68000-based systems.
4500 Use this option for microcontrollers with a 68000 or EC000 core,
4501 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4503 @item -m68020
4504 @itemx -mc68020
4505 Generate output for a 68020.  This is the default
4506 when the compiler is configured for 68020-based systems.
4508 @item -m68881
4509 Generate output containing 68881 instructions for floating point.
4510 This is the default for most 68020 systems unless @samp{-nfp} was
4511 specified when the compiler was configured.
4513 @item -m68030
4514 Generate output for a 68030.  This is the default when the compiler is
4515 configured for 68030-based systems.
4517 @item -m68040
4518 Generate output for a 68040.  This is the default when the compiler is
4519 configured for 68040-based systems.
4521 This option inhibits the use of 68881/68882 instructions that have to be
4522 emulated by software on the 68040.  Use this option if your 68040 does not
4523 have code to emulate those instructions.
4525 @item -m68060
4526 Generate output for a 68060.  This is the default when the compiler is
4527 configured for 68060-based systems.
4529 This option inhibits the use of 68020 and 68881/68882 instructions that
4530 have to be emulated by software on the 68060.  Use this option if your 68060
4531 does not have code to emulate those instructions.
4533 @item -mcpu32
4534 Generate output for a CPU32. This is the default
4535 when the compiler is configured for CPU32-based systems.
4537 Use this option for microcontrollers with a
4538 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4539 68336, 68340, 68341, 68349 and 68360.
4541 @item -m5200
4542 Generate output for a 520X "coldfire" family cpu.  This is the default
4543 when the compiler is configured for 520X-based systems.
4545 Use this option for microcontroller with a 5200 core, including 
4546 the MCF5202, MCF5203, MCF5204 and MCF5202.
4549 @item -m68020-40
4550 Generate output for a 68040, without using any of the new instructions.
4551 This results in code which can run relatively efficiently on either a
4552 68020/68881 or a 68030 or a 68040.  The generated code does use the
4553 68881 instructions that are emulated on the 68040.
4555 @item -m68020-60
4556 Generate output for a 68060, without using any of the new instructions.
4557 This results in code which can run relatively efficiently on either a
4558 68020/68881 or a 68030 or a 68040.  The generated code does use the
4559 68881 instructions that are emulated on the 68060.
4561 @item -mfpa
4562 Generate output containing Sun FPA instructions for floating point.
4564 @item -msoft-float
4565 Generate output containing library calls for floating point.
4566 @strong{Warning:} the requisite libraries are not available for all m68k
4567 targets.  Normally the facilities of the machine's usual C compiler are
4568 used, but this can't be done directly in cross-compilation.  You must
4569 make your own arrangements to provide suitable library functions for
4570 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
4571 @samp{m68k-*-coff} do provide software floating point support.
4573 @item -mshort
4574 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4576 @item -mnobitfield
4577 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
4578 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4580 @item -mbitfield
4581 Do use the bit-field instructions.  The @samp{-m68020} option implies
4582 @samp{-mbitfield}.  This is the default if you use a configuration
4583 designed for a 68020.
4585 @item -mrtd
4586 Use a different function-calling convention, in which functions
4587 that take a fixed number of arguments return with the @code{rtd}
4588 instruction, which pops their arguments while returning.  This
4589 saves one instruction in the caller since there is no need to pop
4590 the arguments there.
4592 This calling convention is incompatible with the one normally
4593 used on Unix, so you cannot use it if you need to call libraries
4594 compiled with the Unix compiler.
4596 Also, you must provide function prototypes for all functions that
4597 take variable numbers of arguments (including @code{printf});
4598 otherwise incorrect code will be generated for calls to those
4599 functions.
4601 In addition, seriously incorrect code will result if you call a
4602 function with too many arguments.  (Normally, extra arguments are
4603 harmlessly ignored.)
4605 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4606 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4608 @item -malign-int
4609 @itemx -mno-align-int
4610 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4611 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4612 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4613 Aligning variables on 32-bit boundaries produces code that runs somewhat
4614 faster on processors with 32-bit busses at the expense of more memory.
4616 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4617 align structures containing the above types  differently than
4618 most published application binary interface specifications for the m68k.
4620 @item -mpcrel
4621 Use the pc-relative addressing mode of the 68000 directly, instead of
4622 using a global offset table.  At present, this option implies -fpic,
4623 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4624 not presently supported with -mpcrel, though this could be supported for
4625 68020 and higher processors.
4627 @item -mno-strict-align
4628 @itemx -mstrict-align
4629 @kindex -mstrict-align
4630 Do not (do) assume that unaligned memory references will be handled by
4631 the system.
4633 @end table
4635 @node M68hc1x Options
4636 @subsection M68hc1x Options
4637 @cindex M68hc1x options
4639 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4640 microcontrollers.  The default values for these options depends on 
4641 which style of microcontroller was selected when the compiler was configured;
4642 the defaults for the most common choices are given below.
4644 @table @gcctabopt
4645 @item -m6811
4646 @itemx -m68hc11
4647 Generate output for a 68HC11.  This is the default
4648 when the compiler is configured for 68HC11-based systems.
4650 @item -m6812
4651 @itemx -m68hc12
4652 Generate output for a 68HC12.  This is the default
4653 when the compiler is configured for 68HC12-based systems.
4655 @item -mauto-incdec
4656 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4657 addressing modes.
4659 @item -mshort
4660 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4662 @item -msoft-reg-count=@var{count}
4663 Specify the number of pseudo-soft registers which are used for the
4664 code generation.  The maximum number is 32.  Using more pseudo-soft
4665 register may or may not result in better code depending on the program.
4666 The default is 4 for 68HC11 and 2 for 68HC12.
4668 @end table
4670 @node VAX Options
4671 @subsection VAX Options
4672 @cindex VAX options
4674 These @samp{-m} options are defined for the Vax:
4676 @table @gcctabopt
4677 @item -munix
4678 Do not output certain jump instructions (@code{aobleq} and so on)
4679 that the Unix assembler for the Vax cannot handle across long
4680 ranges.
4682 @item -mgnu
4683 Do output those jump instructions, on the assumption that you
4684 will assemble with the GNU assembler.
4686 @item -mg
4687 Output code for g-format floating point numbers instead of d-format.
4688 @end table
4690 @node SPARC Options
4691 @subsection SPARC Options
4692 @cindex SPARC options
4694 These @samp{-m} switches are supported on the SPARC:
4696 @table @gcctabopt
4697 @item -mno-app-regs
4698 @itemx -mapp-regs
4699 Specify @samp{-mapp-regs} to generate output using the global registers
4700 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4701 is the default.
4703 To be fully SVR4 ABI compliant at the cost of some performance loss,
4704 specify @samp{-mno-app-regs}.  You should compile libraries and system
4705 software with this option.
4707 @item -mfpu
4708 @itemx -mhard-float
4709 Generate output containing floating point instructions.  This is the
4710 default.
4712 @item -mno-fpu
4713 @itemx -msoft-float
4714 Generate output containing library calls for floating point.
4715 @strong{Warning:} the requisite libraries are not available for all SPARC
4716 targets.  Normally the facilities of the machine's usual C compiler are
4717 used, but this cannot be done directly in cross-compilation.  You must make
4718 your own arrangements to provide suitable library functions for
4719 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4720 @samp{sparclite-*-*} do provide software floating point support.
4722 @samp{-msoft-float} changes the calling convention in the output file;
4723 therefore, it is only useful if you compile @emph{all} of a program with
4724 this option.  In particular, you need to compile @file{libgcc.a}, the
4725 library that comes with GCC, with @samp{-msoft-float} in order for
4726 this to work.
4728 @item -mhard-quad-float
4729 Generate output containing quad-word (long double) floating point
4730 instructions.
4732 @item -msoft-quad-float
4733 Generate output containing library calls for quad-word (long double)
4734 floating point instructions.  The functions called are those specified
4735 in the SPARC ABI.  This is the default.
4737 As of this writing, there are no sparc implementations that have hardware
4738 support for the quad-word floating point instructions.  They all invoke
4739 a trap handler for one of these instructions, and then the trap handler
4740 emulates the effect of the instruction.  Because of the trap handler overhead,
4741 this is much slower than calling the ABI library routines.  Thus the
4742 @samp{-msoft-quad-float} option is the default.
4744 @item -mno-epilogue
4745 @itemx -mepilogue
4746 With @samp{-mepilogue} (the default), the compiler always emits code for
4747 function exit at the end of each function.  Any function exit in
4748 the middle of the function (such as a return statement in C) will
4749 generate a jump to the exit code at the end of the function.
4751 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4752 at every function exit.
4754 @item -mno-flat
4755 @itemx -mflat
4756 With @samp{-mflat}, the compiler does not generate save/restore instructions
4757 and will use a "flat" or single register window calling convention.
4758 This model uses %i7 as the frame pointer and is compatible with the normal
4759 register window model.  Code from either may be intermixed.
4760 The local registers and the input registers (0-5) are still treated as
4761 "call saved" registers and will be saved on the stack as necessary.
4763 With @samp{-mno-flat} (the default), the compiler emits save/restore
4764 instructions (except for leaf functions) and is the normal mode of operation.
4766 @item -mno-unaligned-doubles
4767 @itemx -munaligned-doubles
4768 Assume that doubles have 8 byte alignment.  This is the default.
4770 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4771 alignment only if they are contained in another type, or if they have an
4772 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4773 Specifying this option avoids some rare compatibility problems with code
4774 generated by other compilers.  It is not the default because it results
4775 in a performance loss, especially for floating point code.
4777 @item -mno-faster-structs
4778 @itemx -mfaster-structs
4779 With @samp{-mfaster-structs}, the compiler assumes that structures
4780 should have 8 byte alignment.  This enables the use of pairs of
4781 @code{ldd} and @code{std} instructions for copies in structure
4782 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4783 However, the use of this changed alignment directly violates the Sparc
4784 ABI.  Thus, it's intended only for use on targets where the developer
4785 acknowledges that their resulting code will not be directly in line with
4786 the rules of the ABI.
4788 @item -mv8
4789 @itemx -msparclite
4790 These two options select variations on the SPARC architecture.
4792 By default (unless specifically configured for the Fujitsu SPARClite),
4793 GCC generates code for the v7 variant of the SPARC architecture.
4795 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4796 code is that the compiler emits the integer multiply and integer
4797 divide instructions which exist in SPARC v8 but not in SPARC v7.
4799 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4800 multiply, integer divide step and scan (@code{ffs}) instructions which
4801 exist in SPARClite but not in SPARC v7.
4803 These options are deprecated and will be deleted in a future GCC release.
4804 They have been replaced with @samp{-mcpu=xxx}.
4806 @item -mcypress
4807 @itemx -msupersparc
4808 These two options select the processor for which the code is optimised.
4810 With @samp{-mcypress} (the default), the compiler optimizes code for the
4811 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4812 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4814 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4815 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4816 of the full SPARC v8 instruction set.
4818 These options are deprecated and will be deleted in a future GCC release.
4819 They have been replaced with @samp{-mcpu=xxx}.
4821 @item -mcpu=@var{cpu_type}
4822 Set the instruction set, register set, and instruction scheduling parameters
4823 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4824 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4825 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4826 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4828 Default instruction scheduling parameters are used for values that select
4829 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4830 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4832 Here is a list of each supported architecture and their supported
4833 implementations.
4835 @smallexample
4836     v7:             cypress
4837     v8:             supersparc, hypersparc
4838     sparclite:      f930, f934, sparclite86x
4839     sparclet:       tsc701
4840     v9:             ultrasparc
4841 @end smallexample
4843 @item -mtune=@var{cpu_type}
4844 Set the instruction scheduling parameters for machine type
4845 @var{cpu_type}, but do not set the instruction set or register set that the
4846 option @samp{-mcpu=}@var{cpu_type} would.
4848 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4849 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4850 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4851 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4852 @samp{tsc701}, @samp{ultrasparc}.
4854 @end table
4856 These @samp{-m} switches are supported in addition to the above
4857 on the SPARCLET processor.
4859 @table @gcctabopt
4860 @item -mlittle-endian
4861 Generate code for a processor running in little-endian mode.
4863 @item -mlive-g0
4864 Treat register @code{%g0} as a normal register.
4865 GCC will continue to clobber it as necessary but will not assume
4866 it always reads as 0.
4868 @item -mbroken-saverestore
4869 Generate code that does not use non-trivial forms of the @code{save} and
4870 @code{restore} instructions.  Early versions of the SPARCLET processor do
4871 not correctly handle @code{save} and @code{restore} instructions used with
4872 arguments.  They correctly handle them used without arguments.  A @code{save}
4873 instruction used without arguments increments the current window pointer
4874 but does not allocate a new stack frame.  It is assumed that the window
4875 overflow trap handler will properly handle this case as will interrupt
4876 handlers.
4877 @end table
4879 These @samp{-m} switches are supported in addition to the above
4880 on SPARC V9 processors in 64 bit environments.
4882 @table @gcctabopt
4883 @item -mlittle-endian
4884 Generate code for a processor running in little-endian mode.
4886 @item -m32
4887 @itemx -m64
4888 Generate code for a 32 bit or 64 bit environment.
4889 The 32 bit environment sets int, long and pointer to 32 bits.
4890 The 64 bit environment sets int to 32 bits and long and pointer
4891 to 64 bits.
4893 @item -mcmodel=medlow
4894 Generate code for the Medium/Low code model: the program must be linked
4895 in the low 32 bits of the address space.  Pointers are 64 bits.
4896 Programs can be statically or dynamically linked.
4898 @item -mcmodel=medmid
4899 Generate code for the Medium/Middle code model: the program must be linked
4900 in the low 44 bits of the address space, the text segment must be less than
4901 2G bytes, and data segment must be within 2G of the text segment.
4902 Pointers are 64 bits.
4904 @item -mcmodel=medany
4905 Generate code for the Medium/Anywhere code model: the program may be linked
4906 anywhere in the address space, the text segment must be less than
4907 2G bytes, and data segment must be within 2G of the text segment.
4908 Pointers are 64 bits.
4910 @item -mcmodel=embmedany
4911 Generate code for the Medium/Anywhere code model for embedded systems:
4912 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4913 (determined at link time).  Register %g4 points to the base of the
4914 data segment.  Pointers still 64 bits.
4915 Programs are statically linked, PIC is not supported.
4917 @item -mstack-bias
4918 @itemx -mno-stack-bias
4919 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4920 frame pointer if present, are offset by -2047 which must be added back
4921 when making stack frame references.
4922 Otherwise, assume no such offset is present.
4923 @end table
4925 @node Convex Options
4926 @subsection Convex Options
4927 @cindex Convex options
4929 These @samp{-m} options are defined for Convex:
4931 @table @gcctabopt
4932 @item -mc1
4933 Generate output for C1.  The code will run on any Convex machine.
4934 The preprocessor symbol @code{__convex__c1__} is defined.
4936 @item -mc2
4937 Generate output for C2.  Uses instructions not available on C1.
4938 Scheduling and other optimizations are chosen for max performance on C2.
4939 The preprocessor symbol @code{__convex_c2__} is defined.
4941 @item -mc32
4942 Generate output for C32xx.  Uses instructions not available on C1.
4943 Scheduling and other optimizations are chosen for max performance on C32.
4944 The preprocessor symbol @code{__convex_c32__} is defined.
4946 @item -mc34
4947 Generate output for C34xx.  Uses instructions not available on C1.
4948 Scheduling and other optimizations are chosen for max performance on C34.
4949 The preprocessor symbol @code{__convex_c34__} is defined.
4951 @item -mc38
4952 Generate output for C38xx.  Uses instructions not available on C1.
4953 Scheduling and other optimizations are chosen for max performance on C38.
4954 The preprocessor symbol @code{__convex_c38__} is defined.
4956 @item -margcount
4957 Generate code which puts an argument count in the word preceding each
4958 argument list.  This is compatible with regular CC, and a few programs
4959 may need the argument count word.  GDB and other source-level debuggers
4960 do not need it; this info is in the symbol table.
4962 @item -mnoargcount
4963 Omit the argument count word.  This is the default.
4965 @item -mvolatile-cache
4966 Allow volatile references to be cached.  This is the default.
4968 @item -mvolatile-nocache
4969 Volatile references bypass the data cache, going all the way to memory.
4970 This is only needed for multi-processor code that does not use standard
4971 synchronization instructions.  Making non-volatile references to volatile
4972 locations will not necessarily work.
4974 @item -mlong32
4975 Type long is 32 bits, the same as type int.  This is the default.
4977 @item -mlong64
4978 Type long is 64 bits, the same as type long long.  This option is useless,
4979 because no library support exists for it.
4980 @end table
4982 @node AMD29K Options
4983 @subsection AMD29K Options
4984 @cindex AMD29K options
4986 These @samp{-m} options are defined for the AMD Am29000:
4988 @table @gcctabopt
4989 @item -mdw
4990 @kindex -mdw
4991 @cindex DW bit (29k)
4992 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4993 halfword operations are directly supported by the hardware.  This is the
4994 default.
4996 @item -mndw
4997 @kindex -mndw
4998 Generate code that assumes the @code{DW} bit is not set.
5000 @item -mbw
5001 @kindex -mbw
5002 @cindex byte writes (29k)
5003 Generate code that assumes the system supports byte and halfword write
5004 operations.  This is the default.
5006 @item -mnbw
5007 @kindex -mnbw
5008 Generate code that assumes the systems does not support byte and
5009 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
5011 @item -msmall
5012 @kindex -msmall
5013 @cindex memory model (29k)
5014 Use a small memory model that assumes that all function addresses are
5015 either within a single 256 KB segment or at an absolute address of less
5016 than 256k.  This allows the @code{call} instruction to be used instead
5017 of a @code{const}, @code{consth}, @code{calli} sequence.
5019 @item -mnormal
5020 @kindex -mnormal
5021 Use the normal memory model: Generate @code{call} instructions only when
5022 calling functions in the same file and @code{calli} instructions
5023 otherwise.  This works if each file occupies less than 256 KB but allows
5024 the entire executable to be larger than 256 KB.  This is the default.
5026 @item -mlarge
5027 Always use @code{calli} instructions.  Specify this option if you expect
5028 a single file to compile into more than 256 KB of code.
5030 @item -m29050
5031 @kindex -m29050
5032 @cindex processor selection (29k)
5033 Generate code for the Am29050.
5035 @item -m29000
5036 @kindex -m29000
5037 Generate code for the Am29000.  This is the default.
5039 @item -mkernel-registers
5040 @kindex -mkernel-registers
5041 @cindex kernel and user registers (29k)
5042 Generate references to registers @code{gr64-gr95} instead of to
5043 registers @code{gr96-gr127}.  This option can be used when compiling
5044 kernel code that wants a set of global registers disjoint from that used
5045 by user-mode code.
5047 Note that when this option is used, register names in @samp{-f} flags
5048 must use the normal, user-mode, names.
5050 @item -muser-registers
5051 @kindex -muser-registers
5052 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5053 default.
5055 @item -mstack-check
5056 @itemx -mno-stack-check
5057 @kindex -mstack-check
5058 @cindex stack checks (29k)
5059 Insert (or do not insert) a call to @code{__msp_check} after each stack
5060 adjustment.  This is often used for kernel code.
5062 @item -mstorem-bug
5063 @itemx -mno-storem-bug
5064 @kindex -mstorem-bug
5065 @cindex storem bug (29k)
5066 @samp{-mstorem-bug} handles 29k processors which cannot handle the
5067 separation of a mtsrim insn and a storem instruction (most 29000 chips
5068 to date, but not the 29050).
5070 @item -mno-reuse-arg-regs
5071 @itemx -mreuse-arg-regs
5072 @kindex -mreuse-arg-regs
5073 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5074 registers for copying out arguments.  This helps detect calling a function
5075 with fewer arguments than it was declared with.
5077 @item -mno-impure-text
5078 @itemx -mimpure-text
5079 @kindex -mimpure-text
5080 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5081 not pass @samp{-assert pure-text} to the linker when linking a shared object.
5083 @item -msoft-float
5084 @kindex -msoft-float
5085 Generate output containing library calls for floating point.
5086 @strong{Warning:} the requisite libraries are not part of GCC.
5087 Normally the facilities of the machine's usual C compiler are used, but
5088 this can't be done directly in cross-compilation.  You must make your
5089 own arrangements to provide suitable library functions for
5090 cross-compilation.
5092 @item -mno-multm
5093 @kindex -mno-multm
5094 Do not generate multm or multmu instructions.  This is useful for some embedded
5095 systems which do not have trap handlers for these instructions.
5096 @end table
5098 @node ARM Options
5099 @subsection ARM Options
5100 @cindex ARM options
5102 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5103 architectures:
5105 @table @gcctabopt
5106 @item -mapcs-frame
5107 @kindex -mapcs-frame
5108 Generate a stack frame that is compliant with the ARM Procedure Call
5109 Standard for all functions, even if this is not strictly necessary for
5110 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
5111 with this option will cause the stack frames not to be generated for
5112 leaf functions.  The default is @samp{-mno-apcs-frame}.
5114 @item -mapcs
5115 @kindex -mapcs
5116 This is a synonym for @samp{-mapcs-frame}.
5118 @item -mapcs-26
5119 @kindex -mapcs-26
5120 Generate code for a processor running with a 26-bit program counter,
5121 and conforming to the function calling standards for the APCS 26-bit
5122 option.  This option replaces the @samp{-m2} and @samp{-m3} options
5123 of previous releases of the compiler.
5125 @item -mapcs-32
5126 @kindex -mapcs-32
5127 Generate code for a processor running with a 32-bit program counter,
5128 and conforming to the function calling standards for the APCS 32-bit
5129 option.  This option replaces the @samp{-m6} option of previous releases
5130 of the compiler.
5132 @item -mapcs-stack-check
5133 @kindex -mapcs-stack-check
5134 @kindex -mno-apcs-stack-check
5135 Generate code to check the amount of stack space available upon entry to
5136 every function (that actually uses some stack space).  If there is
5137 insufficient space available then either the function
5138 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5139 called, depending upon the amount of stack space required.  The run time
5140 system is required to provide these functions.  The default is
5141 @samp{-mno-apcs-stack-check}, since this produces smaller code.
5143 @item -mapcs-float
5144 @kindex -mapcs-float
5145 @kindex -mno-apcs-float
5146 Pass floating point arguments using the float point registers.  This is
5147 one of the variants of the APCS.  This option is recommended if the
5148 target hardware has a floating point unit or if a lot of floating point
5149 arithmetic is going to be performed by the code.  The default is
5150 @samp{-mno-apcs-float}, since integer only code is slightly increased in
5151 size if @samp{-mapcs-float} is used.
5153 @item -mapcs-reentrant
5154 @kindex -mapcs-reentrant
5155 @kindex -mno-apcs-reentrant
5156 Generate reentrant, position independent code.  This is the equivalent
5157 to specifying the @samp{-fpic} option.  The default is
5158 @samp{-mno-apcs-reentrant}.
5160 @item -mthumb-interwork
5161 @kindex -mthumb-interwork
5162 @kindex -mno-thumb-interwork
5163 Generate code which supports calling between the ARM and THUMB
5164 instruction sets.  Without this option the two instruction sets cannot
5165 be reliably used inside one program.  The default is
5166 @samp{-mno-thumb-interwork}, since slightly larger code is generated
5167 when @samp{-mthumb-interwork} is specified.
5169 @item -mno-sched-prolog
5170 @kindex -mno-sched-prolog
5171 @kindex -msched-prolog
5172 Prevent the reordering of instructions in the function prolog, or the
5173 merging of those instruction with the instructions in the function's
5174 body.  This means that all functions will start with a recognizable set
5175 of instructions (or in fact one of a choice from a small set of
5176 different function prologues), and this information can be used to
5177 locate the start if functions inside an executable piece of code.  The
5178 default is @samp{-msched-prolog}.
5180 @item -mhard-float
5181 Generate output containing floating point instructions.  This is the
5182 default.
5184 @item -msoft-float
5185 Generate output containing library calls for floating point.
5186 @strong{Warning:} the requisite libraries are not available for all ARM
5187 targets.  Normally the facilities of the machine's usual C compiler are
5188 used, but this cannot be done directly in cross-compilation.  You must make
5189 your own arrangements to provide suitable library functions for
5190 cross-compilation.
5192 @samp{-msoft-float} changes the calling convention in the output file;
5193 therefore, it is only useful if you compile @emph{all} of a program with
5194 this option.  In particular, you need to compile @file{libgcc.a}, the
5195 library that comes with GCC, with @samp{-msoft-float} in order for
5196 this to work.
5198 @item -mlittle-endian
5199 Generate code for a processor running in little-endian mode.  This is
5200 the default for all standard configurations.
5202 @item -mbig-endian
5203 Generate code for a processor running in big-endian mode; the default is
5204 to compile code for a little-endian processor.
5206 @item -mwords-little-endian
5207 This option only applies when generating code for big-endian processors.
5208 Generate code for a little-endian word order but a big-endian byte
5209 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5210 option should only be used if you require compatibility with code for
5211 big-endian ARM processors generated by versions of the compiler prior to
5212 2.8.
5214 @item -malignment-traps
5215 @kindex -malignment-traps
5216 Generate code that will not trap if the MMU has alignment traps enabled.
5217 On ARM architectures prior to ARMv4, there were no instructions to
5218 access half-word objects stored in memory.  However, when reading from
5219 memory a feature of the ARM architecture allows a word load to be used,
5220 even if the address is unaligned, and the processor core will rotate the
5221 data as it is being loaded.  This option tells the compiler that such
5222 misaligned accesses will cause a MMU trap and that it should instead
5223 synthesise the access as a series of byte accesses.  The compiler can
5224 still use word accesses to load half-word data if it knows that the
5225 address is aligned to a word boundary.
5227 This option is ignored when compiling for ARM architecture 4 or later,
5228 since these processors have instructions to directly access half-word
5229 objects in memory. 
5230         
5231 @item -mno-alignment-traps
5232 @kindex -mno-alignment-traps
5233 Generate code that assumes that the MMU will not trap unaligned
5234 accesses.  This produces better code when the target instruction set
5235 does not have half-word memory operations (implementations prior to
5236 ARMv4). 
5238 Note that you cannot use this option to access unaligned word objects,
5239 since the processor will only fetch one 32-bit aligned object from
5240 memory. 
5242 The default setting for most targets is -mno-alignment-traps, since
5243 this produces better code when there are no half-word memory
5244 instructions available. 
5246 @item -mshort-load-bytes
5247 @kindex -mshort-load-bytes
5248 This is a deprecated alias for @samp{-malignment-traps}.
5250 @item -mno-short-load-bytes
5251 @kindex -mno-short-load-bytes
5252 This is a deprecated alias for @samp{-mno-alignment-traps}.
5254 @item -mshort-load-words
5255 @kindex -mshort-load-words
5256 This is a deprecated alias for @samp{-mno-alignment-traps}.
5258 @item -mno-short-load-words
5259 @kindex -mno-short-load-words
5260 This is a deprecated alias for @samp{-malignment-traps}.
5262 @item -mbsd
5263 @kindex -mbsd
5264 This option only applies to RISC iX.  Emulate the native BSD-mode
5265 compiler.  This is the default if @samp{-ansi} is not specified.
5267 @item -mxopen
5268 @kindex -mxopen
5269 This option only applies to RISC iX.  Emulate the native X/Open-mode
5270 compiler.
5272 @item -mno-symrename
5273 @kindex -mno-symrename
5274 This option only applies to RISC iX.  Do not run the assembler
5275 post-processor, @samp{symrename}, after code has been assembled.
5276 Normally it is necessary to modify some of the standard symbols in
5277 preparation for linking with the RISC iX C library; this option
5278 suppresses this pass.  The post-processor is never run when the
5279 compiler is built for cross-compilation.
5281 @item -mcpu=<name>
5282 @kindex -mcpu=
5283 This specifies the name of the target ARM processor.  GCC uses this name
5284 to determine what kind of instructions it can use when generating
5285 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
5286 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5287 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
5288 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
5289 arm9, arm920, arm920t, arm9tdmi.
5291 @itemx -mtune=<name>
5292 @kindex -mtune=
5293 This option is very similar to the @samp{-mcpu=} option, except that
5294 instead of specifying the actual target processor type, and hence
5295 restricting which instructions can be used, it specifies that GCC should
5296 tune the performance of the code as if the target were of the type
5297 specified in this option, but still choosing the instructions that it
5298 will generate based on the cpu specified by a @samp{-mcpu=} option.
5299 For some arm implementations better performance can be obtained by using
5300 this option.
5302 @item -march=<name>
5303 @kindex -march=
5304 This specifies the name of the target ARM architecture.  GCC uses this
5305 name to determine what kind of instructions it can use when generating
5306 assembly code.  This option can be used in conjunction with or instead
5307 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
5308 armv3, armv3m, armv4, armv4t, armv5.
5310 @item -mfpe=<number>
5311 @itemx -mfp=<number>
5312 @kindex -mfpe=
5313 @kindex -mfp=
5314 This specifies the version of the floating point emulation available on
5315 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
5316 for @samp{-mfpe=} to support older versions of GCC.
5318 @item -mstructure-size-boundary=<n>
5319 @kindex -mstructure-size-boundary
5320 The size of all structures and unions will be rounded up to a multiple
5321 of the number of bits set by this option.  Permissible values are 8 and
5322 32.  The default value varies for different toolchains.  For the COFF
5323 targeted toolchain the default value is 8.  Specifying the larger number
5324 can produce faster, more efficient code, but can also increase the size
5325 of the program.  The two values are potentially incompatible.  Code
5326 compiled with one value cannot necessarily expect to work with code or
5327 libraries compiled with the other value, if they exchange information
5328 using structures or unions.  Programmers are encouraged to use the 32
5329 value as future versions of the toolchain may default to this value.
5331 @item -mabort-on-noreturn
5332 @kindex -mabort-on-noreturn
5333 @kindex -mnoabort-on-noreturn
5334 Generate a call to the function abort at the end of a noreturn function.
5335 It will be executed if the function tries to return.
5337 @item -mlong-calls
5338 @itemx -mno-long-calls
5339 Tells the compiler to perform function calls by first loading the
5340 address of the function into a register and then performing a subroutine
5341 call on this register.  This switch is needed if the target function
5342 will lie outside of the 64 megabyte addressing range of the offset based
5343 version of subroutine call instruction. 
5345 Even if this switch is enabled, not all function calls will be turned
5346 into long calls.  The heuristic is that static functions, functions
5347 which have the @samp{short-call} attribute, functions that are inside
5348 the scope of a @samp{#pragma no_long_calls} directive and functions whose
5349 definitions have already been compiled within the current compilation
5350 unit, will not be turned into long calls.  The exception to this rule is
5351 that weak function definitions, functions with the @samp{long-call}
5352 attribute or the @samp{section} attribute, and functions that are within
5353 the scope of a @samp{#pragma long_calls} directive, will always be
5354 turned into long calls.
5356 This feature is not enabled by default.  Specifying
5357 @samp{--no-long-calls} will restore the default behaviour, as will
5358 placing the function calls within the scope of a @samp{#pragma
5359 long_calls_off} directive.  Note these switches have no effect on how
5360 the compiler generates code to handle function calls via function
5361 pointers.  
5363 @item -mnop-fun-dllimport
5364 @kindex -mnop-fun-dllimport
5365 Disable the support for the @emph{dllimport} attribute.
5367 @item -msingle-pic-base
5368 @kindex -msingle-pic-base
5369 Treat the register used for PIC addressing as read-only, rather than
5370 loading it in the prologue for each function.  The run-time system is
5371 responsible for initialising this register with an appropriate value
5372 before execution begins.
5374 @item -mpic-register=<reg>
5375 @kindex -mpic-register=
5376 Specify the register to be used for PIC addressing.  The default is R10
5377 unless stack-checking is enabled, when R9 is used.
5379 @end table
5381 @node Thumb Options
5382 @subsection Thumb Options
5383 @cindex Thumb Options
5385 @table @gcctabopt
5387 @item -mthumb-interwork
5388 @kindex -mthumb-interwork
5389 @kindex -mno-thumb-interwork
5390 Generate code which supports calling between the THUMB and ARM
5391 instruction sets.  Without this option the two instruction sets cannot
5392 be reliably used inside one program.  The default is
5393 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
5394 with this option.
5396 @item -mtpcs-frame
5397 @kindex -mtpcs-frame
5398 @kindex -mno-tpcs-frame
5399 Generate a stack frame that is compliant with the Thumb Procedure Call
5400 Standard for all non-leaf functions.  (A leaf function is one that does
5401 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
5403 @item -mtpcs-leaf-frame
5404 @kindex -mtpcs-leaf-frame
5405 @kindex -mno-tpcs-leaf-frame
5406 Generate a stack frame that is compliant with the Thumb Procedure Call
5407 Standard for all leaf functions.  (A leaf function is one that does
5408 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
5410 @item -mlittle-endian
5411 @kindex -mlittle-endian
5412 Generate code for a processor running in little-endian mode.  This is
5413 the default for all standard configurations.
5415 @item -mbig-endian
5416 @kindex -mbig-endian
5417 Generate code for a processor running in big-endian mode.
5419 @item -mstructure-size-boundary=<n>
5420 @kindex -mstructure-size-boundary
5421 The size of all structures and unions will be rounded up to a multiple
5422 of the number of bits set by this option.  Permissible values are 8 and
5423 32.  The default value varies for different toolchains.  For the COFF
5424 targeted toolchain the default value is 8.  Specifying the larger number
5425 can produced faster, more efficient code, but can also increase the size
5426 of the program.  The two values are potentially incompatible.  Code
5427 compiled with one value cannot necessarily expect to work with code or
5428 libraries compiled with the other value, if they exchange information
5429 using structures or unions.  Programmers are encouraged to use the 32
5430 value as future versions of the toolchain may default to this value.
5432 @item -mnop-fun-dllimport
5433 @kindex -mnop-fun-dllimport
5434 Disable the support for the @emph{dllimport} attribute.
5436 @item -mcallee-super-interworking
5437 @kindex -mcallee-super-interworking
5438 Gives all externally visible functions in the file being compiled an ARM
5439 instruction set header which switches to Thumb mode before executing the
5440 rest of the function.  This allows these functions to be called from
5441 non-interworking code.
5443 @item -mcaller-super-interworking
5444 @kindex -mcaller-super-interworking
5445 Allows calls via function pointers (including virtual functions) to
5446 execute correctly regardless of whether the target code has been
5447 compiled for interworking or not.  There is a small overhead in the cost
5448 of executing a function pointer if this option is enabled.
5450 @item -msingle-pic-base
5451 @kindex -msingle-pic-base
5452 Treat the register used for PIC addressing as read-only, rather than
5453 loading it in the prologue for each function.  The run-time system is
5454 responsible for initialising this register with an appropriate value
5455 before execution begins.
5457 @item -mpic-register=<reg>
5458 @kindex -mpic-register=
5459 Specify the register to be used for PIC addressing.  The default is R10.
5461 @end table
5463 @node MN10200 Options
5464 @subsection MN10200 Options
5465 @cindex MN10200 options
5466 These @samp{-m} options are defined for Matsushita MN10200 architectures:
5467 @table @gcctabopt
5469 @item -mrelax
5470 Indicate to the linker that it should perform a relaxation optimization pass
5471 to shorten branches, calls and absolute memory addresses.  This option only
5472 has an effect when used on the command line for the final link step.
5474 This option makes symbolic debugging impossible. 
5475 @end table
5477 @node MN10300 Options
5478 @subsection MN10300 Options
5479 @cindex MN10300 options
5480 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5482 @table @gcctabopt
5483 @item -mmult-bug
5484 Generate code to avoid bugs in the multiply instructions for the MN10300
5485 processors.  This is the default.
5487 @item -mno-mult-bug
5488 Do not generate code to avoid bugs in the multiply instructions for the
5489 MN10300 processors.
5491 @item -mam33
5492 Generate code which uses features specific to the AM33 processor.
5494 @item -mno-am33
5495 Do not generate code which uses features specific to the AM33 processor.  This
5496 is the default.
5498 @item -mrelax
5499 Indicate to the linker that it should perform a relaxation optimization pass
5500 to shorten branches, calls and absolute memory addresses.  This option only
5501 has an effect when used on the command line for the final link step.
5503 This option makes symbolic debugging impossible. 
5504 @end table
5507 @node M32R/D Options
5508 @subsection M32R/D Options
5509 @cindex M32R/D options
5511 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5513 @table @gcctabopt
5514 @item -mcode-model=small
5515 Assume all objects live in the lower 16MB of memory (so that their addresses
5516 can be loaded with the @code{ld24} instruction), and assume all subroutines
5517 are reachable with the @code{bl} instruction.
5518 This is the default.
5520 The addressability of a particular object can be set with the
5521 @code{model} attribute.
5523 @item -mcode-model=medium
5524 Assume objects may be anywhere in the 32 bit address space (the compiler
5525 will generate @code{seth/add3} instructions to load their addresses), and
5526 assume all subroutines are reachable with the @code{bl} instruction.
5528 @item -mcode-model=large
5529 Assume objects may be anywhere in the 32 bit address space (the compiler
5530 will generate @code{seth/add3} instructions to load their addresses), and
5531 assume subroutines may not be reachable with the @code{bl} instruction
5532 (the compiler will generate the much slower @code{seth/add3/jl}
5533 instruction sequence).
5535 @item -msdata=none
5536 Disable use of the small data area.  Variables will be put into
5537 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5538 @code{section} attribute has been specified).
5539 This is the default.
5541 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5542 Objects may be explicitly put in the small data area with the
5543 @code{section} attribute using one of these sections.
5545 @item -msdata=sdata
5546 Put small global and static data in the small data area, but do not
5547 generate special code to reference them.
5549 @item -msdata=use
5550 Put small global and static data in the small data area, and generate
5551 special instructions to reference them.
5553 @item -G @var{num}
5554 @cindex smaller data references
5555 Put global and static objects less than or equal to @var{num} bytes
5556 into the small data or bss sections instead of the normal data or bss
5557 sections.  The default value of @var{num} is 8.
5558 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5559 for this option to have any effect.
5561 All modules should be compiled with the same @samp{-G @var{num}} value.
5562 Compiling with different values of @var{num} may or may not work; if it
5563 doesn't the linker will give an error message - incorrect code will not be
5564 generated.
5566 @end table
5568 @node M88K Options
5569 @subsection M88K Options
5570 @cindex M88k options
5572 These @samp{-m} options are defined for Motorola 88k architectures:
5574 @table @gcctabopt
5575 @item -m88000
5576 @kindex -m88000
5577 Generate code that works well on both the m88100 and the
5578 m88110.
5580 @item -m88100
5581 @kindex -m88100
5582 Generate code that works best for the m88100, but that also
5583 runs on the m88110.
5585 @item -m88110
5586 @kindex -m88110
5587 Generate code that works best for the m88110, and may not run
5588 on the m88100.
5590 @item -mbig-pic
5591 @kindex -mbig-pic
5592 Obsolete option to be removed from the next revision.
5593 Use @samp{-fPIC}.
5595 @item -midentify-revision
5596 @kindex -midentify-revision
5597 @kindex ident
5598 @cindex identifying source, compiler (88k)
5599 Include an @code{ident} directive in the assembler output recording the
5600 source file name, compiler name and version, timestamp, and compilation
5601 flags used.
5603 @item -mno-underscores
5604 @kindex -mno-underscores
5605 @cindex underscores, avoiding (88k)
5606 In assembler output, emit symbol names without adding an underscore
5607 character at the beginning of each name.  The default is to use an
5608 underscore as prefix on each name.
5610 @item -mocs-debug-info
5611 @itemx -mno-ocs-debug-info
5612 @kindex -mocs-debug-info
5613 @kindex -mno-ocs-debug-info
5614 @cindex OCS (88k)
5615 @cindex debugging, 88k OCS
5616 Include (or omit) additional debugging information (about registers used
5617 in each stack frame) as specified in the 88open Object Compatibility
5618 Standard, ``OCS''.  This extra information allows debugging of code that
5619 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
5620 Delta 88 SVr3.2 is to include this information; other 88k configurations
5621 omit this information by default.
5623 @item -mocs-frame-position
5624 @kindex -mocs-frame-position
5625 @cindex register positions in frame (88k)
5626 When emitting COFF debugging information for automatic variables and
5627 parameters stored on the stack, use the offset from the canonical frame
5628 address, which is the stack pointer (register 31) on entry to the
5629 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5630 @samp{-mocs-frame-position}; other 88k configurations have the default
5631 @samp{-mno-ocs-frame-position}.
5633 @item -mno-ocs-frame-position
5634 @kindex -mno-ocs-frame-position
5635 @cindex register positions in frame (88k)
5636 When emitting COFF debugging information for automatic variables and
5637 parameters stored on the stack, use the offset from the frame pointer
5638 register (register 30).  When this option is in effect, the frame
5639 pointer is not eliminated when debugging information is selected by the
5640 -g switch.
5642 @item -moptimize-arg-area
5643 @itemx -mno-optimize-arg-area
5644 @kindex -moptimize-arg-area
5645 @kindex -mno-optimize-arg-area
5646 @cindex arguments in frame (88k)
5647 Control how function arguments are stored in stack frames.
5648 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5649 conflicts with the 88open specifications.  The opposite alternative,
5650 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5651 GCC does not optimize the argument area.
5653 @item -mshort-data-@var{num}
5654 @kindex -mshort-data-@var{num}
5655 @cindex smaller data references (88k)
5656 @cindex r0-relative references (88k)
5657 Generate smaller data references by making them relative to @code{r0},
5658 which allows loading a value using a single instruction (rather than the
5659 usual two).  You control which data references are affected by
5660 specifying @var{num} with this option.  For example, if you specify
5661 @samp{-mshort-data-512}, then the data references affected are those
5662 involving displacements of less than 512 bytes.
5663 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5664 than 64k.
5666 @item -mserialize-volatile
5667 @kindex -mserialize-volatile
5668 @itemx -mno-serialize-volatile
5669 @kindex -mno-serialize-volatile
5670 @cindex sequential consistency on 88k
5671 Do, or don't, generate code to guarantee sequential consistency
5672 of volatile memory references.  By default, consistency is
5673 guaranteed.
5675 The order of memory references made by the MC88110 processor does
5676 not always match the order of the instructions requesting those
5677 references.  In particular, a load instruction may execute before
5678 a preceding store instruction.  Such reordering violates
5679 sequential consistency of volatile memory references, when there
5680 are multiple processors.   When consistency must be guaranteed,
5681 GNU C generates special instructions, as needed, to force
5682 execution in the proper order.
5684 The MC88100 processor does not reorder memory references and so
5685 always provides sequential consistency.  However, by default, GNU
5686 C generates the special instructions to guarantee consistency
5687 even when you use @samp{-m88100}, so that the code may be run on an
5688 MC88110 processor.  If you intend to run your code only on the
5689 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5691 The extra code generated to guarantee consistency may affect the
5692 performance of your application.  If you know that you can safely
5693 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5695 @item -msvr4
5696 @itemx -msvr3
5697 @kindex -msvr4
5698 @kindex -msvr3
5699 @cindex assembler syntax, 88k
5700 @cindex SVr4
5701 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5702 related to System V release 4 (SVr4).  This controls the following:
5704 @enumerate
5705 @item
5706 Which variant of the assembler syntax to emit.
5707 @item
5708 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5709 that is used on System V release 4.
5710 @item
5711 @samp{-msvr4} makes GCC issue additional declaration directives used in
5712 SVr4.
5713 @end enumerate
5715 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5716 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5717 other m88k configurations.
5719 @item -mversion-03.00
5720 @kindex -mversion-03.00
5721 This option is obsolete, and is ignored.
5722 @c ??? which asm syntax better for GAS?  option there too?
5724 @item -mno-check-zero-division
5725 @itemx -mcheck-zero-division
5726 @kindex -mno-check-zero-division
5727 @kindex -mcheck-zero-division
5728 @cindex zero division on 88k
5729 Do, or don't, generate code to guarantee that integer division by
5730 zero will be detected.  By default, detection is guaranteed.
5732 Some models of the MC88100 processor fail to trap upon integer
5733 division by zero under certain conditions.  By default, when
5734 compiling code that might be run on such a processor, GNU C
5735 generates code that explicitly checks for zero-valued divisors
5736 and traps with exception number 503 when one is detected.  Use of
5737 mno-check-zero-division suppresses such checking for code
5738 generated to run on an MC88100 processor.
5740 GNU C assumes that the MC88110 processor correctly detects all
5741 instances of integer division by zero.  When @samp{-m88110} is
5742 specified, both @samp{-mcheck-zero-division} and
5743 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5744 zero-valued divisors are generated.
5746 @item -muse-div-instruction
5747 @kindex -muse-div-instruction
5748 @cindex divide instruction, 88k
5749 Use the div instruction for signed integer division on the
5750 MC88100 processor.  By default, the div instruction is not used.
5752 On the MC88100 processor the signed integer division instruction
5753 div) traps to the operating system on a negative operand.  The
5754 operating system transparently completes the operation, but at a
5755 large cost in execution time.  By default, when compiling code
5756 that might be run on an MC88100 processor, GNU C emulates signed
5757 integer division using the unsigned integer division instruction
5758 divu), thereby avoiding the large penalty of a trap to the
5759 operating system.  Such emulation has its own, smaller, execution
5760 cost in both time and space.  To the extent that your code's
5761 important signed integer division operations are performed on two
5762 nonnegative operands, it may be desirable to use the div
5763 instruction directly.
5765 On the MC88110 processor the div instruction (also known as the
5766 divs instruction) processes negative operands without trapping to
5767 the operating system.  When @samp{-m88110} is specified,
5768 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5769 for signed integer division.
5771 Note that the result of dividing INT_MIN by -1 is undefined.  In
5772 particular, the behavior of such a division with and without
5773 @samp{-muse-div-instruction}  may differ.
5775 @item -mtrap-large-shift
5776 @itemx -mhandle-large-shift
5777 @kindex -mtrap-large-shift
5778 @kindex -mhandle-large-shift
5779 @cindex bit shift overflow (88k)
5780 @cindex large bit shifts (88k)
5781 Include code to detect bit-shifts of more than 31 bits; respectively,
5782 trap such shifts or emit code to handle them properly.  By default GCC
5783 makes no special provision for large bit shifts.
5785 @item -mwarn-passed-structs
5786 @kindex -mwarn-passed-structs
5787 @cindex structure passing (88k)
5788 Warn when a function passes a struct as an argument or result.
5789 Structure-passing conventions have changed during the evolution of the C
5790 language, and are often the source of portability problems.  By default,
5791 GCC issues no such warning.
5792 @end table
5794 @node RS/6000 and PowerPC Options
5795 @subsection IBM RS/6000 and PowerPC Options
5796 @cindex RS/6000 and PowerPC Options
5797 @cindex IBM RS/6000 and PowerPC Options
5799 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5800 @table @gcctabopt
5801 @item -mpower
5802 @itemx -mno-power
5803 @itemx -mpower2
5804 @itemx -mno-power2
5805 @itemx -mpowerpc
5806 @itemx -mno-powerpc
5807 @itemx -mpowerpc-gpopt
5808 @itemx -mno-powerpc-gpopt
5809 @itemx -mpowerpc-gfxopt
5810 @itemx -mno-powerpc-gfxopt
5811 @itemx -mpowerpc64
5812 @itemx -mno-powerpc64
5813 @kindex -mpower
5814 @kindex -mpower2
5815 @kindex -mpowerpc
5816 @kindex -mpowerpc-gpopt
5817 @kindex -mpowerpc-gfxopt
5818 @kindex -mpowerpc64
5819 GCC supports two related instruction set architectures for the
5820 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5821 instructions supported by the @samp{rios} chip set used in the original
5822 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5823 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5824 the IBM 4xx microprocessors.
5826 Neither architecture is a subset of the other.  However there is a
5827 large common subset of instructions supported by both.  An MQ
5828 register is included in processors supporting the POWER architecture.
5830 You use these options to specify which instructions are available on the
5831 processor you are using.  The default value of these options is
5832 determined when configuring GCC.  Specifying the
5833 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5834 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5835 rather than the options listed above.
5837 The @samp{-mpower} option allows GCC to generate instructions that
5838 are found only in the POWER architecture and to use the MQ register.
5839 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5840 to generate instructions that are present in the POWER2 architecture but
5841 not the original POWER architecture.
5843 The @samp{-mpowerpc} option allows GCC to generate instructions that
5844 are found only in the 32-bit subset of the PowerPC architecture.
5845 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5846 GCC to use the optional PowerPC architecture instructions in the
5847 General Purpose group, including floating-point square root.  Specifying
5848 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5849 use the optional PowerPC architecture instructions in the Graphics
5850 group, including floating-point select.
5852 The @samp{-mpowerpc64} option allows GCC to generate the additional
5853 64-bit instructions that are found in the full PowerPC64 architecture
5854 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5855 @samp{-mno-powerpc64}.
5857 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5858 will use only the instructions in the common subset of both
5859 architectures plus some special AIX common-mode calls, and will not use
5860 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5861 permits GCC to use any instruction from either architecture and to
5862 allow use of the MQ register; specify this for the Motorola MPC601.
5864 @item -mnew-mnemonics
5865 @itemx -mold-mnemonics
5866 @kindex -mnew-mnemonics
5867 @kindex -mold-mnemonics
5868 Select which mnemonics to use in the generated assembler code.
5869 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5870 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5871 requests the assembler mnemonics defined for the POWER architecture.
5872 Instructions defined in only one architecture have only one mnemonic;
5873 GCC uses that mnemonic irrespective of which of these options is
5874 specified.
5876 GCC defaults to the mnemonics appropriate for the architecture in
5877 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5878 value of these option.  Unless you are building a cross-compiler, you
5879 should normally not specify either @samp{-mnew-mnemonics} or
5880 @samp{-mold-mnemonics}, but should instead accept the default.
5882 @item -mcpu=@var{cpu_type}
5883 @kindex -mcpu
5884 Set architecture type, register usage, choice of mnemonics, and
5885 instruction scheduling parameters for machine type @var{cpu_type}.
5886 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5887 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5888 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5889 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5890 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5891 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5892 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5893 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5894 and 64-bit PowerPC architecture machine types, with an appropriate,
5895 generic processor model assumed for scheduling purposes.@refill
5897 Specifying any of the following options: 
5898 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5899 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5900 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5901 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5902 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5903 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5904 @samp{-mcpu=740}, and @samp{-mcpu=750}
5905 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5906 Exactly similarly, all of @samp{-mcpu=403},
5907 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5908 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5909 @samp{-mcpu=common} disables both the 
5910 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5912 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5913 that code will operate on all members of the RS/6000 POWER and PowerPC
5914 families.  In that case, GCC will use only the instructions in the
5915 common subset of both architectures plus some special AIX common-mode
5916 calls, and will not use the MQ register.  GCC assumes a generic
5917 processor model for scheduling purposes.
5919 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5920 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5921 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5922 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5923 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5924 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5925 the @samp{new-mnemonics} option.@refill
5927 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5928 enables the @samp{-msoft-float} option.
5930 @item -mtune=@var{cpu_type}
5931 Set the instruction scheduling parameters for machine type
5932 @var{cpu_type}, but do not set the architecture type, register usage,
5933 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5934 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5935 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5936 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5937 instruction scheduling parameters.
5939 @item -mfull-toc
5940 @itemx -mno-fp-in-toc
5941 @itemx -mno-sum-in-toc
5942 @itemx -mminimal-toc
5943 @kindex -mminimal-toc
5944 Modify generation of the TOC (Table Of Contents), which is created for
5945 every executable file.  The @samp{-mfull-toc} option is selected by
5946 default.  In that case, GCC will allocate at least one TOC entry for
5947 each unique non-automatic variable reference in your program.  GCC
5948 will also place floating-point constants in the TOC.  However, only
5949 16,384 entries are available in the TOC.
5951 If you receive a linker error message that saying you have overflowed
5952 the available TOC space, you can reduce the amount of TOC space used
5953 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5954 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5955 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5956 generate code to calculate the sum of an address and a constant at
5957 run-time instead of putting that sum into the TOC.  You may specify one
5958 or both of these options.  Each causes GCC to produce very slightly
5959 slower and larger code at the expense of conserving TOC space.
5961 If you still run out of space in the TOC even when you specify both of
5962 these options, specify @samp{-mminimal-toc} instead.  This option causes
5963 GCC to make only one TOC entry for every file.  When you specify this
5964 option, GCC will produce code that is slower and larger but which
5965 uses extremely little TOC space.  You may wish to use this option
5966 only on files that contain less frequently executed code. @refill
5968 @item -maix64
5969 @itemx -maix32
5970 @kindex -maix64
5971 @kindex -maix32
5972 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
5973 @code{long} type, and the infrastructure needed to support them.
5974 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
5975 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
5976 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
5978 @item -mxl-call
5979 @itemx -mno-xl-call
5980 @kindex -mxl-call
5981 On AIX, pass floating-point arguments to prototyped functions beyond the
5982 register save area (RSA) on the stack in addition to argument FPRs.  The
5983 AIX calling convention was extended but not initially documented to
5984 handle an obscure K&R C case of calling a function that takes the
5985 address of its arguments with fewer arguments than declared.  AIX XL
5986 compilers access floating point arguments which do not fit in the
5987 RSA from the stack when a subroutine is compiled without
5988 optimization.  Because always storing floating-point arguments on the
5989 stack is inefficient and rarely needed, this option is not enabled by
5990 default and only is necessary when calling subroutines compiled by AIX
5991 XL compilers without optimization.
5993 @item -mthreads
5994 @kindex -mthreads
5995 Support @dfn{AIX Threads}.  Link an application written to use
5996 @dfn{pthreads} with special libraries and startup code to enable the
5997 application to run.
5999 @item -mpe
6000 @kindex -mpe
6001 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
6002 application written to use message passing with special startup code to
6003 enable the application to run.  The system must have PE installed in the
6004 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
6005 must be overridden with the @samp{-specs=} option to specify the
6006 appropriate directory location.  The Parallel Environment does not
6007 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
6008 option are incompatible.
6010 @item -msoft-float
6011 @itemx -mhard-float
6012 @kindex -msoft-float
6013 Generate code that does not use (uses) the floating-point register set.
6014 Software floating point emulation is provided if you use the
6015 @samp{-msoft-float} option, and pass the option to GCC when linking.
6017 @item -mmultiple
6018 @itemx -mno-multiple
6019 Generate code that uses (does not use) the load multiple word
6020 instructions and the store multiple word instructions.  These
6021 instructions are generated by default on POWER systems, and not
6022 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
6023 endian PowerPC systems, since those instructions do not work when the
6024 processor is in little endian mode.  The exceptions are PPC740 and
6025 PPC750 which permit the instructions usage in little endian mode.
6027 @item -mstring
6028 @itemx -mno-string
6029 @kindex -mstring
6030 Generate code that uses (does not use) the load string instructions
6031 and the store string word instructions to save multiple registers and
6032 do small block moves.  These instructions are generated by default on
6033 POWER systems, and not generated on PowerPC systems.  Do not use
6034 @samp{-mstring} on little endian PowerPC systems, since those
6035 instructions do not work when the processor is in little endian mode.
6036 The exceptions are PPC740 and PPC750 which permit the instructions
6037 usage in little endian mode.
6039 @item -mupdate
6040 @itemx -mno-update
6041 @kindex -mupdate
6042 Generate code that uses (does not use) the load or store instructions
6043 that update the base register to the address of the calculated memory
6044 location.  These instructions are generated by default.  If you use
6045 @samp{-mno-update}, there is a small window between the time that the
6046 stack pointer is updated and the address of the previous frame is
6047 stored, which means code that walks the stack frame across interrupts or
6048 signals may get corrupted data.
6050 @item -mfused-madd
6051 @itemx -mno-fused-madd
6052 @kindex -mfused-madd
6053 Generate code that uses (does not use) the floating point multiply and
6054 accumulate instructions.  These instructions are generated by default if
6055 hardware floating is used.
6057 @item -mno-bit-align
6058 @itemx -mbit-align
6059 @kindex -mbit-align
6060 On System V.4 and embedded PowerPC systems do not (do) force structures
6061 and unions that contain bit fields to be aligned to the base type of the
6062 bit field.
6064 For example, by default a structure containing nothing but 8
6065 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6066 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
6067 the structure would be aligned to a 1 byte boundary and be one byte in
6068 size.
6070 @item -mno-strict-align
6071 @itemx -mstrict-align
6072 @kindex -mstrict-align
6073 On System V.4 and embedded PowerPC systems do not (do) assume that
6074 unaligned memory references will be handled by the system.
6076 @item -mrelocatable
6077 @itemx -mno-relocatable
6078 @kindex -mrelocatable
6079 On embedded PowerPC systems generate code that allows (does not allow)
6080 the program to be relocated to a different address at runtime.  If you
6081 use @samp{-mrelocatable} on any module, all objects linked together must
6082 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6084 @item -mrelocatable-lib
6085 @itemx -mno-relocatable-lib
6086 On embedded PowerPC systems generate code that allows (does not allow)
6087 the program to be relocated to a different address at runtime.  Modules
6088 compiled with @samp{-mrelocatable-lib} can be linked with either modules
6089 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6090 with modules compiled with the @samp{-mrelocatable} options.
6092 @item -mno-toc
6093 @itemx -mtoc
6094 On System V.4 and embedded PowerPC systems do not (do) assume that
6095 register 2 contains a pointer to a global area pointing to the addresses
6096 used in the program.
6098 @item -mlittle
6099 @itemx -mlittle-endian
6100 On System V.4 and embedded PowerPC systems compile code for the
6101 processor in little endian mode.  The @samp{-mlittle-endian} option is
6102 the same as @samp{-mlittle}.
6104 @item -mbig
6105 @itemx -mbig-endian
6106 On System V.4 and embedded PowerPC systems compile code for the
6107 processor in big endian mode.  The @samp{-mbig-endian} option is
6108 the same as @samp{-mbig}.
6110 @item -mcall-sysv
6111 On System V.4 and embedded PowerPC systems compile code using calling
6112 conventions that adheres to the March 1995 draft of the System V
6113 Application Binary Interface, PowerPC processor supplement.  This is the
6114 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6116 @item -mcall-sysv-eabi
6117 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6119 @item -mcall-sysv-noeabi
6120 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6122 @item -mcall-aix
6123 On System V.4 and embedded PowerPC systems compile code using calling
6124 conventions that are similar to those used on AIX.  This is the
6125 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6127 @item -mcall-solaris
6128 On System V.4 and embedded PowerPC systems compile code for the Solaris
6129 operating system.
6131 @item -mcall-linux
6132 On System V.4 and embedded PowerPC systems compile code for the
6133 Linux-based GNU system.
6135 @item -mprototype
6136 @itemx -mno-prototype
6137 On System V.4 and embedded PowerPC systems assume that all calls to
6138 variable argument functions are properly prototyped.  Otherwise, the
6139 compiler must insert an instruction before every non prototyped call to
6140 set or clear bit 6 of the condition code register (@var{CR}) to
6141 indicate whether floating point values were passed in the floating point
6142 registers in case the function takes a variable arguments.  With
6143 @samp{-mprototype}, only calls to prototyped variable argument functions
6144 will set or clear the bit.
6146 @item -msim
6147 On embedded PowerPC systems, assume that the startup module is called
6148 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6149 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6150 configurations.
6152 @item -mmvme
6153 On embedded PowerPC systems, assume that the startup module is called
6154 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6155 @file{libc.a}.
6157 @item -mads
6158 On embedded PowerPC systems, assume that the startup module is called
6159 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6160 @file{libc.a}.
6162 @item -myellowknife
6163 On embedded PowerPC systems, assume that the startup module is called
6164 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6165 @file{libc.a}.
6167 @item -mvxworks
6168 On System V.4 and embedded PowerPC systems, specify that you are
6169 compiling for a VxWorks system.
6171 @item -memb
6172 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6173 header to indicate that @samp{eabi} extended relocations are used.
6175 @item -meabi
6176 @itemx -mno-eabi
6177 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6178 Embedded Applications Binary Interface (eabi) which is a set of
6179 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6180 means that the stack is aligned to an 8 byte boundary, a function
6181 @code{__eabi} is called to from @code{main} to set up the eabi
6182 environment, and the @samp{-msdata} option can use both @code{r2} and
6183 @code{r13} to point to two separate small data areas.  Selecting
6184 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6185 do not call an initialization function from @code{main}, and the
6186 @samp{-msdata} option will only use @code{r13} to point to a single
6187 small data area.  The @samp{-meabi} option is on by default if you
6188 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6190 @item -msdata=eabi
6191 On System V.4 and embedded PowerPC systems, put small initialized
6192 @code{const} global and static data in the @samp{.sdata2} section, which
6193 is pointed to by register @code{r2}.  Put small initialized
6194 non-@code{const} global and static data in the @samp{.sdata} section,
6195 which is pointed to by register @code{r13}.  Put small uninitialized
6196 global and static data in the @samp{.sbss} section, which is adjacent to
6197 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
6198 incompatible with the @samp{-mrelocatable} option.  The
6199 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
6201 @item -msdata=sysv
6202 On System V.4 and embedded PowerPC systems, put small global and static
6203 data in the @samp{.sdata} section, which is pointed to by register
6204 @code{r13}.  Put small uninitialized global and static data in the
6205 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6206 The @samp{-msdata=sysv} option is incompatible with the
6207 @samp{-mrelocatable} option.
6209 @item -msdata=default
6210 @itemx -msdata
6211 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6212 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6213 same as @samp{-msdata=sysv}.
6215 @item -msdata-data
6216 On System V.4 and embedded PowerPC systems, put small global and static
6217 data in the @samp{.sdata} section.  Put small uninitialized global and
6218 static data in the @samp{.sbss} section.  Do not use register @code{r13}
6219 to address small data however.  This is the default behavior unless
6220 other @samp{-msdata} options are used.
6222 @item -msdata=none
6223 @itemx -mno-sdata
6224 On embedded PowerPC systems, put all initialized global and static data
6225 in the @samp{.data} section, and all uninitialized data in the
6226 @samp{.bss} section.
6228 @item -G @var{num}
6229 @cindex smaller data references (PowerPC)
6230 @cindex .sdata/.sdata2 references (PowerPC)
6231 On embedded PowerPC systems, put global and static items less than or
6232 equal to @var{num} bytes into the small data or bss sections instead of
6233 the normal data or bss section.  By default, @var{num} is 8.  The
6234 @samp{-G @var{num}} switch is also passed to the linker.
6235 All modules should be compiled with the same @samp{-G @var{num}} value.
6237 @item -mregnames
6238 @itemx -mno-regnames
6239 On System V.4 and embedded PowerPC systems do (do not) emit register
6240 names in the assembly language output using symbolic forms.
6242 @end table
6244 @node RT Options
6245 @subsection IBM RT Options
6246 @cindex RT options
6247 @cindex IBM RT options
6249 These @samp{-m} options are defined for the IBM RT PC:
6251 @table @gcctabopt
6252 @item -min-line-mul
6253 Use an in-line code sequence for integer multiplies.  This is the
6254 default.
6256 @item -mcall-lib-mul
6257 Call @code{lmul$$} for integer multiples.
6259 @item -mfull-fp-blocks
6260 Generate full-size floating point data blocks, including the minimum
6261 amount of scratch space recommended by IBM.  This is the default.
6263 @item -mminimum-fp-blocks
6264 Do not include extra scratch space in floating point data blocks.  This
6265 results in smaller code, but slower execution, since scratch space must
6266 be allocated dynamically.
6268 @cindex @file{varargs.h} and RT PC
6269 @cindex @file{stdarg.h} and RT PC
6270 @item -mfp-arg-in-fpregs
6271 Use a calling sequence incompatible with the IBM calling convention in
6272 which floating point arguments are passed in floating point registers.
6273 Note that @code{varargs.h} and @code{stdargs.h} will not work with
6274 floating point operands if this option is specified.
6276 @item -mfp-arg-in-gregs
6277 Use the normal calling convention for floating point arguments.  This is
6278 the default.
6280 @item -mhc-struct-return
6281 Return structures of more than one word in memory, rather than in a
6282 register.  This provides compatibility with the MetaWare HighC (hc)
6283 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
6284 with the Portable C Compiler (pcc).
6286 @item -mnohc-struct-return
6287 Return some structures of more than one word in registers, when
6288 convenient.  This is the default.  For compatibility with the
6289 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6290 option @samp{-mhc-struct-return}.
6291 @end table
6293 @node MIPS Options
6294 @subsection MIPS Options
6295 @cindex MIPS options
6297 These @samp{-m} options are defined for the MIPS family of computers:
6299 @table @gcctabopt
6300 @item -mcpu=@var{cpu type}
6301 Assume the defaults for the machine type @var{cpu type} when scheduling
6302 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
6303 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6304 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6305 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
6306 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6307 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
6308 @var{cpu type} will schedule things appropriately for that particular
6309 chip, the compiler will not generate any code that does not meet level 1
6310 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6311 or @samp{-mabi} switch being used.
6313 @item -mips1
6314 Issue instructions from level 1 of the MIPS ISA.  This is the default.
6315 @samp{r3000} is the default @var{cpu type} at this ISA level.
6317 @item -mips2
6318 Issue instructions from level 2 of the MIPS ISA (branch likely, square
6319 root instructions).  @samp{r6000} is the default @var{cpu type} at this
6320 ISA level.
6322 @item -mips3
6323 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
6324 @samp{r4000} is the default @var{cpu type} at this ISA level.
6326 @item -mips4
6327 Issue instructions from level 4 of the MIPS ISA (conditional move,
6328 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
6329 @var{cpu type} at this ISA level.
6331 @item -mfp32
6332 Assume that 32 32-bit floating point registers are available.  This is
6333 the default.
6335 @item -mfp64
6336 Assume that 32 64-bit floating point registers are available.  This is
6337 the default when the @samp{-mips3} option is used.
6339 @item -mgp32
6340 Assume that 32 32-bit general purpose registers are available.  This is
6341 the default.
6343 @item -mgp64
6344 Assume that 32 64-bit general purpose registers are available.  This is
6345 the default when the @samp{-mips3} option is used.
6347 @item -mint64
6348 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
6349 explanation of the default, and the width of pointers.
6351 @item -mlong64
6352 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
6353 explanation of the default, and the width of pointers.
6355 @item -mlong32
6356 Force long, int, and pointer types to be 32 bits wide.
6358 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
6359 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
6360 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6361 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6362 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6363 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
6364 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
6365 the smaller of the width of longs or the width of general purpose
6366 registers (which in turn depends on the ISA).
6368 @item -mabi=32
6369 @itemx -mabi=o64
6370 @itemx -mabi=n32
6371 @itemx -mabi=64
6372 @itemx -mabi=eabi
6373 Generate code for the indicated ABI.  The default instruction level is
6374 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6375 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
6376 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6377 is @samp{64}.
6379 @item -mmips-as
6380 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6381 add normal debug information.  This is the default for all
6382 platforms except for the OSF/1 reference platform, using the OSF/rose
6383 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
6384 switches are used, the @file{mips-tfile} program will encapsulate the
6385 stabs within MIPS ECOFF.
6387 @item -mgas
6388 Generate code for the GNU assembler.  This is the default on the OSF/1
6389 reference platform, using the OSF/rose object format.  Also, this is
6390 the default if the configure option @samp{--with-gnu-as} is used.
6392 @item -msplit-addresses
6393 @itemx -mno-split-addresses
6394 Generate code to load the high and low parts of address constants separately.
6395 This allows @code{gcc} to optimize away redundant loads of the high order
6396 bits of addresses.  This optimization requires GNU as and GNU ld.
6397 This optimization is enabled by default for some embedded targets where
6398 GNU as and GNU ld are standard.
6400 @item -mrnames
6401 @itemx -mno-rnames
6402 The @samp{-mrnames} switch says to output code using the MIPS software
6403 names for the registers, instead of the hardware names (ie, @var{a0}
6404 instead of @var{$4}).  The only known assembler that supports this option
6405 is the Algorithmics assembler.
6407 @item -mgpopt
6408 @itemx -mno-gpopt
6409 The @samp{-mgpopt} switch says to write all of the data declarations
6410 before the instructions in the text section, this allows the MIPS
6411 assembler to generate one word memory references instead of using two
6412 words for short global or static data items.  This is on by default if
6413 optimization is selected.
6415 @item -mstats
6416 @itemx -mno-stats
6417 For each non-inline function processed, the @samp{-mstats} switch
6418 causes the compiler to emit one line to the standard error file to
6419 print statistics about the program (number of registers saved, stack
6420 size, etc.).
6422 @item -mmemcpy
6423 @itemx -mno-memcpy
6424 The @samp{-mmemcpy} switch makes all block moves call the appropriate
6425 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6426 generating inline code.
6428 @item -mmips-tfile
6429 @itemx -mno-mips-tfile
6430 The @samp{-mno-mips-tfile} switch causes the compiler not
6431 postprocess the object file with the @file{mips-tfile} program,
6432 after the MIPS assembler has generated it to add debug support.  If
6433 @file{mips-tfile} is not run, then no local variables will be
6434 available to the debugger.  In addition, @file{stage2} and
6435 @file{stage3} objects will have the temporary file names passed to the
6436 assembler embedded in the object file, which means the objects will
6437 not compare the same.  The @samp{-mno-mips-tfile} switch should only
6438 be used when there are bugs in the @file{mips-tfile} program that
6439 prevents compilation.
6441 @item -msoft-float
6442 Generate output containing library calls for floating point.
6443 @strong{Warning:} the requisite libraries are not part of GCC.
6444 Normally the facilities of the machine's usual C compiler are used, but
6445 this can't be done directly in cross-compilation.  You must make your
6446 own arrangements to provide suitable library functions for
6447 cross-compilation.
6449 @item -mhard-float
6450 Generate output containing floating point instructions.  This is the
6451 default if you use the unmodified sources.
6453 @item -mabicalls
6454 @itemx -mno-abicalls
6455 Emit (or do not emit) the pseudo operations @samp{.abicalls},
6456 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6457 position independent code.
6459 @item -mlong-calls
6460 @itemx -mno-long-calls
6461 Do all calls with the @samp{JALR} instruction, which requires
6462 loading up a function's address into a register before the call.
6463 You need to use this switch, if you call outside of the current
6464 512 megabyte segment to functions that are not through pointers.
6466 @item -mhalf-pic
6467 @itemx -mno-half-pic
6468 Put pointers to extern references into the data section and load them
6469 up, rather than put the references in the text section.
6471 @item -membedded-pic
6472 @itemx -mno-embedded-pic
6473 Generate PIC code suitable for some embedded systems.  All calls are
6474 made using PC relative address, and all data is addressed using the $gp
6475 register.  No more than 65536 bytes of global data may be used.  This
6476 requires GNU as and GNU ld which do most of the work.  This currently
6477 only works on targets which use ECOFF; it does not work with ELF.
6479 @item -membedded-data
6480 @itemx -mno-embedded-data
6481 Allocate variables to the read-only data section first if possible, then
6482 next in the small data section if possible, otherwise in data.  This gives
6483 slightly slower code than the default, but reduces the amount of RAM required
6484 when executing, and thus may be preferred for some embedded systems.
6486 @item -muninit-const-in-rodata
6487 @itemx -mno-uninit-const-in-rodata
6488 When used together with -membedded-data, it will always store uninitialized
6489 const variables in the read-only data section.
6490   
6491 @item -msingle-float
6492 @itemx -mdouble-float
6493 The @samp{-msingle-float} switch tells gcc to assume that the floating
6494 point coprocessor only supports single precision operations, as on the
6495 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
6496 double precision operations.  This is the default.
6498 @item -mmad
6499 @itemx -mno-mad
6500 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6501 as on the @samp{r4650} chip.
6503 @item -m4650
6504 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6505 @samp{-mcpu=r4650}.
6507 @item -mips16
6508 @itemx -mno-mips16
6509 Enable 16-bit instructions.
6511 @item -mentry
6512 Use the entry and exit pseudo ops.  This option can only be used with
6513 @samp{-mips16}.
6515 @item -EL
6516 Compile code for the processor in little endian mode.
6517 The requisite libraries are assumed to exist.
6519 @item -EB
6520 Compile code for the processor in big endian mode.
6521 The requisite libraries are assumed to exist.
6523 @item -G @var{num}
6524 @cindex smaller data references (MIPS)
6525 @cindex gp-relative references (MIPS)
6526 Put global and static items less than or equal to @var{num} bytes into
6527 the small data or bss sections instead of the normal data or bss
6528 section.  This allows the assembler to emit one word memory reference
6529 instructions based on the global pointer (@var{gp} or @var{$28}),
6530 instead of the normal two words used.  By default, @var{num} is 8 when
6531 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
6532 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6533 All modules should be compiled with the same @samp{-G @var{num}}
6534 value.
6536 @item -nocpp
6537 Tell the MIPS assembler to not run its preprocessor over user
6538 assembler files (with a @samp{.s} suffix) when assembling them.
6540 @item -mfix7000
6541 Pass an option to gas which will cause nops to be inserted if
6542 the read of the destination register of an mfhi or mflo instruction
6543 occurs in the following two instructions.
6545 @item -no-crt0
6546 Do not include the default crt0.
6547 @end table
6549 @ifset INTERNALS
6550 These options are defined by the macro
6551 @code{TARGET_SWITCHES} in the machine description.  The default for the
6552 options is also defined by that macro, which enables you to change the
6553 defaults.
6554 @end ifset
6556 @node i386 Options
6557 @subsection Intel 386 Options
6558 @cindex i386 Options
6559 @cindex Intel 386 Options
6561 These @samp{-m} options are defined for the i386 family of computers:
6563 @table @gcctabopt
6564 @item -mcpu=@var{cpu type}
6565 Assume the defaults for the machine type @var{cpu type} when scheduling
6566 instructions.  The choices for @var{cpu type} are @samp{i386},
6567 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
6568 @samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
6570 While picking a specific @var{cpu type} will schedule things appropriately
6571 for that particular chip, the compiler will not generate any code that
6572 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6573 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6574 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} are the
6575 AMD chips as opposed to the Intel ones.
6577 @item -march=@var{cpu type}
6578 Generate instructions for the machine type @var{cpu type}.  The choices
6579 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
6580 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6582 @item -m386
6583 @itemx -m486
6584 @itemx -mpentium
6585 @itemx -mpentiumpro
6586 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6587 respectively.  These synonyms are deprecated.
6589 @item -mintel-syntax
6590 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6592 @item -mieee-fp
6593 @itemx -mno-ieee-fp
6594 Control whether or not the compiler uses IEEE floating point
6595 comparisons.  These handle correctly the case where the result of a
6596 comparison is unordered.
6598 @item -msoft-float
6599 Generate output containing library calls for floating point.
6600 @strong{Warning:} the requisite libraries are not part of GCC.
6601 Normally the facilities of the machine's usual C compiler are used, but
6602 this can't be done directly in cross-compilation.  You must make your
6603 own arrangements to provide suitable library functions for
6604 cross-compilation.
6606 On machines where a function returns floating point results in the 80387
6607 register stack, some floating point opcodes may be emitted even if
6608 @samp{-msoft-float} is used.
6610 @item -mno-fp-ret-in-387
6611 Do not use the FPU registers for return values of functions.
6613 The usual calling convention has functions return values of types
6614 @code{float} and @code{double} in an FPU register, even if there
6615 is no FPU.  The idea is that the operating system should emulate
6616 an FPU.
6618 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6619 in ordinary CPU registers instead.
6621 @item -mno-fancy-math-387
6622 Some 387 emulators do not support the @code{sin}, @code{cos} and
6623 @code{sqrt} instructions for the 387.  Specify this option to avoid
6624 generating those instructions. This option is the default on FreeBSD.
6625 As of revision 2.6.1, these instructions are not generated unless you
6626 also use the @samp{-funsafe-math-optimizations} switch.
6628 @item -malign-double
6629 @itemx -mno-align-double
6630 Control whether GCC aligns @code{double}, @code{long double}, and
6631 @code{long long} variables on a two word boundary or a one word
6632 boundary.  Aligning @code{double} variables on a two word boundary will
6633 produce code that runs somewhat faster on a @samp{Pentium} at the
6634 expense of more memory.
6636 @item -m128bit-long-double
6637 @itemx -m128bit-long-double
6638 Control the size of @code{long double} type. i386 application binary interface
6639 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6640 preffer @code{long double} aligned to 8 or 16 byte boundary.  This is
6641 impossible to reach with 12 byte long doubles in the array accesses.
6643 @strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6644 structures and arrays containing @code{long double} will change their size as
6645 well as function calling convention for function taking @code{long double}
6646 will be modified. 
6648 @item -m96bit-long-double
6649 @itemx -m96bit-long-double
6650 Set the size of @code{long double} to 96 bits as required by the i386
6651 application binary interface.  This is the default.
6653 @item -msvr3-shlib
6654 @itemx -mno-svr3-shlib
6655 Control whether GCC places uninitialized locals into @code{bss} or
6656 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6657 These options are meaningful only on System V Release 3.
6659 @item -mno-wide-multiply
6660 @itemx -mwide-multiply
6661 Control whether GCC uses the @code{mul} and @code{imul} that produce
6662 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6663 long} multiplies and 32-bit division by constants.
6665 @item -mrtd
6666 Use a different function-calling convention, in which functions that
6667 take a fixed number of arguments return with the @code{ret} @var{num}
6668 instruction, which pops their arguments while returning.  This saves one
6669 instruction in the caller since there is no need to pop the arguments
6670 there.
6672 You can specify that an individual function is called with this calling
6673 sequence with the function attribute @samp{stdcall}.  You can also
6674 override the @samp{-mrtd} option by using the function attribute
6675 @samp{cdecl}.  @xref{Function Attributes}.
6677 @strong{Warning:} this calling convention is incompatible with the one
6678 normally used on Unix, so you cannot use it if you need to call
6679 libraries compiled with the Unix compiler.
6681 Also, you must provide function prototypes for all functions that
6682 take variable numbers of arguments (including @code{printf});
6683 otherwise incorrect code will be generated for calls to those
6684 functions.
6686 In addition, seriously incorrect code will result if you call a
6687 function with too many arguments.  (Normally, extra arguments are
6688 harmlessly ignored.)
6690 @item -mregparm=@var{num}
6691 Control how many registers are used to pass integer arguments.  By
6692 default, no registers are used to pass arguments, and at most 3
6693 registers can be used.  You can control this behavior for a specific
6694 function by using the function attribute @samp{regparm}.
6695 @xref{Function Attributes}.
6697 @strong{Warning:} if you use this switch, and
6698 @var{num} is nonzero, then you must build all modules with the same
6699 value, including any libraries.  This includes the system libraries and
6700 startup modules.
6702 @item -malign-loops=@var{num}
6703 Align loops to a 2 raised to a @var{num} byte boundary.  If
6704 @samp{-malign-loops} is not specified, the default is 2 unless
6705 gas 2.8 (or later) is being used in which case the default is
6706 to align the loop on a 16 byte boundary if it is less than 8
6707 bytes away.
6709 @item -malign-jumps=@var{num}
6710 Align instructions that are only jumped to to a 2 raised to a @var{num}
6711 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6712 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6713 gas 2.8 (or later) is being used in which case the default is
6714 to align the instruction on a 16 byte boundary if it is less
6715 than 8 bytes away.
6717 @item -malign-functions=@var{num}
6718 Align the start of functions to a 2 raised to @var{num} byte boundary.
6719 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6720 for a 386, and 4 if optimizing for a 486.
6722 @item -mpreferred-stack-boundary=@var{num}
6723 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6724 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6725 the default is 4 (16 bytes or 128 bits).
6727 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6728 and PentiumPro, @code{double} and @code{long double} values should be
6729 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6730 significant run time performance penalties.  On Pentium III, the
6731 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6732 penalties if it is not 16 byte aligned.
6734 To ensure proper alignment of this values on the stack, the stack boundary
6735 must be as aligned as that required by any value stored on the stack. 
6736 Further, every function must be generated such that it keeps the stack
6737 aligned.  Thus calling a function compiled with a higher preferred
6738 stack boundary from a function compiled with a lower preferred stack
6739 boundary will most likely misalign the stack.  It is recommended that
6740 libraries that use callbacks always use the default setting.
6742 This extra alignment does consume extra stack space.  Code that is sensitive
6743 to stack space usage, such as embedded systems and operating system kernels,
6744 may want to reduce the preferred alignment to
6745 @samp{-mpreferred-stack-boundary=2}.
6747 @item -mpush-args
6748 @kindex -mpush-args
6749 Use PUSH operations to store outgoing parameters. This method is shorter
6750 and usually equally fast as method using SUB/MOV operations and is enabled
6751 by default. In some cases disabling it may improve performance because of
6752 improved scheduling and reduced dependencies.
6754 @item -maccumulate-outgoing-args
6755 @kindex -maccumulate-outgoing-args
6756 If enabled, the maximum amount of space required for outgoing arguments will be
6757 computed in the function prologue. This in faster on most modern CPUs
6758 because of reduced dependencies, improved scheduling and reduced stack usage
6759 when preferred stack boundary is not equal to 2.  The drawback is a notable
6760 increase in code size. This switch implies -mno-push-args.
6762 @item -mthreads
6763 @kindex -mthreads
6764 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6765 on thread-safe exception handling must compile and link all code with the 
6766 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6767 @samp{-D_MT}; when linking, it links in a special thread helper library 
6768 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6770 @item -mno-align-stringops
6771 @kindex -mno-align-stringops
6772 Do not align destination of inlined string operations. This switch reduces
6773 code size and improves performance in case the destination is already aligned,
6774 but gcc don't know about it.
6776 @item -minline-all-stringops
6777 @kindex -minline-all-stringops
6778 By default GCC inlines string operations only when destination is known to be
6779 aligned at least to 4 byte boundary. This enables more inlining, increase code
6780 size, but may improve performance of code that depends on fast memcpy, strlen
6781 and memset for short lengths.
6782 @end table
6784 @node HPPA Options
6785 @subsection HPPA Options
6786 @cindex HPPA Options
6788 These @samp{-m} options are defined for the HPPA family of computers:
6790 @table @gcctabopt
6791 @item -march=@var{architecture type}
6792 Generate code for the specified architecture.  The choices for
6793 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6794 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6795 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6796 architecture option for your machine.  Code compiled for lower numbered
6797 architectures will run on higher numbered architectures, but not the
6798 other way around.
6800 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6801 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6802 support.  
6804 @item -mpa-risc-1-0
6805 @itemx -mpa-risc-1-1
6806 @itemx -mpa-risc-2-0
6807 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6809 @item -mbig-switch
6810 Generate code suitable for big switch tables.  Use this option only if
6811 the assembler/linker complain about out of range branches within a switch
6812 table.
6814 @item -mjump-in-delay
6815 Fill delay slots of function calls with unconditional jump instructions
6816 by modifying the return pointer for the function call to be the target
6817 of the conditional jump.
6819 @item -mdisable-fpregs
6820 Prevent floating point registers from being used in any manner.  This is
6821 necessary for compiling kernels which perform lazy context switching of
6822 floating point registers.  If you use this option and attempt to perform
6823 floating point operations, the compiler will abort.
6825 @item -mdisable-indexing
6826 Prevent the compiler from using indexing address modes.  This avoids some
6827 rather obscure problems when compiling MIG generated code under MACH.
6829 @item -mno-space-regs
6830 Generate code that assumes the target has no space registers.  This allows
6831 GCC to generate faster indirect calls and use unscaled index address modes.
6833 Such code is suitable for level 0 PA systems and kernels.
6835 @item -mfast-indirect-calls
6836 Generate code that assumes calls never cross space boundaries.  This
6837 allows GCC to emit code which performs faster indirect calls.
6839 This option will not work in the presence of shared libraries or nested
6840 functions.
6842 @item -mlong-load-store
6843 Generate 3-instruction load and store sequences as sometimes required by
6844 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6845 the HP compilers.
6847 @item -mportable-runtime
6848 Use the portable calling conventions proposed by HP for ELF systems.
6850 @item -mgas
6851 Enable the use of assembler directives only GAS understands.
6853 @item -mschedule=@var{cpu type}
6854 Schedule code according to the constraints for the machine type
6855 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6856 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6857 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6858 proper scheduling option for your machine.
6860 @item -mlinker-opt
6861 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6862 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6863 in which they give bogus error messages when linking some programs.
6865 @item -msoft-float
6866 Generate output containing library calls for floating point.
6867 @strong{Warning:} the requisite libraries are not available for all HPPA
6868 targets.  Normally the facilities of the machine's usual C compiler are
6869 used, but this cannot be done directly in cross-compilation.  You must make
6870 your own arrangements to provide suitable library functions for
6871 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6872 does provide software floating point support.
6874 @samp{-msoft-float} changes the calling convention in the output file;
6875 therefore, it is only useful if you compile @emph{all} of a program with
6876 this option.  In particular, you need to compile @file{libgcc.a}, the
6877 library that comes with GCC, with @samp{-msoft-float} in order for
6878 this to work.
6879 @end table
6881 @node Intel 960 Options
6882 @subsection Intel 960 Options
6884 These @samp{-m} options are defined for the Intel 960 implementations:
6886 @table @gcctabopt
6887 @item -m@var{cpu type}
6888 Assume the defaults for the machine type @var{cpu type} for some of
6889 the other options, including instruction scheduling, floating point
6890 support, and addressing modes.  The choices for @var{cpu type} are
6891 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6892 @samp{sa}, and @samp{sb}.
6893 The default is
6894 @samp{kb}.
6896 @item -mnumerics
6897 @itemx -msoft-float
6898 The @samp{-mnumerics} option indicates that the processor does support
6899 floating-point instructions.  The @samp{-msoft-float} option indicates
6900 that floating-point support should not be assumed.
6902 @item -mleaf-procedures
6903 @itemx -mno-leaf-procedures
6904 Do (or do not) attempt to alter leaf procedures to be callable with the
6905 @code{bal} instruction as well as @code{call}.  This will result in more
6906 efficient code for explicit calls when the @code{bal} instruction can be
6907 substituted by the assembler or linker, but less efficient code in other
6908 cases, such as calls via function pointers, or using a linker that doesn't
6909 support this optimization.
6911 @item -mtail-call
6912 @itemx -mno-tail-call
6913 Do (or do not) make additional attempts (beyond those of the
6914 machine-independent portions of the compiler) to optimize tail-recursive
6915 calls into branches.  You may not want to do this because the detection of
6916 cases where this is not valid is not totally complete.  The default is
6917 @samp{-mno-tail-call}.
6919 @item -mcomplex-addr
6920 @itemx -mno-complex-addr
6921 Assume (or do not assume) that the use of a complex addressing mode is a
6922 win on this implementation of the i960.  Complex addressing modes may not
6923 be worthwhile on the K-series, but they definitely are on the C-series.
6924 The default is currently @samp{-mcomplex-addr} for all processors except
6925 the CB and CC.
6927 @item -mcode-align
6928 @itemx -mno-code-align
6929 Align code to 8-byte boundaries for faster fetching (or don't bother).
6930 Currently turned on by default for C-series implementations only.
6932 @ignore
6933 @item -mclean-linkage
6934 @itemx -mno-clean-linkage
6935 These options are not fully implemented.
6936 @end ignore
6938 @item -mic-compat
6939 @itemx -mic2.0-compat
6940 @itemx -mic3.0-compat
6941 Enable compatibility with iC960 v2.0 or v3.0.
6943 @item -masm-compat
6944 @itemx -mintel-asm
6945 Enable compatibility with the iC960 assembler.
6947 @item -mstrict-align
6948 @itemx -mno-strict-align
6949 Do not permit (do permit) unaligned accesses.
6951 @item -mold-align
6952 Enable structure-alignment compatibility with Intel's gcc release version
6953 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6955 @item -mlong-double-64
6956 Implement type @samp{long double} as 64-bit floating point numbers.
6957 Without the option @samp{long double} is implemented by 80-bit
6958 floating point numbers.  The only reason we have it because there is
6959 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6960 is only useful for people using soft-float targets.  Otherwise, we
6961 should recommend against use of it.
6963 @end table
6965 @node DEC Alpha Options
6966 @subsection DEC Alpha Options
6968 These @samp{-m} options are defined for the DEC Alpha implementations:
6970 @table @gcctabopt
6971 @item -mno-soft-float
6972 @itemx -msoft-float
6973 Use (do not use) the hardware floating-point instructions for
6974 floating-point operations.  When @option{-msoft-float} is specified,
6975 functions in @file{libgcc1.c} will be used to perform floating-point
6976 operations.  Unless they are replaced by routines that emulate the
6977 floating-point operations, or compiled in such a way as to call such
6978 emulations routines, these routines will issue floating-point
6979 operations.   If you are compiling for an Alpha without floating-point
6980 operations, you must ensure that the library is built so as not to call
6981 them.
6983 Note that Alpha implementations without floating-point operations are
6984 required to have floating-point registers.
6986 @item -mfp-reg
6987 @itemx -mno-fp-regs
6988 Generate code that uses (does not use) the floating-point register set.
6989 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
6990 register set is not used, floating point operands are passed in integer
6991 registers as if they were integers and floating-point results are passed
6992 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6993 function with a floating-point argument or return value called by code
6994 compiled with @option{-mno-fp-regs} must also be compiled with that
6995 option.
6997 A typical use of this option is building a kernel that does not use,
6998 and hence need not save and restore, any floating-point registers.
7000 @item -mieee
7001 The Alpha architecture implements floating-point hardware optimized for
7002 maximum performance.  It is mostly compliant with the IEEE floating
7003 point standard.  However, for full compliance, software assistance is
7004 required.  This option generates code fully IEEE compliant code
7005 @emph{except} that the @var{inexact flag} is not maintained (see below).
7006 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
7007 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
7008 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
7009 code is less efficient but is able to correctly support denormalized
7010 numbers and exceptional IEEE values such as not-a-number and plus/minus
7011 infinity.  Other Alpha compilers call this option
7012 @option{-ieee_with_no_inexact}.
7014 @item -mieee-with-inexact
7015 @c overfull hbox here --bob 22 jul96
7016 @c original text between ignore ... end ignore
7017 @ignore
7018 This is like @samp{-mieee} except the generated code also maintains the
7019 IEEE @var{inexact flag}.  Turning on this option causes the generated
7020 code to implement fully-compliant IEEE math.  The option is a shorthand
7021 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
7022 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
7023 implementations the resulting code may execute significantly slower than
7024 the code generated by default.  Since there is very little code that
7025 depends on the @var{inexact flag}, you should normally not specify this
7026 option.  Other Alpha compilers call this option
7027 @samp{-ieee_with_inexact}.
7028 @end ignore
7029 @c            changed paragraph
7030 This is like @samp{-mieee} except the generated code also maintains the
7031 IEEE @var{inexact flag}.  Turning on this option causes the generated
7032 code to implement fully-compliant IEEE math.  The option is a shorthand
7033 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
7034 @samp{-mieee-conformant},
7035 @samp{-mfp-trap-mode=sui}, 
7036 and @samp{-mtrap-precision=i}.  
7037 On some Alpha implementations the resulting code may execute
7038 significantly slower than the code generated by default.  Since there
7039 is very little code that depends on the @var{inexact flag}, you should
7040 normally not specify this option.  Other Alpha compilers call this
7041 option @samp{-ieee_with_inexact}.
7042 @c             end changes to prevent overfull hboxes
7044 @item -mfp-trap-mode=@var{trap mode}
7045 This option controls what floating-point related traps are enabled.
7046 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7047 The trap mode can be set to one of four values:
7049 @table @samp
7050 @item n
7051 This is the default (normal) setting.  The only traps that are enabled
7052 are the ones that cannot be disabled in software (e.g., division by zero
7053 trap).
7055 @item u
7056 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7057 as well.
7059 @item su
7060 Like @samp{su}, but the instructions are marked to be safe for software
7061 completion (see Alpha architecture manual for details).
7063 @item sui
7064 Like @samp{su}, but inexact traps are enabled as well.
7065 @end table
7067 @item -mfp-rounding-mode=@var{rounding mode}
7068 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7069 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
7072 @table @samp
7073 @item n
7074 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7075 the nearest machine number or towards the even machine number in case
7076 of a tie.
7078 @item m
7079 Round towards minus infinity.
7081 @item c
7082 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7084 @item d
7085 Dynamic rounding mode.  A field in the floating point control register
7086 (@var{fpcr}, see Alpha architecture reference manual) controls the
7087 rounding mode in effect.  The C library initializes this register for
7088 rounding towards plus infinity.  Thus, unless your program modifies the
7089 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7090 @end table
7092 @item -mtrap-precision=@var{trap precision}
7093 In the Alpha architecture, floating point traps are imprecise.  This
7094 means without software assistance it is impossible to recover from a
7095 floating trap and program execution normally needs to be terminated.
7096 GCC can generate code that can assist operating system trap handlers
7097 in determining the exact location that caused a floating point trap.
7098 Depending on the requirements of an application, different levels of
7099 precisions can be selected:
7101 @table @samp
7102 @item p
7103 Program precision.  This option is the default and means a trap handler
7104 can only identify which program caused a floating point exception.
7106 @item f
7107 Function precision.  The trap handler can determine the function that
7108 caused a floating point exception.
7110 @item i
7111 Instruction precision.  The trap handler can determine the exact
7112 instruction that caused a floating point exception.
7113 @end table
7115 Other Alpha compilers provide the equivalent options called
7116 @samp{-scope_safe} and @samp{-resumption_safe}.
7118 @item -mieee-conformant
7119 This option marks the generated code as IEEE conformant.  You must not
7120 use this option unless you also specify @samp{-mtrap-precision=i} and either
7121 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
7122 is to emit the line @samp{.eflag 48} in the function prologue of the
7123 generated assembly file.  Under DEC Unix, this has the effect that
7124 IEEE-conformant math library routines will be linked in.
7126 @item -mbuild-constants
7127 Normally GCC examines a 32- or 64-bit integer constant to
7128 see if it can construct it from smaller constants in two or three
7129 instructions.  If it cannot, it will output the constant as a literal and
7130 generate code to load it from the data segment at runtime.
7132 Use this option to require GCC to construct @emph{all} integer constants
7133 using code, even if it takes more instructions (the maximum is six).
7135 You would typically use this option to build a shared library dynamic
7136 loader.  Itself a shared library, it must relocate itself in memory
7137 before it can find the variables and constants in its own data segment.
7139 @item -malpha-as
7140 @itemx -mgas
7141 Select whether to generate code to be assembled by the vendor-supplied
7142 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7144 @item -mbwx
7145 @itemx -mno-bwx
7146 @itemx -mcix
7147 @itemx -mno-cix
7148 @itemx -mmax
7149 @itemx -mno-max
7150 Indicate whether GCC should generate code to use the optional BWX,
7151 CIX, and MAX instruction sets.  The default is to use the instruction sets
7152 supported by the CPU type specified via @samp{-mcpu=} option or that
7153 of the CPU on which GCC was built if none was specified.
7155 @item -mcpu=@var{cpu_type}
7156 Set the instruction set, register set, and instruction scheduling
7157 parameters for machine type @var{cpu_type}.  You can specify either the
7158 @samp{EV} style name or the corresponding chip number.  GCC
7159 supports scheduling parameters for the EV4 and EV5 family of processors
7160 and will choose the default values for the instruction set from
7161 the processor you specify.  If you do not specify a processor type,
7162 GCC will default to the processor on which the compiler was built.
7164 Supported values for @var{cpu_type} are
7166 @table @samp
7167 @item ev4
7168 @itemx 21064
7169 Schedules as an EV4 and has no instruction set extensions.
7171 @item ev5
7172 @itemx 21164
7173 Schedules as an EV5 and has no instruction set extensions.
7175 @item ev56
7176 @itemx 21164a
7177 Schedules as an EV5 and supports the BWX extension.
7179 @item pca56
7180 @itemx 21164pc
7181 @itemx 21164PC
7182 Schedules as an EV5 and supports the BWX and MAX extensions.
7184 @item ev6
7185 @itemx 21264
7186 Schedules as an EV5 (until Digital releases the scheduling parameters
7187 for the EV6) and supports the BWX, CIX, and MAX extensions.
7188 @end table
7190 @item -mmemory-latency=@var{time}
7191 Sets the latency the scheduler should assume for typical memory
7192 references as seen by the application.  This number is highly
7193 dependent on the memory access patterns used by the application
7194 and the size of the external cache on the machine.
7196 Valid options for @var{time} are
7198 @table @samp
7199 @item @var{number}
7200 A decimal number representing clock cycles.
7202 @item L1
7203 @itemx L2
7204 @itemx L3
7205 @itemx main
7206 The compiler contains estimates of the number of clock cycles for
7207 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7208 (also called Dcache, Scache, and Bcache), as well as to main memory.
7209 Note that L3 is only valid for EV5.
7211 @end table
7212 @end table
7214 @node Clipper Options
7215 @subsection Clipper Options
7217 These @samp{-m} options are defined for the Clipper implementations:
7219 @table @gcctabopt
7220 @item -mc300
7221 Produce code for a C300 Clipper processor. This is the default.
7223 @item -mc400
7224 Produce code for a C400 Clipper processor i.e. use floating point
7225 registers f8..f15.
7226 @end table
7228 @node H8/300 Options
7229 @subsection H8/300 Options
7231 These @samp{-m} options are defined for the H8/300 implementations:
7233 @table @gcctabopt
7234 @item -mrelax
7235 Shorten some address references at link time, when possible; uses the
7236 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7237 ld.info, Using ld}, for a fuller description.
7239 @item -mh
7240 Generate code for the H8/300H.
7242 @item -ms
7243 Generate code for the H8/S.
7245 @item -ms2600
7246 Generate code for the H8/S2600.  This switch must be used with -ms.
7248 @item -mint32
7249 Make @code{int} data 32 bits by default.
7251 @item -malign-300
7252 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7253 The default for the H8/300H and H8/S is to align longs and floats on 4
7254 byte boundaries.
7255 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
7256 This option has no effect on the H8/300.
7257 @end table
7259 @node SH Options
7260 @subsection SH Options
7262 These @samp{-m} options are defined for the SH implementations:
7264 @table @gcctabopt
7265 @item -m1
7266 Generate code for the SH1.
7268 @item -m2
7269 Generate code for the SH2.
7271 @item -m3
7272 Generate code for the SH3.
7274 @item -m3e
7275 Generate code for the SH3e.
7277 @item -m4-nofpu
7278 Generate code for the SH4 without a floating-point unit.
7280 @item -m4-single-only
7281 Generate code for the SH4 with a floating-point unit that only
7282 supports single-precision arithmentic.
7284 @item -m4-single
7285 Generate code for the SH4 assuming the floating-point unit is in
7286 single-precision mode by default.
7288 @item -m4
7289 Generate code for the SH4.
7291 @item -mb
7292 Compile code for the processor in big endian mode.
7294 @item -ml
7295 Compile code for the processor in little endian mode.
7297 @item -mdalign
7298 Align doubles at 64 bit boundaries.  Note that this changes the calling
7299 conventions, and thus some functions from the standard C library will
7300 not work unless you recompile it first with -mdalign.
7302 @item -mrelax
7303 Shorten some address references at link time, when possible; uses the
7304 linker option @samp{-relax}.
7306 @item -mbigtable
7307 Use 32-bit offsets in @code{switch} tables.  The default is to use
7308 16-bit offsets.
7310 @item -mfmovd
7311 Enable the use of the instruction @code{fmovd}.
7313 @item -mhitachi
7314 Comply with the calling conventions defined by Hitachi.
7316 @item -mnomacsave
7317 Mark the @code{MAC} register as call-clobbered, even if
7318 @option{-mhitachi} is given.
7320 @item -misize
7321 Dump instruction size and location in the assembly code.
7323 @item -mpadstruct
7324 This option is deprecated.  It pads structures to multiple of 4 bytes,
7325 which is incompatible with the SH ABI.
7327 @item -mspace
7328 Optimize for space instead of speed.  Implied by @option{-Os}.
7330 @item -mprefergot
7331 When generating position-independent code, emit function calls using
7332 the Global Offset Table instead of the Procedure Linkage Table.
7334 @item -musermode
7335 Generate a library function call to invalidate instruction cache
7336 entries, after fixing up a trampoline.  This library function call
7337 doesn't assume it can write to the whole memory address space.  This
7338 is the default when the target is @code{sh-*-linux*}.
7339 @end table
7341 @node System V Options
7342 @subsection Options for System V
7344 These additional options are available on System V Release 4 for
7345 compatibility with other compilers on those systems:
7347 @table @gcctabopt
7348 @item -G
7349 Create a shared object.
7350 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7352 @item -Qy
7353 Identify the versions of each tool used by the compiler, in a
7354 @code{.ident} assembler directive in the output.
7356 @item -Qn
7357 Refrain from adding @code{.ident} directives to the output file (this is
7358 the default).
7360 @item -YP\,@var{dirs}
7361 Search the directories @var{dirs}, and no others, for libraries
7362 specified with @samp{-l}.
7364 @item -Ym\,@var{dir}
7365 Look in the directory @var{dir} to find the M4 preprocessor.
7366 The assembler uses this option.
7367 @c This is supposed to go with a -Yd for predefined M4 macro files, but
7368 @c the generic assembler that comes with Solaris takes just -Ym.
7369 @end table
7371 @node TMS320C3x/C4x Options
7372 @subsection TMS320C3x/C4x Options
7373 @cindex TMS320C3x/C4x Options
7375 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7377 @table @gcctabopt
7379 @item -mcpu=@var{cpu_type}
7380 Set the instruction set, register set, and instruction scheduling
7381 parameters for machine type @var{cpu_type}.  Supported values for
7382 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7383 @samp{c44}.  The default is @samp{c40} to generate code for the
7384 TMS320C40.
7386 @item -mbig-memory
7387 @item -mbig
7388 @itemx -msmall-memory
7389 @itemx -msmall
7390 Generates code for the big or small memory model.  The small memory
7391 model assumed that all data fits into one 64K word page.  At run-time
7392 the data page (DP) register must be set to point to the 64K page
7393 containing the .bss and .data program sections.  The big memory model is
7394 the default and requires reloading of the DP register for every direct
7395 memory access.
7397 @item -mbk
7398 @itemx -mno-bk
7399 Allow (disallow) allocation of general integer operands into the block
7400 count register BK. 
7402 @item -mdb
7403 @itemx -mno-db
7404 Enable (disable) generation of code using decrement and branch,
7405 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
7406 on the safe side, this is disabled for the C3x, since the maximum
7407 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
7408 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
7409 that it can utilise the decrement and branch instruction, but will give
7410 up if there is more than one memory reference in the loop.  Thus a loop
7411 where the loop counter is decremented can generate slightly more
7412 efficient code, in cases where the RPTB instruction cannot be utilised.
7414 @item -mdp-isr-reload
7415 @itemx -mparanoid
7416 Force the DP register to be saved on entry to an interrupt service
7417 routine (ISR), reloaded to point to the data section, and restored on
7418 exit from the ISR.  This should not be required unless someone has
7419 violated the small memory model by modifying the DP register, say within
7420 an object library.
7422 @item -mmpyi
7423 @itemx -mno-mpyi
7424 For the C3x use the 24-bit MPYI instruction for integer multiplies
7425 instead of a library call to guarantee 32-bit results.  Note that if one
7426 of the operands is a constant, then the multiplication will be performed
7427 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
7428 then squaring operations are performed inline instead of a library call.
7430 @item -mfast-fix
7431 @itemx -mno-fast-fix
7432 The C3x/C4x FIX instruction to convert a floating point value to an
7433 integer value chooses the nearest integer less than or equal to the
7434 floating point value rather than to the nearest integer.  Thus if the
7435 floating point number is negative, the result will be incorrectly
7436 truncated an additional code is necessary to detect and correct this
7437 case.  This option can be used to disable generation of the additional
7438 code required to correct the result.
7440 @item -mrptb
7441 @itemx -mno-rptb
7442 Enable (disable) generation of repeat block sequences using the RPTB
7443 instruction for zero overhead looping.  The RPTB construct is only used
7444 for innermost loops that do not call functions or jump across the loop
7445 boundaries.  There is no advantage having nested RPTB loops due to the
7446 overhead required to save and restore the RC, RS, and RE registers.
7447 This is enabled by default with -O2.
7449 @item -mrpts=@var{count}
7450 @itemx -mno-rpts
7451 Enable (disable) the use of the single instruction repeat instruction
7452 RPTS.  If a repeat block contains a single instruction, and the loop
7453 count can be guaranteed to be less than the value @var{count}, GCC will
7454 emit a RPTS instruction instead of a RPTB.  If no value is specified,
7455 then a RPTS will be emitted even if the loop count cannot be determined
7456 at compile time.  Note that the repeated instruction following RPTS does
7457 not have to be reloaded from memory each iteration, thus freeing up the
7458 CPU buses for operands.  However, since interrupts are blocked by this
7459 instruction, it is disabled by default.
7461 @item -mloop-unsigned
7462 @itemx -mno-loop-unsigned
7463 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7464 is 2^31 + 1 since these instructions test if the iteration count is
7465 negative to terminate the loop.  If the iteration count is unsigned
7466 there is a possibility than the 2^31 + 1 maximum iteration count may be
7467 exceeded.  This switch allows an unsigned iteration count.
7469 @item -mti
7470 Try to emit an assembler syntax that the TI assembler (asm30) is happy
7471 with.  This also enforces compatibility with the API employed by the TI
7472 C3x C compiler.  For example, long doubles are passed as structures
7473 rather than in floating point registers.
7475 @item -mregparm
7476 @itemx -mmemparm
7477 Generate code that uses registers (stack) for passing arguments to functions.
7478 By default, arguments are passed in registers where possible rather
7479 than by pushing arguments on to the stack.
7481 @item -mparallel-insns
7482 @itemx -mno-parallel-insns
7483 Allow the generation of parallel instructions.  This is enabled by
7484 default with -O2.
7486 @item -mparallel-mpy
7487 @itemx -mno-parallel-mpy
7488 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7489 provided -mparallel-insns is also specified.  These instructions have
7490 tight register constraints which can pessimize the code generation
7491 of large functions.
7493 @end table
7495 @node V850 Options
7496 @subsection V850 Options
7497 @cindex V850 Options
7499 These @samp{-m} options are defined for V850 implementations:
7501 @table @gcctabopt
7502 @item -mlong-calls
7503 @itemx -mno-long-calls
7504 Treat all calls as being far away (near).  If calls are assumed to be
7505 far away, the compiler will always load the functions address up into a
7506 register, and call indirect through the pointer.
7508 @item -mno-ep
7509 @itemx -mep
7510 Do not optimize (do optimize) basic blocks that use the same index
7511 pointer 4 or more times to copy pointer into the @code{ep} register, and
7512 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
7513 option is on by default if you optimize.
7515 @item -mno-prolog-function
7516 @itemx -mprolog-function
7517 Do not use (do use) external functions to save and restore registers at
7518 the prolog and epilog of a function.  The external functions are slower,
7519 but use less code space if more than one function saves the same number
7520 of registers.  The @samp{-mprolog-function} option is on by default if
7521 you optimize.
7523 @item -mspace
7524 Try to make the code as small as possible.  At present, this just turns
7525 on the @samp{-mep} and @samp{-mprolog-function} options.
7527 @item -mtda=@var{n}
7528 Put static or global variables whose size is @var{n} bytes or less into
7529 the tiny data area that register @code{ep} points to.  The tiny data
7530 area can hold up to 256 bytes in total (128 bytes for byte references).
7532 @item -msda=@var{n}
7533 Put static or global variables whose size is @var{n} bytes or less into
7534 the small data area that register @code{gp} points to.  The small data
7535 area can hold up to 64 kilobytes.
7537 @item -mzda=@var{n}
7538 Put static or global variables whose size is @var{n} bytes or less into
7539 the first 32 kilobytes of memory.
7541 @item -mv850
7542 Specify that the target processor is the V850.
7544 @item -mbig-switch
7545 Generate code suitable for big switch tables.  Use this option only if
7546 the assembler/linker complain about out of range branches within a switch
7547 table.
7548 @end table
7550 @node ARC Options
7551 @subsection ARC Options
7552 @cindex ARC Options
7554 These options are defined for ARC implementations:
7556 @table @gcctabopt
7557 @item -EL
7558 Compile code for little endian mode.  This is the default.
7560 @item -EB
7561 Compile code for big endian mode.
7563 @item -mmangle-cpu
7564 Prepend the name of the cpu to all public symbol names.
7565 In multiple-processor systems, there are many ARC variants with different
7566 instruction and register set characteristics.  This flag prevents code
7567 compiled for one cpu to be linked with code compiled for another.
7568 No facility exists for handling variants that are "almost identical".
7569 This is an all or nothing option.
7571 @item -mcpu=@var{cpu}
7572 Compile code for ARC variant @var{cpu}.
7573 Which variants are supported depend on the configuration.
7574 All variants support @samp{-mcpu=base}, this is the default.
7576 @item -mtext=@var{text section}
7577 @itemx -mdata=@var{data section}
7578 @itemx -mrodata=@var{readonly data section}
7579 Put functions, data, and readonly data in @var{text section},
7580 @var{data section}, and @var{readonly data section} respectively
7581 by default.  This can be overridden with the @code{section} attribute.
7582 @xref{Variable Attributes}.
7584 @end table
7586 @node NS32K Options
7587 @subsection NS32K Options
7588 @cindex NS32K options
7590 These are the @samp{-m} options defined for the 32000 series.  The default
7591 values for these options depends on which style of 32000 was selected when
7592 the compiler was configured; the defaults for the most common choices are
7593 given below.
7595 @table @gcctabopt
7596 @item -m32032
7597 @itemx -m32032
7598 Generate output for a 32032.  This is the default
7599 when the compiler is configured for 32032 and 32016 based systems.
7601 @item -m32332
7602 @itemx -m32332
7603 Generate output for a 32332.  This is the default
7604 when the compiler is configured for 32332-based systems.
7606 @item -m32532
7607 @itemx -m32532
7608 Generate output for a 32532.  This is the default
7609 when the compiler is configured for 32532-based systems.
7611 @item -m32081
7612 Generate output containing 32081 instructions for floating point.
7613 This is the default for all systems.
7615 @item -m32381
7616 Generate output containing 32381 instructions for floating point.  This
7617 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7618 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7620 @item -mmulti-add
7621 Try and generate multiply-add floating point instructions @code{polyF}
7622 and @code{dotF}. This option is only available if the @samp{-m32381}
7623 option is in effect. Using these instructions requires changes to to
7624 register allocation which generally has a negative impact on
7625 performance.  This option should only be enabled when compiling code
7626 particularly likely to make heavy use of multiply-add instructions.
7628 @item -mnomulti-add
7629 Do not try and generate multiply-add floating point instructions
7630 @code{polyF} and @code{dotF}. This is the default on all platforms.
7632 @item -msoft-float
7633 Generate output containing library calls for floating point.
7634 @strong{Warning:} the requisite libraries may not be available.
7636 @item -mnobitfield
7637 Do not use the bit-field instructions. On some machines it is faster to
7638 use shifting and masking operations. This is the default for the pc532.
7640 @item -mbitfield
7641 Do use the bit-field instructions. This is the default for all platforms
7642 except the pc532.
7644 @item -mrtd
7645 Use a different function-calling convention, in which functions
7646 that take a fixed number of arguments return pop their
7647 arguments on return with the @code{ret} instruction.
7649 This calling convention is incompatible with the one normally
7650 used on Unix, so you cannot use it if you need to call libraries
7651 compiled with the Unix compiler.
7653 Also, you must provide function prototypes for all functions that
7654 take variable numbers of arguments (including @code{printf});
7655 otherwise incorrect code will be generated for calls to those
7656 functions.
7658 In addition, seriously incorrect code will result if you call a
7659 function with too many arguments.  (Normally, extra arguments are
7660 harmlessly ignored.)
7662 This option takes its name from the 680x0 @code{rtd} instruction.
7665 @item -mregparam
7666 Use a different function-calling convention where the first two arguments
7667 are passed in registers.
7669 This calling convention is incompatible with the one normally
7670 used on Unix, so you cannot use it if you need to call libraries
7671 compiled with the Unix compiler.
7673 @item -mnoregparam
7674 Do not pass any arguments in registers. This is the default for all
7675 targets.
7677 @item -msb
7678 It is OK to use the sb as an index register which is always loaded with
7679 zero. This is the default for the pc532-netbsd target.
7681 @item -mnosb
7682 The sb register is not available for use or has not been initialized to
7683 zero by the run time system. This is the default for all targets except
7684 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7685 @samp{-fpic} is set.
7687 @item -mhimem
7688 Many ns32000 series addressing modes use displacements of up to 512MB.
7689 If an address is above 512MB then displacements from zero can not be used.
7690 This option causes code to be generated which can be loaded above 512MB.
7691 This may be useful for operating systems or ROM code.
7693 @item -mnohimem
7694 Assume code will be loaded in the first 512MB of virtual address space.
7695 This is the default for all platforms.
7698 @end table
7700 @node AVR Options
7701 @subsection AVR Options
7702 @cindex AVR Options
7704 These options are defined for AVR implementations:
7706 @table @gcctabopt
7707 @item -mmcu=@var{mcu}
7708 Specify ATMEL AVR instruction set or MCU type.
7710 Instruction set avr1 is for the minimal AVR core, not supported by the C
7711 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7712 attiny11, attiny12, attiny15, attiny28).
7714 Instruction set avr2 (default) is for the classic AVR core with up to
7715 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7716 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7717 at90c8534, at90s8535).
7719 Instruction set avr3 is for the classic AVR core with up to 128K program
7720 memory space (MCU types: atmega103, atmega603).
7722 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7723 memory space (MCU types: atmega83, atmega85).
7725 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7726 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
7728 @item -msize
7729 Output instruction sizes to the asm file.
7731 @item -minit-stack=@var{N}
7732 Specify the initial stack address, which may be a symbol or numeric value,
7733 __stack is the default.
7735 @item -mno-interrupts
7736 Generated code is not compatible with hardware interrupts.
7737 Code size will be smaller.
7739 @item -mcall-prologues
7740 Functions prologues/epilogues expanded as call to appropriate
7741 subroutines. Code size will be smaller.
7743 @item -mno-tablejump
7744 Do not generate tablejump insns which sometimes increase code size.
7746 @item -mtiny-stack
7747 Change only the low 8 bits of the stack pointer.
7748 @end table
7750 @node MCore Options
7751 @subsection MCore Options
7752 @cindex MCore options
7754 These are the @samp{-m} options defined for the Motorola M*Core
7755 processors.  
7757 @table @gcctabopt
7759 @item -mhardlit
7760 @itemx -mhardlit
7761 @itemx -mno-hardlit
7762 Inline constants into the code stream if it can be done in two
7763 instructions or less.
7765 @item -mdiv
7766 @itemx -mdiv
7767 @itemx -mno-div
7768 Use the divide instruction.  (Enabled by default).
7770 @item -mrelax-immediate
7771 @itemx -mrelax-immediate
7772 @itemx -mno-relax-immediate
7773 Allow arbitrary sized immediates in bit operations.
7775 @item -mwide-bitfields
7776 @itemx -mwide-bitfields
7777 @itemx -mno-wide-bitfields
7778 Always treat bitfields as int-sized.
7780 @item -m4byte-functions
7781 @itemx -m4byte-functions
7782 @itemx -mno-4byte-functions
7783 Force all functions to be aligned to a four byte boundary.
7785 @item -mcallgraph-data
7786 @itemx -mcallgraph-data
7787 @itemx -mno-callgraph-data
7788 Emit callgraph information.
7790 @item -mslow-bytes
7791 @itemx -mslow-bytes
7792 @itemx -mno-slow-bytes
7793 Prefer word access when reading byte quantities.
7795 @item -mlittle-endian
7796 @itemx -mlittle-endian
7797 @itemx -mbig-endian
7798 Generate code for a little endian target.
7800 @item -m210
7801 @itemx -m210
7802 @itemx -m340
7803 Generate code for the 210 processor.
7804 @end table
7806 @node IA-64 Options
7807 @subsection IA-64 Options
7808 @cindex IA-64 Options
7810 These are the @samp{-m} options defined for the Intel IA-64 architecture.
7812 @table @gcctabopt
7813 @item -mbig-endian
7814 Generate code for a big endian target.  This is the default for HPUX.
7816 @item -mlittle-endian
7817 Generate code for a little endian target.  This is the default for AIX5
7818 and Linux.
7820 @item -mgnu-as
7821 @itemx -mno-gnu-as
7822 Generate (or don't) code for the GNU assembler.  This is the default.
7823 @c Also, this is the default if the configure option @samp{--with-gnu-as}
7824 @c is used.
7826 @item -mgnu-ld
7827 @itemx -mno-gnu-ld
7828 Generate (or don't) code for the GNU linker.  This is the default.
7829 @c Also, this is the default if the configure option @samp{--with-gnu-ld}
7830 @c is used.
7832 @item -mno-pic
7833 Generate code that does not use a global pointer register.  The result
7834 is not position independent code, and violates the IA-64 ABI.
7836 @item -mvolatile-asm-stop
7837 @itemx -mno-volatile-asm-stop
7838 Generate (or don't) a stop bit immediately before and after volatile asm
7839 statements.
7841 @item -mb-step
7842 Generate code that works around Itanium B step errata.
7844 @item -mregister-names
7845 @itemx -mno-register-names
7846 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7847 the stacked registers.  This may make assembler output more readable.
7849 @item -mno-sdata
7850 @itemx -msdata
7851 Disable (or enable) optimizations that use the small data section.  This may
7852 be useful for working around optimizer bugs.
7854 @item -mconstant-gp
7855 Generate code that uses a single constant global pointer value.  This is
7856 useful when compiling kernel code.
7858 @item -mauto-pic
7859 Generate code that is self-relocatable.  This implies @samp{-mconstant-gp}.
7860 This is useful when compiling firmware code.
7862 @item -minline-divide-min-latency
7863 Generate code for inline divides using the minimum latency algorithm.
7865 @item -minline-divide-max-throughput
7866 Generate code for inline divides using the maximum throughput algorithm.
7868 @item -mno-dwarf2-asm
7869 @itemx -mdwarf2-asm
7870 Don't (or do) generate assembler code for the DWARF2 line number debugging
7871 info.  This may be useful when not using the GNU assembler.
7873 @item -mfixed-range=@var{register range}
7874 Generate code treating the given register range as fixed registers.
7875 A fixed register is one that the register allocator can not use.  This is
7876 useful when compiling kernel code.  A register range is specified as
7877 two registers separated by a dash.  Multiple register ranges can be
7878 specified separated by a comma.
7879 @end table
7881 @node D30V Options
7882 @subsection D30V Options
7883 @cindex D30V Options
7885 These @samp{-m} options are defined for D30V implementations:
7887 @table @gcctabopt
7888 @item -mextmem
7889 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7890 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7891 memory, which starts at location @code{0x80000000}.
7893 @item -mextmemory
7894 Same as the @samp{-mextmem} switch.
7896 @item -monchip
7897 Link the @samp{.text} section into onchip text memory, which starts at
7898 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
7899 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7900 into onchip data memory, which starts at location @code{0x20000000}.
7902 @item -mno-asm-optimize
7903 @itemx -masm-optimize
7904 Disable (enable) passing @samp{-O} to the assembler when optimizing.
7905 The assembler uses the @samp{-O} option to automatically parallelize
7906 adjacent short instructions where possible.
7908 @item -mbranch-cost=@var{n}
7909 Increase the internal costs of branches to @var{n}.  Higher costs means
7910 that the compiler will issue more instructions to avoid doing a branch.
7911 The default is 2.
7913 @item -mcond-exec=@var{n}
7914 Specify the maximum number of conditionally executed instructions that
7915 replace a branch.  The default is 4.
7916 @end table
7918 @node Code Gen Options
7919 @section Options for Code Generation Conventions
7920 @cindex code generation conventions
7921 @cindex options, code generation
7922 @cindex run-time options
7924 These machine-independent options control the interface conventions
7925 used in code generation.
7927 Most of them have both positive and negative forms; the negative form
7928 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7929 one of the forms is listed---the one which is not the default.  You
7930 can figure out the other form by either removing @samp{no-} or adding
7933 @table @gcctabopt
7934 @item -fexceptions
7935 Enable exception handling. Generates extra code needed to propagate
7936 exceptions.  For some targets, this implies GNU CC will generate frame
7937 unwind information for all functions, which can produce significant data
7938 size overhead, although it does not affect execution.  If you do not
7939 specify this option, GNU CC will enable it by default for languages like
7940 C++ which normally require exception handling, and disable itfor
7941 languages like C that do not normally require it.  However, you may need
7942 to enable this option when compiling C code that needs to interoperate
7943 properly with exception handlers written in C++.  You may also wish to
7944 disable this option if you are compiling older C++ programs that don't
7945 use exception handling.
7947 @item -funwind-tables
7948 Similar to @option{-fexceptions}, except that it will just generate any needed
7949 static data, but will not affect the generated code in any other way.
7950 You will normally not enable this option; instead, a language processor
7951 that needs this handling would enable it on your behalf.
7953 @item -fpcc-struct-return
7954 Return ``short'' @code{struct} and @code{union} values in memory like
7955 longer ones, rather than in registers.  This convention is less
7956 efficient, but it has the advantage of allowing intercallability between
7957 GCC-compiled files and files compiled with other compilers.
7959 The precise convention for returning structures in memory depends
7960 on the target configuration macros.
7962 Short structures and unions are those whose size and alignment match
7963 that of some integer type.
7965 @item -freg-struct-return
7966 Use the convention that @code{struct} and @code{union} values are
7967 returned in registers when possible.  This is more efficient for small
7968 structures than @samp{-fpcc-struct-return}.
7970 If you specify neither @samp{-fpcc-struct-return} nor its contrary
7971 @samp{-freg-struct-return}, GCC defaults to whichever convention is
7972 standard for the target.  If there is no standard convention, GCC
7973 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
7974 is the principal compiler.  In those cases, we can choose the standard,
7975 and we chose the more efficient register return alternative.
7977 @item -fshort-enums
7978 Allocate to an @code{enum} type only as many bytes as it needs for the
7979 declared range of possible values.  Specifically, the @code{enum} type
7980 will be equivalent to the smallest integer type which has enough room.
7982 @item -fshort-double
7983 Use the same size for @code{double} as for @code{float}.
7985 @item -fshared-data
7986 Requests that the data and non-@code{const} variables of this
7987 compilation be shared data rather than private data.  The distinction
7988 makes sense only on certain operating systems, where shared data is
7989 shared between processes running the same program, while private data
7990 exists in one copy per process.
7992 @item -fno-common
7993 Allocate even uninitialized global variables in the data section of the
7994 object file, rather than generating them as common blocks.  This has the
7995 effect that if the same variable is declared (without @code{extern}) in
7996 two different compilations, you will get an error when you link them.
7997 The only reason this might be useful is if you wish to verify that the
7998 program will work on other systems which always work this way.
8000 @item -fno-ident
8001 Ignore the @samp{#ident} directive.
8003 @item -fno-gnu-linker
8004 Do not output global initializations (such as C++ constructors and
8005 destructors) in the form used by the GNU linker (on systems where the GNU
8006 linker is the standard method of handling them).  Use this option when
8007 you want to use a non-GNU linker, which also requires using the
8008 @command{collect2} program to make sure the system linker includes
8009 constructors and destructors.  (@command{collect2} is included in the GCC
8010 distribution.)  For systems which @emph{must} use @command{collect2}, the
8011 compiler driver @command{gcc} is configured to do this automatically.
8013 @item -finhibit-size-directive
8014 Don't output a @code{.size} assembler directive, or anything else that
8015 would cause trouble if the function is split in the middle, and the
8016 two halves are placed at locations far apart in memory.  This option is
8017 used when compiling @file{crtstuff.c}; you should not need to use it
8018 for anything else.
8020 @item -fverbose-asm
8021 Put extra commentary information in the generated assembly code to
8022 make it more readable.  This option is generally only of use to those
8023 who actually need to read the generated assembly code (perhaps while
8024 debugging the compiler itself).
8026 @samp{-fno-verbose-asm}, the default, causes the
8027 extra information to be omitted and is useful when comparing two assembler
8028 files.
8030 @item -fvolatile
8031 Consider all memory references through pointers to be volatile.
8033 @item -fvolatile-global
8034 Consider all memory references to extern and global data items to
8035 be volatile.  GCC does not consider static data items to be volatile
8036 because of this switch.
8038 @item -fvolatile-static
8039 Consider all memory references to static data to be volatile.
8041 @item -fpic
8042 @cindex global offset table
8043 @cindex PIC
8044 Generate position-independent code (PIC) suitable for use in a shared
8045 library, if supported for the target machine.  Such code accesses all
8046 constant addresses through a global offset table (GOT).  The dynamic
8047 loader resolves the GOT entries when the program starts (the dynamic
8048 loader is not part of GCC; it is part of the operating system).  If
8049 the GOT size for the linked executable exceeds a machine-specific
8050 maximum size, you get an error message from the linker indicating that
8051 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8052 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8053 on the m68k and RS/6000.  The 386 has no such limit.)
8055 Position-independent code requires special support, and therefore works
8056 only on certain machines.  For the 386, GCC supports PIC for System V
8057 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
8058 position-independent.
8060 @item -fPIC
8061 If supported for the target machine, emit position-independent code,
8062 suitable for dynamic linking and avoiding any limit on the size of the
8063 global offset table.  This option makes a difference on the m68k, m88k,
8064 and the Sparc.
8066 Position-independent code requires special support, and therefore works
8067 only on certain machines.
8069 @item -ffixed-@var{reg}
8070 Treat the register named @var{reg} as a fixed register; generated code
8071 should never refer to it (except perhaps as a stack pointer, frame
8072 pointer or in some other fixed role).
8074 @var{reg} must be the name of a register.  The register names accepted
8075 are machine-specific and are defined in the @code{REGISTER_NAMES}
8076 macro in the machine description macro file.
8078 This flag does not have a negative form, because it specifies a
8079 three-way choice.
8081 @item -fcall-used-@var{reg}
8082 Treat the register named @var{reg} as an allocable register that is
8083 clobbered by function calls.  It may be allocated for temporaries or
8084 variables that do not live across a call.  Functions compiled this way
8085 will not save and restore the register @var{reg}.
8087 It is an error to used this flag with the frame pointer or stack pointer.
8088 Use of this flag for other registers that have fixed pervasive roles in
8089 the machine's execution model will produce disastrous results.
8091 This flag does not have a negative form, because it specifies a
8092 three-way choice.
8094 @item -fcall-saved-@var{reg}
8095 Treat the register named @var{reg} as an allocable register saved by
8096 functions.  It may be allocated even for temporaries or variables that
8097 live across a call.  Functions compiled this way will save and restore
8098 the register @var{reg} if they use it.
8100 It is an error to used this flag with the frame pointer or stack pointer.
8101 Use of this flag for other registers that have fixed pervasive roles in
8102 the machine's execution model will produce disastrous results.
8104 A different sort of disaster will result from the use of this flag for
8105 a register in which function values may be returned.
8107 This flag does not have a negative form, because it specifies a
8108 three-way choice.
8110 @item -fpack-struct
8111 Pack all structure members together without holes.  Usually you would
8112 not want to use this option, since it makes the code suboptimal, and
8113 the offsets of structure members won't agree with system libraries.
8115 @item -fcheck-memory-usage
8116 Generate extra code to check each memory access.  GCC will generate
8117 code that is suitable for a detector of bad memory accesses such as
8118 @file{Checker}.
8120 Normally, you should compile all, or none, of your code with this option.
8122 If you do mix code compiled with and without this option,
8123 you must ensure that all code that has side effects
8124 and that is called by code compiled with this option
8125 is, itself, compiled with this option.
8126 If you do not, you might get erroneous messages from the detector.
8128 If you use functions from a library that have side-effects (such as
8129 @code{read}), you might not be able to recompile the library and
8130 specify this option.  In that case, you can enable the
8131 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
8132 your code and make other functions look as if they were compiled with
8133 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
8134 which are provided by the detector.  If you cannot find or build
8135 stubs for every function you call, you might have to specify
8136 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8138 If you specify this option, you can not use the @code{asm} or
8139 @code{__asm__} keywords in functions with memory checking enabled.  GNU
8140 CC cannot understand what the @code{asm} statement may do, and therefore
8141 cannot generate the appropriate code, so it will reject it.  However, if
8142 you specify the function attribute @code{no_check_memory_usage}
8143 (@pxref{Function Attributes}), GNU CC will disable memory checking within a
8144 function; you may use @code{asm} statements inside such functions.  You
8145 may have an inline expansion of a non-checked function within a checked
8146 function; in that case GNU CC will not generate checks for the inlined
8147 function's memory accesses.
8149 If you move your @code{asm} statements to non-checked inline functions
8150 and they do access memory, you can add calls to the support code in your
8151 inline function, to indicate any reads, writes, or copies being done.
8152 These calls would be similar to those done in the stubs described above.
8154 @item -fprefix-function-name
8155 Request GCC to add a prefix to the symbols generated for function names.
8156 GCC adds a prefix to the names of functions defined as well as
8157 functions called.  Code compiled with this option and code compiled
8158 without the option can't be linked together, unless stubs are used.
8160 If you compile the following code with @samp{-fprefix-function-name}
8161 @example
8162 extern void bar (int);
8163 void
8164 foo (int a)
8166   return bar (a + 5);
8168 @end example
8170 @noindent
8171 GCC will compile the code as if it was written:
8172 @example
8173 extern void prefix_bar (int);
8174 void
8175 prefix_foo (int a)
8177   return prefix_bar (a + 5);
8179 @end example
8180 This option is designed to be used with @samp{-fcheck-memory-usage}.
8182 @item -finstrument-functions
8183 Generate instrumentation calls for entry and exit to functions.  Just
8184 after function entry and just before function exit, the following
8185 profiling functions will be called with the address of the current
8186 function and its call site.  (On some platforms,
8187 @code{__builtin_return_address} does not work beyond the current
8188 function, so the call site information may not be available to the
8189 profiling functions otherwise.)
8191 @example
8192 void __cyg_profile_func_enter (void *this_fn, void *call_site);
8193 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
8194 @end example
8196 The first argument is the address of the start of the current function,
8197 which may be looked up exactly in the symbol table.
8199 This instrumentation is also done for functions expanded inline in other
8200 functions.  The profiling calls will indicate where, conceptually, the
8201 inline function is entered and exited.  This means that addressable
8202 versions of such functions must be available.  If all your uses of a
8203 function are expanded inline, this may mean an additional expansion of
8204 code size.  If you use @samp{extern inline} in your C code, an
8205 addressable version of such functions must be provided.  (This is
8206 normally the case anyways, but if you get lucky and the optimizer always
8207 expands the functions inline, you might have gotten away without
8208 providing static copies.)
8210 A function may be given the attribute @code{no_instrument_function}, in
8211 which case this instrumentation will not be done.  This can be used, for
8212 example, for the profiling functions listed above, high-priority
8213 interrupt routines, and any functions from which the profiling functions
8214 cannot safely be called (perhaps signal handlers, if the profiling
8215 routines generate output or allocate memory).
8217 @item -fstack-check
8218 Generate code to verify that you do not go beyond the boundary of the
8219 stack.  You should specify this flag if you are running in an
8220 environment with multiple threads, but only rarely need to specify it in
8221 a single-threaded environment since stack overflow is automatically
8222 detected on nearly all systems if there is only one stack.
8224 Note that this switch does not actually cause checking to be done; the
8225 operating system must do that.  The switch causes generation of code
8226 to ensure that the operating system sees the stack being extended.
8228 @item -fstack-limit-register=@var{reg}
8229 @itemx -fstack-limit-symbol=@var{sym}
8230 @itemx -fno-stack-limit
8231 Generate code to ensure that the stack does not grow beyond a certain value,
8232 either the value of a register or the address of a symbol.  If the stack
8233 would grow beyond the value, a signal is raised.  For most targets,
8234 the signal is raised before the stack overruns the boundary, so
8235 it is possible to catch the signal without taking special precautions.
8237 For instance, if the stack starts at address @samp{0x80000000} and grows
8238 downwards you can use the flags
8239 @samp{-fstack-limit-symbol=__stack_limit}
8240 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8241 limit of 128K.
8243 @cindex aliasing of parameters
8244 @cindex parameters, aliased
8245 @item -fargument-alias
8246 @itemx -fargument-noalias
8247 @itemx -fargument-noalias-global
8248 Specify the possible relationships among parameters and between
8249 parameters and global data.
8251 @samp{-fargument-alias} specifies that arguments (parameters) may
8252 alias each other and may alias global storage.
8253 @samp{-fargument-noalias} specifies that arguments do not alias
8254 each other, but may alias global storage.
8255 @samp{-fargument-noalias-global} specifies that arguments do not
8256 alias each other and do not alias global storage.
8258 Each language will automatically use whatever option is required by
8259 the language standard.  You should not need to use these options yourself.
8261 @item -fleading-underscore
8262 This option and its counterpart, -fno-leading-underscore, forcibly
8263 change the way C symbols are represented in the object file.  One use
8264 is to help link with legacy assembly code.
8266 Be warned that you should know what you are doing when invoking this
8267 option, and that not all targets provide complete support for it.
8268 @end table
8270 @c man end
8272 @node Environment Variables
8273 @section Environment Variables Affecting GCC
8274 @cindex environment variables
8276 @c man begin ENVIRONMENT
8278 This section describes several environment variables that affect how GCC
8279 operates.  Some of them work by specifying directories or prefixes to use
8280 when searching for various kinds of files. Some are used to specify other
8281 aspects of the compilation environment.
8283 @ifclear INTERNALS
8284 Note that you can also specify places to search using options such as
8285 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8286 take precedence over places specified using environment variables, which
8287 in turn take precedence over those specified by the configuration of GCC.
8289 @end ifclear
8290 @ifset INTERNALS
8291 Note that you can also specify places to search using options such as
8292 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8293 take precedence over places specified using environment variables, which
8294 in turn take precedence over those specified by the configuration of GCC.
8295 @xref{Driver}.
8296 @end ifset
8298 @table @env
8299 @item LANG
8300 @itemx LC_CTYPE
8301 @c @itemx LC_COLLATE
8302 @itemx LC_MESSAGES
8303 @c @itemx LC_MONETARY
8304 @c @itemx LC_NUMERIC
8305 @c @itemx LC_TIME
8306 @itemx LC_ALL
8307 @findex LANG
8308 @findex LC_CTYPE
8309 @c @findex LC_COLLATE
8310 @findex LC_MESSAGES
8311 @c @findex LC_MONETARY
8312 @c @findex LC_NUMERIC
8313 @c @findex LC_TIME
8314 @findex LC_ALL
8315 @cindex locale
8316 These environment variables control the way that GCC uses
8317 localization information that allow GCC to work with different
8318 national conventions.  GCC inspects the locale categories
8319 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
8320 so.  These locale categories can be set to any value supported by your
8321 installation.  A typical value is @samp{en_UK} for English in the United
8322 Kingdom.
8324 The @env{LC_CTYPE} environment variable specifies character
8325 classification.  GCC uses it to determine the character boundaries in
8326 a string; this is needed for some multibyte encodings that contain quote
8327 and escape characters that would otherwise be interpreted as a string
8328 end or escape.
8330 The @env{LC_MESSAGES} environment variable specifies the language to
8331 use in diagnostic messages.
8333 If the @env{LC_ALL} environment variable is set, it overrides the value
8334 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8335 and @env{LC_MESSAGES} default to the value of the @env{LANG}
8336 environment variable.  If none of these variables are set, GCC
8337 defaults to traditional C English behavior.
8339 @item TMPDIR
8340 @findex TMPDIR
8341 If @env{TMPDIR} is set, it specifies the directory to use for temporary
8342 files.  GCC uses temporary files to hold the output of one stage of
8343 compilation which is to be used as input to the next stage: for example,
8344 the output of the preprocessor, which is the input to the compiler
8345 proper.
8347 @item GCC_EXEC_PREFIX
8348 @findex GCC_EXEC_PREFIX
8349 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
8350 names of the subprograms executed by the compiler.  No slash is added
8351 when this prefix is combined with the name of a subprogram, but you can
8352 specify a prefix that ends with a slash if you wish.
8354 If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
8355 an appropriate prefix to use based on the pathname it was invoked with.
8357 If GCC cannot find the subprogram using the specified prefix, it
8358 tries looking in the usual places for the subprogram.
8360 The default value of @env{GCC_EXEC_PREFIX} is
8361 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8362 of @code{prefix} when you ran the @file{configure} script.
8364 Other prefixes specified with @samp{-B} take precedence over this prefix.
8366 This prefix is also used for finding files such as @file{crt0.o} that are
8367 used for linking.
8369 In addition, the prefix is used in an unusual way in finding the
8370 directories to search for header files.  For each of the standard
8371 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
8372 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
8373 replacing that beginning with the specified prefix to produce an
8374 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
8375 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8376 These alternate directories are searched first; the standard directories
8377 come next.
8379 @item COMPILER_PATH
8380 @findex COMPILER_PATH
8381 The value of @env{COMPILER_PATH} is a colon-separated list of
8382 directories, much like @env{PATH}.  GCC tries the directories thus
8383 specified when searching for subprograms, if it can't find the
8384 subprograms using @env{GCC_EXEC_PREFIX}.
8386 @item LIBRARY_PATH
8387 @findex LIBRARY_PATH
8388 The value of @env{LIBRARY_PATH} is a colon-separated list of
8389 directories, much like @env{PATH}.  When configured as a native compiler,
8390 GCC tries the directories thus specified when searching for special
8391 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
8392 using GCC also uses these directories when searching for ordinary
8393 libraries for the @samp{-l} option (but directories specified with
8394 @samp{-L} come first).
8396 @item C_INCLUDE_PATH
8397 @itemx CPLUS_INCLUDE_PATH
8398 @itemx OBJC_INCLUDE_PATH
8399 @findex C_INCLUDE_PATH
8400 @findex CPLUS_INCLUDE_PATH
8401 @findex OBJC_INCLUDE_PATH
8402 @c @itemx OBJCPLUS_INCLUDE_PATH
8403 These environment variables pertain to particular languages.  Each
8404 variable's value is a colon-separated list of directories, much like
8405 @env{PATH}.  When GCC searches for header files, it tries the
8406 directories listed in the variable for the language you are using, after
8407 the directories specified with @samp{-I} but before the standard header
8408 file directories.
8410 @item DEPENDENCIES_OUTPUT
8411 @findex DEPENDENCIES_OUTPUT
8412 @cindex dependencies for make as output
8413 If this variable is set, its value specifies how to output dependencies
8414 for Make based on the header files processed by the compiler.  This
8415 output looks much like the output from the @samp{-M} option
8416 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
8417 in addition to the usual results of compilation.
8419 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
8420 which case the Make rules are written to that file, guessing the target
8421 name from the source file name.  Or the value can have the form
8422 @samp{@var{file} @var{target}}, in which case the rules are written to
8423 file @var{file} using @var{target} as the target name.
8425 @item LANG
8426 @findex LANG
8427 @cindex locale definition
8428 This variable is used to pass locale information to the compiler. One way in
8429 which this information is used is to determine the character set to be used
8430 when character literals, string literals and comments are parsed in C and C++.
8431 When the compiler is configured to allow multibyte characters,
8432 the following values for @env{LANG} are recognized:
8434 @table @samp
8435 @item C-JIS
8436 Recognize JIS characters.
8437 @item C-SJIS
8438 Recognize SJIS characters.
8439 @item C-EUCJP
8440 Recognize EUCJP characters.
8441 @end table
8443 If @env{LANG} is not defined, or if it has some other value, then the
8444 compiler will use mblen and mbtowc as defined by the default locale to
8445 recognize and translate multibyte characters.
8446 @end table
8448 @c man end
8450 @node Running Protoize
8451 @section Running Protoize
8453 The program @code{protoize} is an optional part of GNU C.  You can use
8454 it to add prototypes to a program, thus converting the program to ISO
8455 C in one respect.  The companion program @code{unprotoize} does the
8456 reverse: it removes argument types from any prototypes that are found.
8458 When you run these programs, you must specify a set of source files as
8459 command line arguments.  The conversion programs start out by compiling
8460 these files to see what functions they define.  The information gathered
8461 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8463 After scanning comes actual conversion.  The specified files are all
8464 eligible to be converted; any files they include (whether sources or
8465 just headers) are eligible as well.
8467 But not all the eligible files are converted.  By default,
8468 @code{protoize} and @code{unprotoize} convert only source and header
8469 files in the current directory.  You can specify additional directories
8470 whose files should be converted with the @samp{-d @var{directory}}
8471 option.  You can also specify particular files to exclude with the
8472 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
8473 directory name matches one of the specified directory names, and its
8474 name within the directory has not been excluded.
8476 Basic conversion with @code{protoize} consists of rewriting most
8477 function definitions and function declarations to specify the types of
8478 the arguments.  The only ones not rewritten are those for varargs
8479 functions.
8481 @code{protoize} optionally inserts prototype declarations at the
8482 beginning of the source file, to make them available for any calls that
8483 precede the function's definition.  Or it can insert prototype
8484 declarations with block scope in the blocks where undeclared functions
8485 are called.
8487 Basic conversion with @code{unprotoize} consists of rewriting most
8488 function declarations to remove any argument types, and rewriting
8489 function definitions to the old-style pre-ISO form.
8491 Both conversion programs print a warning for any function declaration or
8492 definition that they can't convert.  You can suppress these warnings
8493 with @samp{-q}.
8495 The output from @code{protoize} or @code{unprotoize} replaces the
8496 original source file.  The original file is renamed to a name ending
8497 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
8498 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
8499 for DOS) file already exists, then the source file is simply discarded.
8501 @code{protoize} and @code{unprotoize} both depend on GCC itself to
8502 scan the program and collect information about the functions it uses.
8503 So neither of these programs will work until GCC is installed.
8505 Here is a table of the options you can use with @code{protoize} and
8506 @code{unprotoize}.  Each option works with both programs unless
8507 otherwise stated.
8509 @table @code
8510 @item -B @var{directory}
8511 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8512 usual directory (normally @file{/usr/local/lib}).  This file contains
8513 prototype information about standard system functions.  This option
8514 applies only to @code{protoize}.
8516 @item -c @var{compilation-options}
8517 Use  @var{compilation-options} as the options when running @code{gcc} to
8518 produce the @samp{.X} files.  The special option @samp{-aux-info} is
8519 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8521 Note that the compilation options must be given as a single argument to
8522 @code{protoize} or @code{unprotoize}.  If you want to specify several
8523 @code{gcc} options, you must quote the entire set of compilation options
8524 to make them a single word in the shell.
8526 There are certain @code{gcc} arguments that you cannot use, because they
8527 would produce the wrong kind of output.  These include @samp{-g},
8528 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8529 the @var{compilation-options}, they are ignored.
8531 @item -C
8532 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8533 systems) instead of @samp{.c}.  This is convenient if you are converting 
8534 a C program to C++.  This option applies only to @code{protoize}.
8536 @item -g
8537 Add explicit global declarations.  This means inserting explicit
8538 declarations at the beginning of each source file for each function
8539 that is called in the file and was not declared.  These declarations
8540 precede the first function definition that contains a call to an
8541 undeclared function.  This option applies only to @code{protoize}.
8543 @item -i @var{string}
8544 Indent old-style parameter declarations with the string @var{string}.
8545 This option applies only to @code{protoize}.
8547 @code{unprotoize} converts prototyped function definitions to old-style
8548 function definitions, where the arguments are declared between the
8549 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
8550 uses five spaces as the indentation.  If you want to indent with just
8551 one space instead, use @samp{-i " "}.
8553 @item -k
8554 Keep the @samp{.X} files.  Normally, they are deleted after conversion
8555 is finished.
8557 @item -l
8558 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
8559 a prototype declaration for each function in each block which calls the
8560 function without any declaration.  This option applies only to
8561 @code{protoize}.
8563 @item -n
8564 Make no real changes.  This mode just prints information about the conversions
8565 that would have been done without @samp{-n}.
8567 @item -N
8568 Make no @samp{.save} files.  The original files are simply deleted.
8569 Use this option with caution.
8571 @item -p @var{program}
8572 Use the program @var{program} as the compiler.  Normally, the name
8573 @file{gcc} is used.
8575 @item -q
8576 Work quietly.  Most warnings are suppressed.
8578 @item -v
8579 Print the version number, just like @samp{-v} for @code{gcc}.
8580 @end table
8582 If you need special compiler options to compile one of your program's
8583 source files, then you should generate that file's @samp{.X} file
8584 specially, by running @code{gcc} on that source file with the
8585 appropriate options and the option @samp{-aux-info}.  Then run
8586 @code{protoize} on the entire set of files.  @code{protoize} will use
8587 the existing @samp{.X} file because it is newer than the source file.
8588 For example:
8590 @example
8591 gcc -Dfoo=bar file1.c -aux-info
8592 protoize *.c
8593 @end example
8595 @noindent
8596 You need to include the special files along with the rest in the
8597 @code{protoize} command, even though their @samp{.X} files already
8598 exist, because otherwise they won't get converted.
8600 @xref{Protoize Caveats}, for more information on how to use
8601 @code{protoize} successfully.