OSDN Git Service

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