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