BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / stdio / fflush.3

diff --git a/usr/src/lib/libc/stdio/fflush.3 b/usr/src/lib/libc/stdio/fflush.3
index eba10ce..3107cd7 100644 (file)
--- a/usr/src/lib/libc/stdio/fflush.3
+++ b/usr/src/lib/libc/stdio/fflush.3
@@ -1,75 +1,110 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by
 .\" All rights reserved.
 .\"
 .\" This code is derived from software contributed to Berkeley by

-.\" Chris Torek.
+.\" Chris Torek and the American National Standards Committee X3,
+.\" on Information Processing Systems.

 .\"
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)fflush.3    5.1 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH FFLUSH 3 ""
-.UC 7
-.SH NAME
-fflush, fpurge \- flush a stream
-.SH SYNOPSIS
-.nf
-.ft B
-#include <stdio.h>
-
-int
-fflush(FILE *stream);
-
-int
-fpurge(FILE *stream);
-.ft R
-.fi
-.SH DESCRIPTION
-.I Fflush
-writes any buffered data for the given output
-.I stream
+.\"     @(#)fflush.3   5.4 (Berkeley) 6/29/91
+.\"
+.Dd June 29, 1991
+.Dt FFLUSH 3
+.Os
+.Sh NAME
+.Nm fflush ,
+.Nm fpurge
+.Nd flush a stream
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft int
+.Fn fflush "FILE *stream"
+.Ft int
+.Fn fpurge "FILE *stream"
+.Sh DESCRIPTION
+The function
+.Fn fflush
+forces a write of all buffered data for the given output or update
+.Fa stream

 via the stream's underlying write function.
 via the stream's underlying write function.

-The stream remains open.
-.PP
+The open status of the stream is unaffected.
+.Pp

 If the
 If the

-.I stream
-argument is NULL,
-.I fflush
+.Fa stream
+argument is
+.Dv NULL ,
+.Fn fflush

 flushes
 flushes

-.I all
+.Em all

 open output streams.
 open output streams.

-.PP
-.I Fpurge
+.Pp
+The function
+.Fn fpurge

 erases any input or output buffered in the given
 erases any input or output buffered in the given

-.IR stream .
+.Fa stream .

 For output streams this discards any unwritten output.
 For input streams this discards any input read from the underlying object
 but not yet obtained via
 For output streams this discards any unwritten output.
 For input streams this discards any input read from the underlying object
 but not yet obtained via

-.IR getc ;
+.Xr getc 3 ;

 this includes any text pushed back via
 this includes any text pushed back via

-.IR ungetc .
-.SH "RETURN VALUE"
+.Xr ungetc .
+.Sh RETURN VALUES

 Upon successful completion 0 is returned.
 Otherwise,
 Upon successful completion 0 is returned.
 Otherwise,

-.B EOF
+.Dv EOF

 is returned and the global variable
 is returned and the global variable

-.I errno
+.Va errno

 is set to indicate the error.
 is set to indicate the error.

-.SH ERRORS
-.TP 15
-[EBADF]
-.I Stream
+.Sh ERRORS
+.Bl -tag -width [EBADF]
+.It Bq Er EBADF
+.Fa Stream

 is not an open stream, or, in the case of
 is not an open stream, or, in the case of

-.IR fflush ,
+.Fn fflush ,

 not a stream open for writing.
 not a stream open for writing.

-.PP
-.I Fflush
+.El
+.Pp
+The function
+.Fn fflush

 may also fail and set
 may also fail and set

-.I errno
+.Va errno

 for any of the errors specified for the routine
 for any of the errors specified for the routine

-.IR write (2).
-.SH "SEE ALSO"
-write(2), fopen(3), fclose(3), setbuf(3)
-.SH STANDARDS
-.I Fflush
-conforms to ANSI X3.159-1989 (``ANSI C'').
+.Xr write 2 .
+.Sh SEE ALSO
+.Xr write 2 ,
+.Xr fopen 3 ,
+.Xr fclose 3 ,
+.Xr setbuf 3
+.Sh STANDARDS
+The
+.Fn fflush
+function
+conforms to
+.St -ansiC .