OSDN Git Service

2007-05-17 Tobias Burnus <burnus@net-b.de>
[pf3gnuchains/gcc-fork.git] / gcc / fortran / gfortran.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename gfortran.info
4 @set copyrights-gfortran 1999-2007
5
6 @include gcc-common.texi
7
8 @settitle The GNU Fortran Compiler
9
10 @c Create a separate index for command line options
11 @defcodeindex op
12 @c Merge the standard indexes into a single one.
13 @syncodeindex fn cp
14 @syncodeindex vr cp
15 @syncodeindex ky cp
16 @syncodeindex pg cp
17 @syncodeindex tp cp
18
19 @c TODO: The following "Part" definitions are included here temporarily
20 @c until they are incorporated into the official Texinfo distribution.
21 @c They borrow heavily from Texinfo's \unnchapentry definitions.
22
23 @tex
24 \gdef\part#1#2{%
25   \pchapsepmacro
26   \gdef\thischapter{}
27   \begingroup
28     \vglue\titlepagetopglue
29     \titlefonts \rm
30     \leftline{Part #1:@* #2}
31     \vskip4pt \hrule height 4pt width \hsize \vskip4pt
32   \endgroup
33   \writetocentry{part}{#2}{#1}
34 }
35 \gdef\blankpart{%
36   \writetocentry{blankpart}{}{}
37 }
38 % Part TOC-entry definition for summary contents.
39 \gdef\dosmallpartentry#1#2#3#4{%
40   \vskip .5\baselineskip plus.2\baselineskip
41   \begingroup
42     \let\rm=\bf \rm
43     \tocentry{Part #2: #1}{\doshortpageno\bgroup#4\egroup}
44   \endgroup
45 }
46 \gdef\dosmallblankpartentry#1#2#3#4{%
47   \vskip .5\baselineskip plus.2\baselineskip
48 }
49 % Part TOC-entry definition for regular contents.  This has to be
50 % equated to an existing entry to not cause problems when the PDF
51 % outline is created.
52 \gdef\dopartentry#1#2#3#4{%
53   \unnchapentry{Part #2: #1}{}{#3}{#4}
54 }
55 \gdef\doblankpartentry#1#2#3#4{}
56 @end tex
57
58 @c %**end of header
59
60 @c Use with @@smallbook.
61
62 @c %** start of document
63
64 @c Cause even numbered pages to be printed on the left hand side of
65 @c the page and odd numbered pages to be printed on the right hand
66 @c side of the page.  Using this, you can print on both sides of a
67 @c sheet of paper and have the text on the same part of the sheet.
68
69 @c The text on right hand pages is pushed towards the right hand
70 @c margin and the text on left hand pages is pushed toward the left
71 @c hand margin.
72 @c (To provide the reverse effect, set bindingoffset to -0.75in.)
73
74 @c @tex
75 @c \global\bindingoffset=0.75in
76 @c \global\normaloffset =0.75in
77 @c @end tex
78
79 @copying
80 Copyright @copyright{} @value{copyrights-gfortran} Free Software Foundation, Inc.
81
82 Permission is granted to copy, distribute and/or modify this document
83 under the terms of the GNU Free Documentation License, Version 1.1 or
84 any later version published by the Free Software Foundation; with the
85 Invariant Sections being ``GNU General Public License'' and ``Funding
86 Free Software'', the Front-Cover
87 texts being (a) (see below), and with the Back-Cover Texts being (b)
88 (see below).  A copy of the license is included in the section entitled
89 ``GNU Free Documentation License''.
90
91 (a) The FSF's Front-Cover Text is:
92
93      A GNU Manual
94
95 (b) The FSF's Back-Cover Text is:
96
97      You have freedom to copy and modify this GNU Manual, like GNU
98      software.  Copies published by the Free Software Foundation raise
99      funds for GNU development.
100 @end copying
101
102 @ifinfo
103 @dircategory Software development
104 @direntry
105 * gfortran: (gfortran).                  The GNU Fortran Compiler.
106 @end direntry
107 This file documents the use and the internals of
108 the GNU Fortran compiler, (@command{gfortran}).
109
110 Published by the Free Software Foundation
111 51 Franklin Street, Fifth Floor
112 Boston, MA 02110-1301 USA
113
114 @insertcopying
115 @end ifinfo
116
117
118 @setchapternewpage odd
119 @titlepage
120 @title Using GNU Fortran
121 @versionsubtitle
122 @author The @t{gfortran} team
123 @page
124 @vskip 0pt plus 1filll
125 Published by the Free Software Foundation@*
126 51 Franklin Street, Fifth Floor@*
127 Boston, MA 02110-1301, USA@*
128 @c Last printed ??ber, 19??.@*
129 @c Printed copies are available for $? each.@*
130 @c ISBN ???
131 @sp 1
132 @insertcopying
133 @end titlepage
134
135 @c TODO: The following "Part" definitions are included here temporarily
136 @c until they are incorporated into the official Texinfo distribution.
137
138 @tex
139 \global\let\partentry=\dosmallpartentry
140 \global\let\blankpartentry=\dosmallblankpartentry
141 @end tex
142 @summarycontents
143
144 @tex
145 \global\let\partentry=\dopartentry
146 \global\let\blankpartentry=\doblankpartentry
147 @end tex
148 @contents
149
150 @page
151
152 @c ---------------------------------------------------------------------
153 @c TexInfo table of contents.
154 @c ---------------------------------------------------------------------
155
156 @ifnottex
157 @node Top
158 @top Introduction
159 @cindex Introduction
160
161 This manual documents the use of @command{gfortran}, 
162 the GNU Fortran compiler. You can find in this manual how to invoke
163 @command{gfortran}, as well as its features and incompatibilities.
164
165 @ifset DEVELOPMENT
166 @emph{Warning:} This document, and the compiler it describes, are still
167 under development.  While efforts are made to keep it up-to-date, it might
168 not accurately reflect the status of the most recent GNU Fortran compiler.
169 @end ifset
170
171 @comment
172 @comment  When you add a new menu item, please keep the right hand
173 @comment  aligned to the same column.  Do not use tabs.  This provides
174 @comment  better formatting.
175 @comment
176 @menu
177 * Introduction::
178
179 Part I: Invoking GNU Fortran
180 * Invoking GNU Fortran:: Command options supported by @command{gfortran}.
181 * Runtime::              Influencing runtime behavior with environment variables.
182
183 Part II: Language Reference
184 * Fortran 2003 status::  Fortran 2003 features supported by GNU Fortran.
185 * Extensions::           Language extensions implemented by GNU Fortran.
186 * Intrinsic Procedures:: Intrinsic procedures supported by GNU Fortran.
187
188 * Contributing::         How you can help.
189 * Copying::              GNU General Public License says
190                          how you can copy and share GNU Fortran.
191 * GNU Free Documentation License::
192                          How you can copy and share this manual.
193 * Funding::              How to help assure continued work for free software.
194 * Option Index::         Index of command line options
195 * Keyword Index::        Index of concepts
196 @end menu
197 @end ifnottex
198
199 @c ---------------------------------------------------------------------
200 @c Introduction
201 @c ---------------------------------------------------------------------
202
203 @node Introduction
204 @chapter Introduction
205
206 @c The following duplicates the text on the TexInfo table of contents.
207 @iftex
208 This manual documents the use of @command{gfortran}, the GNU Fortran
209 compiler. You can find in this manual how to invoke @command{gfortran},
210 as well as its features and incompatibilities.
211
212 @ifset DEVELOPMENT
213 @emph{Warning:} This document, and the compiler it describes, are still
214 under development.  While efforts are made to keep it up-to-date, it
215 might not accurately reflect the status of the most recent GNU Fortran
216 compiler.
217 @end ifset
218 @end iftex
219
220 The GNU Fortran compiler front end was
221 designed initially as a free replacement for,
222 or alternative to, the unix @command{f95} command;
223 @command{gfortran} is the command you'll use to invoke the compiler.
224
225 @menu
226 * About GNU Fortran::    What you should know about the GNU Fortran compiler.
227 * GNU Fortran and GCC::  You can compile Fortran, C, or other programs.
228 * GNU Fortran and G77::  Why we chose to start from scratch.
229 * Project Status::       Status of GNU Fortran, roadmap, proposed extensions.
230 * Standards::            Standards supported by GNU Fortran.
231 @end menu
232
233
234 @c ---------------------------------------------------------------------
235 @c About GNU Fortran
236 @c ---------------------------------------------------------------------
237
238 @node About GNU Fortran
239 @section About GNU Fortran
240
241 The GNU Fortran compiler is still in an early state of development.
242 It can generate code for most constructs and expressions,
243 but much work remains to be done.
244
245 When the GNU Fortran compiler is finished,
246 it will do everything you expect from any decent compiler: 
247
248 @itemize @bullet
249 @item
250 Read a user's program,
251 stored in a file and containing instructions written
252 in Fortran 77, Fortran 90, Fortran 95 or Fortran 2003.
253 This file contains @dfn{source code}.
254
255 @item
256 Translate the user's program into instructions a computer
257 can carry out more quickly than it takes to translate the
258 instructions in the first
259 place.  The result after compilation of a program is
260 @dfn{machine code},
261 code designed to be efficiently translated and processed
262 by a machine such as your computer.
263 Humans usually aren't as good writing machine code
264 as they are at writing Fortran (or C++, Ada, or Java),
265 because is easy to make tiny mistakes writing machine code.
266
267 @item
268 Provide the user with information about the reasons why
269 the compiler is unable to create a binary from the source code.
270 Usually this will be the case if the source code is flawed.
271 When writing Fortran, it is easy to make big mistakes.
272 The Fortran 90 requires that the compiler can point out
273 mistakes to the user.
274 An incorrect usage of the language causes an @dfn{error message}.
275
276 The compiler will also attempt to diagnose cases where the
277 user's program contains a correct usage of the language,
278 but instructs the computer to do something questionable.
279 This kind of diagnostics message is called a @dfn{warning message}.
280
281 @item
282 Provide optional information about the translation passes
283 from the source code to machine code.
284 This can help a user of the compiler to find the cause of
285 certain bugs which may not be obvious in the source code,
286 but may be more easily found at a lower level compiler output.
287 It also helps developers to find bugs in the compiler itself.
288
289 @item
290 Provide information in the generated machine code that can
291 make it easier to find bugs in the program (using a debugging tool,
292 called a @dfn{debugger}, such as the GNU Debugger @command{gdb}). 
293
294 @item
295 Locate and gather machine code already generated to
296 perform actions requested by statements in the user's program.
297 This machine code is organized into @dfn{modules} and is located
298 and @dfn{linked} to the user program. 
299 @end itemize
300
301 The GNU Fortran compiler consists of several components:
302
303 @itemize @bullet
304 @item
305 A version of the @command{gcc} command
306 (which also might be installed as the system's @command{cc} command)
307 that also understands and accepts Fortran source code.
308 The @command{gcc} command is the @dfn{driver} program for
309 all the languages in the GNU Compiler Collection (GCC);
310 With @command{gcc},
311 you can compile the source code of any language for
312 which a front end is available in GCC.
313
314 @item
315 The @command{gfortran} command itself,
316 which also might be installed as the
317 system's @command{f95} command.
318 @command{gfortran} is just another driver program,
319 but specifically for the Fortran compiler only.
320 The difference with @command{gcc} is that @command{gfortran}
321 will automatically link the correct libraries to your program.
322
323 @item
324 A collection of run-time libraries.
325 These libraries contain the machine code needed to support
326 capabilities of the Fortran language that are not directly
327 provided by the machine code generated by the
328 @command{gfortran} compilation phase,
329 such as intrinsic functions and subroutines,
330 and routines for interaction with files and the operating system.
331 @c and mechanisms to spawn,
332 @c unleash and pause threads in parallelized code.
333
334 @item
335 The Fortran compiler itself, (@command{f951}).
336 This is the GNU Fortran parser and code generator,
337 linked to and interfaced with the GCC backend library.
338 @command{f951} ``translates'' the source code to
339 assembler code.  You would typically not use this
340 program directly;
341 instead, the @command{gcc} or @command{gfortran} driver
342 programs will call it for you.
343 @end itemize
344
345
346 @c ---------------------------------------------------------------------
347 @c GNU Fortran and GCC
348 @c ---------------------------------------------------------------------
349
350 @node GNU Fortran and GCC
351 @section GNU Fortran and GCC
352 @cindex GNU Compiler Collection
353 @cindex GCC
354
355 GNU Fortran is a part of GCC, the @dfn{GNU Compiler Collection}.  GCC
356 consists of a collection of front ends for various languages, which
357 translate the source code into a language-independent form called
358 @dfn{GENERIC}.  This is then processed by a common middle end which
359 provides optimization, and then passed to one of a collection of back
360 ends which generate code for different computer architectures and
361 operating systems.
362
363 Functionally, this is implemented with a driver program (@command{gcc})
364 which provides the command-line interface for the compiler.  It calls
365 the relevant compiler front-end program (e.g., @command{f951} for
366 Fortran) for each file in the source code, and then calls the assembler
367 and linker as appropriate to produce the compiled output. In a copy of
368 GCC which has been compiled with Fortran language support enabled,
369 @command{gcc} will recognize files with @file{.f}, @file{.f90}, @file{.f95},
370 and @file{.f03} extensions as Fortran source code, and compile it
371 accordingly.  A @command{gfortran} driver program is also provided,
372 which is identical to @command{gcc} except that it automatically links
373 the Fortran runtime libraries into the compiled program.
374
375 This manual specifically documents the Fortran front end, which handles
376 the programming language's syntax and semantics.  The aspects of GCC
377 which relate to the optimization passes and the back-end code generation
378 are documented in the GCC manual; see 
379 @ref{Top,,Introduction,gcc,Using the GNU Compiler Collection (GCC)}.
380 The two manuals together provide a complete reference for the GNU
381 Fortran compiler.
382
383
384 @c ---------------------------------------------------------------------
385 @c GNU Fortran and G77
386 @c ---------------------------------------------------------------------
387
388 @node GNU Fortran and G77
389 @section GNU Fortran and G77
390 @cindex Fortran 77
391 @cindex @command{g77}
392
393 The GNU Fortran compiler is the successor to @command{g77}, the Fortran 
394 77 front end included in GCC prior to version 4.  It is an entirely new 
395 program that has been designed to provide Fortran 95 support and 
396 extensibility for future Fortran language standards, as well as providing 
397 backwards compatibility for Fortran 77 and nearly all of the GNU language 
398 extensions supported by @command{g77}.
399
400
401 @c ---------------------------------------------------------------------
402 @c Project Status
403 @c ---------------------------------------------------------------------
404
405 @node Project Status
406 @section Project Status
407
408 @quotation
409 As soon as @command{gfortran} can parse all of the statements correctly,
410 it will be in the ``larva'' state.
411 When we generate code, the ``puppa'' state.
412 When @command{gfortran} is done,
413 we'll see if it will be a beautiful butterfly,
414 or just a big bug....
415
416 --Andy Vaught, April 2000
417 @end quotation
418
419 The start of the GNU Fortran 95 project was announced on
420 the GCC homepage in March 18, 2000
421 (even though Andy had already been working on it for a while,
422 of course).
423
424 The GNU Fortran compiler is able to compile nearly all
425 standard-compliant Fortran 95, Fortran 90, and Fortran 77 programs,
426 including a number of standard and non-standard extensions, and can be
427 used on real-world programs.  In particular, the supported extensions
428 include OpenMP, Cray-style pointers, and several Fortran 2003 features
429 such as enumeration, stream I/O, and some of the enhancements to
430 allocatable array support from TR 15581.  However, it is still under
431 development and has a few remaining rough edges.
432
433 At present, the GNU Fortran compiler passes the
434 @uref{http://www.fortran-2000.com/ArnaudRecipes/fcvs21_f95.html, 
435 NIST Fortran 77 Test Suite}, and produces acceptable results on the
436 @uref{http://www.netlib.org/lapack/faq.html#1.21, LAPACK Test Suite}.
437 It also provides respectable performance on 
438 the @uref{http://www.polyhedron.com/pb05.html, Polyhedron Fortran
439 compiler benchmarks} and the
440 @uref{http://www.llnl.gov/asci_benchmarks/asci/limited/lfk/README.html,
441 Livermore Fortran Kernels test}.  It has been used to compile a number of
442 large real-world programs, including
443 @uref{http://mysite.verizon.net/serveall/moene.pdf, the HIRLAM
444 weather-forecasting code} and
445 @uref{http://www.theochem.uwa.edu.au/tonto/, the Tonto quantum 
446 chemistry package}; see @url{http://gcc.gnu.org/wiki/GfortranApps} for an
447 extended list.
448
449 Among other things, the GNU Fortran compiler is intended as a replacement
450 for G77.  At this point, nearly all programs that could be compiled with
451 G77 can be compiled with GNU Fortran, although there are a few minor known
452 regressions.
453
454 The primary work remaining to be done on GNU Fortran falls into three
455 categories: bug fixing (primarily regarding the treatment of invalid code
456 and providing useful error messages), improving the compiler optimizations
457 and the performance of compiled code, and extending the compiler to support
458 future standards---in particular, Fortran 2003.
459
460
461 @c ---------------------------------------------------------------------
462 @c Standards
463 @c ---------------------------------------------------------------------
464
465 @node Standards
466 @section Standards
467 @cindex Standards
468
469 The GNU Fortran compiler implements
470 ISO/IEC 1539:1997 (Fortran 95).  As such, it can also compile essentially all
471 standard-compliant Fortran 90 and Fortran 77 programs.   It also supports
472 the ISO/IEC TR-15581 enhancements to allocatable arrays, and
473 the @uref{http://www.openmp.org/drupal/mp-documents/spec25.pdf,
474 OpenMP Application Program Interface v2.5} specification.
475
476 In the future, the GNU Fortran compiler may also support other standard 
477 variants of and extensions to the Fortran language.  These include
478 ISO/IEC 1539-1:2004 (Fortran 2003).
479
480
481 @c =====================================================================
482 @c PART I: INVOCATION REFERENCE
483 @c =====================================================================
484
485 @tex
486 \part{I}{Invoking GNU Fortran}
487 @end tex
488
489 @c ---------------------------------------------------------------------
490 @c Compiler Options
491 @c ---------------------------------------------------------------------
492
493 @include invoke.texi
494
495
496 @c ---------------------------------------------------------------------
497 @c Runtime
498 @c ---------------------------------------------------------------------
499
500 @node Runtime
501 @chapter Runtime:  Influencing runtime behavior with environment variables
502 @cindex environment variable
503
504 The behavior of the @command{gfortran} can be influenced by
505 environment variables.
506
507 Malformed environment variables are silently ignored.
508
509 @menu
510 * GFORTRAN_STDIN_UNIT:: Unit number for standard input
511 * GFORTRAN_STDOUT_UNIT:: Unit number for standard output
512 * GFORTRAN_STDERR_UNIT:: Unit number for standard error
513 * GFORTRAN_USE_STDERR:: Send library output to standard error
514 * GFORTRAN_TMPDIR:: Directory for scratch files
515 * GFORTRAN_UNBUFFERED_ALL:: Don't buffer output
516 * GFORTRAN_SHOW_LOCUS::  Show location for runtime errors
517 * GFORTRAN_OPTIONAL_PLUS:: Print leading + where permitted
518 * GFORTRAN_DEFAULT_RECL:: Default record length for new files
519 * GFORTRAN_LIST_SEPARATOR::  Separator for list output
520 * GFORTRAN_CONVERT_UNIT::  Set endianness for unformatted I/O
521 @end menu
522
523 @node GFORTRAN_STDIN_UNIT
524 @section @env{GFORTRAN_STDIN_UNIT}---Unit number for standard input
525
526 This environment variable can be used to select the unit number
527 preconnected to standard input.  This must be a positive integer.
528 The default value is 5.
529
530 @node GFORTRAN_STDOUT_UNIT
531 @section @env{GFORTRAN_STDOUT_UNIT}---Unit number for standard output
532
533 This environment variable can be used to select the unit number
534 preconnected to standard output.  This must be a positive integer.
535 The default value is 6.
536
537 @node GFORTRAN_STDERR_UNIT
538 @section @env{GFORTRAN_STDERR_UNIT}---Unit number for standard error
539
540 This environment variable can be used to select the unit number
541 preconnected to standard error.  This must be a positive integer.
542 The default value is 0.
543
544 @node GFORTRAN_USE_STDERR
545 @section @env{GFORTRAN_USE_STDERR}---Send library output to standard error
546
547 This environment variable controls where library output is sent.
548 If the first letter is @samp{y}, @samp{Y} or @samp{1}, standard
549 error is used. If the first letter is @samp{n}, @samp{N} or
550 @samp{0}, standard output is used.
551
552 @node GFORTRAN_TMPDIR
553 @section @env{GFORTRAN_TMPDIR}---Directory for scratch files
554
555 This environment variable controls where scratch files are
556 created.  If this environment variable is missing,
557 GNU Fortran searches for the environment variable @env{TMP}.  If
558 this is also missing, the default is @file{/tmp}.
559
560 @node GFORTRAN_UNBUFFERED_ALL
561 @section @env{GFORTRAN_UNBUFFERED_ALL}---Don't buffer output
562
563 This environment variable controls whether all output is unbuffered.
564 If the first letter is @samp{y}, @samp{Y} or @samp{1}, all output is
565 unbuffered. This will slow down large writes.  If the first letter is
566 @samp{n}, @samp{N}  or @samp{0}, output is buffered.  This is the
567 default.
568
569 @node GFORTRAN_SHOW_LOCUS
570 @section @env{GFORTRAN_SHOW_LOCUS}---Show location for runtime errors
571
572 If the first letter is @samp{y}, @samp{Y} or @samp{1}, filename and
573 line numbers for runtime errors are printed.  If the first letter is
574 @samp{n}, @samp{N} or @samp{0}, don't print filename and line numbers
575 for runtime errors. The default is to print the location.
576
577 @node GFORTRAN_OPTIONAL_PLUS
578 @section @env{GFORTRAN_OPTIONAL_PLUS}---Print leading + where permitted
579
580 If the first letter is @samp{y}, @samp{Y} or @samp{1},
581 a plus sign is printed
582 where permitted by the Fortran standard.  If the first letter
583 is @samp{n}, @samp{N} or @samp{0}, a plus sign is not printed
584 in most cases. Default is not to print plus signs.
585
586 @node GFORTRAN_DEFAULT_RECL
587 @section @env{GFORTRAN_DEFAULT_RECL}---Default record length for new files
588
589 This environment variable specifies the default record length, in
590 bytes, for files which are opened without a @code{RECL} tag in the
591 @code{OPEN} statement.  This must be a positive integer.  The
592 default value is 1073741824 bytes (1 GB).
593
594 @node GFORTRAN_LIST_SEPARATOR
595 @section @env{GFORTRAN_LIST_SEPARATOR}---Separator for list output
596
597 This environment variable specifies the separator when writing
598 list-directed output.  It may contain any number of spaces and
599 at most one comma.  If you specify this on the command line,
600 be sure to quote spaces, as in
601 @smallexample
602 $ GFORTRAN_LIST_SEPARATOR='  ,  ' ./a.out
603 @end smallexample
604 when @command{a.out} is the compiled Fortran program that you want to run.
605 Default is a single space.
606
607 @node GFORTRAN_CONVERT_UNIT
608 @section @env{GFORTRAN_CONVERT_UNIT}---Set endianness for unformatted I/O
609
610 By setting the @env{GFORTRAN_CONVERT_UNIT} variable, it is possible
611 to change the representation of data for unformatted files.
612 The syntax for the @env{GFORTRAN_CONVERT_UNIT} variable is:
613 @smallexample
614 GFORTRAN_CONVERT_UNIT: mode | mode ';' exception | exception ;
615 mode: 'native' | 'swap' | 'big_endian' | 'little_endian' ;
616 exception: mode ':' unit_list | unit_list ;
617 unit_list: unit_spec | unit_list unit_spec ;
618 unit_spec: INTEGER | INTEGER '-' INTEGER ;
619 @end smallexample
620 The variable consists of an optional default mode, followed by
621 a list of optional exceptions, which are separated by semicolons
622 from the preceding default and each other.  Each exception consists
623 of a format and a comma-separated list of units.  Valid values for
624 the modes are the same as for the @code{CONVERT} specifier:
625
626 @itemize @w{}
627 @item @code{NATIVE} Use the native format.  This is the default.
628 @item @code{SWAP} Swap between little- and big-endian.
629 @item @code{LITTLE_ENDIAN} Use the little-endian format
630         for unformatted files.
631 @item @code{BIG_ENDIAN} Use the big-endian format for unformatted files.
632 @end itemize
633 A missing mode for an exception is taken to mean @code{BIG_ENDIAN}.
634 Examples of values for @env{GFORTRAN_CONVERT_UNIT} are:
635 @itemize @w{}
636 @item @code{'big_endian'}  Do all unformatted I/O in big_endian mode.
637 @item @code{'little_endian;native:10-20,25'}  Do all unformatted I/O 
638 in little_endian mode, except for units 10 to 20 and 25, which are in
639 native format.
640 @item @code{'10-20'}  Units 10 to 20 are big-endian, the rest is native.
641 @end itemize
642
643 Setting the environment variables should be done on the command
644 line or via the @command{export}
645 command for @command{sh}-compatible shells and via @command{setenv}
646 for @command{csh}-compatible shells.
647
648 Example for @command{sh}:
649 @smallexample
650 $ gfortran foo.f90
651 $ GFORTRAN_CONVERT_UNIT='big_endian;native:10-20' ./a.out
652 @end smallexample
653
654 Example code for @command{csh}:
655 @smallexample
656 % gfortran foo.f90
657 % setenv GFORTRAN_CONVERT_UNIT 'big_endian;native:10-20'
658 % ./a.out
659 @end smallexample
660
661 Using anything but the native representation for unformatted data
662 carries a significant speed overhead.  If speed in this area matters
663 to you, it is best if you use this only for data that needs to be
664 portable.
665
666 @xref{CONVERT specifier}, for an alternative way to specify the
667 data representation for unformatted files.  @xref{Runtime Options}, for
668 setting a default data representation for the whole program.  The
669 @code{CONVERT} specifier overrides the @option{-fconvert} compile options.
670
671 @emph{Note that the values specified via the GFORTRAN_CONVERT_UNIT
672 environment variable will override the CONVERT specifier in the
673 open statement}.  This is to give control over data formats to
674 users who do not have the source code of their program available.
675
676
677 @c =====================================================================
678 @c PART II: LANGUAGE REFERENCE
679 @c =====================================================================
680
681 @tex
682 \part{II}{Language Reference}
683 @end tex
684
685 @c ---------------------------------------------------------------------
686 @c Fortran 2003 Status
687 @c ---------------------------------------------------------------------
688
689 @node Fortran 2003 status
690 @chapter Fortran 2003 Status
691
692 Although GNU Fortran focuses on implementing the Fortran 95
693 standard for the time being, a few Fortran 2003 features are currently
694 available.
695
696 @itemize
697 @item 
698 Intrinsics @code{command_argument_count}, @code{get_command},
699 @code{get_command_argument}, @code{get_environment_variable}, and
700 @code{move_alloc}.
701
702 @item 
703 @cindex array, constructors
704 @cindex @code{[...]}
705 Array constructors using square brackets. That is, @code{[...]} rather
706 than @code{(/.../)}.
707
708 @item
709 @cindex @code{FLUSH} statement
710 @cindex statement, @code{FLUSH}
711 @code{FLUSH} statement.
712
713 @item
714 @cindex @code{IOMSG=} specifier
715 @code{IOMSG=} specifier for I/O statements.
716
717 @item
718 @cindex @code{ENUM} statement
719 @cindex @code{ENUMERATOR} statement
720 @cindex statement, @code{ENUM}
721 @cindex statement, @code{ENUMERATOR}
722 @opindex @code{fshort-enums}
723 Support for the declaration of enumeration constants via the
724 @code{ENUM} and @code{ENUMERATOR} statements.  Interoperability with
725 @command{gcc} is guaranteed also for the case where the
726 @command{-fshort-enums} command line option is given.
727
728 @item
729 @cindex TR 15581
730 TR 15581:
731 @itemize
732 @item
733 @cindex @code{ALLOCATABLE} dummy arguments
734 @code{ALLOCATABLE} dummy arguments.
735 @item
736 @cindex @code{ALLOCATABLE} function results
737 @code{ALLOCATABLE} function results
738 @item
739 @cindex @code{ALLOCATABLE} components of derived types
740 @code{ALLOCATABLE} components of derived types
741 @end itemize
742
743 @item
744 @cindex @code{STREAM} I/O
745 @cindex @code{ACCESS='STREAM'} I/O
746 The @code{OPEN} statement supports the @code{ACCESS='STREAM'} specifier,
747 allowing I/O without any record structure.
748
749 @item
750 Namelist input/output for internal files.
751
752 @item
753 @cindex @code{PROTECTED} statement
754 @cindex statement, @code{PROTECTED}
755 The @code{PROTECTED} statement and attribute.
756
757 @item
758 @cindex @code{VALUE} statement
759 @cindex statement, @code{VALUE}
760 The @code{VALUE} statement and attribute.
761
762 @item
763 @cindex @code{VOLATILE} statement
764 @cindex statement, @code{VOLATILE}
765 The @code{VOLATILE} statement and attribute.
766
767 @item
768 @cindex @code{IMPORT} statement
769 @cindex statement, @code{IMPORT}
770 The @code{IMPORT} statement, allowing to import
771 host-associated derived types.
772
773 @item
774 @cindex @code{USE, INTRINSIC} statement
775 @cindex statement, @code{USE, INTRINSIC}
776 @cindex @code{ISO_FORTRAN_ENV} statement
777 @cindex statement, @code{ISO_FORTRAN_ENV}
778 @code{USE} statement with @code{INTRINSIC} and @code{NON_INTRINSIC}
779 attribute; supported intrinsic modules: @code{ISO_FORTRAN_ENV},
780 @code{OMP_LIB} and @code{OMP_LIB_KINDS}.
781
782 @item
783 Renaming of operators in the @code{USE} statement.
784
785 @end itemize
786
787
788 @c ---------------------------------------------------------------------
789 @c Extensions
790 @c ---------------------------------------------------------------------
791
792 @c Maybe this chapter should be merged with the 'Standards' section,
793 @c whenever that is written :-)
794
795 @node Extensions
796 @chapter Extensions
797 @cindex Extension
798
799 GNU Fortran implements a number of extensions over standard
800 Fortran. This chapter contains information on their syntax and
801 meaning.  There are currently two categories of GNU Fortran
802 extensions, those that provide functionality beyond that provided
803 by any standard, and those that are supported by GNU Fortran
804 purely for backward compatibility with legacy compilers.  By default,
805 @option{-std=gnu} allows the compiler to accept both types of
806 extensions, but to warn about the use of the latter.  Specifying
807 either @option{-std=f95} or @option{-std=f2003} disables both types
808 of extensions, and @option{-std=legacy} allows both without warning.
809
810 @menu
811 * Old-style kind specifications::
812 * Old-style variable initialization::
813 * Extensions to namelist::
814 * X format descriptor without count field::
815 * Commas in FORMAT specifications::
816 * Missing period in FORMAT specifications::
817 * I/O item lists::
818 * BOZ literal constants::
819 * Real array indices::
820 * Unary operators::
821 * Implicitly convert LOGICAL and INTEGER values::
822 * Hollerith constants support::
823 * Cray pointers::
824 * CONVERT specifier::
825 * OpenMP::
826 * Argument list functions::
827 @end menu
828
829 @node Old-style kind specifications
830 @section Old-style kind specifications
831 @cindex kind, old-style
832
833 GNU Fortran allows old-style kind specifications in declarations. These
834 look like:
835 @smallexample
836       TYPESPEC*size x,y,z
837 @end smallexample
838 @noindent
839 where @code{TYPESPEC} is a basic type (@code{INTEGER}, @code{REAL},
840 etc.), and where @code{size} is a byte count corresponding to the
841 storage size of a valid kind for that type.  (For @code{COMPLEX}
842 variables, @code{size} is the total size of the real and imaginary
843 parts.)  The statement then declares @code{x}, @code{y} and @code{z} to
844 be of type @code{TYPESPEC} with the appropriate kind.  This is
845 equivalent to the standard-conforming declaration
846 @smallexample
847       TYPESPEC(k) x,y,z
848 @end smallexample
849 @noindent
850 where @code{k} is equal to @code{size} for most types, but is equal to
851 @code{size/2} for the @code{COMPLEX} type.
852
853 @node Old-style variable initialization
854 @section Old-style variable initialization
855
856 GNU Fortran allows old-style initialization of variables of the
857 form:
858 @smallexample
859       INTEGER i/1/,j/2/
860       REAL x(2,2) /3*0.,1./
861 @end smallexample
862 The syntax for the initializers is as for the @code{DATA} statement, but
863 unlike in a @code{DATA} statement, an initializer only applies to the
864 variable immediately preceding the initialization.  In other words,
865 something like @code{INTEGER I,J/2,3/} is not valid.  This style of
866 initialization is only allowed in declarations without double colons
867 (@code{::}); the double colons were introduced in Fortran 90, which also
868 introduced a standard syntax for initializing variables in type
869 declarations.
870
871 Examples of standard-conforming code equivalent to the above example
872 are:
873 @smallexample
874 ! Fortran 90
875       INTEGER :: i = 1, j = 2
876       REAL :: x(2,2) = RESHAPE((/0.,0.,0.,1./),SHAPE(x))
877 ! Fortran 77
878       INTEGER i, j
879       REAL x(2,2)
880       DATA i/1/, j/2/, x/3*0.,1./
881 @end smallexample
882
883 Note that variables which are explicitly initialized in declarations
884 or in @code{DATA} statements automatically acquire the @code{SAVE}
885 attribute.
886
887 @node Extensions to namelist
888 @section Extensions to namelist
889 @cindex Namelist
890
891 GNU Fortran fully supports the Fortran 95 standard for namelist I/O
892 including array qualifiers, substrings and fully qualified derived types.
893 The output from a namelist write is compatible with namelist read.  The
894 output has all names in upper case and indentation to column 1 after the
895 namelist name.  Two extensions are permitted:
896
897 Old-style use of @samp{$} instead of @samp{&}
898 @smallexample
899 $MYNML
900  X(:)%Y(2) = 1.0 2.0 3.0
901  CH(1:4) = "abcd"
902 $END
903 @end smallexample
904
905 It should be noted that the default terminator is @samp{/} rather than
906 @samp{&END}.
907
908 Querying of the namelist when inputting from stdin. After at least
909 one space, entering @samp{?} sends to stdout the namelist name and the names of
910 the variables in the namelist:
911 @smallexample
912  ?
913
914 &mynml
915  x
916  x%y
917  ch
918 &end
919 @end smallexample
920
921 Entering @samp{=?} outputs the namelist to stdout, as if
922 @code{WRITE(*,NML = mynml)} had been called:
923 @smallexample
924 =?
925
926 &MYNML
927  X(1)%Y=  0.000000    ,  1.000000    ,  0.000000    ,
928  X(2)%Y=  0.000000    ,  2.000000    ,  0.000000    ,
929  X(3)%Y=  0.000000    ,  3.000000    ,  0.000000    ,
930  CH=abcd,  /
931 @end smallexample
932
933 To aid this dialog, when input is from stdin, errors send their
934 messages to stderr and execution continues, even if @code{IOSTAT} is set.
935
936 @code{PRINT} namelist is permitted.  This causes an error if
937 @option{-std=f95} is used.
938 @smallexample
939 PROGRAM test_print
940   REAL, dimension (4)  ::  x = (/1.0, 2.0, 3.0, 4.0/)
941   NAMELIST /mynml/ x
942   PRINT mynml
943 END PROGRAM test_print
944 @end smallexample
945
946 Expanded namelist reads are permitted.  This causes an error if 
947 @option{-std=f95} is used.  In the following example, the first element
948 of the array will be given the value 0.00 and the two succeeding
949 elements will be given the values 1.00 and 2.00.
950 @smallexample
951 &MYNML
952   X(1,1) = 0.00 , 1.00 , 2.00
953 /
954 @end smallexample
955
956 @node X format descriptor without count field
957 @section @code{X} format descriptor without count field
958
959 To support legacy codes, GNU Fortran permits the count field of the
960 @code{X} edit descriptor in @code{FORMAT} statements to be omitted.
961 When omitted, the count is implicitly assumed to be one.
962
963 @smallexample
964        PRINT 10, 2, 3
965 10     FORMAT (I1, X, I1)
966 @end smallexample
967
968 @node Commas in FORMAT specifications
969 @section Commas in @code{FORMAT} specifications
970
971 To support legacy codes, GNU Fortran allows the comma separator
972 to be omitted immediately before and after character string edit
973 descriptors in @code{FORMAT} statements.
974
975 @smallexample
976        PRINT 10, 2, 3
977 10     FORMAT ('FOO='I1' BAR='I2)
978 @end smallexample
979
980
981 @node Missing period in FORMAT specifications
982 @section Missing period in @code{FORMAT} specifications
983
984 To support legacy codes, GNU Fortran allows missing periods in format
985 specifications if and only if @option{-std=legacy} is given on the
986 command line.  This is considered non-conforming code and is
987 discouraged.
988
989 @smallexample
990        REAL :: value
991        READ(*,10) value
992 10     FORMAT ('F4')
993 @end smallexample
994
995 @node I/O item lists
996 @section I/O item lists
997 @cindex I/O item lists
998
999 To support legacy codes, GNU Fortran allows the input item list
1000 of the @code{READ} statement, and the output item lists of the
1001 @code{WRITE} and @code{PRINT} statements, to start with a comma.
1002
1003 @node BOZ literal constants
1004 @section BOZ literal constants
1005 @cindex BOZ literal constants
1006
1007 As an extension, GNU Fortran allows hexadecimal BOZ literal constants to
1008 be specified using the X prefix, in addition to the standard Z prefix.
1009 BOZ literal constants can also be specified by adding a suffix to the
1010 string. For example, @code{Z'ABC'} and @code{'ABC'Z} are equivalent.
1011
1012 The Fortran standard restricts the appearance of a BOZ literal constant
1013 to the @code{DATA} statement, and it is expected to be assigned to an
1014 @code{INTEGER} variable.  GNU Fortran permits a BOZ literal to appear in
1015 any initialization expression as well as assignment statements.
1016
1017 Attempts to use a BOZ literal constant to do a bitwise initialization of
1018 a variable can lead to confusion.  A BOZ literal constant is converted
1019 to an @code{INTEGER} value with the kind type with the largest decimal
1020 representation, and this value is then converted numerically to the type
1021 and kind of the variable in question.  Thus, one should not expect a
1022 bitwise copy of the BOZ literal constant to be assigned to a @code{REAL}
1023 variable.
1024
1025 Similarly, initializing an @code{INTEGER} variable with a statement such
1026 as @code{DATA i/Z'FFFFFFFF'/} will produce an integer overflow rather
1027 than the desired result of @math{-1} when @code{i} is a 32-bit integer
1028 on a system that supports 64-bit integers.  The @samp{-fno-range-check}
1029 option can be used as a workaround for legacy code that initializes
1030 integers in this manner.
1031
1032 @node Real array indices
1033 @section Real array indices
1034 @cindex array, indices of type real
1035
1036 As an extension, GNU Fortran allows the use of @code{REAL} expressions
1037 or variables as array indices.
1038
1039 @node Unary operators
1040 @section Unary operators
1041 @cindex operators, unary
1042
1043 As an extension, GNU Fortran allows unary plus and unary minus operators
1044 to appear as the second operand of binary arithmetic operators without
1045 the need for parenthesis.
1046
1047 @smallexample
1048        X = Y * -Z
1049 @end smallexample
1050
1051 @node Implicitly convert LOGICAL and INTEGER values
1052 @section Implicitly convert @code{LOGICAL} and @code{INTEGER} values
1053 @cindex conversion, to integer
1054 @cindex conversion, to logical
1055
1056 As an extension for backwards compatibility with other compilers, GNU
1057 Fortran allows the implicit conversion of @code{LOGICAL} values to
1058 @code{INTEGER} values and vice versa.  When converting from a
1059 @code{LOGICAL} to an @code{INTEGER}, @code{.FALSE.} is interpreted as
1060 zero, and @code{.TRUE.} is interpreted as one.  When converting from
1061 @code{INTEGER} to @code{LOGICAL}, the value zero is interpreted as
1062 @code{.FALSE.} and any nonzero value is interpreted as @code{.TRUE.}.
1063
1064 @smallexample
1065        INTEGER :: i = 1
1066        IF (i) PRINT *, 'True'
1067 @end smallexample
1068
1069 @node Hollerith constants support
1070 @section Hollerith constants support
1071 @cindex Hollerith constants
1072
1073 GNU Fortran supports Hollerith constants in assignments, function
1074 arguments, and @code{DATA} and @code{ASSIGN} statements.  A Hollerith
1075 constant is written as a string of characters preceded by an integer
1076 constant indicating the character count, and the letter @code{H} or
1077 @code{h}, and stored in bytewise fashion in a numeric (@code{INTEGER},
1078 @code{REAL}, or @code{complex}) or @code{LOGICAL} variable.  The
1079 constant will be padded or truncated to fit the size of the variable in
1080 which it is stored.
1081
1082 Examples of valid uses of Hollerith constants:
1083 @smallexample
1084       complex*16 x(2)
1085       data x /16Habcdefghijklmnop, 16Hqrstuvwxyz012345/
1086       x(1) = 16HABCDEFGHIJKLMNOP
1087       call foo (4h abc)
1088 @end smallexample
1089
1090 Invalid Hollerith constants examples:
1091 @smallexample
1092       integer*4 a
1093       a = 8H12345678 ! Valid, but the Hollerith constant will be truncated.
1094       a = 0H         ! At least one character is needed.
1095 @end smallexample
1096
1097 In general, Hollerith constants were used to provide a rudimentary
1098 facility for handling character strings in early Fortran compilers,
1099 prior to the introduction of @code{CHARACTER} variables in Fortran 77;
1100 in those cases, the standard-compliant equivalent is to convert the
1101 program to use proper character strings.  On occasion, there may be a
1102 case where the intent is specifically to initialize a numeric variable
1103 with a given byte sequence.  In these cases, the same result can be
1104 obtained by using the @code{TRANSFER} statement, as in this example.
1105 @smallexample
1106       INTEGER(KIND=4) :: a
1107       a = TRANSFER ("abcd", a)     ! equivalent to: a = 4Habcd
1108 @end smallexample
1109
1110
1111 @node Cray pointers
1112 @section Cray pointers
1113 @cindex pointer, cray
1114
1115 Cray pointers are part of a non-standard extension that provides a
1116 C-like pointer in Fortran.  This is accomplished through a pair of
1117 variables: an integer "pointer" that holds a memory address, and a
1118 "pointee" that is used to dereference the pointer.
1119
1120 Pointer/pointee pairs are declared in statements of the form:
1121 @smallexample
1122         pointer ( <pointer> , <pointee> )
1123 @end smallexample
1124 or,
1125 @smallexample
1126         pointer ( <pointer1> , <pointee1> ), ( <pointer2> , <pointee2> ), ...
1127 @end smallexample
1128 The pointer is an integer that is intended to hold a memory address.
1129 The pointee may be an array or scalar.  A pointee can be an assumed
1130 size array---that is, the last dimension may be left unspecified by
1131 using a @code{*} in place of a value---but a pointee cannot be an
1132 assumed shape array.  No space is allocated for the pointee.
1133
1134 The pointee may have its type declared before or after the pointer
1135 statement, and its array specification (if any) may be declared
1136 before, during, or after the pointer statement.  The pointer may be
1137 declared as an integer prior to the pointer statement.  However, some
1138 machines have default integer sizes that are different than the size
1139 of a pointer, and so the following code is not portable:
1140 @smallexample
1141         integer ipt
1142         pointer (ipt, iarr)
1143 @end smallexample
1144 If a pointer is declared with a kind that is too small, the compiler
1145 will issue a warning; the resulting binary will probably not work
1146 correctly, because the memory addresses stored in the pointers may be
1147 truncated.  It is safer to omit the first line of the above example;
1148 if explicit declaration of ipt's type is omitted, then the compiler
1149 will ensure that ipt is an integer variable large enough to hold a
1150 pointer.
1151
1152 Pointer arithmetic is valid with Cray pointers, but it is not the same
1153 as C pointer arithmetic.  Cray pointers are just ordinary integers, so
1154 the user is responsible for determining how many bytes to add to a
1155 pointer in order to increment it.  Consider the following example:
1156 @smallexample
1157         real target(10)
1158         real pointee(10)
1159         pointer (ipt, pointee)
1160         ipt = loc (target)
1161         ipt = ipt + 1       
1162 @end smallexample
1163 The last statement does not set @code{ipt} to the address of
1164 @code{target(1)}, as it would in C pointer arithmetic.  Adding @code{1}
1165 to @code{ipt} just adds one byte to the address stored in @code{ipt}.
1166
1167 Any expression involving the pointee will be translated to use the
1168 value stored in the pointer as the base address.
1169
1170 To get the address of elements, this extension provides an intrinsic
1171 function @code{LOC()}.  The @code{LOC()} function is equivalent to the
1172 @code{&} operator in C, except the address is cast to an integer type:
1173 @smallexample
1174         real ar(10)
1175         pointer(ipt, arpte(10))
1176         real arpte
1177         ipt = loc(ar)  ! Makes arpte is an alias for ar
1178         arpte(1) = 1.0 ! Sets ar(1) to 1.0
1179 @end smallexample
1180 The pointer can also be set by a call to the @code{MALLOC} intrinsic
1181 (see @ref{MALLOC}).
1182
1183 Cray pointees often are used to alias an existing variable.  For
1184 example:
1185 @smallexample
1186         integer target(10)
1187         integer iarr(10)
1188         pointer (ipt, iarr)
1189         ipt = loc(target)
1190 @end smallexample
1191 As long as @code{ipt} remains unchanged, @code{iarr} is now an alias for
1192 @code{target}. The optimizer, however, will not detect this aliasing, so
1193 it is unsafe to use @code{iarr} and @code{target} simultaneously.  Using
1194 a pointee in any way that violates the Fortran aliasing rules or
1195 assumptions is illegal. It is the user's responsibility to avoid doing
1196 this; the compiler works under the assumption that no such aliasing
1197 occurs.
1198
1199 Cray pointers will work correctly when there is no aliasing (i.e., when
1200 they are used to access a dynamically allocated block of memory), and
1201 also in any routine where a pointee is used, but any variable with which
1202 it shares storage is not used.  Code that violates these rules may not
1203 run as the user intends.  This is not a bug in the optimizer; any code
1204 that violates the aliasing rules is illegal.  (Note that this is not
1205 unique to GNU Fortran; any Fortran compiler that supports Cray pointers
1206 will ``incorrectly'' optimize code with illegal aliasing.)
1207
1208 There are a number of restrictions on the attributes that can be applied
1209 to Cray pointers and pointees.  Pointees may not have the
1210 @code{ALLOCATABLE}, @code{INTENT}, @code{OPTIONAL}, @code{DUMMY},
1211 @code{TARGET}, @code{INTRINSIC}, or @code{POINTER} attributes. Pointers
1212 may not have the @code{DIMENSION}, @code{POINTER}, @code{TARGET},
1213 @code{ALLOCATABLE}, @code{EXTERNAL}, or @code{INTRINSIC} attributes.
1214 Pointees may not occur in more than one pointer statement.  A pointee
1215 cannot be a pointer.  Pointees cannot occur in equivalence, common, or
1216 data statements.
1217
1218 A Cray pointer may also point to a function or a subroutine.  For
1219 example, the following excerpt is valid:
1220 @smallexample
1221   implicit none
1222   external sub
1223   pointer (subptr,subpte)
1224   external subpte
1225   subptr = loc(sub)
1226   call subpte()
1227   [...]
1228   subroutine sub
1229   [...]
1230   end subroutine sub
1231 @end smallexample
1232
1233 A pointer may be modified during the course of a program, and this
1234 will change the location to which the pointee refers.  However, when
1235 pointees are passed as arguments, they are treated as ordinary
1236 variables in the invoked function.  Subsequent changes to the pointer
1237 will not change the base address of the array that was passed.
1238
1239 @node CONVERT specifier
1240 @section CONVERT specifier
1241 @cindex CONVERT specifier
1242
1243 GNU Fortran allows the conversion of unformatted data between little-
1244 and big-endian representation to facilitate moving of data
1245 between different systems.  The conversion can be indicated with
1246 the @code{CONVERT} specifier on the @code{OPEN} statement.
1247 @xref{GFORTRAN_CONVERT_UNIT}, for an alternative way of specifying
1248 the data format via an environment variable.
1249
1250 Valid values for @code{CONVERT} are:
1251 @itemize @w{}
1252 @item @code{CONVERT='NATIVE'} Use the native format.  This is the default.
1253 @item @code{CONVERT='SWAP'} Swap between little- and big-endian.
1254 @item @code{CONVERT='LITTLE_ENDIAN'} Use the little-endian representation
1255         for unformatted files.
1256 @item @code{CONVERT='BIG_ENDIAN'} Use the big-endian representation for
1257         unformatted files.
1258 @end itemize
1259
1260 Using the option could look like this:
1261 @smallexample
1262   open(file='big.dat',form='unformatted',access='sequential', &
1263        convert='big_endian')
1264 @end smallexample
1265
1266 The value of the conversion can be queried by using
1267 @code{INQUIRE(CONVERT=ch)}.  The values returned are
1268 @code{'BIG_ENDIAN'} and @code{'LITTLE_ENDIAN'}.
1269
1270 @code{CONVERT} works between big- and little-endian for
1271 @code{INTEGER} values of all supported kinds and for @code{REAL}
1272 on IEEE systems of kinds 4 and 8.  Conversion between different
1273 ``extended double'' types on different architectures such as
1274 m68k and x86_64, which GNU Fortran
1275 supports as @code{REAL(KIND=10)} and @code{REAL(KIND=16)}, will
1276 probably not work.
1277
1278 @emph{Note that the values specified via the GFORTRAN_CONVERT_UNIT
1279 environment variable will override the CONVERT specifier in the
1280 open statement}.  This is to give control over data formats to
1281 users who do not have the source code of their program available.
1282
1283 Using anything but the native representation for unformatted data
1284 carries a significant speed overhead.  If speed in this area matters
1285 to you, it is best if you use this only for data that needs to be
1286 portable.
1287
1288 @node OpenMP
1289 @section OpenMP
1290 @cindex OpenMP
1291
1292 GNU Fortran attempts to be OpenMP Application Program Interface v2.5
1293 compatible when invoked with the @option{-fopenmp} option.  GNU Fortran
1294 then generates parallelized code according to the OpenMP directives
1295 used in the source.  The OpenMP Fortran runtime library
1296 routines are provided both in a form of a Fortran 90 module named
1297 @code{omp_lib} and in a form of a Fortran @code{include} file named
1298 @file{omp_lib.h}.
1299
1300 For details refer to the actual
1301 @uref{http://www.openmp.org/drupal/mp-documents/spec25.pdf,
1302 OpenMP Application Program Interface v2.5} specification.
1303
1304 @node Argument list functions
1305 @section Argument list functions %VAL, %REF and %LOC
1306 @cindex argument list functions
1307 @cindex %VAL
1308 @cindex %REF
1309 @cindex %LOC
1310
1311 GNU Fortran supports argument list functions @code{%VAL}, @code{%REF} 
1312 and @code{%LOC} statements, for backward compatibility with g77. 
1313 It is recommended that these should be used only for code that is 
1314 accessing facilities outside of GNU Fortran, such as operating system 
1315 or windowing facilities. It is best to constrain such uses to isolated 
1316 portions of a program--portions that deal specifically and exclusively 
1317 with low-level, system-dependent facilities. Such portions might well 
1318 provide a portable interface for use by the program as a whole, but are 
1319 themselves not portable, and should be thoroughly tested each time they 
1320 are rebuilt using a new compiler or version of a compiler.
1321
1322 @code{%VAL} passes a scalar argument by value, @code{%REF} passes it by 
1323 reference and @code{%LOC} passes its memory location.  Since gfortran 
1324 already passes scalar arguments by reference, @code{%REF} is in effect 
1325 a do-nothing.  @code{%LOC} has the same effect as a fortran pointer.
1326
1327 An example of passing an argument by value to a C subroutine foo.:
1328 @smallexample
1329 C
1330 C prototype      void foo_ (float x);
1331 C
1332       external foo
1333       real*4 x
1334       x = 3.14159
1335       call foo (%VAL (x))
1336       end
1337 @end smallexample
1338
1339 For details refer to the g77 manual
1340 @uref{http://gcc.gnu.org/onlinedocs/gcc-3.4.6/g77/index.html#Top}.
1341
1342 Also, the gfortran testsuite c_by_val.f and its partner c_by_val.c are
1343 worth a look.
1344
1345 @c ---------------------------------------------------------------------
1346 @c Intrinsic Procedures
1347 @c ---------------------------------------------------------------------
1348
1349 @include intrinsic.texi
1350
1351
1352 @tex
1353 \blankpart
1354 @end tex
1355
1356 @c ---------------------------------------------------------------------
1357 @c Contributing
1358 @c ---------------------------------------------------------------------
1359
1360 @node Contributing
1361 @unnumbered Contributing
1362 @cindex Contributing
1363
1364 Free software is only possible if people contribute to efforts
1365 to create it.
1366 We're always in need of more people helping out with ideas
1367 and comments, writing documentation and contributing code.
1368
1369 If you want to contribute to GNU Fortran,
1370 have a look at the long lists of projects you can take on.
1371 Some of these projects are small,
1372 some of them are large;
1373 some are completely orthogonal to the rest of what is
1374 happening on GNU Fortran,
1375 but others are ``mainstream'' projects in need of enthusiastic hackers.
1376 All of these projects are important!
1377 We'll eventually get around to the things here,
1378 but they are also things doable by someone who is willing and able.
1379
1380 @menu
1381 * Contributors::
1382 * Projects::
1383 * Proposed Extensions::
1384 @end menu
1385
1386
1387 @node Contributors
1388 @section Contributors to GNU Fortran
1389 @cindex Contributors
1390 @cindex Credits
1391 @cindex Authors
1392
1393 Most of the parser was hand-crafted by @emph{Andy Vaught}, who is
1394 also the initiator of the whole project.  Thanks Andy!
1395 Most of the interface with GCC was written by @emph{Paul Brook}.
1396
1397 The following individuals have contributed code and/or
1398 ideas and significant help to the GNU Fortran project
1399 (in no particular order):
1400
1401 @itemize @minus
1402 @item Andy Vaught
1403 @item Katherine Holcomb
1404 @item Tobias Schl@"uter
1405 @item Steven Bosscher
1406 @item Toon Moene
1407 @item Tim Prince
1408 @item Niels Kristian Bech Jensen
1409 @item Steven Johnson
1410 @item Paul Brook
1411 @item Feng Wang
1412 @item Bud Davis
1413 @item Paul Thomas
1414 @item Fran@,{c}ois-Xavier Coudert
1415 @item Steven G. Kargl
1416 @item Jerry Delisle
1417 @item Janne Blomqvist
1418 @item Erik Edelmann
1419 @item Thomas Koenig
1420 @item Asher Langton
1421 @item Jakub Jelinek
1422 @item Roger Sayle
1423 @item H.J. Lu
1424 @item Richard Henderson
1425 @item Richard Sandiford
1426 @item Richard Guenther
1427 @item Bernhard Fischer
1428 @end itemize
1429
1430 The following people have contributed bug reports,
1431 smaller or larger patches,
1432 and much needed feedback and encouragement for the
1433 GNU Fortran project: 
1434
1435 @itemize @minus
1436 @item Erik Schnetter
1437 @item Bill Clodius
1438 @item Kate Hedstrom
1439 @end itemize
1440
1441 Many other individuals have helped debug,
1442 test and improve the GNU Fortran compiler over the past few years,
1443 and we welcome you to do the same!
1444 If you already have done so,
1445 and you would like to see your name listed in the
1446 list above, please contact us.
1447
1448
1449 @node Projects
1450 @section Projects
1451
1452 @table @emph
1453
1454 @item Help build the test suite
1455 Solicit more code for donation to the test suite.
1456 We can keep code private on request.
1457
1458 @item Bug hunting/squishing
1459 Find bugs and write more test cases!
1460 Test cases are especially very welcome,
1461 because it allows us to concentrate on fixing bugs
1462 instead of isolating them.
1463
1464 @item Smaller projects (``bug'' fixes):
1465   @itemize @minus
1466   @item Allow init exprs to be numbers raised to integer powers.
1467   @item Implement correct rounding.
1468   @item Implement F restrictions on Fortran 95 syntax.
1469   @item See about making Emacs-parsable error messages.
1470   @end itemize
1471 @end table
1472
1473 If you wish to work on the runtime libraries,
1474 please contact a project maintainer.
1475 @c TODO: email!
1476
1477
1478 @node Proposed Extensions
1479 @section Proposed Extensions
1480
1481 Here's a list of proposed extensions for the GNU Fortran compiler, in no particular
1482 order.  Most of these are necessary to be fully compatible with
1483 existing Fortran compilers, but they are not part of the official
1484 J3 Fortran 95 standard.
1485
1486 @subsection Compiler extensions: 
1487 @itemize @bullet
1488 @item
1489 User-specified alignment rules for structures.
1490
1491 @item
1492 Flag to generate @code{Makefile} info.
1493
1494 @item
1495 Automatically extend single precision constants to double.
1496
1497 @item
1498 Compile code that conserves memory by dynamically allocating common and
1499 module storage either on stack or heap.
1500
1501 @item
1502 Compile flag to generate code for array conformance checking (suggest -CC).
1503
1504 @item
1505 User control of symbol names (underscores, etc).
1506
1507 @item
1508 Compile setting for maximum size of stack frame size before spilling
1509 parts to static or heap.
1510
1511 @item
1512 Flag to force local variables into static space.
1513
1514 @item
1515 Flag to force local variables onto stack.
1516
1517 @item
1518 Flag for maximum errors before ending compile.
1519
1520 @item
1521 Option to initialize otherwise uninitialized integer and floating
1522 point variables.
1523 @end itemize
1524
1525
1526 @subsection Environment Options
1527 @itemize @bullet
1528 @item
1529 Pluggable library modules for random numbers, linear algebra.
1530 LA should use BLAS calling conventions.
1531
1532 @item
1533 Environment variables controlling actions on arithmetic exceptions like
1534 overflow, underflow, precision loss---Generate NaN, abort, default.
1535 action.
1536
1537 @item
1538 Set precision for fp units that support it (i387).
1539
1540 @item
1541 Variable for setting fp rounding mode.
1542
1543 @item
1544 Variable to fill uninitialized variables with a user-defined bit
1545 pattern.
1546
1547 @item
1548 Environment variable controlling filename that is opened for that unit
1549 number.
1550
1551 @item
1552 Environment variable to clear/trash memory being freed.
1553
1554 @item
1555 Environment variable to control tracing of allocations and frees.
1556
1557 @item
1558 Environment variable to display allocated memory at normal program end.
1559
1560 @item
1561 Environment variable for filename for * IO-unit.
1562
1563 @item
1564 Environment variable for temporary file directory.
1565
1566 @item
1567 Environment variable forcing standard output to be line buffered (unix).
1568
1569 @end itemize
1570
1571
1572 @c ---------------------------------------------------------------------
1573 @c GNU General Public License
1574 @c ---------------------------------------------------------------------
1575
1576 @include gpl.texi
1577
1578
1579
1580 @c ---------------------------------------------------------------------
1581 @c GNU Free Documentation License
1582 @c ---------------------------------------------------------------------
1583
1584 @include fdl.texi
1585
1586
1587
1588 @c ---------------------------------------------------------------------
1589 @c Funding Free Software
1590 @c ---------------------------------------------------------------------
1591
1592 @include funding.texi
1593
1594 @c ---------------------------------------------------------------------
1595 @c Indices
1596 @c ---------------------------------------------------------------------
1597
1598 @node Option Index
1599 @unnumbered Option Index
1600 @command{gfortran}'s command line options are indexed here without any
1601 initial @samp{-} or @samp{--}. Where an option has both positive and
1602 negative forms (such as -foption and -fno-option), relevant entries in
1603 the manual are indexed under the most appropriate form; it may sometimes
1604 be useful to look up both forms.
1605 @printindex op
1606
1607 @node Keyword Index
1608 @unnumbered Keyword Index
1609 @printindex cp
1610
1611 @bye