OSDN Git Service

2003-07-10 Toon Moene <toon@moene.indiv.nluug.nl>
[pf3gnuchains/gcc-fork.git] / gcc / f / intdoc.in
index 5cc9ff0..55d426a 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 1997, 1999 Free Software Foundation, Inc.
+/* Copyright (C) 1997, 1999, 2003 Free Software Foundation, Inc.
  * This is part of the G77 manual.
  * For copying conditions, see the file g77.texi. */
 
@@ -55,11 +55,11 @@ If @var{@1@} is type @code{COMPLEX}, the absolute
 value is computed as:
 
 @example
-SQRT(REALPART(@var{@1@})**2IMAGPART(@var{@1@})**2)
+SQRT(REALPART(@var{@1@})**2+IMAGPART(@var{@1@})**2)
 @end example
 
 @noindent
-Otherwise, it is computed by negating the @var{@1@} if
+Otherwise, it is computed by negating @var{@1@} if
 it is negative, or returning @var{@1@}.
 
 @xref{Sign Intrinsic}, for how to explicitly
@@ -298,7 +298,7 @@ DEFDOC (CDLOG, "Natural logarithm (archaic).", ARCHAIC (LOG, Log))
 
 DEFDOC (LOG10, "Common logarithm.", "\
 Returns the common logarithm (base 10) of @var{@1@}, which must
-be greater than zero or.
+be greater than zero.
 
 The inverse of this function is @samp{10. ** LOG10(@var{@1@})}.
 
@@ -646,7 +646,7 @@ magnitude truncated and its sign preserved, converted
 to type @code{INTEGER(KIND=6)}.
 
 If @var{@1@} is type @code{COMPLEX}, its real part
-is truncated and converted, and its imaginary part is disgregarded.
+is truncated and converted, and its imaginary part is disregarded.
 
 @xref{Int Intrinsic}.
 
@@ -661,7 +661,7 @@ magnitude truncated and its sign preserved, converted
 to type @code{INTEGER(KIND=6)}.
 
 If @var{@1@} is type @code{COMPLEX}, its real part
-is truncated and converted, and its imaginary part is disgregarded.
+is truncated and converted, and its imaginary part is disregarded.
 
 @xref{Int Intrinsic}.
 
@@ -676,7 +676,7 @@ magnitude truncated and its sign preserved, converted
 to type @code{INTEGER(KIND=2)}.
 
 If @var{@1@} is type @code{COMPLEX}, its real part
-is truncated and converted, and its imaginary part is disgregarded.
+is truncated and converted, and its imaginary part is disregarded.
 
 @xref{Int Intrinsic}.
 
@@ -1043,9 +1043,9 @@ and returns that string as the function value.
 ")
 
 DEFDOC (CTIME_subr, "Convert time to Day Mon dd hh:mm:ss yyyy.", "\
-Converts @var{@2@}, a system time value, such as returned by
+Converts @var{@1@}, a system time value, such as returned by
 @code{TIME8()}, to a string of the form @samp{Sat Aug 19 18:13:14 1995},
-and returns that string in @var{@1@}.
+and returns that string in @var{@2@}.
 
 @xref{Time8 Intrinsic}.
 
@@ -1096,10 +1096,10 @@ form is not recommended.
 DEFDOC (DTIME_subr, "Get elapsed time since last time.", "\
 Initially, return the number of seconds of runtime
 since the start of the process's execution
-in @var{@1@},
-and the user and system components of this in @samp{@var{@2@}(1)}
-and @samp{@var{@2@}(2)} respectively.
-The value of @var{@1@} is equal to @samp{@var{@2@}(1) + @var{@2@}(2)}.
+in @var{@2@},
+and the user and system components of this in @samp{@var{@1@}(1)}
+and @samp{@var{@1@}(2)} respectively.
+The value of @var{@2@} is equal to @samp{@var{@1@}(1) + @var{@1@}(2)}.
 
 Subsequent invocations of @samp{@0@()} set values based on accumulations
 since the previous invocation.
@@ -1140,10 +1140,10 @@ during a single run of the compiled program.
 DEFDOC (ETIME_subr, "Get elapsed time for process.", "\
 Return the number of seconds of runtime
 since the start of the process's execution
-in @var{@1@},
-and the user and system components of this in @samp{@var{@2@}(1)}
-and @samp{@var{@2@}(2)} respectively.
-The value of @var{@1@} is equal to @samp{@var{@2@}(1) + @var{@2@}(2)}.
+in @var{@2@},
+and the user and system components of this in @samp{@var{@1@}(1)}
+and @samp{@var{@1@}(2)} respectively.
+The value of @var{@2@} is equal to @samp{@var{@1@}(1) + @var{@1@}(2)}.
 
 @cindex wraparound, timings
 @cindex limits, timings
@@ -1288,9 +1288,9 @@ zero if not, and negative if the information isn't available.
 ")
 
 DEFDOC (IDATE_unix, "Get local time info.", "\
-Fills @var{@1@} with the numerical values at the current local time
-of day, month (in the range 1--12), and year in elements 1, 2, and 3,
-respectively.
+Fills @var{@1@} with the numerical values at the current local time.
+The day (in the range 1--31), month (in the range 1--12),
+and year appear in elements 1, 2, and 3 of @var{@1@}, respectively.
 The year has four significant digits.
 
 @cindex Y10K compliance
@@ -1308,19 +1308,20 @@ as of the Year 10000.
 DEFDOC (IDATE_vxt, "Get local time info (VAX/VMS).", "\
 Returns the numerical values of the current local time.
 The month (in the range 1--12) is returned in @var{@1@},
-the day (in the range 1--7) in @var{@2@},
+the day (in the range 1--31) in @var{@2@},
 and the year in @var{@3@} (in the range 0--99).
 
 @cindex Y2K compliance
 @cindex Year 2000 compliance
 @cindex wraparound, Y2K
 @cindex limits, Y2K
-This intrinsic is not recommended, due to the year 2000 approaching.
-Therefore, programs making use of this intrinsic
-might not be Year 2000 (Y2K) compliant.
+This intrinsic is not recommended, due to the fact that
+its return value for year wraps around century boundaries
+(change from a larger value to a smaller one).
+Therefore, programs making use of this intrinsic, for
+instance, might not be Year 2000 (Y2K) compliant.
 For example, the date might appear,
 to such programs, to wrap around
-(change from a larger value to a smaller one)
 as of the Year 2000.
 
 @xref{IDate Intrinsic (UNIX)}, for information on obtaining more digits
@@ -1584,7 +1585,7 @@ almost certainly want to use something better.
 ")
 
 DEFDOC (SRAND, "Random seed.", "\
-Reinitialises the generator with the seed in @var{@1@}.
+Reinitializes the generator with the seed in @var{@1@}.
 @xref{IRand Intrinsic}.
 @xref{Rand Intrinsic}.
 ")
@@ -1617,7 +1618,7 @@ Existence
 DEFDOC (CHDIR_subr, "Change directory.", "\
 Sets the current working directory to be @var{@1@}.
 If the @var{@2@} argument is supplied, it contains 0
-on success or a non-zero error code otherwise upon return.
+on success or a nonzero error code otherwise upon return.
 See @code{chdir(3)}.
 
 @emph{Caution:} Using this routine during I/O to a unit connected with a
@@ -1631,7 +1632,7 @@ only a function, not as a subroutine, or do not support the
 
 DEFDOC (CHDIR_func, "Change directory.", "\
 Sets the current working directory to be @var{@1@}.
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 See @code{chdir(3)}.
 
 @emph{Caution:} Using this routine during I/O to a unit connected with a
@@ -1652,7 +1653,7 @@ trailing blanks in @var{@1@} are ignored.
 Currently, @var{@1@} must not contain the single quote
 character.
 
-Returns 0 on success or a non-zero error code otherwise.
+Returns 0 on success or a nonzero error code otherwise.
 
 Note that this currently works
 by actually invoking @code{/bin/chmod} (or the @code{chmod} found when
@@ -1674,7 +1675,7 @@ Currently, @var{@1@} must not contain the single quote
 character.
 
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 
 Note that this currently works
 by actually invoking @code{/bin/chmod} (or the @code{chmod} found when
@@ -1689,7 +1690,7 @@ only a function, not as a subroutine, or do not support the
 DEFDOC (GETCWD_func, "Get current working directory.", "\
 Places the current working directory in @var{@1@}.
 Returns 0 on
-success, otherwise a non-zero error code
+success, otherwise a nonzero error code
 (@code{ENOSYS} if the system does not provide @code{getcwd(3)}
 or @code{getwd(3)}).
 ")
@@ -1697,7 +1698,7 @@ or @code{getwd(3)}).
 DEFDOC (GETCWD_subr, "Get current working directory.", "\
 Places the current working directory in @var{@1@}.
 If the @var{@2@} argument is supplied, it contains 0
-success or a non-zero error code upon return
+success or a nonzero error code upon return
 (@code{ENOSYS} if the system does not provide @code{getcwd(3)}
 or @code{getwd(3)}).
 
@@ -1715,16 +1716,13 @@ extracted from the @code{stat} structure as returned by
 
 @enumerate
 @item
-File mode
+Device ID
 
 @item
 Inode number
 
 @item
-ID of device containing directory entry for file
-
-@item
-Device id (if relevant)
+File mode
 
 @item
 Number of links
@@ -1736,6 +1734,10 @@ Owner's uid
 Owner's gid
 
 @item
+ID of device containing directory entry for file
+(0 if not available)
+
+@item
 File size (bytes)
 
 @item
@@ -1748,16 +1750,16 @@ Last modification time
 Last file status change time
 
 @item
-Preferred I/O block size
+Preferred I/O block size (-1 if not available)
 
 @item
-Number of blocks allocated
+Number of blocks allocated (-1 if not available)
 @end enumerate
 
 Not all these elements are relevant on all systems.
 If an element is not relevant, it is returned as 0.
 
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 ")
 
 DEFDOC (FSTAT_subr, "Get file information.", "\
@@ -1769,16 +1771,13 @@ extracted from the @code{stat} structure as returned by
 
 @enumerate
 @item
-File mode
+Device ID
 
 @item
 Inode number
 
 @item
-ID of device containing directory entry for file
-
-@item
-Device id (if relevant)
+File mode
 
 @item
 Number of links
@@ -1790,6 +1789,10 @@ Owner's uid
 Owner's gid
 
 @item
+ID of device containing directory entry for file
+(0 if not available)
+
+@item
 File size (bytes)
 
 @item
@@ -1802,17 +1805,17 @@ Last modification time
 Last file status change time
 
 @item
-Preferred I/O block size
+Preferred I/O block size (-1 if not available)
 
 @item
-Number of blocks allocated
+Number of blocks allocated (-1 if not available)
 @end enumerate
 
 Not all these elements are relevant on all systems.
 If an element is not relevant, it is returned as 0.
 
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
 only a function, not as a subroutine, or do not support the
@@ -1833,16 +1836,13 @@ The values in this array are extracted from the
 
 @enumerate
 @item
-File mode
+Device ID
 
 @item
 Inode number
 
 @item
-ID of device containing directory entry for file
-
-@item
-Device id (if relevant)
+File mode
 
 @item
 Number of links
@@ -1854,6 +1854,10 @@ Owner's uid
 Owner's gid
 
 @item
+ID of device containing directory entry for file
+(0 if not available)
+
+@item
 File size (bytes)
 
 @item
@@ -1866,16 +1870,16 @@ Last modification time
 Last file status change time
 
 @item
-Preferred I/O block size
+Preferred I/O block size (-1 if not available)
 
 @item
-Number of blocks allocated
+Number of blocks allocated (-1 if not available)
 @end enumerate
 
 Not all these elements are relevant on all systems.
 If an element is not relevant, it is returned as 0.
 
-Returns 0 on success or a non-zero error code
+Returns 0 on success or a nonzero error code
 (@code{ENOSYS} if the system does not provide @code{lstat(2)}).
 ")
 
@@ -1893,16 +1897,13 @@ The values in this array are extracted from the
 
 @enumerate
 @item
-File mode
+Device ID
 
 @item
 Inode number
 
 @item
-ID of device containing directory entry for file
-
-@item
-Device id (if relevant)
+File mode
 
 @item
 Number of links
@@ -1914,6 +1915,10 @@ Owner's uid
 Owner's gid
 
 @item
+ID of device containing directory entry for file
+(0 if not available)
+
+@item
 File size (bytes)
 
 @item
@@ -1926,17 +1931,17 @@ Last modification time
 Last file status change time
 
 @item
-Preferred I/O block size
+Preferred I/O block size (-1 if not available)
 
 @item
-Number of blocks allocated
+Number of blocks allocated (-1 if not available)
 @end enumerate
 
 Not all these elements are relevant on all systems.
 If an element is not relevant, it is returned as 0.
 
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return
+0 on success or a nonzero error code upon return
 (@code{ENOSYS} if the system does not provide @code{lstat(2)}).
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -1955,16 +1960,13 @@ The values in this array are extracted from the
 
 @enumerate
 @item
-File mode
+Device ID
 
 @item
 Inode number
 
 @item
-ID of device containing directory entry for file
-
-@item
-Device id (if relevant)
+File mode
 
 @item
 Number of links
@@ -1976,6 +1978,10 @@ Owner's uid
 Owner's gid
 
 @item
+ID of device containing directory entry for file
+(0 if not available)
+
+@item
 File size (bytes)
 
 @item
@@ -1988,16 +1994,16 @@ Last modification time
 Last file status change time
 
 @item
-Preferred I/O block size
+Preferred I/O block size (-1 if not available)
 
 @item
-Number of blocks allocated
+Number of blocks allocated (-1 if not available)
 @end enumerate
 
 Not all these elements are relevant on all systems.
 If an element is not relevant, it is returned as 0.
 
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 ")
 
 DEFDOC (STAT_subr, "Get file information.", "\
@@ -2011,16 +2017,13 @@ The values in this array are extracted from the
 
 @enumerate
 @item
-File mode
+Device ID
 
 @item
 Inode number
 
 @item
-ID of device containing directory entry for file
-
-@item
-Device id (if relevant)
+File mode
 
 @item
 Number of links
@@ -2032,6 +2035,10 @@ Owner's uid
 Owner's gid
 
 @item
+ID of device containing directory entry for file
+(0 if not available)
+
+@item
 File size (bytes)
 
 @item
@@ -2044,17 +2051,17 @@ Last modification time
 Last file status change time
 
 @item
-Preferred I/O block size
+Preferred I/O block size (-1 if not available)
 
 @item
-Number of blocks allocated
+Number of blocks allocated (-1 if not available)
 @end enumerate
 
 Not all these elements are relevant on all systems.
 If an element is not relevant, it is returned as 0.
 
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
 only a function, not as a subroutine, or do not support the
@@ -2067,7 +2074,7 @@ A null character (@samp{CHAR(0)}) marks the end of
 the names in @var{@1@} and @var{@2@}---otherwise,
 trailing blanks in @var{@1@} and @var{@2@} are ignored.
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 See @code{link(2)}.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -2080,7 +2087,7 @@ Makes a (hard) link from file @var{@1@} to @var{@2@}.
 A null character (@samp{CHAR(0)}) marks the end of
 the names in @var{@1@} and @var{@2@}---otherwise,
 trailing blanks in @var{@1@} and @var{@2@} are ignored.
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 See @code{link(2)}.
 
 Due to the side effects performed by this intrinsic, the function
@@ -2093,7 +2100,7 @@ A null character (@samp{CHAR(0)}) marks the end of
 the names in @var{@1@} and @var{@2@}---otherwise,
 trailing blanks in @var{@1@} and @var{@2@} are ignored.
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return
+0 on success or a nonzero error code upon return
 (@code{ENOSYS} if the system does not provide @code{symlink(2)}).
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -2106,7 +2113,7 @@ Makes a symbolic link from file @var{@1@} to @var{@2@}.
 A null character (@samp{CHAR(0)}) marks the end of
 the names in @var{@1@} and @var{@2@}---otherwise,
 trailing blanks in @var{@1@} and @var{@2@} are ignored.
-Returns 0 on success or a non-zero error code
+Returns 0 on success or a nonzero error code
 (@code{ENOSYS} if the system does not provide @code{symlink(2)}).
 
 Due to the side effects performed by this intrinsic, the function
@@ -2120,7 +2127,7 @@ the names in @var{@1@} and @var{@2@}---otherwise,
 trailing blanks in @var{@1@} and @var{@2@} are ignored.
 See @code{rename(2)}.
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
 only a function, not as a subroutine, or do not support the
@@ -2133,7 +2140,7 @@ A null character (@samp{CHAR(0)}) marks the end of
 the names in @var{@1@} and @var{@2@}---otherwise,
 trailing blanks in @var{@1@} and @var{@2@} are ignored.
 See @code{rename(2)}.
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 
 Due to the side effects performed by this intrinsic, the function
 form is not recommended.
@@ -2162,7 +2169,7 @@ A null character (@samp{CHAR(0)}) marks the end of
 the name in @var{@1@}---otherwise,
 trailing blanks in @var{@1@} are ignored.
 If the @var{@2@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 See @code{unlink(2)}.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -2175,7 +2182,7 @@ Unlink the file @var{@1@}.
 A null character (@samp{CHAR(0)}) marks the end of
 the name in @var{@1@}---otherwise,
 trailing blanks in @var{@1@} are ignored.
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 See @code{unlink(2)}.
 
 Due to the side effects performed by this intrinsic, the function
@@ -2232,7 +2239,7 @@ in @var{@1@}.
 
 DEFDOC (HOSTNM_func, "Get host name.", "\
 Fills @var{@1@} with the system's host name returned by
-@code{gethostname(2)}, returning 0 on success or a non-zero error code
+@code{gethostname(2)}, returning 0 on success or a nonzero error code
 (@code{ENOSYS} if the system does not provide @code{gethostname(2)}).
 
 On some systems (specifically SCO) it might be necessary to link the
@@ -2245,7 +2252,7 @@ DEFDOC (HOSTNM_subr, "Get host name.", "\
 Fills @var{@1@} with the system's host name returned by
 @code{gethostname(2)}.
 If the @var{@2@} argument is supplied, it contains
-0 on success or a non-zero error code upon return
+0 on success or a nonzero error code upon return
 (@code{ENOSYS} if the system does not provide @code{gethostname(2)}).
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -2375,8 +2382,8 @@ terminal.
 ")
 
 DEFDOC (TTYNAM_subr, "Get name of terminal device for unit.", "\
-Sets @var{@1@} to the name of the terminal device open on logical unit
-@var{@2@} or a blank string if @var{@2@} is not connected to a
+Sets @var{@2@} to the name of the terminal device open on logical unit
+@var{@1@} or to a blank string if @var{@1@} is not connected to a
 terminal.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -2507,7 +2514,7 @@ allowing you to take appropriate action.
 
 DEFDOC (KILL_func, "Signal a process.", "\
 Sends the signal specified by @var{@2@} to the process @var{@1@}.
-Returns 0 on success or a non-zero error code.
+Returns 0 on success or a nonzero error code.
 See @code{kill(2)}.
 
 Due to the side effects performed by this intrinsic, the function
@@ -2517,7 +2524,7 @@ form is not recommended.
 DEFDOC (KILL_subr, "Signal a process.", "\
 Sends the signal specified by @var{@2@} to the process @var{@1@}.
 If the @var{@3@} argument is supplied, it contains
-0 on success or a non-zero error code upon return.
+0 on success or a nonzero error code upon return.
 See @code{kill(2)}.
 
 Some non-GNU implementations of Fortran provide this intrinsic as
@@ -2584,18 +2591,18 @@ to such programs, to wrap around
 (change from a larger value to a smaller one)
 as of the Year 10000.
 
-@xref{FDate Intrinsic (subroutine)} for an equivalent routine.
+@xref{FDate Intrinsic (subroutine)}, for an equivalent routine.
 ")
 
 DEFDOC (IBCLR, "Clear a bit.", "\
 Returns the value of @var{@1@} with bit @var{@2@} cleared (set to
 zero).
-@xref{BTest Intrinsic} for information on bit positions.
+@xref{BTest Intrinsic}, for information on bit positions.
 ")
 
 DEFDOC (IBSET, "Set a bit.", "\
 Returns the value of @var{@1@} with bit @var{@2@} set (to one).
-@xref{BTest Intrinsic} for information on bit positions.
+@xref{BTest Intrinsic}, for information on bit positions.
 ")
 
 DEFDOC (IBITS, "Extract a bit subfield of a variable.", "\
@@ -2677,7 +2684,8 @@ The difference between local time and UTC (GMT) in the form @var{Shhmm}:
 sign, hours and minutes, e.g.@: @samp{-0500} (winter in New York);
 @item @4@
 The year, month of the year, day of the month, time difference in
-minutes from UTC, hour of the day, minutes of the hour and milliseconds
+minutes from UTC, hour of the day, minutes of the hour, seconds
+of the minute, and milliseconds
 of the second in successive values of the array.
 @end table