gcc/
[official-gcc.git] / gcc / fortran / invoke.texi
blob658ed2375fc3d4f3e8f922b6d78df8fe2ddc30d3
1 @c Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
2 @c Free Software Foundation, Inc.
3 @c This is part of the GNU Fortran manual.   
4 @c For copying conditions, see the file gfortran.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
9 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.3 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``Funding Free Software'', the Front-Cover
15 Texts being (a) (see below), and with the Back-Cover Texts being (b)
16 (see below).  A copy of the license is included in the gfdl(7) man page.
18 (a) The FSF's Front-Cover Text is:
20      A GNU Manual
22 (b) The FSF's Back-Cover Text is:
24      You have freedom to copy and modify this GNU Manual, like GNU
25      software.  Copies published by the Free Software Foundation raise
26      funds for GNU development.
27 @c man end
28 @c Set file name and title for the man page.
29 @setfilename gfortran
30 @settitle GNU Fortran compiler.
31 @c man begin SYNOPSIS
32 gfortran [@option{-c}|@option{-S}|@option{-E}]
33          [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
34          [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
35          [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
36          [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
37          [@option{-f}@var{option}@dots{}]
38          [@option{-m}@var{machine-option}@dots{}]
39          [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), gcc(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{gfortran}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@value{BUGURL}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gfortran} for contributors to GCC and
56 GNU Fortran.
57 @c man end
58 @end ignore
60 @node Invoking GNU Fortran
61 @chapter GNU Fortran Command Options
62 @cindex GNU Fortran command options
63 @cindex command options
64 @cindex options, @command{gfortran} command
66 @c man begin DESCRIPTION
68 The @command{gfortran} command supports all the options supported by the
69 @command{gcc} command.  Only options specific to GNU Fortran are documented
70 here.
72 @xref{Invoking GCC,,GCC Command Options,gcc,Using the GNU Compiler
73 Collection (GCC)}, for information
74 on the non-Fortran-specific aspects of the @command{gcc} command (and,
75 therefore, the @command{gfortran} command).
77 @cindex options, negative forms
78 All GCC and GNU Fortran options
79 are accepted both by @command{gfortran} and by @command{gcc}
80 (as well as any other drivers built at the same time,
81 such as @command{g++}),
82 since adding GNU Fortran to the GCC distribution
83 enables acceptance of GNU Fortran options
84 by all of the relevant drivers.
86 In some cases, options have positive and negative forms;
87 the negative form of @option{-ffoo} would be @option{-fno-foo}.
88 This manual documents only one of these two forms, whichever
89 one is not the default.
90 @c man end
92 @menu
93 * Option Summary::      Brief list of all @command{gfortran} options,
94                         without explanations.
95 * Fortran Dialect Options::  Controlling the variant of Fortran language
96                              compiled.
97 * Preprocessing Options::  Enable and customize preprocessing.
98 * Error and Warning Options::     How picky should the compiler be?
99 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
100 * Directory Options::   Where to find module files
101 * Link Options ::       Influencing the linking step
102 * Runtime Options::     Influencing runtime behavior
103 * Code Gen Options::    Specifying conventions for function calls, data layout
104                         and register usage.
105 * Environment Variables:: Environment variables that affect @command{gfortran}.
106 @end menu
108 @node Option Summary
109 @section Option summary
111 @c man begin OPTIONS
113 Here is a summary of all the options specific to GNU Fortran, grouped
114 by type.  Explanations are in the following sections.
116 @table @emph
117 @item Fortran Language Options
118 @xref{Fortran Dialect Options,,Options controlling Fortran dialect}.
119 @gccoptlist{-fall-intrinsics -fbackslash -fcray-pointer -fd-lines-as-code @gol
120 -fd-lines-as-comments -fdefault-double-8 -fdefault-integer-8 @gol
121 -fdefault-real-8 -fdollar-ok -ffixed-line-length-@var{n} @gol
122 -ffixed-line-length-none -ffree-form -ffree-line-length-@var{n} @gol
123 -ffree-line-length-none -fimplicit-none -finteger-4-integer-8 @gol
124 -fmax-identifier-length -fmodule-private -fno-fixed-form -fno-range-check @gol
125 -fopenmp -freal-4-real-10 -freal-4-real-16 -freal-4-real-8 @gol
126 -freal-8-real-10 -freal-8-real-16 -freal-8-real-4 -std=@var{std}
129 @item Preprocessing Options
130 @xref{Preprocessing Options,,Enable and customize preprocessing}.
131 @gccoptlist{-A-@var{question}@r{[}=@var{answer}@r{]}
132 -A@var{question}=@var{answer} -C -CC -D@var{macro}@r{[}=@var{defn}@r{]}
133 -H -P @gol
134 -U@var{macro} -cpp -dD -dI -dM -dN -dU -fworking-directory
135 -imultilib @var{dir} @gol
136 -iprefix @var{file} -iquote -isysroot @var{dir} -isystem @var{dir} -nocpp 
137 -nostdinc @gol
138 -undef
141 @item Error and Warning Options
142 @xref{Error and Warning Options,,Options to request or suppress errors
143 and warnings}.
144 @gccoptlist{-Waliasing -Wall -Wampersand -Warray-bounds
145 -Wc-binding-type -Wcharacter-truncation @gol
146 -Wconversion -Wfunction-elimination -Wimplicit-interface @gol
147 -Wimplicit-procedure -Wintrinsic-shadow -Wintrinsics-std @gol
148 -Wline-truncation -Wno-align-commons -Wno-tabs -Wreal-q-constant @gol
149 -Wsurprising -Wunderflow -Wunused-parameter -Wrealloc-lhs Wrealloc-lhs-all @gol
150 -fmax-errors=@var{n} -fsyntax-only -pedantic -pedantic-errors
153 @item Debugging Options
154 @xref{Debugging Options,,Options for debugging your program or GNU Fortran}.
155 @gccoptlist{-fbacktrace -fdump-fortran-optimized -fdump-fortran-original @gol
156 -fdump-parse-tree -ffpe-trap=@var{list}
159 @item Directory Options
160 @xref{Directory Options,,Options for directory search}.
161 @gccoptlist{-I@var{dir}  -J@var{dir} -fintrinsic-modules-path @var{dir}}
163 @item Link Options
164 @xref{Link Options,,Options for influencing the linking step}.
165 @gccoptlist{-static-libgfortran}
167 @item Runtime Options
168 @xref{Runtime Options,,Options for influencing runtime behavior}.
169 @gccoptlist{-fconvert=@var{conversion} -fmax-subrecord-length=@var{length} @gol
170 -frecord-marker=@var{length} -fsign-zero
173 @item Code Generation Options
174 @xref{Code Gen Options,,Options for code generation conventions}.
175 @gccoptlist{-faggressive-function-elimination -fblas-matmul-limit=@var{n} @gol
176 -fbounds-check -fcheck-array-temporaries @gol
177 -fcheck=@var{<all|array-temps|bounds|do|mem|pointer|recursion>} @gol
178 -fcoarray=@var{<none|single|lib>} -fexternal-blas -ff2c
179 -ffrontend-optimize @gol
180 -finit-character=@var{n} -finit-integer=@var{n} -finit-local-zero @gol
181 -finit-logical=@var{<true|false>}
182 -finit-real=@var{<zero|inf|-inf|nan|snan>} @gol
183 -fmax-array-constructor=@var{n} -fmax-stack-var-size=@var{n}
184 -fno-align-commons @gol
185 -fno-automatic -fno-protect-parens -fno-underscoring -fno-whole-file @gol
186 -fsecond-underscore -fpack-derived -frealloc-lhs -frecursive @gol
187 -frepack-arrays -fshort-enums -fstack-arrays
189 @end table
191 @node Fortran Dialect Options
192 @section Options controlling Fortran dialect
193 @cindex dialect options
194 @cindex language, dialect options
195 @cindex options, dialect
197 The following options control the details of the Fortran dialect
198 accepted by the compiler:
200 @table @gcctabopt
201 @item -ffree-form
202 @itemx -ffixed-form
203 @opindex @code{ffree-form}
204 @opindex @code{fno-fixed-form}
205 @cindex options, Fortran dialect
206 @cindex file format, free
207 @cindex file format, fixed
208 Specify the layout used by the source file.  The free form layout
209 was introduced in Fortran 90.  Fixed form was traditionally used in
210 older Fortran programs.  When neither option is specified, the source
211 form is determined by the file extension.
213 @item -fall-intrinsics
214 @opindex @code{fall-intrinsics}
215 This option causes all intrinsic procedures (including the GNU-specific
216 extensions) to be accepted.  This can be useful with @option{-std=f95} to
217 force standard-compliance but get access to the full range of intrinsics
218 available with @command{gfortran}.  As a consequence, @option{-Wintrinsics-std}
219 will be ignored and no user-defined procedure with the same name as any
220 intrinsic will be called except when it is explicitly declared @code{EXTERNAL}.
222 @item -fd-lines-as-code
223 @itemx -fd-lines-as-comments
224 @opindex @code{fd-lines-as-code}
225 @opindex @code{fd-lines-as-comments}
226 Enable special treatment for lines beginning with @code{d} or @code{D}
227 in fixed form sources.  If the @option{-fd-lines-as-code} option is
228 given they are treated as if the first column contained a blank.  If the
229 @option{-fd-lines-as-comments} option is given, they are treated as
230 comment lines.
232 @item -fdefault-double-8
233 @opindex @code{fdefault-double-8}
234 Set the @code{DOUBLE PRECISION} type to an 8 byte wide type.  If
235 @option{-fdefault-real-8} is given, @code{DOUBLE PRECISION} would
236 instead be promoted to 16 bytes if possible, and @option{-fdefault-double-8}
237 can be used to prevent this.  The kind of real constants like @code{1.d0} will
238 not be changed by @option{-fdefault-real-8} though, so also
239 @option{-fdefault-double-8} does not affect it.
241 @item -fdefault-integer-8
242 @opindex @code{fdefault-integer-8}
243 Set the default integer and logical types to an 8 byte wide type.
244 Do nothing if this is already the default.  This option also affects
245 the kind of integer constants like @code{42}.
247 @item -fdefault-real-8
248 @opindex @code{fdefault-real-8}
249 Set the default real type to an 8 byte wide type.
250 Do nothing if this is already the default.  This option also affects
251 the kind of non-double real constants like @code{1.0}, and does promote
252 the default width of @code{DOUBLE PRECISION} to 16 bytes if possible, unless
253 @code{-fdefault-double-8} is given, too.
255 @item -fdollar-ok
256 @opindex @code{fdollar-ok}
257 @cindex @code{$}
258 @cindex symbol names
259 @cindex character set
260 Allow @samp{$} as a valid non-first character in a symbol name. Symbols 
261 that start with @samp{$} are rejected since it is unclear which rules to
262 apply to implicit typing as different vendors implement different rules.
263 Using @samp{$} in @code{IMPLICIT} statements is also rejected.
265 @item -fbackslash
266 @opindex @code{backslash}
267 @cindex backslash
268 @cindex escape characters
269 Change the interpretation of backslashes in string literals from a single
270 backslash character to ``C-style'' escape characters. The following
271 combinations are expanded @code{\a}, @code{\b}, @code{\f}, @code{\n},
272 @code{\r}, @code{\t}, @code{\v}, @code{\\}, and @code{\0} to the ASCII
273 characters alert, backspace, form feed, newline, carriage return,
274 horizontal tab, vertical tab, backslash, and NUL, respectively.
275 Additionally, @code{\x}@var{nn}, @code{\u}@var{nnnn} and
276 @code{\U}@var{nnnnnnnn} (where each @var{n} is a hexadecimal digit) are
277 translated into the Unicode characters corresponding to the specified code
278 points. All other combinations of a character preceded by \ are
279 unexpanded.
281 @item -fmodule-private
282 @opindex @code{fmodule-private}
283 @cindex module entities
284 @cindex private
285 Set the default accessibility of module entities to @code{PRIVATE}.
286 Use-associated entities will not be accessible unless they are explicitly
287 declared as @code{PUBLIC}.
289 @item -ffixed-line-length-@var{n}
290 @opindex @code{ffixed-line-length-}@var{n}
291 @cindex file format, fixed
292 Set column after which characters are ignored in typical fixed-form
293 lines in the source file, and through which spaces are assumed (as
294 if padded to that length) after the ends of short fixed-form lines.
296 Popular values for @var{n} include 72 (the
297 standard and the default), 80 (card image), and 132 (corresponding
298 to ``extended-source'' options in some popular compilers).
299 @var{n} may also be @samp{none}, meaning that the entire line is meaningful
300 and that continued character constants never have implicit spaces appended
301 to them to fill out the line.
302 @option{-ffixed-line-length-0} means the same thing as
303 @option{-ffixed-line-length-none}.
305 @item -ffree-line-length-@var{n}
306 @opindex @code{ffree-line-length-}@var{n}
307 @cindex file format, free
308 Set column after which characters are ignored in typical free-form
309 lines in the source file. The default value is 132.
310 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
311 @option{-ffree-line-length-0} means the same thing as
312 @option{-ffree-line-length-none}.
314 @item -fmax-identifier-length=@var{n}
315 @opindex @code{fmax-identifier-length=}@var{n}
316 Specify the maximum allowed identifier length. Typical values are
317 31 (Fortran 95) and 63 (Fortran 2003 and Fortran 2008).
319 @item -fimplicit-none
320 @opindex @code{fimplicit-none}
321 Specify that no implicit typing is allowed, unless overridden by explicit
322 @code{IMPLICIT} statements.  This is the equivalent of adding
323 @code{implicit none} to the start of every procedure.
325 @item -finteger-4-integer-8
326 @opindex @code{finteger-4-integer-8}
327 Promote all @code{INTEGER(KIND=4)} entities to an @code{INTEGER(KIND=8)}
328 entities.  If @code{KIND=8} is unavailable, then an error will be issued.
329 This option should be used with care and may not be suitable for your codes.
330 Areas of possible concern include calls to external procedures,
331 alignment in @code{EQUIVALENCE} and/or @code{COMMON}, generic interfaces,
332 BOZ literal constant conversion, and I/O.  Inspection of the intermediate
333 representation of the translated Fortran code, produced by
334 @option{-fdump-tree-original}, is suggested.
336 @item -fcray-pointer
337 @opindex @code{fcray-pointer}
338 Enable the Cray pointer extension, which provides C-like pointer
339 functionality.
341 @item -fopenmp
342 @opindex @code{fopenmp}
343 @cindex OpenMP
344 Enable the OpenMP extensions.  This includes OpenMP @code{!$omp} directives
345 in free form
346 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
347 @code{!$} conditional compilation sentinels in free form
348 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form, 
349 and when linking arranges for the OpenMP runtime library to be linked
350 in.  The option @option{-fopenmp} implies @option{-frecursive}.
352 @item -fno-range-check
353 @opindex @code{frange-check}
354 Disable range checking on results of simplification of constant
355 expressions during compilation.  For example, GNU Fortran will give
356 an error at compile time when simplifying @code{a = 1. / 0}.
357 With this option, no error will be given and @code{a} will be assigned
358 the value @code{+Infinity}.  If an expression evaluates to a value
359 outside of the relevant range of [@code{-HUGE()}:@code{HUGE()}],
360 then the expression will be replaced by @code{-Inf} or @code{+Inf}
361 as appropriate.
362 Similarly, @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow
363 on most systems, but with @option{-fno-range-check} the value will
364 ``wrap around'' and @code{i} will be initialized to @math{-1} instead.
366 @item  -freal-4-real-8
367 @itemx -freal-4-real-10
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{-Wintrinsics-std},
731 @option{-Wno-tabs}, @option{-Wintrinsic-shadow}, @option{-Wline-truncation},
732 @option{-Wreal-q-constant} and @option{-Wunused}.
734 @item -Waliasing
735 @opindex @code{Waliasing}
736 @cindex aliasing
737 @cindex warnings, aliasing
738 Warn about possible aliasing of dummy arguments. Specifically, it warns
739 if the same actual argument is associated with a dummy argument with
740 @code{INTENT(IN)} and a dummy argument with @code{INTENT(OUT)} in a call
741 with an explicit interface.
743 The following example will trigger the warning.
744 @smallexample
745   interface
746     subroutine bar(a,b)
747       integer, intent(in) :: a
748       integer, intent(out) :: b
749     end subroutine
750   end interface
751   integer :: a
753   call bar(a,a)
754 @end smallexample
756 @item -Wampersand
757 @opindex @code{Wampersand}
758 @cindex warnings, ampersand
759 @cindex @code{&}
760 Warn about missing ampersand in continued character constants. The warning is
761 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95},
762 @option{-std=f2003} and @option{-std=f2008}. Note: With no ampersand
763 given in a continued character constant, GNU Fortran assumes continuation
764 at the first non-comment, non-whitespace character after the ampersand
765 that initiated the continuation.
767 @item -Warray-temporaries
768 @opindex @code{Warray-temporaries}
769 @cindex warnings, array temporaries
770 Warn about array temporaries generated by the compiler.  The information
771 generated by this warning is sometimes useful in optimization, in order to
772 avoid such temporaries.
774 @item -Wc-binding-type
775 @opindex @code{Wc-binding-type}
776 @cindex warning, C binding type
777 Warn if the a variable might not be C interoperable.  In particular, warn if 
778 the variable has been declared using an intrinsic type with default kind
779 instead of using a kind parameter defined for C interoperability in the
780 intrinsic @code{ISO_C_Binding} module.
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.
792 @item -Wconversion
793 @opindex @code{Wconversion}
794 @cindex warnings, conversion
795 @cindex conversion
796 Warn about implicit conversions that are likely to change the value of 
797 the expression after conversion. Implied by @option{-Wall}.
799 @item -Wconversion-extra
800 @opindex @code{Wconversion-extra}
801 @cindex warnings, conversion
802 @cindex conversion
803 Warn about implicit conversions between different types and kinds.
805 @item -Wimplicit-interface
806 @opindex @code{Wimplicit-interface}
807 @cindex warnings, implicit interface
808 Warn if a procedure is called without an explicit interface.
809 Note this only checks that an explicit interface is present.  It does not
810 check that the declared interfaces are consistent across program units.
812 @item -Wimplicit-procedure
813 @opindex @code{Wimplicit-procedure}
814 @cindex warnings, implicit procedure
815 Warn if a procedure is called that has neither an explicit interface
816 nor has been declared as @code{EXTERNAL}.
818 @item -Wintrinsics-std
819 @opindex @code{Wintrinsics-std}
820 @cindex warnings, non-standard intrinsics
821 @cindex warnings, intrinsics of other standards
822 Warn if @command{gfortran} finds a procedure named like an intrinsic not
823 available in the currently selected standard (with @option{-std}) and treats
824 it as @code{EXTERNAL} procedure because of this.  @option{-fall-intrinsics} can
825 be used to never trigger this behavior and always link to the intrinsic
826 regardless of the selected standard.
828 @item -Wreal-q-constant
829 @opindex @code{Wreal-q-constant}
830 @cindex warnings, @code{q} exponent-letter
831 Produce a warning if a real-literal-constant contains a @code{q}
832 exponent-letter.
834 @item -Wsurprising
835 @opindex @code{Wsurprising}
836 @cindex warnings, suspicious code
837 Produce a warning when ``suspicious'' code constructs are encountered.
838 While technically legal these usually indicate that an error has been made.
840 This currently produces a warning under the following circumstances:
842 @itemize @bullet
843 @item
844 An INTEGER SELECT construct has a CASE that can never be matched as its
845 lower value is greater than its upper value.
847 @item
848 A LOGICAL SELECT construct has three CASE statements.
850 @item
851 A TRANSFER specifies a source that is shorter than the destination.
853 @item
854 The type of a function result is declared more than once with the same type.  If
855 @option{-pedantic} or standard-conforming mode is enabled, this is an error.
857 @item
858 A @code{CHARACTER} variable is declared with negative length.
859 @end itemize
861 @item -Wtabs
862 @opindex @code{Wtabs}
863 @cindex warnings, tabs
864 @cindex tabulators
865 By default, tabs are accepted as whitespace, but tabs are not members
866 of the Fortran Character Set.  For continuation lines, a tab followed
867 by a digit between 1 and 9 is supported.  @option{-Wno-tabs} will cause
868 a warning to be issued if a tab is encountered. Note, @option{-Wno-tabs}
869 is active for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003},
870 @option{-std=f2008} and @option{-Wall}.
872 @item -Wunderflow
873 @opindex @code{Wunderflow}
874 @cindex warnings, underflow
875 @cindex underflow
876 Produce a warning when numerical constant expressions are
877 encountered, which yield an UNDERFLOW during compilation.
879 @item -Wintrinsic-shadow
880 @opindex @code{Wintrinsic-shadow}
881 @cindex warnings, intrinsic
882 @cindex intrinsic
883 Warn if a user-defined procedure or module procedure has the same name as an
884 intrinsic; in this case, an explicit interface or @code{EXTERNAL} or
885 @code{INTRINSIC} declaration might be needed to get calls later resolved to
886 the desired intrinsic/procedure.
888 @item -Wunused-dummy-argument
889 @opindex @code{Wunused-dummy-argument}
890 @cindex warnings, unused dummy argument
891 @cindex unused dummy argument
892 @cindex dummy argument, unused
893 Warn about unused dummy arguments. This option is implied by @option{-Wall}.
895 @item -Wunused-parameter
896 @opindex @code{Wunused-parameter}
897 @cindex warnings, unused parameter
898 @cindex unused parameter
899 Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
900 @command{gfortran}'s implementation of this option does not warn
901 about unused dummy arguments (see @option{-Wunused-dummy-argument}),
902 but about unused @code{PARAMETER} values. @option{-Wunused-parameter}
903 is not included in @option{-Wall} but is implied by @option{-Wall -Wextra}.
905 @item -Walign-commons
906 @opindex @code{Walign-commons}
907 @cindex warnings, alignment of @code{COMMON} blocks
908 @cindex alignment of @code{COMMON} blocks
909 By default, @command{gfortran} warns about any occasion of variables being
910 padded for proper alignment inside a @code{COMMON} block. This warning can be turned
911 off via @option{-Wno-align-commons}. See also @option{-falign-commons}.
913 @item -Wfunction-elimination
914 @opindex @code{Wfunction-elimination}
915 @cindex function elimination
916 @cindex warnings, function elimination
917 Warn if any calls to functions are eliminated by the optimizations
918 enabled by the @option{-ffrontend-optimize} option.
920 @item -Wrealloc-lhs
921 @opindex @code{Wrealloc-lhs}
922 @cindex Reallocate the LHS in assignments, notification
923 Warn when the compiler might insert code to for allocation or reallocation of
924 an allocatable array variable of intrinsic type in intrinsic assignments.  In
925 hot loops, the Fortran 2003 reallocation feature may reduce the performance.
926 If the array is already allocated with the correct shape, consider using a
927 whole-array array-spec (e.g. @code{(:,:,:)}) for the variable on the left-hand
928 side to prevent the reallocation check. Note that in some cases the warning
929 is shown, even if the compiler will optimize reallocation checks away.  For
930 instance, when the right-hand side contains the same variable multiplied by
931 a scalar.  See also @option{-frealloc-lhs}.
933 @item -Wrealloc-lhs-all
934 @opindex @code{Wrealloc-lhs-all}
935 Warn when the compiler inserts code to for allocation or reallocation of an
936 allocatable variable; this includes scalars and derived types.
938 @item -Werror
939 @opindex @code{Werror}
940 @cindex warnings, to errors
941 Turns all warnings into errors.
942 @end table
944 @xref{Warning Options,,Options to Request or Suppress Errors and
945 Warnings, gcc,Using the GNU Compiler Collection (GCC)}, for information on
946 more options offered by the GBE shared by @command{gfortran}, @command{gcc}
947 and other GNU compilers.
949 Some of these have no effect when compiling programs written in Fortran.
951 @node Debugging Options
952 @section Options for debugging your program or GNU Fortran
953 @cindex options, debugging
954 @cindex debugging information options
956 GNU Fortran has various special options that are used for debugging
957 either your program or the GNU Fortran compiler.
959 @table @gcctabopt
960 @item -fdump-fortran-original
961 @opindex @code{fdump-fortran-original}
962 Output the internal parse tree after translating the source program
963 into internal representation.  Only really useful for debugging the
964 GNU Fortran compiler itself.
966 @item -fdump-optimized-tree
967 @opindex @code{fdump-fortran-optimized}
968 Output the parse tree after front-end optimization.  Only really
969 useful for debugging the GNU Fortran compiler itself.
971 @opindex @code{fdump-parse-tree}
972 Output the internal parse tree after translating the source program
973 into internal representation.  Only really useful for debugging the
974 GNU Fortran compiler itself.  This option is deprecated; use
975 @code{-fdump-fortran-original} instead.
977 @item -ffpe-trap=@var{list}
978 @opindex @code{ffpe-trap=}@var{list}
979 Specify a list of floating point exception traps to enable.  On most
980 systems, if a floating point exception occurs and the trap for that
981 exception is enabled, a SIGFPE signal will be sent and the program
982 being aborted, producing a core file useful for debugging.  @var{list}
983 is a (possibly empty) comma-separated list of the following
984 exceptions: @samp{invalid} (invalid floating point operation, such as
985 @code{SQRT(-1.0)}), @samp{zero} (division by zero), @samp{overflow}
986 (overflow in a floating point operation), @samp{underflow} (underflow
987 in a floating point operation), @samp{inexact} (loss of precision
988 during operation), and @samp{denormal} (operation performed on a
989 denormal value).  The first five exceptions correspond to the five
990 IEEE 754 exceptions, whereas the last one (@samp{denormal}) is not
991 part of the IEEE 754 standard but is available on some common
992 architectures such as x86.
994 The first three exceptions (@samp{invalid}, @samp{zero}, and
995 @samp{overflow}) often indicate serious errors, and unless the program
996 has provisions for dealing with these exceptions, enabling traps for
997 these three exceptions is probably a good idea.
999 Many, if not most, floating point operations incur loss of precision
1000 due to rounding, and hence the @code{ffpe-trap=inexact} is likely to
1001 be uninteresting in practice.
1003 By default no exception traps are enabled.
1005 @item -fno-backtrace
1006 @opindex @code{fno-backtrace}
1007 @cindex backtrace
1008 @cindex trace
1009 When a serious runtime error is encountered or a deadly signal is
1010 emitted (segmentation fault, illegal instruction, bus error,
1011 floating-point exception, and the other POSIX signals that have the
1012 action @samp{core}), the Fortran runtime library tries to output a
1013 backtrace of the error. @code{-fno-backtrace} disables the backtrace
1014 generation. This option only has influence for compilation of the
1015 Fortran main program.
1017 @end table
1019 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
1020 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
1021 debugging options.
1023 @node Directory Options
1024 @section Options for directory search
1025 @cindex directory, options
1026 @cindex options, directory search
1027 @cindex search path
1028 @cindex @code{INCLUDE} directive
1029 @cindex directive, @code{INCLUDE}
1030 These options affect how GNU Fortran searches
1031 for files specified by the @code{INCLUDE} directive and where it searches
1032 for previously compiled modules.
1034 It also affects the search paths used by @command{cpp} when used to preprocess
1035 Fortran source.
1037 @table @gcctabopt
1038 @item -I@var{dir}
1039 @opindex @code{I}@var{dir}
1040 @cindex directory, search paths for inclusion
1041 @cindex inclusion, directory search paths for
1042 @cindex search paths, for included files
1043 @cindex paths, search
1044 @cindex module search path
1045 These affect interpretation of the @code{INCLUDE} directive
1046 (as well as of the @code{#include} directive of the @command{cpp}
1047 preprocessor).
1049 Also note that the general behavior of @option{-I} and
1050 @code{INCLUDE} is pretty much the same as of @option{-I} with
1051 @code{#include} in the @command{cpp} preprocessor, with regard to
1052 looking for @file{header.gcc} files and other such things.
1054 This path is also used to search for @file{.mod} files when previously
1055 compiled modules are required by a @code{USE} statement.
1057 @xref{Directory Options,,Options for Directory Search,
1058 gcc,Using the GNU Compiler Collection (GCC)}, for information on the
1059 @option{-I} option.
1061 @item -J@var{dir}
1062 @opindex @code{J}@var{dir}
1063 @opindex @code{M}@var{dir}
1064 @cindex paths, search
1065 @cindex module search path
1066 This option specifies where to put @file{.mod} files for compiled modules.
1067 It is also added to the list of directories to searched by an @code{USE}
1068 statement.
1070 The default is the current directory.
1072 @item -fintrinsic-modules-path @var{dir}
1073 @opindex @code{fintrinsic-modules-path} @var{dir}
1074 @cindex paths, search
1075 @cindex module search path
1076 This option specifies the location of pre-compiled intrinsic modules, if
1077 they are not in the default location expected by the compiler.
1078 @end table
1080 @node Link Options
1081 @section Influencing the linking step
1082 @cindex options, linking
1083 @cindex linking, static
1085 These options come into play when the compiler links object files into an 
1086 executable output file. They are meaningless if the compiler is not doing 
1087 a link step.
1089 @table @gcctabopt
1090 @item -static-libgfortran
1091 @opindex @code{static-libgfortran}
1092 On systems that provide @file{libgfortran} as a shared and a static
1093 library, this option forces the use of the static version. If no
1094 shared version of @file{libgfortran} was built when the compiler was
1095 configured, this option has no effect.
1096 @end table
1099 @node Runtime Options
1100 @section Influencing runtime behavior
1101 @cindex options, runtime
1103 These options affect the runtime behavior of programs compiled with GNU Fortran.
1105 @table @gcctabopt
1106 @item -fconvert=@var{conversion}
1107 @opindex @code{fconvert=}@var{conversion}
1108 Specify the representation of data for unformatted files.  Valid
1109 values for conversion are: @samp{native}, the default; @samp{swap},
1110 swap between big- and little-endian; @samp{big-endian}, use big-endian
1111 representation for unformatted files; @samp{little-endian}, use little-endian
1112 representation for unformatted files.
1114 @emph{This option has an effect only when used in the main program.
1115 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
1116 variable override the default specified by @option{-fconvert}.}
1118 @item -frecord-marker=@var{length}
1119 @opindex @code{frecord-marker=}@var{length}
1120 Specify the length of record markers for unformatted files.
1121 Valid values for @var{length} are 4 and 8.  Default is 4.
1122 @emph{This is different from previous versions of @command{gfortran}},
1123 which specified a default record marker length of 8 on most
1124 systems.  If you want to read or write files compatible
1125 with earlier versions of @command{gfortran}, use @option{-frecord-marker=8}.
1127 @item -fmax-subrecord-length=@var{length}
1128 @opindex @code{fmax-subrecord-length=}@var{length}
1129 Specify the maximum length for a subrecord.  The maximum permitted
1130 value for length is 2147483639, which is also the default.  Only
1131 really useful for use by the gfortran testsuite.
1133 @item -fsign-zero
1134 @opindex @code{fsign-zero}
1135 When enabled, floating point numbers of value zero with the sign bit set
1136 are written as negative number in formatted output and treated as
1137 negative in the @code{SIGN} intrinsic.  @option{-fno-sign-zero} does not
1138 print the negative sign of zero values (or values rounded to zero for I/O)
1139 and regards zero as positive number in the @code{SIGN} intrinsic for
1140 compatibility with Fortran 77. The default is @option{-fsign-zero}.
1141 @end table
1143 @node Code Gen Options
1144 @section Options for code generation conventions
1145 @cindex code generation, conventions
1146 @cindex options, code generation
1147 @cindex options, run-time
1149 These machine-independent options control the interface conventions
1150 used in code generation.
1152 Most of them have both positive and negative forms; the negative form
1153 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
1154 one of the forms is listed---the one which is not the default.  You
1155 can figure out the other form by either removing @option{no-} or adding
1158 @table @gcctabopt
1159 @item -fno-automatic
1160 @opindex @code{fno-automatic}
1161 @cindex @code{SAVE} statement
1162 @cindex statement, @code{SAVE}
1163 Treat each program unit (except those marked as RECURSIVE) as if the
1164 @code{SAVE} statement were specified for every local variable and array
1165 referenced in it. Does not affect common blocks. (Some Fortran compilers
1166 provide this option under the name @option{-static} or @option{-save}.)
1167 The default, which is @option{-fautomatic}, uses the stack for local
1168 variables smaller than the value given by @option{-fmax-stack-var-size}.
1169 Use the option @option{-frecursive} to use no static memory. 
1171 @item -ff2c
1172 @opindex ff2c
1173 @cindex calling convention
1174 @cindex @command{f2c} calling convention
1175 @cindex @command{g77} calling convention
1176 @cindex libf2c calling convention
1177 Generate code designed to be compatible with code generated
1178 by @command{g77} and @command{f2c}.
1180 The calling conventions used by @command{g77} (originally implemented
1181 in @command{f2c}) require functions that return type
1182 default @code{REAL} to actually return the C type @code{double}, and
1183 functions that return type @code{COMPLEX} to return the values via an
1184 extra argument in the calling sequence that points to where to
1185 store the return value.  Under the default GNU calling conventions, such
1186 functions simply return their results as they would in GNU
1187 C---default @code{REAL} functions return the C type @code{float}, and
1188 @code{COMPLEX} functions return the GNU C type @code{complex}.
1189 Additionally, this option implies the @option{-fsecond-underscore}
1190 option, unless @option{-fno-second-underscore} is explicitly requested.
1192 This does not affect the generation of code that interfaces with
1193 the @command{libgfortran} library.
1195 @emph{Caution:} It is not a good idea to mix Fortran code compiled with
1196 @option{-ff2c} with code compiled with the default @option{-fno-f2c}
1197 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
1198 functions between program parts which were compiled with different
1199 calling conventions will break at execution time.
1201 @emph{Caution:} This will break code which passes intrinsic functions
1202 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
1203 the library implementations use the @option{-fno-f2c} calling conventions.
1205 @item -fno-underscoring
1206 @opindex @code{fno-underscoring}
1207 @cindex underscore
1208 @cindex symbol names, underscores
1209 @cindex transforming symbol names
1210 @cindex symbol names, transforming
1211 Do not transform names of entities specified in the Fortran
1212 source file by appending underscores to them.
1214 With @option{-funderscoring} in effect, GNU Fortran appends one
1215 underscore to external names with no underscores.  This is done to ensure
1216 compatibility with code produced by many UNIX Fortran compilers.
1218 @emph{Caution}: The default behavior of GNU Fortran is
1219 incompatible with @command{f2c} and @command{g77}, please use the
1220 @option{-ff2c} option if you want object files compiled with
1221 GNU Fortran to be compatible with object code created with these
1222 tools.
1224 Use of @option{-fno-underscoring} is not recommended unless you are
1225 experimenting with issues such as integration of GNU Fortran into
1226 existing system environments (vis-@`{a}-vis existing libraries, tools,
1227 and so on).
1229 For example, with @option{-funderscoring}, and assuming other defaults like
1230 @option{-fcase-lower} and that @code{j()} and @code{max_count()} are
1231 external functions while @code{my_var} and @code{lvar} are local variables,
1232 a statement like
1233 @smallexample
1234 I = J() + MAX_COUNT (MY_VAR, LVAR)
1235 @end smallexample
1236 @noindent
1237 is implemented as something akin to:
1238 @smallexample
1239 i = j_() + max_count__(&my_var__, &lvar);
1240 @end smallexample
1242 With @option{-fno-underscoring}, the same statement is implemented as:
1244 @smallexample
1245 i = j() + max_count(&my_var, &lvar);
1246 @end smallexample
1248 Use of @option{-fno-underscoring} allows direct specification of
1249 user-defined names while debugging and when interfacing GNU Fortran
1250 code with other languages.
1252 Note that just because the names match does @emph{not} mean that the
1253 interface implemented by GNU Fortran for an external name matches the
1254 interface implemented by some other language for that same name.
1255 That is, getting code produced by GNU Fortran to link to code produced
1256 by some other compiler using this or any other method can be only a
1257 small part of the overall solution---getting the code generated by
1258 both compilers to agree on issues other than naming can require
1259 significant effort, and, unlike naming disagreements, linkers normally
1260 cannot detect disagreements in these other areas.
1262 Also, note that with @option{-fno-underscoring}, the lack of appended
1263 underscores introduces the very real possibility that a user-defined
1264 external name will conflict with a name in a system library, which
1265 could make finding unresolved-reference bugs quite difficult in some
1266 cases---they might occur at program run time, and show up only as
1267 buggy behavior at run time.
1269 In future versions of GNU Fortran we hope to improve naming and linking
1270 issues so that debugging always involves using the names as they appear
1271 in the source, even if the names as seen by the linker are mangled to
1272 prevent accidental linking between procedures with incompatible
1273 interfaces.
1275 @item -fno-whole-file
1276 @opindex @code{fno-whole-file}
1277 This flag causes the compiler to resolve and translate each procedure in
1278 a file separately. 
1280 By default, the whole file is parsed and placed in a single front-end tree.
1281 During resolution, in addition to all the usual checks and fixups, references
1282 to external procedures that are in the same file effect resolution of
1283 that procedure, if not already done, and a check of the interfaces.  The
1284 dependences are resolved by changing the order in which the file is
1285 translated into the backend tree.  Thus, a procedure that is referenced
1286 is translated before the reference and the duplication of backend tree
1287 declarations eliminated.
1289 The @option{-fno-whole-file} option is deprecated and may lead to wrong code.
1291 @item -fsecond-underscore
1292 @opindex @code{fsecond-underscore}
1293 @cindex underscore
1294 @cindex symbol names, underscores
1295 @cindex transforming symbol names
1296 @cindex symbol names, transforming
1297 @cindex @command{f2c} calling convention
1298 @cindex @command{g77} calling convention
1299 @cindex libf2c calling convention
1300 By default, GNU Fortran appends an underscore to external
1301 names.  If this option is used GNU Fortran appends two
1302 underscores to names with underscores and one underscore to external names
1303 with no underscores.  GNU Fortran also appends two underscores to
1304 internal names with underscores to avoid naming collisions with external
1305 names.
1307 This option has no effect if @option{-fno-underscoring} is
1308 in effect.  It is implied by the @option{-ff2c} option.
1310 Otherwise, with this option, an external name such as @code{MAX_COUNT}
1311 is implemented as a reference to the link-time external symbol
1312 @code{max_count__}, instead of @code{max_count_}.  This is required
1313 for compatibility with @command{g77} and @command{f2c}, and is implied
1314 by use of the @option{-ff2c} option.
1316 @item -fcoarray=@var{<keyword>}
1317 @opindex @code{fcoarray}
1318 @cindex coarrays
1320 @table @asis
1321 @item @samp{none}
1322 Disable coarray support; using coarray declarations and image-control
1323 statements will produce a compile-time error. (Default)
1325 @item @samp{single}
1326 Single-image mode, i.e. @code{num_images()} is always one.
1328 @item @samp{lib}
1329 Library-based coarray parallelization; a suitable GNU Fortran coarray
1330 library needs to be linked.
1331 @end table
1334 @item -fcheck=@var{<keyword>}
1335 @opindex @code{fcheck}
1336 @cindex array, bounds checking
1337 @cindex bounds checking
1338 @cindex pointer checking
1339 @cindex memory checking
1340 @cindex range checking
1341 @cindex subscript checking
1342 @cindex checking subscripts
1343 @cindex run-time checking
1344 @cindex checking array temporaries
1346 Enable the generation of run-time checks; the argument shall be
1347 a comma-delimited list of the following keywords.
1349 @table @asis
1350 @item @samp{all}
1351 Enable all run-time test of @option{-fcheck}.
1353 @item @samp{array-temps}
1354 Warns at run time when for passing an actual argument a temporary array
1355 had to be generated. The information generated by this warning is
1356 sometimes useful in optimization, in order to avoid such temporaries.
1358 Note: The warning is only printed once per location.
1360 @item @samp{bounds}
1361 Enable generation of run-time checks for array subscripts
1362 and against the declared minimum and maximum values.  It also
1363 checks array indices for assumed and deferred
1364 shape arrays against the actual allocated bounds and ensures that all string
1365 lengths are equal for character array constructors without an explicit
1366 typespec.
1368 Some checks require that @option{-fcheck=bounds} is set for
1369 the compilation of the main program.
1371 Note: In the future this may also include other forms of checking, e.g.,
1372 checking substring references.
1374 @item @samp{do}
1375 Enable generation of run-time checks for invalid modification of loop
1376 iteration variables.
1378 @item @samp{mem}
1379 Enable generation of run-time checks for memory allocation.
1380 Note: This option does not affect explicit allocations using the
1381 @code{ALLOCATE} statement, which will be always checked.
1383 @item @samp{pointer}
1384 Enable generation of run-time checks for pointers and allocatables.
1386 @item @samp{recursion}
1387 Enable generation of run-time checks for recursively called subroutines and
1388 functions which are not marked as recursive. See also @option{-frecursive}.
1389 Note: This check does not work for OpenMP programs and is disabled if used
1390 together with @option{-frecursive} and @option{-fopenmp}.
1391 @end table
1394 @item -fbounds-check
1395 @opindex @code{fbounds-check}
1396 @c Note: This option is also referred in gcc's manpage
1397 Deprecated alias for @option{-fcheck=bounds}.
1399 @item -fcheck-array-temporaries
1400 @opindex @code{fcheck-array-temporaries}
1401 Deprecated alias for @option{-fcheck=array-temps}.
1403 @item -fmax-array-constructor=@var{n}
1404 @opindex @code{fmax-array-constructor}
1405 This option can be used to increase the upper limit permitted in 
1406 array constructors.  The code below requires this option to expand
1407 the array at compile time.
1409 @smallexample
1410 program test
1411 implicit none
1412 integer j
1413 integer, parameter :: n = 100000
1414 integer, parameter :: i(n) = (/ (2*j, j = 1, n) /)
1415 print '(10(I0,1X))', i
1416 end program test
1417 @end smallexample
1419 @emph{Caution:  This option can lead to long compile times and excessively
1420 large object files.}
1422 The default value for @var{n} is 65535.
1425 @item -fmax-stack-var-size=@var{n}
1426 @opindex @code{fmax-stack-var-size}
1427 This option specifies the size in bytes of the largest array that will be put
1428 on the stack; if the size is exceeded static memory is used (except in
1429 procedures marked as RECURSIVE). Use the option @option{-frecursive} to
1430 allow for recursive procedures which do not have a RECURSIVE attribute or
1431 for parallel programs. Use @option{-fno-automatic} to never use the stack.
1433 This option currently only affects local arrays declared with constant
1434 bounds, and may not apply to all character variables.
1435 Future versions of GNU Fortran may improve this behavior.
1437 The default value for @var{n} is 32768.
1439 @item -fstack-arrays
1440 @opindex @code{fstack-arrays}
1441 Adding this option will make the Fortran compiler put all local arrays,
1442 even those of unknown size onto stack memory.  If your program uses very
1443 large local arrays it is possible that you will have to extend your runtime
1444 limits for stack memory on some operating systems. This flag is enabled
1445 by default at optimization level @option{-Ofast}.
1448 @item -fpack-derived
1449 @opindex @code{fpack-derived}
1450 @cindex structure packing
1451 This option tells GNU Fortran to pack derived type members as closely as
1452 possible.  Code compiled with this option is likely to be incompatible
1453 with code compiled without this option, and may execute slower.
1455 @item -frepack-arrays
1456 @opindex @code{frepack-arrays}
1457 @cindex repacking arrays
1458 In some circumstances GNU Fortran may pass assumed shape array
1459 sections via a descriptor describing a noncontiguous area of memory.
1460 This option adds code to the function prologue to repack the data into
1461 a contiguous block at runtime.
1463 This should result in faster accesses to the array.  However it can introduce
1464 significant overhead to the function call, especially  when the passed data
1465 is noncontiguous.
1467 @item -fshort-enums
1468 @opindex @code{fshort-enums}
1469 This option is provided for interoperability with C code that was
1470 compiled with the @option{-fshort-enums} option.  It will make
1471 GNU Fortran choose the smallest @code{INTEGER} kind a given
1472 enumerator set will fit in, and give all its enumerators this kind.
1474 @item -fexternal-blas
1475 @opindex @code{fexternal-blas}
1476 This option will make @command{gfortran} generate calls to BLAS functions
1477 for some matrix operations like @code{MATMUL}, instead of using our own
1478 algorithms, if the size of the matrices involved is larger than a given
1479 limit (see @option{-fblas-matmul-limit}).  This may be profitable if an
1480 optimized vendor BLAS library is available.  The BLAS library will have
1481 to be specified at link time.
1483 @item -fblas-matmul-limit=@var{n}
1484 @opindex @code{fblas-matmul-limit}
1485 Only significant when @option{-fexternal-blas} is in effect.
1486 Matrix multiplication of matrices with size larger than (or equal to) @var{n}
1487 will be performed by calls to BLAS functions, while others will be
1488 handled by @command{gfortran} internal algorithms. If the matrices
1489 involved are not square, the size comparison is performed using the
1490 geometric mean of the dimensions of the argument and result matrices.
1492 The default value for @var{n} is 30.
1494 @item -frecursive
1495 @opindex @code{frecursive}
1496 Allow indirect recursion by forcing all local arrays to be allocated
1497 on the stack. This flag cannot be used together with
1498 @option{-fmax-stack-var-size=} or @option{-fno-automatic}.
1500 @item -finit-local-zero
1501 @itemx -finit-integer=@var{n}
1502 @itemx -finit-real=@var{<zero|inf|-inf|nan|snan>}
1503 @itemx -finit-logical=@var{<true|false>}
1504 @itemx -finit-character=@var{n}
1505 @opindex @code{finit-local-zero}
1506 @opindex @code{finit-integer}
1507 @opindex @code{finit-real}
1508 @opindex @code{finit-logical}
1509 @opindex @code{finit-character}
1510 The @option{-finit-local-zero} option instructs the compiler to
1511 initialize local @code{INTEGER}, @code{REAL}, and @code{COMPLEX}
1512 variables to zero, @code{LOGICAL} variables to false, and
1513 @code{CHARACTER} variables to a string of null bytes.  Finer-grained
1514 initialization options are provided by the
1515 @option{-finit-integer=@var{n}},
1516 @option{-finit-real=@var{<zero|inf|-inf|nan|snan>}} (which also initializes
1517 the real and imaginary parts of local @code{COMPLEX} variables),
1518 @option{-finit-logical=@var{<true|false>}}, and
1519 @option{-finit-character=@var{n}} (where @var{n} is an ASCII character
1520 value) options.  These options do not initialize
1521 @itemize @bullet
1522 @item
1523 allocatable arrays
1524 @item
1525 components of derived type variables
1526 @item
1527 variables that appear in an @code{EQUIVALENCE} statement.
1528 @end itemize
1529 (These limitations may be removed in future releases).
1531 Note that the @option{-finit-real=nan} option initializes @code{REAL}
1532 and @code{COMPLEX} variables with a quiet NaN. For a signalling NaN
1533 use @option{-finit-real=snan}; note, however, that compile-time
1534 optimizations may convert them into quiet NaN and that trapping
1535 needs to be enabled (e.g. via @option{-ffpe-trap}).
1537 Finally, note that enabling any of the @option{-finit-*} options will
1538 silence warnings that would have been emitted by @option{-Wuninitialized}
1539 for the affected local variables.
1541 @item -falign-commons
1542 @opindex @code{falign-commons}
1543 @cindex alignment of @code{COMMON} blocks
1544 By default, @command{gfortran} enforces proper alignment of all variables in a
1545 @code{COMMON} block by padding them as needed. On certain platforms this is mandatory,
1546 on others it increases performance. If a @code{COMMON} block is not declared with
1547 consistent data types everywhere, this padding can cause trouble, and
1548 @option{-fno-align-commons} can be used to disable automatic alignment. The
1549 same form of this option should be used for all files that share a @code{COMMON} block.
1550 To avoid potential alignment issues in @code{COMMON} blocks, it is recommended to order
1551 objects from largest to smallest.
1553 @item -fno-protect-parens
1554 @opindex @code{fno-protect-parens}
1555 @cindex re-association of parenthesized expressions
1556 By default the parentheses in expression are honored for all optimization
1557 levels such that the compiler does not do any re-association. Using
1558 @option{-fno-protect-parens} allows the compiler to reorder @code{REAL} and
1559 @code{COMPLEX} expressions to produce faster code. Note that for the re-association
1560 optimization @option{-fno-signed-zeros} and @option{-fno-trapping-math}
1561 need to be in effect. The parentheses protection is enabled by default, unless
1562 @option{-Ofast} is given.
1564 @item -frealloc-lhs
1565 @opindex @code{frealloc-lhs}
1566 @cindex Reallocate the LHS in assignments
1567 An allocatable left-hand side of an intrinsic assignment is automatically
1568 (re)allocated if it is either unallocated or has a different shape. The
1569 option is enabled by default except when @option{-std=f95} is given. See
1570 also @option{-Wrealloc-lhs}.
1572 @item -faggressive-function-elimination
1573 @opindex @code{faggressive-function-elimination}
1574 @cindex Elimination of functions with identical argument lists
1575 Functions with identical argument lists are eliminated within
1576 statements, regardless of whether these functions are marked
1577 @code{PURE} or not. For example, in
1578 @smallexample
1579   a = f(b,c) + f(b,c)
1580 @end smallexample
1581 there will only be a single call to @code{f}.  This option only works
1582 if @option{-ffrontend-optimize} is in effect.
1584 @item -ffrontend-optimize
1585 @opindex @code{frontend-optimize}
1586 @cindex Front-end optimization
1587 This option performs front-end optimization, based on manipulating
1588 parts the Fortran parse tree.  Enabled by default by any @option{-O}
1589 option.  Optimizations enabled by this option include elimination of
1590 identical function calls within expressions, removing unnecessary
1591 calls to @code{TRIM} in comparisons and assignments and replacing
1592 @code{TRIM(a)} with @code{a(1:LEN_TRIM(a))}. 
1593 It can be deselected by specifying @option{-fno-frontend-optimize}.
1594 @end table
1596 @xref{Code Gen Options,,Options for Code Generation Conventions,
1597 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
1598 offered by the GBE
1599 shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
1601 @c man end
1603 @node Environment Variables
1604 @section Environment variables affecting @command{gfortran}
1605 @cindex environment variable
1607 @c man begin ENVIRONMENT
1609 The @command{gfortran} compiler currently does not make use of any environment
1610 variables to control its operation above and beyond those
1611 that affect the operation of @command{gcc}.
1613 @xref{Environment Variables,,Environment Variables Affecting GCC,
1614 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
1615 variables.
1617 @xref{Runtime}, for environment variables that affect the
1618 run-time behavior of programs compiled with GNU Fortran.
1619 @c man end