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