2006-10-10 Brooks Moses <bmoses@stanford.edu>
[official-gcc.git] / gcc / fortran / invoke.texi
blob91ad3ca547b7ba61d19000101471aeffcbe71d5d
1 @c Copyright (C) 2004, 2005, 2006
2 @c Free Software Foundation, Inc.
3 @c This is part of the GNU Fortran manual.   
4 @c For copying conditions, see the file gfortran.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 2004, 2005, 2006
9 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gfortran
31 @settitle GNU Fortran compiler.
32 @c man begin SYNOPSIS
33 gfortran [@option{-c}|@option{-S}|@option{-E}]
34          [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35          [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36          [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37          [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38          [@option{-f}@var{option}@dots{}]
39          [@option{-m}@var{machine-option}@dots{}]
40          [@option{-o} @var{outfile}] @var{infile}@dots{}
42 Only the most useful options are listed here; see below for the
43 remainder.
44 @c man end
45 @c man begin SEEALSO
46 gpl(7), gfdl(7), fsf-funding(7),
47 cpp(1), gcov(1), gcc(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
48 and the Info entries for @file{gcc}, @file{cpp}, @file{gfortran}, @file{as},
49 @file{ld}, @file{binutils} and @file{gdb}.
50 @c man end
51 @c man begin BUGS
52 For instructions on reporting bugs, see
53 @w{@uref{http://gcc.gnu.org/bugs.html}}.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gfortran} for contributors to GCC and
57 GNU Fortran.
58 @c man end
59 @end ignore
61 @node Invoking GNU Fortran
62 @chapter GNU Fortran Command Options
63 @cindex GNU Fortran command options
64 @cindex command options
65 @cindex options, @command{gfortran} command
67 @c man begin DESCRIPTION
69 The @command{gfortran} command supports all the options supported by the
70 @command{gcc} command.  Only options specific to GNU Fortran are documented here.
72 @xref{Invoking GCC,,GCC Command Options,gcc,Using the GNU Compiler
73 Collection (GCC)}, for information
74 on the non-Fortran-specific aspects of the @command{gcc} command (and,
75 therefore, the @command{gfortran} command).
77 @cindex options, negative forms
78 @cindex negative forms of options
79 All GCC and GNU Fortran options
80 are accepted both by @command{gfortran} and by @command{gcc}
81 (as well as any other drivers built at the same time,
82 such as @command{g++}),
83 since adding GNU Fortran to the GCC distribution
84 enables acceptance of GNU Fortran options
85 by all of the relevant drivers.
87 In some cases, options have positive and negative forms;
88 the negative form of @option{-ffoo} would be @option{-fno-foo}.
89 This manual documents only one of these two forms, whichever
90 one is not the default.
91 @c man end
93 @menu
94 * Option Summary::      Brief list of all @command{gfortran} options,
95                         without explanations.
96 * Fortran Dialect Options::  Controlling the variant of Fortran language
97                              compiled.
98 * Warning Options::     How picky should the compiler be?
99 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
100 * Directory Options::   Where to find module files
101 * Runtime Options::     Influencing runtime behavior
102 * Code Gen Options::    Specifying conventions for function calls, data layout
103                         and register usage.
104 * Environment Variables:: Env vars that affect @command{gfortran}.
105 @end menu
107 @node Option Summary
108 @section Option Summary
110 @c man begin OPTIONS
112 Here is a summary of all the options specific to GNU Fortran, grouped
113 by type.  Explanations are in the following sections.
115 @table @emph
116 @item Fortran Language Options
117 @xref{Fortran Dialect Options,,Options Controlling Fortran Dialect}.
118 @gccoptlist{
119 -fall-intrinsics -ffree-form  -fno-fixed-form @gol
120 -fdollar-ok  -fimplicit-none  -fmax-identifier-length @gol
121 -std=@var{std} -fd-lines-as-code -fd-lines-as-comments @gol
122 -ffixed-line-length-@var{n}  -ffixed-line-length-none @gol
123 -ffree-line-length-@var{n}  -ffree-line-length-none @gol
124 -fdefault-double-8  -fdefault-integer-8  -fdefault-real-8 @gol
125 -fcray-pointer  -fopenmp  -frange-check }
127 @item Warning Options
128 @xref{Warning Options,,Options to Request or Suppress Warnings}.
129 @gccoptlist{
130 -fsyntax-only  -pedantic  -pedantic-errors @gol
131 -w  -Wall  -Waliasing -Wampersand -Wconversion -Wimplicit-interface @gol
132 -Wtabs -Wnonstd-intrinsics -Wsurprising -Wunderflow @gol
133 -Wunused-labels -Wline-truncation -W}
135 @item Debugging Options
136 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
137 @gccoptlist{
138 -fdump-parse-tree -ffpe-trap=@var{list}}
140 @item Directory Options
141 @xref{Directory Options,,Options for Directory Search}.
142 @gccoptlist{
143 -I@var{dir}  -M@var{dir}}
145 @item Runtime Options
146 @xref{Runtime Options,,Options for influencing runtime behavior}.
147 @gccoptlist{
148 -fconvert=@var{conversion} -frecord-marker=@var{length}}
150 @item Code Generation Options
151 @xref{Code Gen Options,,Options for Code Generation Conventions}.
152 @gccoptlist{
153 -fno-automatic -ff2c -fno-underscoring  -fsecond-underscore @gol
154 -fbounds-check  -fmax-stack-var-size=@var{n} @gol
155 -fpack-derived  -frepack-arrays  -fshort-enums}
156 @end table
158 @menu
159 * Fortran Dialect Options::  Controlling the variant of Fortran language
160                              compiled.
161 * Warning Options::     How picky should the compiler be?
162 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
163 * Directory Options::   Where to find module files
164 * Runtime Options::     Influencing runtime behavior
165 * Code Gen Options::    Specifying conventions for function calls, data layout
166                         and register usage.
167 @end menu
169 @node Fortran Dialect Options
170 @section Options Controlling Fortran Dialect
171 @cindex dialect options
172 @cindex language, dialect options
173 @cindex options, dialect
175 The following options control the details of the Fortran dialect
176 accepted by the compiler:
178 @table @gcctabopt
179 @cindex -ffree-form option
180 @cindex options, -ffree-form
181 @cindex -fno-fixed-form option
182 @cindex options, -fno-fixed-form
183 @cindex source file format
184 @cindex free form
185 @cindex fixed form
186 @cindex Source Form
187 @cindex Fortran 90, features
188 @item -ffree-form
189 @item -ffixed-form
190 Specify the layout used by the source file.  The free form layout
191 was introduced in Fortran 90.  Fixed form was traditionally used in
192 older Fortran programs.  When neither option is specified, the source
193 form is determined by the file extension.
195 @cindex -fall-intrinsics
196 @item -fall-intrinsics
197 Accept all of the intrinsic procedures provided in libgfortran 
198 without regard to the setting of @option{-std}.  In particular, 
199 this option can be quite useful with @option{-std=f95}.  Additionally,
200 @command{gfortran} will ignore @option{-Wnonstd-intrinsics}.
202 @cindex option, -fd-lines-as-code
203 @cindex -fd-lines-as-code, option
204 @cindex option, -fd-lines-as-comments
205 @cindex -fd-lines-as-comments, option
206 @item -fd-lines-as-code
207 @item -fd-lines-as-comment
208 Enable special treatment for lines beginning with @samp{d} or @samp{D}
209 in fixed form sources.  If the @option{-fd-lines-as-code} option is
210 given they are treated as if the first column contained a blank.  If the
211 @option{-fd-lines-as-comments} option is given, they are treated as
212 comment lines.
214 @cindex option, -fdefault-double-8
215 @cindex -fdefault-double-8, option
216 @item -fdefault-double-8
217 Set the @code{DOUBLE PRECISION} type to an 8 byte wide type.
219 @cindex option, -fdefault-integer-8
220 @cindex -fdefault-integer-8, option
221 @item -fdefault-integer-8
222 Set the default integer and logical types to an 8 byte wide type.
223 Do nothing if this is already the default.
225 @cindex option, -fdefault-real-8
226 @cindex -fdefault-real-8, option
227 @item -fdefault-real-8
228 Set the default real type to an 8 byte wide type.
229 Do nothing if this is already the default.
231 @cindex -fdollar-ok option
232 @cindex options, -fdollar-ok
233 @item -fdollar-ok
234 @cindex dollar sign
235 @cindex symbol names
236 @cindex character set
237 Allow @samp{$} as a valid character in a symbol name.
239 @cindex -fno-backslash option
240 @cindex options, -fno-backslash
241 @item -fno-backslash
242 @cindex backslash
243 @cindex escape characters
244 Change the interpretation of backslashes in string literals from
245 ``C-style'' escape characters to a single backslash character.
247 @cindex -ffixed-line-length-@var{n} option
248 @cindex options, -ffixed-line-length-@var{n}
249 @item -ffixed-line-length-@var{n}
250 @cindex source file format
251 @cindex lines, length
252 @cindex length of source lines
253 @cindex fixed form
254 @cindex limits, lengths of source lines
255 Set column after which characters are ignored in typical fixed-form
256 lines in the source file, and through which spaces are assumed (as
257 if padded to that length) after the ends of short fixed-form lines.
259 @cindex card image
260 @cindex extended-source option
261 Popular values for @var{n} include 72 (the
262 standard and the default), 80 (card image), and 132 (corresponding
263 to ``extended-source'' options in some popular compilers).
264 @var{n} may also be @samp{none}, meaning that the entire line is meaningful
265 and that continued character constants never have implicit spaces appended
266 to them to fill out the line.
267 @option{-ffixed-line-length-0} means the same thing as
268 @option{-ffixed-line-length-none}.
270 @cindex -ffree-line-length-@var{n} option
271 @cindex options, -ffree-line-length-@var{n}
272 @item -ffree-line-length-@var{n}
273 @cindex source file format
274 @cindex lines, length
275 @cindex length of source lines
276 @cindex free form
277 @cindex limits, lengths of source lines
278 Set column after which characters are ignored in typical free-form
279 lines in the source file. The default value is 132.
280 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
281 @option{-ffree-line-length-0} means the same thing as
282 @option{-ffree-line-length-none}.
284 @cindex -fmax-identifier-length=@var{n} option
285 @cindex option -fmax-identifier-length=@var{n}
286 @item -fmax-identifier-length=@var{n}
287 Specify the maximum allowed identifier length. Typical values are
288 31 (Fortran 95) and 63 (Fortran 2003).
290 @cindex -fimplicit-none option
291 @cindex options, -fimplicit-none
292 @item -fimplicit-none
293 Specify that no implicit typing is allowed, unless overridden by explicit
294 @samp{IMPLICIT} statements.  This is the equivalent of adding
295 @samp{implicit none} to the start of every procedure.
297 @cindex -fcray-pointer option
298 @cindex options, -fcray-pointer
299 @item -fcray-pointer
300 Enable the Cray pointer extension, which provides C-like pointer
301 functionality.
303 @cindex -fopenmp
304 @cindex options, -fopenmp
305 @item -fopenmp
306 Enable the OpenMP extensions.  This includes OpenMP @code{!$omp} directives
307 in free form
308 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
309 @code{!$} conditional compilation sentinels in free form
310 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form, 
311 and when linking arranges for the OpenMP runtime library to be linked
314 @cindex -frange-check
315 @cindex options, -frange-check
316 @item -frange-check
317 Enable range checking on results of simplification of constant expressions
318 during compilation.  For example, by default, GNU Fortran will give
319 an overflow error at compile time when simplifying @code{a = EXP(1000)}.
320 With @samp{-fno-range-check}, no error will be given and the variable @code{a}
321 will be assigned the value @code{+Infinity}.  Similarly,
322 @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow on most systems,
323 but with @samp{-fno-range-check} the value will ``wrap around'' and @code{i}
324 will be initialized to @math{-1} instead.
326 @cindex -std=@var{std} option
327 @cindex option, -std=@var{std}
328 @item -std=@var{std}
329 Conform to the specified standard.  The default value for @var{std} is
330 @samp{gnu}; a superset of the Fortran 95 standard which includes all
331 of the GNU extensions recommended for use in new code.  The @samp{legacy}
332 value also includes obsolete extensions that may be required for old 
333 non-standard programs.  Strict conformance to the Fortran 95 and Fortran 2003
334 standards is specified by @samp{f95} and @samp{f2003}, respectively.
336 @end table
338 @node Warning Options
339 @section Options to Request or Suppress Warnings
340 @cindex options, warnings
341 @cindex warnings, suppressing
342 @cindex messages, warning
343 @cindex suppressing warnings
345 Warnings are diagnostic messages that report constructions which
346 are not inherently erroneous but which are risky or suggest there
347 might have been an error.
349 You can request many specific warnings with options beginning @option{-W},
350 for example @option{-Wimplicit} to request warnings on implicit
351 declarations.  Each of these specific warning options also has a
352 negative form beginning @option{-Wno-} to turn off warnings;
353 for example, @option{-Wno-implicit}.  This manual lists only one of the
354 two forms, whichever is not the default.
356 These options control the amount and kinds of warnings produced by GNU
357 Fortran:
359 @table @gcctabopt
360 @cindex syntax checking
361 @cindex -fsyntax-only option
362 @cindex options, -fsyntax-only
363 @item -fsyntax-only
364 Check the code for syntax errors, but don't do anything beyond that.
366 @cindex -pedantic option
367 @cindex options, -pedantic
368 @item -pedantic
369 Issue warnings for uses of extensions to Fortran 95.
370 @option{-pedantic} also applies to C-language constructs where they
371 occur in GNU Fortran source files, such as use of @samp{\e} in a
372 character constant within a directive like @samp{#include}.
374 Valid Fortran 95 programs should compile properly with or without
375 this option.
376 However, without this option, certain GNU extensions and traditional
377 Fortran features are supported as well.
378 With this option, many of them are rejected.
380 Some users try to use @option{-pedantic} to check programs for conformance.
381 They soon find that it does not do quite what they want---it finds some
382 nonstandard practices, but not all.
383 However, improvements to GNU Fortran in this area are welcome.
385 This should be used in conjunction with -std=@var{std}.
387 @cindex -pedantic-errors option
388 @cindex options, -pedantic-errors
389 @item -pedantic-errors
390 Like @option{-pedantic}, except that errors are produced rather than
391 warnings.
393 @cindex -w option
394 @cindex options, -w
395 @item -w
396 Inhibit all warning messages.
399 @cindex -Wall option
400 @cindex options, -Wall
401 @item -Wall
402 @cindex all warnings
403 @cindex warnings, all
404 Enables commonly used warning options pertaining to usage that
405 we recommend avoiding and that we believe are easy to avoid.
406 This currently includes @option{-Wunused-labels}, @option{-Waliasing},
407 @option{-Wampersand}, @option{-Wsurprising}, @option{-Wnonstd-intrinsic},
408 @option{-Wno-tabs}, and @option{-Wline-truncation}.
411 @cindex -Waliasing option
412 @cindex options, -Waliasing
413 @item -Waliasing
414 @cindex aliasing
415 Warn about possible aliasing of dummy arguments. Specifically, it warns
416 if the same actual argument is associated with a dummy argument with
417 @code{intent(in)} and a dummy argument with @code{intent(out)} in a call
418 with an explicit interface.
420 The following example will trigger the warning.
421 @smallexample
422   interface
423     subroutine bar(a,b)
424       integer, intent(in) :: a
425       integer, intent(out) :: b
426     end subroutine
427   end interface
428   integer :: a
430   call bar(a,a)
431 @end smallexample
434 @cindex -Wampersand option
435 @cindex options, -Wampersand
436 @item -Wampersand
437 @cindex ampersand
438 Warn about missing ampersand in continued character constants. The warning is
439 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95}, and
440 @option{-std=f2003}. Note: With no ampersand given in a continued character
441 constant, GNU Fortran assumes continuation at the first non-comment,
442 non-whitespace character after the ampersand that initiated the continuation.
445 @cindex -Wconversion option
446 @cindex options, -Wconversion
447 @item -Wconversion
448 @cindex conversion
449 Warn about implicit conversions between different types.
452 @cindex -Wimplicit-interface option
453 @cindex options, -Wimplicit-interface
454 @item -Wimplicit-interface
455 Warn about when procedure are called without an explicit interface.
456 Note this only checks that an explicit interface is present.  It does not
457 check that the declared interfaces are consistent across program units.
460 @cindex -Wnonstd-intrinsic option
461 @cindex options, -Wnonstd-intrinsic
462 @item -Wnonstd-intrinsic
463 Warn if the user tries to use an intrinsic that does not belong to the 
464 standard the user has chosen via the -std option.
467 @cindex -Wsurprising
468 @cindex options, -Wsurprising
469 @item -Wsurprising
470 @cindex Suspicious
471 Produce a warning when ``suspicious'' code constructs are encountered.
472 While technically legal these usually indicate that an error has been made.
474 This currently produces a warning under the following circumstances:
476 @itemize @bullet
477 @item
478 An INTEGER SELECT construct has a CASE that can never be matched as its
479 lower value is greater than its upper value.
481 @item
482 A LOGICAL SELECT construct has three CASE statements.
483 @end itemize
486 @cindex -Wtabs
487 @cindex options, -Wtabs
488 @item -Wtabs
489 @cindex Tabs
490 By default, tabs are accepted as whitespace, but tabs are not members
491 of the Fortran Character Set.  @option{-Wno-tabs} will cause a warning
492 to be issued if a tab is encountered. Note, @option{-Wno-tabs} is active
493 for @option{-pedantic}, @option{-std=f95}, and @option{-Wall}.
496 @cindex -Wunderflow
497 @cindex options, -Wunderflow
498 @item -Wunderflow
499 @cindex UNDERFLOW
500 Produce a warning when numerical constant expressions are
501 encountered, which yield an UNDERFLOW during compilation.
504 @cindex -Wunused-labels option
505 @cindex options, -Wunused-labels
506 @item -Wunused-labels
507 @cindex unused labels
508 @cindex labels, unused
509 Warn whenever a label is defined but never referenced.
512 @cindex -Werror
513 @cindex options, -Werror
514 @item -Werror
515 Turns all warnings into errors.
518 @cindex -W option
519 @cindex options, -W
520 @item -W
521 @cindex extra warnings
522 @cindex warnings, extra
523 Turns on ``extra warnings'' and, if optimization is specified
524 via @option{-O}, the @option{-Wuninitialized} option.
525 (This might change in future versions of GNU Fortran.)
526 @end table
528 @xref{Warning Options,,Options to Request or Suppress Warnings,
529 gcc,Using the GNU Compiler Collection (GCC)}, for information on more
530 options offered by the GBE shared by @command{gfortran}, @command{gcc} and
531 other GNU compilers.
533 Some of these have no effect when compiling programs written in Fortran.
535 @node Debugging Options
536 @section Options for Debugging Your Program or GNU Fortran
537 @cindex options, debugging
538 @cindex debugging information options
540 GNU Fortran has various special options that are used for debugging
541 either your program or the GNU Fortran compiler.
543 @table @gcctabopt
544 @cindex -fdump-parse-tree option
545 @cindex option, -fdump-parse-tree
546 @item -fdump-parse-tree
547 Output the internal parse tree before starting code generation.  Only
548 really useful for debugging the GNU Fortran compiler itself.
549 @end table
551 @table @gcctabopt
552 @cindex -ffpe-trap=@var{list} option
553 @cindex option, -ffpe-trap=@var{list}
554 @item -ffpe-trap=@var{list}
555 Specify a list of IEEE exceptions when a Floating Point Exception
556 (FPE) should be raised.  On most systems, this will result in a SIGFPE
557 signal being sent and the program being interrupted, producing a core
558 file useful for debugging.  @var{list} is a (possibly empty) comma-separated
559 list of the following IEEE exceptions: @samp{invalid} (invalid floating
560 point operation, such as @code{sqrt(-1.0)}), @samp{zero} (division by
561 zero), @samp{overflow} (overflow in a floating point operation),
562 @samp{underflow} (underflow in a floating point operation),
563 @samp{precision} (loss of precision during operation) and @samp{denormal}
564 (operation produced a denormal denormal value).
565 @end table
567 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
568 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
569 debugging options.
571 @node Directory Options
572 @section Options for Directory Search
573 @cindex directory, options
574 @cindex options, directory search
575 @cindex search path
577 @cindex INCLUDE directive
578 @cindex directive, INCLUDE
579 These options affect how GNU Fortran searches
580 for files specified by the @code{INCLUDE} directive and where it searches
581 for previously compiled modules.
583 It also affects the search paths used by @command{cpp} when used to preprocess
584 Fortran source.
586 @table @gcctabopt
587 @cindex -Idir option
588 @cindex options, -Idir
589 @item -I@var{dir}
590 @cindex directory, search paths for inclusion
591 @cindex inclusion, directory search paths for
592 @cindex search paths, for included files
593 @cindex paths, search
594 @cindex module search path
595 These affect interpretation of the @code{INCLUDE} directive
596 (as well as of the @code{#include} directive of the @command{cpp}
597 preprocessor).
599 Also note that the general behavior of @option{-I} and
600 @code{INCLUDE} is pretty much the same as of @option{-I} with
601 @code{#include} in the @command{cpp} preprocessor, with regard to
602 looking for @file{header.gcc} files and other such things.
604 This path is also used to search for @samp{.mod} files when previously
605 compiled modules are required by a @code{USE} statement.
607 @xref{Directory Options,,Options for Directory Search,
608 gcc,Using the GNU Compiler Collection (GCC)}, for information on the
609 @option{-I} option.
611 @cindex -Mdir option
612 @cindex option, -Mdir
613 @item -M@var{dir}
614 @item -J@var{dir}
615 This option specifies where to put @samp{.mod} files for compiled modules.
616 It is also added to the list of directories to searched by an @code{USE}
617 statement.
619 The default is the current directory.
621 @option{-J} is an alias for @option{-M} to avoid conflicts with existing
622 GCC options.
623 @end table
625 @node Runtime Options
626 @section Influencing runtime behavior
627 @cindex runtime, options
629 These options affect the runtime behavior of programs compiled with GNU Fortran.
630 @table @gcctabopt
631 @cindex -fconvert=@var{conversion} option
632 @item -fconvert=@var{conversion}
633 Specify the representation of data for unformatted files.  Valid
634 values for conversion are: @samp{native}, the default; @samp{swap},
635 swap between big- and little-endian; @samp{big-endian}, use big-endian
636 representation for unformatted files; @samp{little-endian}, use little-endian
637 representation for unformatted files.
639 @emph{This option has an effect only when used in the main program.
640 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
641 variable override the default specified by -fconvert.}
643 @cindex -frecord-marker=@var{length}
644 @item -frecord-marker=@var{length}
645 Specify the length of record markers for unformatted files.
646 Valid values for @var{length} are 4 and 8.  Default is whatever
647 @code{off_t} is specified to be on that particular system.
648 Note that specifying @var{length} as 4 limits the record
649 length of unformatted files to 2 GB.  This option does not
650 extend the maximum possible record length on systems where
651 @code{off_t} is a four_byte quantity.
653 @end table
655 @node Code Gen Options
656 @section Options for Code Generation Conventions
657 @cindex code generation, conventions
658 @cindex options, code generation
659 @cindex run-time, options
661 These machine-independent options control the interface conventions
662 used in code generation.
664 Most of them have both positive and negative forms; the negative form
665 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
666 one of the forms is listed---the one which is not the default.  You
667 can figure out the other form by either removing @option{no-} or adding
670 @table @gcctabopt
671 @cindex @option{-fno-automatic} option
672 @cindex options, @option{-fno-automatic}
673 @item -fno-automatic
674 @cindex SAVE statement
675 @cindex statements, SAVE
676 Treat each program unit as if the @code{SAVE} statement was specified for
677 every local variable and array referenced in it. Does not affect common
678 blocks. (Some Fortran compilers provide this option under the name
679 @option{-static}.)
681 @cindex @option{-ff2c} option
682 @cindex options, @option{-ff2c}
683 @item -ff2c
684 @cindex calling convention
685 @cindex @command{f2c} calling convention
686 @cindex @command{g77} calling convention
687 @cindex libf2c calling convention
688 Generate code designed to be compatible with code generated
689 by @command{g77} and @command{f2c}.
691 The calling conventions used by @command{g77} (originally implemented
692 in @command{f2c}) require functions that return type
693 default @code{REAL} to actually return the C type @code{double}, and
694 functions that return type @code{COMPLEX} to return the values via an
695 extra argument in the calling sequence that points to where to
696 store the return value.  Under the default GNU calling conventions, such
697 functions simply return their results as they would in GNU
698 C---default @code{REAL} functions return the C type @code{float}, and
699 @code{COMPLEX} functions return the GNU C type @code{complex}.
700 Additionally, this option implies the @option{-fsecond-underscore}
701 option, unless @option{-fno-second-underscore} is explicitly requested.
703 This does not affect the generation of code that interfaces with
704 the @command{libgfortran} library.
706 @emph{Caution:} It is not a good idea to mix Fortran code compiled
707 with @code{-ff2c} with code compiled with the default @code{-fno-f2c}
708 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
709 functions between program parts which were compiled with different
710 calling conventions will break at execution time.
712 @emph{Caution:} This will break code which passes intrinsic functions
713 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
714 the library implementations use the @command{-fno-f2c} calling conventions.
716 @cindex @option{-fno-underscoring option}
717 @cindex options, @option{-fno-underscoring}
718 @item -fno-underscoring
719 @cindex underscore
720 @cindex symbol names, underscores
721 @cindex transforming symbol names
722 @cindex symbol names, transforming
723 Do not transform names of entities specified in the Fortran
724 source file by appending underscores to them.
726 With @option{-funderscoring} in effect, GNU Fortran appends one
727 underscore to external names with no underscores.  This is done to ensure
728 compatibility with code produced by many UNIX Fortran compilers.
730 @emph{Caution}: The default behavior of GNU Fortran is
731 incompatible with @command{f2c} and @command{g77}, please use the
732 @option{-ff2c} option if you want object files compiled with
733 GNU Fortran to be compatible with object code created with these
734 tools.
736 Use of @option{-fno-underscoring} is not recommended unless you are
737 experimenting with issues such as integration of GNU Fortran into
738 existing system environments (vis-a-vis existing libraries, tools, and
739 so on).
741 For example, with @option{-funderscoring}, and assuming other defaults like
742 @option{-fcase-lower} and that @samp{j()} and @samp{max_count()} are
743 external functions while @samp{my_var} and @samp{lvar} are local variables,
744 a statement like
746 @smallexample
747 I = J() + MAX_COUNT (MY_VAR, LVAR)
748 @end smallexample
750 @noindent
751 is implemented as something akin to:
753 @smallexample
754 i = j_() + max_count__(&my_var__, &lvar);
755 @end smallexample
757 With @option{-fno-underscoring}, the same statement is implemented as:
759 @smallexample
760 i = j() + max_count(&my_var, &lvar);
761 @end smallexample
763 Use of @option{-fno-underscoring} allows direct specification of
764 user-defined names while debugging and when interfacing GNU Fortran
765 code with other languages.
767 Note that just because the names match does @emph{not} mean that the
768 interface implemented by GNU Fortran for an external name matches the
769 interface implemented by some other language for that same name.
770 That is, getting code produced by GNU Fortran to link to code produced
771 by some other compiler using this or any other method can be only a
772 small part of the overall solution---getting the code generated by
773 both compilers to agree on issues other than naming can require
774 significant effort, and, unlike naming disagreements, linkers normally
775 cannot detect disagreements in these other areas.
777 Also, note that with @option{-fno-underscoring}, the lack of appended
778 underscores introduces the very real possibility that a user-defined
779 external name will conflict with a name in a system library, which
780 could make finding unresolved-reference bugs quite difficult in some
781 cases---they might occur at program run time, and show up only as
782 buggy behavior at run time.
784 In future versions of GNU Fortran we hope to improve naming and linking
785 issues so that debugging always involves using the names as they appear
786 in the source, even if the names as seen by the linker are mangled to
787 prevent accidental linking between procedures with incompatible
788 interfaces.
790 @cindex @option{-fsecond-underscore option}
791 @cindex options, @option{-fsecond-underscore}
792 @item -fsecond-underscore
793 @cindex underscore
794 @cindex symbol names, underscores
795 @cindex transforming symbol names
796 @cindex symbol names, transforming
797 @cindex @command{f2c} calling convention
798 @cindex @command{g77} calling convention
799 @cindex libf2c calling convention
800 By default, GNU Fortran appends an underscore to external
801 names.  If this option is used GNU Fortran appends two
802 underscores to names with underscores and one underscore to external names
803 with no underscores.  GNU Fortran also appends two underscores to
804 internal names with underscores to avoid naming collisions with external
805 names.
807 This option has no effect if @option{-fno-underscoring} is
808 in effect.  It is implied by the @option{-ff2c} option.
810 Otherwise, with this option, an external name such as @samp{MAX_COUNT}
811 is implemented as a reference to the link-time external symbol
812 @samp{max_count__}, instead of @samp{max_count_}.  This is required
813 for compatibility with @command{g77} and @command{f2c}, and is implied
814 by use of the @option{-ff2c} option.
817 @cindex -fbounds-check option
818 @cindex -ffortran-bounds-check option
819 @item -fbounds-check
820 @cindex bounds checking
821 @cindex range checking
822 @cindex array bounds checking
823 @cindex subscript checking
824 @cindex checking subscripts
825 Enable generation of run-time checks for array subscripts
826 and against the declared minimum and maximum values.  It also
827 checks array indices for assumed and deferred
828 shape arrays against the actual allocated bounds.
830 In the future this may also include other forms of checking, eg. checking
831 substring references.
834 @cindex -fmax-stack-var-size option
835 @item -fmax-stack-var-size=@var{n}
836 This option specifies the size in bytes of the largest array that will be put
837 on the stack.
839 This option currently only affects local arrays declared with constant
840 bounds, and may not apply to all character variables.
841 Future versions of GNU Fortran may improve this behavior.
843 The default value for @var{n} is 32768.
845 @cindex -fpack-derived
846 @item -fpack-derived
847 @cindex Structure packing
848 This option tells GNU Fortran to pack derived type members as closely as
849 possible.  Code compiled with this option is likely to be incompatible
850 with code compiled without this option, and may execute slower.
852 @cindex -frepack-arrays option
853 @item -frepack-arrays
854 @cindex Repacking arrays
855 In some circumstances GNU Fortran may pass assumed shape array
856 sections via a descriptor describing a discontiguous area of memory.
857 This option adds code to the function prologue to repack the data into
858 a contiguous block at runtime.
860 This should result in faster accesses to the array.  However it can introduce
861 significant overhead to the function call, especially  when the passed data
862 is discontiguous.
864 @cindex -fshort-enums
865 @item -fshort-enums
866 This option is provided for interoperability with C code that was
867 compiled with the @command{-fshort-enums} option.  It will make
868 GNU Fortran choose the smallest @code{INTEGER} kind a given
869 enumerator set will fit in, and give all its enumerators this kind.
870 @end table
872 @xref{Code Gen Options,,Options for Code Generation Conventions,
873 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
874 offered by the GBE
875 shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
878 @c man end
880 @node Environment Variables
881 @section Environment Variables Affecting @command{gfortran}
882 @cindex environment variables
884 @c man begin ENVIRONMENT
886 The @command{gfortran} compiler currently does not make use of any environment
887 variables to control its operation above and beyond those
888 that affect the operation of @command{gcc}.
890 @xref{Environment Variables,,Environment Variables Affecting GCC,
891 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
892 variables.
894 @xref{Runtime}, for environment variables that affect the
895 run-time behavior of programs compiled with GNU Fortran.
896 @c man end