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