summaryrefslogtreecommitdiffstats
path: root/man3/fflush.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/fflush.3')
-rw-r--r--man3/fflush.3107
1 files changed, 107 insertions, 0 deletions
diff --git a/man3/fflush.3 b/man3/fflush.3
new file mode 100644
index 000000000..dfb94ae8b
--- /dev/null
+++ b/man3/fflush.3
@@ -0,0 +1,107 @@
+.\" Copyright (c) 1990, 1991 The Regents of the University of California.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" Chris Torek and the American National Standards Committee X3,
+.\" on Information Processing Systems.
+.\"
+.\" 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.
+.\"
+.\" 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.
+.\"
+.\" @(#)fflush.3 5.4 (Berkeley) 6/29/91
+.\"
+.\" Converted for Linux, Mon Nov 29 15:22:01 1993, faith@cs.unc.edu
+.\"
+.\" Modified 2000-07-22 by Nicolás Lichtmaier <nick@debian.org>
+.\" Modified 2001-10-16 by John Levon <moz@compsoc.man.ac.uk>
+.\"
+.TH FFLUSH 3 1993-11-29 "BSD MANPAGE" "Linux Programmer's Manual"
+.SH NAME
+fflush \- flush a stream
+.SH SYNOPSIS
+.B #include <stdio.h>
+.sp
+.BI "int fflush(FILE *" stream );
+.SH DESCRIPTION
+The function
+.B fflush
+forces a write of all user-space buffered data for the given output or update
+.I stream
+via the stream's underlying write function. The open status of the stream
+is unaffected.
+.PP
+If the
+.I stream
+argument is
+.BR NULL ,
+.B fflush
+flushes
+.I all
+open output streams.
+.PP
+For a non-locking counterpart, see
+.BR unlocked_stdio (3).
+.SH "RETURN VALUE"
+Upon successful completion 0 is returned. Otherwise,
+.B EOF
+is returned and the global variable
+.I errno
+is set to indicate the error.
+.SH ERRORS
+.TP
+.B EBADF
+.I Stream
+is not an open stream, or is not open for writing.
+.PP
+The function
+.B fflush
+may also fail and set
+.I errno
+for any of the errors specified for the routine
+.BR write (2).
+.SH NOTES
+Note that
+.B fflush()
+only flushes the user space buffers provided by the C library.
+To ensure that the data is physically stored on disk
+the kernel buffers must be flushed too, e.g. with
+.BR sync (2)
+or
+.BR fsync (2).
+.SH "CONFORMING TO"
+The function
+.BR fflush()
+conforms to ANSI X3.159-1989 (``ANSI C'').
+.SH "SEE ALSO"
+.BR fsync (2),
+.BR sync (2),
+.BR write (2),
+.BR fclose (3),
+.BR fopen (3),
+.BR setbuf (3),
+.BR unlocked_stdio (3)