S/390: Add -fsplit-stack support
[official-gcc.git] / gcc / fortran / invoke.texi
blob7fbbc4b01a9be76bdb2478b6675b2daff85d47bf
1 @c Copyright (C) 2004-2016 Free Software Foundation, Inc.
2 @c This is part of the GNU Fortran manual.   
3 @c For copying conditions, see the file gfortran.texi.
5 @ignore
6 @c man begin COPYRIGHT
7 Copyright @copyright{} 2004-2016 Free Software Foundation, Inc.
9 Permission is granted to copy, distribute and/or modify this document
10 under the terms of the GNU Free Documentation License, Version 1.3 or
11 any later version published by the Free Software Foundation; with the
12 Invariant Sections being ``Funding Free Software'', the Front-Cover
13 Texts being (a) (see below), and with the Back-Cover Texts being (b)
14 (see below).  A copy of the license is included in the gfdl(7) man page.
16 (a) The FSF's Front-Cover Text is:
18      A GNU Manual
20 (b) The FSF's Back-Cover Text is:
22      You have freedom to copy and modify this GNU Manual, like GNU
23      software.  Copies published by the Free Software Foundation raise
24      funds for GNU development.
25 @c man end
26 @c Set file name and title for the man page.
27 @setfilename gfortran
28 @settitle GNU Fortran compiler.
29 @c man begin SYNOPSIS
30 gfortran [@option{-c}|@option{-S}|@option{-E}]
31          [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
32          [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
33          [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
34          [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
35          [@option{-f}@var{option}@dots{}]
36          [@option{-m}@var{machine-option}@dots{}]
37          [@option{-o} @var{outfile}] @var{infile}@dots{}
39 Only the most useful options are listed here; see below for the
40 remainder.
41 @c man end
42 @c man begin SEEALSO
43 gpl(7), gfdl(7), fsf-funding(7),
44 cpp(1), gcov(1), gcc(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
45 and the Info entries for @file{gcc}, @file{cpp}, @file{gfortran}, @file{as},
46 @file{ld}, @file{binutils} and @file{gdb}.
47 @c man end
48 @c man begin BUGS
49 For instructions on reporting bugs, see
50 @w{@value{BUGURL}}.
51 @c man end
52 @c man begin AUTHOR
53 See the Info entry for @command{gfortran} for contributors to GCC and
54 GNU Fortran.
55 @c man end
56 @end ignore
58 @node Invoking GNU Fortran
59 @chapter GNU Fortran Command Options
60 @cindex GNU Fortran command options
61 @cindex command options
62 @cindex options, @command{gfortran} command
64 @c man begin DESCRIPTION
66 The @command{gfortran} command supports all the options supported by the
67 @command{gcc} command.  Only options specific to GNU Fortran are documented
68 here.
70 @xref{Invoking GCC,,GCC Command Options,gcc,Using the GNU Compiler
71 Collection (GCC)}, for information
72 on the non-Fortran-specific aspects of the @command{gcc} command (and,
73 therefore, the @command{gfortran} command).
75 @cindex options, negative forms
76 All GCC and GNU Fortran options
77 are accepted both by @command{gfortran} and by @command{gcc}
78 (as well as any other drivers built at the same time,
79 such as @command{g++}),
80 since adding GNU Fortran to the GCC distribution
81 enables acceptance of GNU Fortran options
82 by all of the relevant drivers.
84 In some cases, options have positive and negative forms;
85 the negative form of @option{-ffoo} would be @option{-fno-foo}.
86 This manual documents only one of these two forms, whichever
87 one is not the default.
88 @c man end
90 @menu
91 * Option Summary::      Brief list of all @command{gfortran} options,
92                         without explanations.
93 * Fortran Dialect Options::  Controlling the variant of Fortran language
94                              compiled.
95 * Preprocessing Options::  Enable and customize preprocessing.
96 * Error and Warning Options::     How picky should the compiler be?
97 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
98 * Directory Options::   Where to find module files
99 * Link Options ::       Influencing the linking step
100 * Runtime Options::     Influencing runtime behavior
101 * Code Gen Options::    Specifying conventions for function calls, data layout
102                         and register usage.
103 * Environment Variables:: Environment variables that affect @command{gfortran}.
104 @end menu
106 @node Option Summary
107 @section Option summary
109 @c man begin OPTIONS
111 Here is a summary of all the options specific to GNU Fortran, grouped
112 by type.  Explanations are in the following sections.
114 @table @emph
115 @item Fortran Language Options
116 @xref{Fortran Dialect Options,,Options controlling Fortran dialect}.
117 @gccoptlist{-fall-intrinsics -fbackslash -fcray-pointer -fd-lines-as-code @gol
118 -fd-lines-as-comments -fdefault-double-8 -fdefault-integer-8 @gol
119 -fdefault-real-8 -fdollar-ok -ffixed-line-length-@var{n} @gol
120 -ffixed-line-length-none -ffree-form -ffree-line-length-@var{n} @gol
121 -ffree-line-length-none -fimplicit-none -finteger-4-integer-8 @gol
122 -fmax-identifier-length -fmodule-private -ffixed-form -fno-range-check @gol
123 -fopenacc -fopenmp -freal-4-real-10 -freal-4-real-16 -freal-4-real-8 @gol
124 -freal-8-real-10 -freal-8-real-16 -freal-8-real-4 -std=@var{std}
127 @item Preprocessing Options
128 @xref{Preprocessing Options,,Enable and customize preprocessing}.
129 @gccoptlist{-A-@var{question}@r{[}=@var{answer}@r{]}
130 -A@var{question}=@var{answer} -C -CC -D@var{macro}@r{[}=@var{defn}@r{]}
131 -H -P @gol
132 -U@var{macro} -cpp -dD -dI -dM -dN -dU -fworking-directory
133 -imultilib @var{dir} @gol
134 -iprefix @var{file} -iquote -isysroot @var{dir} -isystem @var{dir} -nocpp 
135 -nostdinc @gol
136 -undef
139 @item Error and Warning Options
140 @xref{Error and Warning Options,,Options to request or suppress errors
141 and warnings}.
142 @gccoptlist{-Waliasing -Wall -Wampersand -Warray-bounds
143 -Wc-binding-type -Wcharacter-truncation @gol
144 -Wconversion -Wfunction-elimination -Wimplicit-interface @gol
145 -Wimplicit-procedure -Wintrinsic-shadow -Wuse-without-only -Wintrinsics-std @gol
146 -Wline-truncation -Wno-align-commons -Wno-tabs -Wreal-q-constant @gol
147 -Wsurprising -Wunderflow -Wunused-parameter -Wrealloc-lhs -Wrealloc-lhs-all @gol
148 -Wtarget-lifetime -fmax-errors=@var{n} -fsyntax-only -pedantic -pedantic-errors
151 @item Debugging Options
152 @xref{Debugging Options,,Options for debugging your program or GNU Fortran}.
153 @gccoptlist{-fbacktrace -fdump-fortran-optimized -fdump-fortran-original @gol
154 -fdump-parse-tree -ffpe-trap=@var{list} -ffpe-summary=@var{list}
157 @item Directory Options
158 @xref{Directory Options,,Options for directory search}.
159 @gccoptlist{-I@var{dir}  -J@var{dir} -fintrinsic-modules-path @var{dir}}
161 @item Link Options
162 @xref{Link Options,,Options for influencing the linking step}.
163 @gccoptlist{-static-libgfortran}
165 @item Runtime Options
166 @xref{Runtime Options,,Options for influencing runtime behavior}.
167 @gccoptlist{-fconvert=@var{conversion} -fmax-subrecord-length=@var{length} @gol
168 -frecord-marker=@var{length} -fsign-zero
171 @item Code Generation Options
172 @xref{Code Gen Options,,Options for code generation conventions}.
173 @gccoptlist{-faggressive-function-elimination -fblas-matmul-limit=@var{n} @gol
174 -fbounds-check -fcheck-array-temporaries @gol
175 -fcheck=@var{<all|array-temps|bounds|do|mem|pointer|recursion>} @gol
176 -fcoarray=@var{<none|single|lib>} -fexternal-blas -ff2c
177 -ffrontend-optimize @gol
178 -finit-character=@var{n} -finit-integer=@var{n} -finit-local-zero @gol
179 -finit-logical=@var{<true|false>}
180 -finit-real=@var{<zero|inf|-inf|nan|snan>} @gol
181 -finline-matmul-limit=@var{n} @gol
182 -fmax-array-constructor=@var{n} -fmax-stack-var-size=@var{n}
183 -fno-align-commons @gol
184 -fno-automatic -fno-protect-parens -fno-underscoring @gol
185 -fsecond-underscore -fpack-derived -frealloc-lhs -frecursive @gol
186 -frepack-arrays -fshort-enums -fstack-arrays
188 @end table
190 @node Fortran Dialect Options
191 @section Options controlling Fortran dialect
192 @cindex dialect options
193 @cindex language, dialect options
194 @cindex options, dialect
196 The following options control the details of the Fortran dialect
197 accepted by the compiler:
199 @table @gcctabopt
200 @item -ffree-form
201 @itemx -ffixed-form
202 @opindex @code{ffree-form}
203 @opindex @code{ffixed-form}
204 @cindex options, Fortran dialect
205 @cindex file format, free
206 @cindex file format, fixed
207 Specify the layout used by the source file.  The free form layout
208 was introduced in Fortran 90.  Fixed form was traditionally used in
209 older Fortran programs.  When neither option is specified, the source
210 form is determined by the file extension.
212 @item -fall-intrinsics
213 @opindex @code{fall-intrinsics}
214 This option causes all intrinsic procedures (including the GNU-specific
215 extensions) to be accepted.  This can be useful with @option{-std=f95} to
216 force standard-compliance but get access to the full range of intrinsics
217 available with @command{gfortran}.  As a consequence, @option{-Wintrinsics-std}
218 will be ignored and no user-defined procedure with the same name as any
219 intrinsic will be called except when it is explicitly declared @code{EXTERNAL}.
221 @item -fd-lines-as-code
222 @itemx -fd-lines-as-comments
223 @opindex @code{fd-lines-as-code}
224 @opindex @code{fd-lines-as-comments}
225 Enable special treatment for lines beginning with @code{d} or @code{D}
226 in fixed form sources.  If the @option{-fd-lines-as-code} option is
227 given they are treated as if the first column contained a blank.  If the
228 @option{-fd-lines-as-comments} option is given, they are treated as
229 comment lines.
231 @item -fdollar-ok
232 @opindex @code{fdollar-ok}
233 @cindex @code{$}
234 @cindex symbol names
235 @cindex character set
236 Allow @samp{$} as a valid non-first character in a symbol name. Symbols 
237 that start with @samp{$} are rejected since it is unclear which rules to
238 apply to implicit typing as different vendors implement different rules.
239 Using @samp{$} in @code{IMPLICIT} statements is also rejected.
241 @item -fbackslash
242 @opindex @code{backslash}
243 @cindex backslash
244 @cindex escape characters
245 Change the interpretation of backslashes in string literals from a single
246 backslash character to ``C-style'' escape characters. The following
247 combinations are expanded @code{\a}, @code{\b}, @code{\f}, @code{\n},
248 @code{\r}, @code{\t}, @code{\v}, @code{\\}, and @code{\0} to the ASCII
249 characters alert, backspace, form feed, newline, carriage return,
250 horizontal tab, vertical tab, backslash, and NUL, respectively.
251 Additionally, @code{\x}@var{nn}, @code{\u}@var{nnnn} and
252 @code{\U}@var{nnnnnnnn} (where each @var{n} is a hexadecimal digit) are
253 translated into the Unicode characters corresponding to the specified code
254 points. All other combinations of a character preceded by \ are
255 unexpanded.
257 @item -fmodule-private
258 @opindex @code{fmodule-private}
259 @cindex module entities
260 @cindex private
261 Set the default accessibility of module entities to @code{PRIVATE}.
262 Use-associated entities will not be accessible unless they are explicitly
263 declared as @code{PUBLIC}.
265 @item -ffixed-line-length-@var{n}
266 @opindex @code{ffixed-line-length-}@var{n}
267 @cindex file format, fixed
268 Set column after which characters are ignored in typical fixed-form
269 lines in the source file, and through which spaces are assumed (as
270 if padded to that length) after the ends of short fixed-form lines.
272 Popular values for @var{n} include 72 (the
273 standard and the default), 80 (card image), and 132 (corresponding
274 to ``extended-source'' options in some popular compilers).
275 @var{n} may also be @samp{none}, meaning that the entire line is meaningful
276 and that continued character constants never have implicit spaces appended
277 to them to fill out the line.
278 @option{-ffixed-line-length-0} means the same thing as
279 @option{-ffixed-line-length-none}.
281 @item -ffree-line-length-@var{n}
282 @opindex @code{ffree-line-length-}@var{n}
283 @cindex file format, free
284 Set column after which characters are ignored in typical free-form
285 lines in the source file. The default value is 132.
286 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
287 @option{-ffree-line-length-0} means the same thing as
288 @option{-ffree-line-length-none}.
290 @item -fmax-identifier-length=@var{n}
291 @opindex @code{fmax-identifier-length=}@var{n}
292 Specify the maximum allowed identifier length. Typical values are
293 31 (Fortran 95) and 63 (Fortran 2003 and Fortran 2008).
295 @item -fimplicit-none
296 @opindex @code{fimplicit-none}
297 Specify that no implicit typing is allowed, unless overridden by explicit
298 @code{IMPLICIT} statements.  This is the equivalent of adding
299 @code{implicit none} to the start of every procedure.
301 @item -fcray-pointer
302 @opindex @code{fcray-pointer}
303 Enable the Cray pointer extension, which provides C-like pointer
304 functionality.
306 @item -fopenacc
307 @opindex @code{fopenacc}
308 @cindex OpenACC
309 Enable the OpenACC extensions.  This includes OpenACC @code{!$acc}
310 directives in free form and @code{c$acc}, @code{*$acc} and
311 @code{!$acc} directives in fixed form, @code{!$} conditional
312 compilation sentinels in free form and @code{c$}, @code{*$} and
313 @code{!$} sentinels in fixed form, and when linking arranges for the
314 OpenACC runtime library to be linked in.
316 Note that this is an experimental feature, incomplete, and subject to
317 change in future versions of GCC.  See
318 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
320 @item -fopenmp
321 @opindex @code{fopenmp}
322 @cindex OpenMP
323 Enable the OpenMP extensions.  This includes OpenMP @code{!$omp} directives
324 in free form
325 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
326 @code{!$} conditional compilation sentinels in free form
327 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form, 
328 and when linking arranges for the OpenMP runtime library to be linked
329 in.  The option @option{-fopenmp} implies @option{-frecursive}.
331 @item -fno-range-check
332 @opindex @code{frange-check}
333 Disable range checking on results of simplification of constant
334 expressions during compilation.  For example, GNU Fortran will give
335 an error at compile time when simplifying @code{a = 1. / 0}.
336 With this option, no error will be given and @code{a} will be assigned
337 the value @code{+Infinity}.  If an expression evaluates to a value
338 outside of the relevant range of [@code{-HUGE()}:@code{HUGE()}],
339 then the expression will be replaced by @code{-Inf} or @code{+Inf}
340 as appropriate.
341 Similarly, @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow
342 on most systems, but with @option{-fno-range-check} the value will
343 ``wrap around'' and @code{i} will be initialized to @math{-1} instead.
345 @item -fdefault-integer-8
346 @opindex @code{fdefault-integer-8}
347 Set the default integer and logical types to an 8 byte wide type.  This option
348 also affects the kind of integer constants like @code{42}. Unlike
349 @option{-finteger-4-integer-8}, it does not promote variables with explicit
350 kind declaration.
352 @item -fdefault-real-8
353 @opindex @code{fdefault-real-8}
354 Set the default real type to an 8 byte wide type. This option also affects
355 the kind of non-double real constants like @code{1.0}, and does promote
356 the default width of @code{DOUBLE PRECISION} to 16 bytes if possible, unless
357 @code{-fdefault-double-8} is given, too. Unlike @option{-freal-4-real-8},
358 it does not promote variables with explicit kind declaration.
360 @item -fdefault-double-8
361 @opindex @code{fdefault-double-8}
362 Set the @code{DOUBLE PRECISION} type to an 8 byte wide type.  Do nothing if this
363 is already the default.  If @option{-fdefault-real-8} is given,
364 @code{DOUBLE PRECISION} would instead be promoted to 16 bytes if possible, and
365 @option{-fdefault-double-8} can be used to prevent this.  The kind of real
366 constants like @code{1.d0} will not be changed by @option{-fdefault-real-8}
367 though, so also @option{-fdefault-double-8} does not affect it.
369 @item -finteger-4-integer-8
370 @opindex @code{finteger-4-integer-8}
371 Promote all @code{INTEGER(KIND=4)} entities to an @code{INTEGER(KIND=8)}
372 entities.  If @code{KIND=8} is unavailable, then an error will be issued.
373 This option should be used with care and may not be suitable for your codes.
374 Areas of possible concern include calls to external procedures,
375 alignment in @code{EQUIVALENCE} and/or @code{COMMON}, generic interfaces,
376 BOZ literal constant conversion, and I/O.  Inspection of the intermediate
377 representation of the translated Fortran code, produced by
378 @option{-fdump-tree-original}, is suggested.
380 @item  -freal-4-real-8
381 @itemx -freal-4-real-10
382 @itemx -freal-4-real-16
383 @itemx -freal-8-real-4
384 @itemx -freal-8-real-10
385 @itemx -freal-8-real-16
386 @opindex @code{freal-4-real-8}
387 @opindex @code{freal-4-real-10}
388 @opindex @code{freal-4-real-16}
389 @opindex @code{freal-8-real-4}
390 @opindex @code{freal-8-real-10}
391 @opindex @code{freal-8-real-16}
392 @cindex options, real kind type promotion
393 Promote all @code{REAL(KIND=M)} entities to @code{REAL(KIND=N)} entities.
394 If @code{REAL(KIND=N)} is unavailable, then an error will be issued.
395 All other real kind types are unaffected by this option.
396 These options should be used with care and may not be suitable for your
397 codes.  Areas of possible concern include calls to external procedures,
398 alignment in @code{EQUIVALENCE} and/or @code{COMMON}, generic interfaces,
399 BOZ literal constant conversion, and I/O.  Inspection of the intermediate
400 representation of the translated Fortran code, produced by
401 @option{-fdump-tree-original}, is suggested.
403 @item -std=@var{std}
404 @opindex @code{std=}@var{std} option
405 Specify the standard to which the program is expected to conform, which
406 may be one of @samp{f95}, @samp{f2003}, @samp{f2008}, @samp{gnu}, or
407 @samp{legacy}.  The default value for @var{std} is @samp{gnu}, which
408 specifies a superset of the Fortran 95 standard that includes all of the
409 extensions supported by GNU Fortran, although warnings will be given for
410 obsolete extensions not recommended for use in new code.  The
411 @samp{legacy} value is equivalent but without the warnings for obsolete
412 extensions, and may be useful for old non-standard programs.  The
413 @samp{f95}, @samp{f2003} and @samp{f2008} values specify strict
414 conformance to the Fortran 95, Fortran 2003 and Fortran 2008 standards,
415 respectively; errors are given for all extensions beyond the relevant
416 language standard, and warnings are given for the Fortran 77 features
417 that are permitted but obsolescent in later standards. @samp{-std=f2008ts}
418 allows the Fortran 2008 standard including the additions of the 
419 Technical Specification (TS) 29113 on Further Interoperability of Fortran
420 with C and TS 18508 on Additional Parallel Features in Fortran.
422 @end table
424 @node Preprocessing Options
425 @section Enable and customize preprocessing
426 @cindex preprocessor
427 @cindex options, preprocessor
428 @cindex CPP
430 Preprocessor related options. See section 
431 @ref{Preprocessing and conditional compilation} for more detailed
432 information on preprocessing in @command{gfortran}.
434 @table @gcctabopt
435 @item -cpp
436 @itemx -nocpp
437 @opindex @code{cpp}
438 @opindex @code{fpp}
439 @cindex preprocessor, enable
440 @cindex preprocessor, disable
441 Enable preprocessing. The preprocessor is automatically invoked if
442 the file extension is @file{.fpp}, @file{.FPP},  @file{.F}, @file{.FOR},
443 @file{.FTN}, @file{.F90}, @file{.F95}, @file{.F03} or @file{.F08}. Use
444 this option to manually enable preprocessing of any kind of Fortran file.
446 To disable preprocessing of files with any of the above listed extensions,
447 use the negative form: @option{-nocpp}.
449 The preprocessor is run in traditional mode. Any restrictions of the
450 file-format, especially the limits on line length, apply for
451 preprocessed output as well, so it might be advisable to use the
452 @option{-ffree-line-length-none} or @option{-ffixed-line-length-none}
453 options.
455 @item -dM
456 @opindex @code{dM}
457 @cindex preprocessor, debugging
458 @cindex debugging, preprocessor
459 Instead of the normal output, generate a list of @code{'#define'}
460 directives for all the macros defined during the execution of the
461 preprocessor, including predefined macros. This gives you a way
462 of finding out what is predefined in your version of the preprocessor.
463 Assuming you have no file @file{foo.f90}, the command
464 @smallexample
465   touch foo.f90; gfortran -cpp -E -dM foo.f90
466 @end smallexample
467 will show all the predefined macros.
469 @item -dD
470 @opindex @code{dD}
471 @cindex preprocessor, debugging
472 @cindex debugging, preprocessor
473 Like @option{-dM} except in two respects: it does not include the
474 predefined macros, and it outputs both the @code{#define} directives
475 and the result of preprocessing. Both kinds of output go to the
476 standard output file.
478 @item -dN
479 @opindex @code{dN}
480 @cindex preprocessor, debugging
481 @cindex debugging, preprocessor
482 Like @option{-dD}, but emit only the macro names, not their expansions.
484 @item -dU
485 @opindex @code{dU}
486 @cindex preprocessor, debugging
487 @cindex debugging, preprocessor
488 Like @option{dD} except that only macros that are expanded, or whose
489 definedness is tested in preprocessor directives, are output; the 
490 output is delayed until the use or test of the macro; and @code{'#undef'}
491 directives are also output for macros tested but undefined at the time.
493 @item -dI
494 @opindex @code{dI}
495 @cindex preprocessor, debugging
496 @cindex debugging, preprocessor
497 Output @code{'#include'} directives in addition to the result
498 of preprocessing.
500 @item -fworking-directory
501 @opindex @code{fworking-directory}
502 @cindex preprocessor, working directory
503 Enable generation of linemarkers in the preprocessor output that will
504 let the compiler know the current working directory at the time of
505 preprocessing. When this option is enabled, the preprocessor will emit,
506 after the initial linemarker, a second linemarker with the current
507 working directory followed by two slashes. GCC will use this directory,
508 when it is present in the preprocessed input, as the directory emitted
509 as the current working directory in some debugging information formats.
510 This option is implicitly enabled if debugging information is enabled,
511 but this can be inhibited with the negated form
512 @option{-fno-working-directory}. If the @option{-P} flag is present
513 in the command line, this option has no effect, since no @code{#line}
514 directives are emitted whatsoever.
516 @item -idirafter @var{dir}
517 @opindex @code{idirafter @var{dir}}
518 @cindex preprocessing, include path
519 Search @var{dir} for include files, but do it after all directories
520 specified with @option{-I} and the standard system directories have
521 been exhausted. @var{dir} is treated as a system include directory.
522 If dir begins with @code{=}, then the @code{=} will be replaced by
523 the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
525 @item -imultilib @var{dir}
526 @opindex @code{imultilib @var{dir}}
527 @cindex preprocessing, include path
528 Use @var{dir} as a subdirectory of the directory containing target-specific
529 C++ headers.
531 @item -iprefix @var{prefix}
532 @opindex @code{iprefix @var{prefix}}
533 @cindex preprocessing, include path
534 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
535 options. If the @var{prefix} represents a directory, you should include
536 the final @code{'/'}.
538 @item -isysroot @var{dir}
539 @opindex @code{isysroot @var{dir}}
540 @cindex preprocessing, include path
541 This option is like the @option{--sysroot} option, but applies only to
542 header files. See the @option{--sysroot} option for more information.
544 @item -iquote @var{dir}
545 @opindex @code{iquote @var{dir}}
546 @cindex preprocessing, include path
547 Search @var{dir} only for header files requested with @code{#include "file"};
548 they are not searched for @code{#include <file>}, before all directories
549 specified by @option{-I} and before the standard system directories. If
550 @var{dir} begins with @code{=}, then the @code{=} will be replaced by the
551 sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
553 @item -isystem @var{dir}
554 @opindex @code{isystem @var{dir}}
555 @cindex preprocessing, include path
556 Search @var{dir} for header files, after all directories specified by
557 @option{-I} but before the standard system directories. Mark it as a
558 system directory, so that it gets the same special treatment as is
559 applied to the standard system directories. If @var{dir} begins with
560 @code{=}, then the @code{=} will be replaced by the sysroot prefix;
561 see @option{--sysroot} and @option{-isysroot}.
563 @item -nostdinc
564 @opindex @code{nostdinc}
565 Do not search the standard system directories for header files. Only
566 the directories you have specified with @option{-I} options (and the
567 directory of the current file, if appropriate) are searched.
569 @item -undef
570 @opindex @code{undef}
571 Do not predefine any system-specific or GCC-specific macros.
572 The standard predefined macros remain defined.
574 @item -A@var{predicate}=@var{answer}
575 @opindex @code{A@var{predicate}=@var{answer}}
576 @cindex preprocessing, assertion
577 Make an assertion with the predicate @var{predicate} and answer @var{answer}.
578 This form is preferred to the older form -A predicate(answer), which is still
579 supported, because it does not use shell special characters.
581 @item -A-@var{predicate}=@var{answer}
582 @opindex @code{A-@var{predicate}=@var{answer}}
583 @cindex preprocessing, assertion
584 Cancel an assertion with the predicate @var{predicate} and answer @var{answer}.
586 @item -C
587 @opindex @code{C}
588 @cindex preprocessing, keep comments
589 Do not discard comments. All comments are passed through to the output
590 file, except for comments in processed directives, which are deleted
591 along with the directive.
593 You should be prepared for side effects when using @option{-C}; it causes
594 the preprocessor to treat comments as tokens in their own right. For example,
595 comments appearing at the start of what would be a directive line have the
596 effect of turning that line into an ordinary source line, since the first
597 token on the line is no longer a @code{'#'}.
599 Warning: this currently handles C-Style comments only. The preprocessor
600 does not yet recognize Fortran-style comments.
602 @item -CC
603 @opindex @code{CC}
604 @cindex preprocessing, keep comments
605 Do not discard comments, including during macro expansion. This is like
606 @option{-C}, except that comments contained within macros are also passed
607 through to the output file where the macro is expanded.
609 In addition to the side-effects of the @option{-C} option, the @option{-CC}
610 option causes all C++-style comments inside a macro to be converted to C-style
611 comments. This is to prevent later use of that macro from inadvertently
612 commenting out the remainder of the source line. The @option{-CC} option
613 is generally used to support lint comments.
615 Warning: this currently handles C- and C++-Style comments only. The
616 preprocessor does not yet recognize Fortran-style comments.
618 @item -D@var{name}
619 @opindex @code{D@var{name}}
620 @cindex preprocessing, define macros
621 Predefine name as a macro, with definition @code{1}.
623 @item -D@var{name}=@var{definition}
624 @opindex @code{D@var{name}=@var{definition}}
625 @cindex preprocessing, define macros
626 The contents of @var{definition} are tokenized and processed as if they
627 appeared during translation phase three in a @code{'#define'} directive.
628 In particular, the definition will be truncated by embedded newline
629 characters.
631 If you are invoking the preprocessor from a shell or shell-like program
632 you may need to use the shell's quoting syntax to protect characters such
633 as spaces that have a meaning in the shell syntax.
635 If you wish to define a function-like macro on the command line, write
636 its argument list with surrounding parentheses before the equals sign
637 (if any). Parentheses are meaningful to most shells, so you will need
638 to quote the option. With sh and csh, @code{-D'name(args...)=definition'}
639 works.
641 @option{-D} and @option{-U} options are processed in the order they are
642 given on the command line. All -imacros file and -include file options
643 are processed after all -D and -U options.
645 @item -H
646 @opindex @code{H}
647 Print the name of each header file used, in addition to other normal
648 activities. Each name is indented to show how deep in the @code{'#include'}
649 stack it is.
651 @item -P
652 @opindex @code{P}
653 @cindex preprocessing, no linemarkers
654 Inhibit generation of linemarkers in the output from the preprocessor.
655 This might be useful when running the preprocessor on something that
656 is not C code, and will be sent to a program which might be confused
657 by the linemarkers.
659 @item -U@var{name}
660 @opindex @code{U@var{name}}
661 @cindex preprocessing, undefine macros
662 Cancel any previous definition of @var{name}, either built in or provided
663 with a @option{-D} option.
664 @end table
667 @node Error and Warning Options
668 @section Options to request or suppress errors and warnings
669 @cindex options, warnings
670 @cindex options, errors
671 @cindex warnings, suppressing
672 @cindex messages, error
673 @cindex messages, warning
674 @cindex suppressing warnings
676 Errors are diagnostic messages that report that the GNU Fortran compiler
677 cannot compile the relevant piece of source code.  The compiler will
678 continue to process the program in an attempt to report further errors
679 to aid in debugging, but will not produce any compiled output.  
681 Warnings are diagnostic messages that report constructions which
682 are not inherently erroneous but which are risky or suggest there is
683 likely to be a bug in the program.  Unless @option{-Werror} is specified,
684 they do not prevent compilation of the program.
686 You can request many specific warnings with options beginning @option{-W},
687 for example @option{-Wimplicit} to request warnings on implicit
688 declarations.  Each of these specific warning options also has a
689 negative form beginning @option{-Wno-} to turn off warnings;
690 for example, @option{-Wno-implicit}.  This manual lists only one of the
691 two forms, whichever is not the default.
693 These options control the amount and kinds of errors and warnings produced
694 by GNU Fortran:
696 @table @gcctabopt
697 @item -fmax-errors=@var{n}
698 @opindex @code{fmax-errors=}@var{n}
699 @cindex errors, limiting
700 Limits the maximum number of error messages to @var{n}, at which point
701 GNU Fortran bails out rather than attempting to continue processing the
702 source code.  If @var{n} is 0, there is no limit on the number of error
703 messages produced.
705 @item -fsyntax-only
706 @opindex @code{fsyntax-only}
707 @cindex syntax checking
708 Check the code for syntax errors, but do not actually compile it.  This
709 will generate module files for each module present in the code, but no
710 other output file.
712 @item -pedantic
713 @opindex @code{pedantic}
714 Issue warnings for uses of extensions to Fortran 95.
715 @option{-pedantic} also applies to C-language constructs where they
716 occur in GNU Fortran source files, such as use of @samp{\e} in a
717 character constant within a directive like @code{#include}.
719 Valid Fortran 95 programs should compile properly with or without
720 this option.
721 However, without this option, certain GNU extensions and traditional
722 Fortran features are supported as well.
723 With this option, many of them are rejected.
725 Some users try to use @option{-pedantic} to check programs for conformance.
726 They soon find that it does not do quite what they want---it finds some
727 nonstandard practices, but not all.
728 However, improvements to GNU Fortran in this area are welcome.
730 This should be used in conjunction with @option{-std=f95},
731 @option{-std=f2003} or @option{-std=f2008}.
733 @item -pedantic-errors
734 @opindex @code{pedantic-errors}
735 Like @option{-pedantic}, except that errors are produced rather than
736 warnings.
738 @item -Wall
739 @opindex @code{Wall}
740 @cindex all warnings
741 @cindex warnings, all
742 Enables commonly used warning options pertaining to usage that
743 we recommend avoiding and that we believe are easy to avoid.
744 This currently includes @option{-Waliasing}, @option{-Wampersand},
745 @option{-Wconversion}, @option{-Wsurprising}, @option{-Wc-binding-type},
746 @option{-Wintrinsics-std}, @option{-Wtabs}, @option{-Wintrinsic-shadow},
747 @option{-Wline-truncation}, @option{-Wtarget-lifetime},
748 @option{-Winteger-division}, @option{-Wreal-q-constant} and @option{-Wunused}.
750 @item -Waliasing
751 @opindex @code{Waliasing}
752 @cindex aliasing
753 @cindex warnings, aliasing
754 Warn about possible aliasing of dummy arguments. Specifically, it warns
755 if the same actual argument is associated with a dummy argument with
756 @code{INTENT(IN)} and a dummy argument with @code{INTENT(OUT)} in a call
757 with an explicit interface.
759 The following example will trigger the warning.
760 @smallexample
761   interface
762     subroutine bar(a,b)
763       integer, intent(in) :: a
764       integer, intent(out) :: b
765     end subroutine
766   end interface
767   integer :: a
769   call bar(a,a)
770 @end smallexample
772 @item -Wampersand
773 @opindex @code{Wampersand}
774 @cindex warnings, ampersand
775 @cindex @code{&}
776 Warn about missing ampersand in continued character constants. The warning is
777 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95},
778 @option{-std=f2003} and @option{-std=f2008}. Note: With no ampersand
779 given in a continued character constant, GNU Fortran assumes continuation
780 at the first non-comment, non-whitespace character after the ampersand
781 that initiated the continuation.
783 @item -Warray-temporaries
784 @opindex @code{Warray-temporaries}
785 @cindex warnings, array temporaries
786 Warn about array temporaries generated by the compiler.  The information
787 generated by this warning is sometimes useful in optimization, in order to
788 avoid such temporaries.
790 @item -Wc-binding-type
791 @opindex @code{Wc-binding-type}
792 @cindex warning, C binding type
793 Warn if the a variable might not be C interoperable.  In particular, warn if 
794 the variable has been declared using an intrinsic type with default kind
795 instead of using a kind parameter defined for C interoperability in the
796 intrinsic @code{ISO_C_Binding} module.  This option is implied by
797 @option{-Wall}.
799 @item -Wcharacter-truncation
800 @opindex @code{Wcharacter-truncation}
801 @cindex warnings, character truncation
802 Warn when a character assignment will truncate the assigned string.
804 @item -Wline-truncation
805 @opindex @code{Wline-truncation}
806 @cindex warnings, line truncation
807 Warn when a source code line will be truncated.  This option is
808 implied by @option{-Wall}.  For free-form source code, the default is
809 @option{-Werror=line-truncation} such that truncations are reported as
810 error.
812 @item -Wconversion
813 @opindex @code{Wconversion}
814 @cindex warnings, conversion
815 @cindex conversion
816 Warn about implicit conversions that are likely to change the value of 
817 the expression after conversion. Implied by @option{-Wall}.
819 @item -Wconversion-extra
820 @opindex @code{Wconversion-extra}
821 @cindex warnings, conversion
822 @cindex conversion
823 Warn about implicit conversions between different types and kinds. This
824 option does @emph{not} imply @option{-Wconversion}.
826 @item -Wextra
827 @opindex @code{Wextra}
828 @cindex extra warnings
829 @cindex warnings, extra
830 Enables some warning options for usages of language features which
831 may be problematic. This currently includes @option{-Wcompare-reals}
832 and @option{-Wunused-parameter}.
834 @item -Wimplicit-interface
835 @opindex @code{Wimplicit-interface}
836 @cindex warnings, implicit interface
837 Warn if a procedure is called without an explicit interface.
838 Note this only checks that an explicit interface is present.  It does not
839 check that the declared interfaces are consistent across program units.
841 @item -Wimplicit-procedure
842 @opindex @code{Wimplicit-procedure}
843 @cindex warnings, implicit procedure
844 Warn if a procedure is called that has neither an explicit interface
845 nor has been declared as @code{EXTERNAL}.
847 @item -Winteger-division
848 @opindex @code{Winteger-division}
849 @cindex warnings, integer division
850 @cindex warnings, division of integers
851 Warn if a constant integer division truncates it result.
852 As an example, 3/5 evaluates to 0.
854 @item -Wintrinsics-std
855 @opindex @code{Wintrinsics-std}
856 @cindex warnings, non-standard intrinsics
857 @cindex warnings, intrinsics of other standards
858 Warn if @command{gfortran} finds a procedure named like an intrinsic not
859 available in the currently selected standard (with @option{-std}) and treats
860 it as @code{EXTERNAL} procedure because of this.  @option{-fall-intrinsics} can
861 be used to never trigger this behavior and always link to the intrinsic
862 regardless of the selected standard.
864 @item -Wreal-q-constant
865 @opindex @code{Wreal-q-constant}
866 @cindex warnings, @code{q} exponent-letter
867 Produce a warning if a real-literal-constant contains a @code{q}
868 exponent-letter.
870 @item -Wsurprising
871 @opindex @code{Wsurprising}
872 @cindex warnings, suspicious code
873 Produce a warning when ``suspicious'' code constructs are encountered.
874 While technically legal these usually indicate that an error has been made.
876 This currently produces a warning under the following circumstances:
878 @itemize @bullet
879 @item
880 An INTEGER SELECT construct has a CASE that can never be matched as its
881 lower value is greater than its upper value.
883 @item
884 A LOGICAL SELECT construct has three CASE statements.
886 @item
887 A TRANSFER specifies a source that is shorter than the destination.
889 @item
890 The type of a function result is declared more than once with the same type.  If
891 @option{-pedantic} or standard-conforming mode is enabled, this is an error.
893 @item
894 A @code{CHARACTER} variable is declared with negative length.
895 @end itemize
897 @item -Wtabs
898 @opindex @code{Wtabs}
899 @cindex warnings, tabs
900 @cindex tabulators
901 By default, tabs are accepted as whitespace, but tabs are not members
902 of the Fortran Character Set.  For continuation lines, a tab followed
903 by a digit between 1 and 9 is supported.  @option{-Wtabs} will cause
904 a warning to be issued if a tab is encountered. Note, @option{-Wtabs}
905 is active for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003},
906 @option{-std=f2008}, @option{-std=f2008ts} and @option{-Wall}.
908 @item -Wunderflow
909 @opindex @code{Wunderflow}
910 @cindex warnings, underflow
911 @cindex underflow
912 Produce a warning when numerical constant expressions are
913 encountered, which yield an UNDERFLOW during compilation. Enabled by default.
915 @item -Wintrinsic-shadow
916 @opindex @code{Wintrinsic-shadow}
917 @cindex warnings, intrinsic
918 @cindex intrinsic
919 Warn if a user-defined procedure or module procedure has the same name as an
920 intrinsic; in this case, an explicit interface or @code{EXTERNAL} or
921 @code{INTRINSIC} declaration might be needed to get calls later resolved to
922 the desired intrinsic/procedure.  This option is implied by @option{-Wall}.
924 @item -Wuse-without-only
925 @opindex @code{Wuse-without-only}
926 @cindex warnings, use statements
927 @cindex intrinsic
928 Warn if a @code{USE} statement has no @code{ONLY} qualifier and 
929 thus implicitly imports all public entities of the used module.
931 @item -Wunused-dummy-argument
932 @opindex @code{Wunused-dummy-argument}
933 @cindex warnings, unused dummy argument
934 @cindex unused dummy argument
935 @cindex dummy argument, unused
936 Warn about unused dummy arguments. This option is implied by @option{-Wall}.
938 @item -Wunused-parameter
939 @opindex @code{Wunused-parameter}
940 @cindex warnings, unused parameter
941 @cindex unused parameter
942 Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
943 @command{gfortran}'s implementation of this option does not warn
944 about unused dummy arguments (see @option{-Wunused-dummy-argument}),
945 but about unused @code{PARAMETER} values. @option{-Wunused-parameter}
946 is implied by @option{-Wextra} if also @option{-Wunused} or
947 @option{-Wall} is used.
949 @item -Walign-commons
950 @opindex @code{Walign-commons}
951 @cindex warnings, alignment of @code{COMMON} blocks
952 @cindex alignment of @code{COMMON} blocks
953 By default, @command{gfortran} warns about any occasion of variables being
954 padded for proper alignment inside a @code{COMMON} block. This warning can be turned
955 off via @option{-Wno-align-commons}. See also @option{-falign-commons}.
957 @item -Wfunction-elimination
958 @opindex @code{Wfunction-elimination}
959 @cindex function elimination
960 @cindex warnings, function elimination
961 Warn if any calls to functions are eliminated by the optimizations
962 enabled by the @option{-ffrontend-optimize} option.
964 @item -Wrealloc-lhs
965 @opindex @code{Wrealloc-lhs}
966 @cindex Reallocate the LHS in assignments, notification
967 Warn when the compiler might insert code to for allocation or reallocation of
968 an allocatable array variable of intrinsic type in intrinsic assignments.  In
969 hot loops, the Fortran 2003 reallocation feature may reduce the performance.
970 If the array is already allocated with the correct shape, consider using a
971 whole-array array-spec (e.g. @code{(:,:,:)}) for the variable on the left-hand
972 side to prevent the reallocation check. Note that in some cases the warning
973 is shown, even if the compiler will optimize reallocation checks away.  For
974 instance, when the right-hand side contains the same variable multiplied by
975 a scalar.  See also @option{-frealloc-lhs}.
977 @item -Wrealloc-lhs-all
978 @opindex @code{Wrealloc-lhs-all}
979 Warn when the compiler inserts code to for allocation or reallocation of an
980 allocatable variable; this includes scalars and derived types.
982 @item -Wcompare-reals
983 @opindex @code{Wcompare-reals}
984 Warn when comparing real or complex types for equality or inequality.
985 This option is implied by @option{-Wextra}.
987 @item -Wtarget-lifetime
988 @opindex @code{Wtargt-lifetime}
989 Warn if the pointer in a pointer assignment might be longer than the its
990 target. This option is implied by @option{-Wall}.
992 @item -Wzerotrip
993 @opindex @code{Wzerotrip}
994 Warn if a @code{DO} loop is known to execute zero times at compile
995 time.  This option is implied by @option{-Wall}.
997 @item -Werror
998 @opindex @code{Werror}
999 @cindex warnings, to errors
1000 Turns all warnings into errors.
1001 @end table
1003 @xref{Warning Options,,Options to Request or Suppress Errors and
1004 Warnings, gcc,Using the GNU Compiler Collection (GCC)}, for information on
1005 more options offered by the GBE shared by @command{gfortran}, @command{gcc}
1006 and other GNU compilers.
1008 Some of these have no effect when compiling programs written in Fortran.
1010 @node Debugging Options
1011 @section Options for debugging your program or GNU Fortran
1012 @cindex options, debugging
1013 @cindex debugging information options
1015 GNU Fortran has various special options that are used for debugging
1016 either your program or the GNU Fortran compiler.
1018 @table @gcctabopt
1019 @item -fdump-fortran-original
1020 @opindex @code{fdump-fortran-original}
1021 Output the internal parse tree after translating the source program
1022 into internal representation.  Only really useful for debugging the
1023 GNU Fortran compiler itself.
1025 @item -fdump-fortran-optimized
1026 @opindex @code{fdump-fortran-optimized}
1027 Output the parse tree after front-end optimization.  Only really
1028 useful for debugging the GNU Fortran compiler itself.
1030 @item -fdump-parse-tree
1031 @opindex @code{fdump-parse-tree}
1032 Output the internal parse tree after translating the source program
1033 into internal representation.  Only really useful for debugging the
1034 GNU Fortran compiler itself.  This option is deprecated; use
1035 @code{-fdump-fortran-original} instead.
1037 @item -ffpe-trap=@var{list}
1038 @opindex @code{ffpe-trap=}@var{list}
1039 Specify a list of floating point exception traps to enable.  On most
1040 systems, if a floating point exception occurs and the trap for that
1041 exception is enabled, a SIGFPE signal will be sent and the program
1042 being aborted, producing a core file useful for debugging.  @var{list}
1043 is a (possibly empty) comma-separated list of the following
1044 exceptions: @samp{invalid} (invalid floating point operation, such as
1045 @code{SQRT(-1.0)}), @samp{zero} (division by zero), @samp{overflow}
1046 (overflow in a floating point operation), @samp{underflow} (underflow
1047 in a floating point operation), @samp{inexact} (loss of precision
1048 during operation), and @samp{denormal} (operation performed on a
1049 denormal value).  The first five exceptions correspond to the five
1050 IEEE 754 exceptions, whereas the last one (@samp{denormal}) is not
1051 part of the IEEE 754 standard but is available on some common
1052 architectures such as x86.
1054 The first three exceptions (@samp{invalid}, @samp{zero}, and
1055 @samp{overflow}) often indicate serious errors, and unless the program
1056 has provisions for dealing with these exceptions, enabling traps for
1057 these three exceptions is probably a good idea.
1059 Many, if not most, floating point operations incur loss of precision
1060 due to rounding, and hence the @code{ffpe-trap=inexact} is likely to
1061 be uninteresting in practice.
1063 By default no exception traps are enabled.
1065 @item -ffpe-summary=@var{list}
1066 @opindex @code{ffpe-summary=}@var{list}
1067 Specify a list of floating-point exceptions, whose flag status is printed
1068 to @code{ERROR_UNIT} when invoking @code{STOP} and @code{ERROR STOP}.
1069 @var{list} can be either @samp{none}, @samp{all} or a comma-separated list
1070 of the following exceptions: @samp{invalid}, @samp{zero}, @samp{overflow},
1071 @samp{underflow}, @samp{inexact} and @samp{denormal}. (See
1072 @option{-ffpe-trap} for a description of the exceptions.)
1074 By default, a summary for all exceptions but @samp{inexact} is shown.
1076 @item -fno-backtrace
1077 @opindex @code{fno-backtrace}
1078 @cindex backtrace
1079 @cindex trace
1080 When a serious runtime error is encountered or a deadly signal is
1081 emitted (segmentation fault, illegal instruction, bus error,
1082 floating-point exception, and the other POSIX signals that have the
1083 action @samp{core}), the Fortran runtime library tries to output a
1084 backtrace of the error. @code{-fno-backtrace} disables the backtrace
1085 generation. This option only has influence for compilation of the
1086 Fortran main program.
1088 @end table
1090 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
1091 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
1092 debugging options.
1094 @node Directory Options
1095 @section Options for directory search
1096 @cindex directory, options
1097 @cindex options, directory search
1098 @cindex search path
1099 @cindex @code{INCLUDE} directive
1100 @cindex directive, @code{INCLUDE}
1101 These options affect how GNU Fortran searches
1102 for files specified by the @code{INCLUDE} directive and where it searches
1103 for previously compiled modules.
1105 It also affects the search paths used by @command{cpp} when used to preprocess
1106 Fortran source.
1108 @table @gcctabopt
1109 @item -I@var{dir}
1110 @opindex @code{I}@var{dir}
1111 @cindex directory, search paths for inclusion
1112 @cindex inclusion, directory search paths for
1113 @cindex search paths, for included files
1114 @cindex paths, search
1115 @cindex module search path
1116 These affect interpretation of the @code{INCLUDE} directive
1117 (as well as of the @code{#include} directive of the @command{cpp}
1118 preprocessor).
1120 Also note that the general behavior of @option{-I} and
1121 @code{INCLUDE} is pretty much the same as of @option{-I} with
1122 @code{#include} in the @command{cpp} preprocessor, with regard to
1123 looking for @file{header.gcc} files and other such things.
1125 This path is also used to search for @file{.mod} files when previously
1126 compiled modules are required by a @code{USE} statement.
1128 @xref{Directory Options,,Options for Directory Search,
1129 gcc,Using the GNU Compiler Collection (GCC)}, for information on the
1130 @option{-I} option.
1132 @item -J@var{dir}
1133 @opindex @code{J}@var{dir}
1134 @opindex @code{M}@var{dir}
1135 @cindex paths, search
1136 @cindex module search path
1137 This option specifies where to put @file{.mod} files for compiled modules.
1138 It is also added to the list of directories to searched by an @code{USE}
1139 statement.
1141 The default is the current directory.
1143 @item -fintrinsic-modules-path @var{dir}
1144 @opindex @code{fintrinsic-modules-path} @var{dir}
1145 @cindex paths, search
1146 @cindex module search path
1147 This option specifies the location of pre-compiled intrinsic modules, if
1148 they are not in the default location expected by the compiler.
1149 @end table
1151 @node Link Options
1152 @section Influencing the linking step
1153 @cindex options, linking
1154 @cindex linking, static
1156 These options come into play when the compiler links object files into an 
1157 executable output file. They are meaningless if the compiler is not doing 
1158 a link step.
1160 @table @gcctabopt
1161 @item -static-libgfortran
1162 @opindex @code{static-libgfortran}
1163 On systems that provide @file{libgfortran} as a shared and a static
1164 library, this option forces the use of the static version. If no
1165 shared version of @file{libgfortran} was built when the compiler was
1166 configured, this option has no effect.
1167 @end table
1170 @node Runtime Options
1171 @section Influencing runtime behavior
1172 @cindex options, runtime
1174 These options affect the runtime behavior of programs compiled with GNU Fortran.
1176 @table @gcctabopt
1177 @item -fconvert=@var{conversion}
1178 @opindex @code{fconvert=}@var{conversion}
1179 Specify the representation of data for unformatted files.  Valid
1180 values for conversion are: @samp{native}, the default; @samp{swap},
1181 swap between big- and little-endian; @samp{big-endian}, use big-endian
1182 representation for unformatted files; @samp{little-endian}, use little-endian
1183 representation for unformatted files.
1185 @emph{This option has an effect only when used in the main program.
1186 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
1187 variable override the default specified by @option{-fconvert}.}
1189 @item -frecord-marker=@var{length}
1190 @opindex @code{frecord-marker=}@var{length}
1191 Specify the length of record markers for unformatted files.
1192 Valid values for @var{length} are 4 and 8.  Default is 4.
1193 @emph{This is different from previous versions of @command{gfortran}},
1194 which specified a default record marker length of 8 on most
1195 systems.  If you want to read or write files compatible
1196 with earlier versions of @command{gfortran}, use @option{-frecord-marker=8}.
1198 @item -fmax-subrecord-length=@var{length}
1199 @opindex @code{fmax-subrecord-length=}@var{length}
1200 Specify the maximum length for a subrecord.  The maximum permitted
1201 value for length is 2147483639, which is also the default.  Only
1202 really useful for use by the gfortran testsuite.
1204 @item -fsign-zero
1205 @opindex @code{fsign-zero}
1206 When enabled, floating point numbers of value zero with the sign bit set
1207 are written as negative number in formatted output and treated as
1208 negative in the @code{SIGN} intrinsic.  @option{-fno-sign-zero} does not
1209 print the negative sign of zero values (or values rounded to zero for I/O)
1210 and regards zero as positive number in the @code{SIGN} intrinsic for
1211 compatibility with Fortran 77. The default is @option{-fsign-zero}.
1212 @end table
1214 @node Code Gen Options
1215 @section Options for code generation conventions
1216 @cindex code generation, conventions
1217 @cindex options, code generation
1218 @cindex options, run-time
1220 These machine-independent options control the interface conventions
1221 used in code generation.
1223 Most of them have both positive and negative forms; the negative form
1224 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
1225 one of the forms is listed---the one which is not the default.  You
1226 can figure out the other form by either removing @option{no-} or adding
1229 @table @gcctabopt
1230 @item -fno-automatic
1231 @opindex @code{fno-automatic}
1232 @cindex @code{SAVE} statement
1233 @cindex statement, @code{SAVE}
1234 Treat each program unit (except those marked as RECURSIVE) as if the
1235 @code{SAVE} statement were specified for every local variable and array
1236 referenced in it. Does not affect common blocks. (Some Fortran compilers
1237 provide this option under the name @option{-static} or @option{-save}.)
1238 The default, which is @option{-fautomatic}, uses the stack for local
1239 variables smaller than the value given by @option{-fmax-stack-var-size}.
1240 Use the option @option{-frecursive} to use no static memory. 
1242 @item -ff2c
1243 @opindex ff2c
1244 @cindex calling convention
1245 @cindex @command{f2c} calling convention
1246 @cindex @command{g77} calling convention
1247 @cindex libf2c calling convention
1248 Generate code designed to be compatible with code generated
1249 by @command{g77} and @command{f2c}.
1251 The calling conventions used by @command{g77} (originally implemented
1252 in @command{f2c}) require functions that return type
1253 default @code{REAL} to actually return the C type @code{double}, and
1254 functions that return type @code{COMPLEX} to return the values via an
1255 extra argument in the calling sequence that points to where to
1256 store the return value.  Under the default GNU calling conventions, such
1257 functions simply return their results as they would in GNU
1258 C---default @code{REAL} functions return the C type @code{float}, and
1259 @code{COMPLEX} functions return the GNU C type @code{complex}.
1260 Additionally, this option implies the @option{-fsecond-underscore}
1261 option, unless @option{-fno-second-underscore} is explicitly requested.
1263 This does not affect the generation of code that interfaces with
1264 the @command{libgfortran} library.
1266 @emph{Caution:} It is not a good idea to mix Fortran code compiled with
1267 @option{-ff2c} with code compiled with the default @option{-fno-f2c}
1268 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
1269 functions between program parts which were compiled with different
1270 calling conventions will break at execution time.
1272 @emph{Caution:} This will break code which passes intrinsic functions
1273 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
1274 the library implementations use the @option{-fno-f2c} calling conventions.
1276 @item -fno-underscoring
1277 @opindex @code{fno-underscoring}
1278 @cindex underscore
1279 @cindex symbol names, underscores
1280 @cindex transforming symbol names
1281 @cindex symbol names, transforming
1282 Do not transform names of entities specified in the Fortran
1283 source file by appending underscores to them.
1285 With @option{-funderscoring} in effect, GNU Fortran appends one
1286 underscore to external names with no underscores.  This is done to ensure
1287 compatibility with code produced by many UNIX Fortran compilers.
1289 @emph{Caution}: The default behavior of GNU Fortran is
1290 incompatible with @command{f2c} and @command{g77}, please use the
1291 @option{-ff2c} option if you want object files compiled with
1292 GNU Fortran to be compatible with object code created with these
1293 tools.
1295 Use of @option{-fno-underscoring} is not recommended unless you are
1296 experimenting with issues such as integration of GNU Fortran into
1297 existing system environments (vis-@`{a}-vis existing libraries, tools,
1298 and so on).
1300 For example, with @option{-funderscoring}, and assuming that @code{j()} and
1301 @code{max_count()} are external functions while @code{my_var} and
1302 @code{lvar} are local variables, a statement like
1303 @smallexample
1304 I = J() + MAX_COUNT (MY_VAR, LVAR)
1305 @end smallexample
1306 @noindent
1307 is implemented as something akin to:
1308 @smallexample
1309 i = j_() + max_count__(&my_var__, &lvar);
1310 @end smallexample
1312 With @option{-fno-underscoring}, the same statement is implemented as:
1314 @smallexample
1315 i = j() + max_count(&my_var, &lvar);
1316 @end smallexample
1318 Use of @option{-fno-underscoring} allows direct specification of
1319 user-defined names while debugging and when interfacing GNU Fortran
1320 code with other languages.
1322 Note that just because the names match does @emph{not} mean that the
1323 interface implemented by GNU Fortran for an external name matches the
1324 interface implemented by some other language for that same name.
1325 That is, getting code produced by GNU Fortran to link to code produced
1326 by some other compiler using this or any other method can be only a
1327 small part of the overall solution---getting the code generated by
1328 both compilers to agree on issues other than naming can require
1329 significant effort, and, unlike naming disagreements, linkers normally
1330 cannot detect disagreements in these other areas.
1332 Also, note that with @option{-fno-underscoring}, the lack of appended
1333 underscores introduces the very real possibility that a user-defined
1334 external name will conflict with a name in a system library, which
1335 could make finding unresolved-reference bugs quite difficult in some
1336 cases---they might occur at program run time, and show up only as
1337 buggy behavior at run time.
1339 In future versions of GNU Fortran we hope to improve naming and linking
1340 issues so that debugging always involves using the names as they appear
1341 in the source, even if the names as seen by the linker are mangled to
1342 prevent accidental linking between procedures with incompatible
1343 interfaces.
1345 @item -fsecond-underscore
1346 @opindex @code{fsecond-underscore}
1347 @cindex underscore
1348 @cindex symbol names, underscores
1349 @cindex transforming symbol names
1350 @cindex symbol names, transforming
1351 @cindex @command{f2c} calling convention
1352 @cindex @command{g77} calling convention
1353 @cindex libf2c calling convention
1354 By default, GNU Fortran appends an underscore to external
1355 names.  If this option is used GNU Fortran appends two
1356 underscores to names with underscores and one underscore to external names
1357 with no underscores.  GNU Fortran also appends two underscores to
1358 internal names with underscores to avoid naming collisions with external
1359 names.
1361 This option has no effect if @option{-fno-underscoring} is
1362 in effect.  It is implied by the @option{-ff2c} option.
1364 Otherwise, with this option, an external name such as @code{MAX_COUNT}
1365 is implemented as a reference to the link-time external symbol
1366 @code{max_count__}, instead of @code{max_count_}.  This is required
1367 for compatibility with @command{g77} and @command{f2c}, and is implied
1368 by use of the @option{-ff2c} option.
1370 @item -fcoarray=@var{<keyword>}
1371 @opindex @code{fcoarray}
1372 @cindex coarrays
1374 @table @asis
1375 @item @samp{none}
1376 Disable coarray support; using coarray declarations and image-control
1377 statements will produce a compile-time error. (Default)
1379 @item @samp{single}
1380 Single-image mode, i.e. @code{num_images()} is always one.
1382 @item @samp{lib}
1383 Library-based coarray parallelization; a suitable GNU Fortran coarray
1384 library needs to be linked.
1385 @end table
1388 @item -fcheck=@var{<keyword>}
1389 @opindex @code{fcheck}
1390 @cindex array, bounds checking
1391 @cindex bounds checking
1392 @cindex pointer checking
1393 @cindex memory checking
1394 @cindex range checking
1395 @cindex subscript checking
1396 @cindex checking subscripts
1397 @cindex run-time checking
1398 @cindex checking array temporaries
1400 Enable the generation of run-time checks; the argument shall be
1401 a comma-delimited list of the following keywords.
1403 @table @asis
1404 @item @samp{all}
1405 Enable all run-time test of @option{-fcheck}.
1407 @item @samp{array-temps}
1408 Warns at run time when for passing an actual argument a temporary array
1409 had to be generated. The information generated by this warning is
1410 sometimes useful in optimization, in order to avoid such temporaries.
1412 Note: The warning is only printed once per location.
1414 @item @samp{bounds}
1415 Enable generation of run-time checks for array subscripts
1416 and against the declared minimum and maximum values.  It also
1417 checks array indices for assumed and deferred
1418 shape arrays against the actual allocated bounds and ensures that all string
1419 lengths are equal for character array constructors without an explicit
1420 typespec.
1422 Some checks require that @option{-fcheck=bounds} is set for
1423 the compilation of the main program.
1425 Note: In the future this may also include other forms of checking, e.g.,
1426 checking substring references.
1428 @item @samp{do}
1429 Enable generation of run-time checks for invalid modification of loop
1430 iteration variables.
1432 @item @samp{mem}
1433 Enable generation of run-time checks for memory allocation.
1434 Note: This option does not affect explicit allocations using the
1435 @code{ALLOCATE} statement, which will be always checked.
1437 @item @samp{pointer}
1438 Enable generation of run-time checks for pointers and allocatables.
1440 @item @samp{recursion}
1441 Enable generation of run-time checks for recursively called subroutines and
1442 functions which are not marked as recursive. See also @option{-frecursive}.
1443 Note: This check does not work for OpenMP programs and is disabled if used
1444 together with @option{-frecursive} and @option{-fopenmp}.
1445 @end table
1448 @item -fbounds-check
1449 @opindex @code{fbounds-check}
1450 @c Note: This option is also referred in gcc's manpage
1451 Deprecated alias for @option{-fcheck=bounds}.
1453 @item -fcheck-array-temporaries
1454 @opindex @code{fcheck-array-temporaries}
1455 Deprecated alias for @option{-fcheck=array-temps}.
1457 @item -fmax-array-constructor=@var{n}
1458 @opindex @code{fmax-array-constructor}
1459 This option can be used to increase the upper limit permitted in 
1460 array constructors.  The code below requires this option to expand
1461 the array at compile time.
1463 @smallexample
1464 program test
1465 implicit none
1466 integer j
1467 integer, parameter :: n = 100000
1468 integer, parameter :: i(n) = (/ (2*j, j = 1, n) /)
1469 print '(10(I0,1X))', i
1470 end program test
1471 @end smallexample
1473 @emph{Caution:  This option can lead to long compile times and excessively
1474 large object files.}
1476 The default value for @var{n} is 65535.
1479 @item -fmax-stack-var-size=@var{n}
1480 @opindex @code{fmax-stack-var-size}
1481 This option specifies the size in bytes of the largest array that will be put
1482 on the stack; if the size is exceeded static memory is used (except in
1483 procedures marked as RECURSIVE). Use the option @option{-frecursive} to
1484 allow for recursive procedures which do not have a RECURSIVE attribute or
1485 for parallel programs. Use @option{-fno-automatic} to never use the stack.
1487 This option currently only affects local arrays declared with constant
1488 bounds, and may not apply to all character variables.
1489 Future versions of GNU Fortran may improve this behavior.
1491 The default value for @var{n} is 32768.
1493 @item -fstack-arrays
1494 @opindex @code{fstack-arrays}
1495 Adding this option will make the Fortran compiler put all local arrays,
1496 even those of unknown size onto stack memory.  If your program uses very
1497 large local arrays it is possible that you will have to extend your runtime
1498 limits for stack memory on some operating systems. This flag is enabled
1499 by default at optimization level @option{-Ofast}.
1502 @item -fpack-derived
1503 @opindex @code{fpack-derived}
1504 @cindex structure packing
1505 This option tells GNU Fortran to pack derived type members as closely as
1506 possible.  Code compiled with this option is likely to be incompatible
1507 with code compiled without this option, and may execute slower.
1509 @item -frepack-arrays
1510 @opindex @code{frepack-arrays}
1511 @cindex repacking arrays
1512 In some circumstances GNU Fortran may pass assumed shape array
1513 sections via a descriptor describing a noncontiguous area of memory.
1514 This option adds code to the function prologue to repack the data into
1515 a contiguous block at runtime.
1517 This should result in faster accesses to the array.  However it can introduce
1518 significant overhead to the function call, especially  when the passed data
1519 is noncontiguous.
1521 @item -fshort-enums
1522 @opindex @code{fshort-enums}
1523 This option is provided for interoperability with C code that was
1524 compiled with the @option{-fshort-enums} option.  It will make
1525 GNU Fortran choose the smallest @code{INTEGER} kind a given
1526 enumerator set will fit in, and give all its enumerators this kind.
1528 @item -fexternal-blas
1529 @opindex @code{fexternal-blas}
1530 This option will make @command{gfortran} generate calls to BLAS functions
1531 for some matrix operations like @code{MATMUL}, instead of using our own
1532 algorithms, if the size of the matrices involved is larger than a given
1533 limit (see @option{-fblas-matmul-limit}).  This may be profitable if an
1534 optimized vendor BLAS library is available.  The BLAS library will have
1535 to be specified at link time.
1537 @item -fblas-matmul-limit=@var{n}
1538 @opindex @code{fblas-matmul-limit}
1539 Only significant when @option{-fexternal-blas} is in effect.
1540 Matrix multiplication of matrices with size larger than (or equal to) @var{n}
1541 will be performed by calls to BLAS functions, while others will be
1542 handled by @command{gfortran} internal algorithms. If the matrices
1543 involved are not square, the size comparison is performed using the
1544 geometric mean of the dimensions of the argument and result matrices.
1546 The default value for @var{n} is 30.
1548 @item -finline-matmul-limit=@var{n}
1549 @opindex @code{finline-matmul-limit}
1550 When front-end optimiztion is active, some calls to the @code{MATMUL}
1551 intrinsic function will be inlined.  This may result in code size
1552 increase if the size of the matrix cannot be determined at compile
1553 time, as code for both cases is generated.  Setting
1554 @code{-finline-matmul-limit=0} will disable inlining in all cases.
1555 Setting this option with a value of @var{n} will produce inline code
1556 for matrices with size up to @var{n}. If the matrices involved are not
1557 square, the size comparison is performed using the geometric mean of
1558 the dimensions of the argument and result matrices.
1560 The default value for @var{n} is the value specified for
1561 @code{-fblas-matmul-limit} if this option is specified, or unlimitited
1562 otherwise.
1564 @item -frecursive
1565 @opindex @code{frecursive}
1566 Allow indirect recursion by forcing all local arrays to be allocated
1567 on the stack. This flag cannot be used together with
1568 @option{-fmax-stack-var-size=} or @option{-fno-automatic}.
1570 @item -finit-local-zero
1571 @itemx -finit-integer=@var{n}
1572 @itemx -finit-real=@var{<zero|inf|-inf|nan|snan>}
1573 @itemx -finit-logical=@var{<true|false>}
1574 @itemx -finit-character=@var{n}
1575 @opindex @code{finit-local-zero}
1576 @opindex @code{finit-integer}
1577 @opindex @code{finit-real}
1578 @opindex @code{finit-logical}
1579 @opindex @code{finit-character}
1580 The @option{-finit-local-zero} option instructs the compiler to
1581 initialize local @code{INTEGER}, @code{REAL}, and @code{COMPLEX}
1582 variables to zero, @code{LOGICAL} variables to false, and
1583 @code{CHARACTER} variables to a string of null bytes.  Finer-grained
1584 initialization options are provided by the
1585 @option{-finit-integer=@var{n}},
1586 @option{-finit-real=@var{<zero|inf|-inf|nan|snan>}} (which also initializes
1587 the real and imaginary parts of local @code{COMPLEX} variables),
1588 @option{-finit-logical=@var{<true|false>}}, and
1589 @option{-finit-character=@var{n}} (where @var{n} is an ASCII character
1590 value) options.  These options do not initialize
1591 @itemize @bullet
1592 @item
1593 allocatable arrays
1594 @item
1595 components of derived type variables
1596 @item
1597 variables that appear in an @code{EQUIVALENCE} statement.
1598 @end itemize
1599 (These limitations may be removed in future releases).
1601 Note that the @option{-finit-real=nan} option initializes @code{REAL}
1602 and @code{COMPLEX} variables with a quiet NaN. For a signalling NaN
1603 use @option{-finit-real=snan}; note, however, that compile-time
1604 optimizations may convert them into quiet NaN and that trapping
1605 needs to be enabled (e.g. via @option{-ffpe-trap}).
1607 Finally, note that enabling any of the @option{-finit-*} options will
1608 silence warnings that would have been emitted by @option{-Wuninitialized}
1609 for the affected local variables.
1611 @item -falign-commons
1612 @opindex @code{falign-commons}
1613 @cindex alignment of @code{COMMON} blocks
1614 By default, @command{gfortran} enforces proper alignment of all variables in a
1615 @code{COMMON} block by padding them as needed. On certain platforms this is mandatory,
1616 on others it increases performance. If a @code{COMMON} block is not declared with
1617 consistent data types everywhere, this padding can cause trouble, and
1618 @option{-fno-align-commons} can be used to disable automatic alignment. The
1619 same form of this option should be used for all files that share a @code{COMMON} block.
1620 To avoid potential alignment issues in @code{COMMON} blocks, it is recommended to order
1621 objects from largest to smallest.
1623 @item -fno-protect-parens
1624 @opindex @code{fno-protect-parens}
1625 @cindex re-association of parenthesized expressions
1626 By default the parentheses in expression are honored for all optimization
1627 levels such that the compiler does not do any re-association. Using
1628 @option{-fno-protect-parens} allows the compiler to reorder @code{REAL} and
1629 @code{COMPLEX} expressions to produce faster code. Note that for the re-association
1630 optimization @option{-fno-signed-zeros} and @option{-fno-trapping-math}
1631 need to be in effect. The parentheses protection is enabled by default, unless
1632 @option{-Ofast} is given.
1634 @item -frealloc-lhs
1635 @opindex @code{frealloc-lhs}
1636 @cindex Reallocate the LHS in assignments
1637 An allocatable left-hand side of an intrinsic assignment is automatically
1638 (re)allocated if it is either unallocated or has a different shape. The
1639 option is enabled by default except when @option{-std=f95} is given. See
1640 also @option{-Wrealloc-lhs}.
1642 @item -faggressive-function-elimination
1643 @opindex @code{faggressive-function-elimination}
1644 @cindex Elimination of functions with identical argument lists
1645 Functions with identical argument lists are eliminated within
1646 statements, regardless of whether these functions are marked
1647 @code{PURE} or not. For example, in
1648 @smallexample
1649   a = f(b,c) + f(b,c)
1650 @end smallexample
1651 there will only be a single call to @code{f}.  This option only works
1652 if @option{-ffrontend-optimize} is in effect.
1654 @item -ffrontend-optimize
1655 @opindex @code{frontend-optimize}
1656 @cindex Front-end optimization
1657 This option performs front-end optimization, based on manipulating
1658 parts the Fortran parse tree.  Enabled by default by any @option{-O}
1659 option.  Optimizations enabled by this option include inlining calls
1660 to @code{MATMUL}, elimination of identical function calls within
1661 expressions, removing unnecessary calls to @code{TRIM} in comparisons
1662 and assignments and replacing @code{TRIM(a)} with
1663 @code{a(1:LEN_TRIM(a))}.  It can be deselected by specifying
1664 @option{-fno-frontend-optimize}.
1665 @end table
1667 @xref{Code Gen Options,,Options for Code Generation Conventions,
1668 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
1669 offered by the GBE
1670 shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
1672 @c man end
1674 @node Environment Variables
1675 @section Environment variables affecting @command{gfortran}
1676 @cindex environment variable
1678 @c man begin ENVIRONMENT
1680 The @command{gfortran} compiler currently does not make use of any environment
1681 variables to control its operation above and beyond those
1682 that affect the operation of @command{gcc}.
1684 @xref{Environment Variables,,Environment Variables Affecting GCC,
1685 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
1686 variables.
1688 @xref{Runtime}, for environment variables that affect the
1689 run-time behavior of programs compiled with GNU Fortran.
1690 @c man end