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