* Makefile.in (OBJS): Add dwarf2asm.o.
[official-gcc.git] / gcc / invoke.texi
blobc95e7746ac3a337aecf3cb4e16dc7478dff10de7
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
249 -fno-inline  -fno-math-errno  -fno-peephole @gol
250 -fomit-frame-pointer  -foptimize-register-move @gol
251 -foptimize-sibling-calls  -freduce-all-givs @gol
252 -fregmove  -frename-registers @gol
253 -frerun-cse-after-loop  -frerun-loop-opt @gol
254 -fschedule-insns  -fschedule-insns2 @gol
255 -fsingle-precision-constant  -fssa @gol
256 -fstrength-reduce  -fstrict-aliasing  -fthread-jumps  -ftrapv @gol
257 -funroll-all-loops  -funroll-loops  @gol
258 --param @var{name}=@var{value}
259 -O  -O0  -O1  -O2  -O3  -Os}
261 @item Preprocessor Options
262 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
263 @gccoptlist{
264 -$  -A@var{question}=@var{answer}  -A-@var{question}@r{[}=@var{answer}@r{]} @gol
265 -C  -dD  -dI  -dM  -dN @gol
266 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
267 -idirafter @var{dir} @gol
268 -include @var{file}  -imacros @var{file} @gol
269 -iprefix @var{file}  -iwithprefix @var{dir} @gol
270 -iwithprefixbefore @var{dir}  -isystem @var{dir} -isystem-c++ @var{dir} @gol
271 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  -P  -remap @gol
272 -trigraphs  -undef  -U@var{macro}  -Wp\,@var{option}}
274 @item Assembler Option
275 @xref{Assembler Options,,Passing Options to the Assembler}.
276 @gccoptlist{
277 -Wa\,@var{option}}
279 @item Linker Options
280 @xref{Link Options,,Options for Linking}.
281 @gccoptlist{
282 @var{object-file-name}  -l@var{library} @gol
283 -nostartfiles  -nodefaultlibs  -nostdlib @gol
284 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
285 -Wl\,@var{option}  -Xlinker @var{option} @gol
286 -u @var{symbol}}
288 @item Directory Options
289 @xref{Directory Options,,Options for Directory Search}.
290 @gccoptlist{
291 -B@var{prefix}  -I@var{dir}  -I-  -L@var{dir}  -specs=@var{file}}
293 @item Target Options
294 @c I wrote this xref this way to avoid overfull hbox. -- rms
295 @xref{Target Options}.
296 @gccoptlist{
297 -b @var{machine}  -V @var{version}}
299 @item Machine Dependent Options
300 @xref{Submodel Options,,Hardware Models and Configurations}.
301 @emph{M680x0 Options}
302 @gccoptlist{
303 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
304 -m68060  -mcpu32 -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
305 -mfpa -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
306 -malign-int -mstrict-align}
308 @emph{M68hc1x Options}
309 @gccoptlist{
310 -m6811  -m6812  -m68hc11  -m68hc12 @gol
311 -mauto-incdec  -mshort  -msoft-reg-count=@var{count}}
313 @emph{VAX Options}
314 @gccoptlist{
315 -mg  -mgnu  -munix}
317 @emph{SPARC Options}
318 @gccoptlist{
319 -mcpu=@var{cpu type} @gol
320 -mtune=@var{cpu type} @gol
321 -mcmodel=@var{code model} @gol
322 -m32  -m64 @gol
323 -mapp-regs  -mbroken-saverestore  -mcypress @gol
324 -mepilogue -mfaster-structs -mflat @gol
325 -mfpu  -mhard-float  -mhard-quad-float @gol
326 -mimpure-text  -mlive-g0  -mno-app-regs @gol
327 -mno-epilogue -mno-faster-structs -mno-flat  -mno-fpu @gol
328 -mno-impure-text -mno-stack-bias  -mno-unaligned-doubles @gol
329 -msoft-float  -msoft-quad-float  -msparclite  -mstack-bias @gol
330 -msupersparc  -munaligned-doubles  -mv8}
332 @emph{Convex Options}
333 @gccoptlist{
334 -mc1  -mc2  -mc32  -mc34  -mc38 @gol
335 -margcount  -mnoargcount @gol
336 -mlong32  -mlong64 @gol
337 -mvolatile-cache  -mvolatile-nocache}
339 @emph{AMD29K Options}
340 @gccoptlist{
341 -m29000  -m29050  -mbw  -mnbw  -mdw  -mndw @gol
342 -mlarge  -mnormal  -msmall @gol
343 -mkernel-registers  -mno-reuse-arg-regs @gol
344 -mno-stack-check  -mno-storem-bug @gol
345 -mreuse-arg-regs  -msoft-float  -mstack-check @gol
346 -mstorem-bug  -muser-registers}
348 @emph{ARM Options}
349 @gccoptlist{
350 -mapcs-frame -mno-apcs-frame @gol
351 -mapcs-26 -mapcs-32 @gol
352 -mapcs-stack-check -mno-apcs-stack-check @gol
353 -mapcs-float -mno-apcs-float @gol
354 -mapcs-reentrant -mno-apcs-reentrant @gol
355 -msched-prolog -mno-sched-prolog @gol
356 -mlittle-endian -mbig-endian -mwords-little-endian @gol
357 -malignment-traps -mno-alignment-traps @gol
358 -msoft-float -mhard-float -mfpe @gol
359 -mthumb-interwork -mno-thumb-interwork @gol
360 -mcpu= -march= -mfpe=  @gol
361 -mstructure-size-boundary= @gol
362 -mbsd -mxopen -mno-symrename @gol
363 -mabort-on-noreturn @gol
364 -mlong-calls -mno-long-calls @gol
365 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
366 -msingle-pic-base -mno-single-pic-base @gol
367 -mpic-register=}
369 @emph{Thumb Options}
370 @gccoptlist{
371 -mtpcs-frame -mno-tpcs-frame @gol
372 -mtpcs-leaf-frame -mno-tpcs-leaf-frame @gol
373 -mlittle-endian  -mbig-endian @gol
374 -mthumb-interwork -mno-thumb-interwork @gol
375 -mstructure-size-boundary= @gol
376 -mnop-fun-dllimport -mno-nop-fun-dllimport @gol
377 -mcallee-super-interworking -mno-callee-super-interworking @gol
378 -mcaller-super-interworking -mno-caller-super-interworking @gol
379 -msingle-pic-base -mno-single-pic-base @gol
380 -mpic-register=}
382 @emph{MN10200 Options}
383 @gccoptlist{
384 -mrelax}
386 @emph{MN10300 Options}
387 @gccoptlist{
388 -mmult-bug @gol
389 -mno-mult-bug @gol
390 -mam33 @gol
391 -mno-am33 @gol
392 -mrelax}
394 @emph{M32R/D Options}
395 @gccoptlist{
396 -mcode-model=@var{model type}  -msdata=@var{sdata type} @gol
397 -G @var{num}}
399 @emph{M88K Options}
400 @gccoptlist{
401 -m88000  -m88100  -m88110  -mbig-pic @gol
402 -mcheck-zero-division  -mhandle-large-shift @gol
403 -midentify-revision  -mno-check-zero-division @gol
404 -mno-ocs-debug-info  -mno-ocs-frame-position @gol
405 -mno-optimize-arg-area  -mno-serialize-volatile @gol
406 -mno-underscores  -mocs-debug-info @gol
407 -mocs-frame-position  -moptimize-arg-area @gol
408 -mserialize-volatile  -mshort-data-@var{num}  -msvr3 @gol
409 -msvr4  -mtrap-large-shift  -muse-div-instruction @gol
410 -mversion-03.00  -mwarn-passed-structs}
412 @emph{RS/6000 and PowerPC Options}
413 @gccoptlist{
414 -mcpu=@var{cpu type} @gol
415 -mtune=@var{cpu type} @gol
416 -mpower  -mno-power  -mpower2  -mno-power2 @gol
417 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
418 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
419 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
420 -mnew-mnemonics  -mold-mnemonics @gol
421 -mfull-toc   -mminimal-toc  -mno-fop-in-toc  -mno-sum-in-toc @gol
422 -m64  -m32  -mxl-call  -mno-xl-call  -mthreads  -mpe @gol
423 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
424 -mstring  -mno-string  -mupdate  -mno-update @gol
425 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
426 -mstrict-align  -mno-strict-align  -mrelocatable @gol
427 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
428 -mtoc  -mno-toc -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
429 -mcall-aix  -mcall-sysv  -mprototype  -mno-prototype @gol
430 -msim  -mmvme  -mads  -myellowknife  -memb -msdata @gol
431 -msdata=@var{opt}  -mvxworks -G @var{num}}
433 @emph{RT Options}
434 @gccoptlist{
435 -mcall-lib-mul  -mfp-arg-in-fpregs  -mfp-arg-in-gregs @gol
436 -mfull-fp-blocks  -mhc-struct-return  -min-line-mul @gol
437 -mminimum-fp-blocks  -mnohc-struct-return}
439 @emph{MIPS Options}
440 @gccoptlist{
441 -mabicalls  -mcpu=@var{cpu type}
442 -membedded-data  -muninit-const-in-rodata @gol
443 -membedded-pic  -mfp32  -mfp64  -mgas  -mgp32  -mgp64 @gol
444 -mgpopt  -mhalf-pic  -mhard-float  -mint64  -mips1 @gol
445 -mips2  -mips3 -mips4 -mlong64  -mlong32 -mlong-calls  -mmemcpy @gol
446 -mmips-as  -mmips-tfile  -mno-abicalls @gol
447 -mno-embedded-data  -mno-uninit-const-in-rodata  -mno-embedded-pic @gol
448 -mno-gpopt  -mno-long-calls @gol
449 -mno-memcpy  -mno-mips-tfile  -mno-rnames  -mno-stats @gol
450 -mrnames  -msoft-float @gol
451 -m4650  -msingle-float  -mmad @gol
452 -mstats  -EL  -EB  -G @var{num}  -nocpp @gol
453 -mabi=32 -mabi=n32 -mabi=64 -mabi=eabi @gol
454 -mfix7000 -mno-crt0}
456 @emph{i386 Options}
457 @gccoptlist{
458 -mcpu=@var{cpu type} -march=@var{cpu type} @gol
459 -mintel-syntax -mieee-fp  -mno-fancy-math-387 @gol
460 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
461 -mno-wide-multiply  -mrtd  -malign-double @gol
462 -malign-jumps=@var{num}  -malign-loops=@var{num} @gol
463 -malign-functions=@var{num} -mpreferred-stack-boundary=@var{num} @gol
464 -mthreads -mno-align-stringops -minline-all-stringops @gol
465 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
466 -m96bit-long-double -mregparm=@var{num}}
468 @emph{HPPA Options}
469 @gccoptlist{
470 -march=@var{architecture type} @gol
471 -mbig-switch  -mdisable-fpregs  -mdisable-indexing   @gol
472 -mfast-indirect-calls -mgas  -mjump-in-delay   @gol
473 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
474 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
475 -mno-jump-in-delay  -mno-long-load-store   @gol
476 -mno-portable-runtime  -mno-soft-float @gol
477 -mno-space-regs  -msoft-float  -mpa-risc-1-0   @gol
478 -mpa-risc-1-1  -mpa-risc-2-0 -mportable-runtime @gol
479 -mschedule=@var{cpu type}  -mspace-regs}
481 @emph{Intel 960 Options}
482 @gccoptlist{
483 -m@var{cpu type}  -masm-compat  -mclean-linkage @gol
484 -mcode-align  -mcomplex-addr  -mleaf-procedures @gol
485 -mic-compat  -mic2.0-compat  -mic3.0-compat @gol
486 -mintel-asm  -mno-clean-linkage  -mno-code-align @gol
487 -mno-complex-addr  -mno-leaf-procedures @gol
488 -mno-old-align  -mno-strict-align  -mno-tail-call @gol
489 -mnumerics  -mold-align  -msoft-float  -mstrict-align @gol
490 -mtail-call}
492 @emph{DEC Alpha Options}
493 @gccoptlist{
494 -mfp-regs  -mno-fp-regs -mno-soft-float  -msoft-float @gol
495 -malpha-as -mgas @gol
496 -mieee  -mieee-with-inexact  -mieee-conformant @gol
497 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
498 -mtrap-precision=@var{mode}  -mbuild-constants @gol
499 -mcpu=@var{cpu type} @gol
500 -mbwx -mno-bwx -mcix -mno-cix -mmax -mno-max @gol
501 -mmemory-latency=@var{time}}
503 @emph{Clipper Options}
504 @gccoptlist{
505 -mc300  -mc400}
507 @emph{H8/300 Options}
508 @gccoptlist{
509 -mrelax  -mh -ms -mint32  -malign-300}
511 @emph{SH Options}
512 @gccoptlist{
513 -m1  -m2  -m3  -m3e @gol
514 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
515 -mb  -ml  -mdalign  -mrelax @gol
516 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
517 -misize  -mpadstruct  -mspace @gol
518 -mprefergot
519 -musermode}
521 @emph{System V Options}
522 @gccoptlist{
523 -Qy  -Qn  -YP\,@var{paths}  -Ym\,@var{dir}}
525 @emph{ARC Options}
526 @gccoptlist{
527 -EB  -EL @gol
528 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text section} @gol
529 -mdata=@var{data section}  -mrodata=@var{readonly data section}}
531 @emph{TMS320C3x/C4x Options}
532 @gccoptlist{
533 -mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
534 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
535 -mrpts=@var{count}  -mrptb -mdb -mloop-unsigned @gol
536 -mparallel-insns -mparallel-mpy -mpreserve-float}
538 @emph{V850 Options}
539 @gccoptlist{
540 -mlong-calls -mno-long-calls -mep -mno-ep @gol
541 -mprolog-function -mno-prolog-function -mspace @gol
542 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
543 -mv850 -mbig-switch}
545 @emph{NS32K Options}
546 @gccoptlist{
547 -m32032 -m32332 -m32532 -m32081 -m32381 -mmult-add -mnomult-add @gol
548 -msoft-float -mrtd -mnortd -mregparam -mnoregparam -msb -mnosb @gol
549 -mbitfield -mnobitfield -mhimem -mnohimem}
551 @emph{AVR Options}
552 @gccoptlist{
553 -mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
554 -mcall-prologues -mno-tablejump -mtiny-stack}
556 @emph{MCore Options}
557 @gccoptlist{
558 -mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates  @gol
559 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
560 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
561 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
562 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
564 @emph{IA-64 Options}
565 @gccoptlist{
566 -mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
567 -mvolatile-asm-stop -mb-step -mregister-names -mno-sdata @gol
568 -mconstant-gp -mauto-pic -minline-divide-min-latency @gol
569 -minline-divide-max-throughput -mno-dwarf2-asm @gol
570 -mfixed-range=@var{register range}}
572 @item Code Generation Options
573 @xref{Code Gen Options,,Options for Code Generation Conventions}.
574 @gccoptlist{
575 -fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
576 -fexceptions  -funwind-tables  -ffixed-@var{reg} @gol
577 -finhibit-size-directive  -finstrument-functions @gol
578 -fcheck-memory-usage  -fprefix-function-name @gol
579 -fno-common  -fno-ident  -fno-gnu-linker @gol
580 -fpcc-struct-return  -fpic  -fPIC @gol
581 -freg-struct-return  -fshared-data  -fshort-enums @gol
582 -fshort-double  -fvolatile  -fvolatile-global -fvolatile-static @gol
583 -fverbose-asm  -fpack-struct  -fstack-check @gol
584 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
585 -fargument-alias  -fargument-noalias @gol
586 -fargument-noalias-global @gol
587 -fleading-underscore}
588 @end table
590 @menu
591 * Overall Options::     Controlling the kind of output:
592                         an executable, object files, assembler files,
593                         or preprocessed source.
594 * C Dialect Options::   Controlling the variant of C language compiled.
595 * C++ Dialect Options:: Variations on C++.
596 * Language Independent Options:: Controlling how diagnostics should be
597                         formatted. 
598 * Warning Options::     How picky should the compiler be?
599 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
600 * Optimize Options::    How much optimization?
601 * Preprocessor Options:: Controlling header files and macro definitions.
602                          Also, getting dependency information for Make.
603 * Assembler Options::   Passing options to the assembler.
604 * Link Options::        Specifying libraries and so on.
605 * Directory Options::   Where to find header files and libraries.
606                         Where to find the compiler executable files.
607 * Spec Files::          How to pass switches to sub-processes.
608 * Target Options::      Running a cross-compiler, or an old version of GCC.
609 @end menu
611 @node Overall Options
612 @section Options Controlling the Kind of Output
614 Compilation can involve up to four stages: preprocessing, compilation
615 proper, assembly and linking, always in that order.  The first three
616 stages apply to an individual source file, and end by producing an
617 object file; linking combines all the object files (those newly
618 compiled, and those specified as input) into an executable file.
620 @cindex file name suffix
621 For any given input file, the file name suffix determines what kind of
622 compilation is done:
624 @table @gcctabopt
625 @item @var{file}.c
626 C source code which must be preprocessed.
628 @item @var{file}.i
629 C source code which should not be preprocessed.
631 @item @var{file}.ii
632 C++ source code which should not be preprocessed.
634 @item @var{file}.m
635 Objective-C source code.  Note that you must link with the library
636 @file{libobjc.a} to make an Objective-C program work.
638 @item @var{file}.mi
639 Objective-C source code which should not be preprocessed.
641 @item @var{file}.h
642 C header file (not to be compiled or linked).
644 @item @var{file}.cc
645 @itemx @var{file}.cp
646 @itemx @var{file}.cxx
647 @itemx @var{file}.cpp
648 @itemx @var{file}.c++
649 @itemx @var{file}.C
650 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
651 the last two letters must both be literally @samp{x}.  Likewise,
652 @samp{.C} refers to a literal capital C.
654 @item @var{file}.f
655 @itemx @var{file}.for
656 @itemx @var{file}.FOR
657 Fortran source code which should not be preprocessed.
659 @item @var{file}.F
660 @itemx @var{file}.fpp
661 @itemx @var{file}.FPP
662 Fortran source code which must be preprocessed (with the traditional
663 preprocessor).
665 @item @var{file}.r
666 Fortran source code which must be preprocessed with a RATFOR
667 preprocessor (not included with GCC).
669 @xref{Overall Options,,Options Controlling the Kind of Output, g77,
670 Using and Porting GNU Fortran}, for more details of the handling of
671 Fortran input files.
673 @c FIXME: Descriptions of Java file types.
674 @c @var{file}.java
675 @c @var{file}.class
676 @c @var{file}.zip
677 @c @var{file}.jar
679 @c GCC also knows about some suffixes for languages not yet included:
680 @c Ada:
681 @c @var{file}.ads
682 @c @var{file}.adb
683 @c @var{file}.ada
684 @c Pascal:
685 @c @var{file}.p
686 @c @var{file}.pas
688 @item @var{file}.ch
689 @itemx @var{file}.chi
690 CHILL source code (preprocessed with the traditional preprocessor).
692 @item @var{file}.s
693 Assembler code.
695 @item @var{file}.S
696 Assembler code which must be preprocessed.
698 @item @var{other}
699 An object file to be fed straight into linking.
700 Any file name with no recognized suffix is treated this way.
701 @end table
703 You can specify the input language explicitly with the @samp{-x} option:
705 @table @gcctabopt
706 @item -x @var{language}
707 Specify explicitly the @var{language} for the following input files
708 (rather than letting the compiler choose a default based on the file
709 name suffix).  This option applies to all following input files until
710 the next @samp{-x} option.  Possible values for @var{language} are:
711 @example
712 c  c-header  cpp-output
713 c++  c++-cpp-output
714 objective-c  objc-cpp-output
715 assembler  assembler-with-cpp
716 f77  f77-cpp-input  ratfor
717 java  chill
718 @end example
719 @c Also f77-version, for internal use only.
721 @item -x none
722 Turn off any specification of a language, so that subsequent files are
723 handled according to their file name suffixes (as they are if @samp{-x}
724 has not been used at all).
726 @item -pass-exit-codes
727 Normally the @command{gcc} program will exit with the code of 1 if any
728 phase of the compiler returns a non-success return code.  If you specify
729 @samp{-pass-exit-codes}, the @command{gcc} program will instead return with
730 numerically highest error produced by any phase that returned an error
731 indication.
732 @end table
734 If you only want some of the stages of compilation, you can use
735 @samp{-x} (or filename suffixes) to tell @command{gcc} where to start, and
736 one of the options @samp{-c}, @samp{-S}, or @samp{-E} to say where
737 @command{gcc} is to stop.  Note that some combinations (for example,
738 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
740 @table @gcctabopt
741 @item -c
742 Compile or assemble the source files, but do not link.  The linking
743 stage simply is not done.  The ultimate output is in the form of an
744 object file for each source file.
746 By default, the object file name for a source file is made by replacing
747 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
749 Unrecognized input files, not requiring compilation or assembly, are
750 ignored.
752 @item -S
753 Stop after the stage of compilation proper; do not assemble.  The output
754 is in the form of an assembler code file for each non-assembler input
755 file specified.
757 By default, the assembler file name for a source file is made by
758 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
760 Input files that don't require compilation are ignored.
762 @item -E
763 Stop after the preprocessing stage; do not run the compiler proper.  The
764 output is in the form of preprocessed source code, which is sent to the
765 standard output.
767 Input files which don't require preprocessing are ignored.
769 @cindex output file option
770 @item -o @var{file}
771 Place output in file @var{file}.  This applies regardless to whatever
772 sort of output is being produced, whether it be an executable file,
773 an object file, an assembler file or preprocessed C code.
775 Since only one output file can be specified, it does not make sense to
776 use @samp{-o} when compiling more than one input file, unless you are
777 producing an executable file as output.
779 If @samp{-o} is not specified, the default is to put an executable file
780 in @file{a.out}, the object file for @file{@var{source}.@var{suffix}} in
781 @file{@var{source}.o}, its assembler file in @file{@var{source}.s}, and
782 all preprocessed C source on standard output.@refill
784 @item -v
785 Print (on standard error output) the commands executed to run the stages
786 of compilation.  Also print the version number of the compiler driver
787 program and of the preprocessor and the compiler proper.
789 @item -pipe
790 Use pipes rather than temporary files for communication between the
791 various stages of compilation.  This fails to work on some systems where
792 the assembler is unable to read from a pipe; but the GNU assembler has
793 no trouble.
795 @item --help
796 Print (on the standard output) a description of the command line options
797 understood by @command{gcc}.  If the @option{-v} option is also specified
798 then @option{--help} will also be passed on to the various processes
799 invoked by @command{gcc}, so that they can display the command line options
800 they accept.  If the @option{-W} option is also specified then command
801 line options which have no documentation associated with them will also
802 be displayed.
804 @item --target-help
805 Print (on the standard output) a description of target specific command
806 line options for each tool.
807 @end table
809 @node Invoking G++
810 @section Compiling C++ Programs
812 @cindex suffixes for C++ source
813 @cindex C++ source file suffixes
814 C++ source files conventionally use one of the suffixes @samp{.C},
815 @samp{.cc}, @samp{.cpp}, @samp{.c++}, @samp{.cp}, or @samp{.cxx};
816 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
817 files with these names and compiles them as C++ programs even if you
818 call the compiler the same way as for compiling C programs (usually with
819 the name @command{gcc}).
821 @findex g++
822 @findex c++
823 However, C++ programs often require class libraries as well as a
824 compiler that understands the C++ language---and under some
825 circumstances, you might want to compile programs from standard input,
826 or otherwise without a suffix that flags them as C++ programs.
827 @command{g++} is a program that calls GCC with the default language
828 set to C++, and automatically specifies linking against the C++
829 library.  On many systems, @command{g++} is also
830 installed with the name @command{c++}.
832 @cindex invoking @command{g++}
833 When you compile C++ programs, you may specify many of the same
834 command-line options that you use for compiling programs in any
835 language; or command-line options meaningful for C and related
836 languages; or options that are meaningful only for C++ programs.
837 @xref{C Dialect Options,,Options Controlling C Dialect}, for
838 explanations of options for languages related to C.
839 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
840 explanations of options that are meaningful only for C++ programs.
842 @node C Dialect Options
843 @section Options Controlling C Dialect
844 @cindex dialect options
845 @cindex language dialect options
846 @cindex options, dialect
848 The following options control the dialect of C (or languages derived
849 from C, such as C++ and Objective C) that the compiler accepts:
851 @table @gcctabopt
852 @cindex ANSI support
853 @cindex ISO support
854 @item -ansi
855 In C mode, support all ISO C89 programs.  In C++ mode,
856 remove GNU extensions that conflict with ISO C++.
858 This turns off certain features of GCC that are incompatible with ISO
859 C (when compiling C code), or of standard C++ (when compiling C++ code),
860 such as the @code{asm} and @code{typeof} keywords, and
861 predefined macros such as @code{unix} and @code{vax} that identify the
862 type of system you are using.  It also enables the undesirable and
863 rarely used ISO trigraph feature.  For the C compiler, 
864 it disables recognition of C++ style @samp{//} comments as well as
865 the @code{inline} keyword.
867 The alternate keywords @code{__asm__}, @code{__extension__},
868 @code{__inline__} and @code{__typeof__} continue to work despite
869 @samp{-ansi}.  You would not want to use them in an ISO C program, of
870 course, but it is useful to put them in header files that might be included
871 in compilations done with @samp{-ansi}.  Alternate predefined macros
872 such as @code{__unix__} and @code{__vax__} are also available, with or
873 without @samp{-ansi}.
875 The @samp{-ansi} option does not cause non-ISO programs to be
876 rejected gratuitously.  For that, @samp{-pedantic} is required in
877 addition to @samp{-ansi}.  @xref{Warning Options}.
879 The macro @code{__STRICT_ANSI__} is predefined when the @samp{-ansi}
880 option is used.  Some header files may notice this macro and refrain
881 from declaring certain functions or defining certain macros that the
882 ISO standard doesn't call for; this is to avoid interfering with any
883 programs that might use these names for other things.
885 Functions which would normally be builtin but do not have semantics
886 defined by ISO C (such as @code{alloca} and @code{ffs}) are not builtin
887 functions with @samp{-ansi} is used.  @xref{Other Builtins,,Other
888 built-in functions provided by GNU CC}, for details of the functions
889 affected.
891 @item -std=
892 Determine the language standard.  A value for this option must be provided;
893 possible values are 
895 @table @samp
896 @item iso9899:1990
897 Same as @option{-ansi}
899 @item iso9899:199409
900 ISO C as modified in amend. 1
902 @item iso9899:1999
903 ISO C99.  Note that this standard is not yet fully supported; see
904 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.
906 @item c89
907 same as @option{-std=iso9899:1990}
909 @item c99
910 same as @option{-std=iso9899:1999}
912 @item gnu89
913 default, iso9899:1990 + gnu extensions
915 @item gnu99
916 iso9899:1999 + gnu extensions
918 @item iso9899:199x
919 same as @option{-std=iso9899:1999}, deprecated
921 @item c9x
922 same as @option{-std=iso9899:1999}, deprecated
924 @item gnu9x
925 same as @option{-std=gnu99}, deprecated
927 @end table
929 Even when this option is not specified, you can still use some of the
930 features of newer standards in so far as they do not conflict with
931 previous C standards.  For example, you may use @code{__restrict__} even
932 when @option{-std=c99} is not specified.
934 The @option{-std} options specifying some version of ISO C have the same
935 effects as @option{-ansi}, except that features that were not in ISO C89
936 but are in the specified version (for example, @samp{//} comments and
937 the @code{inline} keyword in ISO C99) are not disabled.
939 @xref{Standards,,Language Standards Supported by GCC}, for details of
940 these standard versions.
942 @item -fno-asm
943 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
944 keyword, so that code can use these words as identifiers.  You can use
945 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
946 instead.  @samp{-ansi} implies @samp{-fno-asm}.
948 In C++, this switch only affects the @code{typeof} keyword, since
949 @code{asm} and @code{inline} are standard keywords.  You may want to
950 use the @samp{-fno-gnu-keywords} flag instead, which has the same
951 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
952 switch only affects the @code{asm} and @code{typeof} keywords, since
953 @code{inline} is a standard keyword in ISO C99.
955 @item -fno-builtin
956 @cindex builtin functions
957 Don't recognize builtin functions that do not begin with
958 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
959 functions provided by GNU CC}, for details of the functions affected,
960 including those which are not builtin functions when @option{-ansi} or
961 @option{-std} options for strict ISO C conformance are used because they
962 do not have an ISO standard meaning.
964 GCC normally generates special code to handle certain builtin functions
965 more efficiently; for instance, calls to @code{alloca} may become single
966 instructions that adjust the stack directly, and calls to @code{memcpy}
967 may become inline copy loops.  The resulting code is often both smaller
968 and faster, but since the function calls no longer appear as such, you
969 cannot set a breakpoint on those calls, nor can you change the behavior
970 of the functions by linking with a different library.
972 @item -fhosted
973 @cindex hosted environment
975 Assert that compilation takes place in a hosted environment.  This implies
976 @samp{-fbuiltin}.  A hosted environment is one in which the
977 entire standard library is available, and in which @code{main} has a return
978 type of @code{int}.  Examples are nearly everything except a kernel.
979 This is equivalent to @samp{-fno-freestanding}.
981 @item -ffreestanding
982 @cindex hosted environment
984 Assert that compilation takes place in a freestanding environment.  This
985 implies @samp{-fno-builtin}.  A freestanding environment
986 is one in which the standard library may not exist, and program startup may
987 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
988 This is equivalent to @samp{-fno-hosted}.
990 @xref{Standards,,Language Standards Supported by GCC}, for details of
991 freestanding and hosted environments.
993 @item -trigraphs
994 Support ISO C trigraphs.  You don't want to know about this
995 brain-damage.  The @option{-ansi} option (and @option{-std} options for
996 strict ISO C conformance) implies @option{-trigraphs}.
998 @cindex traditional C language
999 @cindex C language, traditional
1000 @item -traditional
1001 Attempt to support some aspects of traditional C compilers.
1002 Specifically:
1004 @itemize @bullet
1005 @item
1006 All @code{extern} declarations take effect globally even if they
1007 are written inside of a function definition.  This includes implicit
1008 declarations of functions.
1010 @item
1011 The newer keywords @code{typeof}, @code{inline}, @code{signed}, @code{const}
1012 and @code{volatile} are not recognized.  (You can still use the
1013 alternative keywords such as @code{__typeof__}, @code{__inline__}, and
1014 so on.)
1016 @item
1017 Comparisons between pointers and integers are always allowed.
1019 @item
1020 Integer types @code{unsigned short} and @code{unsigned char} promote
1021 to @code{unsigned int}.
1023 @item
1024 Out-of-range floating point literals are not an error.
1026 @item
1027 Certain constructs which ISO regards as a single invalid preprocessing
1028 number, such as @samp{0xe-0xd}, are treated as expressions instead.
1030 @item
1031 String ``constants'' are not necessarily constant; they are stored in
1032 writable space, and identical looking constants are allocated
1033 separately.  (This is the same as the effect of
1034 @samp{-fwritable-strings}.)
1036 @cindex @code{longjmp} and automatic variables
1037 @item
1038 All automatic variables not declared @code{register} are preserved by
1039 @code{longjmp}.  Ordinarily, GNU C follows ISO C: automatic variables
1040 not declared @code{volatile} may be clobbered.
1042 @item
1043 @kindex \x
1044 @kindex \a
1045 @cindex escape sequences, traditional
1046 The character escape sequences @samp{\x} and @samp{\a} evaluate as the
1047 literal characters @samp{x} and @samp{a} respectively.  Without
1048 @w{@samp{-traditional}}, @samp{\x} is a prefix for the hexadecimal
1049 representation of a character, and @samp{\a} produces a bell.
1050 @end itemize
1052 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1053 if your program uses names that are normally GNU C builtin functions for
1054 other purposes of its own.
1056 You cannot use @samp{-traditional} if you include any header files that
1057 rely on ISO C features.  Some vendors are starting to ship systems with
1058 ISO C header files and you cannot use @samp{-traditional} on such
1059 systems to compile files that include any system headers.
1061 The @samp{-traditional} option also enables @samp{-traditional-cpp},
1062 which is described next.
1064 @item -traditional-cpp
1065 Attempt to support some aspects of traditional C preprocessors.
1066 Specifically:
1068 @itemize @bullet
1069 @item
1070 Comments convert to nothing at all, rather than to a space.  This allows
1071 traditional token concatenation.
1073 @item
1074 In a preprocessing directive, the @samp{#} symbol must appear as the first
1075 character of a line.
1077 @item
1078 Macro arguments are recognized within string constants in a macro
1079 definition (and their values are stringified, though without additional
1080 quote marks, when they appear in such a context).  The preprocessor
1081 always considers a string constant to end at a newline.
1083 @item
1084 @cindex detecting @w{@samp{-traditional}}
1085 The predefined macro @code{__STDC__} is not defined when you use
1086 @samp{-traditional}, but @code{__GNUC__} is (since the GNU extensions
1087 which @code{__GNUC__} indicates are not affected by
1088 @samp{-traditional}).  If you need to write header files that work
1089 differently depending on whether @samp{-traditional} is in use, by
1090 testing both of these predefined macros you can distinguish four
1091 situations: GNU C, traditional GNU C, other ISO C compilers, and other
1092 old C compilers.  The predefined macro @code{__STDC_VERSION__} is also
1093 not defined when you use @samp{-traditional}.  @xref{Standard
1094 Predefined,,Standard Predefined Macros,cpp.info,The C Preprocessor},
1095 for more discussion of these and other predefined macros.
1097 @item
1098 @cindex string constants vs newline
1099 @cindex newline vs string constants
1100 The preprocessor considers a string constant to end at a newline (unless
1101 the newline is escaped with @samp{\}).  (Without @w{@samp{-traditional}},
1102 string constants can contain the newline character as typed.)
1103 @end itemize
1105 @item -fcond-mismatch
1106 Allow conditional expressions with mismatched types in the second and
1107 third arguments.  The value of such an expression is void.  This option
1108 is not supported for C++.
1110 @item -funsigned-char
1111 Let the type @code{char} be unsigned, like @code{unsigned char}.
1113 Each kind of machine has a default for what @code{char} should
1114 be.  It is either like @code{unsigned char} by default or like
1115 @code{signed char} by default.
1117 Ideally, a portable program should always use @code{signed char} or
1118 @code{unsigned char} when it depends on the signedness of an object.
1119 But many programs have been written to use plain @code{char} and
1120 expect it to be signed, or expect it to be unsigned, depending on the
1121 machines they were written for.  This option, and its inverse, let you
1122 make such a program work with the opposite default.
1124 The type @code{char} is always a distinct type from each of
1125 @code{signed char} or @code{unsigned char}, even though its behavior
1126 is always just like one of those two.
1128 @item -fsigned-char
1129 Let the type @code{char} be signed, like @code{signed char}.
1131 Note that this is equivalent to @samp{-fno-unsigned-char}, which is
1132 the negative form of @samp{-funsigned-char}.  Likewise, the option
1133 @samp{-fno-signed-char} is equivalent to @samp{-funsigned-char}.
1135 You may wish to use @samp{-fno-builtin} as well as @samp{-traditional}
1136 if your program uses names that are normally GNU C builtin functions for
1137 other purposes of its own.
1139 You cannot use @samp{-traditional} if you include any header files that
1140 rely on ISO C features.  Some vendors are starting to ship systems with
1141 ISO C header files and you cannot use @samp{-traditional} on such
1142 systems to compile files that include any system headers.
1144 @item -fsigned-bitfields
1145 @itemx -funsigned-bitfields
1146 @itemx -fno-signed-bitfields
1147 @itemx -fno-unsigned-bitfields
1148 These options control whether a bitfield is signed or unsigned, when the
1149 declaration does not use either @code{signed} or @code{unsigned}.  By
1150 default, such a bitfield is signed, because this is consistent: the
1151 basic integer types such as @code{int} are signed types.
1153 However, when @samp{-traditional} is used, bitfields are all unsigned
1154 no matter what.
1156 @item -fwritable-strings
1157 Store string constants in the writable data segment and don't uniquize
1158 them.  This is for compatibility with old programs which assume they can
1159 write into string constants.  The option @samp{-traditional} also has
1160 this effect.
1162 Writing into string constants is a very bad idea; ``constants'' should
1163 be constant.
1165 @item -fallow-single-precision
1166 Do not promote single precision math operations to double precision,
1167 even when compiling with @samp{-traditional}.
1169 Traditional K&R C promotes all floating point operations to double
1170 precision, regardless of the sizes of the operands.   On the
1171 architecture for which you are compiling, single precision may be faster
1172 than double precision.   If you must use @samp{-traditional}, but want
1173 to use single precision operations when the operands are single
1174 precision, use this option.   This option has no effect when compiling
1175 with ISO or GNU C conventions (the default).
1177 @item -fshort-wchar
1178 Override the underlying type for @samp{wchar_t} to be @samp{short
1179 unsigned int} instead of the default for the target.  This option is
1180 useful for building programs to run under WINE.
1181 @end table
1183 @node C++ Dialect Options
1184 @section Options Controlling C++ Dialect
1186 @cindex compiler options, C++
1187 @cindex C++ options, command line
1188 @cindex options, C++
1189 This section describes the command-line options that are only meaningful
1190 for C++ programs; but you can also use most of the GNU compiler options
1191 regardless of what language your program is in.  For example, you
1192 might compile a file @code{firstClass.C} like this:
1194 @example
1195 g++ -g -frepo -O -c firstClass.C
1196 @end example
1198 @noindent
1199 In this example, only @samp{-frepo} is an option meant
1200 only for C++ programs; you can use the other options with any
1201 language supported by GCC.
1203 Here is a list of options that are @emph{only} for compiling C++ programs:
1205 @table @gcctabopt
1206 @item -fno-access-control
1207 Turn off all access checking.  This switch is mainly useful for working
1208 around bugs in the access control code.
1210 @item -fcheck-new
1211 Check that the pointer returned by @code{operator new} is non-null
1212 before attempting to modify the storage allocated.  The current Working
1213 Paper requires that @code{operator new} never return a null pointer, so
1214 this check is normally unnecessary.
1216 An alternative to using this option is to specify that your
1217 @code{operator new} does not throw any exceptions; if you declare it
1218 @samp{throw()}, g++ will check the return value.  See also @samp{new
1219 (nothrow)}.
1221 @item -fconserve-space
1222 Put uninitialized or runtime-initialized global variables into the
1223 common segment, as C does.  This saves space in the executable at the
1224 cost of not diagnosing duplicate definitions.  If you compile with this
1225 flag and your program mysteriously crashes after @code{main()} has
1226 completed, you may have an object that is being destroyed twice because
1227 two definitions were merged.
1229 This option is no longer useful on most targets, now that support has
1230 been added for putting variables into BSS without making them common.
1232 @item -fdollars-in-identifiers
1233 Accept @samp{$} in identifiers.  You can also explicitly prohibit use of
1234 @samp{$} with the option @samp{-fno-dollars-in-identifiers}.  (GNU C allows
1235 @samp{$} by default on most target systems, but there are a few exceptions.)
1236 Traditional C allowed the character @samp{$} to form part of
1237 identifiers.  However, ISO C and C++ forbid @samp{$} in identifiers.
1239 @item -fno-elide-constructors
1240 The C++ standard allows an implementation to omit creating a temporary
1241 which is only used to initialize another object of the same type.
1242 Specifying this option disables that optimization, and forces g++ to
1243 call the copy constructor in all cases.
1245 @item -fno-enforce-eh-specs
1246 Don't check for violation of exception specifications at runtime.  This
1247 option violates the C++ standard, but may be useful for reducing code
1248 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1249 will still optimize based on the exception specifications.
1251 @item -fexternal-templates
1252 Cause template instantiations to obey @samp{#pragma interface} and
1253 @samp{implementation}; template instances are emitted or not according
1254 to the location of the template definition.  @xref{Template
1255 Instantiation}, for more information.
1257 This option is deprecated.
1259 @item -falt-external-templates
1260 Similar to -fexternal-templates, but template instances are emitted or
1261 not according to the place where they are first instantiated.
1262 @xref{Template Instantiation}, for more information.
1264 This option is deprecated.
1266 @item -ffor-scope
1267 @itemx -fno-for-scope
1268 If -ffor-scope is specified, the scope of variables declared in
1269 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1270 as specified by the C++ standard.
1271 If -fno-for-scope is specified, the scope of variables declared in
1272 a @i{for-init-statement} extends to the end of the enclosing scope,
1273 as was the case in old versions of gcc, and other (traditional)
1274 implementations of C++.
1276 The default if neither flag is given to follow the standard,
1277 but to allow and give a warning for old-style code that would
1278 otherwise be invalid, or have different behavior.
1280 @item -fno-gnu-keywords
1281 Do not recognize @code{typeof} as a keyword, so that code can use this
1282 word as an identifier. You can use the keyword @code{__typeof__} instead.  
1283 @samp{-ansi} implies @samp{-fno-gnu-keywords}.
1285 @item -fhonor-std
1286 Treat the @code{namespace std} as a namespace, instead of ignoring
1287 it. For compatibility with earlier versions of g++, the compiler will,
1288 by default, ignore @code{namespace-declarations},
1289 @code{using-declarations}, @code{using-directives}, and
1290 @code{namespace-names}, if they involve @code{std}.
1292 @item -fhuge-objects
1293 Support virtual function calls for objects that exceed the size
1294 representable by a @samp{short int}.  Users should not use this flag by
1295 default; if you need to use it, the compiler will tell you so.
1297 This flag is not useful when compiling with -fvtable-thunks.
1299 Like all options that change the ABI, all C++ code, @emph{including
1300 libgcc} must be built with the same setting of this option.
1302 @item -fno-implicit-templates
1303 Never emit code for non-inline templates which are instantiated
1304 implicitly (i.e. by use); only emit code for explicit instantiations.
1305 @xref{Template Instantiation}, for more information.
1307 @item -fno-implicit-inline-templates
1308 Don't emit code for implicit instantiations of inline templates, either.
1309 The default is to handle inlines differently so that compiles with and
1310 without optimization will need the same set of explicit instantiations.
1312 @item -fno-implement-inlines
1313 To save space, do not emit out-of-line copies of inline functions
1314 controlled by @samp{#pragma implementation}.  This will cause linker
1315 errors if these functions are not inlined everywhere they are called.
1317 @item -fms-extensions
1318 Disable pedantic warnings about constructs used in MFC, such as implicit
1319 int and getting a pointer to member function via non-standard syntax.
1321 @item -fno-operator-names
1322 Do not treat the operator name keywords @code{and}, @code{bitand},
1323 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1324 synonyms as keywords.
1326 @item -fno-optional-diags
1327 Disable diagnostics that the standard says a compiler does not need to
1328 issue.  Currently, the only such diagnostic issued by g++ is the one for
1329 a name having multiple meanings within a class.
1331 @item -fpermissive
1332 Downgrade messages about nonconformant code from errors to warnings.  By
1333 default, g++ effectively sets @samp{-pedantic-errors} without
1334 @samp{-pedantic}; this option reverses that.  This behavior and this
1335 option are superseded by @samp{-pedantic}, which works as it does for GNU C.
1337 @item -frepo
1338 Enable automatic template instantiation.  This option also implies
1339 @samp{-fno-implicit-templates}.  @xref{Template Instantiation}, for more
1340 information.
1342 @item -fno-rtti
1343 Disable generation of information about every class with virtual
1344 functions for use by the C++ runtime type identification features
1345 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1346 of the language, you can save some space by using this flag.  Note that
1347 exception handling uses the same information, but it will generate it as
1348 needed.
1350 @item -ftemplate-depth-@var{n}
1351 Set the maximum instantiation depth for template classes to @var{n}.
1352 A limit on the template instantiation depth is needed to detect
1353 endless recursions during template class instantiation. ANSI/ISO C++
1354 conforming programs must not rely on a maximum depth greater than 17.
1356 @item -fuse-cxa-atexit
1357 Register destructors for objects with static storage duration with the
1358 @code{__cxa_atexit} function rather than the @code{atexit} function.
1359 This option is required for fully standards-compliant handling of static
1360 destructors, but will only work if your C library supports
1361 @code{__cxa_atexit}.
1363 @item -fvtable-thunks
1364 Use @samp{thunks} to implement the virtual function dispatch table
1365 (@samp{vtable}).  The traditional (cfront-style) approach to
1366 implementing vtables was to store a pointer to the function and two
1367 offsets for adjusting the @samp{this} pointer at the call site.  Newer
1368 implementations store a single pointer to a @samp{thunk} function which
1369 does any necessary adjustment and then calls the target function.
1371 This option also enables a heuristic for controlling emission of
1372 vtables; if a class has any non-inline virtual functions, the vtable
1373 will be emitted in the translation unit containing the first one of
1374 those.
1376 Like all options that change the ABI, all C++ code, @emph{including
1377 libgcc.a} must be built with the same setting of this option.
1379 @item -nostdinc++
1380 Do not search for header files in the standard directories specific to
1381 C++, but do still search the other standard directories.  (This option
1382 is used when building the C++ library.)
1383 @end table
1385 In addition, these optimization, warning, and code generation options
1386 have meanings only for C++ programs:
1388 @table @gcctabopt
1389 @item -fno-default-inline
1390 Do not assume @samp{inline} for functions defined inside a class scope.
1391 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1392 functions will have linkage like inline functions; they just won't be
1393 inlined by default.
1395 @item -Wctor-dtor-privacy (C++ only)
1396 Warn when a class seems unusable, because all the constructors or
1397 destructors in a class are private and the class has no friends or
1398 public static member functions.
1400 @item -Wnon-virtual-dtor (C++ only)
1401 Warn when a class declares a non-virtual destructor that should probably
1402 be virtual, because it looks like the class will be used polymorphically.
1404 @item -Wreorder (C++ only)
1405 @cindex reordering, warning
1406 @cindex warning for reordering of member initializers
1407 Warn when the order of member initializers given in the code does not
1408 match the order in which they must be executed.  For instance:
1410 @smallexample
1411 struct A @{
1412   int i;
1413   int j;
1414   A(): j (0), i (1) @{ @}
1416 @end smallexample
1418 Here the compiler will warn that the member initializers for @samp{i}
1419 and @samp{j} will be rearranged to match the declaration order of the
1420 members.
1421 @end table
1423 The following @samp{-W@dots{}} options are not affected by @samp{-Wall}.
1425 @table @gcctabopt
1426 @item -Weffc++ (C++ only)
1427 Warn about violations of various style guidelines from Scott Meyers'
1428 @cite{Effective C++} books.  If you use this option, you should be aware
1429 that the standard library headers do not obey all of these guidelines;
1430 you can use @samp{grep -v} to filter out those warnings.
1432 @item -Wno-deprecated (C++ only)
1433 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1435 @item -Wno-non-template-friend (C++ only)
1436 Disable warnings when non-templatized friend functions are declared
1437 within a template. With the advent of explicit template specification
1438 support in g++, if the name of the friend is an unqualified-id (ie,
1439 @samp{friend foo(int)}), the C++ language specification demands that the
1440 friend declare or define an ordinary, nontemplate function. (Section
1441 14.5.3). Before g++ implemented explicit specification, unqualified-ids
1442 could be interpreted as a particular specialization of a templatized
1443 function. Because this non-conforming behavior is no longer the default
1444 behavior for g++, @samp{-Wnon-template-friend} allows the compiler to
1445 check existing code for potential trouble spots, and is on by default.
1446 This new compiler behavior can be turned off with
1447 @samp{-Wno-non-template-friend} which keeps the conformant compiler code
1448 but disables the helpful warning.
1450 @item -Wold-style-cast (C++ only)
1451 Warn if an old-style (C-style) cast is used within a C++ program.  The
1452 new-style casts (@samp{static_cast}, @samp{reinterpret_cast}, and
1453 @samp{const_cast}) are less vulnerable to unintended effects.
1455 @item -Woverloaded-virtual (C++ only)
1456 @cindex overloaded virtual fn, warning
1457 @cindex warning for overloaded virtual fn
1458 Warn when a function declaration hides virtual functions from a
1459 base class.  For example, in:
1461 @smallexample
1462 struct A @{
1463   virtual void f();
1466 struct B: public A @{
1467   void f(int);
1469 @end smallexample
1471 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1472 like this:
1474 @smallexample
1475 B* b;
1476 b->f();
1477 @end smallexample
1479 will fail to compile.
1481 @item -Wno-pmf-conversions (C++ only)
1482 Disable the diagnostic for converting a bound pointer to member function
1483 to a plain pointer.
1485 @item -Wsign-promo (C++ only)
1486 Warn when overload resolution chooses a promotion from unsigned or
1487 enumeral type to a signed type over a conversion to an unsigned type of
1488 the same size.  Previous versions of g++ would try to preserve
1489 unsignedness, but the standard mandates the current behavior.
1491 @item -Wsynth (C++ only)
1492 @cindex warning for synthesized methods
1493 @cindex synthesized methods, warning
1494 Warn when g++'s synthesis behavior does not match that of cfront.  For
1495 instance:
1497 @smallexample
1498 struct A @{
1499   operator int ();
1500   A& operator = (int);
1503 main ()
1505   A a,b;
1506   a = b;
1508 @end smallexample
1510 In this example, g++ will synthesize a default @samp{A& operator =
1511 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1512 @end table
1514 @node Language Independent Options
1515 @section Options to Control Diagnostic Messages Formatting
1516 @cindex options to control diagnostics formatting
1517 @cindex diagnostic messages
1518 @cindex message formatting
1520 Traditionally, diagnostic messages have been formatted irrespective of
1521 the output device's aspect (e.g. its width, ...).  The options described
1522 below can be used to control the diagnostic messages formatting
1523 algorithm, e.g. how many characters per line, how often source location
1524 information should be reported.  Right now, only the C++ front-end can
1525 honor these options.  However it is expected, in the near future, that
1526 the remaining front-ends would be able to digest them correctly. 
1528 @table @gcctabopt
1529 @item -fmessage-length=@var{n}
1530 Try to format error messages so that they fit on lines of about @var{n}
1531 characters.  The default is 72 characters for g++ and 0 for the rest of
1532 the front-ends supported by GCC.  If @var{n} is zero, then no
1533 line-wrapping will be done; each error message will appear on a single 
1534 line.
1536 @item -fdiagnostics-show-location=once
1537 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1538 reporter to emit @emph{once} source location information; that is, in
1539 case the message is too long to fit on a single physical line and has to
1540 be wrapped, the source location won't be emitted (as prefix) again,
1541 over and over, in subsequent continuation lines.  This is the default
1542 behaviour. 
1544 @item -fdiagnostics-show-location=every-line
1545 Only meaningful in line-wrapping mode.  Instructs the diagnostic
1546 messages reporter to emit the same source location information (as
1547 prefix) for physical lines that result from the process of breaking a
1548 a message which is too long to fit on a single line.
1550 @end table
1552 @node Warning Options
1553 @section Options to Request or Suppress Warnings
1554 @cindex options to control warnings
1555 @cindex warning messages
1556 @cindex messages, warning
1557 @cindex suppressing warnings
1559 Warnings are diagnostic messages that report constructions which
1560 are not inherently erroneous but which are risky or suggest there
1561 may have been an error.
1563 You can request many specific warnings with options beginning @samp{-W},
1564 for example @samp{-Wimplicit} to request warnings on implicit
1565 declarations.  Each of these specific warning options also has a
1566 negative form beginning @samp{-Wno-} to turn off warnings;
1567 for example, @samp{-Wno-implicit}.  This manual lists only one of the
1568 two forms, whichever is not the default.
1570 These options control the amount and kinds of warnings produced by GCC:
1572 @table @gcctabopt
1573 @cindex syntax checking
1574 @item -fsyntax-only
1575 Check the code for syntax errors, but don't do anything beyond that.
1577 @item -pedantic
1578 Issue all the warnings demanded by strict ISO C and ISO C++;
1579 reject all programs that use forbidden extensions, and some other
1580 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
1581 version of the ISO C standard specified by any @samp{-std} option used.
1583 Valid ISO C and ISO C++ programs should compile properly with or without
1584 this option (though a rare few will require @option{-ansi} or a
1585 @option{-std} option specifying the required version of ISO C).  However,
1586 without this option, certain GNU extensions and traditional C and C++
1587 features are supported as well.  With this option, they are rejected.
1589 @samp{-pedantic} does not cause warning messages for use of the
1590 alternate keywords whose names begin and end with @samp{__}.  Pedantic
1591 warnings are also disabled in the expression that follows
1592 @code{__extension__}.  However, only system header files should use
1593 these escape routes; application programs should avoid them.
1594 @xref{Alternate Keywords}.
1596 Some users try to use @samp{-pedantic} to check programs for strict ISO
1597 C conformance.  They soon find that it does not do quite what they want:
1598 it finds some non-ISO practices, but not all---only those for which
1599 ISO C @emph{requires} a diagnostic, and some others for which
1600 diagnostics have been added.
1602 A feature to report any failure to conform to ISO C might be useful in
1603 some instances, but would require considerable additional work and would
1604 be quite different from @samp{-pedantic}.  We don't have plans to
1605 support such a feature in the near future.
1607 @item -pedantic-errors
1608 Like @samp{-pedantic}, except that errors are produced rather than
1609 warnings.
1611 @item -w
1612 Inhibit all warning messages.
1614 @item -Wno-import
1615 Inhibit warning messages about the use of @samp{#import}.
1617 @item -Wchar-subscripts
1618 Warn if an array subscript has type @code{char}.  This is a common cause
1619 of error, as programmers often forget that this type is signed on some
1620 machines.
1622 @item -Wcomment
1623 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
1624 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
1626 @item -Wformat
1627 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
1628 the arguments supplied have types appropriate to the format string
1629 specified, and that the conversions specified in the format string make
1630 sense.  This includes standard functions, and others specified by format
1631 attributes (@pxref{Function Attributes}), in the @code{printf},
1632 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
1633 not in the C standard) families.
1635 The formats are checked against the format features supported by GNU
1636 libc version 2.2.  These include all ISO C89 and C99 features, as well
1637 as features from the Single Unix Specification and some BSD and GNU
1638 extensions.  Other library implementations may not support all these
1639 features; GCC does not support warning about features that go beyond a
1640 particular library's limitations.  However, if @samp{-pedantic} is used
1641 with @samp{-Wformat}, warnings will be given about format features not
1642 in the selected standard version (but not for @code{strfmon} formats,
1643 since those are not in any version of the C standard).  @xref{C Dialect
1644 Options,,Options Controlling C Dialect}.
1646 @samp{-Wformat} is included in @samp{-Wall}.  For more control over some
1647 aspects of format checking, the options @samp{-Wno-format-y2k},
1648 @samp{-Wno-format-extra-args}, @samp{-Wformat-nonliteral},
1649 @samp{-Wformat-security} and @samp{-Wformat=2} are available, but are
1650 not included in @samp{-Wall}.
1652 @item -Wno-format-y2k
1653 If @samp{-Wformat} is specified, do not warn about @code{strftime}
1654 formats which may yield only a two-digit year.
1656 @item -Wno-format-extra-args
1657 If @samp{-Wformat} is specified, do not warn about excess arguments to a
1658 @code{printf} or @code{scanf} format function.  The C standard specifies
1659 that such arguments are ignored.
1661 @item -Wformat-nonliteral
1662 If @samp{-Wformat} is specified, also warn if the format string is not a
1663 string literal and so cannot be checked, unless the format function
1664 takes its format arguments as a @code{va_list}.
1666 @item -Wformat-security
1667 If @samp{-Wformat} is specified, also warn about uses of format
1668 functions that represent possible security problems.  At present, this
1669 warns about calls to @code{printf} and @code{scanf} functions where the
1670 format string is not a string literal and there are no format arguments,
1671 as in @code{printf (foo);}.  This may be a security hole if the format
1672 string came from untrusted input and contains @samp{%n}.  (This is
1673 currently a subset of what @samp{-Wformat-nonliteral} warns about, but
1674 in future warnings may be added to @samp{-Wformat-security} that are not
1675 included in @samp{-Wformat-nonliteral}.)
1677 @item -Wformat=2
1678 Enable @samp{-Wformat} plus format checks not included in
1679 @samp{-Wformat}.  Currently equivalent to @samp{-Wformat
1680 -Wformat-nonliteral -Wformat-security}.
1682 @item -Wimplicit-int
1683 Warn when a declaration does not specify a type.
1685 @item -Wimplicit-function-declaration
1686 @itemx -Werror-implicit-function-declaration
1687 Give a warning (or error) whenever a function is used before being
1688 declared.
1690 @item -Wimplicit
1691 Same as @samp{-Wimplicit-int} and @samp{-Wimplicit-function-}@*
1692 @samp{declaration}.
1694 @item -Wmain
1695 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
1696 function with external linkage, returning int, taking either zero
1697 arguments, two, or three arguments of appropriate types.
1699 @item -Wmultichar
1700 Warn if a multicharacter constant (@samp{'FOOF'}) is used.  Usually they
1701 indicate a typo in the user's code, as they have implementation-defined
1702 values, and should not be used in portable code.
1704 @item -Wparentheses
1705 Warn if parentheses are omitted in certain contexts, such
1706 as when there is an assignment in a context where a truth value
1707 is expected, or when operators are nested whose precedence people
1708 often get confused about.
1710 Also warn about constructions where there may be confusion to which
1711 @code{if} statement an @code{else} branch belongs.  Here is an example of
1712 such a case:
1714 @smallexample
1716   if (a)
1717     if (b)
1718       foo ();
1719   else
1720     bar ();
1722 @end smallexample
1724 In C, every @code{else} branch belongs to the innermost possible @code{if}
1725 statement, which in this example is @code{if (b)}.  This is often not
1726 what the programmer expected, as illustrated in the above example by
1727 indentation the programmer chose.  When there is the potential for this
1728 confusion, GNU C will issue a warning when this flag is specified.
1729 To eliminate the warning, add explicit braces around the innermost
1730 @code{if} statement so there is no way the @code{else} could belong to
1731 the enclosing @code{if}.  The resulting code would look like this:
1733 @smallexample
1735   if (a)
1736     @{
1737       if (b)
1738         foo ();
1739       else
1740         bar ();
1741     @}
1743 @end smallexample
1745 @item -Wsequence-point
1746 Warn about code that may have undefined semantics because of violations
1747 of sequence point rules in the C standard.
1749 The C standard defines the order in which expressions in a C program are
1750 evaluated in terms of @dfn{sequence points}, which represent a partial
1751 ordering between the execution of parts of the program: those executed
1752 before the sequence point, and those executed after it.  These occur
1753 after the evaluation of a full expression (one which is not part of a
1754 larger expression), after the evaluation of the first operand of a
1755 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
1756 function is called (but after the evaluation of its arguments and the
1757 expression denoting the called function), and in certain other places.
1758 Other than as expressed by the sequence point rules, the order of
1759 evaluation of subexpressions of an expression is not specified.  All
1760 these rules describe only a partial order rather than a total order,
1761 since, for example, if two functions are called within one expression
1762 with no sequence point between them, the order in which the functions
1763 are called is not specified.  However, the standards committee have
1764 ruled that function calls do not overlap.
1766 It is not specified when between sequence points modifications to the
1767 values of objects take effect.  Programs whose behavior depends on this
1768 have undefined behavior; the C standard specifies that ``Between the
1769 previous and next sequence point an object shall have its stored value
1770 modified at most once by the evaluation of an expression.  Furthermore,
1771 the prior value shall be read only to determine the value to be
1772 stored.''.  If a program breaks these rules, the results on any
1773 particular implementation are entirely unpredictable.
1775 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
1776 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
1777 diagnosed by this option, and it may give an occasional false positive
1778 result, but in general it has been found fairly effective at detecting
1779 this sort of problem in programs.
1781 The present implementation of this option only works for C programs.  A
1782 future implementation may also work for C++ programs.
1784 There is some controversy over the precise meaning of the sequence point
1785 rules in subtle cases.  Alternative formal definitions may be found in
1786 Clive Feather's ``Annex S''
1787 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n925.htm}} and in
1788 Michael Norrish's thesis
1789 @w{@uref{http://www.cl.cam.ac.uk/users/mn200/PhD/thesis-report.ps.gz}}.
1790 Other discussions are by Raymond Mak
1791 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n926.htm}} and
1792 D. Hugh Redelmeier
1793 @w{@uref{http://wwwold.dkuug.dk/JTC1/SC22/WG14/www/docs/n927.htm}}.
1795 @item -Wreturn-type
1796 Warn whenever a function is defined with a return-type that defaults to
1797 @code{int}.  Also warn about any @code{return} statement with no
1798 return-value in a function whose return-type is not @code{void}. 
1800 For C++, a function without return type always produces a diagnostic
1801 message, even when @samp{-Wno-return-type} is specified. The only
1802 exceptions are @samp{main} and functions defined in system headers.
1804 @item -Wswitch
1805 Warn whenever a @code{switch} statement has an index of enumeral type
1806 and lacks a @code{case} for one or more of the named codes of that
1807 enumeration.  (The presence of a @code{default} label prevents this
1808 warning.)  @code{case} labels outside the enumeration range also
1809 provoke warnings when this option is used.
1811 @item -Wtrigraphs
1812 Warn if any trigraphs are encountered that might change the meaning of
1813 the program (trigraphs within comments are not warned about).
1815 @item -Wunused-function
1816 Warn whenever a static function is declared but not defined or a
1817 non\-inline static function is unused.
1819 @item -Wunused-label
1820 Warn whenever a label is declared but not used.
1822 To suppress this warning use the @samp{unused} attribute
1823 (@pxref{Variable Attributes}).
1825 @item -Wunused-parameter
1826 Warn whenever a function parameter is unused aside from its declaration.
1828 To suppress this warning use the @samp{unused} attribute
1829 (@pxref{Variable Attributes}).
1831 @item -Wunused-variable
1832 Warn whenever a local variable or non-constant static variable is unused
1833 aside from its declaration
1835 To suppress this warning use the @samp{unused} attribute
1836 (@pxref{Variable Attributes}).
1838 @item -Wunused-value
1839 Warn whenever a statement computes a result that is explicitly not used.
1841 To suppress this warning cast the expression to @samp{void}.
1843 @item -Wunused
1844 All all the above @samp{-Wunused} options combined.
1846 In order to get a warning about an unused function parameter, you must
1847 either specify @samp{-W -Wunused} or separately specify
1848 @samp{-Wunused-parameter}.
1850 @item -Wuninitialized
1851 Warn if an automatic variable is used without first being initialized or
1852 if a variable may be clobbered by a @code{setjmp} call.
1854 These warnings are possible only in optimizing compilation,
1855 because they require data flow information that is computed only
1856 when optimizing.  If you don't specify @samp{-O}, you simply won't
1857 get these warnings.
1859 These warnings occur only for variables that are candidates for
1860 register allocation.  Therefore, they do not occur for a variable that
1861 is declared @code{volatile}, or whose address is taken, or whose size
1862 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
1863 structures, unions or arrays, even when they are in registers.
1865 Note that there may be no warning about a variable that is used only
1866 to compute a value that itself is never used, because such
1867 computations may be deleted by data flow analysis before the warnings
1868 are printed.
1870 These warnings are made optional because GCC is not smart
1871 enough to see all the reasons why the code might be correct
1872 despite appearing to have an error.  Here is one example of how
1873 this can happen:
1875 @smallexample
1877   int x;
1878   switch (y)
1879     @{
1880     case 1: x = 1;
1881       break;
1882     case 2: x = 4;
1883       break;
1884     case 3: x = 5;
1885     @}
1886   foo (x);
1888 @end smallexample
1890 @noindent
1891 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
1892 always initialized, but GCC doesn't know this.  Here is
1893 another common case:
1895 @smallexample
1897   int save_y;
1898   if (change_y) save_y = y, y = new_y;
1899   @dots{}
1900   if (change_y) y = save_y;
1902 @end smallexample
1904 @noindent
1905 This has no bug because @code{save_y} is used only if it is set.
1907 @cindex @code{longjmp} warnings
1908 This option also warns when a non-volatile automatic variable might be
1909 changed by a call to @code{longjmp}.  These warnings as well are possible
1910 only in optimizing compilation.
1912 The compiler sees only the calls to @code{setjmp}.  It cannot know
1913 where @code{longjmp} will be called; in fact, a signal handler could
1914 call it at any point in the code.  As a result, you may get a warning
1915 even when there is in fact no problem because @code{longjmp} cannot
1916 in fact be called at the place which would cause a problem.
1918 Some spurious warnings can be avoided if you declare all the functions
1919 you use that never return as @code{noreturn}.  @xref{Function
1920 Attributes}.
1922 @item -Wreorder (C++ only)
1923 @cindex reordering, warning
1924 @cindex warning for reordering of member initializers
1925 Warn when the order of member initializers given in the code does not
1926 match the order in which they must be executed.  For instance:
1928 @item -Wunknown-pragmas
1929 @cindex warning for unknown pragmas
1930 @cindex unknown pragmas, warning
1931 @cindex pragmas, warning of unknown
1932 Warn when a #pragma directive is encountered which is not understood by
1933 GCC.  If this command line option is used, warnings will even be issued
1934 for unknown pragmas in system header files.  This is not the case if
1935 the warnings were only enabled by the @samp{-Wall} command line option.
1937 @item -Wall
1938 All of the above @samp{-W} options combined.  This enables all the
1939 warnings about constructions that some users consider questionable, and
1940 that are easy to avoid (or modify to prevent the warning), even in
1941 conjunction with macros.
1943 @item -Wsystem-headers
1944 @cindex warnings from system headers
1945 @cindex system headers, warnings from
1946 Print warning messages for constructs found in system header files.
1947 Warnings from system headers are normally suppressed, on the assumption
1948 that they usually do not indicate real problems and would only make the
1949 compiler output harder to read.  Using this command line option tells
1950 GCC to emit warnings from system headers as if they occurred in user
1951 code.  However, note that using @samp{-Wall} in conjunction with this
1952 option will @emph{not} warn about unknown pragmas in system
1953 headers---for that, @samp{-Wunknown-pragmas} must also be used.
1954 @end table
1956 The following @samp{-W@dots{}} options are not implied by @samp{-Wall}.
1957 Some of them warn about constructions that users generally do not
1958 consider questionable, but which occasionally you might wish to check
1959 for; others warn about constructions that are necessary or hard to avoid
1960 in some cases, and there is no simple way to modify the code to suppress
1961 the warning.
1963 @table @gcctabopt
1964 @item -W
1965 Print extra warning messages for these events:
1967 @itemize @bullet
1968 @item
1969 A function can return either with or without a value.  (Falling
1970 off the end of the function body is considered returning without
1971 a value.)  For example, this function would evoke such a
1972 warning:
1974 @smallexample
1975 @group
1976 foo (a)
1978   if (a > 0)
1979     return a;
1981 @end group
1982 @end smallexample
1984 @item
1985 An expression-statement or the left-hand side of a comma expression
1986 contains no side effects.
1987 To suppress the warning, cast the unused expression to void.
1988 For example, an expression such as @samp{x[i,j]} will cause a warning,
1989 but @samp{x[(void)i,j]} will not.
1991 @item
1992 An unsigned value is compared against zero with @samp{<} or @samp{<=}.
1994 @item
1995 A comparison like @samp{x<=y<=z} appears; this is equivalent to
1996 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
1997 that of ordinary mathematical notation.
1999 @item
2000 Storage-class specifiers like @code{static} are not the first things in
2001 a declaration.  According to the C Standard, this usage is obsolescent.
2003 @item
2004 The return type of a function has a type qualifier such as @code{const}.
2005 Such a type qualifier has no effect, since the value returned by a
2006 function is not an lvalue.  (But don't warn about the GNU extension of
2007 @code{volatile void} return types.  That extension will be warned about
2008 if @samp{-pedantic} is specified.)
2010 @item
2011 If @samp{-Wall} or @samp{-Wunused} is also specified, warn about unused
2012 arguments.
2014 @item
2015 A comparison between signed and unsigned values could produce an
2016 incorrect result when the signed value is converted to unsigned.
2017 (But don't warn if @samp{-Wno-sign-compare} is also specified.)
2019 @item
2020 An aggregate has a partly bracketed initializer.
2021 For example, the following code would evoke such a warning,
2022 because braces are missing around the initializer for @code{x.h}:
2024 @smallexample
2025 struct s @{ int f, g; @};
2026 struct t @{ struct s h; int i; @};
2027 struct t x = @{ 1, 2, 3 @};
2028 @end smallexample
2030 @item
2031 An aggregate has an initializer which does not initialize all members.
2032 For example, the following code would cause such a warning, because
2033 @code{x.h} would be implicitly initialized to zero:
2035 @smallexample
2036 struct s @{ int f, g, h; @};
2037 struct s x = @{ 3, 4 @};
2038 @end smallexample
2039 @end itemize
2041 @item -Wfloat-equal
2042 Warn if floating point values are used in equality comparisons.
2044 The idea behind this is that sometimes it is convenient (for the
2045 programmer) to consider floating-point values as approximations to
2046 infinitely precise real numbers.  If you are doing this, then you need
2047 to compute (by analysing the code, or in some other way) the maximum or
2048 likely maximum error that the computation introduces, and allow for it
2049 when performing comparisons (and when producing output, but that's a
2050 different problem).  In particular, instead of testing for equality, you
2051 would check to see whether the two values have ranges that overlap; and
2052 this is done with the relational operators, so equality comparisons are
2053 probably mistaken.
2055 @item -Wtraditional (C only)
2056 Warn about certain constructs that behave differently in traditional and
2057 ISO C.
2059 @itemize @bullet
2060 @item
2061 Macro parameters that appear within string literals in the macro body.
2062 In traditional C macro replacement takes place within string literals,
2063 but does not in ISO C.
2065 @item
2066 In traditional C, some preprocessor directives did not exist.
2067 Traditional preprocessors would only consider a line to be a directive
2068 if the @samp{#} appeared in column 1 on the line.  Therefore
2069 @samp{-Wtraditional} warns about directives that traditional C
2070 understands but would ignore because the @samp{#} does not appear as the
2071 first character on the line.  It also suggests you hide directives like
2072 @samp{#pragma} not understood by traditional C by indenting them.  Some
2073 traditional implementations would not recognise @samp{#elif}, so it
2074 suggests avoiding it altogether.
2076 @item
2077 A function-like macro that appears without arguments.
2079 @item
2080 The unary plus operator.
2082 @item
2083 The `U' integer constant suffix, or the `F' or `L' floating point
2084 constant suffixes.  (Traditonal C does support the `L' suffix on integer
2085 constants.)  Note, these suffixes appear in macros defined in the system
2086 headers of most modern systems, e.g. the _MIN/_MAX macros in limits.h.
2087 Use of these macros can lead to spurious warnings as they do not
2088 necessarily reflect whether the code in question is any less portable to
2089 traditional C given that suitable backup definitions are provided.
2091 @item
2092 A function declared external in one block and then used after the end of
2093 the block.
2095 @item
2096 A @code{switch} statement has an operand of type @code{long}.
2098 @item
2099 A non-@code{static} function declaration follows a @code{static} one.
2100 This construct is not accepted by some traditional C compilers.
2102 @item
2103 The ISO type of an integer constant has a different width or
2104 signedness from its traditional type.  This warning is only issued if
2105 the base of the constant is ten.  I.e. hexadecimal or octal values, which
2106 typically represent bit patterns, are not warned about.
2108 @item
2109 Usage of ISO string concatenation is detected.
2111 @item
2112 Initialization of automatic aggregates.
2114 @item
2115 Identifier conflicts with labels.  Traditional C lacks a separate
2116 namespace for labels.
2118 @item
2119 Initialization of unions.  If the initializer is zero, the warning is
2120 omitted.  This is done under the assumption that the zero initializer in
2121 user code appears conditioned on e.g. @code{__STDC__} to avoid missing
2122 initializer warnings and relies on default initialization to zero in the
2123 traditional C case.
2124 @end itemize
2126 @item -Wundef
2127 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2129 @item -Wshadow
2130 Warn whenever a local variable shadows another local variable.
2132 @item -Wid-clash-@var{len}
2133 Warn whenever two distinct identifiers match in the first @var{len}
2134 characters.  This may help you prepare a program that will compile
2135 with certain obsolete, brain-damaged compilers.
2137 @item -Wlarger-than-@var{len}
2138 Warn whenever an object of larger than @var{len} bytes is defined.
2140 @item -Wpointer-arith
2141 Warn about anything that depends on the ``size of'' a function type or
2142 of @code{void}.  GNU C assigns these types a size of 1, for
2143 convenience in calculations with @code{void *} pointers and pointers
2144 to functions.
2146 @item -Wbad-function-cast (C only)
2147 Warn whenever a function call is cast to a non-matching type.
2148 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2150 @item -Wcast-qual
2151 Warn whenever a pointer is cast so as to remove a type qualifier from
2152 the target type.  For example, warn if a @code{const char *} is cast
2153 to an ordinary @code{char *}.
2155 @item -Wcast-align
2156 Warn whenever a pointer is cast such that the required alignment of the
2157 target is increased.  For example, warn if a @code{char *} is cast to
2158 an @code{int *} on machines where integers can only be accessed at
2159 two- or four-byte boundaries.
2161 @item -Wwrite-strings
2162 Give string constants the type @code{const char[@var{length}]} so that
2163 copying the address of one into a non-@code{const} @code{char *}
2164 pointer will get a warning.  These warnings will help you find at
2165 compile time code that can try to write into a string constant, but
2166 only if you have been very careful about using @code{const} in
2167 declarations and prototypes.  Otherwise, it will just be a nuisance;
2168 this is why we did not make @samp{-Wall} request these warnings.
2170 @item -Wconversion
2171 Warn if a prototype causes a type conversion that is different from what
2172 would happen to the same argument in the absence of a prototype.  This
2173 includes conversions of fixed point to floating and vice versa, and
2174 conversions changing the width or signedness of a fixed point argument
2175 except when the same as the default promotion.
2177 Also, warn if a negative integer constant expression is implicitly
2178 converted to an unsigned type.  For example, warn about the assignment
2179 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2180 casts like @code{(unsigned) -1}.
2182 @item -Wsign-compare
2183 @cindex warning for comparison of signed and unsigned values
2184 @cindex comparison of signed and unsigned values, warning
2185 @cindex signed and unsigned values, comparison warning
2186 Warn when a comparison between signed and unsigned values could produce
2187 an incorrect result when the signed value is converted to unsigned.
2188 This warning is also enabled by @samp{-W}; to get the other warnings
2189 of @samp{-W} without this warning, use @samp{-W -Wno-sign-compare}.
2191 @item -Waggregate-return
2192 Warn if any functions that return structures or unions are defined or
2193 called.  (In languages where you can return an array, this also elicits
2194 a warning.)
2196 @item -Wstrict-prototypes (C only)
2197 Warn if a function is declared or defined without specifying the
2198 argument types.  (An old-style function definition is permitted without
2199 a warning if preceded by a declaration which specifies the argument
2200 types.)
2202 @item -Wmissing-prototypes (C only)
2203 Warn if a global function is defined without a previous prototype
2204 declaration.  This warning is issued even if the definition itself
2205 provides a prototype.  The aim is to detect global functions that fail
2206 to be declared in header files.
2208 @item -Wmissing-declarations
2209 Warn if a global function is defined without a previous declaration.
2210 Do so even if the definition itself provides a prototype.
2211 Use this option to detect global functions that are not declared in
2212 header files.
2214 @item -Wmissing-noreturn
2215 Warn about functions which might be candidates for attribute @code{noreturn}.
2216 Note these are only possible candidates, not absolute ones.  Care should
2217 be taken to manually verify functions actually do not ever return before
2218 adding the @code{noreturn} attribute, otherwise subtle code generation
2219 bugs could be introduced.  You will not get a warning for @code{main} in
2220 hosted C environments.
2222 @item -Wmissing-format-attribute
2223 If @samp{-Wformat} is enabled, also warn about functions which might be
2224 candidates for @code{format} attributes.  Note these are only possible
2225 candidates, not absolute ones.  GCC will guess that @code{format}
2226 attributes might be appropriate for any function that calls a function
2227 like @code{vprintf} or @code{vscanf}, but this might not always be the
2228 case, and some functions for which @code{format} attributes are
2229 appropriate may not be detected.  This option has no effect unless
2230 @samp{-Wformat} is enabled (possibly by @samp{-Wall}).
2232 @item -Wpacked
2233 Warn if a structure is given the packed attribute, but the packed
2234 attribute has no effect on the layout or size of the structure.  
2235 Such structures may be mis-aligned for little benefit.  For
2236 instance, in this code, the variable @code{f.x} in @code{struct bar}
2237 will be misaligned even though @code{struct bar} does not itself
2238 have the packed attribute:
2240 @smallexample
2241 @group
2242 struct foo @{
2243   int x;
2244   char a, b, c, d;
2245 @} __attribute__((packed));
2246 struct bar @{
2247   char z;
2248   struct foo f;
2250 @end group
2251 @end smallexample
2253 @item -Wpadded
2254 Warn if padding is included in a structure, either to align an element
2255 of the structure or to align the whole structure.  Sometimes when this
2256 happens it is possible to rearrange the fields of the structure to
2257 reduce the padding and so make the structure smaller.
2259 @item -Wredundant-decls
2260 Warn if anything is declared more than once in the same scope, even in
2261 cases where multiple declaration is valid and changes nothing.
2263 @item -Wnested-externs (C only)
2264 Warn if an @code{extern} declaration is encountered within a function.
2266 @item -Wunreachable-code
2267 Warn if the compiler detects that code will never be executed.
2269 This option is intended to warn when the compiler detects that at
2270 least a whole line of source code will never be executed, because
2271 some condition is never satisfied or because it is after a
2272 procedure that never returns.
2274 It is possible for this option to produce a warning even though there
2275 are circumstances under which part of the affected line can be executed,
2276 so care should be taken when removing apparently-unreachable code.
2278 For instance, when a function is inlined, a warning may mean that the
2279 line is unreachable in only one inlined copy of the function.  
2281 This option is not made part of @samp{-Wall} because in a debugging
2282 version of a program there is often substantial code which checks
2283 correct functioning of the program and is, hopefully, unreachable
2284 because the program does work.  Another common use of unreachable
2285 code is to provide behaviour which is selectable at compile-time.
2287 @item -Winline
2288 Warn if a function can not be inlined and it was declared as inline.
2290 @item -Wlong-long
2291 Warn if @samp{long long} type is used.  This is default.  To inhibit
2292 the warning messages, use @samp{-Wno-long-long}.  Flags
2293 @samp{-Wlong-long} and @samp{-Wno-long-long} are taken into account
2294 only when @samp{-pedantic} flag is used.
2296 @item -Wdisabled-optimization
2297 Warn if a requested optimization pass is disabled.  This warning does
2298 not generally indicate that there is anything wrong with your code; it
2299 merely indicates that GCC's optimizers were unable to handle the code
2300 effectively.  Often, the problem is that your code is too big or too
2301 complex; GCC will refuse to optimize programs when the optimization
2302 itself is likely to take inordinate amounts of time.
2304 @item -Werror
2305 Make all warnings into errors.
2306 @end table
2308 @node Debugging Options
2309 @section Options for Debugging Your Program or GCC
2310 @cindex options, debugging
2311 @cindex debugging information options
2313 GCC has various special options that are used for debugging
2314 either your program or GCC:
2316 @table @gcctabopt
2317 @item -g
2318 Produce debugging information in the operating system's native format
2319 (stabs, COFF, XCOFF, or DWARF).  GDB can work with this debugging
2320 information.
2322 On most systems that use stabs format, @samp{-g} enables use of extra
2323 debugging information that only GDB can use; this extra information
2324 makes debugging work better in GDB but will probably make other debuggers
2325 crash or
2326 refuse to read the program.  If you want to control for certain whether
2327 to generate the extra information, use @samp{-gstabs+}, @samp{-gstabs},
2328 @samp{-gxcoff+}, @samp{-gxcoff}, @samp{-gdwarf-1+}, or @samp{-gdwarf-1}
2329 (see below).
2331 Unlike most other C compilers, GCC allows you to use @samp{-g} with
2332 @samp{-O}.  The shortcuts taken by optimized code may occasionally
2333 produce surprising results: some variables you declared may not exist
2334 at all; flow of control may briefly move where you did not expect it;
2335 some statements may not be executed because they compute constant
2336 results or their values were already at hand; some statements may
2337 execute in different places because they were moved out of loops.
2339 Nevertheless it proves possible to debug optimized output.  This makes
2340 it reasonable to use the optimizer for programs that might have bugs.
2342 The following options are useful when GCC is generated with the
2343 capability for more than one debugging format.
2345 @item -ggdb
2346 Produce debugging information for use by GDB.  This means to use the
2347 most expressive format available (DWARF 2, stabs, or the native format
2348 if neither of those are supported), including GDB extensions if at all
2349 possible.
2351 @item -gstabs
2352 Produce debugging information in stabs format (if that is supported),
2353 without GDB extensions.  This is the format used by DBX on most BSD
2354 systems.  On MIPS, Alpha and System V Release 4 systems this option
2355 produces stabs debugging output which is not understood by DBX or SDB.
2356 On System V Release 4 systems this option requires the GNU assembler.
2358 @item -gstabs+
2359 Produce debugging information in stabs format (if that is supported),
2360 using GNU extensions understood only by the GNU debugger (GDB).  The
2361 use of these extensions is likely to make other debuggers crash or
2362 refuse to read the program.
2364 @item -gcoff
2365 Produce debugging information in COFF format (if that is supported).
2366 This is the format used by SDB on most System V systems prior to
2367 System V Release 4.
2369 @item -gxcoff
2370 Produce debugging information in XCOFF format (if that is supported).
2371 This is the format used by the DBX debugger on IBM RS/6000 systems.
2373 @item -gxcoff+
2374 Produce debugging information in XCOFF format (if that is supported),
2375 using GNU extensions understood only by the GNU debugger (GDB).  The
2376 use of these extensions is likely to make other debuggers crash or
2377 refuse to read the program, and may cause assemblers other than the GNU
2378 assembler (GAS) to fail with an error.
2380 @item -gdwarf
2381 Produce debugging information in DWARF version 1 format (if that is
2382 supported).  This is the format used by SDB on most System V Release 4
2383 systems.
2385 @item -gdwarf+
2386 Produce debugging information in DWARF version 1 format (if that is
2387 supported), using GNU extensions understood only by the GNU debugger
2388 (GDB).  The use of these extensions is likely to make other debuggers
2389 crash or refuse to read the program.
2391 @item -gdwarf-2
2392 Produce debugging information in DWARF version 2 format (if that is
2393 supported).  This is the format used by DBX on IRIX 6.
2395 @item -g@var{level}
2396 @itemx -ggdb@var{level}
2397 @itemx -gstabs@var{level}
2398 @itemx -gcoff@var{level}
2399 @itemx -gxcoff@var{level}
2400 @itemx -gdwarf@var{level}
2401 @itemx -gdwarf-2@var{level}
2402 Request debugging information and also use @var{level} to specify how
2403 much information.  The default level is 2.
2405 Level 1 produces minimal information, enough for making backtraces in
2406 parts of the program that you don't plan to debug.  This includes
2407 descriptions of functions and external variables, but no information
2408 about local variables and no line numbers.
2410 Level 3 includes extra information, such as all the macro definitions
2411 present in the program.  Some debuggers support macro expansion when
2412 you use @samp{-g3}.
2414 @cindex @code{prof}
2415 @item -p
2416 Generate extra code to write profile information suitable for the
2417 analysis program @code{prof}.  You must use this option when compiling
2418 the source files you want data about, and you must also use it when
2419 linking.
2421 @cindex @code{gprof}
2422 @item -pg
2423 Generate extra code to write profile information suitable for the
2424 analysis program @code{gprof}.  You must use this option when compiling
2425 the source files you want data about, and you must also use it when
2426 linking.
2428 @cindex @code{tcov}
2429 @item -a
2430 Generate extra code to write profile information for basic blocks, which will
2431 record the number of times each basic block is executed, the basic block start
2432 address, and the function name containing the basic block.  If @samp{-g} is
2433 used, the line number and filename of the start of the basic block will also be
2434 recorded.  If not overridden by the machine description, the default action is
2435 to append to the text file @file{bb.out}.
2437 This data could be analyzed by a program like @code{tcov}.  Note,
2438 however, that the format of the data is not what @code{tcov} expects.
2439 Eventually GNU @code{gprof} should be extended to process this data.
2441 @item -Q
2442 Makes the compiler print out each function name as it is compiled, and
2443 print some statistics about each pass when it finishes.
2445 @item -ax
2446 Generate extra code to profile basic blocks.  Your executable will
2447 produce output that is a superset of that produced when @samp{-a} is
2448 used.  Additional output is the source and target address of the basic
2449 blocks where a jump takes place, the number of times a jump is executed,
2450 and (optionally) the complete sequence of basic blocks being executed.
2451 The output is appended to file @file{bb.out}.
2453 You can examine different profiling aspects without recompilation.  Your
2454 executable will read a list of function names from file @file{bb.in}.
2455 Profiling starts when a function on the list is entered and stops when
2456 that invocation is exited.  To exclude a function from profiling, prefix
2457 its name with `-'.  If a function name is not unique, you can
2458 disambiguate it by writing it in the form
2459 @samp{/path/filename.d:functionname}.  Your executable will write the
2460 available paths and filenames in file @file{bb.out}.
2462 Several function names have a special meaning:
2463 @table @code
2464 @item __bb_jumps__
2465 Write source, target and frequency of jumps to file @file{bb.out}.
2466 @item __bb_hidecall__
2467 Exclude function calls from frequency count.
2468 @item __bb_showret__
2469 Include function returns in frequency count.
2470 @item __bb_trace__
2471 Write the sequence of basic blocks executed to file @file{bbtrace.gz}.
2472 The file will be compressed using the program @samp{gzip}, which must
2473 exist in your @env{PATH}.  On systems without the @samp{popen}
2474 function, the file will be named @file{bbtrace} and will not be
2475 compressed.  @strong{Profiling for even a few seconds on these systems
2476 will produce a very large file.}  Note: @code{__bb_hidecall__} and
2477 @code{__bb_showret__} will not affect the sequence written to
2478 @file{bbtrace.gz}.
2479 @end table
2481 Here's a short example using different profiling parameters
2482 in file @file{bb.in}.  Assume function @code{foo} consists of basic blocks
2483 1 and 2 and is called twice from block 3 of function @code{main}.  After
2484 the calls, block 3 transfers control to block 4 of @code{main}.
2486 With @code{__bb_trace__} and @code{main} contained in file @file{bb.in},
2487 the following sequence of blocks is written to file @file{bbtrace.gz}:
2488 0 3 1 2 1 2 4.  The return from block 2 to block 3 is not shown, because
2489 the return is to a point inside the block and not to the top.  The
2490 block address 0 always indicates, that control is transferred
2491 to the trace from somewhere outside the observed functions.  With
2492 @samp{-foo} added to @file{bb.in}, the blocks of function
2493 @code{foo} are removed from the trace, so only 0 3 4 remains.
2495 With @code{__bb_jumps__} and @code{main} contained in file @file{bb.in},
2496 jump frequencies will be written to file @file{bb.out}.  The
2497 frequencies are obtained by constructing a trace of blocks
2498 and incrementing a counter for every neighbouring pair of blocks
2499 in the trace.  The trace 0 3 1 2 1 2 4 displays the following
2500 frequencies:
2502 @example
2503 Jump from block 0x0 to block 0x3 executed 1 time(s)
2504 Jump from block 0x3 to block 0x1 executed 1 time(s)
2505 Jump from block 0x1 to block 0x2 executed 2 time(s)
2506 Jump from block 0x2 to block 0x1 executed 1 time(s)
2507 Jump from block 0x2 to block 0x4 executed 1 time(s)
2508 @end example
2510 With @code{__bb_hidecall__}, control transfer due to call instructions
2511 is removed from the trace, that is the trace is cut into three parts: 0
2512 3 4, 0 1 2 and 0 1 2.  With @code{__bb_showret__}, control transfer due
2513 to return instructions is added to the trace.  The trace becomes: 0 3 1
2514 2 3 1 2 3 4.  Note, that this trace is not the same, as the sequence
2515 written to @file{bbtrace.gz}.  It is solely used for counting jump
2516 frequencies.
2518 @item -fprofile-arcs
2519 Instrument @dfn{arcs} during compilation.  For each function of your
2520 program, GCC creates a program flow graph, then finds a spanning tree
2521 for the graph.  Only arcs that are not on the spanning tree have to be
2522 instrumented: the compiler adds code to count the number of times that these
2523 arcs are executed.  When an arc is the only exit or only entrance to a
2524 block, the instrumentation code can be added to the block; otherwise, a
2525 new basic block must be created to hold the instrumentation code.
2527 Since not every arc in the program must be instrumented, programs
2528 compiled with this option run faster than programs compiled with
2529 @samp{-a}, which adds instrumentation code to every basic block in the
2530 program.  The tradeoff: since @code{gcov} does not have
2531 execution counts for all branches, it must start with the execution
2532 counts for the instrumented branches, and then iterate over the program
2533 flow graph until the entire graph has been solved.  Hence, @code{gcov}
2534 runs a little more slowly than a program which uses information from
2535 @samp{-a}.
2537 @samp{-fprofile-arcs} also makes it possible to estimate branch
2538 probabilities, and to calculate basic block execution counts.  In
2539 general, basic block execution counts do not give enough information to
2540 estimate all branch probabilities.  When the compiled program exits, it
2541 saves the arc execution counts to a file called
2542 @file{@var{sourcename}.da}.  Use the compiler option
2543 @samp{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
2544 Control Optimization}) when recompiling, to optimize using estimated
2545 branch probabilities.
2547 @need 2000
2548 @item -ftest-coverage
2549 Create data files for the @code{gcov} code-coverage utility
2550 (@pxref{Gcov,, @code{gcov}: a GCC Test Coverage Program}).
2551 The data file names begin with the name of your source file:
2553 @table @gcctabopt
2554 @item @var{sourcename}.bb
2555 A mapping from basic blocks to line numbers, which @code{gcov} uses to
2556 associate basic block execution counts with line numbers.
2558 @item @var{sourcename}.bbg
2559 A list of all arcs in the program flow graph.  This allows @code{gcov}
2560 to reconstruct the program flow graph, so that it can compute all basic
2561 block and arc execution counts from the information in the
2562 @code{@var{sourcename}.da} file (this last file is the output from
2563 @samp{-fprofile-arcs}).
2564 @end table
2566 @item -d@var{letters}
2567 Says to make debugging dumps during compilation at times specified by
2568 @var{letters}.  This is used for debugging the compiler.  The file names
2569 for most of the dumps are made by appending a pass number and a word to
2570 the source file name (e.g.  @file{foo.c.00.rtl} or @file{foo.c.01.sibling}). 
2571 Here are the possible letters for use in @var{letters}, and their meanings:
2573 @table @samp
2574 @item A
2575 Annotate the assembler output with miscellaneous debugging information.
2576 @item b
2577 Dump after computing branch probabilities, to @file{@var{file}.11.bp}.
2578 @item B
2579 Dump after block reordering, to @file{@var{file}.26.bbro}.
2580 @item c
2581 Dump after instruction combination, to the file @file{@var{file}.14.combine}.
2582 @item C
2583 Dump after the first if conversion, to the file @file{@var{file}.15.ce}.
2584 @item d
2585 Dump after delayed branch scheduling, to @file{@var{file}.29.dbr}.
2586 @item D
2587 Dump all macro definitions, at the end of preprocessing, in addition to
2588 normal output.
2589 @item e
2590 Dump after SSA optimizations, to @file{@var{file}.05.ssa} and
2591 @file{@var{file}.06.ussa}.
2592 @item E
2593 Dump after the second if conversion, to @file{@var{file}.24.ce2}.
2594 @item f
2595 Dump after life analysis, to @file{@var{file}.13.life}.
2596 @item F
2597 Dump after purging @code{ADDRESSOF} codes, to @file{@var{file}.04.addressof}.
2598 @item g
2599 Dump after global register allocation, to @file{@var{file}.19.greg}.
2600 @item o
2601 Dump after post-reload CSE and other optimizations, to @file{@var{file}.20.postreload}.
2602 @item G      
2603 Dump after GCSE, to @file{@var{file}.08.gcse}.
2604 @item i
2605 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
2606 @item j
2607 Dump after the first jump optimization, to @file{@var{file}.02.jump}.
2608 @item J
2609 Dump after the last jump optimization, to @file{@var{file}.27.jump2}.
2610 @item k
2611 Dump after conversion from registers to stack, to @file{@var{file}.29.stack}.
2612 @item l
2613 Dump after local register allocation, to @file{@var{file}.18.lreg}.
2614 @item L
2615 Dump after loop optimization, to @file{@var{file}.09.loop}.
2616 @item M
2617 Dump after performing the machine dependent reorganisation pass, to
2618 @file{@var{file}.28.mach}. 
2619 @item n
2620 Dump after register renumbering, to @file{@var{file}.23.rnreg}.
2621 @item N
2622 Dump after the register move pass, to @file{@var{file}.16.regmove}.
2623 @item r
2624 Dump after RTL generation, to @file{@var{file}.00.rtl}.
2625 @item R
2626 Dump after the second instruction scheduling pass, to
2627 @file{@var{file}.25.sched2}.
2628 @item s
2629 Dump after CSE (including the jump optimization that sometimes follows
2630 CSE), to @file{@var{file}.03.cse}. 
2631 @item S
2632 Dump after the first instruction scheduling pass, to
2633 @file{@var{file}.17.sched}.
2634 @item t
2635 Dump after the second CSE pass (including the jump optimization that
2636 sometimes follows CSE), to @file{@var{file}.10.cse2}.
2637 @item w
2638 Dump after the second flow pass, to @file{@var{file}.21.flow2}.
2639 @item X
2640 Dump after dead code elimination, to @file{@var{file}.06.dce}.
2641 @item z
2642 Dump after the peephole pass, to @file{@var{file}.22.peephole2}.
2643 @item a
2644 Produce all the dumps listed above.
2645 @item m
2646 Print statistics on memory usage, at the end of the run, to
2647 standard error.
2648 @item p
2649 Annotate the assembler output with a comment indicating which
2650 pattern and alternative was used.  The length of each instruction is
2651 also printed.
2652 @item P
2653 Dump the RTL in the assembler output as a comment before each instruction.
2654 Also turns on @samp{-dp} annotation.
2655 @item v
2656 For each of the other indicated dump files (except for
2657 @file{@var{file}.00.rtl}), dump a representation of the control flow graph
2658 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
2659 @item x
2660 Just generate RTL for a function instead of compiling it.  Usually used
2661 with @samp{r}.
2662 @item y
2663 Dump debugging information during parsing, to standard error.
2664 @end table
2666 @item -fdump-unnumbered
2667 When doing debugging dumps (see -d option above), suppress instruction
2668 numbers and line number note output.  This makes it more feasible to
2669 use diff on debugging dumps for compiler invocations with different
2670 options, in particular with and without -g.
2672 @item -fdump-translation-unit=@var{file} (C and C++ only)
2673 Dump a representation of the tree structure for the entire translation
2674 unit to @var{file}.
2676 @item -fdump-class_layout=@var{file} (C++ only)
2677 @item -fdump-class_layout (C++ only)
2678 Dump a representation of each class's heirarchy to @var{file}, or
2679 @code{stderr} if not specified.
2681 @item -fpretend-float
2682 When running a cross-compiler, pretend that the target machine uses the
2683 same floating point format as the host machine.  This causes incorrect
2684 output of the actual floating constants, but the actual instruction
2685 sequence will probably be the same as GCC would make when running on
2686 the target machine.
2688 @item -save-temps
2689 Store the usual ``temporary'' intermediate files permanently; place them
2690 in the current directory and name them based on the source file.  Thus,
2691 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
2692 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
2693 preprocessed @file{foo.i} output file even though the compiler now
2694 normally uses an integrated preprocessor.
2696 @item -time
2697 Report the CPU time taken by each subprocess in the compilation
2698 sequence.  For C source files, this is the compiler proper and assembler
2699 (plus the linker if linking is done).  The output looks like this:
2701 @smallexample
2702 # cc1 0.12 0.01
2703 # as 0.00 0.01
2704 @end smallexample
2706 The first number on each line is the ``user time,'' that is time spent
2707 executing the program itself.  The second number is ``system time,''
2708 time spent executing operating system routines on behalf of the program.
2709 Both numbers are in seconds.
2711 @item -print-file-name=@var{library}
2712 Print the full absolute name of the library file @var{library} that
2713 would be used when linking---and don't do anything else.  With this
2714 option, GCC does not compile or link anything; it just prints the
2715 file name.
2717 @item -print-prog-name=@var{program}
2718 Like @samp{-print-file-name}, but searches for a program such as @samp{cpp}.
2720 @item -print-libgcc-file-name
2721 Same as @samp{-print-file-name=libgcc.a}.
2723 This is useful when you use @samp{-nostdlib} or @samp{-nodefaultlibs}
2724 but you do want to link with @file{libgcc.a}.  You can do
2726 @example
2727 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
2728 @end example
2730 @item -print-search-dirs
2731 Print the name of the configured installation directory and a list of
2732 program and library directories gcc will search---and don't do anything else.
2734 This is useful when gcc prints the error message
2735 @samp{installation problem, cannot exec cpp0: No such file or directory}.
2736 To resolve this you either need to put @file{cpp0} and the other compiler
2737 components where gcc expects to find them, or you can set the environment
2738 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
2739 Don't forget the trailing '/'.
2740 @xref{Environment Variables}.
2741 @end table
2743 @node Optimize Options
2744 @section Options That Control Optimization
2745 @cindex optimize options
2746 @cindex options, optimization
2748 These options control various sorts of optimizations:
2750 @table @gcctabopt
2751 @item -O
2752 @itemx -O1
2753 Optimize.  Optimizing compilation takes somewhat more time, and a lot
2754 more memory for a large function.
2756 Without @samp{-O}, the compiler's goal is to reduce the cost of
2757 compilation and to make debugging produce the expected results.
2758 Statements are independent: if you stop the program with a breakpoint
2759 between statements, you can then assign a new value to any variable or
2760 change the program counter to any other statement in the function and
2761 get exactly the results you would expect from the source code.
2763 Without @samp{-O}, the compiler only allocates variables declared
2764 @code{register} in registers.  The resulting compiled code is a little
2765 worse than produced by PCC without @samp{-O}.
2767 With @samp{-O}, the compiler tries to reduce code size and execution
2768 time.
2770 When you specify @samp{-O}, the compiler turns on @samp{-fthread-jumps}
2771 and @samp{-fdefer-pop} on all machines.  The compiler turns on
2772 @samp{-fdelayed-branch} on machines that have delay slots, and
2773 @samp{-fomit-frame-pointer} on machines that can support debugging even
2774 without a frame pointer.  On some machines the compiler also turns
2775 on other flags.@refill
2777 @item -O2
2778 Optimize even more.  GCC performs nearly all supported optimizations
2779 that do not involve a space-speed tradeoff.  The compiler does not
2780 perform loop unrolling or function inlining when you specify @samp{-O2}.
2781 As compared to @samp{-O}, this option increases both compilation time
2782 and the performance of the generated code.
2784 @samp{-O2} turns on all optional optimizations except for loop unrolling,
2785 function inlining, and register renaming.  It also turns on the
2786 @samp{-fforce-mem} option on all machines and frame pointer elimination
2787 on machines where doing so does not interfere with debugging.
2789 @item -O3
2790 Optimize yet more.  @samp{-O3} turns on all optimizations specified by
2791 @samp{-O2} and also turns on the @samp{-finline-functions} and
2792 @samp{-frename-registers} options.
2794 @item -O0
2795 Do not optimize.
2797 @item -Os
2798 Optimize for size.  @samp{-Os} enables all @samp{-O2} optimizations that
2799 do not typically increase code size.  It also performs further
2800 optimizations designed to reduce code size.
2802 If you use multiple @samp{-O} options, with or without level numbers,
2803 the last such option is the one that is effective.
2804 @end table
2806 Options of the form @samp{-f@var{flag}} specify machine-independent
2807 flags.  Most flags have both positive and negative forms; the negative
2808 form of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below,
2809 only one of the forms is listed---the one which is not the default.
2810 You can figure out the other form by either removing @samp{no-} or
2811 adding it.
2813 @table @gcctabopt
2814 @item -ffloat-store
2815 Do not store floating point variables in registers, and inhibit other
2816 options that might change whether a floating point value is taken from a
2817 register or memory.
2819 @cindex floating point precision
2820 This option prevents undesirable excess precision on machines such as
2821 the 68000 where the floating registers (of the 68881) keep more
2822 precision than a @code{double} is supposed to have.  Similarly for the
2823 x86 architecture.  For most programs, the excess precision does only
2824 good, but a few programs rely on the precise definition of IEEE floating
2825 point.  Use @samp{-ffloat-store} for such programs, after modifying
2826 them to store all pertinent intermediate computations into variables.
2828 @item -fno-default-inline
2829 Do not make member functions inline by default merely because they are
2830 defined inside the class scope (C++ only).  Otherwise, when you specify
2831 @w{@samp{-O}}, member functions defined inside class scope are compiled
2832 inline by default; i.e., you don't need to add @samp{inline} in front of
2833 the member function name.
2835 @item -fno-defer-pop
2836 Always pop the arguments to each function call as soon as that function
2837 returns.  For machines which must pop arguments after a function call,
2838 the compiler normally lets arguments accumulate on the stack for several
2839 function calls and pops them all at once.
2841 @item -fforce-mem
2842 Force memory operands to be copied into registers before doing
2843 arithmetic on them.  This produces better code by making all memory
2844 references potential common subexpressions.  When they are not common
2845 subexpressions, instruction combination should eliminate the separate
2846 register-load.  The @samp{-O2} option turns on this option.
2848 @item -fforce-addr
2849 Force memory address constants to be copied into registers before
2850 doing arithmetic on them.  This may produce better code just as
2851 @samp{-fforce-mem} may.
2853 @item -fomit-frame-pointer
2854 Don't keep the frame pointer in a register for functions that
2855 don't need one.  This avoids the instructions to save, set up and
2856 restore frame pointers; it also makes an extra register available
2857 in many functions.  @strong{It also makes debugging impossible on
2858 some machines.}
2860 @ifset INTERNALS
2861 On some machines, such as the Vax, this flag has no effect, because
2862 the standard calling sequence automatically handles the frame pointer
2863 and nothing is saved by pretending it doesn't exist.  The
2864 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2865 whether a target machine supports this flag.  @xref{Registers}.@refill
2866 @end ifset
2867 @ifclear INTERNALS
2868 On some machines, such as the Vax, this flag has no effect, because
2869 the standard calling sequence automatically handles the frame pointer
2870 and nothing is saved by pretending it doesn't exist.  The
2871 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
2872 whether a target machine supports this flag.  @xref{Registers,,Register
2873 Usage, gcc.info, Using and Porting GCC}.@refill
2874 @end ifclear
2876 @item -foptimize-sibling-calls
2877 Optimize sibling and tail recursive calls.
2879 @item -ftrapv
2880 This option generates traps for signed overflow on addition, subtraction,
2881 multiplication operations.
2883 @item -fno-inline
2884 Don't pay attention to the @code{inline} keyword.  Normally this option
2885 is used to keep the compiler from expanding any functions inline.
2886 Note that if you are not optimizing, no functions can be expanded inline.
2888 @item -finline-functions
2889 Integrate all simple functions into their callers.  The compiler
2890 heuristically decides which functions are simple enough to be worth
2891 integrating in this way.
2893 If all calls to a given function are integrated, and the function is
2894 declared @code{static}, then the function is normally not output as
2895 assembler code in its own right.
2897 @item -finline-limit=@var{n}
2898 By default, gcc limits the size of functions that can be inlined.  This flag
2899 allows the control of this limit for functions that are explicitly marked as
2900 inline (ie marked with the inline keyword or defined within the class 
2901 definition in c++).  @var{n} is the size of functions that can be inlined in 
2902 number of pseudo instructions (not counting parameter handling).  The default
2903 value of n is 10000.  Increasing this value can result in more inlined code at
2904 the cost of compilation time and memory consumption.  Decreasing usually makes
2905 the compilation faster and less code will be inlined (which presumably 
2906 means slower programs).  This option is particularly useful for programs that 
2907 use inlining heavily such as those based on recursive templates with c++.
2909 @emph{Note:} pseudo instruction represents, in this particular context, an
2910 abstract measurement of function's size.  In no way, it represents a count
2911 of assembly instructions and as such its exact meaning might change from one
2912 release to an another.
2914 @item -fkeep-inline-functions
2915 Even if all calls to a given function are integrated, and the function
2916 is declared @code{static}, nevertheless output a separate run-time
2917 callable version of the function.  This switch does not affect
2918 @code{extern inline} functions.
2920 @item -fkeep-static-consts
2921 Emit variables declared @code{static const} when optimization isn't turned
2922 on, even if the variables aren't referenced.
2924 GCC enables this option by default.  If you want to force the compiler to
2925 check if the variable was referenced, regardless of whether or not
2926 optimization is turned on, use the @samp{-fno-keep-static-consts} option.
2928 @item -fno-function-cse
2929 Do not put function addresses in registers; make each instruction that
2930 calls a constant function contain the function's address explicitly.
2932 This option results in less efficient code, but some strange hacks
2933 that alter the assembler output may be confused by the optimizations
2934 performed when this option is not used.
2936 @item -ffast-math
2937 This option allows GCC to violate some ISO or IEEE rules and/or
2938 specifications in the interest of optimizing code for speed.  For
2939 example, it allows the compiler to assume arguments to the @code{sqrt}
2940 function are non-negative numbers and that no floating-point values
2941 are NaNs.
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 The default is @samp{-fmath-errno}.  The @samp{-ffast-math} option
2955 sets @samp{-fno-math-errno}.
2956 @end table
2958 @c following causes underfulls.. they don't look great, but we deal.
2959 @c --mew 26jan93
2960 The following options control specific optimizations.  The @samp{-O2}
2961 option turns on all of these optimizations except @samp{-funroll-loops}
2962 and @samp{-funroll-all-loops}.  On most machines, the @samp{-O} option
2963 turns on the @samp{-fthread-jumps} and @samp{-fdelayed-branch} options,
2964 but specific machines may handle it differently.
2966 You can use the following flags in the rare cases when ``fine-tuning''
2967 of optimizations to be performed is desired.
2969 @table @gcctabopt
2970 @item -fstrength-reduce
2971 Perform the optimizations of loop strength reduction and
2972 elimination of iteration variables.
2974 @item -fthread-jumps
2975 Perform optimizations where we check to see if a jump branches to a
2976 location where another comparison subsumed by the first is found.  If
2977 so, the first branch is redirected to either the destination of the
2978 second branch or a point immediately following it, depending on whether
2979 the condition is known to be true or false.
2981 @item -fcse-follow-jumps
2982 In common subexpression elimination, scan through jump instructions
2983 when the target of the jump is not reached by any other path.  For
2984 example, when CSE encounters an @code{if} statement with an
2985 @code{else} clause, CSE will follow the jump when the condition
2986 tested is false.
2988 @item -fcse-skip-blocks
2989 This is similar to @samp{-fcse-follow-jumps}, but causes CSE to
2990 follow jumps which conditionally skip over blocks.  When CSE
2991 encounters a simple @code{if} statement with no else clause,
2992 @samp{-fcse-skip-blocks} causes CSE to follow the jump around the
2993 body of the @code{if}.
2995 @item -frerun-cse-after-loop
2996 Re-run common subexpression elimination after loop optimizations has been
2997 performed.
2999 @item -frerun-loop-opt
3000 Run the loop optimizer twice.
3002 @item -fgcse
3003 Perform a global common subexpression elimination pass.
3004 This pass also performs global constant and copy propagation.
3006 @item -fdelete-null-pointer-checks
3007 Use global dataflow analysis to identify and eliminate useless null
3008 pointer checks.  Programs which rely on NULL pointer dereferences @emph{not}
3009 halting the program may not work properly with this option.  Use
3010 -fno-delete-null-pointer-checks to disable this optimizing for programs
3011 which depend on that behavior.
3013 @item -fexpensive-optimizations
3014 Perform a number of minor optimizations that are relatively expensive.
3016 @item -foptimize-register-move
3017 @itemx -fregmove
3018 Attempt to reassign register numbers in move instructions and as
3019 operands of other simple instructions in order to maximize the amount of
3020 register tying.  This is especially helpful on machines with two-operand
3021 instructions.  GCC enables this optimization by default with @samp{-O2}
3022 or higher.
3024 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
3025 optimization.
3027 @item -fdelayed-branch
3028 If supported for the target machine, attempt to reorder instructions
3029 to exploit instruction slots available after delayed branch
3030 instructions.
3032 @item -fschedule-insns
3033 If supported for the target machine, attempt to reorder instructions to
3034 eliminate execution stalls due to required data being unavailable.  This
3035 helps machines that have slow floating point or memory load instructions
3036 by allowing other instructions to be issued until the result of the load
3037 or floating point instruction is required.
3039 @item -fschedule-insns2
3040 Similar to @samp{-fschedule-insns}, but requests an additional pass of
3041 instruction scheduling after register allocation has been done.  This is
3042 especially useful on machines with a relatively small number of
3043 registers and where memory load instructions take more than one cycle.
3045 @item -ffunction-sections
3046 @itemx -fdata-sections
3047 Place each function or data item into its own section in the output
3048 file if the target supports arbitrary sections.  The name of the
3049 function or the name of the data item determines the section's name
3050 in the output file.
3052 Use these options on systems where the linker can perform optimizations
3053 to improve locality of reference in the instruction space.  HPPA
3054 processors running HP-UX and Sparc processors running Solaris 2 have
3055 linkers with such optimizations.  Other systems using the ELF object format
3056 as well as AIX may have these optimizations in the future.
3058 Only use these options when there are significant benefits from doing
3059 so.  When you specify these options, the assembler and linker will
3060 create larger object and executable files and will also be slower.
3061 You will not be able to use @code{gprof} on all systems if you
3062 specify this option and you may have problems with debugging if
3063 you specify both this option and @samp{-g}.
3065 @item -fcaller-saves
3066 Enable values to be allocated in registers that will be clobbered by
3067 function calls, by emitting extra instructions to save and restore the
3068 registers around such calls.  Such allocation is done only when it
3069 seems to result in better code than would otherwise be produced.
3071 This option is always enabled by default on certain machines, usually
3072 those which have no call-preserved registers to use instead.
3074 For all machines, optimization level 2 and higher enables this flag by
3075 default.
3077 @item -funroll-loops
3078 Perform the optimization of loop unrolling.  This is only done for loops
3079 whose number of iterations can be determined at compile time or run time.
3080 @samp{-funroll-loops} implies both @samp{-fstrength-reduce} and
3081 @samp{-frerun-cse-after-loop}.
3083 @item -funroll-all-loops
3084 Perform the optimization of loop unrolling.  This is done for all loops
3085 and usually makes programs run more slowly.  @samp{-funroll-all-loops}
3086 implies @samp{-fstrength-reduce} as well as @samp{-frerun-cse-after-loop}.
3088 @item -fmove-all-movables
3089 Forces all invariant computations in loops to be moved
3090 outside the loop.
3092 @item -freduce-all-givs
3093 Forces all general-induction variables in loops to be
3094 strength-reduced.
3096 @emph{Note:} When compiling programs written in Fortran,
3097 @samp{-fmove-all-movables} and @samp{-freduce-all-givs} are enabled
3098 by default when you use the optimizer.
3100 These options may generate better or worse code; results are highly
3101 dependent on the structure of loops within the source code.
3103 These two options are intended to be removed someday, once
3104 they have helped determine the efficacy of various
3105 approaches to improving loop optimizations.
3107 Please let us (@w{@email{gcc@@gcc.gnu.org}} and @w{@email{fortran@@gnu.org}})
3108 know how use of these options affects
3109 the performance of your production code.
3110 We're very interested in code that runs @emph{slower}
3111 when these options are @emph{enabled}.
3113 @item -fno-peephole
3114 Disable any machine-specific peephole optimizations.
3116 @item -fbranch-probabilities
3117 After running a program compiled with @samp{-fprofile-arcs}
3118 (@pxref{Debugging Options,, Options for Debugging Your Program or
3119 @command{gcc}}), you can compile it a second time using
3120 @samp{-fbranch-probabilities}, to improve optimizations based on
3121 guessing the path a branch might take.
3123 @ifset INTERNALS
3124 With @samp{-fbranch-probabilities}, GCC puts a @samp{REG_EXEC_COUNT}
3125 note on the first instruction of each basic block, and a
3126 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
3127 These can be used to improve optimization.  Currently, they are only
3128 used in one place: in @file{reorg.c}, instead of guessing which path a
3129 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
3130 exactly determine which path is taken more often.
3131 @end ifset
3133 @item -fno-guess-branch-probability
3134 Sometimes gcc will opt to guess branch probabilities when none are
3135 available from either profile directed feedback (@samp{-fprofile-arcs})
3136 or @samp{__builtin_expect}.  In a hard real-time system, people don't
3137 want different runs of the compiler to produce code that has different
3138 behavior; minimizing non-determinism is of paramount import.  This
3139 switch allows users to reduce non-determinism, possibly at the expense
3140 of inferior optimization.
3142 @item -fstrict-aliasing
3143 Allows the compiler to assume the strictest aliasing rules applicable to
3144 the language being compiled.  For C (and C++), this activates
3145 optimizations based on the type of expressions.  In particular, an
3146 object of one type is assumed never to reside at the same address as an
3147 object of a different type, unless the types are almost the same.  For
3148 example, an @code{unsigned int} can alias an @code{int}, but not a
3149 @code{void*} or a @code{double}.  A character type may alias any other
3150 type.  
3152 Pay special attention to code like this:
3153 @example
3154 union a_union @{ 
3155   int i;
3156   double d;
3159 int f() @{
3160   a_union t;
3161   t.d = 3.0;
3162   return t.i;
3164 @end example
3165 The practice of reading from a different union member than the one most
3166 recently written to (called ``type-punning'') is common.  Even with
3167 @samp{-fstrict-aliasing}, type-punning is allowed, provided the memory
3168 is accessed through the union type.  So, the code above will work as
3169 expected.  However, this code might not:
3170 @example
3171 int f() @{ 
3172   a_union t;
3173   int* ip;
3174   t.d = 3.0;
3175   ip = &t.i;
3176   return *ip;
3178 @end example
3180 @ifset INTERNALS
3181 Every language that wishes to perform language-specific alias analysis
3182 should define a function that computes, given an @code{tree}
3183 node, an alias set for the node.  Nodes in different alias sets are not
3184 allowed to alias.  For an example, see the C front-end function
3185 @code{c_get_alias_set}.
3186 @end ifset
3188 @item -falign-functions
3189 @itemx -falign-functions=@var{n}
3190 Align the start of functions to the next power-of-two greater than
3191 @var{n}, skipping up to @var{n} bytes.  For instance,
3192 @samp{-falign-functions=32} aligns functions to the next 32-byte
3193 boundary, but @samp{-falign-functions=24} would align to the next
3194 32-byte boundary only if this can be done by skipping 23 bytes or less.
3196 @samp{-fno-align-functions} and @samp{-falign-functions=1} are
3197 equivalent and mean that functions will not be aligned.
3199 Some assemblers only support this flag when @var{n} is a power of two;
3200 in that case, it is rounded up.
3202 If @var{n} is not specified, use a machine-dependent default.
3204 @item -falign-labels
3205 @itemx -falign-labels=@var{n}
3206 Align all branch targets to a power-of-two boundary, skipping up to
3207 @var{n} bytes like @samp{-falign-functions}.  This option can easily
3208 make code slower, because it must insert dummy operations for when the
3209 branch target is reached in the usual flow of the code.
3211 If @samp{-falign-loops} or @samp{-falign-jumps} are applicable and
3212 are greater than this value, then their values are used instead.
3214 If @var{n} is not specified, use a machine-dependent default which is
3215 very likely to be @samp{1}, meaning no alignment.
3217 @item -falign-loops
3218 @itemx -falign-loops=@var{n}
3219 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
3220 like @samp{-falign-functions}.  The hope is that the loop will be
3221 executed many times, which will make up for any execution of the dummy
3222 operations.
3224 If @var{n} is not specified, use a machine-dependent default.
3226 @item -falign-jumps
3227 @itemx -falign-jumps=@var{n}
3228 Align branch targets to a power-of-two boundary, for branch targets
3229 where the targets can only be reached by jumping, skipping up to @var{n}
3230 bytes like @samp{-falign-functions}.  In this case, no dummy operations
3231 need be executed.
3233 If @var{n} is not specified, use a machine-dependent default.
3235 @item -fssa
3236 Perform optimizations in static single assignment form.  Each function's
3237 flow graph is translated into SSA form, optimizations are performed, and
3238 the flow graph is translated back from SSA form.  User's should not
3239 specify this option, since it is not yet ready for production use.
3241 @item -fdce
3242 Perform dead-code elimination in SSA form.  Requires @samp{-fssa}.  Like
3243 @samp{-fssa}, this is an experimental feature.
3245 @item -fsingle-precision-constant
3246 Treat floating point constant as single precision constant instead of
3247 implicitly converting it to double precision constant.
3249 @item -frename-registers
3250 Attempt to avoid false dependancies in scheduled code by making use
3251 of registers left over after register allocation.  This optimization
3252 will most benefit processors with lots of registers.  It can, however,
3253 make debugging impossible, since variables will no longer stay in
3254 a ``home register''.
3256 @item --param @var{name}=@var{value}
3257 In some places, GCC uses various constants to control the amount of
3258 optimization that is done.  For example, GCC will not inline functions
3259 that contain more that a certain number of instructions.  You can
3260 control some of these constants on the command-line using the
3261 @samp{--param} option.  
3263 In each case, the @var{value} is a integer.  The allowable choices for
3264 @var{name} are given in the following table:
3266 @table @gcctabopt
3267 @item max-inline-insns
3268 If an function contains more than this many instructions, it
3269 will not be inlined.  This option is precisely equivalent to
3270 @samp{-finline-limit}.
3271 @end table
3273 @end table
3275 @node Preprocessor Options
3276 @section Options Controlling the Preprocessor
3277 @cindex preprocessor options
3278 @cindex options, preprocessor
3280 These options control the C preprocessor, which is run on each C source
3281 file before actual compilation.
3283 If you use the @samp{-E} option, nothing is done except preprocessing.
3284 Some of these options make sense only together with @samp{-E} because
3285 they cause the preprocessor output to be unsuitable for actual
3286 compilation.
3288 @table @gcctabopt
3289 @item -include @var{file}
3290 Process @var{file} as input before processing the regular input file.
3291 In effect, the contents of @var{file} are compiled first.  Any @samp{-D}
3292 and @samp{-U} options on the command line are always processed before
3293 @samp{-include @var{file}}, regardless of the order in which they are
3294 written.  All the @samp{-include} and @samp{-imacros} options are
3295 processed in the order in which they are written.
3297 @item -imacros @var{file}
3298 Process @var{file} as input, discarding the resulting output, before
3299 processing the regular input file.  Because the output generated from
3300 @var{file} is discarded, the only effect of @samp{-imacros @var{file}}
3301 is to make the macros defined in @var{file} available for use in the
3302 main input.  All the @samp{-include} and @samp{-imacros} options are
3303 processed in the order in which they are written.
3305 @item -idirafter @var{dir}
3306 @cindex second include path
3307 Add the directory @var{dir} to the second include path.  The directories
3308 on the second include path are searched when a header file is not found
3309 in any of the directories in the main include path (the one that
3310 @samp{-I} adds to).
3312 @item -iprefix @var{prefix}
3313 Specify @var{prefix} as the prefix for subsequent @samp{-iwithprefix}
3314 options.
3316 @item -iwithprefix @var{dir}
3317 Add a directory to the second include path.  The directory's name is
3318 made by concatenating @var{prefix} and @var{dir}, where @var{prefix} was
3319 specified previously with @samp{-iprefix}.  If you have not specified a
3320 prefix yet, the directory containing the installed passes of the
3321 compiler is used as the default.
3323 @item -iwithprefixbefore @var{dir}
3324 Add a directory to the main include path.  The directory's name is made
3325 by concatenating @var{prefix} and @var{dir}, as in the case of
3326 @samp{-iwithprefix}.
3328 @item -isystem @var{dir}
3329 Add a directory to the beginning of the second include path, marking it
3330 as a system directory, so that it gets the same special treatment as
3331 is applied to the standard system directories.
3333 @item -nostdinc
3334 Do not search the standard system directories for header files.  Only
3335 the directories you have specified with @samp{-I} options (and the
3336 current directory, if appropriate) are searched.  @xref{Directory
3337 Options}, for information on @samp{-I}.
3339 By using both @samp{-nostdinc} and @samp{-I-}, you can limit the include-file
3340 search path to only those directories you specify explicitly.
3342 @item -remap
3343 @findex -remap
3344 When searching for a header file in a directory, remap file names if a
3345 file named @file{header.gcc} exists in that directory.  This can be used
3346 to work around limitations of file systems with file name restrictions.
3347 The @file{header.gcc} file should contain a series of lines with two
3348 tokens on each line: the first token is the name to map, and the second
3349 token is the actual name to use.
3351 @item -undef
3352 Do not predefine any nonstandard macros.  (Including architecture flags).
3354 @item -E
3355 Run only the C preprocessor.  Preprocess all the C source files
3356 specified and output the results to standard output or to the
3357 specified output file.
3359 @item -C
3360 Tell the preprocessor not to discard comments.  Used with the
3361 @samp{-E} option.
3363 @item -P
3364 Tell the preprocessor not to generate @samp{#line} directives.
3365 Used with the @samp{-E} option.
3367 @cindex make
3368 @cindex dependencies, make
3369 @item -M
3370 @findex -M
3371 Instead of outputting the result of preprocessing, output a rule
3372 suitable for @code{make} describing the dependencies of the main source
3373 file.  The preprocessor outputs one @code{make} rule containing the
3374 object file name for that source file, a colon, and the names of all the
3375 included files.  Unless overridden explicitly, the object file name
3376 consists of the basename of the source file with any suffix replaced with
3377 object file suffix. If there are many included files then the
3378 rule is split into several lines using @samp{\}-newline.
3380 @samp{-M} implies @samp{-E}.
3382 @item -MM
3383 @findex -MM
3384 Like @samp{-M}, but mention only the files included with @samp{#include
3385 "@var{file}"}.  System header files included with @samp{#include
3386 <@var{file}>} are omitted.
3388 @item -MD
3389 @findex -MD
3390 Like @samp{-M} but the dependency information is written to a file
3391 rather than stdout.  @code{gcc} will use the same file name and
3392 directory as the object file, but with the suffix ".d" instead.
3394 This is in addition to compiling the main file as specified ---
3395 @samp{-MD} does not inhibit ordinary compilation the way @samp{-M} does,
3396 unless you also specify @samp{-MG}.
3398 With Mach, you can use the utility @code{md} to merge multiple
3399 dependency files into a single dependency file suitable for using with
3400 the @samp{make} command.
3402 @item -MMD
3403 @findex -MMD
3404 Like @samp{-MD} except mention only user header files, not system
3405 -header files.
3407 @item -MF @var{file}
3408 @findex -MF
3409 When used with @samp{-M} or @samp{-MM}, specifies a file to write the
3410 dependencies to.  This allows the preprocessor to write the preprocessed
3411 file to stdout normally.  If no @samp{-MF} switch is given, CPP sends
3412 the rules to stdout and suppresses normal preprocessed output.
3414 Another way to specify output of a @code{make} rule is by setting
3415 the environment variable @env{DEPENDENCIES_OUTPUT} (@pxref{Environment
3416 Variables}).
3418 @item -MG
3419 @findex -MG
3420 When used with @samp{-M} or @samp{-MM}, @samp{-MG} says to treat missing
3421 header files as generated files and assume they live in the same
3422 directory as the source file.  It suppresses preprocessed output, as a
3423 missing header file is ordinarily an error.
3425 This feature is used in automatic updating of makefiles.
3427 @item -MP
3428 @findex -MP
3429 This option instructs CPP to add a phony target for each dependency
3430 other than the main file, causing each to depend on nothing.  These
3431 dummy rules work around errors @code{make} gives if you remove header
3432 files without updating the @code{Makefile} to match.
3434 This is typical output:-
3436 @smallexample
3437 /tmp/test.o: /tmp/test.c /tmp/test.h
3439 /tmp/test.h:
3440 @end smallexample
3442 @item -MQ @var{target}
3443 @item -MT @var{target}
3444 @findex -MQ
3445 @findex -MT
3446 By default CPP uses the main file name, including any path, and appends
3447 the object suffix, normally ``.o'', to it to obtain the name of the
3448 target for dependency generation.  With @samp{-MT} you can specify a
3449 target yourself, overriding the default one.
3451 If you want multiple targets, you can specify them as a single argument
3452 to @samp{-MT}, or use multiple @samp{-MT} options.
3454 The targets you specify are output in the order they appear on the
3455 command line.  @samp{-MQ} is identical to @samp{-MT}, except that the
3456 target name is quoted for Make, but with @samp{-MT} it isn't.  For
3457 example, -MT '$(objpfx)foo.o' gives
3459 @smallexample
3460 $(objpfx)foo.o: /tmp/foo.c
3461 @end smallexample
3463 but -MQ '$(objpfx)foo.o' gives
3465 @smallexample
3466 $$(objpfx)foo.o: /tmp/foo.c
3467 @end smallexample
3469 The default target is automatically quoted, as if it were given with
3470 @samp{-MQ}.
3472 @item -H
3473 Print the name of each header file used, in addition to other normal
3474 activities.
3476 @item -A@var{question}(@var{answer})
3477 Assert the answer @var{answer} for @var{question}, in case it is tested
3478 with a preprocessing conditional such as @samp{#if
3479 #@var{question}(@var{answer})}.  @samp{-A-} disables the standard
3480 assertions that normally describe the target machine.
3482 @item -D@var{macro}
3483 Define macro @var{macro} with the string @samp{1} as its definition.
3485 @item -D@var{macro}=@var{defn}
3486 Define macro @var{macro} as @var{defn}.  All instances of @samp{-D} on
3487 the command line are processed before any @samp{-U} options.
3489 Any @samp{-D} and @samp{-U} options on the command line are processed in
3490 order, and always before @samp{-imacros @var{file}}, regardless of the
3491 order in which they are written.
3493 @item -U@var{macro}
3494 Undefine macro @var{macro}.  @samp{-U} options are evaluated after all
3495 @samp{-D} options, but before any @samp{-include} and @samp{-imacros}
3496 options.
3498 Any @samp{-D} and @samp{-U} options on the command line are processed in
3499 order, and always before @samp{-imacros @var{file}}, regardless of the
3500 order in which they are written.
3502 @item -dM
3503 Tell the preprocessor to output only a list of the macro definitions
3504 that are in effect at the end of preprocessing.  Used with the @samp{-E}
3505 option.
3507 @item -dD
3508 Tell the preprocessing to pass all macro definitions into the output, in
3509 their proper sequence in the rest of the output.
3511 @item -dN
3512 Like @samp{-dD} except that the macro arguments and contents are omitted.
3513 Only @samp{#define @var{name}} is included in the output.
3515 @item -dI
3516 @findex -dI
3517 Output @samp{#include} directives in addition to the result of
3518 preprocessing.
3520 @item -trigraphs
3521 @findex -trigraphs
3522 Process ISO standard trigraph sequences.  These are three-character
3523 sequences, all starting with @samp{??}, that are defined by ISO C to
3524 stand for single characters.  For example, @samp{??/} stands for
3525 @samp{\}, so @samp{'??/n'} is a character constant for a newline.  By
3526 default, GCC ignores trigraphs, but in standard-conforming modes it
3527 converts them.  See the @samp{-std} and @samp{-ansi} options.
3529 The nine trigraph sequences are
3530 @table @samp
3531 @item ??(
3532 -> @samp{[}
3534 @item ??)
3535 -> @samp{]}
3537 @item ??<
3538 -> @samp{@{}
3540 @item ??>
3541 -> @samp{@}}
3543 @item ??=
3544 -> @samp{#}
3546 @item ??/
3547 -> @samp{\}
3549 @item ??'
3550 -> @samp{^}
3552 @item ??!
3553 -> @samp{|}
3555 @item ??-
3556 -> @samp{~}
3558 @end table
3560 Trigraph support is not popular, so many compilers do not implement it
3561 properly.  Portable code should not rely on trigraphs being either
3562 converted or ignored.
3564 @item -Wp\,@var{option}
3565 Pass @var{option} as an option to the preprocessor.  If @var{option}
3566 contains commas, it is split into multiple options at the commas.
3567 @end table
3569 @node Assembler Options
3570 @section Passing Options to the Assembler
3572 @c prevent bad page break with this line
3573 You can pass options to the assembler.
3575 @table @gcctabopt
3576 @item -Wa\,@var{option}
3577 Pass @var{option} as an option to the assembler.  If @var{option}
3578 contains commas, it is split into multiple options at the commas.
3579 @end table
3581 @node Link Options
3582 @section Options for Linking
3583 @cindex link options
3584 @cindex options, linking
3586 These options come into play when the compiler links object files into
3587 an executable output file.  They are meaningless if the compiler is
3588 not doing a link step.
3590 @table @gcctabopt
3591 @cindex file names
3592 @item @var{object-file-name}
3593 A file name that does not end in a special recognized suffix is
3594 considered to name an object file or library.  (Object files are
3595 distinguished from libraries by the linker according to the file
3596 contents.)  If linking is done, these object files are used as input
3597 to the linker.
3599 @item -c
3600 @itemx -S
3601 @itemx -E
3602 If any of these options is used, then the linker is not run, and
3603 object file names should not be used as arguments.  @xref{Overall
3604 Options}.
3606 @cindex Libraries
3607 @item -l@var{library}
3608 Search the library named @var{library} when linking.
3610 It makes a difference where in the command you write this option; the
3611 linker searches processes libraries and object files in the order they
3612 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
3613 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
3614 to functions in @samp{z}, those functions may not be loaded.
3616 The linker searches a standard list of directories for the library,
3617 which is actually a file named @file{lib@var{library}.a}.  The linker
3618 then uses this file as if it had been specified precisely by name.
3620 The directories searched include several standard system directories
3621 plus any that you specify with @samp{-L}.
3623 Normally the files found this way are library files---archive files
3624 whose members are object files.  The linker handles an archive file by
3625 scanning through it for members which define symbols that have so far
3626 been referenced but not defined.  But if the file that is found is an
3627 ordinary object file, it is linked in the usual fashion.  The only
3628 difference between using an @samp{-l} option and specifying a file name
3629 is that @samp{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
3630 and searches several directories.
3632 @item -lobjc
3633 You need this special case of the @samp{-l} option in order to
3634 link an Objective C program.
3636 @item -nostartfiles
3637 Do not use the standard system startup files when linking.
3638 The standard system libraries are used normally, unless @option{-nostdlib}
3639 or @option{-nodefaultlibs} is used.
3641 @item -nodefaultlibs
3642 Do not use the standard system libraries when linking.
3643 Only the libraries you specify will be passed to the linker.
3644 The standard startup files are used normally, unless @option{-nostartfiles}
3645 is used.  The compiler may generate calls to memcmp, memset, and memcpy
3646 for System V (and ISO C) environments or to bcopy and bzero for
3647 BSD environments.  These entries are usually resolved by entries in
3648 libc.  These entry points should be supplied through some other
3649 mechanism when this option is specified.
3651 @item -nostdlib
3652 Do not use the standard system startup files or libraries when linking.
3653 No startup files and only the libraries you specify will be passed to
3654 the linker. The compiler may generate calls to memcmp, memset, and memcpy
3655 for System V (and ISO C) environments or to bcopy and bzero for
3656 BSD environments.  These entries are usually resolved by entries in
3657 libc.  These entry points should be supplied through some other
3658 mechanism when this option is specified.
3660 @cindex @code{-lgcc}, use with @code{-nostdlib}
3661 @cindex @code{-nostdlib} and unresolved references
3662 @cindex unresolved references and @code{-nostdlib}
3663 @cindex @code{-lgcc}, use with @code{-nodefaultlibs}
3664 @cindex @code{-nodefaultlibs} and unresolved references
3665 @cindex unresolved references and @code{-nodefaultlibs}
3666 One of the standard libraries bypassed by @samp{-nostdlib} and
3667 @samp{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
3668 that GCC uses to overcome shortcomings of particular machines, or special
3669 needs for some languages.
3670 @ifset INTERNALS
3671 (@xref{Interface,,Interfacing to GCC Output}, for more discussion of
3672 @file{libgcc.a}.)
3673 @end ifset
3674 @ifclear INTERNALS
3675 (@xref{Interface,,Interfacing to GCC Output,gcc.info,Porting GCC},
3676 for more discussion of @file{libgcc.a}.)
3677 @end ifclear
3678 In most cases, you need @file{libgcc.a} even when you want to avoid
3679 other standard libraries.  In other words, when you specify @samp{-nostdlib}
3680 or @samp{-nodefaultlibs} you should usually specify @samp{-lgcc} as well.
3681 This ensures that you have no unresolved references to internal GCC
3682 library subroutines.  (For example, @samp{__main}, used to ensure C++
3683 constructors will be called; @pxref{Collect2,,@command{collect2}}.)
3685 @item -s
3686 Remove all symbol table and relocation information from the executable.
3688 @item -static
3689 On systems that support dynamic linking, this prevents linking with the shared
3690 libraries.  On other systems, this option has no effect.
3692 @item -shared
3693 Produce a shared object which can then be linked with other objects to
3694 form an executable.  Not all systems support this option.  For predictable
3695 results, you must also specify the same set of options that were used to 
3696 generate code (@samp{-fpic}, @samp{-fPIC}, or model suboptions)
3697 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
3698 needs to build supplementary stub code for constructors to work. On
3699 multi-libbed systems, @samp{gcc -shared} must select the correct support
3700 libraries to link against.  Failing to supply the correct flags may lead
3701 to subtle defects. Supplying them in cases where they are not necessary
3702 is innocuous.}
3704 @item -shared-libgcc
3705 @itemx -static-libgcc
3706 On systems that provide @file{libgcc} as a shared library, these options
3707 force the use of either the shared or static version respectively.
3708 If no shared version of @file{libgcc} was built when the compiler was
3709 configured, these options have no effect.
3711 There are several situations in which an application should use the
3712 shared @file{libgcc} instead of the static version.  The most common
3713 of these is when the application wishes to throw and catch exceptions
3714 across different shared libraries.  In that case, each of the libraries
3715 as well as the application itself should use the shared @file{libgcc}.
3717 Therefore, whenever you specify the @samp{-shared} option, the GCC
3718 driver automatically adds @samp{-shared-libgcc}, unless you explicitly
3719 specify @samp{-static-libgcc}.  The G++ driver automatically adds
3720 @samp{-shared-libgcc} when you build a main executable as well because
3721 for C++ programs that is typically the right thing to do.
3722 (Exception-handling will not work reliably otherwise.)
3724 However, when linking a main executable written in C, you must
3725 explicitly say @samp{-shared-libgcc} if you want to use the shared
3726 @file{libgcc}.
3728 @item -symbolic
3729 Bind references to global symbols when building a shared object.  Warn
3730 about any unresolved references (unless overridden by the link editor
3731 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
3732 this option.
3734 @item -Xlinker @var{option}
3735 Pass @var{option} as an option to the linker.  You can use this to
3736 supply system-specific linker options which GCC does not know how to
3737 recognize.
3739 If you want to pass an option that takes an argument, you must use
3740 @samp{-Xlinker} twice, once for the option and once for the argument.
3741 For example, to pass @samp{-assert definitions}, you must write
3742 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
3743 @samp{-Xlinker "-assert definitions"}, because this passes the entire
3744 string as a single argument, which is not what the linker expects.
3746 @item -Wl\,@var{option}
3747 Pass @var{option} as an option to the linker.  If @var{option} contains
3748 commas, it is split into multiple options at the commas.
3750 @item -u @var{symbol}
3751 Pretend the symbol @var{symbol} is undefined, to force linking of
3752 library modules to define it.  You can use @samp{-u} multiple times with
3753 different symbols to force loading of additional library modules.
3754 @end table
3756 @node Directory Options
3757 @section Options for Directory Search
3758 @cindex directory options
3759 @cindex options, directory search
3760 @cindex search path
3762 These options specify directories to search for header files, for
3763 libraries and for parts of the compiler:
3765 @table @gcctabopt
3766 @item -I@var{dir}
3767 Add the directory @var{dir} to the head of the list of directories to be
3768 searched for header files.  This can be used to override a system header
3769 file, substituting your own version, since these directories are
3770 searched before the system header file directories.  However, you should
3771 not use this option to add directories that contain vendor-supplied
3772 system header files (use @samp{-isystem} for that). If you use more than
3773 one @samp{-I} option, the directories are scanned in left-to-right
3774 order; the standard system directories come after.
3776 @item -I-
3777 Any directories you specify with @samp{-I} options before the @samp{-I-}
3778 option are searched only for the case of @samp{#include "@var{file}"};
3779 they are not searched for @samp{#include <@var{file}>}.
3781 If additional directories are specified with @samp{-I} options after
3782 the @samp{-I-}, these directories are searched for all @samp{#include}
3783 directives.  (Ordinarily @emph{all} @samp{-I} directories are used
3784 this way.)
3786 In addition, the @samp{-I-} option inhibits the use of the current
3787 directory (where the current input file came from) as the first search
3788 directory for @samp{#include "@var{file}"}.  There is no way to
3789 override this effect of @samp{-I-}.  With @samp{-I.} you can specify
3790 searching the directory which was current when the compiler was
3791 invoked.  That is not exactly the same as what the preprocessor does
3792 by default, but it is often satisfactory.
3794 @samp{-I-} does not inhibit the use of the standard system directories
3795 for header files.  Thus, @samp{-I-} and @samp{-nostdinc} are
3796 independent.
3798 @item -L@var{dir}
3799 Add directory @var{dir} to the list of directories to be searched
3800 for @samp{-l}.
3802 @item -B@var{prefix}
3803 This option specifies where to find the executables, libraries,
3804 include files, and data files of the compiler itself.
3806 The compiler driver program runs one or more of the subprograms
3807 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
3808 @var{prefix} as a prefix for each program it tries to run, both with and
3809 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
3811 For each subprogram to be run, the compiler driver first tries the
3812 @samp{-B} prefix, if any.  If that name is not found, or if @samp{-B}
3813 was not specified, the driver tries two standard prefixes, which are
3814 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc-lib/}.  If neither of
3815 those results in a file name that is found, the unmodified program
3816 name is searched for using the directories specified in your
3817 @env{PATH} environment variable.
3819 @samp{-B} prefixes that effectively specify directory names also apply
3820 to libraries in the linker, because the compiler translates these
3821 options into @samp{-L} options for the linker.  They also apply to
3822 includes files in the preprocessor, because the compiler translates these
3823 options into @samp{-isystem} options for the preprocessor.  In this case,
3824 the compiler appends @samp{include} to the prefix.
3826 The run-time support file @file{libgcc.a} can also be searched for using
3827 the @samp{-B} prefix, if needed.  If it is not found there, the two
3828 standard prefixes above are tried, and that is all.  The file is left
3829 out of the link if it is not found by those means.
3831 Another way to specify a prefix much like the @samp{-B} prefix is to use
3832 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
3833 Variables}.
3835 @item -specs=@var{file}
3836 Process @var{file} after the compiler reads in the standard @file{specs}
3837 file, in order to override the defaults that the @file{gcc} driver
3838 program uses when determining what switches to pass to @file{cc1},
3839 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
3840 @samp{-specs=}@var{file} can be specified on the command line, and they
3841 are processed in order, from left to right.
3842 @end table
3844 @c man end
3846 @node Spec Files
3847 @section Specifying subprocesses and the switches to pass to them
3848 @cindex Spec Files
3849 @command{gcc} is a driver program.  It performs its job by invoking a
3850 sequence of other programs to do the work of compiling, assembling and
3851 linking.  GCC interprets its command-line parameters and uses these to
3852 deduce which programs it should invoke, and which command-line options
3853 it ought to place on their command lines.  This behaviour is controlled
3854 by @dfn{spec strings}.  In most cases there is one spec string for each
3855 program that GCC can invoke, but a few programs have multiple spec
3856 strings to control their behaviour.  The spec strings built into GCC can
3857 be overridden by using the @samp{-specs=} command-line switch to specify
3858 a spec file.
3860 @dfn{Spec files} are plaintext files that are used to construct spec
3861 strings.  They consist of a sequence of directives separated by blank
3862 lines.  The type of directive is determined by the first non-whitespace
3863 character on the line and it can be one of the following:
3865 @table @code
3866 @item %@var{command}
3867 Issues a @var{command} to the spec file processor.  The commands that can
3868 appear here are: 
3870 @table @code
3871 @item %include <@var{file}>
3872 @cindex %include
3873 Search for @var{file} and insert its text at the current point in the
3874 specs file.
3876 @item %include_noerr <@var{file}>
3877 @cindex %include_noerr
3878 Just like @samp{%include}, but do not generate an error message if the include
3879 file cannot be found.
3881 @item %rename @var{old_name} @var{new_name}
3882 @cindex %rename
3883 Rename the spec string @var{old_name} to @var{new_name}.
3885 @end table
3887 @item *[@var{spec_name}]:
3888 This tells the compiler to create, override or delete the named spec
3889 string.  All lines after this directive up to the next directive or
3890 blank line are considered to be the text for the spec string.  If this
3891 results in an empty string then the spec will be deleted.  (Or, if the
3892 spec did not exist, then nothing will happened.)  Otherwise, if the spec
3893 does not currently exist a new spec will be created.  If the spec does
3894 exist then its contents will be overridden by the text of this
3895 directive, unless the first character of that text is the @samp{+}
3896 character, in which case the text will be appended to the spec.
3898 @item [@var{suffix}]:
3899 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
3900 and up to the next directive or blank line are considered to make up the
3901 spec string for the indicated suffix.  When the compiler encounters an 
3902 input file with the named suffix, it will processes the spec string in
3903 order to work out how to compile that file.  For example:
3905 @smallexample
3906 .ZZ:
3907 z-compile -input %i
3908 @end smallexample
3910 This says that any input file whose name ends in @samp{.ZZ} should be
3911 passed to the program @samp{z-compile}, which should be invoked with the
3912 command-line switch @samp{-input} and with the result of performing the
3913 @samp{%i} substitution.  (See below.)
3915 As an alternative to providing a spec string, the text that follows a
3916 suffix directive can be one of the following:
3918 @table @code
3919 @item @@@var{language}
3920 This says that the suffix is an alias for a known @var{language}.  This is
3921 similar to using the @option{-x} command-line switch to GCC to specify a
3922 language explicitly.  For example:
3924 @smallexample
3925 .ZZ:
3926 @@c++
3927 @end smallexample
3929 Says that .ZZ files are, in fact, C++ source files.
3931 @item #@var{name}
3932 This causes an error messages saying:
3934 @smallexample
3935 @var{name} compiler not installed on this system.
3936 @end smallexample
3937 @end table
3939 GCC already has an extensive list of suffixes built into it.
3940 This directive will add an entry to the end of the list of suffixes, but
3941 since the list is searched from the end backwards, it is effectively
3942 possible to override earlier entries using this technique.
3944 @end table
3946 GCC has the following spec strings built into it.  Spec files can
3947 override these strings or create their own.  Note that individual
3948 targets can also add their own spec strings to this list. 
3950 @smallexample
3951 asm          Options to pass to the assembler
3952 asm_final    Options to pass to the assembler post-processor
3953 cpp          Options to pass to the C preprocessor
3954 cc1          Options to pass to the C compiler
3955 cc1plus      Options to pass to the C++ compiler
3956 endfile      Object files to include at the end of the link
3957 link         Options to pass to the linker
3958 lib          Libraries to include on the command line to the linker
3959 libgcc       Decides which GCC support library to pass to the linker
3960 linker       Sets the name of the linker
3961 predefines   Defines to be passed to the C preprocessor
3962 signed_char  Defines to pass to CPP to say whether @code{char} is signed by default
3963 startfile    Object files to include at the start of the link
3964 @end smallexample
3966 Here is a small example of a spec file:
3968 @smallexample
3969 %rename lib                 old_lib
3971 *lib:
3972 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
3973 @end smallexample
3975 This example renames the spec called @samp{lib} to @samp{old_lib} and
3976 then overrides the previous definition of @samp{lib} with a new one.
3977 The new definition adds in some extra command-line options before
3978 including the text of the old definition.
3980 @dfn{Spec strings} are a list of command-line options to be passed to their
3981 corresponding program.  In addition, the spec strings can contain
3982 @samp{%}-prefixed sequences to substitute variable text or to
3983 conditionally insert text into the command line.  Using these constructs
3984 it is possible to generate quite complex command lines.
3986 Here is a table of all defined @samp{%}-sequences for spec
3987 strings.  Note that spaces are not generated automatically around the
3988 results of expanding these sequences.  Therefore you can concatenate them
3989 together or combine them with constant text in a single argument. 
3991 @table @code
3992 @item %%
3993 Substitute one @samp{%} into the program name or argument.
3995 @item %i
3996 Substitute the name of the input file being processed.
3998 @item %b
3999 Substitute the basename of the input file being processed.
4000 This is the substring up to (and not including) the last period
4001 and not including the directory.
4003 @item %B
4004 This is the same as @samp{%b}, but include the file suffix (text after
4005 the last period).
4007 @item %d
4008 Marks the argument containing or following the @samp{%d} as a
4009 temporary file name, so that that file will be deleted if GCC exits
4010 successfully.  Unlike @samp{%g}, this contributes no text to the
4011 argument. 
4013 @item %g@var{suffix}
4014 Substitute a file name that has suffix @var{suffix} and is chosen
4015 once per compilation, and mark the argument in the same way as
4016 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
4017 name is now chosen in a way that is hard to predict even when previously 
4018 chosen file names are known.  For example, @samp{%g.s ... %g.o ... %g.s}
4019 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
4020 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
4021 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
4022 was simply substituted with a file name chosen once per compilation,
4023 without regard to any appended suffix (which was therefore treated
4024 just like ordinary text), making such attacks more likely to succeed.
4026 @item %u@var{suffix}
4027 Like @samp{%g}, but generates a new temporary file name even if
4028 @samp{%u@var{suffix}} was already seen.
4030 @item %U@var{suffix}
4031 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
4032 new one if there is no such last file name.  In the absence of any
4033 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
4034 the same suffix @emph{space}, so @samp{%g.s ... %U.s ... %g.s ... %U.s}
4035 would involve the generation of two distinct file names, one
4036 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
4037 simply substituted with a file name chosen for the previous @samp{%u},
4038 without regard to any appended suffix.
4040 @item %j@var{SUFFIX}
4041 Substitutes the name of the HOST_BIT_BUCKET, if any, and if it is 
4042 writable, and if save-temps is off; otherwise, substitute the name
4043 of a temporary file, just like @samp{%u}.  This temporary file is not
4044 meant for communication between processes, but rather as a junk
4045 disposal mechanism.
4047 @item %.@var{SUFFIX}
4048 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
4049 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
4050 terminated by the next space or %.
4052 @item %w
4053 Marks the argument containing or following the @samp{%w} as the
4054 designated output file of this compilation.  This puts the argument
4055 into the sequence of arguments that @samp{%o} will substitute later.
4057 @item %o
4058 Substitutes the names of all the output files, with spaces
4059 automatically placed around them.  You should write spaces
4060 around the @samp{%o} as well or the results are undefined.
4061 @samp{%o} is for use in the specs for running the linker.
4062 Input files whose names have no recognized suffix are not compiled
4063 at all, but they are included among the output files, so they will
4064 be linked.
4066 @item %O
4067 Substitutes the suffix for object files.  Note that this is
4068 handled specially when it immediately follows @samp{%g, %u, or %U},
4069 because of the need for those to form complete file names.  The
4070 handling is such that @samp{%O} is treated exactly as if it had already
4071 been substituted, except that @samp{%g, %u, and %U} do not currently
4072 support additional @var{suffix} characters following @samp{%O} as they would
4073 following, for example, @samp{.o}.
4075 @item %p
4076 Substitutes the standard macro predefinitions for the
4077 current target machine.  Use this when running @code{cpp}.
4079 @item %P
4080 Like @samp{%p}, but puts @samp{__} before and after the name of each
4081 predefined macro, except for macros that start with @samp{__} or with
4082 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
4083 C.  
4085 @item %I
4086 Substitute a @samp{-iprefix} option made from GCC_EXEC_PREFIX.
4088 @item %s
4089 Current argument is the name of a library or startup file of some sort.
4090 Search for that file in a standard list of directories and substitute
4091 the full name found. 
4093 @item %e@var{str}
4094 Print @var{str} as an error message.  @var{str} is terminated by a newline.
4095 Use this when inconsistent options are detected.
4097 @item %|
4098 Output @samp{-} if the input for the current command is coming from a pipe.
4100 @item %(@var{name})
4101 Substitute the contents of spec string @var{name} at this point.
4103 @item %[@var{name}]
4104 Like @samp{%(...)} but put @samp{__} around @samp{-D} arguments.
4106 @item %x@{@var{option}@}
4107 Accumulate an option for @samp{%X}.
4109 @item %X
4110 Output the accumulated linker options specified by @samp{-Wl} or a @samp{%x}
4111 spec string.
4113 @item %Y
4114 Output the accumulated assembler options specified by @samp{-Wa}.
4116 @item %Z
4117 Output the accumulated preprocessor options specified by @samp{-Wp}.
4119 @item %v1
4120 Substitute the major version number of GCC.
4121 (For version 2.9.5, this is 2.)
4123 @item %v2
4124 Substitute the minor version number of GCC.
4125 (For version 2.9.5, this is 9.)
4127 @item %v3
4128 Substitute the patch level number of GCC.
4129 (For version 2.9.5, this is 5.)
4131 @item %a
4132 Process the @code{asm} spec.  This is used to compute the
4133 switches to be passed to the assembler.
4135 @item %A
4136 Process the @code{asm_final} spec.  This is a spec string for
4137 passing switches to an assembler post-processor, if such a program is
4138 needed.
4140 @item %l
4141 Process the @code{link} spec.  This is the spec for computing the
4142 command line passed to the linker.  Typically it will make use of the
4143 @samp{%L %G %S %D and %E} sequences.
4145 @item %D
4146 Dump out a @samp{-L} option for each directory that GCC believes might
4147 contain startup files.  If the target supports multilibs then the
4148 current multilib directory will be prepended to each of these paths. 
4150 @item %M
4151 Output the multilib directory with directory seperators replaced with
4152 "_".  If multilib directories are not set, or the multilib directory is
4153 "." then this option emits nothing.
4155 @item %L
4156 Process the @code{lib} spec.  This is a spec string for deciding which
4157 libraries should be included on the command line to the linker. 
4159 @item %G
4160 Process the @code{libgcc} spec.  This is a spec string for deciding
4161 which GCC support library should be included on the command line to the linker. 
4163 @item %S
4164 Process the @code{startfile} spec.  This is a spec for deciding which
4165 object files should be the first ones passed to the linker.  Typically
4166 this might be a file named @file{crt0.o}. 
4168 @item %E
4169 Process the @code{endfile} spec.  This is a spec string that specifies
4170 the last object files that will be passed to the linker.  
4172 @item %C
4173 Process the @code{cpp} spec.  This is used to construct the arguments
4174 to be passed to the C preprocessor.
4176 @item %c
4177 Process the @code{signed_char} spec.  This is intended to be used
4178 to tell cpp whether a char is signed.  It typically has the definition: 
4179 @smallexample
4180 %@{funsigned-char:-D__CHAR_UNSIGNED__@}
4181 @end smallexample
4183 @item %1
4184 Process the @code{cc1} spec.  This is used to construct the options to be
4185 passed to the actual C compiler (@samp{cc1}).
4187 @item %2
4188 Process the @code{cc1plus} spec.  This is used to construct the options to be
4189 passed to the actual C++ compiler (@samp{cc1plus}).
4191 @item %*
4192 Substitute the variable part of a matched option.  See below.
4193 Note that each comma in the substituted string is replaced by
4194 a single space.
4196 @item %@{@code{S}@}
4197 Substitutes the @code{-S} switch, if that switch was given to GCC.
4198 If that switch was not specified, this substitutes nothing.  Note that
4199 the leading dash is omitted when specifying this option, and it is
4200 automatically inserted if the substitution is performed.  Thus the spec
4201 string @samp{%@{foo@}} would match the command-line option @samp{-foo}
4202 and would output the command line option @samp{-foo}.
4204 @item %W@{@code{S}@}
4205 Like %@{@code{S}@} but mark last argument supplied within as a file to be
4206 deleted on failure. 
4208 @item %@{@code{S}*@}
4209 Substitutes all the switches specified to GCC whose names start
4210 with @code{-S}, but which also take an argument.  This is used for
4211 switches like @samp{-o, -D, -I}, etc.  GCC considers @samp{-o foo} as being
4212 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
4213 text, including the space.  Thus two arguments would be generated. 
4215 @item %@{^@code{S}*@}
4216 Like %@{@code{S}*@}, but don't put a blank between a switch and its
4217 argument.  Thus %@{^o*@} would only generate one argument, not two.
4219 @item %@{@code{S}*&@code{T}*@}
4220 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
4221 (the order of @code{S} and @code{T} in the spec is not significant).
4222 There can be any number of ampersand-separated variables; for each the
4223 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
4225 @item %@{<@code{S}@}
4226 Remove all occurrences of @code{-S} from the command line.  Note - this
4227 command is position dependent.  @samp{%} commands in the spec string
4228 before this option will see @code{-S}, @samp{%} commands in the spec
4229 string after this option will not.
4231 @item %@{@code{S}*:@code{X}@}
4232 Substitutes @code{X} if one or more switches whose names start with
4233 @code{-S} are specified to GCC.  Note that the tail part of the
4234 @code{-S} option (i.e. the part matched by the @samp{*}) will be substituted
4235 for each occurrence of @samp{%*} within @code{X}. 
4237 @item %@{@code{S}:@code{X}@}
4238 Substitutes @code{X}, but only if the @samp{-S} switch was given to GCC.
4240 @item %@{!@code{S}:@code{X}@}
4241 Substitutes @code{X}, but only if the @samp{-S} switch was @emph{not} given to GCC.
4243 @item %@{|@code{S}:@code{X}@}
4244 Like %@{@code{S}:@code{X}@}, but if no @code{S} switch, substitute @samp{-}.
4246 @item %@{|!@code{S}:@code{X}@}
4247 Like %@{!@code{S}:@code{X}@}, but if there is an @code{S} switch, substitute @samp{-}.
4249 @item %@{.@code{S}:@code{X}@}
4250 Substitutes @code{X}, but only if processing a file with suffix @code{S}.
4252 @item %@{!.@code{S}:@code{X}@}
4253 Substitutes @code{X}, but only if @emph{not} processing a file with suffix @code{S}.
4255 @item %@{@code{S}|@code{P}:@code{X}@}
4256 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC.  This may be
4257 combined with @samp{!} and @samp{.} sequences as well, although they
4258 have a stronger binding than the @samp{|}.  For example a spec string
4259 like this:
4261 @smallexample
4262 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
4263 @end smallexample
4265 will output the following command-line options from the following input
4266 command-line options:
4268 @smallexample
4269 fred.c        -foo -baz
4270 jim.d         -bar -boggle
4271 -d fred.c     -foo -baz -boggle
4272 -d jim.d      -bar -baz -boggle
4273 @end smallexample
4275 @end table
4277 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or
4278 %@{!@code{S}:@code{X}@} construct may contain other nested @samp{%} constructs
4279 or spaces, or even newlines.  They are processed as usual, as described
4280 above. 
4282 The @samp{-O, -f, -m, and -W} switches are handled specifically in these
4283 constructs.  If another value of @samp{-O} or the negated form of a @samp{-f, -m, or
4284 -W} switch is found later in the command line, the earlier switch
4285 value is ignored, except with @{@code{S}*@} where @code{S} is just one
4286 letter, which passes all matching options.
4288 The character @samp{|} at the beginning of the predicate text is used to indicate
4289 that a command should be piped to the following command, but only if @samp{-pipe}
4290 is specified.
4292 It is built into GCC which switches take arguments and which do not.
4293 (You might think it would be useful to generalize this to allow each
4294 compiler's spec to say which switches take arguments.  But this cannot
4295 be done in a consistent fashion.  GCC cannot even decide which input
4296 files have been specified without knowing which switches take arguments,
4297 and it must know which input files to compile in order to tell which
4298 compilers to run). 
4300 GCC also knows implicitly that arguments starting in @samp{-l} are to be
4301 treated as compiler output files, and passed to the linker in their
4302 proper position among the other output files.
4304 @c man begin OPTIONS
4306 @node Target Options
4307 @section Specifying Target Machine and Compiler Version
4308 @cindex target options
4309 @cindex cross compiling
4310 @cindex specifying machine version
4311 @cindex specifying compiler version and target machine
4312 @cindex compiler version, specifying
4313 @cindex target machine, specifying
4315 By default, GCC compiles code for the same type of machine that you
4316 are using.  However, it can also be installed as a cross-compiler, to
4317 compile for some other type of machine.  In fact, several different
4318 configurations of GCC, for different target machines, can be
4319 installed side by side.  Then you specify which one to use with the
4320 @samp{-b} option.
4322 In addition, older and newer versions of GCC can be installed side
4323 by side.  One of them (probably the newest) will be the default, but
4324 you may sometimes wish to use another.
4326 @table @gcctabopt
4327 @item -b @var{machine}
4328 The argument @var{machine} specifies the target machine for compilation.
4329 This is useful when you have installed GCC as a cross-compiler.
4331 The value to use for @var{machine} is the same as was specified as the
4332 machine type when configuring GCC as a cross-compiler.  For
4333 example, if a cross-compiler was configured with @samp{configure
4334 i386v}, meaning to compile for an 80386 running System V, then you
4335 would specify @samp{-b i386v} to run that cross compiler.
4337 When you do not specify @samp{-b}, it normally means to compile for
4338 the same type of machine that you are using.
4340 @item -V @var{version}
4341 The argument @var{version} specifies which version of GCC to run.
4342 This is useful when multiple versions are installed.  For example,
4343 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
4345 The default version, when you do not specify @samp{-V}, is the last
4346 version of GCC that you installed.
4347 @end table
4349 The @samp{-b} and @samp{-V} options actually work by controlling part of
4350 the file name used for the executable files and libraries used for
4351 compilation.  A given version of GCC, for a given target machine, is
4352 normally kept in the directory @file{/usr/local/lib/gcc-lib/@var{machine}/@var{version}}.@refill
4354 Thus, sites can customize the effect of @samp{-b} or @samp{-V} either by
4355 changing the names of these directories or adding alternate names (or
4356 symbolic links).  If in directory @file{/usr/local/lib/gcc-lib/} the
4357 file @file{80386} is a link to the file @file{i386v}, then @samp{-b
4358 80386} becomes an alias for @samp{-b i386v}.
4360 In one respect, the @samp{-b} or @samp{-V} do not completely change
4361 to a different compiler: the top-level driver program @command{gcc}
4362 that you originally invoked continues to run and invoke the other
4363 executables (preprocessor, compiler per se, assembler and linker)
4364 that do the real work.  However, since no real work is done in the
4365 driver program, it usually does not matter that the driver program
4366 in use is not the one for the specified target.  It is common for the
4367 interface to the other executables to change incompatibly between
4368 compiler versions, so unless the version specified is very close to that
4369 of the driver (for example, @samp{-V 3.0} with a driver program from GCC
4370 version 3.0.1), use of @samp{-V} may not work; for example, using
4371 @samp{-V 2.95.2} will not work with a driver program from GCC 3.0.
4373 The only way that the driver program depends on the target machine is
4374 in the parsing and handling of special machine-specific options.
4375 However, this is controlled by a file which is found, along with the
4376 other executables, in the directory for the specified version and
4377 target machine.  As a result, a single installed driver program adapts
4378 to any specified target machine, and sufficiently similar compiler
4379 versions.
4381 The driver program executable does control one significant thing,
4382 however: the default version and target machine.  Therefore, you can
4383 install different instances of the driver program, compiled for
4384 different targets or versions, under different names.
4386 For example, if the driver for version 2.0 is installed as @command{ogcc}
4387 and that for version 2.1 is installed as @command{gcc}, then the command
4388 @command{gcc} will use version 2.1 by default, while @command{ogcc} will use
4389 2.0 by default.  However, you can choose either version with either
4390 command with the @samp{-V} option.
4392 @node Submodel Options
4393 @section Hardware Models and Configurations
4394 @cindex submodel options
4395 @cindex specifying hardware config
4396 @cindex hardware models and configurations, specifying
4397 @cindex machine dependent options
4399 Earlier we discussed the standard option @samp{-b} which chooses among
4400 different installed compilers for completely different target
4401 machines, such as Vax vs. 68000 vs. 80386.
4403 In addition, each of these target machine types can have its own
4404 special options, starting with @samp{-m}, to choose among various
4405 hardware models or configurations---for example, 68010 vs 68020,
4406 floating coprocessor or none.  A single installed version of the
4407 compiler can compile for any model or configuration, according to the
4408 options specified.
4410 Some configurations of the compiler also support additional special
4411 options, usually for compatibility with other compilers on the same
4412 platform.
4414 @ifset INTERNALS
4415 These options are defined by the macro @code{TARGET_SWITCHES} in the
4416 machine description.  The default for the options is also defined by
4417 that macro, which enables you to change the defaults.
4418 @end ifset
4420 @menu
4421 * M680x0 Options::
4422 * M68hc1x Options::
4423 * VAX Options::
4424 * SPARC Options::
4425 * Convex Options::
4426 * AMD29K Options::
4427 * ARM Options::
4428 * Thumb Options::
4429 * MN10200 Options::
4430 * MN10300 Options::
4431 * M32R/D Options::
4432 * M88K Options::
4433 * RS/6000 and PowerPC Options::
4434 * RT Options::
4435 * MIPS Options::
4436 * i386 Options::
4437 * HPPA Options::
4438 * Intel 960 Options::
4439 * DEC Alpha Options::
4440 * Clipper Options::
4441 * H8/300 Options::
4442 * SH Options::
4443 * System V Options::
4444 * TMS320C3x/C4x Options::
4445 * V850 Options::
4446 * ARC Options::
4447 * NS32K Options::
4448 * AVR Options::
4449 * MCore Options::
4450 * IA-64 Options::
4451 * D30V Options::
4452 @end menu
4454 @node M680x0 Options
4455 @subsection M680x0 Options
4456 @cindex M680x0 options
4458 These are the @samp{-m} options defined for the 68000 series.  The default
4459 values for these options depends on which style of 68000 was selected when
4460 the compiler was configured; the defaults for the most common choices are
4461 given below.
4463 @table @gcctabopt
4464 @item -m68000
4465 @itemx -mc68000
4466 Generate output for a 68000.  This is the default
4467 when the compiler is configured for 68000-based systems.
4469 Use this option for microcontrollers with a 68000 or EC000 core,
4470 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
4472 @item -m68020
4473 @itemx -mc68020
4474 Generate output for a 68020.  This is the default
4475 when the compiler is configured for 68020-based systems.
4477 @item -m68881
4478 Generate output containing 68881 instructions for floating point.
4479 This is the default for most 68020 systems unless @samp{-nfp} was
4480 specified when the compiler was configured.
4482 @item -m68030
4483 Generate output for a 68030.  This is the default when the compiler is
4484 configured for 68030-based systems.
4486 @item -m68040
4487 Generate output for a 68040.  This is the default when the compiler is
4488 configured for 68040-based systems.
4490 This option inhibits the use of 68881/68882 instructions that have to be
4491 emulated by software on the 68040.  Use this option if your 68040 does not
4492 have code to emulate those instructions.
4494 @item -m68060
4495 Generate output for a 68060.  This is the default when the compiler is
4496 configured for 68060-based systems.
4498 This option inhibits the use of 68020 and 68881/68882 instructions that
4499 have to be emulated by software on the 68060.  Use this option if your 68060
4500 does not have code to emulate those instructions.
4502 @item -mcpu32
4503 Generate output for a CPU32. This is the default
4504 when the compiler is configured for CPU32-based systems.
4506 Use this option for microcontrollers with a
4507 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
4508 68336, 68340, 68341, 68349 and 68360.
4510 @item -m5200
4511 Generate output for a 520X "coldfire" family cpu.  This is the default
4512 when the compiler is configured for 520X-based systems.
4514 Use this option for microcontroller with a 5200 core, including 
4515 the MCF5202, MCF5203, MCF5204 and MCF5202.
4518 @item -m68020-40
4519 Generate output for a 68040, without using any of the new instructions.
4520 This results in code which can run relatively efficiently on either a
4521 68020/68881 or a 68030 or a 68040.  The generated code does use the
4522 68881 instructions that are emulated on the 68040.
4524 @item -m68020-60
4525 Generate output for a 68060, without using any of the new instructions.
4526 This results in code which can run relatively efficiently on either a
4527 68020/68881 or a 68030 or a 68040.  The generated code does use the
4528 68881 instructions that are emulated on the 68060.
4530 @item -mfpa
4531 Generate output containing Sun FPA instructions for floating point.
4533 @item -msoft-float
4534 Generate output containing library calls for floating point.
4535 @strong{Warning:} the requisite libraries are not available for all m68k
4536 targets.  Normally the facilities of the machine's usual C compiler are
4537 used, but this can't be done directly in cross-compilation.  You must
4538 make your own arrangements to provide suitable library functions for
4539 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
4540 @samp{m68k-*-coff} do provide software floating point support.
4542 @item -mshort
4543 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4545 @item -mnobitfield
4546 Do not use the bit-field instructions.  The @samp{-m68000}, @samp{-mcpu32}
4547 and @samp{-m5200} options imply @w{@samp{-mnobitfield}}.
4549 @item -mbitfield
4550 Do use the bit-field instructions.  The @samp{-m68020} option implies
4551 @samp{-mbitfield}.  This is the default if you use a configuration
4552 designed for a 68020.
4554 @item -mrtd
4555 Use a different function-calling convention, in which functions
4556 that take a fixed number of arguments return with the @code{rtd}
4557 instruction, which pops their arguments while returning.  This
4558 saves one instruction in the caller since there is no need to pop
4559 the arguments there.
4561 This calling convention is incompatible with the one normally
4562 used on Unix, so you cannot use it if you need to call libraries
4563 compiled with the Unix compiler.
4565 Also, you must provide function prototypes for all functions that
4566 take variable numbers of arguments (including @code{printf});
4567 otherwise incorrect code will be generated for calls to those
4568 functions.
4570 In addition, seriously incorrect code will result if you call a
4571 function with too many arguments.  (Normally, extra arguments are
4572 harmlessly ignored.)
4574 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
4575 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
4577 @item -malign-int
4578 @itemx -mno-align-int
4579 Control whether GCC aligns @code{int}, @code{long}, @code{long long}, 
4580 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
4581 boundary (@samp{-malign-int}) or a 16-bit boundary (@samp{-mno-align-int}).
4582 Aligning variables on 32-bit boundaries produces code that runs somewhat
4583 faster on processors with 32-bit busses at the expense of more memory.
4585 @strong{Warning:} if you use the @samp{-malign-int} switch, GCC will
4586 align structures containing the above types  differently than
4587 most published application binary interface specifications for the m68k.
4589 @item -mpcrel
4590 Use the pc-relative addressing mode of the 68000 directly, instead of
4591 using a global offset table.  At present, this option implies -fpic,
4592 allowing at most a 16-bit offset for pc-relative addressing.  -fPIC is
4593 not presently supported with -mpcrel, though this could be supported for
4594 68020 and higher processors.
4596 @item -mno-strict-align
4597 @itemx -mstrict-align
4598 @kindex -mstrict-align
4599 Do not (do) assume that unaligned memory references will be handled by
4600 the system.
4602 @end table
4604 @node M68hc1x Options
4605 @subsection M68hc1x Options
4606 @cindex M68hc1x options
4608 These are the @samp{-m} options defined for the 68hc11 and 68hc12
4609 microcontrollers.  The default values for these options depends on 
4610 which style of microcontroller was selected when the compiler was configured;
4611 the defaults for the most common choices are given below.
4613 @table @gcctabopt
4614 @item -m6811
4615 @itemx -m68hc11
4616 Generate output for a 68HC11.  This is the default
4617 when the compiler is configured for 68HC11-based systems.
4619 @item -m6812
4620 @itemx -m68hc12
4621 Generate output for a 68HC12.  This is the default
4622 when the compiler is configured for 68HC12-based systems.
4624 @item -mauto-incdec
4625 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
4626 addressing modes.
4628 @item -mshort
4629 Consider type @code{int} to be 16 bits wide, like @code{short int}.
4631 @item -msoft-reg-count=@var{count}
4632 Specify the number of pseudo-soft registers which are used for the
4633 code generation.  The maximum number is 32.  Using more pseudo-soft
4634 register may or may not result in better code depending on the program.
4635 The default is 4 for 68HC11 and 2 for 68HC12.
4637 @end table
4639 @node VAX Options
4640 @subsection VAX Options
4641 @cindex VAX options
4643 These @samp{-m} options are defined for the Vax:
4645 @table @gcctabopt
4646 @item -munix
4647 Do not output certain jump instructions (@code{aobleq} and so on)
4648 that the Unix assembler for the Vax cannot handle across long
4649 ranges.
4651 @item -mgnu
4652 Do output those jump instructions, on the assumption that you
4653 will assemble with the GNU assembler.
4655 @item -mg
4656 Output code for g-format floating point numbers instead of d-format.
4657 @end table
4659 @node SPARC Options
4660 @subsection SPARC Options
4661 @cindex SPARC options
4663 These @samp{-m} switches are supported on the SPARC:
4665 @table @gcctabopt
4666 @item -mno-app-regs
4667 @itemx -mapp-regs
4668 Specify @samp{-mapp-regs} to generate output using the global registers
4669 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
4670 is the default.
4672 To be fully SVR4 ABI compliant at the cost of some performance loss,
4673 specify @samp{-mno-app-regs}.  You should compile libraries and system
4674 software with this option.
4676 @item -mfpu
4677 @itemx -mhard-float
4678 Generate output containing floating point instructions.  This is the
4679 default.
4681 @item -mno-fpu
4682 @itemx -msoft-float
4683 Generate output containing library calls for floating point.
4684 @strong{Warning:} the requisite libraries are not available for all SPARC
4685 targets.  Normally the facilities of the machine's usual C compiler are
4686 used, but this cannot be done directly in cross-compilation.  You must make
4687 your own arrangements to provide suitable library functions for
4688 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
4689 @samp{sparclite-*-*} do provide software floating point support.
4691 @samp{-msoft-float} changes the calling convention in the output file;
4692 therefore, it is only useful if you compile @emph{all} of a program with
4693 this option.  In particular, you need to compile @file{libgcc.a}, the
4694 library that comes with GCC, with @samp{-msoft-float} in order for
4695 this to work.
4697 @item -mhard-quad-float
4698 Generate output containing quad-word (long double) floating point
4699 instructions.
4701 @item -msoft-quad-float
4702 Generate output containing library calls for quad-word (long double)
4703 floating point instructions.  The functions called are those specified
4704 in the SPARC ABI.  This is the default.
4706 As of this writing, there are no sparc implementations that have hardware
4707 support for the quad-word floating point instructions.  They all invoke
4708 a trap handler for one of these instructions, and then the trap handler
4709 emulates the effect of the instruction.  Because of the trap handler overhead,
4710 this is much slower than calling the ABI library routines.  Thus the
4711 @samp{-msoft-quad-float} option is the default.
4713 @item -mno-epilogue
4714 @itemx -mepilogue
4715 With @samp{-mepilogue} (the default), the compiler always emits code for
4716 function exit at the end of each function.  Any function exit in
4717 the middle of the function (such as a return statement in C) will
4718 generate a jump to the exit code at the end of the function.
4720 With @samp{-mno-epilogue}, the compiler tries to emit exit code inline
4721 at every function exit.
4723 @item -mno-flat
4724 @itemx -mflat
4725 With @samp{-mflat}, the compiler does not generate save/restore instructions
4726 and will use a "flat" or single register window calling convention.
4727 This model uses %i7 as the frame pointer and is compatible with the normal
4728 register window model.  Code from either may be intermixed.
4729 The local registers and the input registers (0-5) are still treated as
4730 "call saved" registers and will be saved on the stack as necessary.
4732 With @samp{-mno-flat} (the default), the compiler emits save/restore
4733 instructions (except for leaf functions) and is the normal mode of operation.
4735 @item -mno-unaligned-doubles
4736 @itemx -munaligned-doubles
4737 Assume that doubles have 8 byte alignment.  This is the default.
4739 With @samp{-munaligned-doubles}, GCC assumes that doubles have 8 byte
4740 alignment only if they are contained in another type, or if they have an
4741 absolute address.  Otherwise, it assumes they have 4 byte alignment.
4742 Specifying this option avoids some rare compatibility problems with code
4743 generated by other compilers.  It is not the default because it results
4744 in a performance loss, especially for floating point code.
4746 @item -mno-faster-structs
4747 @itemx -mfaster-structs
4748 With @samp{-mfaster-structs}, the compiler assumes that structures
4749 should have 8 byte alignment.  This enables the use of pairs of
4750 @code{ldd} and @code{std} instructions for copies in structure
4751 assignment, in place of twice as many @code{ld} and @code{st} pairs.
4752 However, the use of this changed alignment directly violates the Sparc
4753 ABI.  Thus, it's intended only for use on targets where the developer
4754 acknowledges that their resulting code will not be directly in line with
4755 the rules of the ABI.
4757 @item -mv8
4758 @itemx -msparclite
4759 These two options select variations on the SPARC architecture.
4761 By default (unless specifically configured for the Fujitsu SPARClite),
4762 GCC generates code for the v7 variant of the SPARC architecture.
4764 @samp{-mv8} will give you SPARC v8 code.  The only difference from v7
4765 code is that the compiler emits the integer multiply and integer
4766 divide instructions which exist in SPARC v8 but not in SPARC v7.
4768 @samp{-msparclite} will give you SPARClite code.  This adds the integer
4769 multiply, integer divide step and scan (@code{ffs}) instructions which
4770 exist in SPARClite but not in SPARC v7.
4772 These options are deprecated and will be deleted in a future GCC release.
4773 They have been replaced with @samp{-mcpu=xxx}.
4775 @item -mcypress
4776 @itemx -msupersparc
4777 These two options select the processor for which the code is optimised.
4779 With @samp{-mcypress} (the default), the compiler optimizes code for the
4780 Cypress CY7C602 chip, as used in the SparcStation/SparcServer 3xx series.
4781 This is also appropriate for the older SparcStation 1, 2, IPX etc.
4783 With @samp{-msupersparc} the compiler optimizes code for the SuperSparc cpu, as
4784 used in the SparcStation 10, 1000 and 2000 series. This flag also enables use
4785 of the full SPARC v8 instruction set.
4787 These options are deprecated and will be deleted in a future GCC release.
4788 They have been replaced with @samp{-mcpu=xxx}.
4790 @item -mcpu=@var{cpu_type}
4791 Set the instruction set, register set, and instruction scheduling parameters
4792 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
4793 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
4794 @samp{hypersparc}, @samp{sparclite86x}, @samp{f930}, @samp{f934},
4795 @samp{sparclet}, @samp{tsc701}, @samp{v9}, and @samp{ultrasparc}.
4797 Default instruction scheduling parameters are used for values that select
4798 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
4799 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
4801 Here is a list of each supported architecture and their supported
4802 implementations.
4804 @smallexample
4805     v7:             cypress
4806     v8:             supersparc, hypersparc
4807     sparclite:      f930, f934, sparclite86x
4808     sparclet:       tsc701
4809     v9:             ultrasparc
4810 @end smallexample
4812 @item -mtune=@var{cpu_type}
4813 Set the instruction scheduling parameters for machine type
4814 @var{cpu_type}, but do not set the instruction set or register set that the
4815 option @samp{-mcpu=}@var{cpu_type} would.
4817 The same values for @samp{-mcpu=}@var{cpu_type} are used for
4818 @samp{-mtune=}@*@var{cpu_type}, though the only useful values are those that
4819 select a particular cpu implementation: @samp{cypress}, @samp{supersparc},
4820 @samp{hypersparc}, @samp{f930}, @samp{f934}, @samp{sparclite86x},
4821 @samp{tsc701}, @samp{ultrasparc}.
4823 @end table
4825 These @samp{-m} switches are supported in addition to the above
4826 on the SPARCLET processor.
4828 @table @gcctabopt
4829 @item -mlittle-endian
4830 Generate code for a processor running in little-endian mode.
4832 @item -mlive-g0
4833 Treat register @code{%g0} as a normal register.
4834 GCC will continue to clobber it as necessary but will not assume
4835 it always reads as 0.
4837 @item -mbroken-saverestore
4838 Generate code that does not use non-trivial forms of the @code{save} and
4839 @code{restore} instructions.  Early versions of the SPARCLET processor do
4840 not correctly handle @code{save} and @code{restore} instructions used with
4841 arguments.  They correctly handle them used without arguments.  A @code{save}
4842 instruction used without arguments increments the current window pointer
4843 but does not allocate a new stack frame.  It is assumed that the window
4844 overflow trap handler will properly handle this case as will interrupt
4845 handlers.
4846 @end table
4848 These @samp{-m} switches are supported in addition to the above
4849 on SPARC V9 processors in 64 bit environments.
4851 @table @gcctabopt
4852 @item -mlittle-endian
4853 Generate code for a processor running in little-endian mode.
4855 @item -m32
4856 @itemx -m64
4857 Generate code for a 32 bit or 64 bit environment.
4858 The 32 bit environment sets int, long and pointer to 32 bits.
4859 The 64 bit environment sets int to 32 bits and long and pointer
4860 to 64 bits.
4862 @item -mcmodel=medlow
4863 Generate code for the Medium/Low code model: the program must be linked
4864 in the low 32 bits of the address space.  Pointers are 64 bits.
4865 Programs can be statically or dynamically linked.
4867 @item -mcmodel=medmid
4868 Generate code for the Medium/Middle code model: the program must be linked
4869 in the low 44 bits of the address space, the text segment must be less than
4870 2G bytes, and data segment must be within 2G of the text segment.
4871 Pointers are 64 bits.
4873 @item -mcmodel=medany
4874 Generate code for the Medium/Anywhere code model: the program may be linked
4875 anywhere in the address space, the text segment must be less than
4876 2G bytes, and data segment must be within 2G of the text segment.
4877 Pointers are 64 bits.
4879 @item -mcmodel=embmedany
4880 Generate code for the Medium/Anywhere code model for embedded systems:
4881 assume a 32 bit text and a 32 bit data segment, both starting anywhere
4882 (determined at link time).  Register %g4 points to the base of the
4883 data segment.  Pointers still 64 bits.
4884 Programs are statically linked, PIC is not supported.
4886 @item -mstack-bias
4887 @itemx -mno-stack-bias
4888 With @samp{-mstack-bias}, GCC assumes that the stack pointer, and
4889 frame pointer if present, are offset by -2047 which must be added back
4890 when making stack frame references.
4891 Otherwise, assume no such offset is present.
4892 @end table
4894 @node Convex Options
4895 @subsection Convex Options
4896 @cindex Convex options
4898 These @samp{-m} options are defined for Convex:
4900 @table @gcctabopt
4901 @item -mc1
4902 Generate output for C1.  The code will run on any Convex machine.
4903 The preprocessor symbol @code{__convex__c1__} is defined.
4905 @item -mc2
4906 Generate output for C2.  Uses instructions not available on C1.
4907 Scheduling and other optimizations are chosen for max performance on C2.
4908 The preprocessor symbol @code{__convex_c2__} is defined.
4910 @item -mc32
4911 Generate output for C32xx.  Uses instructions not available on C1.
4912 Scheduling and other optimizations are chosen for max performance on C32.
4913 The preprocessor symbol @code{__convex_c32__} is defined.
4915 @item -mc34
4916 Generate output for C34xx.  Uses instructions not available on C1.
4917 Scheduling and other optimizations are chosen for max performance on C34.
4918 The preprocessor symbol @code{__convex_c34__} is defined.
4920 @item -mc38
4921 Generate output for C38xx.  Uses instructions not available on C1.
4922 Scheduling and other optimizations are chosen for max performance on C38.
4923 The preprocessor symbol @code{__convex_c38__} is defined.
4925 @item -margcount
4926 Generate code which puts an argument count in the word preceding each
4927 argument list.  This is compatible with regular CC, and a few programs
4928 may need the argument count word.  GDB and other source-level debuggers
4929 do not need it; this info is in the symbol table.
4931 @item -mnoargcount
4932 Omit the argument count word.  This is the default.
4934 @item -mvolatile-cache
4935 Allow volatile references to be cached.  This is the default.
4937 @item -mvolatile-nocache
4938 Volatile references bypass the data cache, going all the way to memory.
4939 This is only needed for multi-processor code that does not use standard
4940 synchronization instructions.  Making non-volatile references to volatile
4941 locations will not necessarily work.
4943 @item -mlong32
4944 Type long is 32 bits, the same as type int.  This is the default.
4946 @item -mlong64
4947 Type long is 64 bits, the same as type long long.  This option is useless,
4948 because no library support exists for it.
4949 @end table
4951 @node AMD29K Options
4952 @subsection AMD29K Options
4953 @cindex AMD29K options
4955 These @samp{-m} options are defined for the AMD Am29000:
4957 @table @gcctabopt
4958 @item -mdw
4959 @kindex -mdw
4960 @cindex DW bit (29k)
4961 Generate code that assumes the @code{DW} bit is set, i.e., that byte and
4962 halfword operations are directly supported by the hardware.  This is the
4963 default.
4965 @item -mndw
4966 @kindex -mndw
4967 Generate code that assumes the @code{DW} bit is not set.
4969 @item -mbw
4970 @kindex -mbw
4971 @cindex byte writes (29k)
4972 Generate code that assumes the system supports byte and halfword write
4973 operations.  This is the default.
4975 @item -mnbw
4976 @kindex -mnbw
4977 Generate code that assumes the systems does not support byte and
4978 halfword write operations.  @samp{-mnbw} implies @samp{-mndw}.
4980 @item -msmall
4981 @kindex -msmall
4982 @cindex memory model (29k)
4983 Use a small memory model that assumes that all function addresses are
4984 either within a single 256 KB segment or at an absolute address of less
4985 than 256k.  This allows the @code{call} instruction to be used instead
4986 of a @code{const}, @code{consth}, @code{calli} sequence.
4988 @item -mnormal
4989 @kindex -mnormal
4990 Use the normal memory model: Generate @code{call} instructions only when
4991 calling functions in the same file and @code{calli} instructions
4992 otherwise.  This works if each file occupies less than 256 KB but allows
4993 the entire executable to be larger than 256 KB.  This is the default.
4995 @item -mlarge
4996 Always use @code{calli} instructions.  Specify this option if you expect
4997 a single file to compile into more than 256 KB of code.
4999 @item -m29050
5000 @kindex -m29050
5001 @cindex processor selection (29k)
5002 Generate code for the Am29050.
5004 @item -m29000
5005 @kindex -m29000
5006 Generate code for the Am29000.  This is the default.
5008 @item -mkernel-registers
5009 @kindex -mkernel-registers
5010 @cindex kernel and user registers (29k)
5011 Generate references to registers @code{gr64-gr95} instead of to
5012 registers @code{gr96-gr127}.  This option can be used when compiling
5013 kernel code that wants a set of global registers disjoint from that used
5014 by user-mode code.
5016 Note that when this option is used, register names in @samp{-f} flags
5017 must use the normal, user-mode, names.
5019 @item -muser-registers
5020 @kindex -muser-registers
5021 Use the normal set of global registers, @code{gr96-gr127}.  This is the
5022 default.
5024 @item -mstack-check
5025 @itemx -mno-stack-check
5026 @kindex -mstack-check
5027 @cindex stack checks (29k)
5028 Insert (or do not insert) a call to @code{__msp_check} after each stack
5029 adjustment.  This is often used for kernel code.
5031 @item -mstorem-bug
5032 @itemx -mno-storem-bug
5033 @kindex -mstorem-bug
5034 @cindex storem bug (29k)
5035 @samp{-mstorem-bug} handles 29k processors which cannot handle the
5036 separation of a mtsrim insn and a storem instruction (most 29000 chips
5037 to date, but not the 29050).
5039 @item -mno-reuse-arg-regs
5040 @itemx -mreuse-arg-regs
5041 @kindex -mreuse-arg-regs
5042 @samp{-mno-reuse-arg-regs} tells the compiler to only use incoming argument
5043 registers for copying out arguments.  This helps detect calling a function
5044 with fewer arguments than it was declared with.
5046 @item -mno-impure-text
5047 @itemx -mimpure-text
5048 @kindex -mimpure-text
5049 @samp{-mimpure-text}, used in addition to @samp{-shared}, tells the compiler to
5050 not pass @samp{-assert pure-text} to the linker when linking a shared object.
5052 @item -msoft-float
5053 @kindex -msoft-float
5054 Generate output containing library calls for floating point.
5055 @strong{Warning:} the requisite libraries are not part of GCC.
5056 Normally the facilities of the machine's usual C compiler are used, but
5057 this can't be done directly in cross-compilation.  You must make your
5058 own arrangements to provide suitable library functions for
5059 cross-compilation.
5061 @item -mno-multm
5062 @kindex -mno-multm
5063 Do not generate multm or multmu instructions.  This is useful for some embedded
5064 systems which do not have trap handlers for these instructions.
5065 @end table
5067 @node ARM Options
5068 @subsection ARM Options
5069 @cindex ARM options
5071 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
5072 architectures:
5074 @table @gcctabopt
5075 @item -mapcs-frame
5076 @kindex -mapcs-frame
5077 Generate a stack frame that is compliant with the ARM Procedure Call
5078 Standard for all functions, even if this is not strictly necessary for
5079 correct execution of the code.  Specifying @samp{-fomit-frame-pointer}
5080 with this option will cause the stack frames not to be generated for
5081 leaf functions.  The default is @samp{-mno-apcs-frame}.
5083 @item -mapcs
5084 @kindex -mapcs
5085 This is a synonym for @samp{-mapcs-frame}.
5087 @item -mapcs-26
5088 @kindex -mapcs-26
5089 Generate code for a processor running with a 26-bit program counter,
5090 and conforming to the function calling standards for the APCS 26-bit
5091 option.  This option replaces the @samp{-m2} and @samp{-m3} options
5092 of previous releases of the compiler.
5094 @item -mapcs-32
5095 @kindex -mapcs-32
5096 Generate code for a processor running with a 32-bit program counter,
5097 and conforming to the function calling standards for the APCS 32-bit
5098 option.  This option replaces the @samp{-m6} option of previous releases
5099 of the compiler.
5101 @item -mapcs-stack-check
5102 @kindex -mapcs-stack-check
5103 @kindex -mno-apcs-stack-check
5104 Generate code to check the amount of stack space available upon entry to
5105 every function (that actually uses some stack space).  If there is
5106 insufficient space available then either the function
5107 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
5108 called, depending upon the amount of stack space required.  The run time
5109 system is required to provide these functions.  The default is
5110 @samp{-mno-apcs-stack-check}, since this produces smaller code.
5112 @item -mapcs-float
5113 @kindex -mapcs-float
5114 @kindex -mno-apcs-float
5115 Pass floating point arguments using the float point registers.  This is
5116 one of the variants of the APCS.  This option is recommended if the
5117 target hardware has a floating point unit or if a lot of floating point
5118 arithmetic is going to be performed by the code.  The default is
5119 @samp{-mno-apcs-float}, since integer only code is slightly increased in
5120 size if @samp{-mapcs-float} is used.
5122 @item -mapcs-reentrant
5123 @kindex -mapcs-reentrant
5124 @kindex -mno-apcs-reentrant
5125 Generate reentrant, position independent code.  This is the equivalent
5126 to specifying the @samp{-fpic} option.  The default is
5127 @samp{-mno-apcs-reentrant}.
5129 @item -mthumb-interwork
5130 @kindex -mthumb-interwork
5131 @kindex -mno-thumb-interwork
5132 Generate code which supports calling between the ARM and THUMB
5133 instruction sets.  Without this option the two instruction sets cannot
5134 be reliably used inside one program.  The default is
5135 @samp{-mno-thumb-interwork}, since slightly larger code is generated
5136 when @samp{-mthumb-interwork} is specified.
5138 @item -mno-sched-prolog
5139 @kindex -mno-sched-prolog
5140 @kindex -msched-prolog
5141 Prevent the reordering of instructions in the function prolog, or the
5142 merging of those instruction with the instructions in the function's
5143 body.  This means that all functions will start with a recognizable set
5144 of instructions (or in fact one of a choice from a small set of
5145 different function prologues), and this information can be used to
5146 locate the start if functions inside an executable piece of code.  The
5147 default is @samp{-msched-prolog}.
5149 @item -mhard-float
5150 Generate output containing floating point instructions.  This is the
5151 default.
5153 @item -msoft-float
5154 Generate output containing library calls for floating point.
5155 @strong{Warning:} the requisite libraries are not available for all ARM
5156 targets.  Normally the facilities of the machine's usual C compiler are
5157 used, but this cannot be done directly in cross-compilation.  You must make
5158 your own arrangements to provide suitable library functions for
5159 cross-compilation.
5161 @samp{-msoft-float} changes the calling convention in the output file;
5162 therefore, it is only useful if you compile @emph{all} of a program with
5163 this option.  In particular, you need to compile @file{libgcc.a}, the
5164 library that comes with GCC, with @samp{-msoft-float} in order for
5165 this to work.
5167 @item -mlittle-endian
5168 Generate code for a processor running in little-endian mode.  This is
5169 the default for all standard configurations.
5171 @item -mbig-endian
5172 Generate code for a processor running in big-endian mode; the default is
5173 to compile code for a little-endian processor.
5175 @item -mwords-little-endian
5176 This option only applies when generating code for big-endian processors.
5177 Generate code for a little-endian word order but a big-endian byte
5178 order.  That is, a byte order of the form @samp{32107654}.  Note: this
5179 option should only be used if you require compatibility with code for
5180 big-endian ARM processors generated by versions of the compiler prior to
5181 2.8.
5183 @item -malignment-traps
5184 @kindex -malignment-traps
5185 Generate code that will not trap if the MMU has alignment traps enabled.
5186 On ARM architectures prior to ARMv4, there were no instructions to
5187 access half-word objects stored in memory.  However, when reading from
5188 memory a feature of the ARM architecture allows a word load to be used,
5189 even if the address is unaligned, and the processor core will rotate the
5190 data as it is being loaded.  This option tells the compiler that such
5191 misaligned accesses will cause a MMU trap and that it should instead
5192 synthesise the access as a series of byte accesses.  The compiler can
5193 still use word accesses to load half-word data if it knows that the
5194 address is aligned to a word boundary.
5196 This option is ignored when compiling for ARM architecture 4 or later,
5197 since these processors have instructions to directly access half-word
5198 objects in memory. 
5199         
5200 @item -mno-alignment-traps
5201 @kindex -mno-alignment-traps
5202 Generate code that assumes that the MMU will not trap unaligned
5203 accesses.  This produces better code when the target instruction set
5204 does not have half-word memory operations (implementations prior to
5205 ARMv4). 
5207 Note that you cannot use this option to access unaligned word objects,
5208 since the processor will only fetch one 32-bit aligned object from
5209 memory. 
5211 The default setting for most targets is -mno-alignment-traps, since
5212 this produces better code when there are no half-word memory
5213 instructions available. 
5215 @item -mshort-load-bytes
5216 @kindex -mshort-load-bytes
5217 This is a deprecated alias for @samp{-malignment-traps}.
5219 @item -mno-short-load-bytes
5220 @kindex -mno-short-load-bytes
5221 This is a deprecated alias for @samp{-mno-alignment-traps}.
5223 @item -mshort-load-words
5224 @kindex -mshort-load-words
5225 This is a deprecated alias for @samp{-mno-alignment-traps}.
5227 @item -mno-short-load-words
5228 @kindex -mno-short-load-words
5229 This is a deprecated alias for @samp{-malignment-traps}.
5231 @item -mbsd
5232 @kindex -mbsd
5233 This option only applies to RISC iX.  Emulate the native BSD-mode
5234 compiler.  This is the default if @samp{-ansi} is not specified.
5236 @item -mxopen
5237 @kindex -mxopen
5238 This option only applies to RISC iX.  Emulate the native X/Open-mode
5239 compiler.
5241 @item -mno-symrename
5242 @kindex -mno-symrename
5243 This option only applies to RISC iX.  Do not run the assembler
5244 post-processor, @samp{symrename}, after code has been assembled.
5245 Normally it is necessary to modify some of the standard symbols in
5246 preparation for linking with the RISC iX C library; this option
5247 suppresses this pass.  The post-processor is never run when the
5248 compiler is built for cross-compilation.
5250 @item -mcpu=<name>
5251 @kindex -mcpu=
5252 This specifies the name of the target ARM processor.  GCC uses this name
5253 to determine what kind of instructions it can use when generating
5254 assembly code.  Permissible names are: arm2, arm250, arm3, arm6, arm60,
5255 arm600, arm610, arm620, arm7, arm7m, arm7d, arm7dm, arm7di, arm7dmi,
5256 arm70, arm700, arm700i, arm710, arm710c, arm7100, arm7500, arm7500fe,
5257 arm7tdmi, arm8, strongarm, strongarm110, strongarm1100, arm8, arm810,
5258 arm9, arm920, arm920t, arm9tdmi.
5260 @itemx -mtune=<name>
5261 @kindex -mtune=
5262 This option is very similar to the @samp{-mcpu=} option, except that
5263 instead of specifying the actual target processor type, and hence
5264 restricting which instructions can be used, it specifies that GCC should
5265 tune the performance of the code as if the target were of the type
5266 specified in this option, but still choosing the instructions that it
5267 will generate based on the cpu specified by a @samp{-mcpu=} option.
5268 For some arm implementations better performance can be obtained by using
5269 this option.
5271 @item -march=<name>
5272 @kindex -march=
5273 This specifies the name of the target ARM architecture.  GCC uses this
5274 name to determine what kind of instructions it can use when generating
5275 assembly code.  This option can be used in conjunction with or instead
5276 of the @samp{-mcpu=} option.  Permissible names are: armv2, armv2a,
5277 armv3, armv3m, armv4, armv4t, armv5.
5279 @item -mfpe=<number>
5280 @itemx -mfp=<number>
5281 @kindex -mfpe=
5282 @kindex -mfp=
5283 This specifies the version of the floating point emulation available on
5284 the target.  Permissible values are 2 and 3.  @samp{-mfp=} is a synonym
5285 for @samp{-mfpe=} to support older versions of GCC.
5287 @item -mstructure-size-boundary=<n>
5288 @kindex -mstructure-size-boundary
5289 The size of all structures and unions will be rounded up to a multiple
5290 of the number of bits set by this option.  Permissible values are 8 and
5291 32.  The default value varies for different toolchains.  For the COFF
5292 targeted toolchain the default value is 8.  Specifying the larger number
5293 can produce faster, more efficient code, but can also increase the size
5294 of the program.  The two values are potentially incompatible.  Code
5295 compiled with one value cannot necessarily expect to work with code or
5296 libraries compiled with the other value, if they exchange information
5297 using structures or unions.  Programmers are encouraged to use the 32
5298 value as future versions of the toolchain may default to this value.
5300 @item -mabort-on-noreturn
5301 @kindex -mabort-on-noreturn
5302 @kindex -mnoabort-on-noreturn
5303 Generate a call to the function abort at the end of a noreturn function.
5304 It will be executed if the function tries to return.
5306 @item -mlong-calls
5307 @itemx -mno-long-calls
5308 Tells the compiler to perform function calls by first loading the
5309 address of the function into a register and then performing a subroutine
5310 call on this register.  This switch is needed if the target function
5311 will lie outside of the 64 megabyte addressing range of the offset based
5312 version of subroutine call instruction. 
5314 Even if this switch is enabled, not all function calls will be turned
5315 into long calls.  The heuristic is that static functions, functions
5316 which have the @samp{short-call} attribute, functions that are inside
5317 the scope of a @samp{#pragma no_long_calls} directive and functions whose
5318 definitions have already been compiled within the current compilation
5319 unit, will not be turned into long calls.  The exception to this rule is
5320 that weak function definitions, functions with the @samp{long-call}
5321 attribute or the @samp{section} attribute, and functions that are within
5322 the scope of a @samp{#pragma long_calls} directive, will always be
5323 turned into long calls.
5325 This feature is not enabled by default.  Specifying
5326 @samp{--no-long-calls} will restore the default behaviour, as will
5327 placing the function calls within the scope of a @samp{#pragma
5328 long_calls_off} directive.  Note these switches have no effect on how
5329 the compiler generates code to handle function calls via function
5330 pointers.  
5332 @item -mnop-fun-dllimport
5333 @kindex -mnop-fun-dllimport
5334 Disable the support for the @emph{dllimport} attribute.
5336 @item -msingle-pic-base
5337 @kindex -msingle-pic-base
5338 Treat the register used for PIC addressing as read-only, rather than
5339 loading it in the prologue for each function.  The run-time system is
5340 responsible for initialising this register with an appropriate value
5341 before execution begins.
5343 @item -mpic-register=<reg>
5344 @kindex -mpic-register=
5345 Specify the register to be used for PIC addressing.  The default is R10
5346 unless stack-checking is enabled, when R9 is used.
5348 @end table
5350 @node Thumb Options
5351 @subsection Thumb Options
5352 @cindex Thumb Options
5354 @table @gcctabopt
5356 @item -mthumb-interwork
5357 @kindex -mthumb-interwork
5358 @kindex -mno-thumb-interwork
5359 Generate code which supports calling between the THUMB and ARM
5360 instruction sets.  Without this option the two instruction sets cannot
5361 be reliably used inside one program.  The default is
5362 @samp{-mno-thumb-interwork}, since slightly smaller code is generated
5363 with this option.
5365 @item -mtpcs-frame
5366 @kindex -mtpcs-frame
5367 @kindex -mno-tpcs-frame
5368 Generate a stack frame that is compliant with the Thumb Procedure Call
5369 Standard for all non-leaf functions.  (A leaf function is one that does
5370 not call any other functions).  The default is @samp{-mno-apcs-frame}. 
5372 @item -mtpcs-leaf-frame
5373 @kindex -mtpcs-leaf-frame
5374 @kindex -mno-tpcs-leaf-frame
5375 Generate a stack frame that is compliant with the Thumb Procedure Call
5376 Standard for all leaf functions.  (A leaf function is one that does
5377 not call any other functions).  The default is @samp{-mno-apcs-leaf-frame}. 
5379 @item -mlittle-endian
5380 @kindex -mlittle-endian
5381 Generate code for a processor running in little-endian mode.  This is
5382 the default for all standard configurations.
5384 @item -mbig-endian
5385 @kindex -mbig-endian
5386 Generate code for a processor running in big-endian mode.
5388 @item -mstructure-size-boundary=<n>
5389 @kindex -mstructure-size-boundary
5390 The size of all structures and unions will be rounded up to a multiple
5391 of the number of bits set by this option.  Permissible values are 8 and
5392 32.  The default value varies for different toolchains.  For the COFF
5393 targeted toolchain the default value is 8.  Specifying the larger number
5394 can produced faster, more efficient code, but can also increase the size
5395 of the program.  The two values are potentially incompatible.  Code
5396 compiled with one value cannot necessarily expect to work with code or
5397 libraries compiled with the other value, if they exchange information
5398 using structures or unions.  Programmers are encouraged to use the 32
5399 value as future versions of the toolchain may default to this value.
5401 @item -mnop-fun-dllimport
5402 @kindex -mnop-fun-dllimport
5403 Disable the support for the @emph{dllimport} attribute.
5405 @item -mcallee-super-interworking
5406 @kindex -mcallee-super-interworking
5407 Gives all externally visible functions in the file being compiled an ARM
5408 instruction set header which switches to Thumb mode before executing the
5409 rest of the function.  This allows these functions to be called from
5410 non-interworking code.
5412 @item -mcaller-super-interworking
5413 @kindex -mcaller-super-interworking
5414 Allows calls via function pointers (including virtual functions) to
5415 execute correctly regardless of whether the target code has been
5416 compiled for interworking or not.  There is a small overhead in the cost
5417 of executing a function pointer if this option is enabled.
5419 @item -msingle-pic-base
5420 @kindex -msingle-pic-base
5421 Treat the register used for PIC addressing as read-only, rather than
5422 loading it in the prologue for each function.  The run-time system is
5423 responsible for initialising this register with an appropriate value
5424 before execution begins.
5426 @item -mpic-register=<reg>
5427 @kindex -mpic-register=
5428 Specify the register to be used for PIC addressing.  The default is R10.
5430 @end table
5432 @node MN10200 Options
5433 @subsection MN10200 Options
5434 @cindex MN10200 options
5435 These @samp{-m} options are defined for Matsushita MN10200 architectures:
5436 @table @gcctabopt
5438 @item -mrelax
5439 Indicate to the linker that it should perform a relaxation optimization pass
5440 to shorten branches, calls and absolute memory addresses.  This option only
5441 has an effect when used on the command line for the final link step.
5443 This option makes symbolic debugging impossible. 
5444 @end table
5446 @node MN10300 Options
5447 @subsection MN10300 Options
5448 @cindex MN10300 options
5449 These @samp{-m} options are defined for Matsushita MN10300 architectures:
5451 @table @gcctabopt
5452 @item -mmult-bug
5453 Generate code to avoid bugs in the multiply instructions for the MN10300
5454 processors.  This is the default.
5456 @item -mno-mult-bug
5457 Do not generate code to avoid bugs in the multiply instructions for the
5458 MN10300 processors.
5460 @item -mam33
5461 Generate code which uses features specific to the AM33 processor.
5463 @item -mno-am33
5464 Do not generate code which uses features specific to the AM33 processor.  This
5465 is the default.
5467 @item -mrelax
5468 Indicate to the linker that it should perform a relaxation optimization pass
5469 to shorten branches, calls and absolute memory addresses.  This option only
5470 has an effect when used on the command line for the final link step.
5472 This option makes symbolic debugging impossible. 
5473 @end table
5476 @node M32R/D Options
5477 @subsection M32R/D Options
5478 @cindex M32R/D options
5480 These @samp{-m} options are defined for Mitsubishi M32R/D architectures:
5482 @table @gcctabopt
5483 @item -mcode-model=small
5484 Assume all objects live in the lower 16MB of memory (so that their addresses
5485 can be loaded with the @code{ld24} instruction), and assume all subroutines
5486 are reachable with the @code{bl} instruction.
5487 This is the default.
5489 The addressability of a particular object can be set with the
5490 @code{model} attribute.
5492 @item -mcode-model=medium
5493 Assume objects may be anywhere in the 32 bit address space (the compiler
5494 will generate @code{seth/add3} instructions to load their addresses), and
5495 assume all subroutines are reachable with the @code{bl} instruction.
5497 @item -mcode-model=large
5498 Assume objects may be anywhere in the 32 bit address space (the compiler
5499 will generate @code{seth/add3} instructions to load their addresses), and
5500 assume subroutines may not be reachable with the @code{bl} instruction
5501 (the compiler will generate the much slower @code{seth/add3/jl}
5502 instruction sequence).
5504 @item -msdata=none
5505 Disable use of the small data area.  Variables will be put into
5506 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
5507 @code{section} attribute has been specified).
5508 This is the default.
5510 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
5511 Objects may be explicitly put in the small data area with the
5512 @code{section} attribute using one of these sections.
5514 @item -msdata=sdata
5515 Put small global and static data in the small data area, but do not
5516 generate special code to reference them.
5518 @item -msdata=use
5519 Put small global and static data in the small data area, and generate
5520 special instructions to reference them.
5522 @item -G @var{num}
5523 @cindex smaller data references
5524 Put global and static objects less than or equal to @var{num} bytes
5525 into the small data or bss sections instead of the normal data or bss
5526 sections.  The default value of @var{num} is 8.
5527 The @samp{-msdata} option must be set to one of @samp{sdata} or @samp{use}
5528 for this option to have any effect.
5530 All modules should be compiled with the same @samp{-G @var{num}} value.
5531 Compiling with different values of @var{num} may or may not work; if it
5532 doesn't the linker will give an error message - incorrect code will not be
5533 generated.
5535 @end table
5537 @node M88K Options
5538 @subsection M88K Options
5539 @cindex M88k options
5541 These @samp{-m} options are defined for Motorola 88k architectures:
5543 @table @gcctabopt
5544 @item -m88000
5545 @kindex -m88000
5546 Generate code that works well on both the m88100 and the
5547 m88110.
5549 @item -m88100
5550 @kindex -m88100
5551 Generate code that works best for the m88100, but that also
5552 runs on the m88110.
5554 @item -m88110
5555 @kindex -m88110
5556 Generate code that works best for the m88110, and may not run
5557 on the m88100.
5559 @item -mbig-pic
5560 @kindex -mbig-pic
5561 Obsolete option to be removed from the next revision.
5562 Use @samp{-fPIC}.
5564 @item -midentify-revision
5565 @kindex -midentify-revision
5566 @kindex ident
5567 @cindex identifying source, compiler (88k)
5568 Include an @code{ident} directive in the assembler output recording the
5569 source file name, compiler name and version, timestamp, and compilation
5570 flags used.
5572 @item -mno-underscores
5573 @kindex -mno-underscores
5574 @cindex underscores, avoiding (88k)
5575 In assembler output, emit symbol names without adding an underscore
5576 character at the beginning of each name.  The default is to use an
5577 underscore as prefix on each name.
5579 @item -mocs-debug-info
5580 @itemx -mno-ocs-debug-info
5581 @kindex -mocs-debug-info
5582 @kindex -mno-ocs-debug-info
5583 @cindex OCS (88k)
5584 @cindex debugging, 88k OCS
5585 Include (or omit) additional debugging information (about registers used
5586 in each stack frame) as specified in the 88open Object Compatibility
5587 Standard, ``OCS''.  This extra information allows debugging of code that
5588 has had the frame pointer eliminated.  The default for DG/UX, SVr4, and
5589 Delta 88 SVr3.2 is to include this information; other 88k configurations
5590 omit this information by default.
5592 @item -mocs-frame-position
5593 @kindex -mocs-frame-position
5594 @cindex register positions in frame (88k)
5595 When emitting COFF debugging information for automatic variables and
5596 parameters stored on the stack, use the offset from the canonical frame
5597 address, which is the stack pointer (register 31) on entry to the
5598 function.  The DG/UX, SVr4, Delta88 SVr3.2, and BCS configurations use
5599 @samp{-mocs-frame-position}; other 88k configurations have the default
5600 @samp{-mno-ocs-frame-position}.
5602 @item -mno-ocs-frame-position
5603 @kindex -mno-ocs-frame-position
5604 @cindex register positions in frame (88k)
5605 When emitting COFF debugging information for automatic variables and
5606 parameters stored on the stack, use the offset from the frame pointer
5607 register (register 30).  When this option is in effect, the frame
5608 pointer is not eliminated when debugging information is selected by the
5609 -g switch.
5611 @item -moptimize-arg-area
5612 @itemx -mno-optimize-arg-area
5613 @kindex -moptimize-arg-area
5614 @kindex -mno-optimize-arg-area
5615 @cindex arguments in frame (88k)
5616 Control how function arguments are stored in stack frames.
5617 @samp{-moptimize-arg-area} saves space by optimizing them, but this
5618 conflicts with the 88open specifications.  The opposite alternative,
5619 @samp{-mno-optimize-arg-area}, agrees with 88open standards.  By default
5620 GCC does not optimize the argument area.
5622 @item -mshort-data-@var{num}
5623 @kindex -mshort-data-@var{num}
5624 @cindex smaller data references (88k)
5625 @cindex r0-relative references (88k)
5626 Generate smaller data references by making them relative to @code{r0},
5627 which allows loading a value using a single instruction (rather than the
5628 usual two).  You control which data references are affected by
5629 specifying @var{num} with this option.  For example, if you specify
5630 @samp{-mshort-data-512}, then the data references affected are those
5631 involving displacements of less than 512 bytes.
5632 @samp{-mshort-data-@var{num}} is not effective for @var{num} greater
5633 than 64k.
5635 @item -mserialize-volatile
5636 @kindex -mserialize-volatile
5637 @itemx -mno-serialize-volatile
5638 @kindex -mno-serialize-volatile
5639 @cindex sequential consistency on 88k
5640 Do, or don't, generate code to guarantee sequential consistency
5641 of volatile memory references.  By default, consistency is
5642 guaranteed.
5644 The order of memory references made by the MC88110 processor does
5645 not always match the order of the instructions requesting those
5646 references.  In particular, a load instruction may execute before
5647 a preceding store instruction.  Such reordering violates
5648 sequential consistency of volatile memory references, when there
5649 are multiple processors.   When consistency must be guaranteed,
5650 GNU C generates special instructions, as needed, to force
5651 execution in the proper order.
5653 The MC88100 processor does not reorder memory references and so
5654 always provides sequential consistency.  However, by default, GNU
5655 C generates the special instructions to guarantee consistency
5656 even when you use @samp{-m88100}, so that the code may be run on an
5657 MC88110 processor.  If you intend to run your code only on the
5658 MC88100 processor, you may use @samp{-mno-serialize-volatile}.
5660 The extra code generated to guarantee consistency may affect the
5661 performance of your application.  If you know that you can safely
5662 forgo this guarantee, you may use @samp{-mno-serialize-volatile}.
5664 @item -msvr4
5665 @itemx -msvr3
5666 @kindex -msvr4
5667 @kindex -msvr3
5668 @cindex assembler syntax, 88k
5669 @cindex SVr4
5670 Turn on (@samp{-msvr4}) or off (@samp{-msvr3}) compiler extensions
5671 related to System V release 4 (SVr4).  This controls the following:
5673 @enumerate
5674 @item
5675 Which variant of the assembler syntax to emit.
5676 @item
5677 @samp{-msvr4} makes the C preprocessor recognize @samp{#pragma weak}
5678 that is used on System V release 4.
5679 @item
5680 @samp{-msvr4} makes GCC issue additional declaration directives used in
5681 SVr4.
5682 @end enumerate
5684 @samp{-msvr4} is the default for the m88k-motorola-sysv4 and
5685 m88k-dg-dgux m88k configurations. @samp{-msvr3} is the default for all
5686 other m88k configurations.
5688 @item -mversion-03.00
5689 @kindex -mversion-03.00
5690 This option is obsolete, and is ignored.
5691 @c ??? which asm syntax better for GAS?  option there too?
5693 @item -mno-check-zero-division
5694 @itemx -mcheck-zero-division
5695 @kindex -mno-check-zero-division
5696 @kindex -mcheck-zero-division
5697 @cindex zero division on 88k
5698 Do, or don't, generate code to guarantee that integer division by
5699 zero will be detected.  By default, detection is guaranteed.
5701 Some models of the MC88100 processor fail to trap upon integer
5702 division by zero under certain conditions.  By default, when
5703 compiling code that might be run on such a processor, GNU C
5704 generates code that explicitly checks for zero-valued divisors
5705 and traps with exception number 503 when one is detected.  Use of
5706 mno-check-zero-division suppresses such checking for code
5707 generated to run on an MC88100 processor.
5709 GNU C assumes that the MC88110 processor correctly detects all
5710 instances of integer division by zero.  When @samp{-m88110} is
5711 specified, both @samp{-mcheck-zero-division} and
5712 @samp{-mno-check-zero-division} are ignored, and no explicit checks for
5713 zero-valued divisors are generated.
5715 @item -muse-div-instruction
5716 @kindex -muse-div-instruction
5717 @cindex divide instruction, 88k
5718 Use the div instruction for signed integer division on the
5719 MC88100 processor.  By default, the div instruction is not used.
5721 On the MC88100 processor the signed integer division instruction
5722 div) traps to the operating system on a negative operand.  The
5723 operating system transparently completes the operation, but at a
5724 large cost in execution time.  By default, when compiling code
5725 that might be run on an MC88100 processor, GNU C emulates signed
5726 integer division using the unsigned integer division instruction
5727 divu), thereby avoiding the large penalty of a trap to the
5728 operating system.  Such emulation has its own, smaller, execution
5729 cost in both time and space.  To the extent that your code's
5730 important signed integer division operations are performed on two
5731 nonnegative operands, it may be desirable to use the div
5732 instruction directly.
5734 On the MC88110 processor the div instruction (also known as the
5735 divs instruction) processes negative operands without trapping to
5736 the operating system.  When @samp{-m88110} is specified,
5737 @samp{-muse-div-instruction} is ignored, and the div instruction is used
5738 for signed integer division.
5740 Note that the result of dividing INT_MIN by -1 is undefined.  In
5741 particular, the behavior of such a division with and without
5742 @samp{-muse-div-instruction}  may differ.
5744 @item -mtrap-large-shift
5745 @itemx -mhandle-large-shift
5746 @kindex -mtrap-large-shift
5747 @kindex -mhandle-large-shift
5748 @cindex bit shift overflow (88k)
5749 @cindex large bit shifts (88k)
5750 Include code to detect bit-shifts of more than 31 bits; respectively,
5751 trap such shifts or emit code to handle them properly.  By default GCC
5752 makes no special provision for large bit shifts.
5754 @item -mwarn-passed-structs
5755 @kindex -mwarn-passed-structs
5756 @cindex structure passing (88k)
5757 Warn when a function passes a struct as an argument or result.
5758 Structure-passing conventions have changed during the evolution of the C
5759 language, and are often the source of portability problems.  By default,
5760 GCC issues no such warning.
5761 @end table
5763 @node RS/6000 and PowerPC Options
5764 @subsection IBM RS/6000 and PowerPC Options
5765 @cindex RS/6000 and PowerPC Options
5766 @cindex IBM RS/6000 and PowerPC Options
5768 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
5769 @table @gcctabopt
5770 @item -mpower
5771 @itemx -mno-power
5772 @itemx -mpower2
5773 @itemx -mno-power2
5774 @itemx -mpowerpc
5775 @itemx -mno-powerpc
5776 @itemx -mpowerpc-gpopt
5777 @itemx -mno-powerpc-gpopt
5778 @itemx -mpowerpc-gfxopt
5779 @itemx -mno-powerpc-gfxopt
5780 @itemx -mpowerpc64
5781 @itemx -mno-powerpc64
5782 @kindex -mpower
5783 @kindex -mpower2
5784 @kindex -mpowerpc
5785 @kindex -mpowerpc-gpopt
5786 @kindex -mpowerpc-gfxopt
5787 @kindex -mpowerpc64
5788 GCC supports two related instruction set architectures for the
5789 RS/6000 and PowerPC.  The @dfn{POWER} instruction set are those
5790 instructions supported by the @samp{rios} chip set used in the original
5791 RS/6000 systems and the @dfn{PowerPC} instruction set is the
5792 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
5793 the IBM 4xx microprocessors.
5795 Neither architecture is a subset of the other.  However there is a
5796 large common subset of instructions supported by both.  An MQ
5797 register is included in processors supporting the POWER architecture.
5799 You use these options to specify which instructions are available on the
5800 processor you are using.  The default value of these options is
5801 determined when configuring GCC.  Specifying the
5802 @samp{-mcpu=@var{cpu_type}} overrides the specification of these
5803 options.  We recommend you use the @samp{-mcpu=@var{cpu_type}} option
5804 rather than the options listed above.
5806 The @samp{-mpower} option allows GCC to generate instructions that
5807 are found only in the POWER architecture and to use the MQ register.
5808 Specifying @samp{-mpower2} implies @samp{-power} and also allows GCC
5809 to generate instructions that are present in the POWER2 architecture but
5810 not the original POWER architecture.
5812 The @samp{-mpowerpc} option allows GCC to generate instructions that
5813 are found only in the 32-bit subset of the PowerPC architecture.
5814 Specifying @samp{-mpowerpc-gpopt} implies @samp{-mpowerpc} and also allows
5815 GCC to use the optional PowerPC architecture instructions in the
5816 General Purpose group, including floating-point square root.  Specifying
5817 @samp{-mpowerpc-gfxopt} implies @samp{-mpowerpc} and also allows GCC to
5818 use the optional PowerPC architecture instructions in the Graphics
5819 group, including floating-point select.
5821 The @samp{-mpowerpc64} option allows GCC to generate the additional
5822 64-bit instructions that are found in the full PowerPC64 architecture
5823 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
5824 @samp{-mno-powerpc64}.
5826 If you specify both @samp{-mno-power} and @samp{-mno-powerpc}, GCC
5827 will use only the instructions in the common subset of both
5828 architectures plus some special AIX common-mode calls, and will not use
5829 the MQ register.  Specifying both @samp{-mpower} and @samp{-mpowerpc}
5830 permits GCC to use any instruction from either architecture and to
5831 allow use of the MQ register; specify this for the Motorola MPC601.
5833 @item -mnew-mnemonics
5834 @itemx -mold-mnemonics
5835 @kindex -mnew-mnemonics
5836 @kindex -mold-mnemonics
5837 Select which mnemonics to use in the generated assembler code.
5838 @samp{-mnew-mnemonics} requests output that uses the assembler mnemonics
5839 defined for the PowerPC architecture, while @samp{-mold-mnemonics}
5840 requests the assembler mnemonics defined for the POWER architecture.
5841 Instructions defined in only one architecture have only one mnemonic;
5842 GCC uses that mnemonic irrespective of which of these options is
5843 specified.
5845 GCC defaults to the mnemonics appropriate for the architecture in
5846 use.  Specifying @samp{-mcpu=@var{cpu_type}} sometimes overrides the
5847 value of these option.  Unless you are building a cross-compiler, you
5848 should normally not specify either @samp{-mnew-mnemonics} or
5849 @samp{-mold-mnemonics}, but should instead accept the default.
5851 @item -mcpu=@var{cpu_type}
5852 @kindex -mcpu
5853 Set architecture type, register usage, choice of mnemonics, and
5854 instruction scheduling parameters for machine type @var{cpu_type}.
5855 Supported values for @var{cpu_type} are @samp{rios}, @samp{rios1},
5856 @samp{rsc}, @samp{rios2}, @samp{rs64a}, @samp{601}, @samp{602},
5857 @samp{603}, @samp{603e}, @samp{604}, @samp{604e}, @samp{620},
5858 @samp{630}, @samp{740}, @samp{750}, @samp{power}, @samp{power2},
5859 @samp{powerpc}, @samp{403}, @samp{505}, @samp{801}, @samp{821},
5860 @samp{823}, and @samp{860} and @samp{common}.  @samp{-mcpu=power},
5861 @samp{-mcpu=power2}, @samp{-mcpu=powerpc}, and @samp{-mcpu=powerpc64}
5862 specify generic POWER, POWER2, pure 32-bit PowerPC (i.e., not MPC601),
5863 and 64-bit PowerPC architecture machine types, with an appropriate,
5864 generic processor model assumed for scheduling purposes.@refill
5866 Specifying any of the following options: 
5867 @samp{-mcpu=rios1}, @samp{-mcpu=rios2}, @samp{-mcpu=rsc},
5868 @samp{-mcpu=power}, or @samp{-mcpu=power2}  
5869 enables the @samp{-mpower} option and disables the @samp{-mpowerpc} option; 
5870 @samp{-mcpu=601} enables both the @samp{-mpower} and @samp{-mpowerpc} options.
5871 All of @samp{-mcpu=rs64a}, @samp{-mcpu=602}, @samp{-mcpu=603},
5872 @samp{-mcpu=603e}, @samp{-mcpu=604}, @samp{-mcpu=620}, @samp{-mcpu=630},
5873 @samp{-mcpu=740}, and @samp{-mcpu=750}
5874 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.  
5875 Exactly similarly, all of @samp{-mcpu=403},
5876 @samp{-mcpu=505}, @samp{-mcpu=821}, @samp{-mcpu=860} and @samp{-mcpu=powerpc} 
5877 enable the @samp{-mpowerpc} option and disable the @samp{-mpower} option.
5878 @samp{-mcpu=common} disables both the 
5879 @samp{-mpower} and @samp{-mpowerpc} options.@refill
5881 AIX versions 4 or greater selects @samp{-mcpu=common} by default, so
5882 that code will operate on all members of the RS/6000 POWER and PowerPC
5883 families.  In that case, GCC will use only the instructions in the
5884 common subset of both architectures plus some special AIX common-mode
5885 calls, and will not use the MQ register.  GCC assumes a generic
5886 processor model for scheduling purposes.
5888 Specifying any of the options @samp{-mcpu=rios1}, @samp{-mcpu=rios2},
5889 @samp{-mcpu=rsc}, @samp{-mcpu=power}, or @samp{-mcpu=power2} also
5890 disables the @samp{new-mnemonics} option.  Specifying @samp{-mcpu=601},
5891 @samp{-mcpu=602}, @samp{-mcpu=603}, @samp{-mcpu=603e}, @samp{-mcpu=604},
5892 @samp{-mcpu=620}, @samp{-mcpu=630}, @samp{-mcpu=403}, @samp{-mcpu=505},
5893 @samp{-mcpu=821}, @samp{-mcpu=860} or @samp{-mcpu=powerpc} also enables
5894 the @samp{new-mnemonics} option.@refill
5896 Specifying @samp{-mcpu=403}, @samp{-mcpu=821}, or @samp{-mcpu=860} also
5897 enables the @samp{-msoft-float} option.
5899 @item -mtune=@var{cpu_type}
5900 Set the instruction scheduling parameters for machine type
5901 @var{cpu_type}, but do not set the architecture type, register usage,
5902 choice of mnemonics like @samp{-mcpu=}@var{cpu_type} would.  The same
5903 values for @var{cpu_type} are used for @samp{-mtune=}@var{cpu_type} as
5904 for @samp{-mcpu=}@var{cpu_type}.  The @samp{-mtune=}@var{cpu_type}
5905 option overrides the @samp{-mcpu=}@var{cpu_type} option in terms of
5906 instruction scheduling parameters.
5908 @item -mfull-toc
5909 @itemx -mno-fp-in-toc
5910 @itemx -mno-sum-in-toc
5911 @itemx -mminimal-toc
5912 @kindex -mminimal-toc
5913 Modify generation of the TOC (Table Of Contents), which is created for
5914 every executable file.  The @samp{-mfull-toc} option is selected by
5915 default.  In that case, GCC will allocate at least one TOC entry for
5916 each unique non-automatic variable reference in your program.  GCC
5917 will also place floating-point constants in the TOC.  However, only
5918 16,384 entries are available in the TOC.
5920 If you receive a linker error message that saying you have overflowed
5921 the available TOC space, you can reduce the amount of TOC space used
5922 with the @samp{-mno-fp-in-toc} and @samp{-mno-sum-in-toc} options.
5923 @samp{-mno-fp-in-toc} prevents GCC from putting floating-point
5924 constants in the TOC and @samp{-mno-sum-in-toc} forces GCC to
5925 generate code to calculate the sum of an address and a constant at
5926 run-time instead of putting that sum into the TOC.  You may specify one
5927 or both of these options.  Each causes GCC to produce very slightly
5928 slower and larger code at the expense of conserving TOC space.
5930 If you still run out of space in the TOC even when you specify both of
5931 these options, specify @samp{-mminimal-toc} instead.  This option causes
5932 GCC to make only one TOC entry for every file.  When you specify this
5933 option, GCC will produce code that is slower and larger but which
5934 uses extremely little TOC space.  You may wish to use this option
5935 only on files that contain less frequently executed code. @refill
5937 @item -maix64
5938 @itemx -maix32
5939 @kindex -maix64
5940 @kindex -maix32
5941 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
5942 @code{long} type, and the infrastructure needed to support them.
5943 Specifying @samp{-maix64} implies @samp{-mpowerpc64} and
5944 @samp{-mpowerpc}, while @samp{-maix32} disables the 64-bit ABI and
5945 implies @samp{-mno-powerpc64}.  GCC defaults to @samp{-maix32}.
5947 @item -mxl-call
5948 @itemx -mno-xl-call
5949 @kindex -mxl-call
5950 On AIX, pass floating-point arguments to prototyped functions beyond the
5951 register save area (RSA) on the stack in addition to argument FPRs.  The
5952 AIX calling convention was extended but not initially documented to
5953 handle an obscure K&R C case of calling a function that takes the
5954 address of its arguments with fewer arguments than declared.  AIX XL
5955 compilers access floating point arguments which do not fit in the
5956 RSA from the stack when a subroutine is compiled without
5957 optimization.  Because always storing floating-point arguments on the
5958 stack is inefficient and rarely needed, this option is not enabled by
5959 default and only is necessary when calling subroutines compiled by AIX
5960 XL compilers without optimization.
5962 @item -mthreads
5963 @kindex -mthreads
5964 Support @dfn{AIX Threads}.  Link an application written to use
5965 @dfn{pthreads} with special libraries and startup code to enable the
5966 application to run.
5968 @item -mpe
5969 @kindex -mpe
5970 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE).  Link an
5971 application written to use message passing with special startup code to
5972 enable the application to run.  The system must have PE installed in the
5973 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
5974 must be overridden with the @samp{-specs=} option to specify the
5975 appropriate directory location.  The Parallel Environment does not
5976 support threads, so the @samp{-mpe} option and the @samp{-mthreads}
5977 option are incompatible.
5979 @item -msoft-float
5980 @itemx -mhard-float
5981 @kindex -msoft-float
5982 Generate code that does not use (uses) the floating-point register set.
5983 Software floating point emulation is provided if you use the
5984 @samp{-msoft-float} option, and pass the option to GCC when linking.
5986 @item -mmultiple
5987 @itemx -mno-multiple
5988 Generate code that uses (does not use) the load multiple word
5989 instructions and the store multiple word instructions.  These
5990 instructions are generated by default on POWER systems, and not
5991 generated on PowerPC systems.  Do not use @samp{-mmultiple} on little
5992 endian PowerPC systems, since those instructions do not work when the
5993 processor is in little endian mode.  The exceptions are PPC740 and
5994 PPC750 which permit the instructions usage in little endian mode.
5996 @item -mstring
5997 @itemx -mno-string
5998 @kindex -mstring
5999 Generate code that uses (does not use) the load string instructions
6000 and the store string word instructions to save multiple registers and
6001 do small block moves.  These instructions are generated by default on
6002 POWER systems, and not generated on PowerPC systems.  Do not use
6003 @samp{-mstring} on little endian PowerPC systems, since those
6004 instructions do not work when the processor is in little endian mode.
6005 The exceptions are PPC740 and PPC750 which permit the instructions
6006 usage in little endian mode.
6008 @item -mupdate
6009 @itemx -mno-update
6010 @kindex -mupdate
6011 Generate code that uses (does not use) the load or store instructions
6012 that update the base register to the address of the calculated memory
6013 location.  These instructions are generated by default.  If you use
6014 @samp{-mno-update}, there is a small window between the time that the
6015 stack pointer is updated and the address of the previous frame is
6016 stored, which means code that walks the stack frame across interrupts or
6017 signals may get corrupted data.
6019 @item -mfused-madd
6020 @itemx -mno-fused-madd
6021 @kindex -mfused-madd
6022 Generate code that uses (does not use) the floating point multiply and
6023 accumulate instructions.  These instructions are generated by default if
6024 hardware floating is used.
6026 @item -mno-bit-align
6027 @itemx -mbit-align
6028 @kindex -mbit-align
6029 On System V.4 and embedded PowerPC systems do not (do) force structures
6030 and unions that contain bit fields to be aligned to the base type of the
6031 bit field.
6033 For example, by default a structure containing nothing but 8
6034 @code{unsigned} bitfields of length 1 would be aligned to a 4 byte
6035 boundary and have a size of 4 bytes.  By using @samp{-mno-bit-align},
6036 the structure would be aligned to a 1 byte boundary and be one byte in
6037 size.
6039 @item -mno-strict-align
6040 @itemx -mstrict-align
6041 @kindex -mstrict-align
6042 On System V.4 and embedded PowerPC systems do not (do) assume that
6043 unaligned memory references will be handled by the system.
6045 @item -mrelocatable
6046 @itemx -mno-relocatable
6047 @kindex -mrelocatable
6048 On embedded PowerPC systems generate code that allows (does not allow)
6049 the program to be relocated to a different address at runtime.  If you
6050 use @samp{-mrelocatable} on any module, all objects linked together must
6051 be compiled with @samp{-mrelocatable} or @samp{-mrelocatable-lib}.
6053 @item -mrelocatable-lib
6054 @itemx -mno-relocatable-lib
6055 On embedded PowerPC systems generate code that allows (does not allow)
6056 the program to be relocated to a different address at runtime.  Modules
6057 compiled with @samp{-mrelocatable-lib} can be linked with either modules
6058 compiled without @samp{-mrelocatable} and @samp{-mrelocatable-lib} or
6059 with modules compiled with the @samp{-mrelocatable} options.
6061 @item -mno-toc
6062 @itemx -mtoc
6063 On System V.4 and embedded PowerPC systems do not (do) assume that
6064 register 2 contains a pointer to a global area pointing to the addresses
6065 used in the program.
6067 @item -mlittle
6068 @itemx -mlittle-endian
6069 On System V.4 and embedded PowerPC systems compile code for the
6070 processor in little endian mode.  The @samp{-mlittle-endian} option is
6071 the same as @samp{-mlittle}.
6073 @item -mbig
6074 @itemx -mbig-endian
6075 On System V.4 and embedded PowerPC systems compile code for the
6076 processor in big endian mode.  The @samp{-mbig-endian} option is
6077 the same as @samp{-mbig}.
6079 @item -mcall-sysv
6080 On System V.4 and embedded PowerPC systems compile code using calling
6081 conventions that adheres to the March 1995 draft of the System V
6082 Application Binary Interface, PowerPC processor supplement.  This is the
6083 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
6085 @item -mcall-sysv-eabi
6086 Specify both @samp{-mcall-sysv} and @samp{-meabi} options.
6088 @item -mcall-sysv-noeabi
6089 Specify both @samp{-mcall-sysv} and @samp{-mno-eabi} options.
6091 @item -mcall-aix
6092 On System V.4 and embedded PowerPC systems compile code using calling
6093 conventions that are similar to those used on AIX.  This is the
6094 default if you configured GCC using @samp{powerpc-*-eabiaix}.
6096 @item -mcall-solaris
6097 On System V.4 and embedded PowerPC systems compile code for the Solaris
6098 operating system.
6100 @item -mcall-linux
6101 On System V.4 and embedded PowerPC systems compile code for the
6102 Linux-based GNU system.
6104 @item -mprototype
6105 @itemx -mno-prototype
6106 On System V.4 and embedded PowerPC systems assume that all calls to
6107 variable argument functions are properly prototyped.  Otherwise, the
6108 compiler must insert an instruction before every non prototyped call to
6109 set or clear bit 6 of the condition code register (@var{CR}) to
6110 indicate whether floating point values were passed in the floating point
6111 registers in case the function takes a variable arguments.  With
6112 @samp{-mprototype}, only calls to prototyped variable argument functions
6113 will set or clear the bit.
6115 @item -msim
6116 On embedded PowerPC systems, assume that the startup module is called
6117 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
6118 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
6119 configurations.
6121 @item -mmvme
6122 On embedded PowerPC systems, assume that the startup module is called
6123 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
6124 @file{libc.a}.
6126 @item -mads
6127 On embedded PowerPC systems, assume that the startup module is called
6128 @file{crt0.o} and the standard C libraries are @file{libads.a} and
6129 @file{libc.a}.
6131 @item -myellowknife
6132 On embedded PowerPC systems, assume that the startup module is called
6133 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
6134 @file{libc.a}.
6136 @item -mvxworks
6137 On System V.4 and embedded PowerPC systems, specify that you are
6138 compiling for a VxWorks system.
6140 @item -memb
6141 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
6142 header to indicate that @samp{eabi} extended relocations are used.
6144 @item -meabi
6145 @itemx -mno-eabi
6146 On System V.4 and embedded PowerPC systems do (do not) adhere to the
6147 Embedded Applications Binary Interface (eabi) which is a set of
6148 modifications to the System V.4 specifications.  Selecting @option{-meabi}
6149 means that the stack is aligned to an 8 byte boundary, a function
6150 @code{__eabi} is called to from @code{main} to set up the eabi
6151 environment, and the @samp{-msdata} option can use both @code{r2} and
6152 @code{r13} to point to two separate small data areas.  Selecting
6153 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
6154 do not call an initialization function from @code{main}, and the
6155 @samp{-msdata} option will only use @code{r13} to point to a single
6156 small data area.  The @samp{-meabi} option is on by default if you
6157 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
6159 @item -msdata=eabi
6160 On System V.4 and embedded PowerPC systems, put small initialized
6161 @code{const} global and static data in the @samp{.sdata2} section, which
6162 is pointed to by register @code{r2}.  Put small initialized
6163 non-@code{const} global and static data in the @samp{.sdata} section,
6164 which is pointed to by register @code{r13}.  Put small uninitialized
6165 global and static data in the @samp{.sbss} section, which is adjacent to
6166 the @samp{.sdata} section.  The @samp{-msdata=eabi} option is
6167 incompatible with the @samp{-mrelocatable} option.  The
6168 @samp{-msdata=eabi} option also sets the @samp{-memb} option.
6170 @item -msdata=sysv
6171 On System V.4 and embedded PowerPC systems, put small global and static
6172 data in the @samp{.sdata} section, which is pointed to by register
6173 @code{r13}.  Put small uninitialized global and static data in the
6174 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
6175 The @samp{-msdata=sysv} option is incompatible with the
6176 @samp{-mrelocatable} option.
6178 @item -msdata=default
6179 @itemx -msdata
6180 On System V.4 and embedded PowerPC systems, if @samp{-meabi} is used,
6181 compile code the same as @samp{-msdata=eabi}, otherwise compile code the
6182 same as @samp{-msdata=sysv}.
6184 @item -msdata-data
6185 On System V.4 and embedded PowerPC systems, put small global and static
6186 data in the @samp{.sdata} section.  Put small uninitialized global and
6187 static data in the @samp{.sbss} section.  Do not use register @code{r13}
6188 to address small data however.  This is the default behavior unless
6189 other @samp{-msdata} options are used.
6191 @item -msdata=none
6192 @itemx -mno-sdata
6193 On embedded PowerPC systems, put all initialized global and static data
6194 in the @samp{.data} section, and all uninitialized data in the
6195 @samp{.bss} section.
6197 @item -G @var{num}
6198 @cindex smaller data references (PowerPC)
6199 @cindex .sdata/.sdata2 references (PowerPC)
6200 On embedded PowerPC systems, put global and static items less than or
6201 equal to @var{num} bytes into the small data or bss sections instead of
6202 the normal data or bss section.  By default, @var{num} is 8.  The
6203 @samp{-G @var{num}} switch is also passed to the linker.
6204 All modules should be compiled with the same @samp{-G @var{num}} value.
6206 @item -mregnames
6207 @itemx -mno-regnames
6208 On System V.4 and embedded PowerPC systems do (do not) emit register
6209 names in the assembly language output using symbolic forms.
6211 @end table
6213 @node RT Options
6214 @subsection IBM RT Options
6215 @cindex RT options
6216 @cindex IBM RT options
6218 These @samp{-m} options are defined for the IBM RT PC:
6220 @table @gcctabopt
6221 @item -min-line-mul
6222 Use an in-line code sequence for integer multiplies.  This is the
6223 default.
6225 @item -mcall-lib-mul
6226 Call @code{lmul$$} for integer multiples.
6228 @item -mfull-fp-blocks
6229 Generate full-size floating point data blocks, including the minimum
6230 amount of scratch space recommended by IBM.  This is the default.
6232 @item -mminimum-fp-blocks
6233 Do not include extra scratch space in floating point data blocks.  This
6234 results in smaller code, but slower execution, since scratch space must
6235 be allocated dynamically.
6237 @cindex @file{varargs.h} and RT PC
6238 @cindex @file{stdarg.h} and RT PC
6239 @item -mfp-arg-in-fpregs
6240 Use a calling sequence incompatible with the IBM calling convention in
6241 which floating point arguments are passed in floating point registers.
6242 Note that @code{varargs.h} and @code{stdargs.h} will not work with
6243 floating point operands if this option is specified.
6245 @item -mfp-arg-in-gregs
6246 Use the normal calling convention for floating point arguments.  This is
6247 the default.
6249 @item -mhc-struct-return
6250 Return structures of more than one word in memory, rather than in a
6251 register.  This provides compatibility with the MetaWare HighC (hc)
6252 compiler.  Use the option @samp{-fpcc-struct-return} for compatibility
6253 with the Portable C Compiler (pcc).
6255 @item -mnohc-struct-return
6256 Return some structures of more than one word in registers, when
6257 convenient.  This is the default.  For compatibility with the
6258 IBM-supplied compilers, use the option @samp{-fpcc-struct-return} or the
6259 option @samp{-mhc-struct-return}.
6260 @end table
6262 @node MIPS Options
6263 @subsection MIPS Options
6264 @cindex MIPS options
6266 These @samp{-m} options are defined for the MIPS family of computers:
6268 @table @gcctabopt
6269 @item -mcpu=@var{cpu type}
6270 Assume the defaults for the machine type @var{cpu type} when scheduling
6271 instructions.  The choices for @var{cpu type} are @samp{r2000}, @samp{r3000},
6272 @samp{r3900}, @samp{r4000}, @samp{r4100}, @samp{r4300}, @samp{r4400},
6273 @samp{r4600}, @samp{r4650}, @samp{r5000}, @samp{r6000}, @samp{r8000},
6274 and @samp{orion}.  Additionally, the @samp{r2000}, @samp{r3000},
6275 @samp{r4000}, @samp{r5000}, and @samp{r6000} can be abbreviated as
6276 @samp{r2k} (or @samp{r2K}), @samp{r3k}, etc.  While picking a specific
6277 @var{cpu type} will schedule things appropriately for that particular
6278 chip, the compiler will not generate any code that does not meet level 1
6279 of the MIPS ISA (instruction set architecture) without a @samp{-mipsX}
6280 or @samp{-mabi} switch being used.
6282 @item -mips1
6283 Issue instructions from level 1 of the MIPS ISA.  This is the default.
6284 @samp{r3000} is the default @var{cpu type} at this ISA level.
6286 @item -mips2
6287 Issue instructions from level 2 of the MIPS ISA (branch likely, square
6288 root instructions).  @samp{r6000} is the default @var{cpu type} at this
6289 ISA level.
6291 @item -mips3
6292 Issue instructions from level 3 of the MIPS ISA (64 bit instructions).
6293 @samp{r4000} is the default @var{cpu type} at this ISA level.
6295 @item -mips4
6296 Issue instructions from level 4 of the MIPS ISA (conditional move,
6297 prefetch, enhanced FPU instructions).  @samp{r8000} is the default
6298 @var{cpu type} at this ISA level.
6300 @item -mfp32
6301 Assume that 32 32-bit floating point registers are available.  This is
6302 the default.
6304 @item -mfp64
6305 Assume that 32 64-bit floating point registers are available.  This is
6306 the default when the @samp{-mips3} option is used.
6308 @item -mgp32
6309 Assume that 32 32-bit general purpose registers are available.  This is
6310 the default.
6312 @item -mgp64
6313 Assume that 32 64-bit general purpose registers are available.  This is
6314 the default when the @samp{-mips3} option is used.
6316 @item -mint64
6317 Force int and long types to be 64 bits wide.  See @samp{-mlong32} for an
6318 explanation of the default, and the width of pointers.
6320 @item -mlong64
6321 Force long types to be 64 bits wide.  See @samp{-mlong32} for an
6322 explanation of the default, and the width of pointers.
6324 @item -mlong32
6325 Force long, int, and pointer types to be 32 bits wide.
6327 If none of @samp{-mlong32}, @samp{-mlong64}, or @samp{-mint64} are set,
6328 the size of ints, longs, and pointers depends on the ABI and ISA chosen.
6329 For @samp{-mabi=32}, and @samp{-mabi=n32}, ints and longs are 32 bits
6330 wide.  For @samp{-mabi=64}, ints are 32 bits, and longs are 64 bits wide.
6331 For @samp{-mabi=eabi} and either @samp{-mips1} or @samp{-mips2}, ints
6332 and longs are 32 bits wide.  For @samp{-mabi=eabi} and higher ISAs, ints
6333 are 32 bits, and longs are 64 bits wide.  The width of pointer types is
6334 the smaller of the width of longs or the width of general purpose
6335 registers (which in turn depends on the ISA).
6337 @item -mabi=32
6338 @itemx -mabi=o64
6339 @itemx -mabi=n32
6340 @itemx -mabi=64
6341 @itemx -mabi=eabi
6342 Generate code for the indicated ABI.  The default instruction level is
6343 @samp{-mips1} for @samp{32}, @samp{-mips3} for @samp{n32}, and
6344 @samp{-mips4} otherwise.  Conversely, with @samp{-mips1} or
6345 @samp{-mips2}, the default ABI is @samp{32}; otherwise, the default ABI
6346 is @samp{64}.
6348 @item -mmips-as
6349 Generate code for the MIPS assembler, and invoke @file{mips-tfile} to
6350 add normal debug information.  This is the default for all
6351 platforms except for the OSF/1 reference platform, using the OSF/rose
6352 object format.  If the either of the @samp{-gstabs} or @samp{-gstabs+}
6353 switches are used, the @file{mips-tfile} program will encapsulate the
6354 stabs within MIPS ECOFF.
6356 @item -mgas
6357 Generate code for the GNU assembler.  This is the default on the OSF/1
6358 reference platform, using the OSF/rose object format.  Also, this is
6359 the default if the configure option @samp{--with-gnu-as} is used.
6361 @item -msplit-addresses
6362 @itemx -mno-split-addresses
6363 Generate code to load the high and low parts of address constants separately.
6364 This allows @code{gcc} to optimize away redundant loads of the high order
6365 bits of addresses.  This optimization requires GNU as and GNU ld.
6366 This optimization is enabled by default for some embedded targets where
6367 GNU as and GNU ld are standard.
6369 @item -mrnames
6370 @itemx -mno-rnames
6371 The @samp{-mrnames} switch says to output code using the MIPS software
6372 names for the registers, instead of the hardware names (ie, @var{a0}
6373 instead of @var{$4}).  The only known assembler that supports this option
6374 is the Algorithmics assembler.
6376 @item -mgpopt
6377 @itemx -mno-gpopt
6378 The @samp{-mgpopt} switch says to write all of the data declarations
6379 before the instructions in the text section, this allows the MIPS
6380 assembler to generate one word memory references instead of using two
6381 words for short global or static data items.  This is on by default if
6382 optimization is selected.
6384 @item -mstats
6385 @itemx -mno-stats
6386 For each non-inline function processed, the @samp{-mstats} switch
6387 causes the compiler to emit one line to the standard error file to
6388 print statistics about the program (number of registers saved, stack
6389 size, etc.).
6391 @item -mmemcpy
6392 @itemx -mno-memcpy
6393 The @samp{-mmemcpy} switch makes all block moves call the appropriate
6394 string function (@samp{memcpy} or @samp{bcopy}) instead of possibly
6395 generating inline code.
6397 @item -mmips-tfile
6398 @itemx -mno-mips-tfile
6399 The @samp{-mno-mips-tfile} switch causes the compiler not
6400 postprocess the object file with the @file{mips-tfile} program,
6401 after the MIPS assembler has generated it to add debug support.  If
6402 @file{mips-tfile} is not run, then no local variables will be
6403 available to the debugger.  In addition, @file{stage2} and
6404 @file{stage3} objects will have the temporary file names passed to the
6405 assembler embedded in the object file, which means the objects will
6406 not compare the same.  The @samp{-mno-mips-tfile} switch should only
6407 be used when there are bugs in the @file{mips-tfile} program that
6408 prevents compilation.
6410 @item -msoft-float
6411 Generate output containing library calls for floating point.
6412 @strong{Warning:} the requisite libraries are not part of GCC.
6413 Normally the facilities of the machine's usual C compiler are used, but
6414 this can't be done directly in cross-compilation.  You must make your
6415 own arrangements to provide suitable library functions for
6416 cross-compilation.
6418 @item -mhard-float
6419 Generate output containing floating point instructions.  This is the
6420 default if you use the unmodified sources.
6422 @item -mabicalls
6423 @itemx -mno-abicalls
6424 Emit (or do not emit) the pseudo operations @samp{.abicalls},
6425 @samp{.cpload}, and @samp{.cprestore} that some System V.4 ports use for
6426 position independent code.
6428 @item -mlong-calls
6429 @itemx -mno-long-calls
6430 Do all calls with the @samp{JALR} instruction, which requires
6431 loading up a function's address into a register before the call.
6432 You need to use this switch, if you call outside of the current
6433 512 megabyte segment to functions that are not through pointers.
6435 @item -mhalf-pic
6436 @itemx -mno-half-pic
6437 Put pointers to extern references into the data section and load them
6438 up, rather than put the references in the text section.
6440 @item -membedded-pic
6441 @itemx -mno-embedded-pic
6442 Generate PIC code suitable for some embedded systems.  All calls are
6443 made using PC relative address, and all data is addressed using the $gp
6444 register.  No more than 65536 bytes of global data may be used.  This
6445 requires GNU as and GNU ld which do most of the work.  This currently
6446 only works on targets which use ECOFF; it does not work with ELF.
6448 @item -membedded-data
6449 @itemx -mno-embedded-data
6450 Allocate variables to the read-only data section first if possible, then
6451 next in the small data section if possible, otherwise in data.  This gives
6452 slightly slower code than the default, but reduces the amount of RAM required
6453 when executing, and thus may be preferred for some embedded systems.
6455 @item -muninit-const-in-rodata
6456 @itemx -mno-uninit-const-in-rodata
6457 When used together with -membedded-data, it will always store uninitialized
6458 const variables in the read-only data section.
6459   
6460 @item -msingle-float
6461 @itemx -mdouble-float
6462 The @samp{-msingle-float} switch tells gcc to assume that the floating
6463 point coprocessor only supports single precision operations, as on the
6464 @samp{r4650} chip.  The @samp{-mdouble-float} switch permits gcc to use
6465 double precision operations.  This is the default.
6467 @item -mmad
6468 @itemx -mno-mad
6469 Permit use of the @samp{mad}, @samp{madu} and @samp{mul} instructions,
6470 as on the @samp{r4650} chip.
6472 @item -m4650
6473 Turns on @samp{-msingle-float}, @samp{-mmad}, and, at least for now,
6474 @samp{-mcpu=r4650}.
6476 @item -mips16
6477 @itemx -mno-mips16
6478 Enable 16-bit instructions.
6480 @item -mentry
6481 Use the entry and exit pseudo ops.  This option can only be used with
6482 @samp{-mips16}.
6484 @item -EL
6485 Compile code for the processor in little endian mode.
6486 The requisite libraries are assumed to exist.
6488 @item -EB
6489 Compile code for the processor in big endian mode.
6490 The requisite libraries are assumed to exist.
6492 @item -G @var{num}
6493 @cindex smaller data references (MIPS)
6494 @cindex gp-relative references (MIPS)
6495 Put global and static items less than or equal to @var{num} bytes into
6496 the small data or bss sections instead of the normal data or bss
6497 section.  This allows the assembler to emit one word memory reference
6498 instructions based on the global pointer (@var{gp} or @var{$28}),
6499 instead of the normal two words used.  By default, @var{num} is 8 when
6500 the MIPS assembler is used, and 0 when the GNU assembler is used.  The
6501 @samp{-G @var{num}} switch is also passed to the assembler and linker.
6502 All modules should be compiled with the same @samp{-G @var{num}}
6503 value.
6505 @item -nocpp
6506 Tell the MIPS assembler to not run its preprocessor over user
6507 assembler files (with a @samp{.s} suffix) when assembling them.
6509 @item -mfix7000
6510 Pass an option to gas which will cause nops to be inserted if
6511 the read of the destination register of an mfhi or mflo instruction
6512 occurs in the following two instructions.
6514 @item -no-crt0
6515 Do not include the default crt0.
6516 @end table
6518 @ifset INTERNALS
6519 These options are defined by the macro
6520 @code{TARGET_SWITCHES} in the machine description.  The default for the
6521 options is also defined by that macro, which enables you to change the
6522 defaults.
6523 @end ifset
6525 @node i386 Options
6526 @subsection Intel 386 Options
6527 @cindex i386 Options
6528 @cindex Intel 386 Options
6530 These @samp{-m} options are defined for the i386 family of computers:
6532 @table @gcctabopt
6533 @item -mcpu=@var{cpu type}
6534 Assume the defaults for the machine type @var{cpu type} when scheduling
6535 instructions.  The choices for @var{cpu type} are @samp{i386},
6536 @samp{i486}, @samp{i586}, @samp{i686}, @samp{pentium},
6537 @samp{pentiumpro}, @samp{pentium4}, @samp{k6}, and @samp{athlon}
6539 While picking a specific @var{cpu type} will schedule things appropriately
6540 for that particular chip, the compiler will not generate any code that
6541 does not run on the i386 without the @samp{-march=@var{cpu type}} option
6542 being used.  @samp{i586} is equivalent to @samp{pentium} and @samp{i686}
6543 is equivalent to @samp{pentiumpro}.  @samp{k6} and @samp{athlon} sre the
6544 AMD chips as opposed to the Intel ones.
6546 @item -march=@var{cpu type}
6547 Generate instructions for the machine type @var{cpu type}.  The choices
6548 for @var{cpu type} are the same as for @samp{-mcpu}.  Moreover, 
6549 specifying @samp{-march=@var{cpu type}} implies @samp{-mcpu=@var{cpu type}}.
6551 @item -m386
6552 @itemx -m486
6553 @itemx -mpentium
6554 @itemx -mpentiumpro
6555 Synonyms for -mcpu=i386, -mcpu=i486, -mcpu=pentium, and -mcpu=pentiumpro
6556 respectively.  These synonyms are deprecated.
6558 @item -mintel-syntax
6559 Emit assembly using Intel syntax opcodes instead of AT&T syntax.
6561 @item -mieee-fp
6562 @itemx -mno-ieee-fp
6563 Control whether or not the compiler uses IEEE floating point
6564 comparisons.  These handle correctly the case where the result of a
6565 comparison is unordered.
6567 @item -msoft-float
6568 Generate output containing library calls for floating point.
6569 @strong{Warning:} the requisite libraries are not part of GCC.
6570 Normally the facilities of the machine's usual C compiler are used, but
6571 this can't be done directly in cross-compilation.  You must make your
6572 own arrangements to provide suitable library functions for
6573 cross-compilation.
6575 On machines where a function returns floating point results in the 80387
6576 register stack, some floating point opcodes may be emitted even if
6577 @samp{-msoft-float} is used.
6579 @item -mno-fp-ret-in-387
6580 Do not use the FPU registers for return values of functions.
6582 The usual calling convention has functions return values of types
6583 @code{float} and @code{double} in an FPU register, even if there
6584 is no FPU.  The idea is that the operating system should emulate
6585 an FPU.
6587 The option @samp{-mno-fp-ret-in-387} causes such values to be returned
6588 in ordinary CPU registers instead.
6590 @item -mno-fancy-math-387
6591 Some 387 emulators do not support the @code{sin}, @code{cos} and
6592 @code{sqrt} instructions for the 387.  Specify this option to avoid
6593 generating those instructions. This option is the default on FreeBSD.
6594 As of revision 2.6.1, these instructions are not generated unless you
6595 also use the @samp{-ffast-math} switch.
6597 @item -malign-double
6598 @itemx -mno-align-double
6599 Control whether GCC aligns @code{double}, @code{long double}, and
6600 @code{long long} variables on a two word boundary or a one word
6601 boundary.  Aligning @code{double} variables on a two word boundary will
6602 produce code that runs somewhat faster on a @samp{Pentium} at the
6603 expense of more memory.
6605 @item -m128bit-long-double
6606 @itemx -m128bit-long-double
6607 Control the size of @code{long double} type. i386 application binary interface
6608 specify the size to be 12 bytes, while modern architectures (Pentium and newer)
6609 preffer @code{long double} aligned to 8 or 16 byte boundary.  This is
6610 impossible to reach with 12 byte long doubles in the array accesses.
6612 @strong{Warning:} if you use the @samp{-m128bit-long-double} switch, the
6613 structures and arrays containing @code{long double} will change their size as
6614 well as function calling convention for function taking @code{long double}
6615 will be modified. 
6617 @item -m96bit-long-double
6618 @itemx -m96bit-long-double
6619 Set the size of @code{long double} to 96 bits as required by the i386
6620 application binary interface.  This is the default.
6622 @item -msvr3-shlib
6623 @itemx -mno-svr3-shlib
6624 Control whether GCC places uninitialized locals into @code{bss} or
6625 @code{data}.  @samp{-msvr3-shlib} places these locals into @code{bss}.
6626 These options are meaningful only on System V Release 3.
6628 @item -mno-wide-multiply
6629 @itemx -mwide-multiply
6630 Control whether GCC uses the @code{mul} and @code{imul} that produce
6631 64 bit results in @code{eax:edx} from 32 bit operands to do @code{long
6632 long} multiplies and 32-bit division by constants.
6634 @item -mrtd
6635 Use a different function-calling convention, in which functions that
6636 take a fixed number of arguments return with the @code{ret} @var{num}
6637 instruction, which pops their arguments while returning.  This saves one
6638 instruction in the caller since there is no need to pop the arguments
6639 there.
6641 You can specify that an individual function is called with this calling
6642 sequence with the function attribute @samp{stdcall}.  You can also
6643 override the @samp{-mrtd} option by using the function attribute
6644 @samp{cdecl}.  @xref{Function Attributes}.
6646 @strong{Warning:} this calling convention is incompatible with the one
6647 normally used on Unix, so you cannot use it if you need to call
6648 libraries compiled with the Unix compiler.
6650 Also, you must provide function prototypes for all functions that
6651 take variable numbers of arguments (including @code{printf});
6652 otherwise incorrect code will be generated for calls to those
6653 functions.
6655 In addition, seriously incorrect code will result if you call a
6656 function with too many arguments.  (Normally, extra arguments are
6657 harmlessly ignored.)
6659 @item -mregparm=@var{num}
6660 Control how many registers are used to pass integer arguments.  By
6661 default, no registers are used to pass arguments, and at most 3
6662 registers can be used.  You can control this behavior for a specific
6663 function by using the function attribute @samp{regparm}.
6664 @xref{Function Attributes}.
6666 @strong{Warning:} if you use this switch, and
6667 @var{num} is nonzero, then you must build all modules with the same
6668 value, including any libraries.  This includes the system libraries and
6669 startup modules.
6671 @item -malign-loops=@var{num}
6672 Align loops to a 2 raised to a @var{num} byte boundary.  If
6673 @samp{-malign-loops} is not specified, the default is 2 unless
6674 gas 2.8 (or later) is being used in which case the default is
6675 to align the loop on a 16 byte boundary if it is less than 8
6676 bytes away.
6678 @item -malign-jumps=@var{num}
6679 Align instructions that are only jumped to to a 2 raised to a @var{num}
6680 byte boundary.  If @samp{-malign-jumps} is not specified, the default is
6681 2 if optimizing for a 386, and 4 if optimizing for a 486 unless
6682 gas 2.8 (or later) is being used in which case the default is
6683 to align the instruction on a 16 byte boundary if it is less
6684 than 8 bytes away.
6686 @item -malign-functions=@var{num}
6687 Align the start of functions to a 2 raised to @var{num} byte boundary.
6688 If @samp{-malign-functions} is not specified, the default is 2 if optimizing
6689 for a 386, and 4 if optimizing for a 486.
6691 @item -mpreferred-stack-boundary=@var{num}
6692 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
6693 byte boundary.  If @samp{-mpreferred-stack-boundary} is not specified,
6694 the default is 4 (16 bytes or 128 bits).
6696 The stack is required to be aligned on a 4 byte boundary.  On Pentium
6697 and PentiumPro, @code{double} and @code{long double} values should be
6698 aligned to an 8 byte boundary (see @samp{-malign-double}) or suffer
6699 significant run time performance penalties.  On Pentium III, the
6700 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
6701 penalties if it is not 16 byte aligned.
6703 To ensure proper alignment of this values on the stack, the stack boundary
6704 must be as aligned as that required by any value stored on the stack. 
6705 Further, every function must be generated such that it keeps the stack
6706 aligned.  Thus calling a function compiled with a higher preferred
6707 stack boundary from a function compiled with a lower preferred stack
6708 boundary will most likely misalign the stack.  It is recommended that
6709 libraries that use callbacks always use the default setting.
6711 This extra alignment does consume extra stack space.  Code that is sensitive
6712 to stack space usage, such as embedded systems and operating system kernels,
6713 may want to reduce the preferred alignment to
6714 @samp{-mpreferred-stack-boundary=2}.
6716 @item -mpush-args
6717 @kindex -mpush-args
6718 Use PUSH operations to store outgoing parameters. This method is shorter
6719 and usually equally fast as method using SUB/MOV operations and is enabled
6720 by default. In some cases disabling it may improve performance because of
6721 improved scheduling and reduced dependencies.
6723 @item -maccumulate-outgoing-args
6724 @kindex -maccumulate-outgoing-args
6725 If enabled, the maximum amount of space required for outgoing arguments will be
6726 computed in the function prologue. This in faster on most modern CPUs
6727 because of reduced dependencies, improved scheduling and reduced stack usage
6728 when preferred stack boundary is not equal to 2.  The drawback is a notable
6729 increase in code size. This switch implies -mno-push-args.
6731 @item -mthreads
6732 @kindex -mthreads
6733 Support thread-safe exception handling on @samp{Mingw32}. Code that relies 
6734 on thread-safe exception handling must compile and link all code with the 
6735 @samp{-mthreads} option. When compiling, @samp{-mthreads} defines 
6736 @samp{-D_MT}; when linking, it links in a special thread helper library 
6737 @samp{-lmingwthrd} which cleans up per thread exception handling data.
6739 @item -mno-align-stringops
6740 @kindex -mno-align-stringops
6741 Do not align destination of inlined string operations. This switch reduces
6742 code size and improves performance in case the destination is already aligned,
6743 but gcc don't know about it.
6745 @item -minline-all-stringops
6746 @kindex -minline-all-stringops
6747 By default GCC inlines string operations only when destination is known to be
6748 aligned at least to 4 byte boundary. This enables more inlining, increase code
6749 size, but may improve performance of code that depends on fast memcpy, strlen
6750 and memset for short lengths.
6751 @end table
6753 @node HPPA Options
6754 @subsection HPPA Options
6755 @cindex HPPA Options
6757 These @samp{-m} options are defined for the HPPA family of computers:
6759 @table @gcctabopt
6760 @item -march=@var{architecture type}
6761 Generate code for the specified architecture.  The choices for
6762 @var{architecture type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
6763 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
6764 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
6765 architecture option for your machine.  Code compiled for lower numbered
6766 architectures will run on higher numbered architectures, but not the
6767 other way around.
6769 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
6770 next release of binutils (current is 2.9.1) will probably contain PA 2.0
6771 support.  
6773 @item -mpa-risc-1-0
6774 @itemx -mpa-risc-1-1
6775 @itemx -mpa-risc-2-0
6776 Synonyms for -march=1.0, -march=1.1, and -march=2.0 respectively.
6778 @item -mbig-switch
6779 Generate code suitable for big switch tables.  Use this option only if
6780 the assembler/linker complain about out of range branches within a switch
6781 table.
6783 @item -mjump-in-delay
6784 Fill delay slots of function calls with unconditional jump instructions
6785 by modifying the return pointer for the function call to be the target
6786 of the conditional jump.
6788 @item -mdisable-fpregs
6789 Prevent floating point registers from being used in any manner.  This is
6790 necessary for compiling kernels which perform lazy context switching of
6791 floating point registers.  If you use this option and attempt to perform
6792 floating point operations, the compiler will abort.
6794 @item -mdisable-indexing
6795 Prevent the compiler from using indexing address modes.  This avoids some
6796 rather obscure problems when compiling MIG generated code under MACH.
6798 @item -mno-space-regs
6799 Generate code that assumes the target has no space registers.  This allows
6800 GCC to generate faster indirect calls and use unscaled index address modes.
6802 Such code is suitable for level 0 PA systems and kernels.
6804 @item -mfast-indirect-calls
6805 Generate code that assumes calls never cross space boundaries.  This
6806 allows GCC to emit code which performs faster indirect calls.
6808 This option will not work in the presence of shared libraries or nested
6809 functions.
6811 @item -mlong-load-store
6812 Generate 3-instruction load and store sequences as sometimes required by
6813 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
6814 the HP compilers.
6816 @item -mportable-runtime
6817 Use the portable calling conventions proposed by HP for ELF systems.
6819 @item -mgas
6820 Enable the use of assembler directives only GAS understands.
6822 @item -mschedule=@var{cpu type}
6823 Schedule code according to the constraints for the machine type
6824 @var{cpu type}.  The choices for @var{cpu type} are @samp{700} 
6825 @samp{7100}, @samp{7100LC}, @samp{7200}, and @samp{8000}.  Refer to 
6826 @file{/usr/lib/sched.models} on an HP-UX system to determine the
6827 proper scheduling option for your machine.
6829 @item -mlinker-opt
6830 Enable the optimization pass in the HPUX linker.  Note this makes symbolic
6831 debugging impossible.  It also triggers a bug in the HPUX 8 and HPUX 9 linkers
6832 in which they give bogus error messages when linking some programs.
6834 @item -msoft-float
6835 Generate output containing library calls for floating point.
6836 @strong{Warning:} the requisite libraries are not available for all HPPA
6837 targets.  Normally the facilities of the machine's usual C compiler are
6838 used, but this cannot be done directly in cross-compilation.  You must make
6839 your own arrangements to provide suitable library functions for
6840 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
6841 does provide software floating point support.
6843 @samp{-msoft-float} changes the calling convention in the output file;
6844 therefore, it is only useful if you compile @emph{all} of a program with
6845 this option.  In particular, you need to compile @file{libgcc.a}, the
6846 library that comes with GCC, with @samp{-msoft-float} in order for
6847 this to work.
6848 @end table
6850 @node Intel 960 Options
6851 @subsection Intel 960 Options
6853 These @samp{-m} options are defined for the Intel 960 implementations:
6855 @table @gcctabopt
6856 @item -m@var{cpu type}
6857 Assume the defaults for the machine type @var{cpu type} for some of
6858 the other options, including instruction scheduling, floating point
6859 support, and addressing modes.  The choices for @var{cpu type} are
6860 @samp{ka}, @samp{kb}, @samp{mc}, @samp{ca}, @samp{cf},
6861 @samp{sa}, and @samp{sb}.
6862 The default is
6863 @samp{kb}.
6865 @item -mnumerics
6866 @itemx -msoft-float
6867 The @samp{-mnumerics} option indicates that the processor does support
6868 floating-point instructions.  The @samp{-msoft-float} option indicates
6869 that floating-point support should not be assumed.
6871 @item -mleaf-procedures
6872 @itemx -mno-leaf-procedures
6873 Do (or do not) attempt to alter leaf procedures to be callable with the
6874 @code{bal} instruction as well as @code{call}.  This will result in more
6875 efficient code for explicit calls when the @code{bal} instruction can be
6876 substituted by the assembler or linker, but less efficient code in other
6877 cases, such as calls via function pointers, or using a linker that doesn't
6878 support this optimization.
6880 @item -mtail-call
6881 @itemx -mno-tail-call
6882 Do (or do not) make additional attempts (beyond those of the
6883 machine-independent portions of the compiler) to optimize tail-recursive
6884 calls into branches.  You may not want to do this because the detection of
6885 cases where this is not valid is not totally complete.  The default is
6886 @samp{-mno-tail-call}.
6888 @item -mcomplex-addr
6889 @itemx -mno-complex-addr
6890 Assume (or do not assume) that the use of a complex addressing mode is a
6891 win on this implementation of the i960.  Complex addressing modes may not
6892 be worthwhile on the K-series, but they definitely are on the C-series.
6893 The default is currently @samp{-mcomplex-addr} for all processors except
6894 the CB and CC.
6896 @item -mcode-align
6897 @itemx -mno-code-align
6898 Align code to 8-byte boundaries for faster fetching (or don't bother).
6899 Currently turned on by default for C-series implementations only.
6901 @ignore
6902 @item -mclean-linkage
6903 @itemx -mno-clean-linkage
6904 These options are not fully implemented.
6905 @end ignore
6907 @item -mic-compat
6908 @itemx -mic2.0-compat
6909 @itemx -mic3.0-compat
6910 Enable compatibility with iC960 v2.0 or v3.0.
6912 @item -masm-compat
6913 @itemx -mintel-asm
6914 Enable compatibility with the iC960 assembler.
6916 @item -mstrict-align
6917 @itemx -mno-strict-align
6918 Do not permit (do permit) unaligned accesses.
6920 @item -mold-align
6921 Enable structure-alignment compatibility with Intel's gcc release version
6922 1.3 (based on gcc 1.37).  This option implies @samp{-mstrict-align}.
6924 @item -mlong-double-64
6925 Implement type @samp{long double} as 64-bit floating point numbers.
6926 Without the option @samp{long double} is implemented by 80-bit
6927 floating point numbers.  The only reason we have it because there is
6928 no 128-bit @samp{long double} support in @samp{fp-bit.c} yet.  So it
6929 is only useful for people using soft-float targets.  Otherwise, we
6930 should recommend against use of it.
6932 @end table
6934 @node DEC Alpha Options
6935 @subsection DEC Alpha Options
6937 These @samp{-m} options are defined for the DEC Alpha implementations:
6939 @table @gcctabopt
6940 @item -mno-soft-float
6941 @itemx -msoft-float
6942 Use (do not use) the hardware floating-point instructions for
6943 floating-point operations.  When @option{-msoft-float} is specified,
6944 functions in @file{libgcc1.c} will be used to perform floating-point
6945 operations.  Unless they are replaced by routines that emulate the
6946 floating-point operations, or compiled in such a way as to call such
6947 emulations routines, these routines will issue floating-point
6948 operations.   If you are compiling for an Alpha without floating-point
6949 operations, you must ensure that the library is built so as not to call
6950 them.
6952 Note that Alpha implementations without floating-point operations are
6953 required to have floating-point registers.
6955 @item -mfp-reg
6956 @itemx -mno-fp-regs
6957 Generate code that uses (does not use) the floating-point register set.
6958 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
6959 register set is not used, floating point operands are passed in integer
6960 registers as if they were integers and floating-point results are passed
6961 in $0 instead of $f0.  This is a non-standard calling sequence, so any
6962 function with a floating-point argument or return value called by code
6963 compiled with @option{-mno-fp-regs} must also be compiled with that
6964 option.
6966 A typical use of this option is building a kernel that does not use,
6967 and hence need not save and restore, any floating-point registers.
6969 @item -mieee
6970 The Alpha architecture implements floating-point hardware optimized for
6971 maximum performance.  It is mostly compliant with the IEEE floating
6972 point standard.  However, for full compliance, software assistance is
6973 required.  This option generates code fully IEEE compliant code
6974 @emph{except} that the @var{inexact flag} is not maintained (see below).
6975 If this option is turned on, the CPP macro @code{_IEEE_FP} is defined
6976 during compilation.  The option is a shorthand for: @samp{-D_IEEE_FP
6977 -mfp-trap-mode=su -mtrap-precision=i -mieee-conformant}.  The resulting
6978 code is less efficient but is able to correctly support denormalized
6979 numbers and exceptional IEEE values such as not-a-number and plus/minus
6980 infinity.  Other Alpha compilers call this option
6981 @option{-ieee_with_no_inexact}.
6983 @item -mieee-with-inexact
6984 @c overfull hbox here --bob 22 jul96
6985 @c original text between ignore ... end ignore
6986 @ignore
6987 This is like @samp{-mieee} except the generated code also maintains the
6988 IEEE @var{inexact flag}.  Turning on this option causes the generated
6989 code to implement fully-compliant IEEE math.  The option is a shorthand
6990 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus @samp{-mieee-conformant},
6991 @samp{-mfp-trap-mode=sui}, and @samp{-mtrap-precision=i}.  On some Alpha
6992 implementations the resulting code may execute significantly slower than
6993 the code generated by default.  Since there is very little code that
6994 depends on the @var{inexact flag}, you should normally not specify this
6995 option.  Other Alpha compilers call this option
6996 @samp{-ieee_with_inexact}.
6997 @end ignore
6998 @c            changed paragraph
6999 This is like @samp{-mieee} except the generated code also maintains the
7000 IEEE @var{inexact flag}.  Turning on this option causes the generated
7001 code to implement fully-compliant IEEE math.  The option is a shorthand
7002 for @samp{-D_IEEE_FP -D_IEEE_FP_INEXACT} plus the three following:
7003 @samp{-mieee-conformant},
7004 @samp{-mfp-trap-mode=sui}, 
7005 and @samp{-mtrap-precision=i}.  
7006 On some Alpha implementations the resulting code may execute
7007 significantly slower than the code generated by default.  Since there
7008 is very little code that depends on the @var{inexact flag}, you should
7009 normally not specify this option.  Other Alpha compilers call this
7010 option @samp{-ieee_with_inexact}.
7011 @c             end changes to prevent overfull hboxes
7013 @item -mfp-trap-mode=@var{trap mode}
7014 This option controls what floating-point related traps are enabled.
7015 Other Alpha compilers call this option @samp{-fptm }@var{trap mode}.
7016 The trap mode can be set to one of four values:
7018 @table @samp
7019 @item n
7020 This is the default (normal) setting.  The only traps that are enabled
7021 are the ones that cannot be disabled in software (e.g., division by zero
7022 trap).
7024 @item u
7025 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7026 as well.
7028 @item su
7029 Like @samp{su}, but the instructions are marked to be safe for software
7030 completion (see Alpha architecture manual for details).
7032 @item sui
7033 Like @samp{su}, but inexact traps are enabled as well.
7034 @end table
7036 @item -mfp-rounding-mode=@var{rounding mode}
7037 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7038 @samp{-fprm }@var{rounding mode}.  The @var{rounding mode} can be one
7041 @table @samp
7042 @item n
7043 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7044 the nearest machine number or towards the even machine number in case
7045 of a tie.
7047 @item m
7048 Round towards minus infinity.
7050 @item c
7051 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7053 @item d
7054 Dynamic rounding mode.  A field in the floating point control register
7055 (@var{fpcr}, see Alpha architecture reference manual) controls the
7056 rounding mode in effect.  The C library initializes this register for
7057 rounding towards plus infinity.  Thus, unless your program modifies the
7058 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7059 @end table
7061 @item -mtrap-precision=@var{trap precision}
7062 In the Alpha architecture, floating point traps are imprecise.  This
7063 means without software assistance it is impossible to recover from a
7064 floating trap and program execution normally needs to be terminated.
7065 GCC can generate code that can assist operating system trap handlers
7066 in determining the exact location that caused a floating point trap.
7067 Depending on the requirements of an application, different levels of
7068 precisions can be selected:
7070 @table @samp
7071 @item p
7072 Program precision.  This option is the default and means a trap handler
7073 can only identify which program caused a floating point exception.
7075 @item f
7076 Function precision.  The trap handler can determine the function that
7077 caused a floating point exception.
7079 @item i
7080 Instruction precision.  The trap handler can determine the exact
7081 instruction that caused a floating point exception.
7082 @end table
7084 Other Alpha compilers provide the equivalent options called
7085 @samp{-scope_safe} and @samp{-resumption_safe}.
7087 @item -mieee-conformant
7088 This option marks the generated code as IEEE conformant.  You must not
7089 use this option unless you also specify @samp{-mtrap-precision=i} and either
7090 @samp{-mfp-trap-mode=su} or @samp{-mfp-trap-mode=sui}.  Its only effect
7091 is to emit the line @samp{.eflag 48} in the function prologue of the
7092 generated assembly file.  Under DEC Unix, this has the effect that
7093 IEEE-conformant math library routines will be linked in.
7095 @item -mbuild-constants
7096 Normally GCC examines a 32- or 64-bit integer constant to
7097 see if it can construct it from smaller constants in two or three
7098 instructions.  If it cannot, it will output the constant as a literal and
7099 generate code to load it from the data segment at runtime.
7101 Use this option to require GCC to construct @emph{all} integer constants
7102 using code, even if it takes more instructions (the maximum is six).
7104 You would typically use this option to build a shared library dynamic
7105 loader.  Itself a shared library, it must relocate itself in memory
7106 before it can find the variables and constants in its own data segment.
7108 @item -malpha-as
7109 @itemx -mgas
7110 Select whether to generate code to be assembled by the vendor-supplied
7111 assembler (@samp{-malpha-as}) or by the GNU assembler @samp{-mgas}.
7113 @item -mbwx
7114 @itemx -mno-bwx
7115 @itemx -mcix
7116 @itemx -mno-cix
7117 @itemx -mmax
7118 @itemx -mno-max
7119 Indicate whether GCC should generate code to use the optional BWX,
7120 CIX, and MAX instruction sets.  The default is to use the instruction sets
7121 supported by the CPU type specified via @samp{-mcpu=} option or that
7122 of the CPU on which GCC was built if none was specified.
7124 @item -mcpu=@var{cpu_type}
7125 Set the instruction set, register set, and instruction scheduling
7126 parameters for machine type @var{cpu_type}.  You can specify either the
7127 @samp{EV} style name or the corresponding chip number.  GCC
7128 supports scheduling parameters for the EV4 and EV5 family of processors
7129 and will choose the default values for the instruction set from
7130 the processor you specify.  If you do not specify a processor type,
7131 GCC will default to the processor on which the compiler was built.
7133 Supported values for @var{cpu_type} are
7135 @table @samp
7136 @item ev4
7137 @itemx 21064
7138 Schedules as an EV4 and has no instruction set extensions.
7140 @item ev5
7141 @itemx 21164
7142 Schedules as an EV5 and has no instruction set extensions.
7144 @item ev56
7145 @itemx 21164a
7146 Schedules as an EV5 and supports the BWX extension.
7148 @item pca56
7149 @itemx 21164pc
7150 @itemx 21164PC
7151 Schedules as an EV5 and supports the BWX and MAX extensions.
7153 @item ev6
7154 @itemx 21264
7155 Schedules as an EV5 (until Digital releases the scheduling parameters
7156 for the EV6) and supports the BWX, CIX, and MAX extensions.
7157 @end table
7159 @item -mmemory-latency=@var{time}
7160 Sets the latency the scheduler should assume for typical memory
7161 references as seen by the application.  This number is highly
7162 dependent on the memory access patterns used by the application
7163 and the size of the external cache on the machine.
7165 Valid options for @var{time} are
7167 @table @samp
7168 @item @var{number}
7169 A decimal number representing clock cycles.
7171 @item L1
7172 @itemx L2
7173 @itemx L3
7174 @itemx main
7175 The compiler contains estimates of the number of clock cycles for
7176 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7177 (also called Dcache, Scache, and Bcache), as well as to main memory.
7178 Note that L3 is only valid for EV5.
7180 @end table
7181 @end table
7183 @node Clipper Options
7184 @subsection Clipper Options
7186 These @samp{-m} options are defined for the Clipper implementations:
7188 @table @gcctabopt
7189 @item -mc300
7190 Produce code for a C300 Clipper processor. This is the default.
7192 @item -mc400
7193 Produce code for a C400 Clipper processor i.e. use floating point
7194 registers f8..f15.
7195 @end table
7197 @node H8/300 Options
7198 @subsection H8/300 Options
7200 These @samp{-m} options are defined for the H8/300 implementations:
7202 @table @gcctabopt
7203 @item -mrelax
7204 Shorten some address references at link time, when possible; uses the
7205 linker option @samp{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7206 ld.info, Using ld}, for a fuller description.
7208 @item -mh
7209 Generate code for the H8/300H.
7211 @item -ms
7212 Generate code for the H8/S.
7214 @item -ms2600
7215 Generate code for the H8/S2600.  This switch must be used with -ms.
7217 @item -mint32
7218 Make @code{int} data 32 bits by default.
7220 @item -malign-300
7221 On the H8/300H and H8/S, use the same alignment rules as for the H8/300.
7222 The default for the H8/300H and H8/S is to align longs and floats on 4
7223 byte boundaries.
7224 @samp{-malign-300} causes them to be aligned on 2 byte boundaries.
7225 This option has no effect on the H8/300.
7226 @end table
7228 @node SH Options
7229 @subsection SH Options
7231 These @samp{-m} options are defined for the SH implementations:
7233 @table @gcctabopt
7234 @item -m1
7235 Generate code for the SH1.
7237 @item -m2
7238 Generate code for the SH2.
7240 @item -m3
7241 Generate code for the SH3.
7243 @item -m3e
7244 Generate code for the SH3e.
7246 @item -m4-nofpu
7247 Generate code for the SH4 without a floating-point unit.
7249 @item -m4-single-only
7250 Generate code for the SH4 with a floating-point unit that only
7251 supports single-precision arithmentic.
7253 @item -m4-single
7254 Generate code for the SH4 assuming the floating-point unit is in
7255 single-precision mode by default.
7257 @item -m4
7258 Generate code for the SH4.
7260 @item -mb
7261 Compile code for the processor in big endian mode.
7263 @item -ml
7264 Compile code for the processor in little endian mode.
7266 @item -mdalign
7267 Align doubles at 64 bit boundaries.  Note that this changes the calling
7268 conventions, and thus some functions from the standard C library will
7269 not work unless you recompile it first with -mdalign.
7271 @item -mrelax
7272 Shorten some address references at link time, when possible; uses the
7273 linker option @samp{-relax}.
7275 @item -mbigtable
7276 Use 32-bit offsets in @code{switch} tables.  The default is to use
7277 16-bit offsets.
7279 @item -mfmovd
7280 Enable the use of the instruction @code{fmovd}.
7282 @item -mhitachi
7283 Comply with the calling conventions defined by Hitachi.
7285 @item -mnomacsave
7286 Mark the @code{MAC} register as call-clobbered, even if
7287 @option{-mhitachi} is given.
7289 @item -misize
7290 Dump instruction size and location in the assembly code.
7292 @item -mpadstruct
7293 This option is deprecated.  It pads structures to multiple of 4 bytes,
7294 which is incompatible with the SH ABI.
7296 @item -mspace
7297 Optimize for space instead of speed.  Implied by @option{-Os}.
7299 @item -mprefergot
7300 When generating position-independent code, emit function calls using
7301 the Global Offset Table instead of the Procedure Linkage Table.
7303 @item -musermode
7304 Generate a library function call to invalidate instruction cache
7305 entries, after fixing up a trampoline.  This library function call
7306 doesn't assume it can write to the whole memory address space.  This
7307 is the default when the target is @code{sh-*-linux*}.
7308 @end table
7310 @node System V Options
7311 @subsection Options for System V
7313 These additional options are available on System V Release 4 for
7314 compatibility with other compilers on those systems:
7316 @table @gcctabopt
7317 @item -G
7318 Create a shared object.
7319 It is recommended that @samp{-symbolic} or @samp{-shared} be used instead.
7321 @item -Qy
7322 Identify the versions of each tool used by the compiler, in a
7323 @code{.ident} assembler directive in the output.
7325 @item -Qn
7326 Refrain from adding @code{.ident} directives to the output file (this is
7327 the default).
7329 @item -YP\,@var{dirs}
7330 Search the directories @var{dirs}, and no others, for libraries
7331 specified with @samp{-l}.
7333 @item -Ym\,@var{dir}
7334 Look in the directory @var{dir} to find the M4 preprocessor.
7335 The assembler uses this option.
7336 @c This is supposed to go with a -Yd for predefined M4 macro files, but
7337 @c the generic assembler that comes with Solaris takes just -Ym.
7338 @end table
7340 @node TMS320C3x/C4x Options
7341 @subsection TMS320C3x/C4x Options
7342 @cindex TMS320C3x/C4x Options
7344 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
7346 @table @gcctabopt
7348 @item -mcpu=@var{cpu_type}
7349 Set the instruction set, register set, and instruction scheduling
7350 parameters for machine type @var{cpu_type}.  Supported values for
7351 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
7352 @samp{c44}.  The default is @samp{c40} to generate code for the
7353 TMS320C40.
7355 @item -mbig-memory
7356 @item -mbig
7357 @itemx -msmall-memory
7358 @itemx -msmall
7359 Generates code for the big or small memory model.  The small memory
7360 model assumed that all data fits into one 64K word page.  At run-time
7361 the data page (DP) register must be set to point to the 64K page
7362 containing the .bss and .data program sections.  The big memory model is
7363 the default and requires reloading of the DP register for every direct
7364 memory access.
7366 @item -mbk
7367 @itemx -mno-bk
7368 Allow (disallow) allocation of general integer operands into the block
7369 count register BK. 
7371 @item -mdb
7372 @itemx -mno-db
7373 Enable (disable) generation of code using decrement and branch,
7374 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
7375 on the safe side, this is disabled for the C3x, since the maximum
7376 iteration count on the C3x is 2^23 + 1 (but who iterates loops more than
7377 2^23 times on the C3x?).  Note that GCC will try to reverse a loop so
7378 that it can utilise the decrement and branch instruction, but will give
7379 up if there is more than one memory reference in the loop.  Thus a loop
7380 where the loop counter is decremented can generate slightly more
7381 efficient code, in cases where the RPTB instruction cannot be utilised.
7383 @item -mdp-isr-reload
7384 @itemx -mparanoid
7385 Force the DP register to be saved on entry to an interrupt service
7386 routine (ISR), reloaded to point to the data section, and restored on
7387 exit from the ISR.  This should not be required unless someone has
7388 violated the small memory model by modifying the DP register, say within
7389 an object library.
7391 @item -mmpyi
7392 @itemx -mno-mpyi
7393 For the C3x use the 24-bit MPYI instruction for integer multiplies
7394 instead of a library call to guarantee 32-bit results.  Note that if one
7395 of the operands is a constant, then the multiplication will be performed
7396 using shifts and adds.  If the -mmpyi option is not specified for the C3x,
7397 then squaring operations are performed inline instead of a library call.
7399 @item -mfast-fix
7400 @itemx -mno-fast-fix
7401 The C3x/C4x FIX instruction to convert a floating point value to an
7402 integer value chooses the nearest integer less than or equal to the
7403 floating point value rather than to the nearest integer.  Thus if the
7404 floating point number is negative, the result will be incorrectly
7405 truncated an additional code is necessary to detect and correct this
7406 case.  This option can be used to disable generation of the additional
7407 code required to correct the result.
7409 @item -mrptb
7410 @itemx -mno-rptb
7411 Enable (disable) generation of repeat block sequences using the RPTB
7412 instruction for zero overhead looping.  The RPTB construct is only used
7413 for innermost loops that do not call functions or jump across the loop
7414 boundaries.  There is no advantage having nested RPTB loops due to the
7415 overhead required to save and restore the RC, RS, and RE registers.
7416 This is enabled by default with -O2.
7418 @item -mrpts=@var{count}
7419 @itemx -mno-rpts
7420 Enable (disable) the use of the single instruction repeat instruction
7421 RPTS.  If a repeat block contains a single instruction, and the loop
7422 count can be guaranteed to be less than the value @var{count}, GCC will
7423 emit a RPTS instruction instead of a RPTB.  If no value is specified,
7424 then a RPTS will be emitted even if the loop count cannot be determined
7425 at compile time.  Note that the repeated instruction following RPTS does
7426 not have to be reloaded from memory each iteration, thus freeing up the
7427 CPU buses for operands.  However, since interrupts are blocked by this
7428 instruction, it is disabled by default.
7430 @item -mloop-unsigned
7431 @itemx -mno-loop-unsigned
7432 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
7433 is 2^31 + 1 since these instructions test if the iteration count is
7434 negative to terminate the loop.  If the iteration count is unsigned
7435 there is a possibility than the 2^31 + 1 maximum iteration count may be
7436 exceeded.  This switch allows an unsigned iteration count.
7438 @item -mti
7439 Try to emit an assembler syntax that the TI assembler (asm30) is happy
7440 with.  This also enforces compatibility with the API employed by the TI
7441 C3x C compiler.  For example, long doubles are passed as structures
7442 rather than in floating point registers.
7444 @item -mregparm
7445 @itemx -mmemparm
7446 Generate code that uses registers (stack) for passing arguments to functions.
7447 By default, arguments are passed in registers where possible rather
7448 than by pushing arguments on to the stack.
7450 @item -mparallel-insns
7451 @itemx -mno-parallel-insns
7452 Allow the generation of parallel instructions.  This is enabled by
7453 default with -O2.
7455 @item -mparallel-mpy
7456 @itemx -mno-parallel-mpy
7457 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
7458 provided -mparallel-insns is also specified.  These instructions have
7459 tight register constraints which can pessimize the code generation
7460 of large functions.
7462 @end table
7464 @node V850 Options
7465 @subsection V850 Options
7466 @cindex V850 Options
7468 These @samp{-m} options are defined for V850 implementations:
7470 @table @gcctabopt
7471 @item -mlong-calls
7472 @itemx -mno-long-calls
7473 Treat all calls as being far away (near).  If calls are assumed to be
7474 far away, the compiler will always load the functions address up into a
7475 register, and call indirect through the pointer.
7477 @item -mno-ep
7478 @itemx -mep
7479 Do not optimize (do optimize) basic blocks that use the same index
7480 pointer 4 or more times to copy pointer into the @code{ep} register, and
7481 use the shorter @code{sld} and @code{sst} instructions.  The @samp{-mep}
7482 option is on by default if you optimize.
7484 @item -mno-prolog-function
7485 @itemx -mprolog-function
7486 Do not use (do use) external functions to save and restore registers at
7487 the prolog and epilog of a function.  The external functions are slower,
7488 but use less code space if more than one function saves the same number
7489 of registers.  The @samp{-mprolog-function} option is on by default if
7490 you optimize.
7492 @item -mspace
7493 Try to make the code as small as possible.  At present, this just turns
7494 on the @samp{-mep} and @samp{-mprolog-function} options.
7496 @item -mtda=@var{n}
7497 Put static or global variables whose size is @var{n} bytes or less into
7498 the tiny data area that register @code{ep} points to.  The tiny data
7499 area can hold up to 256 bytes in total (128 bytes for byte references).
7501 @item -msda=@var{n}
7502 Put static or global variables whose size is @var{n} bytes or less into
7503 the small data area that register @code{gp} points to.  The small data
7504 area can hold up to 64 kilobytes.
7506 @item -mzda=@var{n}
7507 Put static or global variables whose size is @var{n} bytes or less into
7508 the first 32 kilobytes of memory.
7510 @item -mv850
7511 Specify that the target processor is the V850.
7513 @item -mbig-switch
7514 Generate code suitable for big switch tables.  Use this option only if
7515 the assembler/linker complain about out of range branches within a switch
7516 table.
7517 @end table
7519 @node ARC Options
7520 @subsection ARC Options
7521 @cindex ARC Options
7523 These options are defined for ARC implementations:
7525 @table @gcctabopt
7526 @item -EL
7527 Compile code for little endian mode.  This is the default.
7529 @item -EB
7530 Compile code for big endian mode.
7532 @item -mmangle-cpu
7533 Prepend the name of the cpu to all public symbol names.
7534 In multiple-processor systems, there are many ARC variants with different
7535 instruction and register set characteristics.  This flag prevents code
7536 compiled for one cpu to be linked with code compiled for another.
7537 No facility exists for handling variants that are "almost identical".
7538 This is an all or nothing option.
7540 @item -mcpu=@var{cpu}
7541 Compile code for ARC variant @var{cpu}.
7542 Which variants are supported depend on the configuration.
7543 All variants support @samp{-mcpu=base}, this is the default.
7545 @item -mtext=@var{text section}
7546 @itemx -mdata=@var{data section}
7547 @itemx -mrodata=@var{readonly data section}
7548 Put functions, data, and readonly data in @var{text section},
7549 @var{data section}, and @var{readonly data section} respectively
7550 by default.  This can be overridden with the @code{section} attribute.
7551 @xref{Variable Attributes}.
7553 @end table
7555 @node NS32K Options
7556 @subsection NS32K Options
7557 @cindex NS32K options
7559 These are the @samp{-m} options defined for the 32000 series.  The default
7560 values for these options depends on which style of 32000 was selected when
7561 the compiler was configured; the defaults for the most common choices are
7562 given below.
7564 @table @gcctabopt
7565 @item -m32032
7566 @itemx -m32032
7567 Generate output for a 32032.  This is the default
7568 when the compiler is configured for 32032 and 32016 based systems.
7570 @item -m32332
7571 @itemx -m32332
7572 Generate output for a 32332.  This is the default
7573 when the compiler is configured for 32332-based systems.
7575 @item -m32532
7576 @itemx -m32532
7577 Generate output for a 32532.  This is the default
7578 when the compiler is configured for 32532-based systems.
7580 @item -m32081
7581 Generate output containing 32081 instructions for floating point.
7582 This is the default for all systems.
7584 @item -m32381
7585 Generate output containing 32381 instructions for floating point.  This
7586 also implies @samp{-m32081}. The 32381 is only compatible with the 32332
7587 and 32532 cpus. This is the default for the pc532-netbsd configuration.
7589 @item -mmulti-add
7590 Try and generate multiply-add floating point instructions @code{polyF}
7591 and @code{dotF}. This option is only available if the @samp{-m32381}
7592 option is in effect. Using these instructions requires changes to to
7593 register allocation which generally has a negative impact on
7594 performance.  This option should only be enabled when compiling code
7595 particularly likely to make heavy use of multiply-add instructions.
7597 @item -mnomulti-add
7598 Do not try and generate multiply-add floating point instructions
7599 @code{polyF} and @code{dotF}. This is the default on all platforms.
7601 @item -msoft-float
7602 Generate output containing library calls for floating point.
7603 @strong{Warning:} the requisite libraries may not be available.
7605 @item -mnobitfield
7606 Do not use the bit-field instructions. On some machines it is faster to
7607 use shifting and masking operations. This is the default for the pc532.
7609 @item -mbitfield
7610 Do use the bit-field instructions. This is the default for all platforms
7611 except the pc532.
7613 @item -mrtd
7614 Use a different function-calling convention, in which functions
7615 that take a fixed number of arguments return pop their
7616 arguments on return with the @code{ret} instruction.
7618 This calling convention is incompatible with the one normally
7619 used on Unix, so you cannot use it if you need to call libraries
7620 compiled with the Unix compiler.
7622 Also, you must provide function prototypes for all functions that
7623 take variable numbers of arguments (including @code{printf});
7624 otherwise incorrect code will be generated for calls to those
7625 functions.
7627 In addition, seriously incorrect code will result if you call a
7628 function with too many arguments.  (Normally, extra arguments are
7629 harmlessly ignored.)
7631 This option takes its name from the 680x0 @code{rtd} instruction.
7634 @item -mregparam
7635 Use a different function-calling convention where the first two arguments
7636 are passed in registers.
7638 This calling convention is incompatible with the one normally
7639 used on Unix, so you cannot use it if you need to call libraries
7640 compiled with the Unix compiler.
7642 @item -mnoregparam
7643 Do not pass any arguments in registers. This is the default for all
7644 targets.
7646 @item -msb
7647 It is OK to use the sb as an index register which is always loaded with
7648 zero. This is the default for the pc532-netbsd target.
7650 @item -mnosb
7651 The sb register is not available for use or has not been initialized to
7652 zero by the run time system. This is the default for all targets except
7653 the pc532-netbsd. It is also implied whenever @samp{-mhimem} or
7654 @samp{-fpic} is set.
7656 @item -mhimem
7657 Many ns32000 series addressing modes use displacements of up to 512MB.
7658 If an address is above 512MB then displacements from zero can not be used.
7659 This option causes code to be generated which can be loaded above 512MB.
7660 This may be useful for operating systems or ROM code.
7662 @item -mnohimem
7663 Assume code will be loaded in the first 512MB of virtual address space.
7664 This is the default for all platforms.
7667 @end table
7669 @node AVR Options
7670 @subsection AVR Options
7671 @cindex AVR Options
7673 These options are defined for AVR implementations:
7675 @table @gcctabopt
7676 @item -mmcu=@var{mcu}
7677 Specify ATMEL AVR instruction set or MCU type.
7679 Instruction set avr1 is for the minimal AVR core, not supported by the C
7680 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7681 attiny11, attiny12, attiny15, attiny28).
7683 Instruction set avr2 (default) is for the classic AVR core with up to
7684 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7685 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7686 at90c8534, at90s8535).
7688 Instruction set avr3 is for the classic AVR core with up to 128K program
7689 memory space (MCU types: atmega103, atmega603).
7691 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7692 memory space (MCU types: atmega83, atmega85).
7694 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7695 memory space (MCU types: atmega161, atmega163, atmega32, at94k).
7697 @item -msize
7698 Output instruction sizes to the asm file.
7700 @item -minit-stack=@var{N}
7701 Specify the initial stack address, which may be a symbol or numeric value,
7702 __stack is the default.
7704 @item -mno-interrupts
7705 Generated code is not compatible with hardware interrupts.
7706 Code size will be smaller.
7708 @item -mcall-prologues
7709 Functions prologues/epilogues expanded as call to appropriate
7710 subroutines. Code size will be smaller.
7712 @item -mno-tablejump
7713 Do not generate tablejump insns which sometimes increase code size.
7715 @item -mtiny-stack
7716 Change only the low 8 bits of the stack pointer.
7717 @end table
7719 @node MCore Options
7720 @subsection MCore Options
7721 @cindex MCore options
7723 These are the @samp{-m} options defined for the Motorola M*Core
7724 processors.  
7726 @table @gcctabopt
7728 @item -mhardlit
7729 @itemx -mhardlit
7730 @itemx -mno-hardlit
7731 Inline constants into the code stream if it can be done in two
7732 instructions or less.
7734 @item -mdiv
7735 @itemx -mdiv
7736 @itemx -mno-div
7737 Use the divide instruction.  (Enabled by default).
7739 @item -mrelax-immediate
7740 @itemx -mrelax-immediate
7741 @itemx -mno-relax-immediate
7742 Allow arbitrary sized immediates in bit operations.
7744 @item -mwide-bitfields
7745 @itemx -mwide-bitfields
7746 @itemx -mno-wide-bitfields
7747 Always treat bitfields as int-sized.
7749 @item -m4byte-functions
7750 @itemx -m4byte-functions
7751 @itemx -mno-4byte-functions
7752 Force all functions to be aligned to a four byte boundary.
7754 @item -mcallgraph-data
7755 @itemx -mcallgraph-data
7756 @itemx -mno-callgraph-data
7757 Emit callgraph information.
7759 @item -mslow-bytes
7760 @itemx -mslow-bytes
7761 @itemx -mno-slow-bytes
7762 Prefer word access when reading byte quantities.
7764 @item -mlittle-endian
7765 @itemx -mlittle-endian
7766 @itemx -mbig-endian
7767 Generate code for a little endian target.
7769 @item -m210
7770 @itemx -m210
7771 @itemx -m340
7772 Generate code for the 210 processor.
7773 @end table
7775 @node IA-64 Options
7776 @subsection IA-64 Options
7777 @cindex IA-64 Options
7779 These are the @samp{-m} options defined for the Intel IA-64 architecture.
7781 @table @gcctabopt
7782 @item -mbig-endian
7783 Generate code for a big endian target.  This is the default for HPUX.
7785 @item -mlittle-endian
7786 Generate code for a little endian target.  This is the default for AIX5
7787 and Linux.
7789 @item -mgnu-as
7790 @itemx -mno-gnu-as
7791 Generate (or don't) code for the GNU assembler.  This is the default.
7792 @c Also, this is the default if the configure option @samp{--with-gnu-as}
7793 @c is used.
7795 @item -mgnu-ld
7796 @itemx -mno-gnu-ld
7797 Generate (or don't) code for the GNU linker.  This is the default.
7798 @c Also, this is the default if the configure option @samp{--with-gnu-ld}
7799 @c is used.
7801 @item -mno-pic
7802 Generate code that does not use a global pointer register.  The result
7803 is not position independent code, and violates the IA-64 ABI.
7805 @item -mvolatile-asm-stop
7806 @itemx -mno-volatile-asm-stop
7807 Generate (or don't) a stop bit immediately before and after volatile asm
7808 statements.
7810 @item -mb-step
7811 Generate code that works around Itanium B step errata.
7813 @item -mregister-names
7814 @itemx -mno-register-names
7815 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
7816 the stacked registers.  This may make assembler output more readable.
7818 @item -mno-sdata
7819 @itemx -msdata
7820 Disable (or enable) optimizations that use the small data section.  This may
7821 be useful for working around optimizer bugs.
7823 @item -mconstant-gp
7824 Generate code that uses a single constant global pointer value.  This is
7825 useful when compiling kernel code.
7827 @item -mauto-pic
7828 Generate code that is self-relocatable.  This implies @samp{-mconstant-gp}.
7829 This is useful when compiling firmware code.
7831 @item -minline-divide-min-latency
7832 Generate code for inline divides using the minimum latency algorithm.
7834 @item -minline-divide-max-throughput
7835 Generate code for inline divides using the maximum throughput algorithm.
7837 @item -mno-dwarf2-asm
7838 @itemx -mdwarf2-asm
7839 Don't (or do) generate assembler code for the DWARF2 line number debugging
7840 info.  This may be useful when not using the GNU assembler.
7842 @item -mfixed-range=@var{register range}
7843 Generate code treating the given register range as fixed registers.
7844 A fixed register is one that the register allocator can not use.  This is
7845 useful when compiling kernel code.  A register range is specified as
7846 two registers separated by a dash.  Multiple register ranges can be
7847 specified separated by a comma.
7848 @end table
7850 @node D30V Options
7851 @subsection D30V Options
7852 @cindex D30V Options
7854 These @samp{-m} options are defined for D30V implementations:
7856 @table @gcctabopt
7857 @item -mextmem
7858 Link the @samp{.text}, @samp{.data}, @samp{.bss}, @samp{.strings},
7859 @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections into external
7860 memory, which starts at location @code{0x80000000}.
7862 @item -mextmemory
7863 Same as the @samp{-mextmem} switch.
7865 @item -monchip
7866 Link the @samp{.text} section into onchip text memory, which starts at
7867 location @code{0x0}.  Also link @samp{.data}, @samp{.bss},
7868 @samp{.strings}, @samp{.rodata}, @samp{.rodata1}, @samp{.data1} sections
7869 into onchip data memory, which starts at location @code{0x20000000}.
7871 @item -mno-asm-optimize
7872 @itemx -masm-optimize
7873 Disable (enable) passing @samp{-O} to the assembler when optimizing.
7874 The assembler uses the @samp{-O} option to automatically parallelize
7875 adjacent short instructions where possible.
7877 @item -mbranch-cost=@var{n}
7878 Increase the internal costs of branches to @var{n}.  Higher costs means
7879 that the compiler will issue more instructions to avoid doing a branch.
7880 The default is 2.
7882 @item -mcond-exec=@var{n}
7883 Specify the maximum number of conditionally executed instructions that
7884 replace a branch.  The default is 4.
7885 @end table
7887 @node Code Gen Options
7888 @section Options for Code Generation Conventions
7889 @cindex code generation conventions
7890 @cindex options, code generation
7891 @cindex run-time options
7893 These machine-independent options control the interface conventions
7894 used in code generation.
7896 Most of them have both positive and negative forms; the negative form
7897 of @samp{-ffoo} would be @samp{-fno-foo}.  In the table below, only
7898 one of the forms is listed---the one which is not the default.  You
7899 can figure out the other form by either removing @samp{no-} or adding
7902 @table @gcctabopt
7903 @item -fexceptions
7904 Enable exception handling. Generates extra code needed to propagate
7905 exceptions.  For some targets, this implies GNU CC will generate frame
7906 unwind information for all functions, which can produce significant data
7907 size overhead, although it does not affect execution.  If you do not
7908 specify this option, GNU CC will enable it by default for languages like
7909 C++ which normally require exception handling, and disable itfor
7910 languages like C that do not normally require it.  However, you may need
7911 to enable this option when compiling C code that needs to interoperate
7912 properly with exception handlers written in C++.  You may also wish to
7913 disable this option if you are compiling older C++ programs that don't
7914 use exception handling.
7916 @item -funwind-tables
7917 Similar to @option{-fexceptions}, except that it will just generate any needed
7918 static data, but will not affect the generated code in any other way.
7919 You will normally not enable this option; instead, a language processor
7920 that needs this handling would enable it on your behalf.
7922 @item -fpcc-struct-return
7923 Return ``short'' @code{struct} and @code{union} values in memory like
7924 longer ones, rather than in registers.  This convention is less
7925 efficient, but it has the advantage of allowing intercallability between
7926 GCC-compiled files and files compiled with other compilers.
7928 The precise convention for returning structures in memory depends
7929 on the target configuration macros.
7931 Short structures and unions are those whose size and alignment match
7932 that of some integer type.
7934 @item -freg-struct-return
7935 Use the convention that @code{struct} and @code{union} values are
7936 returned in registers when possible.  This is more efficient for small
7937 structures than @samp{-fpcc-struct-return}.
7939 If you specify neither @samp{-fpcc-struct-return} nor its contrary
7940 @samp{-freg-struct-return}, GCC defaults to whichever convention is
7941 standard for the target.  If there is no standard convention, GCC
7942 defaults to @samp{-fpcc-struct-return}, except on targets where GCC
7943 is the principal compiler.  In those cases, we can choose the standard,
7944 and we chose the more efficient register return alternative.
7946 @item -fshort-enums
7947 Allocate to an @code{enum} type only as many bytes as it needs for the
7948 declared range of possible values.  Specifically, the @code{enum} type
7949 will be equivalent to the smallest integer type which has enough room.
7951 @item -fshort-double
7952 Use the same size for @code{double} as for @code{float}.
7954 @item -fshared-data
7955 Requests that the data and non-@code{const} variables of this
7956 compilation be shared data rather than private data.  The distinction
7957 makes sense only on certain operating systems, where shared data is
7958 shared between processes running the same program, while private data
7959 exists in one copy per process.
7961 @item -fno-common
7962 Allocate even uninitialized global variables in the data section of the
7963 object file, rather than generating them as common blocks.  This has the
7964 effect that if the same variable is declared (without @code{extern}) in
7965 two different compilations, you will get an error when you link them.
7966 The only reason this might be useful is if you wish to verify that the
7967 program will work on other systems which always work this way.
7969 @item -fno-ident
7970 Ignore the @samp{#ident} directive.
7972 @item -fno-gnu-linker
7973 Do not output global initializations (such as C++ constructors and
7974 destructors) in the form used by the GNU linker (on systems where the GNU
7975 linker is the standard method of handling them).  Use this option when
7976 you want to use a non-GNU linker, which also requires using the
7977 @command{collect2} program to make sure the system linker includes
7978 constructors and destructors.  (@command{collect2} is included in the GCC
7979 distribution.)  For systems which @emph{must} use @command{collect2}, the
7980 compiler driver @command{gcc} is configured to do this automatically.
7982 @item -finhibit-size-directive
7983 Don't output a @code{.size} assembler directive, or anything else that
7984 would cause trouble if the function is split in the middle, and the
7985 two halves are placed at locations far apart in memory.  This option is
7986 used when compiling @file{crtstuff.c}; you should not need to use it
7987 for anything else.
7989 @item -fverbose-asm
7990 Put extra commentary information in the generated assembly code to
7991 make it more readable.  This option is generally only of use to those
7992 who actually need to read the generated assembly code (perhaps while
7993 debugging the compiler itself).
7995 @samp{-fno-verbose-asm}, the default, causes the
7996 extra information to be omitted and is useful when comparing two assembler
7997 files.
7999 @item -fvolatile
8000 Consider all memory references through pointers to be volatile.
8002 @item -fvolatile-global
8003 Consider all memory references to extern and global data items to
8004 be volatile.  GCC does not consider static data items to be volatile
8005 because of this switch.
8007 @item -fvolatile-static
8008 Consider all memory references to static data to be volatile.
8010 @item -fpic
8011 @cindex global offset table
8012 @cindex PIC
8013 Generate position-independent code (PIC) suitable for use in a shared
8014 library, if supported for the target machine.  Such code accesses all
8015 constant addresses through a global offset table (GOT).  The dynamic
8016 loader resolves the GOT entries when the program starts (the dynamic
8017 loader is not part of GCC; it is part of the operating system).  If
8018 the GOT size for the linked executable exceeds a machine-specific
8019 maximum size, you get an error message from the linker indicating that
8020 @samp{-fpic} does not work; in that case, recompile with @samp{-fPIC}
8021 instead.  (These maximums are 16k on the m88k, 8k on the Sparc, and 32k
8022 on the m68k and RS/6000.  The 386 has no such limit.)
8024 Position-independent code requires special support, and therefore works
8025 only on certain machines.  For the 386, GCC supports PIC for System V
8026 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
8027 position-independent.
8029 @item -fPIC
8030 If supported for the target machine, emit position-independent code,
8031 suitable for dynamic linking and avoiding any limit on the size of the
8032 global offset table.  This option makes a difference on the m68k, m88k,
8033 and the Sparc.
8035 Position-independent code requires special support, and therefore works
8036 only on certain machines.
8038 @item -ffixed-@var{reg}
8039 Treat the register named @var{reg} as a fixed register; generated code
8040 should never refer to it (except perhaps as a stack pointer, frame
8041 pointer or in some other fixed role).
8043 @var{reg} must be the name of a register.  The register names accepted
8044 are machine-specific and are defined in the @code{REGISTER_NAMES}
8045 macro in the machine description macro file.
8047 This flag does not have a negative form, because it specifies a
8048 three-way choice.
8050 @item -fcall-used-@var{reg}
8051 Treat the register named @var{reg} as an allocable register that is
8052 clobbered by function calls.  It may be allocated for temporaries or
8053 variables that do not live across a call.  Functions compiled this way
8054 will not save and restore the register @var{reg}.
8056 It is an error to used this flag with the frame pointer or stack pointer.
8057 Use of this flag for other registers that have fixed pervasive roles in
8058 the machine's execution model will produce disastrous results.
8060 This flag does not have a negative form, because it specifies a
8061 three-way choice.
8063 @item -fcall-saved-@var{reg}
8064 Treat the register named @var{reg} as an allocable register saved by
8065 functions.  It may be allocated even for temporaries or variables that
8066 live across a call.  Functions compiled this way will save and restore
8067 the register @var{reg} if they use it.
8069 It is an error to used this flag with the frame pointer or stack pointer.
8070 Use of this flag for other registers that have fixed pervasive roles in
8071 the machine's execution model will produce disastrous results.
8073 A different sort of disaster will result from the use of this flag for
8074 a register in which function values may be returned.
8076 This flag does not have a negative form, because it specifies a
8077 three-way choice.
8079 @item -fpack-struct
8080 Pack all structure members together without holes.  Usually you would
8081 not want to use this option, since it makes the code suboptimal, and
8082 the offsets of structure members won't agree with system libraries.
8084 @item -fcheck-memory-usage
8085 Generate extra code to check each memory access.  GCC will generate
8086 code that is suitable for a detector of bad memory accesses such as
8087 @file{Checker}.
8089 Normally, you should compile all, or none, of your code with this option.
8091 If you do mix code compiled with and without this option,
8092 you must ensure that all code that has side effects
8093 and that is called by code compiled with this option
8094 is, itself, compiled with this option.
8095 If you do not, you might get erroneous messages from the detector.
8097 If you use functions from a library that have side-effects (such as
8098 @code{read}), you might not be able to recompile the library and
8099 specify this option.  In that case, you can enable the
8100 @samp{-fprefix-function-name} option, which requests GCC to encapsulate
8101 your code and make other functions look as if they were compiled with
8102 @samp{-fcheck-memory-usage}.  This is done by calling ``stubs'',
8103 which are provided by the detector.  If you cannot find or build
8104 stubs for every function you call, you might have to specify
8105 @samp{-fcheck-memory-usage} without @samp{-fprefix-function-name}.
8107 If you specify this option, you can not use the @code{asm} or
8108 @code{__asm__} keywords in functions with memory checking enabled.  GNU
8109 CC cannot understand what the @code{asm} statement may do, and therefore
8110 cannot generate the appropriate code, so it will reject it.  However, if
8111 you specify the function attribute @code{no_check_memory_usage}
8112 (@pxref{Function Attributes}), GNU CC will disable memory checking within a
8113 function; you may use @code{asm} statements inside such functions.  You
8114 may have an inline expansion of a non-checked function within a checked
8115 function; in that case GNU CC will not generate checks for the inlined
8116 function's memory accesses.
8118 If you move your @code{asm} statements to non-checked inline functions
8119 and they do access memory, you can add calls to the support code in your
8120 inline function, to indicate any reads, writes, or copies being done.
8121 These calls would be similar to those done in the stubs described above.
8123 @item -fprefix-function-name
8124 Request GCC to add a prefix to the symbols generated for function names.
8125 GCC adds a prefix to the names of functions defined as well as
8126 functions called.  Code compiled with this option and code compiled
8127 without the option can't be linked together, unless stubs are used.
8129 If you compile the following code with @samp{-fprefix-function-name}
8130 @example
8131 extern void bar (int);
8132 void
8133 foo (int a)
8135   return bar (a + 5);
8137 @end example
8139 @noindent
8140 GCC will compile the code as if it was written:
8141 @example
8142 extern void prefix_bar (int);
8143 void
8144 prefix_foo (int a)
8146   return prefix_bar (a + 5);
8148 @end example
8149 This option is designed to be used with @samp{-fcheck-memory-usage}.
8151 @item -finstrument-functions
8152 Generate instrumentation calls for entry and exit to functions.  Just
8153 after function entry and just before function exit, the following
8154 profiling functions will be called with the address of the current
8155 function and its call site.  (On some platforms,
8156 @code{__builtin_return_address} does not work beyond the current
8157 function, so the call site information may not be available to the
8158 profiling functions otherwise.)
8160 @example
8161 void __cyg_profile_func_enter (void *this_fn, void *call_site);
8162 void __cyg_profile_func_exit  (void *this_fn, void *call_site);
8163 @end example
8165 The first argument is the address of the start of the current function,
8166 which may be looked up exactly in the symbol table.
8168 This instrumentation is also done for functions expanded inline in other
8169 functions.  The profiling calls will indicate where, conceptually, the
8170 inline function is entered and exited.  This means that addressable
8171 versions of such functions must be available.  If all your uses of a
8172 function are expanded inline, this may mean an additional expansion of
8173 code size.  If you use @samp{extern inline} in your C code, an
8174 addressable version of such functions must be provided.  (This is
8175 normally the case anyways, but if you get lucky and the optimizer always
8176 expands the functions inline, you might have gotten away without
8177 providing static copies.)
8179 A function may be given the attribute @code{no_instrument_function}, in
8180 which case this instrumentation will not be done.  This can be used, for
8181 example, for the profiling functions listed above, high-priority
8182 interrupt routines, and any functions from which the profiling functions
8183 cannot safely be called (perhaps signal handlers, if the profiling
8184 routines generate output or allocate memory).
8186 @item -fstack-check
8187 Generate code to verify that you do not go beyond the boundary of the
8188 stack.  You should specify this flag if you are running in an
8189 environment with multiple threads, but only rarely need to specify it in
8190 a single-threaded environment since stack overflow is automatically
8191 detected on nearly all systems if there is only one stack.
8193 Note that this switch does not actually cause checking to be done; the
8194 operating system must do that.  The switch causes generation of code
8195 to ensure that the operating system sees the stack being extended.
8197 @item -fstack-limit-register=@var{reg}
8198 @itemx -fstack-limit-symbol=@var{sym}
8199 @itemx -fno-stack-limit
8200 Generate code to ensure that the stack does not grow beyond a certain value,
8201 either the value of a register or the address of a symbol.  If the stack
8202 would grow beyond the value, a signal is raised.  For most targets,
8203 the signal is raised before the stack overruns the boundary, so
8204 it is possible to catch the signal without taking special precautions.
8206 For instance, if the stack starts at address @samp{0x80000000} and grows
8207 downwards you can use the flags
8208 @samp{-fstack-limit-symbol=__stack_limit}
8209 @samp{-Wl,--defsym,__stack_limit=0x7ffe0000} which will enforce a stack
8210 limit of 128K.
8212 @cindex aliasing of parameters
8213 @cindex parameters, aliased
8214 @item -fargument-alias
8215 @itemx -fargument-noalias
8216 @itemx -fargument-noalias-global
8217 Specify the possible relationships among parameters and between
8218 parameters and global data.
8220 @samp{-fargument-alias} specifies that arguments (parameters) may
8221 alias each other and may alias global storage.
8222 @samp{-fargument-noalias} specifies that arguments do not alias
8223 each other, but may alias global storage.
8224 @samp{-fargument-noalias-global} specifies that arguments do not
8225 alias each other and do not alias global storage.
8227 Each language will automatically use whatever option is required by
8228 the language standard.  You should not need to use these options yourself.
8230 @item -fleading-underscore
8231 This option and its counterpart, -fno-leading-underscore, forcibly
8232 change the way C symbols are represented in the object file.  One use
8233 is to help link with legacy assembly code.
8235 Be warned that you should know what you are doing when invoking this
8236 option, and that not all targets provide complete support for it.
8237 @end table
8239 @c man end
8241 @node Environment Variables
8242 @section Environment Variables Affecting GCC
8243 @cindex environment variables
8245 @c man begin ENVIRONMENT
8247 This section describes several environment variables that affect how GCC
8248 operates.  Some of them work by specifying directories or prefixes to use
8249 when searching for various kinds of files. Some are used to specify other
8250 aspects of the compilation environment.
8252 @ifclear INTERNALS
8253 Note that you can also specify places to search using options such as
8254 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8255 take precedence over places specified using environment variables, which
8256 in turn take precedence over those specified by the configuration of GCC.
8258 @end ifclear
8259 @ifset INTERNALS
8260 Note that you can also specify places to search using options such as
8261 @samp{-B}, @samp{-I} and @samp{-L} (@pxref{Directory Options}).  These
8262 take precedence over places specified using environment variables, which
8263 in turn take precedence over those specified by the configuration of GCC.
8264 @xref{Driver}.
8265 @end ifset
8267 @table @env
8268 @item LANG
8269 @itemx LC_CTYPE
8270 @c @itemx LC_COLLATE
8271 @itemx LC_MESSAGES
8272 @c @itemx LC_MONETARY
8273 @c @itemx LC_NUMERIC
8274 @c @itemx LC_TIME
8275 @itemx LC_ALL
8276 @findex LANG
8277 @findex LC_CTYPE
8278 @c @findex LC_COLLATE
8279 @findex LC_MESSAGES
8280 @c @findex LC_MONETARY
8281 @c @findex LC_NUMERIC
8282 @c @findex LC_TIME
8283 @findex LC_ALL
8284 @cindex locale
8285 These environment variables control the way that GCC uses
8286 localization information that allow GCC to work with different
8287 national conventions.  GCC inspects the locale categories
8288 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
8289 so.  These locale categories can be set to any value supported by your
8290 installation.  A typical value is @samp{en_UK} for English in the United
8291 Kingdom.
8293 The @env{LC_CTYPE} environment variable specifies character
8294 classification.  GCC uses it to determine the character boundaries in
8295 a string; this is needed for some multibyte encodings that contain quote
8296 and escape characters that would otherwise be interpreted as a string
8297 end or escape.
8299 The @env{LC_MESSAGES} environment variable specifies the language to
8300 use in diagnostic messages.
8302 If the @env{LC_ALL} environment variable is set, it overrides the value
8303 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
8304 and @env{LC_MESSAGES} default to the value of the @env{LANG}
8305 environment variable.  If none of these variables are set, GCC
8306 defaults to traditional C English behavior.
8308 @item TMPDIR
8309 @findex TMPDIR
8310 If @env{TMPDIR} is set, it specifies the directory to use for temporary
8311 files.  GCC uses temporary files to hold the output of one stage of
8312 compilation which is to be used as input to the next stage: for example,
8313 the output of the preprocessor, which is the input to the compiler
8314 proper.
8316 @item GCC_EXEC_PREFIX
8317 @findex GCC_EXEC_PREFIX
8318 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
8319 names of the subprograms executed by the compiler.  No slash is added
8320 when this prefix is combined with the name of a subprogram, but you can
8321 specify a prefix that ends with a slash if you wish.
8323 If @env{GCC_EXEC_PREFIX} is not set, GNU CC will attempt to figure out
8324 an appropriate prefix to use based on the pathname it was invoked with.
8326 If GCC cannot find the subprogram using the specified prefix, it
8327 tries looking in the usual places for the subprogram.
8329 The default value of @env{GCC_EXEC_PREFIX} is
8330 @file{@var{prefix}/lib/gcc-lib/} where @var{prefix} is the value
8331 of @code{prefix} when you ran the @file{configure} script.
8333 Other prefixes specified with @samp{-B} take precedence over this prefix.
8335 This prefix is also used for finding files such as @file{crt0.o} that are
8336 used for linking.
8338 In addition, the prefix is used in an unusual way in finding the
8339 directories to search for header files.  For each of the standard
8340 directories whose name normally begins with @samp{/usr/local/lib/gcc-lib}
8341 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
8342 replacing that beginning with the specified prefix to produce an
8343 alternate directory name.  Thus, with @samp{-Bfoo/}, GCC will search
8344 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
8345 These alternate directories are searched first; the standard directories
8346 come next.
8348 @item COMPILER_PATH
8349 @findex COMPILER_PATH
8350 The value of @env{COMPILER_PATH} is a colon-separated list of
8351 directories, much like @env{PATH}.  GCC tries the directories thus
8352 specified when searching for subprograms, if it can't find the
8353 subprograms using @env{GCC_EXEC_PREFIX}.
8355 @item LIBRARY_PATH
8356 @findex LIBRARY_PATH
8357 The value of @env{LIBRARY_PATH} is a colon-separated list of
8358 directories, much like @env{PATH}.  When configured as a native compiler,
8359 GCC tries the directories thus specified when searching for special
8360 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
8361 using GCC also uses these directories when searching for ordinary
8362 libraries for the @samp{-l} option (but directories specified with
8363 @samp{-L} come first).
8365 @item C_INCLUDE_PATH
8366 @itemx CPLUS_INCLUDE_PATH
8367 @itemx OBJC_INCLUDE_PATH
8368 @findex C_INCLUDE_PATH
8369 @findex CPLUS_INCLUDE_PATH
8370 @findex OBJC_INCLUDE_PATH
8371 @c @itemx OBJCPLUS_INCLUDE_PATH
8372 These environment variables pertain to particular languages.  Each
8373 variable's value is a colon-separated list of directories, much like
8374 @env{PATH}.  When GCC searches for header files, it tries the
8375 directories listed in the variable for the language you are using, after
8376 the directories specified with @samp{-I} but before the standard header
8377 file directories.
8379 @item DEPENDENCIES_OUTPUT
8380 @findex DEPENDENCIES_OUTPUT
8381 @cindex dependencies for make as output
8382 If this variable is set, its value specifies how to output dependencies
8383 for Make based on the header files processed by the compiler.  This
8384 output looks much like the output from the @samp{-M} option
8385 (@pxref{Preprocessor Options}), but it goes to a separate file, and is
8386 in addition to the usual results of compilation.
8388 The value of @env{DEPENDENCIES_OUTPUT} can be just a file name, in
8389 which case the Make rules are written to that file, guessing the target
8390 name from the source file name.  Or the value can have the form
8391 @samp{@var{file} @var{target}}, in which case the rules are written to
8392 file @var{file} using @var{target} as the target name.
8394 @item LANG
8395 @findex LANG
8396 @cindex locale definition
8397 This variable is used to pass locale information to the compiler. One way in
8398 which this information is used is to determine the character set to be used
8399 when character literals, string literals and comments are parsed in C and C++.
8400 When the compiler is configured to allow multibyte characters,
8401 the following values for @env{LANG} are recognized:
8403 @table @samp
8404 @item C-JIS
8405 Recognize JIS characters.
8406 @item C-SJIS
8407 Recognize SJIS characters.
8408 @item C-EUCJP
8409 Recognize EUCJP characters.
8410 @end table
8412 If @env{LANG} is not defined, or if it has some other value, then the
8413 compiler will use mblen and mbtowc as defined by the default locale to
8414 recognize and translate multibyte characters.
8415 @end table
8417 @c man end
8419 @node Running Protoize
8420 @section Running Protoize
8422 The program @code{protoize} is an optional part of GNU C.  You can use
8423 it to add prototypes to a program, thus converting the program to ISO
8424 C in one respect.  The companion program @code{unprotoize} does the
8425 reverse: it removes argument types from any prototypes that are found.
8427 When you run these programs, you must specify a set of source files as
8428 command line arguments.  The conversion programs start out by compiling
8429 these files to see what functions they define.  The information gathered
8430 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
8432 After scanning comes actual conversion.  The specified files are all
8433 eligible to be converted; any files they include (whether sources or
8434 just headers) are eligible as well.
8436 But not all the eligible files are converted.  By default,
8437 @code{protoize} and @code{unprotoize} convert only source and header
8438 files in the current directory.  You can specify additional directories
8439 whose files should be converted with the @samp{-d @var{directory}}
8440 option.  You can also specify particular files to exclude with the
8441 @samp{-x @var{file}} option.  A file is converted if it is eligible, its
8442 directory name matches one of the specified directory names, and its
8443 name within the directory has not been excluded.
8445 Basic conversion with @code{protoize} consists of rewriting most
8446 function definitions and function declarations to specify the types of
8447 the arguments.  The only ones not rewritten are those for varargs
8448 functions.
8450 @code{protoize} optionally inserts prototype declarations at the
8451 beginning of the source file, to make them available for any calls that
8452 precede the function's definition.  Or it can insert prototype
8453 declarations with block scope in the blocks where undeclared functions
8454 are called.
8456 Basic conversion with @code{unprotoize} consists of rewriting most
8457 function declarations to remove any argument types, and rewriting
8458 function definitions to the old-style pre-ISO form.
8460 Both conversion programs print a warning for any function declaration or
8461 definition that they can't convert.  You can suppress these warnings
8462 with @samp{-q}.
8464 The output from @code{protoize} or @code{unprotoize} replaces the
8465 original source file.  The original file is renamed to a name ending
8466 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav} 
8467 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
8468 for DOS) file already exists, then the source file is simply discarded.
8470 @code{protoize} and @code{unprotoize} both depend on GCC itself to
8471 scan the program and collect information about the functions it uses.
8472 So neither of these programs will work until GCC is installed.
8474 Here is a table of the options you can use with @code{protoize} and
8475 @code{unprotoize}.  Each option works with both programs unless
8476 otherwise stated.
8478 @table @code
8479 @item -B @var{directory}
8480 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
8481 usual directory (normally @file{/usr/local/lib}).  This file contains
8482 prototype information about standard system functions.  This option
8483 applies only to @code{protoize}.
8485 @item -c @var{compilation-options}
8486 Use  @var{compilation-options} as the options when running @code{gcc} to
8487 produce the @samp{.X} files.  The special option @samp{-aux-info} is
8488 always passed in addition, to tell @code{gcc} to write a @samp{.X} file.
8490 Note that the compilation options must be given as a single argument to
8491 @code{protoize} or @code{unprotoize}.  If you want to specify several
8492 @code{gcc} options, you must quote the entire set of compilation options
8493 to make them a single word in the shell.
8495 There are certain @code{gcc} arguments that you cannot use, because they
8496 would produce the wrong kind of output.  These include @samp{-g},
8497 @samp{-O}, @samp{-c}, @samp{-S}, and @samp{-o} If you include these in
8498 the @var{compilation-options}, they are ignored.
8500 @item -C
8501 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
8502 systems) instead of @samp{.c}.  This is convenient if you are converting 
8503 a C program to C++.  This option applies only to @code{protoize}.
8505 @item -g
8506 Add explicit global declarations.  This means inserting explicit
8507 declarations at the beginning of each source file for each function
8508 that is called in the file and was not declared.  These declarations
8509 precede the first function definition that contains a call to an
8510 undeclared function.  This option applies only to @code{protoize}.
8512 @item -i @var{string}
8513 Indent old-style parameter declarations with the string @var{string}.
8514 This option applies only to @code{protoize}.
8516 @code{unprotoize} converts prototyped function definitions to old-style
8517 function definitions, where the arguments are declared between the
8518 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
8519 uses five spaces as the indentation.  If you want to indent with just
8520 one space instead, use @samp{-i " "}.
8522 @item -k
8523 Keep the @samp{.X} files.  Normally, they are deleted after conversion
8524 is finished.
8526 @item -l
8527 Add explicit local declarations.  @code{protoize} with @samp{-l} inserts
8528 a prototype declaration for each function in each block which calls the
8529 function without any declaration.  This option applies only to
8530 @code{protoize}.
8532 @item -n
8533 Make no real changes.  This mode just prints information about the conversions
8534 that would have been done without @samp{-n}.
8536 @item -N
8537 Make no @samp{.save} files.  The original files are simply deleted.
8538 Use this option with caution.
8540 @item -p @var{program}
8541 Use the program @var{program} as the compiler.  Normally, the name
8542 @file{gcc} is used.
8544 @item -q
8545 Work quietly.  Most warnings are suppressed.
8547 @item -v
8548 Print the version number, just like @samp{-v} for @code{gcc}.
8549 @end table
8551 If you need special compiler options to compile one of your program's
8552 source files, then you should generate that file's @samp{.X} file
8553 specially, by running @code{gcc} on that source file with the
8554 appropriate options and the option @samp{-aux-info}.  Then run
8555 @code{protoize} on the entire set of files.  @code{protoize} will use
8556 the existing @samp{.X} file because it is newer than the source file.
8557 For example:
8559 @example
8560 gcc -Dfoo=bar file1.c -aux-info
8561 protoize *.c
8562 @end example
8564 @noindent
8565 You need to include the special files along with the rest in the
8566 @code{protoize} command, even though their @samp{.X} files already
8567 exist, because otherwise they won't get converted.
8569 @xref{Protoize Caveats}, for more information on how to use
8570 @code{protoize} successfully.