2006-03-22 Thomas Koenig <Thomas.Koenig@onlien.de>
[official-gcc.git] / gcc / fortran / invoke.texi
blobe95b32b70acc1c4af775bc77d5771d4e257170f4
1 @c Copyright (C) 2004, 2005, 2006
2 @c Free Software Foundation, Inc.
3 @c This is part of the GFORTRAN 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 95 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 GFORTRAN@.
58 @c man end
59 @end ignore
61 @node Invoking GFORTRAN
62 @chapter GNU Fortran 95 Command Options
63 @cindex GNU Fortran 95 command options
64 @cindex command options
65 @cindex options, GNU Fortran 95 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 gfortran 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 @command{gcc} and @command{gfortran} 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 @command{gfortran} to the @command{gcc} distribution
84 enables acceptance of @command{gfortran} 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 GNU Fortran.
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 -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 }
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 -fpackderived  -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 dialect of Fortran
176 that the compiler accepts:
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.
194 @cindex option, -fd-lines-as-code
195 @cindex -fd-lines-as-code, option
196 @cindex option, -fd-lines-as-comments
197 @cindex -fd-lines-as-comments, option
198 @item -fd-lines-as-code
199 @item -fd-lines-as-comment
200 Enables special treating for lines with @samp{d} or @samp{D} in fixed
201 form sources.  If the @option{-fd-lines-as-code} option is given
202 they are treated as if the first column contained a blank.  If the
203 @option{-fd-lines-as-comments} option is given, they are treated as
204 comment lines.
206 @cindex option, -fdefault-double-8
207 @cindex -fdefault-double-8, option
208 @item -fdefault-double-8
209 Set the "DOUBLE PRECISION" type to an 8 byte wide.
211 @cindex option, -fdefault-integer-8
212 @cindex -fdefault-integer-8, option
213 @item -fdefault-integer-8
214 Set the default integer and logical types to an 8 byte wide type.
215 Do nothing if this is already the default.
217 @cindex option, -fdefault-real-8
218 @cindex -fdefault-real-8, option
219 @item -fdefault-real-8
220 Set the default real type to an 8 byte wide type.
221 Do nothing if this is already the default.
223 @cindex -fdollar-ok option
224 @cindex options, -fdollar-ok
225 @item -fdollar-ok
226 @cindex dollar sign
227 @cindex symbol names
228 @cindex character set
229 Allow @samp{$} as a valid character in a symbol name.
231 @cindex -fno-backslash option
232 @cindex options, -fno-backslash
233 @item -fno-backslash
234 @cindex backslash
235 @cindex escape characters
236 Compile switch to change the interpretation of a backslash from
237 ``C''-style escape characters to a single backslash character.
239 @cindex -ffixed-line-length-@var{n} option
240 @cindex options, -ffixed-line-length-@var{n}
241 @item -ffixed-line-length-@var{n}
242 @cindex source file format
243 @cindex lines, length
244 @cindex length of source lines
245 @cindex fixed form
246 @cindex limits, lengths of source lines
247 Set column after which characters are ignored in typical fixed-form
248 lines in the source file, and through which spaces are assumed (as
249 if padded to that length) after the ends of short fixed-form lines.
251 @cindex card image
252 @cindex extended-source option
253 Popular values for @var{n} include 72 (the
254 standard and the default), 80 (card image), and 132 (corresponds
255 to ``extended-source'' options in some popular compilers).
256 @var{n} may be @samp{none}, meaning that the entire line is meaningful
257 and that continued character constants never have implicit spaces appended
258 to them to fill out the line.
259 @option{-ffixed-line-length-0} means the same thing as
260 @option{-ffixed-line-length-none}.
262 @cindex -ffree-line-length-@var{n} option
263 @cindex options, -ffree-line-length-@var{n}
264 @item -ffree-line-length-@var{n}
265 @cindex source file format
266 @cindex lines, length
267 @cindex length of source lines
268 @cindex free form
269 @cindex limits, lengths of source lines
270 Set column after which characters are ignored in typical free-form
271 lines in the source file. For free-form, the default value is 132.
272 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
273 @option{-ffree-line-length-0} means the same thing as
274 @option{-ffree-line-length-none}.
276 @cindex -fmax-identifier-length=@var{n} option
277 @cindex option -fmax-identifier-length=@var{n}
278 @item -fmax-identifier-length=@var{n}
279 Specify the maximum allowed identifier length. Typical values are
280 31 (Fortran 95) and 63 (Fortran 200x).
282 @cindex -fimplicit-none option
283 @cindex options, -fimplicit-none
284 @item -fimplicit-none
285 Specify that no implicit typing is allowed, unless overridden by explicit
286 @samp{IMPLICIT} statements.  This is the equivalent of adding
287 @samp{implicit none} to the start of every procedure.
289 @cindex -fcray-pointer option
290 @cindex options, -fcray-pointer
291 @item -fcray-pointer
292 Enables the Cray pointer extension, which provides a C-like pointer.
294 @cindex -fopenmp
295 @cindex options, -fopenmp
296 @item -fopenmp
297 Enables handling of OpenMP @code{!$omp} directives in free form
298 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
299 enables @code{!$} conditional compilation sentinels in free form
300 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form
301 and when linking arranges for the OpenMP runtime library to be linked
304 @cindex -std=@var{std} option
305 @cindex option, -std=@var{std}
306 @item -std=@var{std}
307 Conform to the specified standard.  Allowed values for @var{std} are
308 @samp{gnu}, @samp{f95}, @samp{f2003} and @samp{legacy}.
310 @end table
312 @node Warning Options
313 @section Options to Request or Suppress Warnings
314 @cindex options, warnings
315 @cindex warnings, suppressing
316 @cindex messages, warning
317 @cindex suppressing warnings
319 Warnings are diagnostic messages that report constructions which
320 are not inherently erroneous but which are risky or suggest there
321 might have been an error.
323 You can request many specific warnings with options beginning @option{-W},
324 for example @option{-Wimplicit} to request warnings on implicit
325 declarations.  Each of these specific warning options also has a
326 negative form beginning @option{-Wno-} to turn off warnings;
327 for example, @option{-Wno-implicit}.  This manual lists only one of the
328 two forms, whichever is not the default.
330 These options control the amount and kinds of warnings produced by GNU
331 Fortran:
333 @table @gcctabopt
334 @cindex syntax checking
335 @cindex -fsyntax-only option
336 @cindex options, -fsyntax-only
337 @item -fsyntax-only
338 Check the code for syntax errors, but don't do anything beyond that.
340 @cindex -pedantic option
341 @cindex options, -pedantic
342 @item -pedantic
343 Issue warnings for uses of extensions to FORTRAN 95.
344 @option{-pedantic} also applies to C-language constructs where they
345 occur in GNU Fortran source files, such as use of @samp{\e} in a
346 character constant within a directive like @samp{#include}.
348 Valid FORTRAN 95 programs should compile properly with or without
349 this option.
350 However, without this option, certain GNU extensions and traditional
351 Fortran features are supported as well.
352 With this option, many of them are rejected.
354 Some users try to use @option{-pedantic} to check programs for conformance.
355 They soon find that it does not do quite what they want---it finds some
356 nonstandard practices, but not all.
357 However, improvements to @command{gfortran} in this area are welcome.
359 This should be used in conjunction with -std=@var{std}.
361 @cindex -pedantic-errors option
362 @cindex options, -pedantic-errors
363 @item -pedantic-errors
364 Like @option{-pedantic}, except that errors are produced rather than
365 warnings.
367 @cindex -w option
368 @cindex options, -w
369 @item -w
370 Inhibit all warning messages.
373 @cindex -Wall option
374 @cindex options, -Wall
375 @item -Wall
376 @cindex all warnings
377 @cindex warnings, all
378 Enables commonly used warning options pertaining to usage that
379 we recommend avoiding and that we believe are easy to avoid.
380 This currently includes @option{-Wunused-labels}, @option{-Waliasing},
381 @option{-Wampersand}, @option{-Wsurprising}, @option{-Wnonstd-intrinsic},
382 @option{-Wno-tabs}, and @option{-Wline-truncation}.
385 @cindex -Waliasing option
386 @cindex options, -Waliasing
387 @item -Waliasing
388 @cindex aliasing
389 Warn about possible aliasing of dummy arguments. Specifically, it warns
390 if the same actual argument is associated with a dummy argument with
391 @code{intent(in)} and a dummy argument with @code{intent(out)} in a call
392 with an explicit interface.
394 The following example will trigger the warning.
395 @smallexample
396   interface
397     subroutine bar(a,b)
398       integer, intent(in) :: a
399       integer, intent(out) :: b
400     end subroutine
401   end interface
402   integer :: a
404   call bar(a,a)
405 @end smallexample
408 @cindex -Wampersand option
409 @cindex options, -Wampersand
410 @item -Wampersand
411 @cindex ampersand
412 Warn about missing ampersand in continued character constants. The warning is
413 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95}, and
414 @option{-std=f2003}. Note: With no ampersand given in a continued character
415 constant, gfortran assumes continuation at the first non-comment,
416 non-whitespace character after the ampersand that initiated the continuation.
419 @cindex -Wconversion option
420 @cindex options, -Wconversion
421 @item -Wconversion
422 @cindex conversion
423 Warn about implicit conversions between different types.
426 @cindex -Wimplicit-interface option
427 @cindex options, -Wimplicit-interface
428 @item -Wimplicit-interface
429 Warn about when procedure are called without an explicit interface.
430 Note this only checks that an explicit interface is present.  It does not
431 check that the declared interfaces are consistent across program units.
434 @cindex -Wnonstd-intrinsic option
435 @cindex options, -Wnonstd-intrinsic
436 @item -Wnonstd-intrinsic
437 Warn if the user tries to use an intrinsic that does not belong to the 
438 standard the user has chosen via the -std option.
441 @cindex -Wsurprising
442 @cindex options, -Wsurprising
443 @item -Wsurprising
444 @cindex Suspicious
445 Produce a warning when ``suspicious'' code constructs are encountered.
446 While technically legal these usually indicate that an error has been made.
448 This currently produces a warning under the following circumstances:
450 @itemize @bullet
451 @item
452 An INTEGER SELECT construct has a CASE that can never be matched as its
453 lower value is greater than its upper value.
455 @item
456 A LOGICAL SELECT construct has three CASE statements.
457 @end itemize
460 @cindex -Wtabs
461 @cindex options, -Wtabs
462 @item -Wtabs
463 @cindex Tabs
464 By default, tabs are accepted as whitespace, but tabs are not members
465 of the Fortran Character Set.  @option{-Wno-tabs} will cause a warning
466 to be issued if a tab is encountered. Note, @option{-Wno-tabs} is active
467 for @option{-pedantic}, @option{-std=f95}, and @option{-Wall}.
470 @cindex -Wunderflow
471 @cindex options, -Wunderflow
472 @item -Wunderflow
473 @cindex UNDERFLOW
474 Produce a warning when numerical constant expressions are
475 encountered, which yield an UNDERFLOW during compilation.
478 @cindex -Wunused-labels option
479 @cindex options, -Wunused-labels
480 @item -Wunused-labels
481 @cindex unused labels
482 @cindex labels, unused
483 Warn whenever a label is defined but never referenced.
486 @cindex -Werror
487 @cindex options, -Werror
488 @item -Werror
489 Turns all warnings into errors.
492 @cindex -W option
493 @cindex options, -W
494 @item -W
495 @cindex extra warnings
496 @cindex warnings, extra
497 Turns on ``extra warnings'' and, if optimization is specified
498 via @option{-O}, the @option{-Wuninitialized} option.
499 (This might change in future versions of @command{gfortran}
500 @end table
502 @xref{Warning Options,,Options to Request or Suppress Warnings,
503 gcc,Using the GNU Compiler Collection (GCC)}, for information on more
504 options offered by the GBE shared by @command{gfortran}, @command{gcc} and
505 other GNU compilers.
507 Some of these have no effect when compiling programs written in Fortran.
509 @node Debugging Options
510 @section Options for Debugging Your Program or GNU Fortran
511 @cindex options, debugging
512 @cindex debugging information options
514 GNU Fortran has various special options that are used for debugging
515 either your program or @command{gfortran}
517 @table @gcctabopt
518 @cindex -fdump-parse-tree option
519 @cindex option, -fdump-parse-tree
520 @item -fdump-parse-tree
521 Output the internal parse tree before starting code generation.  Only
522 really useful for debugging gfortran itself.
523 @end table
525 @table @gcctabopt
526 @cindex -ffpe-trap=@var{list} option
527 @cindex option, -ffpe-trap=@var{list}
528 @item -ffpe-trap=@var{list}
529 Specify a list of IEEE exceptions when a Floating Point Exception
530 (FPE) should be raised.  On most systems, this will result in a SIGFPE
531 signal being sent and the program being interrupted, producing a core
532 file useful for debugging.  @var{list} is a (possibly empty) comma-separated
533 list of the following IEEE exceptions: @samp{invalid} (invalid floating
534 point operation, such as @code{sqrt(-1.0)}), @samp{zero} (division by
535 zero), @samp{overflow} (overflow in a floating point operation),
536 @samp{underflow} (underflow in a floating point operation),
537 @samp{precision} (loss of precision during operation) and @samp{denormal}
538 (operation produced a denormal denormal value).
539 @end table
541 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
542 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
543 debugging options.
545 @node Directory Options
546 @section Options for Directory Search
547 @cindex directory, options
548 @cindex options, directory search
549 @cindex search path
551 @cindex INCLUDE directive
552 @cindex directive, INCLUDE
553 These options affect how @command{gfortran} searches
554 for files specified by the @code{INCLUDE} directive and where it searches
555 for previously compiled modules.
557 It also affects the search paths used by @command{cpp} when used to preprocess
558 Fortran source.
560 @table @gcctabopt
561 @cindex -Idir option
562 @cindex options, -Idir
563 @item -I@var{dir}
564 @cindex directory, search paths for inclusion
565 @cindex inclusion, directory search paths for
566 @cindex search paths, for included files
567 @cindex paths, search
568 @cindex module search path
569 These affect interpretation of the @code{INCLUDE} directive
570 (as well as of the @code{#include} directive of the @command{cpp}
571 preprocessor).
573 Also note that the general behavior of @option{-I} and
574 @code{INCLUDE} is pretty much the same as of @option{-I} with
575 @code{#include} in the @command{cpp} preprocessor, with regard to
576 looking for @file{header.gcc} files and other such things.
578 This path is also used to search for @samp{.mod} files when previously
579 compiled modules are required by a @code{USE} statement.
581 @xref{Directory Options,,Options for Directory Search,
582 gcc,Using the GNU Compiler Collection (GCC)}, for information on the
583 @option{-I} option.
585 @cindex -Mdir option
586 @cindex option, -Mdir
587 @item -M@var{dir}
588 @item -J@var{dir}
589 This option specifies where to put @samp{.mod} files for compiled modules.
590 It is also added to the list of directories to searched by an @code{USE}
591 statement.
593 The default is the current directory.
595 @option{-J} is an alias for @option{-M} to avoid conflicts with existing
596 GCC options.
597 @end table
599 @node Runtime Options
600 @section Influencing runtime behavior
601 @cindex runtime, options
603 These options affect the runtime behavior of @command{gfortran}.
604 @table @gcctabopt
605 @cindex -fconvert=@var{conversion} option
606 @item -fconvert=@var{conversion}
607 Specify the representation of data for unformatted files.  Valid
608 values for conversion are: @samp{native}, the default; @samp{swap},
609 swap between big- and little-endian; @samp{big-endian}, use big-endian
610 representation for unformatted files; @samp{little-endian}, use little-endian
611 representation for unformatted files.
613 @emph{This option has an effect only when used in the main program.
614 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
615 variable override the default specified by -fconvert.}
617 @cindex -frecord-marker=@var{length}
618 @item -frecord-marker=@var{length}
619 Specify the length of record markers for unformatted files.
620 Valid values for @var{length} are 4 and 8.  Default is whatever
621 @code{off_t} is specified to be on that particular system.
622 Note that specifying @var{length} as 4 limits the record
623 length of unformatted files to 2 GB.  This option does not
624 extend the maximum possible record length on systems where
625 @code{off_t} is a four_byte quantity.
627 @end table
629 @node Code Gen Options
630 @section Options for Code Generation Conventions
631 @cindex code generation, conventions
632 @cindex options, code generation
633 @cindex run-time, options
635 These machine-independent options control the interface conventions
636 used in code generation.
638 Most of them have both positive and negative forms; the negative form
639 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
640 one of the forms is listed---the one which is not the default.  You
641 can figure out the other form by either removing @option{no-} or adding
644 @table @gcctabopt
645 @cindex @option{-fno-automatic} option
646 @cindex options, @option{-fno-automatic}
647 @item -fno-automatic
648 @cindex SAVE statement
649 @cindex statements, SAVE
650 Treat each program unit as if the @code{SAVE} statement was specified for
651 every local variable and array referenced in it. Does not affect common
652 blocks. (Some Fortran compilers provide this option under the name
653 @option{-static}.)
655 @cindex @option{-ff2c} option
656 @cindex options, @option{-ff2c}
657 @item -ff2c
658 @cindex calling convention
659 @cindex @command{f2c} calling convention
660 @cindex @command{g77} calling convention
661 @cindex libf2c calling convention
662 Generate code designed to be compatible with code generated
663 by @command{g77} and @command{f2c}.
665 The calling conventions used by @command{g77} (originally implemented
666 in @command{f2c}) require functions that return type
667 default @code{REAL} to actually return the C type @code{double}, and
668 functions that return type @code{COMPLEX} to return the values via an
669 extra argument in the calling sequence that points to where to
670 store the return value.  Under the default GNU calling conventions, such
671 functions simply return their results as they would in GNU
672 C -- default @code{REAL} functions return the C type @code{float}, and
673 @code{COMPLEX} functions return the GNU C type @code{complex}.
674 Additionally, this option implies the @option{-fsecond-underscore}
675 option, unless @option{-fno-second-underscore} is explicitly requested.
677 This does not affect the generation of code that interfaces with
678 the @command{libgfortran} library.
680 @emph{Caution:} It is not a good idea to mix Fortran code compiled
681 with @code{-ff2c} with code compiled with the default @code{-fno-f2c}
682 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
683 functions between program parts which were compiled with different
684 calling conventions will break at execution time.
686 @emph{Caution:} This will break code which passes intrinsic functions
687 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
688 the library implementations use the @command{-fno-f2c} calling conventions.
690 @cindex @option{-fno-underscoring option}
691 @cindex options, @option{-fno-underscoring}
692 @item -fno-underscoring
693 @cindex underscore
694 @cindex symbol names, underscores
695 @cindex transforming symbol names
696 @cindex symbol names, transforming
697 Do not transform names of entities specified in the Fortran
698 source file by appending underscores to them.
700 With @option{-funderscoring} in effect, @command{gfortran} appends one
701 underscore to external names with no underscores.  This is done to ensure
702 compatibility with code produced by many UNIX Fortran compilers.
704 @emph{Caution}: The default behavior of @command{gfortran} is
705 incompatible with @command{f2c} and @command{g77}, please use the
706 @option{-ff2c} option if you want object files compiled with
707 @option{gfortran} to be compatible with object code created with these
708 tools.
710 Use of @option{-fno-underscoring} is not recommended unless you are
711 experimenting with issues such as integration of (GNU) Fortran into
712 existing system environments (vis-a-vis existing libraries, tools, and
713 so on).
715 For example, with @option{-funderscoring}, and assuming other defaults like
716 @option{-fcase-lower} and that @samp{j()} and @samp{max_count()} are
717 external functions while @samp{my_var} and @samp{lvar} are local variables,
718 a statement like
720 @smallexample
721 I = J() + MAX_COUNT (MY_VAR, LVAR)
722 @end smallexample
724 @noindent
725 is implemented as something akin to:
727 @smallexample
728 i = j_() + max_count__(&my_var__, &lvar);
729 @end smallexample
731 With @option{-fno-underscoring}, the same statement is implemented as:
733 @smallexample
734 i = j() + max_count(&my_var, &lvar);
735 @end smallexample
737 Use of @option{-fno-underscoring} allows direct specification of
738 user-defined names while debugging and when interfacing @command{gfortran}
739 code with other languages.
741 Note that just because the names match does @emph{not} mean that the
742 interface implemented by @command{gfortran} for an external name matches the
743 interface implemented by some other language for that same name.
744 That is, getting code produced by @command{gfortran} to link to code produced
745 by some other compiler using this or any other method can be only a
746 small part of the overall solution---getting the code generated by
747 both compilers to agree on issues other than naming can require
748 significant effort, and, unlike naming disagreements, linkers normally
749 cannot detect disagreements in these other areas.
751 Also, note that with @option{-fno-underscoring}, the lack of appended
752 underscores introduces the very real possibility that a user-defined
753 external name will conflict with a name in a system library, which
754 could make finding unresolved-reference bugs quite difficult in some
755 cases---they might occur at program run time, and show up only as
756 buggy behavior at run time.
758 In future versions of @command{gfortran} we hope to improve naming and linking
759 issues so that debugging always involves using the names as they appear
760 in the source, even if the names as seen by the linker are mangled to
761 prevent accidental linking between procedures with incompatible
762 interfaces.
764 @cindex @option{-fsecond-underscore option}
765 @cindex options, @option{-fsecond-underscore}
766 @item -fsecond-underscore
767 @cindex underscore
768 @cindex symbol names, underscores
769 @cindex transforming symbol names
770 @cindex symbol names, transforming
771 @cindex @command{f2c} calling convention
772 @cindex @command{g77} calling convention
773 @cindex libf2c calling convention
774 By default, @command{gfortran} appends an underscore to external
775 names.  If this option is used @command{gfortran} appends two
776 underscores to names with underscores and one underscore to external names
777 with no underscores.  (@command{gfortran} also appends two underscores to
778 internal names with underscores to avoid naming collisions with external
779 names.
781 This option has no effect if @option{-fno-underscoring} is
782 in effect.  It is implied by the @option{-ff2c} option.
784 Otherwise, with this option, an external name such as @samp{MAX_COUNT}
785 is implemented as a reference to the link-time external symbol
786 @samp{max_count__}, instead of @samp{max_count_}.  This is required
787 for compatibility with @command{g77} and @command{f2c}, and is implied
788 by use of the @option{-ff2c} option.
791 @cindex -fbounds-check option
792 @cindex -ffortran-bounds-check option
793 @item -fbounds-check
794 @cindex bounds checking
795 @cindex range checking
796 @cindex array bounds checking
797 @cindex subscript checking
798 @cindex checking subscripts
799 Enable generation of run-time checks for array subscripts
800 and against the declared minimum and maximum values.  It also
801 checks array indices for assumed and deferred
802 shape arrays against the actual allocated bounds.
804 In the future this may also include other forms of checking, eg. checking
805 substring references.
808 @cindex -fmax-stack-var-size option
809 @item -fmax-stack-var-size=@var{n}
810 This option specifies the size in bytes of the largest array that will be put
811 on the stack.
813 This option currently only affects local arrays declared with constant
814 bounds, and may not apply to all character variables.
815 Future versions of @command{gfortran} may improve this behavior.
817 The default value for @var{n} is 32768.
819 @cindex -fpackderived
820 @item -fpackderived
821 @cindex Structure packing
822 This option tells gfortran to pack derived type members as closely as
823 possible.  Code compiled with this option is likely to be incompatible
824 with code compiled without this option, and may execute slower.
826 @cindex -frepack-arrays option
827 @item -frepack-arrays
828 @cindex Repacking arrays
829 In some circumstances @command{gfortran} may pass assumed shape array
830 sections via a descriptor describing a discontiguous area of memory.
831 This option adds code to the function prologue to repack the data into
832 a contiguous block at runtime.
834 This should result in faster accesses to the array.  However it can introduce
835 significant overhead to the function call, especially  when the passed data
836 is discontiguous.
838 @cindex -fshort-enums
839 @item -fshort-enums
840 This option is provided for interoperability with C code that was
841 compiled with the @command{-fshort-enums} option.  It will make
842 @command{gfortran} choose the smallest @code{INTEGER} kind a given
843 enumerator set will fit in, and give all its enumerators this kind.
844 @end table
846 @xref{Code Gen Options,,Options for Code Generation Conventions,
847 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
848 offered by the GBE
849 shared by @command{gfortran} @command{gcc} and other GNU compilers.
852 @c man end
854 @node Environment Variables
855 @section Environment Variables Affecting GNU Fortran
856 @cindex environment variables
858 @c man begin ENVIRONMENT
860 GNU Fortran 95 currently does not make use of any environment
861 variables to control its operation above and beyond those
862 that affect the operation of @command{gcc}.
864 @xref{Environment Variables,,Environment Variables Affecting GCC,
865 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
866 variables.
868 @xref{Runtime}, for environment variables that affect the
869 run-time behavior of @command{gfortran} programs.
870 @c man end