Daily bump.
[official-gcc.git] / gcc / fortran / invoke.texi
blob9228c78232f8108c8ad83451d23b605120664550
1 @c Copyright (C) 2004-2015 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-2015 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 -fno-fixed-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 -fmax-array-constructor=@var{n} -fmax-stack-var-size=@var{n}
182 -fno-align-commons @gol
183 -fno-automatic -fno-protect-parens -fno-underscoring @gol
184 -fsecond-underscore -fpack-derived -frealloc-lhs -frecursive @gol
185 -frepack-arrays -fshort-enums -fstack-arrays
187 @end table
189 @node Fortran Dialect Options
190 @section Options controlling Fortran dialect
191 @cindex dialect options
192 @cindex language, dialect options
193 @cindex options, dialect
195 The following options control the details of the Fortran dialect
196 accepted by the compiler:
198 @table @gcctabopt
199 @item -ffree-form
200 @itemx -ffixed-form
201 @opindex @code{ffree-form}
202 @opindex @code{fno-fixed-form}
203 @cindex options, Fortran dialect
204 @cindex file format, free
205 @cindex file format, fixed
206 Specify the layout used by the source file.  The free form layout
207 was introduced in Fortran 90.  Fixed form was traditionally used in
208 older Fortran programs.  When neither option is specified, the source
209 form is determined by the file extension.
211 @item -fall-intrinsics
212 @opindex @code{fall-intrinsics}
213 This option causes all intrinsic procedures (including the GNU-specific
214 extensions) to be accepted.  This can be useful with @option{-std=f95} to
215 force standard-compliance but get access to the full range of intrinsics
216 available with @command{gfortran}.  As a consequence, @option{-Wintrinsics-std}
217 will be ignored and no user-defined procedure with the same name as any
218 intrinsic will be called except when it is explicitly declared @code{EXTERNAL}.
220 @item -fd-lines-as-code
221 @itemx -fd-lines-as-comments
222 @opindex @code{fd-lines-as-code}
223 @opindex @code{fd-lines-as-comments}
224 Enable special treatment for lines beginning with @code{d} or @code{D}
225 in fixed form sources.  If the @option{-fd-lines-as-code} option is
226 given they are treated as if the first column contained a blank.  If the
227 @option{-fd-lines-as-comments} option is given, they are treated as
228 comment lines.
230 @item -fdollar-ok
231 @opindex @code{fdollar-ok}
232 @cindex @code{$}
233 @cindex symbol names
234 @cindex character set
235 Allow @samp{$} as a valid non-first character in a symbol name. Symbols 
236 that start with @samp{$} are rejected since it is unclear which rules to
237 apply to implicit typing as different vendors implement different rules.
238 Using @samp{$} in @code{IMPLICIT} statements is also rejected.
240 @item -fbackslash
241 @opindex @code{backslash}
242 @cindex backslash
243 @cindex escape characters
244 Change the interpretation of backslashes in string literals from a single
245 backslash character to ``C-style'' escape characters. The following
246 combinations are expanded @code{\a}, @code{\b}, @code{\f}, @code{\n},
247 @code{\r}, @code{\t}, @code{\v}, @code{\\}, and @code{\0} to the ASCII
248 characters alert, backspace, form feed, newline, carriage return,
249 horizontal tab, vertical tab, backslash, and NUL, respectively.
250 Additionally, @code{\x}@var{nn}, @code{\u}@var{nnnn} and
251 @code{\U}@var{nnnnnnnn} (where each @var{n} is a hexadecimal digit) are
252 translated into the Unicode characters corresponding to the specified code
253 points. All other combinations of a character preceded by \ are
254 unexpanded.
256 @item -fmodule-private
257 @opindex @code{fmodule-private}
258 @cindex module entities
259 @cindex private
260 Set the default accessibility of module entities to @code{PRIVATE}.
261 Use-associated entities will not be accessible unless they are explicitly
262 declared as @code{PUBLIC}.
264 @item -ffixed-line-length-@var{n}
265 @opindex @code{ffixed-line-length-}@var{n}
266 @cindex file format, fixed
267 Set column after which characters are ignored in typical fixed-form
268 lines in the source file, and through which spaces are assumed (as
269 if padded to that length) after the ends of short fixed-form lines.
271 Popular values for @var{n} include 72 (the
272 standard and the default), 80 (card image), and 132 (corresponding
273 to ``extended-source'' options in some popular compilers).
274 @var{n} may also be @samp{none}, meaning that the entire line is meaningful
275 and that continued character constants never have implicit spaces appended
276 to them to fill out the line.
277 @option{-ffixed-line-length-0} means the same thing as
278 @option{-ffixed-line-length-none}.
280 @item -ffree-line-length-@var{n}
281 @opindex @code{ffree-line-length-}@var{n}
282 @cindex file format, free
283 Set column after which characters are ignored in typical free-form
284 lines in the source file. The default value is 132.
285 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
286 @option{-ffree-line-length-0} means the same thing as
287 @option{-ffree-line-length-none}.
289 @item -fmax-identifier-length=@var{n}
290 @opindex @code{fmax-identifier-length=}@var{n}
291 Specify the maximum allowed identifier length. Typical values are
292 31 (Fortran 95) and 63 (Fortran 2003 and Fortran 2008).
294 @item -fimplicit-none
295 @opindex @code{fimplicit-none}
296 Specify that no implicit typing is allowed, unless overridden by explicit
297 @code{IMPLICIT} statements.  This is the equivalent of adding
298 @code{implicit none} to the start of every procedure.
300 @item -fcray-pointer
301 @opindex @code{fcray-pointer}
302 Enable the Cray pointer extension, which provides C-like pointer
303 functionality.
305 @item -fopenacc
306 @opindex @code{fopenacc}
307 @cindex OpenACC
308 Enable the OpenACC extensions.  This includes OpenACC @code{!$acc}
309 directives in free form and @code{c$acc}, @code{*$acc} and
310 @code{!$acc} directives in fixed form, @code{!$} conditional
311 compilation sentinels in free form and @code{c$}, @code{*$} and
312 @code{!$} sentinels in fixed form, and when linking arranges for the
313 OpenACC runtime library to be linked in.
315 Note that this is an experimental feature, incomplete, and subject to
316 change in future versions of GCC.  See
317 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
319 @item -fopenmp
320 @opindex @code{fopenmp}
321 @cindex OpenMP
322 Enable the OpenMP extensions.  This includes OpenMP @code{!$omp} directives
323 in free form
324 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
325 @code{!$} conditional compilation sentinels in free form
326 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form, 
327 and when linking arranges for the OpenMP runtime library to be linked
328 in.  The option @option{-fopenmp} implies @option{-frecursive}.
330 @item -fno-range-check
331 @opindex @code{frange-check}
332 Disable range checking on results of simplification of constant
333 expressions during compilation.  For example, GNU Fortran will give
334 an error at compile time when simplifying @code{a = 1. / 0}.
335 With this option, no error will be given and @code{a} will be assigned
336 the value @code{+Infinity}.  If an expression evaluates to a value
337 outside of the relevant range of [@code{-HUGE()}:@code{HUGE()}],
338 then the expression will be replaced by @code{-Inf} or @code{+Inf}
339 as appropriate.
340 Similarly, @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow
341 on most systems, but with @option{-fno-range-check} the value will
342 ``wrap around'' and @code{i} will be initialized to @math{-1} instead.
344 @item -fdefault-integer-8
345 @opindex @code{fdefault-integer-8}
346 Set the default integer and logical types to an 8 byte wide type.  This option
347 also affects the kind of integer constants like @code{42}. Unlike
348 @option{-finteger-4-integer-8}, it does not promote variables with explicit
349 kind declaration.
351 @item -fdefault-real-8
352 @opindex @code{fdefault-real-8}
353 Set the default real type to an 8 byte wide type. This option also affects
354 the kind of non-double real constants like @code{1.0}, and does promote
355 the default width of @code{DOUBLE PRECISION} to 16 bytes if possible, unless
356 @code{-fdefault-double-8} is given, too. Unlike @option{-freal-4-real-8},
357 it does not promote variables with explicit kind declaration.
359 @item -fdefault-double-8
360 @opindex @code{fdefault-double-8}
361 Set the @code{DOUBLE PRECISION} type to an 8 byte wide type.  Do nothing if this
362 is already the default.  If @option{-fdefault-real-8} is given,
363 @code{DOUBLE PRECISION} would instead be promoted to 16 bytes if possible, and
364 @option{-fdefault-double-8} can be used to prevent this.  The kind of real
365 constants like @code{1.d0} will not be changed by @option{-fdefault-real-8}
366 though, so also @option{-fdefault-double-8} does not affect it.
368 @item -finteger-4-integer-8
369 @opindex @code{finteger-4-integer-8}
370 Promote all @code{INTEGER(KIND=4)} entities to an @code{INTEGER(KIND=8)}
371 entities.  If @code{KIND=8} is unavailable, then an error will be issued.
372 This option should be used with care and may not be suitable for your codes.
373 Areas of possible concern include calls to external procedures,
374 alignment in @code{EQUIVALENCE} and/or @code{COMMON}, generic interfaces,
375 BOZ literal constant conversion, and I/O.  Inspection of the intermediate
376 representation of the translated Fortran code, produced by
377 @option{-fdump-tree-original}, is suggested.
379 @item  -freal-4-real-8
380 @itemx -freal-4-real-10
381 @itemx -freal-4-real-16
382 @itemx -freal-8-real-4
383 @itemx -freal-8-real-10
384 @itemx -freal-8-real-16
385 @opindex @code{freal-4-real-8}
386 @opindex @code{freal-4-real-10}
387 @opindex @code{freal-4-real-16}
388 @opindex @code{freal-8-real-4}
389 @opindex @code{freal-8-real-10}
390 @opindex @code{freal-8-real-16}
391 @cindex options, real kind type promotion
392 Promote all @code{REAL(KIND=M)} entities to @code{REAL(KIND=N)} entities.
393 If @code{REAL(KIND=N)} is unavailable, then an error will be issued.
394 All other real kind types are unaffected by this option.
395 These options should be used with care and may not be suitable for your
396 codes.  Areas of possible concern include calls to external procedures,
397 alignment in @code{EQUIVALENCE} and/or @code{COMMON}, generic interfaces,
398 BOZ literal constant conversion, and I/O.  Inspection of the intermediate
399 representation of the translated Fortran code, produced by
400 @option{-fdump-tree-original}, is suggested.
402 @item -std=@var{std}
403 @opindex @code{std=}@var{std} option
404 Specify the standard to which the program is expected to conform, which
405 may be one of @samp{f95}, @samp{f2003}, @samp{f2008}, @samp{gnu}, or
406 @samp{legacy}.  The default value for @var{std} is @samp{gnu}, which
407 specifies a superset of the Fortran 95 standard that includes all of the
408 extensions supported by GNU Fortran, although warnings will be given for
409 obsolete extensions not recommended for use in new code.  The
410 @samp{legacy} value is equivalent but without the warnings for obsolete
411 extensions, and may be useful for old non-standard programs.  The
412 @samp{f95}, @samp{f2003} and @samp{f2008} values specify strict
413 conformance to the Fortran 95, Fortran 2003 and Fortran 2008 standards,
414 respectively; errors are given for all extensions beyond the relevant
415 language standard, and warnings are given for the Fortran 77 features
416 that are permitted but obsolescent in later standards. @samp{-std=f2008ts}
417 allows the Fortran 2008 standard including the additions of the 
418 Technical Specification (TS) 29113 on Further Interoperability of Fortran
419 with C and TS 18508 on Additional Parallel Features in Fortran.
421 @end table
423 @node Preprocessing Options
424 @section Enable and customize preprocessing
425 @cindex preprocessor
426 @cindex options, preprocessor
427 @cindex CPP
429 Preprocessor related options. See section 
430 @ref{Preprocessing and conditional compilation} for more detailed
431 information on preprocessing in @command{gfortran}.
433 @table @gcctabopt
434 @item -cpp
435 @itemx -nocpp
436 @opindex @code{cpp}
437 @opindex @code{fpp}
438 @cindex preprocessor, enable
439 @cindex preprocessor, disable
440 Enable preprocessing. The preprocessor is automatically invoked if
441 the file extension is @file{.fpp}, @file{.FPP},  @file{.F}, @file{.FOR},
442 @file{.FTN}, @file{.F90}, @file{.F95}, @file{.F03} or @file{.F08}. Use
443 this option to manually enable preprocessing of any kind of Fortran file.
445 To disable preprocessing of files with any of the above listed extensions,
446 use the negative form: @option{-nocpp}.
448 The preprocessor is run in traditional mode. Any restrictions of the
449 file-format, especially the limits on line length, apply for
450 preprocessed output as well, so it might be advisable to use the
451 @option{-ffree-line-length-none} or @option{-ffixed-line-length-none}
452 options.
454 @item -dM
455 @opindex @code{dM}
456 @cindex preprocessor, debugging
457 @cindex debugging, preprocessor
458 Instead of the normal output, generate a list of @code{'#define'}
459 directives for all the macros defined during the execution of the
460 preprocessor, including predefined macros. This gives you a way
461 of finding out what is predefined in your version of the preprocessor.
462 Assuming you have no file @file{foo.f90}, the command
463 @smallexample
464   touch foo.f90; gfortran -cpp -E -dM foo.f90
465 @end smallexample
466 will show all the predefined macros.
468 @item -dD
469 @opindex @code{dD}
470 @cindex preprocessor, debugging
471 @cindex debugging, preprocessor
472 Like @option{-dM} except in two respects: it does not include the
473 predefined macros, and it outputs both the @code{#define} directives
474 and the result of preprocessing. Both kinds of output go to the
475 standard output file.
477 @item -dN
478 @opindex @code{dN}
479 @cindex preprocessor, debugging
480 @cindex debugging, preprocessor
481 Like @option{-dD}, but emit only the macro names, not their expansions.
483 @item -dU
484 @opindex @code{dU}
485 @cindex preprocessor, debugging
486 @cindex debugging, preprocessor
487 Like @option{dD} except that only macros that are expanded, or whose
488 definedness is tested in preprocessor directives, are output; the 
489 output is delayed until the use or test of the macro; and @code{'#undef'}
490 directives are also output for macros tested but undefined at the time.
492 @item -dI
493 @opindex @code{dI}
494 @cindex preprocessor, debugging
495 @cindex debugging, preprocessor
496 Output @code{'#include'} directives in addition to the result
497 of preprocessing.
499 @item -fworking-directory
500 @opindex @code{fworking-directory}
501 @cindex preprocessor, working directory
502 Enable generation of linemarkers in the preprocessor output that will
503 let the compiler know the current working directory at the time of
504 preprocessing. When this option is enabled, the preprocessor will emit,
505 after the initial linemarker, a second linemarker with the current
506 working directory followed by two slashes. GCC will use this directory,
507 when it is present in the preprocessed input, as the directory emitted
508 as the current working directory in some debugging information formats.
509 This option is implicitly enabled if debugging information is enabled,
510 but this can be inhibited with the negated form
511 @option{-fno-working-directory}. If the @option{-P} flag is present
512 in the command line, this option has no effect, since no @code{#line}
513 directives are emitted whatsoever.
515 @item -idirafter @var{dir}
516 @opindex @code{idirafter @var{dir}}
517 @cindex preprocessing, include path
518 Search @var{dir} for include files, but do it after all directories
519 specified with @option{-I} and the standard system directories have
520 been exhausted. @var{dir} is treated as a system include directory.
521 If dir begins with @code{=}, then the @code{=} will be replaced by
522 the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
524 @item -imultilib @var{dir}
525 @opindex @code{imultilib @var{dir}}
526 @cindex preprocessing, include path
527 Use @var{dir} as a subdirectory of the directory containing target-specific
528 C++ headers.
530 @item -iprefix @var{prefix}
531 @opindex @code{iprefix @var{prefix}}
532 @cindex preprocessing, include path
533 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
534 options. If the @var{prefix} represents a directory, you should include
535 the final @code{'/'}.
537 @item -isysroot @var{dir}
538 @opindex @code{isysroot @var{dir}}
539 @cindex preprocessing, include path
540 This option is like the @option{--sysroot} option, but applies only to
541 header files. See the @option{--sysroot} option for more information.
543 @item -iquote @var{dir}
544 @opindex @code{iquote @var{dir}}
545 @cindex preprocessing, include path
546 Search @var{dir} only for header files requested with @code{#include "file"};
547 they are not searched for @code{#include <file>}, before all directories
548 specified by @option{-I} and before the standard system directories. If
549 @var{dir} begins with @code{=}, then the @code{=} will be replaced by the
550 sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
552 @item -isystem @var{dir}
553 @opindex @code{isystem @var{dir}}
554 @cindex preprocessing, include path
555 Search @var{dir} for header files, after all directories specified by
556 @option{-I} but before the standard system directories. Mark it as a
557 system directory, so that it gets the same special treatment as is
558 applied to the standard system directories. If @var{dir} begins with
559 @code{=}, then the @code{=} will be replaced by the sysroot prefix;
560 see @option{--sysroot} and @option{-isysroot}.
562 @item -nostdinc
563 @opindex @code{nostdinc}
564 Do not search the standard system directories for header files. Only
565 the directories you have specified with @option{-I} options (and the
566 directory of the current file, if appropriate) are searched.
568 @item -undef
569 @opindex @code{undef}
570 Do not predefine any system-specific or GCC-specific macros.
571 The standard predefined macros remain defined.
573 @item -A@var{predicate}=@var{answer}
574 @opindex @code{A@var{predicate}=@var{answer}}
575 @cindex preprocessing, assertion
576 Make an assertion with the predicate @var{predicate} and answer @var{answer}.
577 This form is preferred to the older form -A predicate(answer), which is still
578 supported, because it does not use shell special characters.
580 @item -A-@var{predicate}=@var{answer}
581 @opindex @code{A-@var{predicate}=@var{answer}}
582 @cindex preprocessing, assertion
583 Cancel an assertion with the predicate @var{predicate} and answer @var{answer}.
585 @item -C
586 @opindex @code{C}
587 @cindex preprocessing, keep comments
588 Do not discard comments. All comments are passed through to the output
589 file, except for comments in processed directives, which are deleted
590 along with the directive.
592 You should be prepared for side effects when using @option{-C}; it causes
593 the preprocessor to treat comments as tokens in their own right. For example,
594 comments appearing at the start of what would be a directive line have the
595 effect of turning that line into an ordinary source line, since the first
596 token on the line is no longer a @code{'#'}.
598 Warning: this currently handles C-Style comments only. The preprocessor
599 does not yet recognize Fortran-style comments.
601 @item -CC
602 @opindex @code{CC}
603 @cindex preprocessing, keep comments
604 Do not discard comments, including during macro expansion. This is like
605 @option{-C}, except that comments contained within macros are also passed
606 through to the output file where the macro is expanded.
608 In addition to the side-effects of the @option{-C} option, the @option{-CC}
609 option causes all C++-style comments inside a macro to be converted to C-style
610 comments. This is to prevent later use of that macro from inadvertently
611 commenting out the remainder of the source line. The @option{-CC} option
612 is generally used to support lint comments.
614 Warning: this currently handles C- and C++-Style comments only. The
615 preprocessor does not yet recognize Fortran-style comments.
617 @item -D@var{name}
618 @opindex @code{D@var{name}}
619 @cindex preprocessing, define macros
620 Predefine name as a macro, with definition @code{1}.
622 @item -D@var{name}=@var{definition}
623 @opindex @code{D@var{name}=@var{definition}}
624 @cindex preprocessing, define macros
625 The contents of @var{definition} are tokenized and processed as if they
626 appeared during translation phase three in a @code{'#define'} directive.
627 In particular, the definition will be truncated by embedded newline
628 characters.
630 If you are invoking the preprocessor from a shell or shell-like program
631 you may need to use the shell's quoting syntax to protect characters such
632 as spaces that have a meaning in the shell syntax.
634 If you wish to define a function-like macro on the command line, write
635 its argument list with surrounding parentheses before the equals sign
636 (if any). Parentheses are meaningful to most shells, so you will need
637 to quote the option. With sh and csh, @code{-D'name(args...)=definition'}
638 works.
640 @option{-D} and @option{-U} options are processed in the order they are
641 given on the command line. All -imacros file and -include file options
642 are processed after all -D and -U options.
644 @item -H
645 @opindex @code{H}
646 Print the name of each header file used, in addition to other normal
647 activities. Each name is indented to show how deep in the @code{'#include'}
648 stack it is.
650 @item -P
651 @opindex @code{P}
652 @cindex preprocessing, no linemarkers
653 Inhibit generation of linemarkers in the output from the preprocessor.
654 This might be useful when running the preprocessor on something that
655 is not C code, and will be sent to a program which might be confused
656 by the linemarkers.
658 @item -U@var{name}
659 @opindex @code{U@var{name}}
660 @cindex preprocessing, undefine macros
661 Cancel any previous definition of @var{name}, either built in or provided
662 with a @option{-D} option.
663 @end table
666 @node Error and Warning Options
667 @section Options to request or suppress errors and warnings
668 @cindex options, warnings
669 @cindex options, errors
670 @cindex warnings, suppressing
671 @cindex messages, error
672 @cindex messages, warning
673 @cindex suppressing warnings
675 Errors are diagnostic messages that report that the GNU Fortran compiler
676 cannot compile the relevant piece of source code.  The compiler will
677 continue to process the program in an attempt to report further errors
678 to aid in debugging, but will not produce any compiled output.  
680 Warnings are diagnostic messages that report constructions which
681 are not inherently erroneous but which are risky or suggest there is
682 likely to be a bug in the program.  Unless @option{-Werror} is specified,
683 they do not prevent compilation of the program.
685 You can request many specific warnings with options beginning @option{-W},
686 for example @option{-Wimplicit} to request warnings on implicit
687 declarations.  Each of these specific warning options also has a
688 negative form beginning @option{-Wno-} to turn off warnings;
689 for example, @option{-Wno-implicit}.  This manual lists only one of the
690 two forms, whichever is not the default.
692 These options control the amount and kinds of errors and warnings produced
693 by GNU Fortran:
695 @table @gcctabopt
696 @item -fmax-errors=@var{n}
697 @opindex @code{fmax-errors=}@var{n}
698 @cindex errors, limiting
699 Limits the maximum number of error messages to @var{n}, at which point
700 GNU Fortran bails out rather than attempting to continue processing the
701 source code.  If @var{n} is 0, there is no limit on the number of error
702 messages produced.
704 @item -fsyntax-only
705 @opindex @code{fsyntax-only}
706 @cindex syntax checking
707 Check the code for syntax errors, but do not actually compile it.  This
708 will generate module files for each module present in the code, but no
709 other output file.
711 @item -pedantic
712 @opindex @code{pedantic}
713 Issue warnings for uses of extensions to Fortran 95.
714 @option{-pedantic} also applies to C-language constructs where they
715 occur in GNU Fortran source files, such as use of @samp{\e} in a
716 character constant within a directive like @code{#include}.
718 Valid Fortran 95 programs should compile properly with or without
719 this option.
720 However, without this option, certain GNU extensions and traditional
721 Fortran features are supported as well.
722 With this option, many of them are rejected.
724 Some users try to use @option{-pedantic} to check programs for conformance.
725 They soon find that it does not do quite what they want---it finds some
726 nonstandard practices, but not all.
727 However, improvements to GNU Fortran in this area are welcome.
729 This should be used in conjunction with @option{-std=f95},
730 @option{-std=f2003} or @option{-std=f2008}.
732 @item -pedantic-errors
733 @opindex @code{pedantic-errors}
734 Like @option{-pedantic}, except that errors are produced rather than
735 warnings.
737 @item -Wall
738 @opindex @code{Wall}
739 @cindex all warnings
740 @cindex warnings, all
741 Enables commonly used warning options pertaining to usage that
742 we recommend avoiding and that we believe are easy to avoid.
743 This currently includes @option{-Waliasing}, @option{-Wampersand},
744 @option{-Wconversion}, @option{-Wsurprising}, @option{-Wc-binding-type},
745 @option{-Wintrinsics-std}, @option{-Wno-tabs}, @option{-Wintrinsic-shadow},
746 @option{-Wline-truncation}, @option{-Wtarget-lifetime},
747 @option{-Wreal-q-constant} and @option{-Wunused}.
749 @item -Waliasing
750 @opindex @code{Waliasing}
751 @cindex aliasing
752 @cindex warnings, aliasing
753 Warn about possible aliasing of dummy arguments. Specifically, it warns
754 if the same actual argument is associated with a dummy argument with
755 @code{INTENT(IN)} and a dummy argument with @code{INTENT(OUT)} in a call
756 with an explicit interface.
758 The following example will trigger the warning.
759 @smallexample
760   interface
761     subroutine bar(a,b)
762       integer, intent(in) :: a
763       integer, intent(out) :: b
764     end subroutine
765   end interface
766   integer :: a
768   call bar(a,a)
769 @end smallexample
771 @item -Wampersand
772 @opindex @code{Wampersand}
773 @cindex warnings, ampersand
774 @cindex @code{&}
775 Warn about missing ampersand in continued character constants. The warning is
776 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95},
777 @option{-std=f2003} and @option{-std=f2008}. Note: With no ampersand
778 given in a continued character constant, GNU Fortran assumes continuation
779 at the first non-comment, non-whitespace character after the ampersand
780 that initiated the continuation.
782 @item -Warray-temporaries
783 @opindex @code{Warray-temporaries}
784 @cindex warnings, array temporaries
785 Warn about array temporaries generated by the compiler.  The information
786 generated by this warning is sometimes useful in optimization, in order to
787 avoid such temporaries.
789 @item -Wc-binding-type
790 @opindex @code{Wc-binding-type}
791 @cindex warning, C binding type
792 Warn if the a variable might not be C interoperable.  In particular, warn if 
793 the variable has been declared using an intrinsic type with default kind
794 instead of using a kind parameter defined for C interoperability in the
795 intrinsic @code{ISO_C_Binding} module.  This option is implied by
796 @option{-Wall}.
798 @item -Wcharacter-truncation
799 @opindex @code{Wcharacter-truncation}
800 @cindex warnings, character truncation
801 Warn when a character assignment will truncate the assigned string.
803 @item -Wline-truncation
804 @opindex @code{Wline-truncation}
805 @cindex warnings, line truncation
806 Warn when a source code line will be truncated.  This option is
807 implied by @option{-Wall}.  For free-form source code, the default is
808 @option{-Werror=line-truncation} such that truncations are reported as
809 error.
811 @item -Wconversion
812 @opindex @code{Wconversion}
813 @cindex warnings, conversion
814 @cindex conversion
815 Warn about implicit conversions that are likely to change the value of 
816 the expression after conversion. Implied by @option{-Wall}.
818 @item -Wconversion-extra
819 @opindex @code{Wconversion-extra}
820 @cindex warnings, conversion
821 @cindex conversion
822 Warn about implicit conversions between different types and kinds. This
823 option does @emph{not} imply @option{-Wconversion}.
825 @item -Wextra
826 @opindex @code{Wextra}
827 @cindex extra warnings
828 @cindex warnings, extra
829 Enables some warning options for usages of language features which
830 may be problematic. This currently includes @option{-Wcompare-reals}
831 and @option{-Wunused-parameter}.
833 @item -Wimplicit-interface
834 @opindex @code{Wimplicit-interface}
835 @cindex warnings, implicit interface
836 Warn if a procedure is called without an explicit interface.
837 Note this only checks that an explicit interface is present.  It does not
838 check that the declared interfaces are consistent across program units.
840 @item -Wimplicit-procedure
841 @opindex @code{Wimplicit-procedure}
842 @cindex warnings, implicit procedure
843 Warn if a procedure is called that has neither an explicit interface
844 nor has been declared as @code{EXTERNAL}.
846 @item -Wintrinsics-std
847 @opindex @code{Wintrinsics-std}
848 @cindex warnings, non-standard intrinsics
849 @cindex warnings, intrinsics of other standards
850 Warn if @command{gfortran} finds a procedure named like an intrinsic not
851 available in the currently selected standard (with @option{-std}) and treats
852 it as @code{EXTERNAL} procedure because of this.  @option{-fall-intrinsics} can
853 be used to never trigger this behavior and always link to the intrinsic
854 regardless of the selected standard.
856 @item -Wreal-q-constant
857 @opindex @code{Wreal-q-constant}
858 @cindex warnings, @code{q} exponent-letter
859 Produce a warning if a real-literal-constant contains a @code{q}
860 exponent-letter.
862 @item -Wsurprising
863 @opindex @code{Wsurprising}
864 @cindex warnings, suspicious code
865 Produce a warning when ``suspicious'' code constructs are encountered.
866 While technically legal these usually indicate that an error has been made.
868 This currently produces a warning under the following circumstances:
870 @itemize @bullet
871 @item
872 An INTEGER SELECT construct has a CASE that can never be matched as its
873 lower value is greater than its upper value.
875 @item
876 A LOGICAL SELECT construct has three CASE statements.
878 @item
879 A TRANSFER specifies a source that is shorter than the destination.
881 @item
882 The type of a function result is declared more than once with the same type.  If
883 @option{-pedantic} or standard-conforming mode is enabled, this is an error.
885 @item
886 A @code{CHARACTER} variable is declared with negative length.
887 @end itemize
889 @item -Wtabs
890 @opindex @code{Wtabs}
891 @cindex warnings, tabs
892 @cindex tabulators
893 By default, tabs are accepted as whitespace, but tabs are not members
894 of the Fortran Character Set.  For continuation lines, a tab followed
895 by a digit between 1 and 9 is supported.  @option{-Wtabs} will cause
896 a warning to be issued if a tab is encountered. Note, @option{-Wtabs}
897 is active for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003},
898 @option{-std=f2008}, @option{-std=f2008ts} and @option{-Wall}.
900 @item -Wunderflow
901 @opindex @code{Wunderflow}
902 @cindex warnings, underflow
903 @cindex underflow
904 Produce a warning when numerical constant expressions are
905 encountered, which yield an UNDERFLOW during compilation. Enabled by default.
907 @item -Wintrinsic-shadow
908 @opindex @code{Wintrinsic-shadow}
909 @cindex warnings, intrinsic
910 @cindex intrinsic
911 Warn if a user-defined procedure or module procedure has the same name as an
912 intrinsic; in this case, an explicit interface or @code{EXTERNAL} or
913 @code{INTRINSIC} declaration might be needed to get calls later resolved to
914 the desired intrinsic/procedure.  This option is implied by @option{-Wall}.
916 @item -Wuse-without-only
917 @opindex @code{Wuse-without-only}
918 @cindex warnings, use statements
919 @cindex intrinsic
920 Warn if a @code{USE} statement has no @code{ONLY} qualifier and 
921 thus implicitly imports all public entities of the used module.
923 @item -Wunused-dummy-argument
924 @opindex @code{Wunused-dummy-argument}
925 @cindex warnings, unused dummy argument
926 @cindex unused dummy argument
927 @cindex dummy argument, unused
928 Warn about unused dummy arguments. This option is implied by @option{-Wall}.
930 @item -Wunused-parameter
931 @opindex @code{Wunused-parameter}
932 @cindex warnings, unused parameter
933 @cindex unused parameter
934 Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
935 @command{gfortran}'s implementation of this option does not warn
936 about unused dummy arguments (see @option{-Wunused-dummy-argument}),
937 but about unused @code{PARAMETER} values. @option{-Wunused-parameter}
938 is implied by @option{-Wextra} if also @option{-Wunused} or
939 @option{-Wall} is used.
941 @item -Walign-commons
942 @opindex @code{Walign-commons}
943 @cindex warnings, alignment of @code{COMMON} blocks
944 @cindex alignment of @code{COMMON} blocks
945 By default, @command{gfortran} warns about any occasion of variables being
946 padded for proper alignment inside a @code{COMMON} block. This warning can be turned
947 off via @option{-Wno-align-commons}. See also @option{-falign-commons}.
949 @item -Wfunction-elimination
950 @opindex @code{Wfunction-elimination}
951 @cindex function elimination
952 @cindex warnings, function elimination
953 Warn if any calls to functions are eliminated by the optimizations
954 enabled by the @option{-ffrontend-optimize} option.
956 @item -Wrealloc-lhs
957 @opindex @code{Wrealloc-lhs}
958 @cindex Reallocate the LHS in assignments, notification
959 Warn when the compiler might insert code to for allocation or reallocation of
960 an allocatable array variable of intrinsic type in intrinsic assignments.  In
961 hot loops, the Fortran 2003 reallocation feature may reduce the performance.
962 If the array is already allocated with the correct shape, consider using a
963 whole-array array-spec (e.g. @code{(:,:,:)}) for the variable on the left-hand
964 side to prevent the reallocation check. Note that in some cases the warning
965 is shown, even if the compiler will optimize reallocation checks away.  For
966 instance, when the right-hand side contains the same variable multiplied by
967 a scalar.  See also @option{-frealloc-lhs}.
969 @item -Wrealloc-lhs-all
970 @opindex @code{Wrealloc-lhs-all}
971 Warn when the compiler inserts code to for allocation or reallocation of an
972 allocatable variable; this includes scalars and derived types.
974 @item -Wcompare-reals
975 @opindex @code{Wcompare-reals}
976 Warn when comparing real or complex types for equality or inequality.
977 This option is implied by @option{-Wextra}.
979 @item -Wtarget-lifetime
980 @opindex @code{Wtargt-lifetime}
981 Warn if the pointer in a pointer assignment might be longer than the its
982 target. This option is implied by @option{-Wall}.
984 @item -Wzerotrip
985 @opindex @code{Wzerotrip}
986 Warn if a @code{DO} loop is known to execute zero times at compile
987 time.  This option is implied by @option{-Wall}.
989 @item -Werror
990 @opindex @code{Werror}
991 @cindex warnings, to errors
992 Turns all warnings into errors.
993 @end table
995 @xref{Warning Options,,Options to Request or Suppress Errors and
996 Warnings, gcc,Using the GNU Compiler Collection (GCC)}, for information on
997 more options offered by the GBE shared by @command{gfortran}, @command{gcc}
998 and other GNU compilers.
1000 Some of these have no effect when compiling programs written in Fortran.
1002 @node Debugging Options
1003 @section Options for debugging your program or GNU Fortran
1004 @cindex options, debugging
1005 @cindex debugging information options
1007 GNU Fortran has various special options that are used for debugging
1008 either your program or the GNU Fortran compiler.
1010 @table @gcctabopt
1011 @item -fdump-fortran-original
1012 @opindex @code{fdump-fortran-original}
1013 Output the internal parse tree after translating the source program
1014 into internal representation.  Only really useful for debugging the
1015 GNU Fortran compiler itself.
1017 @item -fdump-fortran-optimized
1018 @opindex @code{fdump-fortran-optimized}
1019 Output the parse tree after front-end optimization.  Only really
1020 useful for debugging the GNU Fortran compiler itself.
1022 @item -fdump-parse-tree
1023 @opindex @code{fdump-parse-tree}
1024 Output the internal parse tree after translating the source program
1025 into internal representation.  Only really useful for debugging the
1026 GNU Fortran compiler itself.  This option is deprecated; use
1027 @code{-fdump-fortran-original} instead.
1029 @item -ffpe-trap=@var{list}
1030 @opindex @code{ffpe-trap=}@var{list}
1031 Specify a list of floating point exception traps to enable.  On most
1032 systems, if a floating point exception occurs and the trap for that
1033 exception is enabled, a SIGFPE signal will be sent and the program
1034 being aborted, producing a core file useful for debugging.  @var{list}
1035 is a (possibly empty) comma-separated list of the following
1036 exceptions: @samp{invalid} (invalid floating point operation, such as
1037 @code{SQRT(-1.0)}), @samp{zero} (division by zero), @samp{overflow}
1038 (overflow in a floating point operation), @samp{underflow} (underflow
1039 in a floating point operation), @samp{inexact} (loss of precision
1040 during operation), and @samp{denormal} (operation performed on a
1041 denormal value).  The first five exceptions correspond to the five
1042 IEEE 754 exceptions, whereas the last one (@samp{denormal}) is not
1043 part of the IEEE 754 standard but is available on some common
1044 architectures such as x86.
1046 The first three exceptions (@samp{invalid}, @samp{zero}, and
1047 @samp{overflow}) often indicate serious errors, and unless the program
1048 has provisions for dealing with these exceptions, enabling traps for
1049 these three exceptions is probably a good idea.
1051 Many, if not most, floating point operations incur loss of precision
1052 due to rounding, and hence the @code{ffpe-trap=inexact} is likely to
1053 be uninteresting in practice.
1055 By default no exception traps are enabled.
1057 @item -ffpe-summary=@var{list}
1058 @opindex @code{ffpe-summary=}@var{list}
1059 Specify a list of floating-point exceptions, whose flag status is printed
1060 to @code{ERROR_UNIT} when invoking @code{STOP} and @code{ERROR STOP}.
1061 @var{list} can be either @samp{none}, @samp{all} or a comma-separated list
1062 of the following exceptions: @samp{invalid}, @samp{zero}, @samp{overflow},
1063 @samp{underflow}, @samp{inexact} and @samp{denormal}. (See
1064 @option{-ffpe-trap} for a description of the exceptions.)
1066 By default, a summary for all exceptions but @samp{inexact} is shown.
1068 @item -fno-backtrace
1069 @opindex @code{fno-backtrace}
1070 @cindex backtrace
1071 @cindex trace
1072 When a serious runtime error is encountered or a deadly signal is
1073 emitted (segmentation fault, illegal instruction, bus error,
1074 floating-point exception, and the other POSIX signals that have the
1075 action @samp{core}), the Fortran runtime library tries to output a
1076 backtrace of the error. @code{-fno-backtrace} disables the backtrace
1077 generation. This option only has influence for compilation of the
1078 Fortran main program.
1080 @end table
1082 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
1083 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
1084 debugging options.
1086 @node Directory Options
1087 @section Options for directory search
1088 @cindex directory, options
1089 @cindex options, directory search
1090 @cindex search path
1091 @cindex @code{INCLUDE} directive
1092 @cindex directive, @code{INCLUDE}
1093 These options affect how GNU Fortran searches
1094 for files specified by the @code{INCLUDE} directive and where it searches
1095 for previously compiled modules.
1097 It also affects the search paths used by @command{cpp} when used to preprocess
1098 Fortran source.
1100 @table @gcctabopt
1101 @item -I@var{dir}
1102 @opindex @code{I}@var{dir}
1103 @cindex directory, search paths for inclusion
1104 @cindex inclusion, directory search paths for
1105 @cindex search paths, for included files
1106 @cindex paths, search
1107 @cindex module search path
1108 These affect interpretation of the @code{INCLUDE} directive
1109 (as well as of the @code{#include} directive of the @command{cpp}
1110 preprocessor).
1112 Also note that the general behavior of @option{-I} and
1113 @code{INCLUDE} is pretty much the same as of @option{-I} with
1114 @code{#include} in the @command{cpp} preprocessor, with regard to
1115 looking for @file{header.gcc} files and other such things.
1117 This path is also used to search for @file{.mod} files when previously
1118 compiled modules are required by a @code{USE} statement.
1120 @xref{Directory Options,,Options for Directory Search,
1121 gcc,Using the GNU Compiler Collection (GCC)}, for information on the
1122 @option{-I} option.
1124 @item -J@var{dir}
1125 @opindex @code{J}@var{dir}
1126 @opindex @code{M}@var{dir}
1127 @cindex paths, search
1128 @cindex module search path
1129 This option specifies where to put @file{.mod} files for compiled modules.
1130 It is also added to the list of directories to searched by an @code{USE}
1131 statement.
1133 The default is the current directory.
1135 @item -fintrinsic-modules-path @var{dir}
1136 @opindex @code{fintrinsic-modules-path} @var{dir}
1137 @cindex paths, search
1138 @cindex module search path
1139 This option specifies the location of pre-compiled intrinsic modules, if
1140 they are not in the default location expected by the compiler.
1141 @end table
1143 @node Link Options
1144 @section Influencing the linking step
1145 @cindex options, linking
1146 @cindex linking, static
1148 These options come into play when the compiler links object files into an 
1149 executable output file. They are meaningless if the compiler is not doing 
1150 a link step.
1152 @table @gcctabopt
1153 @item -static-libgfortran
1154 @opindex @code{static-libgfortran}
1155 On systems that provide @file{libgfortran} as a shared and a static
1156 library, this option forces the use of the static version. If no
1157 shared version of @file{libgfortran} was built when the compiler was
1158 configured, this option has no effect.
1159 @end table
1162 @node Runtime Options
1163 @section Influencing runtime behavior
1164 @cindex options, runtime
1166 These options affect the runtime behavior of programs compiled with GNU Fortran.
1168 @table @gcctabopt
1169 @item -fconvert=@var{conversion}
1170 @opindex @code{fconvert=}@var{conversion}
1171 Specify the representation of data for unformatted files.  Valid
1172 values for conversion are: @samp{native}, the default; @samp{swap},
1173 swap between big- and little-endian; @samp{big-endian}, use big-endian
1174 representation for unformatted files; @samp{little-endian}, use little-endian
1175 representation for unformatted files.
1177 @emph{This option has an effect only when used in the main program.
1178 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
1179 variable override the default specified by @option{-fconvert}.}
1181 @item -frecord-marker=@var{length}
1182 @opindex @code{frecord-marker=}@var{length}
1183 Specify the length of record markers for unformatted files.
1184 Valid values for @var{length} are 4 and 8.  Default is 4.
1185 @emph{This is different from previous versions of @command{gfortran}},
1186 which specified a default record marker length of 8 on most
1187 systems.  If you want to read or write files compatible
1188 with earlier versions of @command{gfortran}, use @option{-frecord-marker=8}.
1190 @item -fmax-subrecord-length=@var{length}
1191 @opindex @code{fmax-subrecord-length=}@var{length}
1192 Specify the maximum length for a subrecord.  The maximum permitted
1193 value for length is 2147483639, which is also the default.  Only
1194 really useful for use by the gfortran testsuite.
1196 @item -fsign-zero
1197 @opindex @code{fsign-zero}
1198 When enabled, floating point numbers of value zero with the sign bit set
1199 are written as negative number in formatted output and treated as
1200 negative in the @code{SIGN} intrinsic.  @option{-fno-sign-zero} does not
1201 print the negative sign of zero values (or values rounded to zero for I/O)
1202 and regards zero as positive number in the @code{SIGN} intrinsic for
1203 compatibility with Fortran 77. The default is @option{-fsign-zero}.
1204 @end table
1206 @node Code Gen Options
1207 @section Options for code generation conventions
1208 @cindex code generation, conventions
1209 @cindex options, code generation
1210 @cindex options, run-time
1212 These machine-independent options control the interface conventions
1213 used in code generation.
1215 Most of them have both positive and negative forms; the negative form
1216 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
1217 one of the forms is listed---the one which is not the default.  You
1218 can figure out the other form by either removing @option{no-} or adding
1221 @table @gcctabopt
1222 @item -fno-automatic
1223 @opindex @code{fno-automatic}
1224 @cindex @code{SAVE} statement
1225 @cindex statement, @code{SAVE}
1226 Treat each program unit (except those marked as RECURSIVE) as if the
1227 @code{SAVE} statement were specified for every local variable and array
1228 referenced in it. Does not affect common blocks. (Some Fortran compilers
1229 provide this option under the name @option{-static} or @option{-save}.)
1230 The default, which is @option{-fautomatic}, uses the stack for local
1231 variables smaller than the value given by @option{-fmax-stack-var-size}.
1232 Use the option @option{-frecursive} to use no static memory. 
1234 @item -ff2c
1235 @opindex ff2c
1236 @cindex calling convention
1237 @cindex @command{f2c} calling convention
1238 @cindex @command{g77} calling convention
1239 @cindex libf2c calling convention
1240 Generate code designed to be compatible with code generated
1241 by @command{g77} and @command{f2c}.
1243 The calling conventions used by @command{g77} (originally implemented
1244 in @command{f2c}) require functions that return type
1245 default @code{REAL} to actually return the C type @code{double}, and
1246 functions that return type @code{COMPLEX} to return the values via an
1247 extra argument in the calling sequence that points to where to
1248 store the return value.  Under the default GNU calling conventions, such
1249 functions simply return their results as they would in GNU
1250 C---default @code{REAL} functions return the C type @code{float}, and
1251 @code{COMPLEX} functions return the GNU C type @code{complex}.
1252 Additionally, this option implies the @option{-fsecond-underscore}
1253 option, unless @option{-fno-second-underscore} is explicitly requested.
1255 This does not affect the generation of code that interfaces with
1256 the @command{libgfortran} library.
1258 @emph{Caution:} It is not a good idea to mix Fortran code compiled with
1259 @option{-ff2c} with code compiled with the default @option{-fno-f2c}
1260 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
1261 functions between program parts which were compiled with different
1262 calling conventions will break at execution time.
1264 @emph{Caution:} This will break code which passes intrinsic functions
1265 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
1266 the library implementations use the @option{-fno-f2c} calling conventions.
1268 @item -fno-underscoring
1269 @opindex @code{fno-underscoring}
1270 @cindex underscore
1271 @cindex symbol names, underscores
1272 @cindex transforming symbol names
1273 @cindex symbol names, transforming
1274 Do not transform names of entities specified in the Fortran
1275 source file by appending underscores to them.
1277 With @option{-funderscoring} in effect, GNU Fortran appends one
1278 underscore to external names with no underscores.  This is done to ensure
1279 compatibility with code produced by many UNIX Fortran compilers.
1281 @emph{Caution}: The default behavior of GNU Fortran is
1282 incompatible with @command{f2c} and @command{g77}, please use the
1283 @option{-ff2c} option if you want object files compiled with
1284 GNU Fortran to be compatible with object code created with these
1285 tools.
1287 Use of @option{-fno-underscoring} is not recommended unless you are
1288 experimenting with issues such as integration of GNU Fortran into
1289 existing system environments (vis-@`{a}-vis existing libraries, tools,
1290 and so on).
1292 For example, with @option{-funderscoring}, and assuming that @code{j()} and
1293 @code{max_count()} are external functions while @code{my_var} and
1294 @code{lvar} are local variables, a statement like
1295 @smallexample
1296 I = J() + MAX_COUNT (MY_VAR, LVAR)
1297 @end smallexample
1298 @noindent
1299 is implemented as something akin to:
1300 @smallexample
1301 i = j_() + max_count__(&my_var__, &lvar);
1302 @end smallexample
1304 With @option{-fno-underscoring}, the same statement is implemented as:
1306 @smallexample
1307 i = j() + max_count(&my_var, &lvar);
1308 @end smallexample
1310 Use of @option{-fno-underscoring} allows direct specification of
1311 user-defined names while debugging and when interfacing GNU Fortran
1312 code with other languages.
1314 Note that just because the names match does @emph{not} mean that the
1315 interface implemented by GNU Fortran for an external name matches the
1316 interface implemented by some other language for that same name.
1317 That is, getting code produced by GNU Fortran to link to code produced
1318 by some other compiler using this or any other method can be only a
1319 small part of the overall solution---getting the code generated by
1320 both compilers to agree on issues other than naming can require
1321 significant effort, and, unlike naming disagreements, linkers normally
1322 cannot detect disagreements in these other areas.
1324 Also, note that with @option{-fno-underscoring}, the lack of appended
1325 underscores introduces the very real possibility that a user-defined
1326 external name will conflict with a name in a system library, which
1327 could make finding unresolved-reference bugs quite difficult in some
1328 cases---they might occur at program run time, and show up only as
1329 buggy behavior at run time.
1331 In future versions of GNU Fortran we hope to improve naming and linking
1332 issues so that debugging always involves using the names as they appear
1333 in the source, even if the names as seen by the linker are mangled to
1334 prevent accidental linking between procedures with incompatible
1335 interfaces.
1337 @item -fsecond-underscore
1338 @opindex @code{fsecond-underscore}
1339 @cindex underscore
1340 @cindex symbol names, underscores
1341 @cindex transforming symbol names
1342 @cindex symbol names, transforming
1343 @cindex @command{f2c} calling convention
1344 @cindex @command{g77} calling convention
1345 @cindex libf2c calling convention
1346 By default, GNU Fortran appends an underscore to external
1347 names.  If this option is used GNU Fortran appends two
1348 underscores to names with underscores and one underscore to external names
1349 with no underscores.  GNU Fortran also appends two underscores to
1350 internal names with underscores to avoid naming collisions with external
1351 names.
1353 This option has no effect if @option{-fno-underscoring} is
1354 in effect.  It is implied by the @option{-ff2c} option.
1356 Otherwise, with this option, an external name such as @code{MAX_COUNT}
1357 is implemented as a reference to the link-time external symbol
1358 @code{max_count__}, instead of @code{max_count_}.  This is required
1359 for compatibility with @command{g77} and @command{f2c}, and is implied
1360 by use of the @option{-ff2c} option.
1362 @item -fcoarray=@var{<keyword>}
1363 @opindex @code{fcoarray}
1364 @cindex coarrays
1366 @table @asis
1367 @item @samp{none}
1368 Disable coarray support; using coarray declarations and image-control
1369 statements will produce a compile-time error. (Default)
1371 @item @samp{single}
1372 Single-image mode, i.e. @code{num_images()} is always one.
1374 @item @samp{lib}
1375 Library-based coarray parallelization; a suitable GNU Fortran coarray
1376 library needs to be linked.
1377 @end table
1380 @item -fcheck=@var{<keyword>}
1381 @opindex @code{fcheck}
1382 @cindex array, bounds checking
1383 @cindex bounds checking
1384 @cindex pointer checking
1385 @cindex memory checking
1386 @cindex range checking
1387 @cindex subscript checking
1388 @cindex checking subscripts
1389 @cindex run-time checking
1390 @cindex checking array temporaries
1392 Enable the generation of run-time checks; the argument shall be
1393 a comma-delimited list of the following keywords.
1395 @table @asis
1396 @item @samp{all}
1397 Enable all run-time test of @option{-fcheck}.
1399 @item @samp{array-temps}
1400 Warns at run time when for passing an actual argument a temporary array
1401 had to be generated. The information generated by this warning is
1402 sometimes useful in optimization, in order to avoid such temporaries.
1404 Note: The warning is only printed once per location.
1406 @item @samp{bounds}
1407 Enable generation of run-time checks for array subscripts
1408 and against the declared minimum and maximum values.  It also
1409 checks array indices for assumed and deferred
1410 shape arrays against the actual allocated bounds and ensures that all string
1411 lengths are equal for character array constructors without an explicit
1412 typespec.
1414 Some checks require that @option{-fcheck=bounds} is set for
1415 the compilation of the main program.
1417 Note: In the future this may also include other forms of checking, e.g.,
1418 checking substring references.
1420 @item @samp{do}
1421 Enable generation of run-time checks for invalid modification of loop
1422 iteration variables.
1424 @item @samp{mem}
1425 Enable generation of run-time checks for memory allocation.
1426 Note: This option does not affect explicit allocations using the
1427 @code{ALLOCATE} statement, which will be always checked.
1429 @item @samp{pointer}
1430 Enable generation of run-time checks for pointers and allocatables.
1432 @item @samp{recursion}
1433 Enable generation of run-time checks for recursively called subroutines and
1434 functions which are not marked as recursive. See also @option{-frecursive}.
1435 Note: This check does not work for OpenMP programs and is disabled if used
1436 together with @option{-frecursive} and @option{-fopenmp}.
1437 @end table
1440 @item -fbounds-check
1441 @opindex @code{fbounds-check}
1442 @c Note: This option is also referred in gcc's manpage
1443 Deprecated alias for @option{-fcheck=bounds}.
1445 @item -fcheck-array-temporaries
1446 @opindex @code{fcheck-array-temporaries}
1447 Deprecated alias for @option{-fcheck=array-temps}.
1449 @item -fmax-array-constructor=@var{n}
1450 @opindex @code{fmax-array-constructor}
1451 This option can be used to increase the upper limit permitted in 
1452 array constructors.  The code below requires this option to expand
1453 the array at compile time.
1455 @smallexample
1456 program test
1457 implicit none
1458 integer j
1459 integer, parameter :: n = 100000
1460 integer, parameter :: i(n) = (/ (2*j, j = 1, n) /)
1461 print '(10(I0,1X))', i
1462 end program test
1463 @end smallexample
1465 @emph{Caution:  This option can lead to long compile times and excessively
1466 large object files.}
1468 The default value for @var{n} is 65535.
1471 @item -fmax-stack-var-size=@var{n}
1472 @opindex @code{fmax-stack-var-size}
1473 This option specifies the size in bytes of the largest array that will be put
1474 on the stack; if the size is exceeded static memory is used (except in
1475 procedures marked as RECURSIVE). Use the option @option{-frecursive} to
1476 allow for recursive procedures which do not have a RECURSIVE attribute or
1477 for parallel programs. Use @option{-fno-automatic} to never use the stack.
1479 This option currently only affects local arrays declared with constant
1480 bounds, and may not apply to all character variables.
1481 Future versions of GNU Fortran may improve this behavior.
1483 The default value for @var{n} is 32768.
1485 @item -fstack-arrays
1486 @opindex @code{fstack-arrays}
1487 Adding this option will make the Fortran compiler put all local arrays,
1488 even those of unknown size onto stack memory.  If your program uses very
1489 large local arrays it is possible that you will have to extend your runtime
1490 limits for stack memory on some operating systems. This flag is enabled
1491 by default at optimization level @option{-Ofast}.
1494 @item -fpack-derived
1495 @opindex @code{fpack-derived}
1496 @cindex structure packing
1497 This option tells GNU Fortran to pack derived type members as closely as
1498 possible.  Code compiled with this option is likely to be incompatible
1499 with code compiled without this option, and may execute slower.
1501 @item -frepack-arrays
1502 @opindex @code{frepack-arrays}
1503 @cindex repacking arrays
1504 In some circumstances GNU Fortran may pass assumed shape array
1505 sections via a descriptor describing a noncontiguous area of memory.
1506 This option adds code to the function prologue to repack the data into
1507 a contiguous block at runtime.
1509 This should result in faster accesses to the array.  However it can introduce
1510 significant overhead to the function call, especially  when the passed data
1511 is noncontiguous.
1513 @item -fshort-enums
1514 @opindex @code{fshort-enums}
1515 This option is provided for interoperability with C code that was
1516 compiled with the @option{-fshort-enums} option.  It will make
1517 GNU Fortran choose the smallest @code{INTEGER} kind a given
1518 enumerator set will fit in, and give all its enumerators this kind.
1520 @item -fexternal-blas
1521 @opindex @code{fexternal-blas}
1522 This option will make @command{gfortran} generate calls to BLAS functions
1523 for some matrix operations like @code{MATMUL}, instead of using our own
1524 algorithms, if the size of the matrices involved is larger than a given
1525 limit (see @option{-fblas-matmul-limit}).  This may be profitable if an
1526 optimized vendor BLAS library is available.  The BLAS library will have
1527 to be specified at link time.
1529 @item -fblas-matmul-limit=@var{n}
1530 @opindex @code{fblas-matmul-limit}
1531 Only significant when @option{-fexternal-blas} is in effect.
1532 Matrix multiplication of matrices with size larger than (or equal to) @var{n}
1533 will be performed by calls to BLAS functions, while others will be
1534 handled by @command{gfortran} internal algorithms. If the matrices
1535 involved are not square, the size comparison is performed using the
1536 geometric mean of the dimensions of the argument and result matrices.
1538 The default value for @var{n} is 30.
1540 @item -frecursive
1541 @opindex @code{frecursive}
1542 Allow indirect recursion by forcing all local arrays to be allocated
1543 on the stack. This flag cannot be used together with
1544 @option{-fmax-stack-var-size=} or @option{-fno-automatic}.
1546 @item -finit-local-zero
1547 @itemx -finit-integer=@var{n}
1548 @itemx -finit-real=@var{<zero|inf|-inf|nan|snan>}
1549 @itemx -finit-logical=@var{<true|false>}
1550 @itemx -finit-character=@var{n}
1551 @opindex @code{finit-local-zero}
1552 @opindex @code{finit-integer}
1553 @opindex @code{finit-real}
1554 @opindex @code{finit-logical}
1555 @opindex @code{finit-character}
1556 The @option{-finit-local-zero} option instructs the compiler to
1557 initialize local @code{INTEGER}, @code{REAL}, and @code{COMPLEX}
1558 variables to zero, @code{LOGICAL} variables to false, and
1559 @code{CHARACTER} variables to a string of null bytes.  Finer-grained
1560 initialization options are provided by the
1561 @option{-finit-integer=@var{n}},
1562 @option{-finit-real=@var{<zero|inf|-inf|nan|snan>}} (which also initializes
1563 the real and imaginary parts of local @code{COMPLEX} variables),
1564 @option{-finit-logical=@var{<true|false>}}, and
1565 @option{-finit-character=@var{n}} (where @var{n} is an ASCII character
1566 value) options.  These options do not initialize
1567 @itemize @bullet
1568 @item
1569 allocatable arrays
1570 @item
1571 components of derived type variables
1572 @item
1573 variables that appear in an @code{EQUIVALENCE} statement.
1574 @end itemize
1575 (These limitations may be removed in future releases).
1577 Note that the @option{-finit-real=nan} option initializes @code{REAL}
1578 and @code{COMPLEX} variables with a quiet NaN. For a signalling NaN
1579 use @option{-finit-real=snan}; note, however, that compile-time
1580 optimizations may convert them into quiet NaN and that trapping
1581 needs to be enabled (e.g. via @option{-ffpe-trap}).
1583 Finally, note that enabling any of the @option{-finit-*} options will
1584 silence warnings that would have been emitted by @option{-Wuninitialized}
1585 for the affected local variables.
1587 @item -falign-commons
1588 @opindex @code{falign-commons}
1589 @cindex alignment of @code{COMMON} blocks
1590 By default, @command{gfortran} enforces proper alignment of all variables in a
1591 @code{COMMON} block by padding them as needed. On certain platforms this is mandatory,
1592 on others it increases performance. If a @code{COMMON} block is not declared with
1593 consistent data types everywhere, this padding can cause trouble, and
1594 @option{-fno-align-commons} can be used to disable automatic alignment. The
1595 same form of this option should be used for all files that share a @code{COMMON} block.
1596 To avoid potential alignment issues in @code{COMMON} blocks, it is recommended to order
1597 objects from largest to smallest.
1599 @item -fno-protect-parens
1600 @opindex @code{fno-protect-parens}
1601 @cindex re-association of parenthesized expressions
1602 By default the parentheses in expression are honored for all optimization
1603 levels such that the compiler does not do any re-association. Using
1604 @option{-fno-protect-parens} allows the compiler to reorder @code{REAL} and
1605 @code{COMPLEX} expressions to produce faster code. Note that for the re-association
1606 optimization @option{-fno-signed-zeros} and @option{-fno-trapping-math}
1607 need to be in effect. The parentheses protection is enabled by default, unless
1608 @option{-Ofast} is given.
1610 @item -frealloc-lhs
1611 @opindex @code{frealloc-lhs}
1612 @cindex Reallocate the LHS in assignments
1613 An allocatable left-hand side of an intrinsic assignment is automatically
1614 (re)allocated if it is either unallocated or has a different shape. The
1615 option is enabled by default except when @option{-std=f95} is given. See
1616 also @option{-Wrealloc-lhs}.
1618 @item -faggressive-function-elimination
1619 @opindex @code{faggressive-function-elimination}
1620 @cindex Elimination of functions with identical argument lists
1621 Functions with identical argument lists are eliminated within
1622 statements, regardless of whether these functions are marked
1623 @code{PURE} or not. For example, in
1624 @smallexample
1625   a = f(b,c) + f(b,c)
1626 @end smallexample
1627 there will only be a single call to @code{f}.  This option only works
1628 if @option{-ffrontend-optimize} is in effect.
1630 @item -ffrontend-optimize
1631 @opindex @code{frontend-optimize}
1632 @cindex Front-end optimization
1633 This option performs front-end optimization, based on manipulating
1634 parts the Fortran parse tree.  Enabled by default by any @option{-O}
1635 option.  Optimizations enabled by this option include elimination of
1636 identical function calls within expressions, removing unnecessary
1637 calls to @code{TRIM} in comparisons and assignments and replacing
1638 @code{TRIM(a)} with @code{a(1:LEN_TRIM(a))}. 
1639 It can be deselected by specifying @option{-fno-frontend-optimize}.
1640 @end table
1642 @xref{Code Gen Options,,Options for Code Generation Conventions,
1643 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
1644 offered by the GBE
1645 shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
1647 @c man end
1649 @node Environment Variables
1650 @section Environment variables affecting @command{gfortran}
1651 @cindex environment variable
1653 @c man begin ENVIRONMENT
1655 The @command{gfortran} compiler currently does not make use of any environment
1656 variables to control its operation above and beyond those
1657 that affect the operation of @command{gcc}.
1659 @xref{Environment Variables,,Environment Variables Affecting GCC,
1660 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
1661 variables.
1663 @xref{Runtime}, for environment variables that affect the
1664 run-time behavior of programs compiled with GNU Fortran.
1665 @c man end