2007-09-02 Steven G. Kargl <kargl@gcc.gnu.org>
[official-gcc.git] / gcc / fortran / invoke.texi
blob1388b6c123ec37eec0650f48b2bd5070be96f30a
1 @c Copyright (C) 2004, 2005, 2006, 2007
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, 2007
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{@value{BUGURL}}.
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 All GCC and GNU Fortran options
79 are accepted both by @command{gfortran} and by @command{gcc}
80 (as well as any other drivers built at the same time,
81 such as @command{g++}),
82 since adding GNU Fortran to the GCC distribution
83 enables acceptance of GNU Fortran options
84 by all of the relevant drivers.
86 In some cases, options have positive and negative forms;
87 the negative form of @option{-ffoo} would be @option{-fno-foo}.
88 This manual documents only one of these two forms, whichever
89 one is not the default.
90 @c man end
92 @menu
93 * Option Summary::      Brief list of all @command{gfortran} options,
94                         without explanations.
95 * Fortran Dialect Options::  Controlling the variant of Fortran language
96                              compiled.
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
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{-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 -fno-backslash -fmodule-private}
126 @item Error and Warning Options
127 @xref{Error and Warning Options,,Options to request or suppress errors
128 and warnings}.
129 @gccoptlist{-fmax-errors=@var{n} @gol
130 -fsyntax-only  -pedantic  -pedantic-errors @gol
131 -Wall  -Waliasing  -Wampersand  -Wcharacter-truncation  -Wconversion @gol
132 -Wimplicit-interface  -Wline-truncation  -Wnonstd-intrinsics  -Wsurprising @gol
133 -Wno-tabs  -Wunderflow -Wunused-parameter}
135 @item Debugging Options
136 @xref{Debugging Options,,Options for debugging your program or GNU Fortran}.
137 @gccoptlist{-fdump-parse-tree  -ffpe-trap=@var{list} @gol
138 -fdump-core -fbacktrace}
140 @item Directory Options
141 @xref{Directory Options,,Options for directory search}.
142 @gccoptlist{-I@var{dir}  -J@var{dir}  -M@var{dir}  -fintrinsic-modules-path @var{dir}}
144 @item Link Options
145 @xref{Link Options,,Options for influencing the linking step}.
146 @gccoptlist{-static-libgfortran}
148 @item Runtime Options
149 @xref{Runtime Options,,Options for influencing runtime behavior}.
150 @gccoptlist{-fconvert=@var{conversion}  -frecord-marker=@var{length} @gol
151 -fmax-subrecord-length=@var{length}  -fsign-zero}
153 @item Code Generation Options
154 @xref{Code Gen Options,,Options for code generation conventions}.
155 @gccoptlist{-fno-automatic  -ff2c  -fno-underscoring
156 -fsecond-underscore @gol
157 -fbounds-check  -fmax-stack-var-size=@var{n} @gol
158 -fpack-derived  -frepack-arrays  -fshort-enums  -fexternal-blas @gol
159 -fblas-matmul-limit=@var{n} -frecursive}
160 @end table
162 @menu
163 * Fortran Dialect Options::  Controlling the variant of Fortran language
164                              compiled.
165 * Error and Warning Options::     How picky should the compiler be?
166 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
167 * Directory Options::   Where to find module files
168 * Link Options ::       Influencing the linking step
169 * Runtime Options::     Influencing runtime behavior
170 * Code Gen Options::    Specifying conventions for function calls, data layout
171                         and register usage.
172 @end menu
174 @node Fortran Dialect Options
175 @section Options controlling Fortran dialect
176 @cindex dialect options
177 @cindex language, dialect options
178 @cindex options, dialect
180 The following options control the details of the Fortran dialect
181 accepted by the compiler:
183 @table @gcctabopt
184 @item -ffree-form
185 @item -ffixed-form
186 @opindex @code{ffree-form}
187 @opindex @code{fno-fixed-form}
188 @cindex options, fortran dialect
189 @cindex file format, free
190 @cindex file format, fixed
191 Specify the layout used by the source file.  The free form layout
192 was introduced in Fortran 90.  Fixed form was traditionally used in
193 older Fortran programs.  When neither option is specified, the source
194 form is determined by the file extension.
196 @item -fall-intrinsics
197 @opindex @code{fall-intrinsics}
198 Accept all of the intrinsic procedures provided in libgfortran 
199 without regard to the setting of @option{-std}.  In particular, 
200 this option can be quite useful with @option{-std=f95}.  Additionally,
201 @command{gfortran} will ignore @option{-Wnonstd-intrinsics}.
203 @item -fd-lines-as-code
204 @item -fd-lines-as-comments
205 @opindex @code{fd-lines-as-code}
206 @opindex @code{fd-lines-as-comments}
207 Enable special treatment for lines beginning with @code{d} or @code{D}
208 in fixed form sources.  If the @option{-fd-lines-as-code} option is
209 given they are treated as if the first column contained a blank.  If the
210 @option{-fd-lines-as-comments} option is given, they are treated as
211 comment lines.
213 @item -fdefault-double-8
214 @opindex @code{fdefault-double-8}
215 Set the @code{DOUBLE PRECISION} type to an 8 byte wide type.
217 @item -fdefault-integer-8
218 @opindex @code{fdefault-integer-8}
219 Set the default integer and logical types to an 8 byte wide type.
220 Do nothing if this is already the default.
222 @item -fdefault-real-8
223 @opindex @code{fdefault-real-8}
224 Set the default real type to an 8 byte wide type.
225 Do nothing if this is already the default.
227 @item -fdollar-ok
228 @opindex @code{fdollar-ok}
229 @cindex $
230 @cindex symbol names
231 @cindex character set
232 Allow @samp{$} as a valid character in a symbol name.
234 @item -fno-backslash
235 @opindex @code{fno-backslash}
236 @cindex backslash
237 @cindex escape characters
238 Change the interpretation of backslashes in string literals from
239 ``C-style'' escape characters to a single backslash character.
241 @item -fmodule-private
242 @opindex @code{fmodule-private}
243 @cindex module entities
244 @cindex private
245 Set the default accessibility of module entities to @code{PRIVATE}.
246 Use-associated entities will not be accessible unless they are explicitly
247 declared as @code{PUBLIC}.
249 @item -ffixed-line-length-@var{n}
250 @opindex @code{ffixed-line-length-}@var{n}
251 @cindex file format, fixed
252 Set column after which characters are ignored in typical fixed-form
253 lines in the source file, and through which spaces are assumed (as
254 if padded to that length) after the ends of short fixed-form lines.
256 Popular values for @var{n} include 72 (the
257 standard and the default), 80 (card image), and 132 (corresponding
258 to ``extended-source'' options in some popular compilers).
259 @var{n} may also be @samp{none}, meaning that the entire line is meaningful
260 and that continued character constants never have implicit spaces appended
261 to them to fill out the line.
262 @option{-ffixed-line-length-0} means the same thing as
263 @option{-ffixed-line-length-none}.
265 @item -ffree-line-length-@var{n}
266 @opindex @code{ffree-line-length-}@var{n}
267 @cindex file format, free
268 Set column after which characters are ignored in typical free-form
269 lines in the source file. The default value is 132.
270 @var{n} may be @samp{none}, meaning that the entire line is meaningful.
271 @option{-ffree-line-length-0} means the same thing as
272 @option{-ffree-line-length-none}.
274 @item -fmax-identifier-length=@var{n}
275 @opindex @code{fmax-identifier-length=}@var{n}
276 Specify the maximum allowed identifier length. Typical values are
277 31 (Fortran 95) and 63 (Fortran 2003).
279 @item -fimplicit-none
280 @opindex @code{fimplicit-none}
281 Specify that no implicit typing is allowed, unless overridden by explicit
282 @code{IMPLICIT} statements.  This is the equivalent of adding
283 @code{implicit none} to the start of every procedure.
285 @item -fcray-pointer
286 @opindex @code{fcray-pointer}
287 Enable the Cray pointer extension, which provides C-like pointer
288 functionality.
290 @item -fopenmp
291 @opindex @code{fopenmp}
292 @cindex OpenMP
293 Enable the OpenMP extensions.  This includes OpenMP @code{!$omp} directives
294 in free form
295 and @code{c$omp}, @code{*$omp} and @code{!$omp} directives in fixed form,
296 @code{!$} conditional compilation sentinels in free form
297 and @code{c$}, @code{*$} and @code{!$} sentinels in fixed form, 
298 and when linking arranges for the OpenMP runtime library to be linked
299 in.  The option @option{-fopenmp} implies @option{-frecursive}.
301 @item -fno-range-check
302 @opindex @code{frange-check}
303 Disable range checking on results of simplification of constant
304 expressions during compilation.  For example, by default, GNU Fortran
305 will give an overflow error at compile time when simplifying @code{a =
306 EXP(1000)}. With @option{-fno-range-check}, no error will be given and
307 the variable @code{a} will be assigned the value @code{+Infinity}.
308 Similarly, @code{DATA i/Z'FFFFFFFF'/} will result in an integer overflow
309 on most systems, but with @option{-fno-range-check} the value will
310 ``wrap around'' and @code{i} will be initialized to @math{-1} instead.
312 @item -std=@var{std}
313 @opindex @code{std=}@var{std} option
314 Specify the standard to which the program is expected to conform, which
315 may be one of @samp{f95}, @samp{f2003}, @samp{gnu}, or @samp{legacy}.
316 The default value for @var{std} is @samp{gnu}, which specifies a
317 superset of the Fortran 95 standard that includes all of the extensions
318 supported by GNU Fortran, although warnings will be given for obsolete
319 extensions not recommended for use in new code.  The @samp{legacy} value
320 is equivalent but without the warnings for obsolete extensions, and may
321 be useful for old non-standard programs.  The @samp{f95} and
322 @samp{f2003} values specify strict conformance to the Fortran 95 and
323 Fortran 2003 standards, respectively; errors are given for all
324 extensions beyond the relevant language standard, and warnings are given
325 for the Fortran 77 features that are permitted but obsolescent in later
326 standards.
328 @end table
330 @node Error and Warning Options
331 @section Options to request or suppress errors and warnings
332 @cindex options, warnings
333 @cindex options, errors
334 @cindex warnings, suppressing
335 @cindex messages, error
336 @cindex messages, warning
337 @cindex suppressing warnings
339 Errors are diagnostic messages that report that the GNU Fortran compiler
340 cannot compile the relevant piece of source code.  The compiler will
341 continue to process the program in an attempt to report further errors
342 to aid in debugging, but will not produce any compiled output.  
344 Warnings are diagnostic messages that report constructions which
345 are not inherently erroneous but which are risky or suggest there is
346 likely to be a bug in the program.  Unless @option{-Werror} is specified,
347 they do not prevent compilation of the program.
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 errors and warnings produced
357 by GNU Fortran:
359 @table @gcctabopt
360 @item -fmax-errors-@var{n}
361 @opindex @code{fmax-errors-}@var{n}
362 @cindex errors, limiting
363 Limits the maximum number of error messages to @var{n}, at which point
364 GNU Fortran bails out rather than attempting to continue processing the
365 source code.  If @var{n} is 0, there is no limit on the number of error
366 messages produced.
368 @item -fsyntax-only
369 @opindex @code{fsyntax-only}
370 @cindex syntax checking
371 Check the code for syntax errors, but don't actually compile it.  This
372 will generate module files for each module present in the code, but no
373 other output file.
375 @item -pedantic
376 @opindex @code{pedantic}
377 Issue warnings for uses of extensions to Fortran 95.
378 @option{-pedantic} also applies to C-language constructs where they
379 occur in GNU Fortran source files, such as use of @samp{\e} in a
380 character constant within a directive like @code{#include}.
382 Valid Fortran 95 programs should compile properly with or without
383 this option.
384 However, without this option, certain GNU extensions and traditional
385 Fortran features are supported as well.
386 With this option, many of them are rejected.
388 Some users try to use @option{-pedantic} to check programs for conformance.
389 They soon find that it does not do quite what they want---it finds some
390 nonstandard practices, but not all.
391 However, improvements to GNU Fortran in this area are welcome.
393 This should be used in conjunction with @option{-std=f95} or
394 @option{-std=f2003}.
396 @item -pedantic-errors
397 @opindex @code{pedantic-errors}
398 Like @option{-pedantic}, except that errors are produced rather than
399 warnings.
401 @item -Wall
402 @opindex @code{Wall}
403 @cindex all warnings
404 @cindex warnings, all
405 Enables commonly used warning options pertaining to usage that
406 we recommend avoiding and that we believe are easy to avoid.
407 This currently includes @option{-Waliasing},
408 @option{-Wampersand}, @option{-Wsurprising}, @option{-Wnonstd-intrinsics},
409 @option{-Wno-tabs}, and @option{-Wline-truncation}.
411 @item -Waliasing
412 @opindex @code{Waliasing}
413 @cindex aliasing
414 @cindex warnings, 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
433 @item -Wampersand
434 @opindex @code{Wampersand}
435 @cindex warnings, ampersand
436 @cindex &
437 Warn about missing ampersand in continued character constants. The warning is
438 given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95}, and
439 @option{-std=f2003}. Note: With no ampersand given in a continued character
440 constant, GNU Fortran assumes continuation at the first non-comment,
441 non-whitespace character after the ampersand that initiated the continuation.
443 @item -Wcharacter-truncation
444 @opindex @code{Wcharacter-truncation}
445 @cindex warnings, character truncation
446 Warn when a character assignment will truncate the assigned string.
448 @item -Wconversion
449 @opindex @code{Wconversion}
450 @cindex warnings, conversion
451 @cindex conversion
452 Warn about implicit conversions between different types.
454 @item -Wimplicit-interface
455 @opindex @code{Wimplicit-interface}
456 @cindex warnings, implicit interface
457 Warn if a procedure is called without an explicit interface.
458 Note this only checks that an explicit interface is present.  It does not
459 check that the declared interfaces are consistent across program units.
461 @item -Wnonstd-intrinsics
462 @opindex @code{Wnonstd-intrinsics}
463 @cindex warnings, non-standard intrinsics
464 Warn if the user tries to use an intrinsic that does not belong to the 
465 standard the user has chosen via the @option{-std} option.
467 @item -Wsurprising
468 @opindex @code{Wsurprising}
469 @cindex warnings, suspicious code
470 Produce a warning when ``suspicious'' code constructs are encountered.
471 While technically legal these usually indicate that an error has been made.
473 This currently produces a warning under the following circumstances:
475 @itemize @bullet
476 @item
477 An INTEGER SELECT construct has a CASE that can never be matched as its
478 lower value is greater than its upper value.
480 @item
481 A LOGICAL SELECT construct has three CASE statements.
482 @end itemize
484 @item -Wtabs
485 @opindex @code{Wtabs}
486 @cindex warnings, tabs
487 @cindex tabulators
488 By default, tabs are accepted as whitespace, but tabs are not members
489 of the Fortran Character Set.  @option{-Wno-tabs} will cause a warning
490 to be issued if a tab is encountered. Note, @option{-Wno-tabs} is active
491 for @option{-pedantic}, @option{-std=f95}, @option{-std=f2003}, and
492 @option{-Wall}.
494 @item -Wunderflow
495 @opindex @code{Wunderflow}
496 @cindex warnings, underflow
497 @cindex underflow
498 Produce a warning when numerical constant expressions are
499 encountered, which yield an UNDERFLOW during compilation.
501 @item -Wunused-parameter
502 @opindex @code{Wunused-parameter}
503 @cindex warnings, unused parameter
504 @cindex unused parameter
505 Contrary to @command{gcc}'s meaning of @option{-Wunused-parameter},
506 @command{gfortran}'s implementation of this option does not warn
507 about unused dummy arguments, but about unused @code{PARAMETER} values.
508 @option{-Wunused-parameter} is not included in @option{-Wall} but is
509 implied by @option{-Wall -Wextra}.
511 @item -Werror
512 @opindex @code{Werror}
513 @cindex warnings, to errors
514 Turns all warnings into errors.
515 @end table
517 @xref{Error and Warning Options,,Options to Request or Suppress Errors and
518 Warnings, gcc,Using the GNU Compiler Collection (GCC)}, for information on
519 more options offered by the GBE shared by @command{gfortran}, @command{gcc}
520 and other GNU compilers.
522 Some of these have no effect when compiling programs written in Fortran.
524 @node Debugging Options
525 @section Options for debugging your program or GNU Fortran
526 @cindex options, debugging
527 @cindex debugging information options
529 GNU Fortran has various special options that are used for debugging
530 either your program or the GNU Fortran compiler.
532 @table @gcctabopt
533 @item -fdump-parse-tree
534 @opindex @code{fdump-parse-tree}
535 Output the internal parse tree before starting code generation.  Only
536 really useful for debugging the GNU Fortran compiler itself.
538 @item -ffpe-trap=@var{list}
539 @opindex @code{ffpe-trap=}@var{list}
540 Specify a list of IEEE exceptions when a Floating Point Exception
541 (FPE) should be raised.  On most systems, this will result in a SIGFPE
542 signal being sent and the program being interrupted, producing a core
543 file useful for debugging.  @var{list} is a (possibly empty) comma-separated
544 list of the following IEEE exceptions: @samp{invalid} (invalid floating
545 point operation, such as @code{SQRT(-1.0)}), @samp{zero} (division by
546 zero), @samp{overflow} (overflow in a floating point operation),
547 @samp{underflow} (underflow in a floating point operation),
548 @samp{precision} (loss of precision during operation) and @samp{denormal}
549 (operation produced a denormal value).
551 @item -fbacktrace
552 @opindex @code{fbacktrace}
553 @cindex backtrace
554 @cindex trace
555 Specify that, when a runtime error is encountered or a deadly signal is
556 emitted (segmentation fault, illegal instruction, bus error or
557 floating-point exception), the Fortran runtime
558 library should output a backtrace of the error.  This option
559 only has influence for compilation of the Fortran main program.
561 @item -fdump-core
562 @cindex core, dump
563 @opindex @code{fdump-core}
564 Request that a core-dump file is written to disk when a runtime error
565 is encountered on systems that support core dumps. This option is
566 only effective for the compilation of the Fortran main program.
567 @end table
569 @xref{Debugging Options,,Options for Debugging Your Program or GCC,
570 gcc,Using the GNU Compiler Collection (GCC)}, for more information on
571 debugging options.
573 @node Directory Options
574 @section Options for directory search
575 @cindex directory, options
576 @cindex options, directory search
577 @cindex search path
578 @cindex INCLUDE directive
579 @cindex directive, INCLUDE
580 These options affect how GNU Fortran searches
581 for files specified by the @code{INCLUDE} directive and where it searches
582 for previously compiled modules.
584 It also affects the search paths used by @command{cpp} when used to preprocess
585 Fortran source.
587 @table @gcctabopt
588 @item -I@var{dir}
589 @opindex @code{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 @file{.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 @item -M@var{dir}
612 @item -J@var{dir}
613 @opindex @code{M}@var{dir}
614 @opindex @code{J}@var{dir}
615 @cindex paths, search
616 @cindex module search path
617 This option specifies where to put @file{.mod} files for compiled modules.
618 It is also added to the list of directories to searched by an @code{USE}
619 statement.
621 The default is the current directory.
623 @option{-J} is an alias for @option{-M} to avoid conflicts with existing
624 GCC options.
626 @item -fintrinsic-modules-path @var{dir}
627 @opindex @code{fintrinsic-modules-path} @var{dir}
628 @cindex paths, search
629 @cindex module search path
630 This option specifies the location of pre-compiled intrinsic modules, if
631 they are not in the default location expected by the compiler.
632 @end table
634 @node Link Options
635 @section Influencing the linking step
636 @cindex options, linking
637 @cindex linking, static
639 These options come into play when the compiler links object files into an 
640 executable output file. They are meaningless if the compiler is not doing 
641 a link step.
643 @table @gcctabopt
644 @item -static-libgfortran
645 @opindex @code{static-libgfortran}
646 On systems that provide @file{libgfortran} as a shared and a static
647 library, this option forces the use of the static version. If no
648 shared version of @file{libgfortran} was built when the compiler was
649 configured, this option has no effect.
650 @end table
653 @node Runtime Options
654 @section Influencing runtime behavior
655 @cindex options, runtime
657 These options affect the runtime behavior of programs compiled with GNU Fortran.
658 @table @gcctabopt
659 @item -fconvert=@var{conversion}
660 @opindex @code{fconvert=}@var{conversion}
661 Specify the representation of data for unformatted files.  Valid
662 values for conversion are: @samp{native}, the default; @samp{swap},
663 swap between big- and little-endian; @samp{big-endian}, use big-endian
664 representation for unformatted files; @samp{little-endian}, use little-endian
665 representation for unformatted files.
667 @emph{This option has an effect only when used in the main program.
668 The @code{CONVERT} specifier and the GFORTRAN_CONVERT_UNIT environment
669 variable override the default specified by @option{-fconvert}.}
671 @item -frecord-marker=@var{length}
672 @opindex @code{frecord-marker=}@var{length}
673 Specify the length of record markers for unformatted files.
674 Valid values for @var{length} are 4 and 8.  Default is 4.
675 @emph{This is different from previous versions of @command{gfortran}},
676 which specified a default record marker length of 8 on most
677 systems.  If you want to read or write files compatible
678 with earlier versions of @command{gfortran}, use @option{-frecord-marker=8}.
680 @item -fmax-subrecord-length=@var{length}
681 @opindex @code{fmax-subrecord-length=}@var{length}
682 Specify the maximum length for a subrecord.  The maximum permitted
683 value for length is 2147483639, which is also the default.  Only
684 really useful for use by the gfortran testsuite.
686 @item -fsign-zero
687 @opindex @code{fsign-zero}
688 When writing zero values, show the negative sign if the sign bit is set.
689 @code{fno-sign-zero} does not print the negative sign of zero values for
690 compatibility with F77.  Default behavior is to show the negative sign.
691 @end table
693 @node Code Gen Options
694 @section Options for code generation conventions
695 @cindex code generation, conventions
696 @cindex options, code generation
697 @cindex options, run-time
699 These machine-independent options control the interface conventions
700 used in code generation.
702 Most of them have both positive and negative forms; the negative form
703 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
704 one of the forms is listed---the one which is not the default.  You
705 can figure out the other form by either removing @option{no-} or adding
708 @table @gcctabopt
709 @item -fno-automatic
710 @opindex @code{fno-automatic}
711 @cindex @code{SAVE} statement
712 @cindex statement, @code{SAVE}
713 Treat each program unit (except those marked as RECURSIVE) as if the
714 @code{SAVE} statement were specified for every local variable and array
715 referenced in it. Does not affect common blocks. (Some Fortran compilers
716 provide this option under the name @option{-static} or @option{-save}.)
717 The default, which is @option{-fautomatic}, uses the stack for local
718 variables smaller than the value given by @option{-fmax-stack-var-size}.
719 Use the option @option{-frecursive} to use no static memory. 
721 @item -ff2c
722 @opindex ff2c
723 @cindex calling convention
724 @cindex @command{f2c} calling convention
725 @cindex @command{g77} calling convention
726 @cindex libf2c calling convention
727 Generate code designed to be compatible with code generated
728 by @command{g77} and @command{f2c}.
730 The calling conventions used by @command{g77} (originally implemented
731 in @command{f2c}) require functions that return type
732 default @code{REAL} to actually return the C type @code{double}, and
733 functions that return type @code{COMPLEX} to return the values via an
734 extra argument in the calling sequence that points to where to
735 store the return value.  Under the default GNU calling conventions, such
736 functions simply return their results as they would in GNU
737 C---default @code{REAL} functions return the C type @code{float}, and
738 @code{COMPLEX} functions return the GNU C type @code{complex}.
739 Additionally, this option implies the @option{-fsecond-underscore}
740 option, unless @option{-fno-second-underscore} is explicitly requested.
742 This does not affect the generation of code that interfaces with
743 the @command{libgfortran} library.
745 @emph{Caution:} It is not a good idea to mix Fortran code compiled with
746 @option{-ff2c} with code compiled with the default @option{-fno-f2c}
747 calling conventions as, calling @code{COMPLEX} or default @code{REAL}
748 functions between program parts which were compiled with different
749 calling conventions will break at execution time.
751 @emph{Caution:} This will break code which passes intrinsic functions
752 of type default @code{REAL} or @code{COMPLEX} as actual arguments, as
753 the library implementations use the @option{-fno-f2c} calling conventions.
755 @item -fno-underscoring
756 @opindex @code{fno-underscoring}
757 @cindex underscore
758 @cindex symbol names, underscores
759 @cindex transforming symbol names
760 @cindex symbol names, transforming
761 Do not transform names of entities specified in the Fortran
762 source file by appending underscores to them.
764 With @option{-funderscoring} in effect, GNU Fortran appends one
765 underscore to external names with no underscores.  This is done to ensure
766 compatibility with code produced by many UNIX Fortran compilers.
768 @emph{Caution}: The default behavior of GNU Fortran is
769 incompatible with @command{f2c} and @command{g77}, please use the
770 @option{-ff2c} option if you want object files compiled with
771 GNU Fortran to be compatible with object code created with these
772 tools.
774 Use of @option{-fno-underscoring} is not recommended unless you are
775 experimenting with issues such as integration of GNU Fortran into
776 existing system environments (vis-a-vis existing libraries, tools, and
777 so on).
779 For example, with @option{-funderscoring}, and assuming other defaults like
780 @option{-fcase-lower} and that @code{j()} and @code{max_count()} are
781 external functions while @code{my_var} and @code{lvar} are local variables,
782 a statement like
783 @smallexample
784 I = J() + MAX_COUNT (MY_VAR, LVAR)
785 @end smallexample
786 @noindent
787 is implemented as something akin to:
788 @smallexample
789 i = j_() + max_count__(&my_var__, &lvar);
790 @end smallexample
792 With @option{-fno-underscoring}, the same statement is implemented as:
794 @smallexample
795 i = j() + max_count(&my_var, &lvar);
796 @end smallexample
798 Use of @option{-fno-underscoring} allows direct specification of
799 user-defined names while debugging and when interfacing GNU Fortran
800 code with other languages.
802 Note that just because the names match does @emph{not} mean that the
803 interface implemented by GNU Fortran for an external name matches the
804 interface implemented by some other language for that same name.
805 That is, getting code produced by GNU Fortran to link to code produced
806 by some other compiler using this or any other method can be only a
807 small part of the overall solution---getting the code generated by
808 both compilers to agree on issues other than naming can require
809 significant effort, and, unlike naming disagreements, linkers normally
810 cannot detect disagreements in these other areas.
812 Also, note that with @option{-fno-underscoring}, the lack of appended
813 underscores introduces the very real possibility that a user-defined
814 external name will conflict with a name in a system library, which
815 could make finding unresolved-reference bugs quite difficult in some
816 cases---they might occur at program run time, and show up only as
817 buggy behavior at run time.
819 In future versions of GNU Fortran we hope to improve naming and linking
820 issues so that debugging always involves using the names as they appear
821 in the source, even if the names as seen by the linker are mangled to
822 prevent accidental linking between procedures with incompatible
823 interfaces.
825 @item -fsecond-underscore
826 @opindex @code{fsecond-underscore}
827 @cindex underscore
828 @cindex symbol names, underscores
829 @cindex transforming symbol names
830 @cindex symbol names, transforming
831 @cindex @command{f2c} calling convention
832 @cindex @command{g77} calling convention
833 @cindex libf2c calling convention
834 By default, GNU Fortran appends an underscore to external
835 names.  If this option is used GNU Fortran appends two
836 underscores to names with underscores and one underscore to external names
837 with no underscores.  GNU Fortran also appends two underscores to
838 internal names with underscores to avoid naming collisions with external
839 names.
841 This option has no effect if @option{-fno-underscoring} is
842 in effect.  It is implied by the @option{-ff2c} option.
844 Otherwise, with this option, an external name such as @code{MAX_COUNT}
845 is implemented as a reference to the link-time external symbol
846 @code{max_count__}, instead of @code{max_count_}.  This is required
847 for compatibility with @command{g77} and @command{f2c}, and is implied
848 by use of the @option{-ff2c} option.
850 @item -fbounds-check
851 @opindex @code{fbounds-check}
852 @cindex array, bounds checking
853 @cindex bounds checking
854 @cindex range checking
855 @cindex subscript checking
856 @cindex checking subscripts
857 Enable generation of run-time checks for array subscripts
858 and against the declared minimum and maximum values.  It also
859 checks array indices for assumed and deferred
860 shape arrays against the actual allocated bounds.
862 Some checks require that @option{-fbounds-check} is set for
863 the compilation of the main probram.
865 In the future this may also include other forms of checking, e.g., checking
866 substring references.
868 @item -fmax-stack-var-size=@var{n}
869 @opindex @code{fmax-stack-var-size}
870 This option specifies the size in bytes of the largest array that will be put
871 on the stack; if the size is exceeded static memory is used (except in
872 procedures marked as RECURSIVE). Use the option @option{-frecursive} to
873 allow for recursive procedures which do not have a RECURSIVE attribute or
874 for parallel programs. Use @option{-fno-automatic} to never use the stack.
876 This option currently only affects local arrays declared with constant
877 bounds, and may not apply to all character variables.
878 Future versions of GNU Fortran may improve this behavior.
880 The default value for @var{n} is 32768.
882 @item -fpack-derived
883 @opindex @code{fpack-derived}
884 @cindex structure packing
885 This option tells GNU Fortran to pack derived type members as closely as
886 possible.  Code compiled with this option is likely to be incompatible
887 with code compiled without this option, and may execute slower.
889 @item -frepack-arrays
890 @opindex @code{frepack-arrays}
891 @cindex repacking arrays
892 In some circumstances GNU Fortran may pass assumed shape array
893 sections via a descriptor describing a noncontiguous area of memory.
894 This option adds code to the function prologue to repack the data into
895 a contiguous block at runtime.
897 This should result in faster accesses to the array.  However it can introduce
898 significant overhead to the function call, especially  when the passed data
899 is noncontiguous.
901 @item -fshort-enums
902 @opindex @code{fshort-enums}
903 This option is provided for interoperability with C code that was
904 compiled with the @option{-fshort-enums} option.  It will make
905 GNU Fortran choose the smallest @code{INTEGER} kind a given
906 enumerator set will fit in, and give all its enumerators this kind.
908 @item -fexternal-blas
909 @opindex @code{fexternal-blas}
910 This option will make @command{gfortran} generate calls to BLAS functions
911 for some matrix operations like @code{MATMUL}, instead of using our own
912 algorithms, if the size of the matrices involved is larger than a given
913 limit (see @option{-fblas-matmul-limit}).  This may be profitable if an
914 optimized vendor BLAS library is available.  The BLAS library will have
915 to be specified at link time.
917 @item -fblas-matmul-limit=@var{n}
918 @opindex @code{fblas-matmul-limit}
919 Only significant when @option{-fexternal-blas} is in effect.
920 Matrix multiplication of matrices with size larger than (or equal to) @var{n}
921 will be performed by calls to BLAS functions, while others will be
922 handled by @command{gfortran} internal algorithms. If the matrices
923 involved are not square, the size comparison is performed using the
924 geometric mean of the dimensions of the argument and result matrices.
926 The default value for @var{n} is 30.
928 @item -frecursive
929 @opindex @code{frecursive}
930 Allow indirect recursion by forcing all local arrays to be allocated
931 on the stack. This flag cannot be used together with
932 @option{-fmax-stack-var-size=} or @option{-fno-automatic}.
934 @end table
936 @xref{Code Gen Options,,Options for Code Generation Conventions,
937 gcc,Using the GNU Compiler Collection (GCC)}, for information on more options
938 offered by the GBE
939 shared by @command{gfortran}, @command{gcc}, and other GNU compilers.
942 @c man end
944 @node Environment Variables
945 @section Environment variables affecting @command{gfortran}
946 @cindex environment variable
948 @c man begin ENVIRONMENT
950 The @command{gfortran} compiler currently does not make use of any environment
951 variables to control its operation above and beyond those
952 that affect the operation of @command{gcc}.
954 @xref{Environment Variables,,Environment Variables Affecting GCC,
955 gcc,Using the GNU Compiler Collection (GCC)}, for information on environment
956 variables.
958 @xref{Runtime}, for environment variables that affect the
959 run-time behavior of programs compiled with GNU Fortran.
960 @c man end