OSDN Git Service

docs: fix typos and markup nits in Fortran manual.
[pf3gnuchains/gcc-fork.git] / gcc / fortran / invoke.texi
1 @c Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
2 @c Free Software Foundation, Inc.
3 @c This is part of the GNU Fortran manual.   
4 @c For copying conditions, see the file gfortran.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
9 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.3 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``Funding Free Software'', the Front-Cover
15 Texts being (a) (see below), and with the Back-Cover Texts being (b)
16 (see below).  A copy of the license is included in the gfdl(7) man page.
17
18 (a) The FSF's Front-Cover Text is:
19
20      A GNU Manual
21
22 (b) The FSF's Back-Cover Text is:
23
24      You have freedom to copy and modify this GNU Manual, like GNU
25      software.  Copies published by the Free Software Foundation raise
26      funds for GNU development.
27 @c man end
28 @c Set file name and title for the man page.
29 @setfilename gfortran
30 @settitle GNU Fortran compiler.
31 @c man begin SYNOPSIS
32 gfortran [@option{-c}|@option{-S}|@option{-E}]
33          [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
34          [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
35          [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
36          [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
37          [@option{-f}@var{option}@dots{}]
38          [@option{-m}@var{machine-option}@dots{}]
39          [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), gcc(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{gfortran}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@value{BUGURL}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gfortran} for contributors to GCC and
56 GNU Fortran.
57 @c man end
58 @end ignore
59
60 @node Invoking GNU Fortran
61 @chapter GNU Fortran Command Options
62 @cindex GNU Fortran command options
63 @cindex command options
64 @cindex options, @command{gfortran} command
65
66 @c man begin DESCRIPTION
67
68 The @command{gfortran} command supports all the options supported by the
69 @command{gcc} command.  Only options specific to GNU Fortran are documented here.
70
71 @xref{Invoking GCC,,GCC Command Options,gcc,Using the GNU Compiler
72 Collection (GCC)}, for information
73 on the non-Fortran-specific aspects of the @command{gcc} command (and,
74 therefore, the @command{gfortran} command).
75
76 @cindex options, negative forms
77 All GCC and GNU Fortran options
78 are accepted both by @command{gfortran} and by @command{gcc}
79 (as well as any other drivers built at the same time,
80 such as @command{g++}),
81 since adding GNU Fortran to the GCC distribution
82 enables acceptance of GNU Fortran options
83 by all of the relevant drivers.
84
85 In some cases, options have positive and negative forms;
86 the negative form of @option{-ffoo} would be @option{-fno-foo}.
87 This manual documents only one of these two forms, whichever
88 one is not the default.
89 @c man end
90
91 @menu
92 * Option Summary::      Brief list of all @command{gfortran} options,
93                         without explanations.
94 * Fortran Dialect Options::  Controlling the variant of Fortran language
95                              compiled.
96 * Preprocessing Options::  Enable and customize preprocessing.
97 * Error and Warning Options::     How picky should the compiler be?
98 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
99 * Directory Options::   Where to find module files
100 * Link Options ::       Influencing the linking step
101 * Runtime Options::     Influencing runtime behavior
102 * Code Gen Options::    Specifying conventions for function calls, data layout
103                         and register usage.
104 * Environment Variables:: Environment variables that affect @command{gfortran}.
105 @end menu
106
107 @node Option Summary
108 @section Option summary
109
110 @c man begin OPTIONS
111
112 Here is a summary of all the options specific to GNU Fortran, grouped
113 by type.  Explanations are in the following sections.
114
115 @table @emph
116 @item Fortran Language Options
117 @xref{Fortran Dialect Options,,Options controlling Fortran dialect}.
118 @gccoptlist{-fall-intrinsics  -ffree-form  -fno-fixed-form @gol
119 -fdollar-ok  -fimplicit-none  -fmax-identifier-length @gol
120 -std=@var{std} -fd-lines-as-code  -fd-lines-as-comments @gol
121 -ffixed-line-length-@var{n}  -ffixed-line-length-none @gol
122 -ffree-line-length-@var{n}  -ffree-line-length-none @gol
123 -fdefault-double-8  -fdefault-integer-8  -fdefault-real-8 @gol
124 -fcray-pointer  -fopenmp  -fno-range-check -fbackslash -fmodule-private}
125
126 @item Preprocessing Options
127 @xref{Preprocessing Options,,Enable and customize preprocessing}.
128 @gccoptlist{-cpp -dD -dI -dM -dN -dU -fworking-directory @gol
129 -imultilib @var{dir} -iprefix @var{file} -isysroot @var{dir} @gol
130 -iquote -isystem @var{dir} -nocpp -nostdinc -undef @gol
131 -A@var{question}=@var{answer} -A-@var{question}@r{[}=@var{answer}@r{]} @gol
132 -C -CC -D@var{macro}@r{[}=@var{defn}@r{]} -U@var{macro} -H -P}
133
134 @item Error and Warning Options
135 @xref{Error and Warning Options,,Options to request or suppress errors
136 and warnings}.
137 @gccoptlist{-fmax-errors=@var{n} @gol
138 -fsyntax-only  -pedantic  -pedantic-errors @gol
139 -Wall  -Waliasing  -Wampersand  -Warray-bounds -Wcharacter-truncation @gol
140 -Wconversion -Wimplicit-interface  -Wimplicit-procedure  -Wline-truncation @gol
141 -Wintrinsics-std  -Wsurprising  -Wno-tabs  -Wunderflow  -Wunused-parameter @gol
142 -Wintrinsic-shadow  -Wno-align-commons}
143
144 @item Debugging Options
145 @xref{Debugging Options,,Options for debugging your program or GNU Fortran}.
146 @gccoptlist{-fdump-fortran-original  -fdump-fortran-optimized @gol
147 -ffpe-trap=@var{list}  -fdump-core -fbacktrace -fdump-parse-tree}
148
149 @item Directory Options
150 @xref{Directory Options,,Options for directory search}.
151 @gccoptlist{-I@var{dir}  -J@var{dir} -fintrinsic-modules-path @var{dir}}
152
153 @item Link Options
154 @xref{Link Options,,Options for influencing the linking step}.
155 @gccoptlist{-static-libgfortran}
156
157 @item Runtime Options
158 @xref{Runtime Options,,Options for influencing runtime behavior}.
159 @gccoptlist{-fconvert=@var{conversion}  -fno-range-check
160 -frecord-marker=@var{length} @gol  -fmax-subrecord-length=@var{length}
161 -fsign-zero}
162
163 @item Code Generation Options
164 @xref{Code Gen Options,,Options for code generation conventions}.
165 @gccoptlist{-fno-automatic  -ff2c  -fno-underscoring @gol
166 -fwhole-file -fsecond-underscore @gol
167 -fbounds-check -fcheck-array-temporaries  -fmax-array-constructor =@var{n} @gol
168 -fcheck=@var{<all|array-temps|bounds|do|mem|pointer|recursion>} @gol
169 -fcoarray=@var{<none|single>} -fmax-stack-var-size=@var{n} @gol
170 -fpack-derived  -frepack-arrays  -fshort-enums  -fexternal-blas @gol
171 -fblas-matmul-limit=@var{n} -frecursive -finit-local-zero @gol
172 -finit-integer=@var{n} -finit-real=@var{<zero|inf|-inf|nan|snan>} @gol
173 -finit-logical=@var{<true|false>} -finit-character=@var{n} @gol
174 -fno-align-commons -fno-protect-parens -frealloc-lhs}
175 @end table
176
177 @menu
178 * Fortran Dialect Options::  Controlling the variant of Fortran language
179                              compiled.
180 * Preprocessing Options::  Enable and customize preprocessing.
181 * Error and Warning Options::     How picky should the compiler be?
182 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
183 * Directory Options::   Where to find module files
184 * Link Options ::       Influencing the linking step
185 * Runtime Options::     Influencing runtime behavior
186 * Code Gen Options::    Specifying conventions for function calls, data layout
187                         and register usage.
188 @end menu
189
190 @node Fortran Dialect Options
191 @section Options controlling Fortran dialect
192 @cindex dialect options
193 @cindex language, dialect options
194 @cindex options, dialect
195
196 The following options control the details of the Fortran dialect
197 accepted by the compiler:
198
199 @table @gcctabopt
200 @item -ffree-form
201 @itemx -ffixed-form
202 @opindex @code{ffree-form}
203 @opindex @code{fno-fixed-form}
204 @cindex options, fortran dialect
205 @cindex file format, free
206 @cindex file format, fixed
207 Specify the layout used by the source file.  The free form layout
208 was introduced in Fortran 90.  Fixed form was traditionally used in
209 older Fortran programs.  When neither option is specified, the source
210 form is determined by the file extension.
211
212 @item -fall-intrinsics
213 @opindex @code{fall-intrinsics}
214 This option causes all intrinsic procedures (including the GNU-specific
215 extensions) to be accepted.  This can be useful with @option{-std=f95} to
216 force standard-compliance but get access to the full range of intrinsics
217 available with @command{gfortran}.  As a consequence, @option{-Wintrinsics-std}
218 will be ignored and no user-defined procedure with the same name as any
219 intrinsic will be called except when it is explicitly declared @code{EXTERNAL}.
220
221 @item -fd-lines-as-code
222 @itemx -fd-lines-as-comments
223 @opindex @code{fd-lines-as-code}
224 @opindex @code{fd-lines-as-comments}
225 Enable special treatment for lines beginning with @code{d} or @code{D}
226 in fixed form sources.  If the @option{-fd-lines-as-code} option is
227 given they are treated as if the first column contained a blank.  If the
228 @option{-fd-lines-as-comments} option is given, they are treated as
229 comment lines.
230
231 @item -fdefault-double-8
232 @opindex @code{fdefault-double-8}
233 Set the @code{DOUBLE PRECISION} type to an 8 byte wide type.  If
234 @option{-fdefault-real-8} is given, @code{DOUBLE PRECISION} would
235 instead be promoted to 16 bytes if possible, and @option{-fdefault-double-8}
236 can be used to prevent this.  The kind of real constants like @code{1.d0} will
237 not be changed by @option{-fdefault-real-8} though, so also
238 @option{-fdefault-double-8} does not affect it.
239
240 @item -fdefault-integer-8
241 @opindex @code{fdefault-integer-8}
242 Set the default integer and logical types to an 8 byte wide type.
243 Do nothing if this is already the default.  This option also affects
244 the kind of integer constants like @code{42}.
245
246 @item -fdefault-real-8
247 @opindex @code{fdefault-real-8}
248 Set the default real type to an 8 byte wide type.
249 Do nothing if this is already the default.  This option also affects
250 the kind of non-double real constants like @code{1.0}, and does promote
251 the default width of @code{DOUBLE PRECISION} to 16 bytes if possible, unless
252 @code{-fdefault-double-8} is given, too.
253
254 @item -fdollar-ok
255 @opindex @code{fdollar-ok}
256 @cindex @code{$}
257 @cindex symbol names
258 @cindex character set
259 Allow @samp{$} as a valid non-first character in a symbol name. Symbols 
260 that start with @samp{$} are rejected since it is unclear which rules to
261 apply to implicit typing as different vendors implement different rules.
262 Using @samp{$} in @code{IMPLICIT} statements is also rejected.
263
264 @item -fbackslash
265 @opindex @code{backslash}
266 @cindex backslash
267 @cindex escape characters
268 Change the interpretation of backslashes in string literals from a single
269 backslash character to ``C-style'' escape characters. The following
270 combinations are expanded @code{\a}, @code{\b}, @code{\f}, @code{\n},
271 @code{\r}, @code{\t}, @code{\v}, @code{\\}, and @code{\0} to the ASCII
272 characters alert, backspace, form feed, newline, carriage return,
273 horizontal tab, vertical tab, backslash, and NUL, respectively.
274 Additionally, @code{\x}@var{nn}, @code{\u}@var{nnnn} and
275 @code{\U}@var{nnnnnnnn} (where each @var{n} is a hexadecimal digit) are
276 translated into the Unicode characters corresponding to the specified code
277 points. All other combinations of a character preceded by \ are
278 unexpanded.
279
280 @item -fmodule-private
281 @opindex @code{fmodule-private}
282 @cindex module entities
283 @cindex private
284 Set the default accessibility of module entities to @code{PRIVATE}.
285 Use-associated entities will not be accessible unless they are explicitly
286 declared as @code{PUBLIC}.
287
288 @item -ffixed-line-length-@var{n}
289 @opindex @code{ffixed-line-length-}@var{n}
290 @cindex file format, fixed
291 Set column after which characters are ignored in typical fixed-form
292 lines in the source file, and through which spaces are assumed (as
293 if padded to that length) after the ends of short fixed-form lines.
294
295 Popular values for @var{n} include 72 (the
296 standard and the default), 80 (card image), and 132 (corresponding
297 to ``extended-source'' options in some popular compilers).
298 @var{n} may also be @samp{none}, meaning that the entire line is meaningful
299 and that continued character constants never have implicit spaces appended
300 to them to fill out the line.
301 @option{-ffixed-line-length-0} means the same thing as
302 @option{-ffixed-line-length-none}.
303
304 @item -ffree-line-length-@var{n}
305 @opindex @code{ffree-line-length-}@var{n}
306 @cindex file format, free
307 Set column after which characters are ignored in typical free-form
308 lines in the source file. The default value is 132.
309 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
310 @option{-ffree-line-length-0} means the same thing as
311 @option{-ffree-line-length-none}.
312
313 @item -fmax-identifier-length=@var{n}
314 @opindex @code{fmax-identifier-length=}@var{n}
315 Specify the maximum allowed identifier length. Typical values are
316 31 (Fortran 95) and 63 (Fortran 2003 and Fortran 2008).
317
318 @item -fimplicit-none
319 @opindex @code{fimplicit-none}
320 Specify that no implicit typing is allowed, unless overridden by explicit
321 @code{IMPLICIT} statements.  This is the equivalent of adding
322 @code{implicit none} to the start of every procedure.
323
324 @item -fcray-pointer
325 @opindex @code{fcray-pointer}
326 Enable the Cray pointer extension, which provides C-like pointer
327 functionality.
328
329 @item -fopenmp
330 @opindex @code{fopenmp}
331 @cindex OpenMP
332 Enable the OpenMP extensions.  This includes OpenMP @code{!$omp} directives
333 in free form
334 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
335 @code{!$} conditional compilation sentinels in free form
336 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form, 
337 and when linking arranges for the OpenMP runtime library to be linked
338 in.  The option @option{-fopenmp} implies @option{-frecursive}.
339
340 @item -fno-range-check
341 @opindex @code{frange-check}
342 Disable range checking on results of simplification of constant
343 expressions during compilation.  For example, GNU Fortran will give
344 an error at compile time when simplifying @code{a = 1. / 0}.
345 With this option, no error will be given and @code{a} will be assigned
346 the value @code{+Infinity}.  If an expression evaluates to a value
347 outside of the relevant range of [@code{-HUGE()}:@code{HUGE()}],
348 then the expression will be replaced by @code{-Inf} or @code{+Inf}
349 as appropriate.
350 Similarly, @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow
351 on most systems, but with @option{-fno-range-check} the value will
352 ``wrap around'' and @code{i} will be initialized to @math{-1} instead.
353
354 @item -std=@var{std}
355 @opindex @code{std=}@var{std} option
356 Specify the standard to which the program is expected to conform, which
357 may be one of @samp{f95}, @samp{f2003}, @samp{f2008}, @samp{gnu}, or
358 @samp{legacy}.  The default value for @var{std} is @samp{gnu}, which
359 specifies a superset of the Fortran 95 standard that includes all of the
360 extensions supported by GNU Fortran, although warnings will be given for
361 obsolete extensions not recommended for use in new code.  The
362 @samp{legacy} value is equivalent but without the warnings for obsolete
363 extensions, and may be useful for old non-standard programs.  The
364 @samp{f95}, @samp{f2003} and @samp{f2008} values specify strict
365 conformance to the Fortran 95, Fortran 2003 and Fortran 2008 standards,
366 respectively; errors are given for all extensions beyond the relevant
367 language standard, and warnings are given for the Fortran 77 features
368 that are permitted but obsolescent in later standards.
369
370 @end table
371
372 @node Preprocessing Options
373 @section Enable and customize preprocessing
374 @cindex preprocessor
375 @cindex options, preprocessor
376 @cindex CPP
377
378 Preprocessor related options. See section 
379 @ref{Preprocessing and conditional compilation} for more detailed
380 information on preprocessing in @command{gfortran}.
381
382 @table @gcctabopt
383 @item -cpp
384 @itemx -nocpp
385 @opindex @code{cpp}
386 @opindex @code{fpp}
387 @cindex preprocessor, enable
388 @cindex preprocessor, disable
389 Enable preprocessing. The preprocessor is automatically invoked if
390 the file extension is @file{.fpp}, @file{.FPP},  @file{.F}, @file{.FOR},
391 @file{.FTN}, @file{.F90}, @file{.F95}, @file{.F03} or @file{.F08}. Use
392 this option to manually enable preprocessing of any kind of Fortran file.
393
394 To disable preprocessing of files with any of the above listed extensions,
395 use the negative form: @option{-nocpp}.
396
397 The preprocessor is run in traditional mode. Any restrictions of the
398 file-format, especially the limits on line length, apply for
399 preprocessed output as well, so it might be advisable to use the
400 @option{-ffree-line-length-none} or @option{-ffixed-line-length-none}
401 options.
402
403 @item -dM
404 @opindex @code{dM}
405 @cindex preprocessor, debugging
406 @cindex debugging, preprocessor
407 Instead of the normal output, generate a list of @code{'#define'}
408 directives for all the macros defined during the execution of the
409 preprocessor, including predefined macros. This gives you a way
410 of finding out what is predefined in your version of the preprocessor.
411 Assuming you have no file @file{foo.f90}, the command
412 @smallexample
413   touch foo.f90; gfortran -cpp -E -dM foo.f90
414 @end smallexample
415 will show all the predefined macros.
416
417 @item -dD
418 @opindex @code{dD}
419 @cindex preprocessor, debugging
420 @cindex debugging, preprocessor
421 Like @option{-dM} except in two respects: it does not include the
422 predefined macros, and it outputs both the @code{#define} directives
423 and the result of preprocessing. Both kinds of output go to the
424 standard output file.
425
426 @item -dN
427 @opindex @code{dN}
428 @cindex preprocessor, debugging
429 @cindex debugging, preprocessor
430 Like @option{-dD}, but emit only the macro names, not their expansions.
431
432 @item -dU
433 @opindex @code{dU}
434 @cindex preprocessor, debugging
435 @cindex debugging, preprocessor
436 Like @option{dD} except that only macros that are expanded, or whose
437 definedness is tested in preprocessor directives, are output; the 
438 output is delayed until the use or test of the macro; and @code{'#undef'}
439 directives are also output for macros tested but undefined at the time.
440
441 @item -dI
442 @opindex @code{dI}
443 @cindex preprocessor, debugging
444 @cindex debugging, preprocessor
445 Output @code{'#include'} directives in addition to the result
446 of preprocessing.
447
448 @item -fworking-directory
449 @opindex @code{fworking-directory}
450 @cindex preprocessor, working directory
451 Enable generation of linemarkers in the preprocessor output that will
452 let the compiler know the current working directory at the time of
453 preprocessing. When this option is enabled, the preprocessor will emit,
454 after the initial linemarker, a second linemarker with the current
455 working directory followed by two slashes. GCC will use this directory,
456 when it's present in the preprocessed input, as the directory emitted
457 as the current working directory in some debugging information formats.
458 This option is implicitly enabled if debugging information is enabled,
459 but this can be inhibited with the negated form
460 @option{-fno-working-directory}. If the @option{-P} flag is present
461 in the command line, this option has no effect, since no @code{#line}
462 directives are emitted whatsoever.
463
464 @item -idirafter @var{dir}
465 @opindex @code{idirafter @var{dir}}
466 @cindex preprocessing, include path
467 Search @var{dir} for include files, but do it after all directories
468 specified with @option{-I} and the standard system directories have
469 been exhausted. @var{dir} is treated as a system include directory.
470 If dir begins with @code{=}, then the @code{=} will be replaced by
471 the sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
472
473 @item -imultilib @var{dir}
474 @opindex @code{imultilib @var{dir}}
475 @cindex preprocessing, include path
476 Use @var{dir} as a subdirectory of the directory containing target-specific
477 C++ headers.
478
479 @item -iprefix @var{prefix}
480 @opindex @code{iprefix @var{prefix}}
481 @cindex preprocessing, include path
482 Specify @var{prefix} as the prefix for subsequent @option{-iwithprefix}
483 options. If the @var{prefix} represents a directory, you should include
484 the final @code{'/'}.
485
486 @item -isysroot @var{dir}
487 @opindex @code{isysroot @var{dir}}
488 @cindex preprocessing, include path
489 This option is like the @option{--sysroot} option, but applies only to
490 header files. See the @option{--sysroot} option for more information.
491
492 @item -iquote @var{dir}
493 @opindex @code{iquote @var{dir}}
494 @cindex preprocessing, include path
495 Search @var{dir} only for header files requested with @code{#include "file"};
496 they are not searched for @code{#include <file>}, before all directories
497 specified by @option{-I} and before the standard system directories. If
498 @var{dir} begins with @code{=}, then the @code{=} will be replaced by the
499 sysroot prefix; see @option{--sysroot} and @option{-isysroot}.
500
501 @item -isystem @var{dir}
502 @opindex @code{isystem @var{dir}}
503 @cindex preprocessing, include path
504 Search @var{dir} for header files, after all directories specified by
505 @option{-I} but before the standard system directories. Mark it as a
506 system directory, so that it gets the same special treatment as is
507 applied to the standard system directories. If @var{dir} begins with
508 @code{=}, then the @code{=} will be replaced by the sysroot prefix;
509 see @option{--sysroot} and @option{-isysroot}.
510
511 @item -nostdinc
512 @opindex @code{nostdinc}
513 Do not search the standard system directories for header files. Only
514 the directories you have specified with @option{-I} options (and the
515 directory of the current file, if appropriate) are searched.
516
517 @item -undef
518 @opindex @code{undef}
519 Do not predefine any system-specific or GCC-specific macros.
520 The standard predefined macros remain defined.
521
522 @item -A@var{predicate}=@var{answer}
523 @opindex @code{A@var{predicate}=@var{answer}}
524 @cindex preprocessing, assertion
525 Make an assertion with the predicate @var{predicate} and answer @var{answer}.
526 This form is preferred to the older form -A predicate(answer), which is still
527 supported, because it does not use shell special characters.
528
529 @item -A-@var{predicate}=@var{answer}
530 @opindex @code{A-@var{predicate}=@var{answer}}
531 @cindex preprocessing, assertion
532 Cancel an assertion with the predicate @var{predicate} and answer @var{answer}.
533
534 @item -C
535 @opindex @code{C}
536 @cindex preprocessing, keep comments
537 Do not discard comments. All comments are passed through to the output
538 file, except for comments in processed directives, which are deleted
539 along with the directive.
540
541 You should be prepared for side effects when using @option{-C}; it causes
542 the preprocessor to treat comments as tokens in their own right. For example,
543 comments appearing at the start of what would be a directive line have the
544 effect of turning that line into an ordinary source line, since the first
545 token on the line is no longer a @code{'#'}.
546
547 Warning: this currently handles C-Style comments only. The preprocessor
548 does not yet recognize Fortran-style comments.
549
550 @item -CC
551 @opindex @code{CC}
552 @cindex preprocessing, keep comments
553 Do not discard comments, including during macro expansion. This is like
554 @option{-C}, except that comments contained within macros are also passed
555 through to the output file where the macro is expanded.
556
557 In addition to the side-effects of the @option{-C} option, the @option{-CC}
558 option causes all C++-style comments inside a macro to be converted to C-style
559 comments. This is to prevent later use of that macro from inadvertently
560 commenting out the remainder of the source line. The @option{-CC} option
561 is generally used to support lint comments.
562
563 Warning: this currently handles C- and C++-Style comments only. The
564 preprocessor does not yet recognize Fortran-style comments.
565
566 @item -D@var{name}
567 @opindex @code{D@var{name}}
568 @cindex preprocessing, define macros
569 Predefine name as a macro, with definition @code{1}.
570
571 @item -D@var{name}=@var{definition}
572 @opindex @code{D@var{name}=@var{definition}}
573 @cindex preprocessing, define macros
574 The contents of @var{definition} are tokenized and processed as if they
575 appeared during translation phase three in a @code{'#define'} directive.
576 In particular, the definition will be truncated by embedded newline
577 characters.
578
579 If you are invoking the preprocessor from a shell or shell-like program
580 you may need to use the shell's quoting syntax to protect characters such
581 as spaces that have a meaning in the shell syntax.
582
583 If you wish to define a function-like macro on the command line, write
584 its argument list with surrounding parentheses before the equals sign
585 (if any). Parentheses are meaningful to most shells, so you will need
586 to quote the option. With sh and csh, @code{-D'name(args...)=definition'}
587 works.
588
589 @option{-D} and @option{-U} options are processed in the order they are
590 given on the command line. All -imacros file and -include file options
591 are processed after all -D and -U options.
592
593 @item -H
594 @opindex @code{H}
595 Print the name of each header file used, in addition to other normal
596 activities. Each name is indented to show how deep in the @code{'#include'}
597 stack it is.
598
599 @item -P
600 @opindex @code{P}
601 @cindex preprocessing, no linemarkers
602 Inhibit generation of linemarkers in the output from the preprocessor.
603 This might be useful when running the preprocessor on something that
604 is not C code, and will be sent to a program which might be confused
605 by the linemarkers.
606
607 @item -U@var{name}
608 @opindex @code{U@var{name}}
609 @cindex preprocessing, undefine macros
610 Cancel any previous definition of @var{name}, either built in or provided
611 with a @option{-D} option.
612 @end table
613
614
615 @node Error and Warning Options
616 @section Options to request or suppress errors and warnings
617 @cindex options, warnings
618 @cindex options, errors
619 @cindex warnings, suppressing
620 @cindex messages, error
621 @cindex messages, warning
622 @cindex suppressing warnings
623
624 Errors are diagnostic messages that report that the GNU Fortran compiler
625 cannot compile the relevant piece of source code.  The compiler will
626 continue to process the program in an attempt to report further errors
627 to aid in debugging, but will not produce any compiled output.  
628
629 Warnings are diagnostic messages that report constructions which
630 are not inherently erroneous but which are risky or suggest there is
631 likely to be a bug in the program.  Unless @option{-Werror} is specified,
632 they do not prevent compilation of the program.
633
634 You can request many specific warnings with options beginning @option{-W},
635 for example @option{-Wimplicit} to request warnings on implicit
636 declarations.  Each of these specific warning options also has a
637 negative form beginning @option{-Wno-} to turn off warnings;
638 for example, @option{-Wno-implicit}.  This manual lists only one of the
639 two forms, whichever is not the default.
640
641 These options control the amount and kinds of errors and warnings produced
642 by GNU Fortran:
643
644 @table @gcctabopt
645 @item -fmax-errors=@var{n}
646 @opindex @code{fmax-errors=}@var{n}
647 @cindex errors, limiting
648 Limits the maximum number of error messages to @var{n}, at which point
649 GNU Fortran bails out rather than attempting to continue processing the
650 source code.  If @var{n} is 0, there is no limit on the number of error
651 messages produced.
652
653 @item -fsyntax-only
654 @opindex @code{fsyntax-only}
655 @cindex syntax checking
656 Check the code for syntax errors, but don't actually compile it.  This
657 will generate module files for each module present in the code, but no
658 other output file.
659
660 @item -pedantic
661 @opindex @code{pedantic}
662 Issue warnings for uses of extensions to Fortran 95.
663 @option{-pedantic} also applies to C-language constructs where they
664 occur in GNU Fortran source files, such as use of @samp{\e} in a
665 character constant within a directive like @code{#include}.
666
667 Valid Fortran 95 programs should compile properly with or without
668 this option.
669 However, without this option, certain GNU extensions and traditional
670 Fortran features are supported as well.
671 With this option, many of them are rejected.
672
673 Some users try to use @option{-pedantic} to check programs for conformance.
674 They soon find that it does not do quite what they want---it finds some
675 nonstandard practices, but not all.
676 However, improvements to GNU Fortran in this area are welcome.
677
678 This should be used in conjunction with @option{-std=f95},
679 @option{-std=f2003} or @option{-std=f2008}.
680
681 @item -pedantic-errors
682 @opindex @code{pedantic-errors}
683 Like @option{-pedantic}, except that errors are produced rather than
684 warnings.
685
686 @item -Wall
687 @opindex @code{Wall}
688 @cindex all warnings
689 @cindex warnings, all
690 Enables commonly used warning options pertaining to usage that
691 we recommend avoiding and that we believe are easy to avoid.
692 This currently includes @option{-Waliasing}, @option{-Wampersand}, 
693 @option{-Wconversion}, @option{-Wsurprising}, @option{-Wintrinsics-std},
694 @option{-Wno-tabs}, @option{-Wintrinsic-shadow}, @option{-Wline-truncation},
695 and @option{-Wunused}.
696
697 @item -Waliasing
698 @opindex @code{Waliasing}
699 @cindex aliasing
700 @cindex warnings, aliasing
701 Warn about possible aliasing of dummy arguments. Specifically, it warns
702 if the same actual argument is associated with a dummy argument with
703 @code{INTENT(IN)} and a dummy argument with @code{INTENT(OUT)} in a call
704 with an explicit interface.
705
706 The following example will trigger the warning.
707 @smallexample
708   interface
709     subroutine bar(a,b)
710       integer, intent(in) :: a
711       integer, intent(out) :: b
712     end subroutine
713   end interface
714   integer :: a
715
716   call bar(a,a)
717 @end smallexample
718
719 @item -Wampersand
720 @opindex @code{Wampersand}
721 @cindex warnings, ampersand
722 @cindex @code{&}
723 Warn about missing ampersand in continued character constants. The warning is
724 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95},
725 @option{-std=f2003} and @option{-std=f2008}. Note: With no ampersand
726 given in a continued character constant, GNU Fortran assumes continuation
727 at the first non-comment, non-whitespace character after the ampersand
728 that initiated the continuation.
729
730 @item -Warray-temporaries
731 @opindex @code{Warray-temporaries}
732 @cindex warnings, array temporaries
733 Warn about array temporaries generated by the compiler.  The information
734 generated by this warning is sometimes useful in optimization, in order to
735 avoid such temporaries.
736
737 @item -Wcharacter-truncation
738 @opindex @code{Wcharacter-truncation}
739 @cindex warnings, character truncation
740 Warn when a character assignment will truncate the assigned string.
741
742 @item -Wline-truncation
743 @opindex @code{Wline-truncation}
744 @cindex warnings, line truncation
745 Warn when a source code line will be truncated.
746
747 @item -Wconversion
748 @opindex @code{Wconversion}
749 @cindex warnings, conversion
750 @cindex conversion
751 Warn about implicit conversions that are likely to change the value of 
752 the expression after conversion. Implied by @option{-Wall}.
753
754 @item -Wconversion-extra
755 @opindex @code{Wconversion-extra}
756 @cindex warnings, conversion
757 @cindex conversion
758 Warn about implicit conversions between different types and kinds.
759
760 @item -Wimplicit-interface
761 @opindex @code{Wimplicit-interface}
762 @cindex warnings, implicit interface
763 Warn if a procedure is called without an explicit interface.
764 Note this only checks that an explicit interface is present.  It does not
765 check that the declared interfaces are consistent across program units.
766
767 @item -Wimplicit-procedure
768 @opindex @code{Wimplicit-procedure}
769 @cindex warnings, implicit procedure
770 Warn if a procedure is called that has neither an explicit interface
771 nor has been declared as @code{EXTERNAL}.
772
773 @item -Wintrinsics-std
774 @opindex @code{Wintrinsics-std}
775 @cindex warnings, non-standard intrinsics
776 @cindex warnings, intrinsics of other standards
777 Warn if @command{gfortran} finds a procedure named like an intrinsic not
778 available in the currently selected standard (with @option{-std}) and treats
779 it as @code{EXTERNAL} procedure because of this.  @option{-fall-intrinsics} can
780 be used to never trigger this behavior and always link to the intrinsic
781 regardless of the selected standard.
782
783 @item -Wsurprising
784 @opindex @code{Wsurprising}
785 @cindex warnings, suspicious code
786 Produce a warning when ``suspicious'' code constructs are encountered.
787 While technically legal these usually indicate that an error has been made.
788
789 This currently produces a warning under the following circumstances:
790
791 @itemize @bullet
792 @item
793 An INTEGER SELECT construct has a CASE that can never be matched as its
794 lower value is greater than its upper value.
795
796 @item
797 A LOGICAL SELECT construct has three CASE statements.
798
799 @item
800 A TRANSFER specifies a source that is shorter than the destination.
801
802 @item
803 The type of a function result is declared more than once with the same type.  If
804 @option{-pedantic} or standard-conforming mode is enabled, this is an error.
805
806 @item
807 A @code{CHARACTER} variable is declared with negative length.
808 @end itemize
809
810 @item -Wtabs
811 @opindex @code{Wtabs}
812 @cindex warnings, tabs
813 @cindex tabulators
814 By default, tabs are accepted as whitespace, but tabs are not members
815 of the Fortran Character Set.  For continuation lines, a tab followed
816 by a digit between 1 and 9 is supported.  @option{-Wno-tabs} will cause
817 a warning to be issued if a tab is encountered. Note, @option{-Wno-tabs}
818 is active for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003},
819 @option{-std=f2008} and @option{-Wall}.
820
821 @item -Wunderflow
822 @opindex @code{Wunderflow}
823 @cindex warnings, underflow
824 @cindex underflow
825 Produce a warning when numerical constant expressions are
826 encountered, which yield an UNDERFLOW during compilation.
827
828 @item -Wintrinsic-shadow
829 @opindex @code{Wintrinsic-shadow}
830 @cindex warnings, intrinsic
831 @cindex intrinsic
832 Warn if a user-defined procedure or module procedure has the same name as an
833 intrinsic; in this case, an explicit interface or @code{EXTERNAL} or
834 @code{INTRINSIC} declaration might be needed to get calls later resolved to
835 the desired intrinsic/procedure.
836
837 @item -Wunused-dummy-argument
838 @opindex @code{Wunused-dummy-argument}
839 @cindex warnings, unused dummy argument
840 @cindex unused dummy argument
841 @cindex dummy argument, unused
842 Warn about unused dummy arguments. This option is implied by @option{-Wall}.
843
844 @item -Wunused-parameter
845 @opindex @code{Wunused-parameter}
846 @cindex warnings, unused parameter
847 @cindex unused parameter
848 Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
849 @command{gfortran}'s implementation of this option does not warn
850 about unused dummy arguments (see @option{-Wunused-dummy-argument}),
851 but about unused @code{PARAMETER} values. @option{-Wunused-parameter}
852 is not included in @option{-Wall} but is implied by @option{-Wall -Wextra}.
853
854 @item -Walign-commons
855 @opindex @code{Walign-commons}
856 @cindex warnings, alignment of @code{COMMON} blocks
857 @cindex alignment of @code{COMMON} blocks
858 By default, @command{gfortran} warns about any occasion of variables being
859 padded for proper alignment inside a @code{COMMON} block. This warning can be turned
860 off via @option{-Wno-align-commons}. See also @option{-falign-commons}.
861
862 @item -Werror
863 @opindex @code{Werror}
864 @cindex warnings, to errors
865 Turns all warnings into errors.
866 @end table
867
868 @xref{Warning Options,,Options to Request or Suppress Errors and
869 Warnings, gcc,Using the GNU Compiler Collection (GCC)}, for information on
870 more options offered by the GBE shared by @command{gfortran}, @command{gcc}
871 and other GNU compilers.
872
873 Some of these have no effect when compiling programs written in Fortran.
874
875 @node Debugging Options
876 @section Options for debugging your program or GNU Fortran
877 @cindex options, debugging
878 @cindex debugging information options
879
880 GNU Fortran has various special options that are used for debugging
881 either your program or the GNU Fortran compiler.
882
883 @table @gcctabopt
884 @item -fdump-fortran-original
885 @opindex @code{fdump-fortran-original}
886 Output the internal parse tree after translating the source program
887 into internal representation.  Only really useful for debugging the
888 GNU Fortran compiler itself.
889
890 @item -fdump-optimized-tree
891 @opindex @code{fdump-fortran-optimized}
892 Output the parse tree after front-end optimization.  Only really
893 useful for debugging the GNU Fortran compiler itself.
894
895 @opindex @code{fdump-parse-tree}
896 Output the internal parse tree after translating the source program
897 into internal representation.  Only really useful for debugging the
898 GNU Fortran compiler itself.  This option is deprecated; use
899 @code{-fdump-fortran-original} instead.
900
901 @item -ffpe-trap=@var{list}
902 @opindex @code{ffpe-trap=}@var{list}
903 Specify a list of IEEE exceptions when a Floating Point Exception
904 (FPE) should be raised.  On most systems, this will result in a SIGFPE
905 signal being sent and the program being interrupted, producing a core
906 file useful for debugging.  @var{list} is a (possibly empty) comma-separated
907 list of the following IEEE exceptions: @samp{invalid} (invalid floating
908 point operation, such as @code{SQRT(-1.0)}), @samp{zero} (division by
909 zero), @samp{overflow} (overflow in a floating point operation),
910 @samp{underflow} (underflow in a floating point operation),
911 @samp{precision} (loss of precision during operation) and @samp{denormal}
912 (operation produced a denormal value).
913
914 Some of the routines in the Fortran runtime library, like
915 @samp{CPU_TIME}, are likely to trigger floating point exceptions when
916 @code{ffpe-trap=precision} is used. For this reason, the use of 
917 @code{ffpe-trap=precision} is not recommended.
918
919 @item -fbacktrace
920 @opindex @code{fbacktrace}
921 @cindex backtrace
922 @cindex trace
923 Specify that, when a runtime error is encountered or a deadly signal is
924 emitted (segmentation fault, illegal instruction, bus error or
925 floating-point exception), the Fortran runtime
926 library should output a backtrace of the error.  This option
927 only has influence for compilation of the Fortran main program.
928
929 @item -fdump-core
930 @cindex core, dump
931 @opindex @code{fdump-core}
932 Request that a core-dump file is written to disk when a runtime error
933 is encountered on systems that support core dumps. This option is
934 only effective for the compilation of the Fortran main program.
935 @end table
936
937 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
938 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
939 debugging options.
940
941 @node Directory Options
942 @section Options for directory search
943 @cindex directory, options
944 @cindex options, directory search
945 @cindex search path
946 @cindex @code{INCLUDE} directive
947 @cindex directive, @code{INCLUDE}
948 These options affect how GNU Fortran searches
949 for files specified by the @code{INCLUDE} directive and where it searches
950 for previously compiled modules.
951
952 It also affects the search paths used by @command{cpp} when used to preprocess
953 Fortran source.
954
955 @table @gcctabopt
956 @item -I@var{dir}
957 @opindex @code{I}@var{dir}
958 @cindex directory, search paths for inclusion
959 @cindex inclusion, directory search paths for
960 @cindex search paths, for included files
961 @cindex paths, search
962 @cindex module search path
963 These affect interpretation of the @code{INCLUDE} directive
964 (as well as of the @code{#include} directive of the @command{cpp}
965 preprocessor).
966
967 Also note that the general behavior of @option{-I} and
968 @code{INCLUDE} is pretty much the same as of @option{-I} with
969 @code{#include} in the @command{cpp} preprocessor, with regard to
970 looking for @file{header.gcc} files and other such things.
971
972 This path is also used to search for @file{.mod} files when previously
973 compiled modules are required by a @code{USE} statement.
974
975 @xref{Directory Options,,Options for Directory Search,
976 gcc,Using the GNU Compiler Collection (GCC)}, for information on the
977 @option{-I} option.
978
979 @item -J@var{dir}
980 @opindex @code{J}@var{dir}
981 @opindex @code{M}@var{dir}
982 @cindex paths, search
983 @cindex module search path
984 This option specifies where to put @file{.mod} files for compiled modules.
985 It is also added to the list of directories to searched by an @code{USE}
986 statement.
987
988 The default is the current directory.
989
990 @item -fintrinsic-modules-path @var{dir}
991 @opindex @code{fintrinsic-modules-path} @var{dir}
992 @cindex paths, search
993 @cindex module search path
994 This option specifies the location of pre-compiled intrinsic modules, if
995 they are not in the default location expected by the compiler.
996 @end table
997
998 @node Link Options
999 @section Influencing the linking step
1000 @cindex options, linking
1001 @cindex linking, static
1002
1003 These options come into play when the compiler links object files into an 
1004 executable output file. They are meaningless if the compiler is not doing 
1005 a link step.
1006
1007 @table @gcctabopt
1008 @item -static-libgfortran
1009 @opindex @code{static-libgfortran}
1010 On systems that provide @file{libgfortran} as a shared and a static
1011 library, this option forces the use of the static version. If no
1012 shared version of @file{libgfortran} was built when the compiler was
1013 configured, this option has no effect.
1014 @end table
1015
1016
1017 @node Runtime Options
1018 @section Influencing runtime behavior
1019 @cindex options, runtime
1020
1021 These options affect the runtime behavior of programs compiled with GNU Fortran.
1022
1023 @table @gcctabopt
1024 @item -fconvert=@var{conversion}
1025 @opindex @code{fconvert=}@var{conversion}
1026 Specify the representation of data for unformatted files.  Valid
1027 values for conversion are: @samp{native}, the default; @samp{swap},
1028 swap between big- and little-endian; @samp{big-endian}, use big-endian
1029 representation for unformatted files; @samp{little-endian}, use little-endian
1030 representation for unformatted files.
1031
1032 @emph{This option has an effect only when used in the main program.
1033 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
1034 variable override the default specified by @option{-fconvert}.}
1035
1036
1037 @item -fno-range-check
1038 @opindex @code{fno-range-check}
1039 Disable range checking of input values during integer @code{READ} operations.
1040 For example, GNU Fortran will give an error if an input value is
1041 outside of the relevant range of [@code{-HUGE()}:@code{HUGE()}]. In other words,
1042 with @code{INTEGER (kind=4) :: i} , attempting to read @math{-2147483648} will
1043 give an error unless @option{-fno-range-check} is given. 
1044
1045
1046 @item -frecord-marker=@var{length}
1047 @opindex @code{frecord-marker=}@var{length}
1048 Specify the length of record markers for unformatted files.
1049 Valid values for @var{length} are 4 and 8.  Default is 4.
1050 @emph{This is different from previous versions of @command{gfortran}},
1051 which specified a default record marker length of 8 on most
1052 systems.  If you want to read or write files compatible
1053 with earlier versions of @command{gfortran}, use @option{-frecord-marker=8}.
1054
1055 @item -fmax-subrecord-length=@var{length}
1056 @opindex @code{fmax-subrecord-length=}@var{length}
1057 Specify the maximum length for a subrecord.  The maximum permitted
1058 value for length is 2147483639, which is also the default.  Only
1059 really useful for use by the gfortran testsuite.
1060
1061 @item -fsign-zero
1062 @opindex @code{fsign-zero}
1063 When enabled, floating point numbers of value zero with the sign bit set
1064 are written as negative number in formatted output and treated as
1065 negative in the @code{SIGN} intrinsic.  @code{fno-sign-zero} does not
1066 print the negative sign of zero values and regards zero as positive
1067 number in the @code{SIGN} intrinsic for compatibility with F77.
1068 Default behavior is to show the negative sign.
1069 @end table
1070
1071 @node Code Gen Options
1072 @section Options for code generation conventions
1073 @cindex code generation, conventions
1074 @cindex options, code generation
1075 @cindex options, run-time
1076
1077 These machine-independent options control the interface conventions
1078 used in code generation.
1079
1080 Most of them have both positive and negative forms; the negative form
1081 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
1082 one of the forms is listed---the one which is not the default.  You
1083 can figure out the other form by either removing @option{no-} or adding
1084 it.
1085
1086 @table @gcctabopt
1087 @item -fno-automatic
1088 @opindex @code{fno-automatic}
1089 @cindex @code{SAVE} statement
1090 @cindex statement, @code{SAVE}
1091 Treat each program unit (except those marked as RECURSIVE) as if the
1092 @code{SAVE} statement were specified for every local variable and array
1093 referenced in it. Does not affect common blocks. (Some Fortran compilers
1094 provide this option under the name @option{-static} or @option{-save}.)
1095 The default, which is @option{-fautomatic}, uses the stack for local
1096 variables smaller than the value given by @option{-fmax-stack-var-size}.
1097 Use the option @option{-frecursive} to use no static memory. 
1098
1099 @item -ff2c
1100 @opindex ff2c
1101 @cindex calling convention
1102 @cindex @command{f2c} calling convention
1103 @cindex @command{g77} calling convention
1104 @cindex libf2c calling convention
1105 Generate code designed to be compatible with code generated
1106 by @command{g77} and @command{f2c}.
1107
1108 The calling conventions used by @command{g77} (originally implemented
1109 in @command{f2c}) require functions that return type
1110 default @code{REAL} to actually return the C type @code{double}, and
1111 functions that return type @code{COMPLEX} to return the values via an
1112 extra argument in the calling sequence that points to where to
1113 store the return value.  Under the default GNU calling conventions, such
1114 functions simply return their results as they would in GNU
1115 C---default @code{REAL} functions return the C type @code{float}, and
1116 @code{COMPLEX} functions return the GNU C type @code{complex}.
1117 Additionally, this option implies the @option{-fsecond-underscore}
1118 option, unless @option{-fno-second-underscore} is explicitly requested.
1119
1120 This does not affect the generation of code that interfaces with
1121 the @command{libgfortran} library.
1122
1123 @emph{Caution:} It is not a good idea to mix Fortran code compiled with
1124 @option{-ff2c} with code compiled with the default @option{-fno-f2c}
1125 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
1126 functions between program parts which were compiled with different
1127 calling conventions will break at execution time.
1128
1129 @emph{Caution:} This will break code which passes intrinsic functions
1130 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
1131 the library implementations use the @option{-fno-f2c} calling conventions.
1132
1133 @item -fno-underscoring
1134 @opindex @code{fno-underscoring}
1135 @cindex underscore
1136 @cindex symbol names, underscores
1137 @cindex transforming symbol names
1138 @cindex symbol names, transforming
1139 Do not transform names of entities specified in the Fortran
1140 source file by appending underscores to them.
1141
1142 With @option{-funderscoring} in effect, GNU Fortran appends one
1143 underscore to external names with no underscores.  This is done to ensure
1144 compatibility with code produced by many UNIX Fortran compilers.
1145
1146 @emph{Caution}: The default behavior of GNU Fortran is
1147 incompatible with @command{f2c} and @command{g77}, please use the
1148 @option{-ff2c} option if you want object files compiled with
1149 GNU Fortran to be compatible with object code created with these
1150 tools.
1151
1152 Use of @option{-fno-underscoring} is not recommended unless you are
1153 experimenting with issues such as integration of GNU Fortran into
1154 existing system environments (vis-@`{a}-vis existing libraries, tools,
1155 and so on).
1156
1157 For example, with @option{-funderscoring}, and assuming other defaults like
1158 @option{-fcase-lower} and that @code{j()} and @code{max_count()} are
1159 external functions while @code{my_var} and @code{lvar} are local variables,
1160 a statement like
1161 @smallexample
1162 I = J() + MAX_COUNT (MY_VAR, LVAR)
1163 @end smallexample
1164 @noindent
1165 is implemented as something akin to:
1166 @smallexample
1167 i = j_() + max_count__(&my_var__, &lvar);
1168 @end smallexample
1169
1170 With @option{-fno-underscoring}, the same statement is implemented as:
1171
1172 @smallexample
1173 i = j() + max_count(&my_var, &lvar);
1174 @end smallexample
1175
1176 Use of @option{-fno-underscoring} allows direct specification of
1177 user-defined names while debugging and when interfacing GNU Fortran
1178 code with other languages.
1179
1180 Note that just because the names match does @emph{not} mean that the
1181 interface implemented by GNU Fortran for an external name matches the
1182 interface implemented by some other language for that same name.
1183 That is, getting code produced by GNU Fortran to link to code produced
1184 by some other compiler using this or any other method can be only a
1185 small part of the overall solution---getting the code generated by
1186 both compilers to agree on issues other than naming can require
1187 significant effort, and, unlike naming disagreements, linkers normally
1188 cannot detect disagreements in these other areas.
1189
1190 Also, note that with @option{-fno-underscoring}, the lack of appended
1191 underscores introduces the very real possibility that a user-defined
1192 external name will conflict with a name in a system library, which
1193 could make finding unresolved-reference bugs quite difficult in some
1194 cases---they might occur at program run time, and show up only as
1195 buggy behavior at run time.
1196
1197 In future versions of GNU Fortran we hope to improve naming and linking
1198 issues so that debugging always involves using the names as they appear
1199 in the source, even if the names as seen by the linker are mangled to
1200 prevent accidental linking between procedures with incompatible
1201 interfaces.
1202
1203 @item -fwhole-file
1204 @opindex @code{fwhole-file}
1205 By default, GNU Fortran parses, resolves and translates each procedure
1206 in a file separately.  Using this option modifies this such that the
1207 whole file is parsed and placed in a single front-end tree.  During
1208 resolution, in addition to all the usual checks and fixups, references
1209 to external procedures that are in the same file effect resolution of
1210 that procedure, if not already done, and a check of the interfaces. The
1211 dependences are resolved by changing the order in which the file is
1212 translated into the backend tree.  Thus, a procedure that is referenced
1213 is translated before the reference and the duplication of backend tree
1214 declarations eliminated.
1215
1216 @item -fsecond-underscore
1217 @opindex @code{fsecond-underscore}
1218 @cindex underscore
1219 @cindex symbol names, underscores
1220 @cindex transforming symbol names
1221 @cindex symbol names, transforming
1222 @cindex @command{f2c} calling convention
1223 @cindex @command{g77} calling convention
1224 @cindex libf2c calling convention
1225 By default, GNU Fortran appends an underscore to external
1226 names.  If this option is used GNU Fortran appends two
1227 underscores to names with underscores and one underscore to external names
1228 with no underscores.  GNU Fortran also appends two underscores to
1229 internal names with underscores to avoid naming collisions with external
1230 names.
1231
1232 This option has no effect if @option{-fno-underscoring} is
1233 in effect.  It is implied by the @option{-ff2c} option.
1234
1235 Otherwise, with this option, an external name such as @code{MAX_COUNT}
1236 is implemented as a reference to the link-time external symbol
1237 @code{max_count__}, instead of @code{max_count_}.  This is required
1238 for compatibility with @command{g77} and @command{f2c}, and is implied
1239 by use of the @option{-ff2c} option.
1240
1241 @item -fcoarray=@var{<keyword>}
1242 @opindex @code{fcoarray}
1243 @cindex coarrays
1244
1245 @table @asis
1246 @item @samp{none}
1247 Disable coarray support; using coarray declarations and image-control
1248 statements will produce a compile-time error. (Default)
1249
1250 @item @samp{single}
1251 Single-image mode, i.e. @code{num_images()} is always one.
1252 @end table
1253
1254
1255 @item -fcheck=@var{<keyword>}
1256 @opindex @code{fcheck}
1257 @cindex array, bounds checking
1258 @cindex bounds checking
1259 @cindex pointer checking
1260 @cindex memory checking
1261 @cindex range checking
1262 @cindex subscript checking
1263 @cindex checking subscripts
1264 @cindex run-time checking
1265 @cindex checking array temporaries
1266
1267 Enable the generation of run-time checks; the argument shall be
1268 a comma-delimited list of the following keywords.
1269
1270 @table @asis
1271 @item @samp{all}
1272 Enable all run-time test of @option{-fcheck}.
1273
1274 @item @samp{array-temps}
1275 Warns at run time when for passing an actual argument a temporary array
1276 had to be generated. The information generated by this warning is
1277 sometimes useful in optimization, in order to avoid such temporaries.
1278
1279 Note: The warning is only printed once per location.
1280
1281 @item @samp{bounds}
1282 Enable generation of run-time checks for array subscripts
1283 and against the declared minimum and maximum values.  It also
1284 checks array indices for assumed and deferred
1285 shape arrays against the actual allocated bounds and ensures that all string
1286 lengths are equal for character array constructors without an explicit
1287 typespec.
1288
1289 Some checks require that @option{-fcheck=bounds} is set for
1290 the compilation of the main program.
1291
1292 Note: In the future this may also include other forms of checking, e.g.,
1293 checking substring references.
1294
1295 @item @samp{do}
1296 Enable generation of run-time checks for invalid modification of loop
1297 iteration variables.
1298
1299 @item @samp{mem}
1300 Enable generation of run-time checks for memory allocation.
1301 Note: This option does not affect explicit allocations using the
1302 @code{ALLOCATE} statement, which will be always checked.
1303
1304 @item @samp{pointer}
1305 Enable generation of run-time checks for pointers and allocatables.
1306
1307 @item @samp{recursion}
1308 Enable generation of run-time checks for recursively called subroutines and
1309 functions which are not marked as recursive. See also @option{-frecursive}.
1310 Note: This check does not work for OpenMP programs and is disabled if used
1311 together with @option{-frecursive} and @option{-fopenmp}.
1312 @end table
1313
1314
1315 @item -fbounds-check
1316 @opindex @code{fbounds-check}
1317 @c Note: This option is also referred in gcc's manpage
1318 Deprecated alias for @option{-fcheck=bounds}.
1319
1320 @item -fcheck-array-temporaries
1321 @opindex @code{fcheck-array-temporaries}
1322 Deprecated alias for @option{-fcheck=array-temps}.
1323
1324 @item -fmax-array-constructor=@var{n}
1325 @opindex @code{fmax-array-constructor}
1326 This option can be used to increase the upper limit permitted in 
1327 array constructors.  The code below requires this option to expand
1328 the array at compile time.
1329
1330 @smallexample
1331 program test
1332 implicit none
1333 integer j
1334 integer, parameter :: n = 100000
1335 integer, parameter :: i(n) = (/ (2*j, j = 1, n) /)
1336 print '(10(I0,1X))', i
1337 end program test
1338 @end smallexample
1339
1340 @emph{Caution:  This option can lead to long compile times and excessively
1341 large object files.}
1342
1343 The default value for @var{n} is 65535.
1344
1345
1346 @item -fmax-stack-var-size=@var{n}
1347 @opindex @code{fmax-stack-var-size}
1348 This option specifies the size in bytes of the largest array that will be put
1349 on the stack; if the size is exceeded static memory is used (except in
1350 procedures marked as RECURSIVE). Use the option @option{-frecursive} to
1351 allow for recursive procedures which do not have a RECURSIVE attribute or
1352 for parallel programs. Use @option{-fno-automatic} to never use the stack.
1353
1354 This option currently only affects local arrays declared with constant
1355 bounds, and may not apply to all character variables.
1356 Future versions of GNU Fortran may improve this behavior.
1357
1358 The default value for @var{n} is 32768.
1359
1360 @item -fpack-derived
1361 @opindex @code{fpack-derived}
1362 @cindex structure packing
1363 This option tells GNU Fortran to pack derived type members as closely as
1364 possible.  Code compiled with this option is likely to be incompatible
1365 with code compiled without this option, and may execute slower.
1366
1367 @item -frepack-arrays
1368 @opindex @code{frepack-arrays}
1369 @cindex repacking arrays
1370 In some circumstances GNU Fortran may pass assumed shape array
1371 sections via a descriptor describing a noncontiguous area of memory.
1372 This option adds code to the function prologue to repack the data into
1373 a contiguous block at runtime.
1374
1375 This should result in faster accesses to the array.  However it can introduce
1376 significant overhead to the function call, especially  when the passed data
1377 is noncontiguous.
1378
1379 @item -fshort-enums
1380 @opindex @code{fshort-enums}
1381 This option is provided for interoperability with C code that was
1382 compiled with the @option{-fshort-enums} option.  It will make
1383 GNU Fortran choose the smallest @code{INTEGER} kind a given
1384 enumerator set will fit in, and give all its enumerators this kind.
1385
1386 @item -fexternal-blas
1387 @opindex @code{fexternal-blas}
1388 This option will make @command{gfortran} generate calls to BLAS functions
1389 for some matrix operations like @code{MATMUL}, instead of using our own
1390 algorithms, if the size of the matrices involved is larger than a given
1391 limit (see @option{-fblas-matmul-limit}).  This may be profitable if an
1392 optimized vendor BLAS library is available.  The BLAS library will have
1393 to be specified at link time.
1394
1395 @item -fblas-matmul-limit=@var{n}
1396 @opindex @code{fblas-matmul-limit}
1397 Only significant when @option{-fexternal-blas} is in effect.
1398 Matrix multiplication of matrices with size larger than (or equal to) @var{n}
1399 will be performed by calls to BLAS functions, while others will be
1400 handled by @command{gfortran} internal algorithms. If the matrices
1401 involved are not square, the size comparison is performed using the
1402 geometric mean of the dimensions of the argument and result matrices.
1403
1404 The default value for @var{n} is 30.
1405
1406 @item -frecursive
1407 @opindex @code{frecursive}
1408 Allow indirect recursion by forcing all local arrays to be allocated
1409 on the stack. This flag cannot be used together with
1410 @option{-fmax-stack-var-size=} or @option{-fno-automatic}.
1411
1412 @item -finit-local-zero
1413 @itemx -finit-integer=@var{n}
1414 @itemx -finit-real=@var{<zero|inf|-inf|nan|snan>}
1415 @itemx -finit-logical=@var{<true|false>}
1416 @itemx -finit-character=@var{n}
1417 @opindex @code{finit-local-zero}
1418 @opindex @code{finit-integer}
1419 @opindex @code{finit-real}
1420 @opindex @code{finit-logical}
1421 @opindex @code{finit-character}
1422 The @option{-finit-local-zero} option instructs the compiler to
1423 initialize local @code{INTEGER}, @code{REAL}, and @code{COMPLEX}
1424 variables to zero, @code{LOGICAL} variables to false, and
1425 @code{CHARACTER} variables to a string of null bytes.  Finer-grained
1426 initialization options are provided by the
1427 @option{-finit-integer=@var{n}},
1428 @option{-finit-real=@var{<zero|inf|-inf|nan|snan>}} (which also initializes
1429 the real and imaginary parts of local @code{COMPLEX} variables),
1430 @option{-finit-logical=@var{<true|false>}}, and
1431 @option{-finit-character=@var{n}} (where @var{n} is an ASCII character
1432 value) options.  These options do not initialize components of derived
1433 type variables, nor do they initialize variables that appear in an
1434 @code{EQUIVALENCE} statement.  (This limitation may be removed in
1435 future releases).
1436
1437 Note that the @option{-finit-real=nan} option initializes @code{REAL}
1438 and @code{COMPLEX} variables with a quiet NaN. For a signalling NaN
1439 use @option{-finit-real=snan}; note, however, that compile-time
1440 optimizations may convert them into quiet NaN and that trapping
1441 needs to be enabled (e.g. via @option{-ffpe-trap}).
1442
1443 @item -falign-commons
1444 @opindex @code{falign-commons}
1445 @cindex alignment of @code{COMMON} blocks
1446 By default, @command{gfortran} enforces proper alignment of all variables in a
1447 @code{COMMON} block by padding them as needed. On certain platforms this is mandatory,
1448 on others it increases performance. If a @code{COMMON} block is not declared with
1449 consistent data types everywhere, this padding can cause trouble, and
1450 @option{-fno-align-commons} can be used to disable automatic alignment. The
1451 same form of this option should be used for all files that share a @code{COMMON} block.
1452 To avoid potential alignment issues in @code{COMMON} blocks, it is recommended to order
1453 objects from largest to smallest.
1454
1455 @item -fno-protect-parens
1456 @opindex @code{fno-protect-parens}
1457 @cindex re-association of parenthesized expressions
1458 By default the parentheses in expression are honored for all optimization
1459 levels such that the compiler does not do any re-association. Using
1460 @option{-fno-protect-parens} allows the compiler to reorder @code{REAL} and
1461 @code{COMPLEX} expressions to produce faster code. Note that for the re-association
1462 optimization @option{-fno-signed-zeros} and @option{-fno-trapping-math}
1463 need to be in effect.
1464
1465 @item -frealloc-lhs
1466 @opindex @code{frealloc-lhs}
1467 @cindex Reallocate the LHS in assignments
1468 An allocatable left-hand side of an intrinsic assignment is automatically
1469 (re)allocated if it is either unallocated or has a different shape. The
1470 option is enabled by default except when @option{-std=f95} is given.
1471 @end table
1472
1473 @xref{Code Gen Options,,Options for Code Generation Conventions,
1474 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
1475 offered by the GBE
1476 shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
1477
1478
1479 @c man end
1480
1481 @node Environment Variables
1482 @section Environment variables affecting @command{gfortran}
1483 @cindex environment variable
1484
1485 @c man begin ENVIRONMENT
1486
1487 The @command{gfortran} compiler currently does not make use of any environment
1488 variables to control its operation above and beyond those
1489 that affect the operation of @command{gcc}.
1490
1491 @xref{Environment Variables,,Environment Variables Affecting GCC,
1492 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
1493 variables.
1494
1495 @xref{Runtime}, for environment variables that affect the
1496 run-time behavior of programs compiled with GNU Fortran.
1497 @c man end