]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man3/fcloseall.3
fanotify_init.2, fanotify.7: Document FAN_REPORT_TID
[thirdparty/man-pages.git] / man3 / fcloseall.3
index 70594f01d010db948fbeadb1f7301be7d16a60e6..966e4efb4923d1184bde7e40f377f3bb61b33efa 100644 (file)
@@ -1,70 +1,78 @@
-.\" Copyright (c) 1990, 1991 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 2006 by Michael Kerrisk <mtk.manpages@gmail.com>
 .\"
-.\" This code is derived from software contributed to Berkeley by
-.\" Chris Torek and the American National Standards Committee X3,
-.\" on Information Processing Systems.
+.\" %%%LICENSE_START(VERBATIM)
+.\" Permission is granted to make and distribute verbatim copies of this
+.\" manual provided the copyright notice and this permission notice are
+.\" preserved on all copies.
 .\"
-.\" 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.
+.\" Permission is granted to copy and distribute modified versions of this
+.\" manual under the conditions for verbatim copying, provided that the
+.\" entire resulting derived work is distributed under the terms of a
+.\" permission notice identical to this one.
 .\"
-.\" 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.
+.\" Since the Linux kernel and libraries are constantly changing, this
+.\" manual page may be incorrect or out-of-date.  The author(s) assume no
+.\" responsibility for errors or omissions, or for damages resulting from
+.\" the use of the information contained herein.  The author(s) may not
+.\" have taken the same level of care in the production of this manual,
+.\" which is licensed free of charge, as they might when working
+.\" professionally.
 .\"
-.\"     @(#)fclose.3   6.7 (Berkeley) 6/29/91
+.\" Formatted or processed versions of this manual, if unaccompanied by
+.\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
-.\" Converted for Linux, Mon Nov 29 15:19:14 1993, faith@cs.unc.edu
-.\" Modified to be fcloseall(3) by Nicolás Lichtmaier <nick@debian.org> Fri Apr 10 1998
-.\"
-.TH FCLOSE 3  1998-04-10 "GNU" "Linux Programmer's Manual"
+.TH FCLOSEALL 3  2017-09-15 "GNU" "Linux Programmer's Manual"
 .SH NAME
 fcloseall \- close all open streams
 .SH SYNOPSIS
-.B #define _GNU_SOURCE
-.sp
+.nf
+.BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
 .B #include <stdio.h>
-.sp
+.PP
 .B int fcloseall(void);
+.fi
 .SH DESCRIPTION
 The
 .BR fcloseall ()
-function dissociates all open streams
-from its underlying file or set of functions.  Any buffered output data is
-written first, using
-.BR fflush (3).
-Note that the standard streams (stdin, stdout
-and stderr) are also closed.
-.SH "RETURN VALUE"
-This function always returns 0.
-.SH "SEE ALSO"
+function closes all of the calling process's open streams.
+Buffered output for each stream is written before it is closed
+(as for
+.BR fflush (3));
+buffered input is discarded.
+.PP
+The standard streams,
+.IR stdin ,
+.IR stdout ,
+and
+.I stderr
+are also closed.
+.SH RETURN VALUE
+This function returns 0 if all files were successfully closed;
+on error,
+.B EOF
+is returned.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lb lb lb
+l l l.
+Interface      Attribute       Value
+T{
+.BR fcloseall ()
+T}     Thread safety   MT-Unsafe race:streams
+.TE
+.PP
+The
+.BR fcloseall ()
+function does not lock the streams, so it is not thread-safe.
+.SH CONFORMING TO
+This function is a GNU extension.
+.SH SEE ALSO
 .BR close (2),
 .BR fclose (3),
 .BR fflush (3),
 .BR fopen (3),
 .BR setbuf (3)
-.SH "CONFORMING TO"
-The
-.BR fcloseall ()
-function is a GNU extension.