.\" Copyright (c) 1985, 1993
.\" The Regents of the University of California. All rights reserved.
.\" %sccs.include.proprietary.man%
.\" @(#)f77IO.ms 8.2 (Berkeley) %G%
.EH 'PSD:9-%''Introduction to the f77 I/O Library'
.OH 'Introduction to the f77 I/O Library''PSD:9-%'
.\" Nh macro - same as NH but also saves heading for table of contents
.\" Nh usage: Nh level string, e.g.: .Nh 2 "Calculator Sample"
Introduction to the f77 I/O Library
University of California, Berkeley
Berkeley, California 94720
The f77 I/O library, libI77.a,
includes routines to perform all of the standard types of
input and output specified in the
The I/O Library was written originally by Peter J. Weinberger at Bell Labs.
Where the original implementation was incomplete,
it has been rewritten to more closely implement the standard.
Where the standard is vague,
we have tried to provide flexibility within the constraints of the
A number of logical extensions and enhancements have been provided
such as the use of the C stdio library routines to provide
efficient buffering for file I/O.
.\" page 2 is allocated to the table of contents
standard impose significant overhead
on programs that do large amounts of I/O. Formatted I/O can be
very ``expensive'' while direct access binary I/O is usually very efficient.
Because of the complexity of
some general concepts deserve clarification.
.Nh 2 "Types of I/O and logical records"
There are four forms of I/O:
related to formatted but do not obey all the rules for formatted I/O.
There are two types of ``files'':
and two modes of access to files:
The definition of a logical record depends upon the
combination of I/O form, file type, and access mode specified by the
.Nh 3 "Direct access external I/O"
file is a string of bytes
of a length specified when the file is opened.
Read and write statements must not specify logical records longer than
the original record size definition. Shorter logical records are allowed.
direct writes leave the unfilled part of the record undefined.
direct writes cause the unfilled record to be padded with blanks.
.Nh 3 "Sequential access external I/O"
files may be of arbitrary
Logical record length for
sequential files is determined by
the size of items in the iolist.
The requirements of this form of I/O cause the external physical
record size to be somewhat larger than the logical record size.
write statements, logical record length is determined by
the format statement interacting with the iolist at execution time.
The ``newline'' character is the logical record delimiter.
Formatted sequential access causes one or more logical records
ending with ``newline'' characters to be read or written.
.Nh 3 "List directed and namelist sequential external I/O"
Logical record length for
I/O is relatively meaningless.
On output, the record length is dependent on the magnitude of the
On input, the record length is determined by the data types and the file
By ANSI definition, a slash, ``/'', terminates execution of a
list directed input operation.
Namelist input is terminated by ``&end'' or ``$end'' (depending on whether
the character before the namelist name was ``&'' or ``$'').
The logical record length for an
read or write is the length of the
character variable or array element. Thus a simple character variable
is a single logical record. A character variable array is similar to
a fixed length direct access file, and obeys the same rules.
I/O are not allowed on ``internal'' files.
Note that each execution of a
I/O statement causes a single
logical record to be read or written. Each execution of a
I/O statement causes one or more logical records to be read or written.
A slash, ``/'', will terminate assignment of
values to the input list during
input and the remainder of the current input line is skipped.
The standard is rather vague on this point but seems to require that
a new external logical record be found at the start of any formatted
input. Therefore data following the slash is ignored and may be used
to comment the data file.
.B "Direct access list directed"
.B "Unformatted internal"
All other flavors of I/O are allowed, although some are not part of the
Any I/O statement may include an
clause to specify an alternative branch to be taken on errors
clause to return the specific error code.
Any error detected during I/O processing will cause the program to abort
has been specificed in the program.
Read statements may include
to branch on end-of-file.
The end-of-file indication for that logical unit may be reset with
a \fBbackspace\fP statement.
File position and the value of I/O list items is undefined following an error.
.Nh 1 "Implementation details"
Some details of the current implementation may be useful in understanding
.Nh 2 "Number of logical units"
Unit numbers must be in the range 0 \- 99.
The maximum number of logical units that a program may have open at one
system limit, currently 48.
.Nh 2 "Standard logical units"
By default, logical units 0, 5, and 6
are opened to ``stderr'', ``stdin'', and ``stdout'' respectively.
However they can be re-defined with an
To preserve error reporting, it is an error to close logical unit 0
although it may be reopened to another file.
If you want to open the default file name for any preconnected logical unit,
Redefining the standard units may impair normal console I/O.
use shell re-direction to externally re-define the above units.
To re-define default blank control or format of the standard input or output
statement specifying the unit number and no
file name (see \(sc\|2.4).
The standard units, 0, 5, and 6, are named internally ``stderr'', ``stdin'',
and ``stdout'' respectively.
These are not actual file names and can not be used for opening these units.
will not return these names and will indicate
that the above units are not named unless they have been opened to real files.
The names are meant to make error reporting more meaningful.
.Nh 2 "Vertical format control"
Simple vertical format control is implemented. The logical unit must be opened
for sequential access with
.B "form = \(fmprint\(fm"
Control codes ``0'' and ``1'' are replaced in the output file
with ``\\n'' and ``\\f'' respectively.
The control character ``+'' is not implemented and, like
any other character in the first position of a record
written to a ``print'' file, is dropped.
.B "form = \(fmprint\(fm"
mode does not recognize vertical format control for
.B "direct formatted, list directed,"
the filter \fIfpr\fP(1) for vertical format control.
It replaces ``0'' and ``1'' by
``\\n'' and ``\\f'' respectively, and implements the ``+'' control code.
.B "form = \(fmprint\(fm"
which drops unrecognized form control characters, \fIfpr\fP copies those
characters to the output file.
.Nh 2 "File names and the open statement"
A file name may be specified in an \fBopen\fP statement for the
If a logical unit is opened by an \fBopen\fP statement which does
not specify a file name, or it is opened implicitly by the execution
of a \fBread\fP, \fBwrite\fP, or \fBendfile\fP
statement, then the default file name is
is the logical unit number.
Before opening the file, the library checks for an environment
variable with a name identical to the tail of the
file name with periods removed.\(dg
\(dgPeriods are deleted because they can not be part of environment variable names in the Bourne shell.
If it finds such an environment variable, it uses its value
as the actual name of the file.
For example, a program containing:
open(32,file=\(fm/usr/guest/census/data.d\(fm)
normally will read from \fI/usr/guest/census/data.d\fP and write to
\fIfort.44\fP in the current directory.
If the environment variables \fIdatad\fP and \fIfort44\fP are set,
in the Bourne shell, then the program will read from \fImydata\fP and
statement need not specify a file name. If it refers to a logical
unit that is already open, the
redefined without affecting the current file position.
.B "status = \(fmscratch\(fm"
is specified, a temporary file with a
and, by default, will be deleted when closed or during
termination of program execution.
It is an error to try to open an existing file with
.B "status = \(fmnew\(fm"
It is an error to try to open a nonexistent file with
.B "status = \(fmold\(fm"
.B "status = \(fmunknown\(fm"
will be assumed, and a file will be created if necessary.
By default, files are positioned
at their beginning upon opening, but see \fIfseek\fP(3f)
and \fIioinit\fP(3f) for alternatives.
Existing files are never truncated on opening.
Sequentially accessed external files are truncated to the current file
position on \fBclose\fP, \fBbackspace\fP, or \fBrewind\fP only if the last
access to the file was a write.
always causes such files to be truncated to the current
.Nh 2 "Format interpretation"
Formats which are in format statements are parsed by the compiler;
formats in \fBread\fP, \fBwrite\fP, and \fBprint\fP statements
are parsed during execution by the
Upper as well as lower case characters are recognized in format statements
and all the alphabetic arguments to the I/O library routines.
If the external representation of a datum
is too large for the field width specified, the specified
field is filled with asterisks (\(**).
On \fBE\fPw.d\fBE\fPe output,
the exponent field will be filled with asterisks if the
exponent representation is too large.
This will only happen if ``e'' is zero (see appendix B).
On output, a real value that is truly zero will display as ``0.'' to
distinguish it from a very small non-zero value.
If this causes problems for other input systems, the
\fBBZ\fP edit descriptor may be used to cause the field
following the decimal point to be filled with zero's.
Non-destructive tabbing is implemented for both internal and external
Tabbing left or right on output
does not affect previously written portions of a record.
causes unwritten portions of a record to be filled with blanks.
Tabbing right off the end of an input logical record is an error.
Tabbing left beyond the beginning of an input logical record leaves
the input pointer at the beginning of the record.
must be followed by a positive non-zero number.
If it is not, it will have a different meaning (see \(sc\|3.1).
Tabbing left requires seek ability on the logical unit.
Therefore it is not allowed in I/O to a terminal or pipe.
Likewise, nondestructive tabbing in either direction is possible
only on a unit that can seek. Otherwise tabbing right or spacing with
will write blanks on the output.
.Nh 2 "List directed output"
In formatting list directed output, the I/O system tries to prevent
output lines longer than 80 characters.
Each external datum will be separated by two spaces.
values includes an appropriate comma.
List directed output distinguishes between
values and formats them differently.
Output of a character string that includes ``\\n''
is interpreted reasonably by the output system.
If I/O errors are not trapped by the user's program an appropriate
error message will be written to ``stderr'' before aborting.
An error number will be printed in ``[ ]'' along with a brief error message
showing the logical unit and I/O state.
Error numbers < 100 refer to
errors, and are described in the
introduction to chapter 2 of the
Error numbers \(>= 100 come from the I/O library, and are described
further in the appendix to this writeup\(dd.
\(dd On many systems, these are also available in \fIhelp f77 io_err_msgs\fP.
For internal I/O, part of the string will be printed with ``|'' at the
current position in the string.
For external I/O, part of the current record will be displayed if
the error was caused during reading from a file that can backspace.
.Nh 1 "Non-``ANSI Standard'' extensions"
Several extensions have been added to the I/O system to provide
for functions omitted or poorly defined in the standard.
Programmers should be aware that these are non-portable.
.Nh 2 "Format specifiers"
is an acceptable edit control specifier. It causes return to the logical unit's
default mode of blank interpretation.
which returns to default sign control.
by itself is equivalent to
\&. It resets the scale factor to the
The form of the \fBE\fPw.d\fBE\fPe format specifier has been extended to
The form \fBE\fPw.d.e is allowed but is not standard.
The ``e'' field specifies the minimum number of digits or spaces in the
exponent field on output.
If the value of the exponent is too large, the exponent notation
will be dropped from the output to allow one
If this is still not adequate, the ``e'' field will be filled with
The default value for ``e'' is 2.
An additional form of tab control specification has been added.
standard forms \fBTR\fPn, \fBTL\fPn, and \fBT\fPn are supported
is a positive non-zero number.
or n\fBT\fP is specified, tabbing will
be to the next (or n-th) 8-column tab stop.
Thus columns of alphanumerics can be lined up without counting.
A format control specifier has been added to suppress the newline
at the end of the last record of a formatted sequential write. The
specifier is a dollar sign ($). It is constrained by the same rules
as the colon (:). It is used typically for console prompts.
write (\(**, "(\(fmenter value for x: \(fm,$)")
Radices other than 10 can be specified for formatted integer I/O
conversion. The specifier is patterned after
floating point conversion. It remains in effect until another radix is
specified or format interpretation is complete. The specifier is defined
as [n]\fBR\fP where 2 \(<= \fIn\fP \(<= 36. If
the default decimal radix is restored.
The format specifier \fBO\fPm.n may be used for an octal conversion;
it is equivalent to 8\fBR,I\fPm.n,10\fBR\fP.
Similarly, \fBZ\fPm.n is equivalent to 16\fBR,I\fPm.n,10\fBR\fP and
may be used for an hexadecimal conversion;
In conjunction with the above, a sign control specifier has been added
to cause integer values to be interpreted as unsigned during output
conversion. The specifier is
and remains in effect until another
sign control specifier is encountered, or format interpretation is
\(dgNote: Unsigned integer values greater than (2\(**\(**31 - 1),
can be read and written using \fBSU\fP.
However they can not be used in
uses signed arithmetic and such values appear to the arithmetic unit
Radix and ``unsigned'' specifiers could be used to format
a hexadecimal dump, as follows:
2000 format ( SU, 8Z10.8 )
standard is ambiguous regarding the definition of a ``print'' file.
has no default ``print'' file, an additional
.B "form = \(fmprint\(fm"
and enables vertical format
control for that logical unit (see \(sc\|2.3).
Vertical format control is interpreted only on sequential formatted writes
for logical units opened as ``print'' files.
It will return -1 for the unit number of an unconnected file.
If a logical unit is already open, an
option will do nothing but re-define those options.
statement need not include the file name, and
must not include a file name if
refers to a standard input or output.
Therefore, to re-define the standard output as a ``print'' file, use:
open (unit=6, form=\(fmprint\(fm)
.B "status = \(fmkeep\(fm"
may be specified for temporary files.
This is the default for all other files.
Remember to get the scratch file's real name,
\&, if you want to re-open it later.
.Nh 2 "List directed I/O"
List directed read has been modified to allow
tab characters wherever blanks are allowed.
It also allows input of a string not enclosed in quotes.
The string must not start with a digit or quote,
and can not contain any separators ( ``,'', ``/'', blank or tab ).
A newline will terminate the string unless escaped with \\.
Any string not meeting the above restrictions
must be enclosed in quotes (`` " '' or `` \(fm '').
Internal list directed I/O has been implemented. During internal list reads,
bytes are consumed until the iolist is satisfied, or the ``end-of-file''
During internal list writes, records are filled until the iolist is satisfied.
The length of an internal array element should be at least 20 bytes to
avoid logical record overflow when writing double precision values.
Internal list read was implemented to make command line decoding easier.
Internal list write should be avoided.
Namelist I/O is a common extension in Fortran systems.
The \fBf77\fP version was designed to be compatible with other
it is described in ``A Portable Fortran 77 Compiler'',
by Feldman and Weinberger, August, 1985.
.Nh 1 "Running older programs"
environments usually assume carriage control on all logical units,
usually interpret blank spaces on input as ``0''s, and often provide
attachment of global file names to logical units at run time.
There are several routines in the I/O library to provide these functions.
.Nh 2 "Traditional unit control parameters"
If a program reads and writes only units 5 and 6, then including
in the f77 command will cause carriage control to be interpreted on
output and cause blanks to be zeros on input without further
modification of the program.
the routine \fIioinit\fP(3f) can be called to specify control parameters
separately, including whether files should be positioned at their
beginning or end upon opening.
\fIIoinit\fP(3f) can be used to attach logical units
to specific files at run time, and to set global parameters for the
It will look for names of a user specified form in the environment
and open the corresponding logical unit for
.B "sequential formatted"
I/O. Names must be of the form \fB\s-1PREFIX\s0\fP\fInn\fP where
is specified in the call to
is the logical unit to be opened. Unit numbers < 10 must include
should prove adequate for most programs as written.
specifically so that it may serve as an example for similar
A copy may be retrieved by ``ar x /usr/lib/libU77.a ioinit.f''.
See \(sc\|2.4 for another way to override program file names
through environment variables.
.Nh 1 "Magnetic tape I/O"
Because the I/O library uses stdio buffering, reading or writing
magnetic tapes should be done with great caution, or avoided if possible.
A set of routines has been provided to read and write arbitrary sized buffers
to or from tape directly. The buffer must be a
I/O can be used to fill or interpret the buffer.
These routines do not use normal
I/O processing and do not obey
.Nh 1 "Caveat Programmer"
The I/O library is extremely complex yet we believe there are few bugs left.
We've tried to make the system as correct as possible according to
X3.9\-1978 document and keep it compatible with the
Exceptions to the standard are noted in appendix B.
.B "I/O Library Error Messages"
Appendix A: I/O Library Error Messages
The following error messages are generated by the I/O library.
The error numbers are returned in the \fBiostat=\fP variable.
Error numbers < 100 are generated by the
See the introduction to chapter 2 of the
Programmers Manual for their description.
.Er 100 "error in format"
See error message output for the location
of the error in the format. Can be caused
by more than 10 levels of nested parentheses, or
an extremely long format statement.
.Er 101 "illegal unit number"
It is illegal to close logical unit 0.
Unit numbers must be between 0 and 99 inclusive.
.Er 102 "formatted i/o not allowed"
The logical unit was opened for
.Er 103 "unformatted i/o not allowed"
The logical unit was opened for
.Er 104 "direct i/o not allowed"
The logical unit was opened for sequential
access, or the logical record length was
.Er 105 "sequential i/o not allowed"
The logical unit was opened for direct
.Er 106 "can't backspace file"
The file associated with the logical unit
can't seek. May be a device or a pipe.
.Er 107 "off beginning of record"
The format specified a left tab beyond the
beginning of an internal input record.
.Er 108 "can't stat file"
The system can't return status information
about the file. Perhaps the directory is
.Er 109 "no \(** after repeat count"
Repeat counts in list directed I/O must be
followed by an \(** with no blank spaces.
.Er 110 "off end of record"
A formatted write tried to go beyond the
logical end-of-record. An unformatted read
or write will also cause this.
.Er 111 "truncation failed"
The truncation of an external sequential file on
.Er 112 "incomprehensible list input"
List input has to be just right.
.Er 113 "out of free space"
The library dynamically creates buffers for
internal use. You ran out of memory for this.
.Er 114 "unit not connected"
The logical unit was not open.
.Er 115 "invalid data for integer format term"
Only spaces, a leading sign and digits are allowed.
.Er 116 "invalid data for logical format term"
Legal input consists of spaces (optional), a period (optional), and then
a ``t'', ``T'', ``f'', or ``F''.
.Er 117 "\|\(fmnew\|\(fm file exists"
You tried to open an existing file with
``status=\|\(fmnew\|\(fm''.
.Er 118 "can't find \|\(fmold\|\(fm file"
You tried to open a non-existent file
with ``status=\|\(fmold\|\(fm''.
.Er 119 "opening too many files or unknown system error"
Either you are trying to open too many files
simultaneously or there has been an undetected system error.
.Er 120 "requires seek ability"
Direct access requires seek ability.
Sequential unformatted I/O requires seek
ability on the file due to the special
data structure required. Tabbing left
also requires seek ability.
.Er 121 "illegal argument"
checked for legitimacy. Often only non-default
.Er 122 "negative repeat count"
The repeat count for list directed input
must be a positive integer.
.Er 123 "illegal operation for unit"
An operation was requested for a device
associated with the logical unit which
was not possible. This error is returned
by the tape I/O routines if attempting to
read past end-of-tape, etc.
.Er 124 "invalid data for d, e, f or g format term"
Input data must be legal.
.Er 125 "illegal input for namelist"
Column one of input is ignored, the namelist name
must match, the variables must be in the namelist,
and the data must be of the right type.
.B "Exceptions to the ANSI Standard"
Appendix B: Exceptions to the ANSI Standard
.B "Vertical format control"
The ``+'' carriage control specifier is not fully implemented
It would be difficult to implement it correctly and still
Furthermore, the carriage control implementation is asymmetrical.
A file written with carriage control interpretation can not be
read again with the same characters in column 1.
An alternative to interpreting carriage control internally is to
run the output file through a ``Fortran output filter''
before printing. This filter could recognize a much broader range
of carriage control and include terminal dependent processing.
One such filter is \fIfpr\fP(1).
Files created by default use of
statements are opened for
.B "sequential formatted"
access. There is no way to redefine such a file to allow
standard requires internally generated strings to be upper case or not.
As currently written, the
statement will return lower case strings for any alphanumeric data.
.B "Exponent representation on Ew.dEe output"
If the field width for the exponent is too small, the standard
allows dropping the exponent character but only if the exponent
is > 99. This system does not enforce that restriction.
Further, the standard implies that the entire field, ``w'', should be
filled with asterisks if the exponent can not be displayed.
This system fills only the exponent field in the above case since
.B "Pre-connection of files"
The standard says units must be pre-connected to files before the program
starts or must be explicitly opened.
connects the unit to a file on its first use in a
\fBread\fP, \fBwrite\fP, \fBprint\fP, or \fBendfile\fP statement.
Thus \fBinquire\fP by unit can not tell prior to a unit number use the
characteristics or name of the file corresponding to a unit.
.\" want Table of Contents to begin on page 2 hence must expand body
.\" of .TC macro to enable us to get handle on page number.