OSDN Git Service

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