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