summaryrefslogtreecommitdiff
path: root/man3p/setbuf.3p
diff options
context:
space:
mode:
authorMichael Kerrisk <mtk.manpages@gmail.com>2004-11-03 13:51:07 +0000
committerMichael Kerrisk <mtk.manpages@gmail.com>2004-11-03 13:51:07 +0000
commitfea681dafb1363a154b7fc6d59baa83d2a9ebc5c (patch)
tree8ea275c0f242af739617d0afc3e1b16c4eff3dc2 /man3p/setbuf.3p
Import of man-pages 1.70
Diffstat (limited to 'man3p/setbuf.3p')
-rw-r--r--man3p/setbuf.3p86
1 files changed, 86 insertions, 0 deletions
diff --git a/man3p/setbuf.3p b/man3p/setbuf.3p
new file mode 100644
index 00000000..00facf32
--- /dev/null
+++ b/man3p/setbuf.3p
@@ -0,0 +1,86 @@
+.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
+.TH "SETBUF" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\" setbuf
+.SH NAME
+setbuf \- assign buffering to a stream
+.SH SYNOPSIS
+.LP
+\fB#include <stdio.h>
+.br
+.sp
+void setbuf(FILE *restrict\fP \fIstream\fP\fB, char *restrict\fP \fIbuf\fP\fB);
+.br
+\fP
+.SH DESCRIPTION
+.LP
+Except that it returns no value, the function call:
+.sp
+.RS
+.nf
+
+\fBsetbuf(stream, buf)
+\fP
+.fi
+.RE
+.LP
+shall be equivalent to:
+.sp
+.RS
+.nf
+
+\fBsetvbuf(stream, buf, _IOFBF, BUFSIZ)
+\fP
+.fi
+.RE
+.LP
+if \fIbuf\fP is not a null pointer, or to:
+.sp
+.RS
+.nf
+
+\fBsetvbuf(stream, buf, _IONBF, BUFSIZ)
+\fP
+.fi
+.RE
+.LP
+if \fIbuf\fP is a null pointer.
+.SH RETURN VALUE
+.LP
+The \fIsetbuf\fP() function shall not return a value.
+.SH ERRORS
+.LP
+No errors are defined.
+.LP
+\fIThe following sections are informative.\fP
+.SH EXAMPLES
+.LP
+None.
+.SH APPLICATION USAGE
+.LP
+A common source of error is allocating buffer space as an "automatic"
+variable in a code block, and then failing to close the
+stream in the same block.
+.LP
+With \fIsetbuf\fP(), allocating a buffer of BUFSIZ bytes does not
+necessarily imply that all of BUFSIZ bytes are used for the
+buffer area.
+.SH RATIONALE
+.LP
+None.
+.SH FUTURE DIRECTIONS
+.LP
+None.
+.SH SEE ALSO
+.LP
+\fIfopen\fP() , \fIsetvbuf\fP() , the Base Definitions volume of
+IEEE\ Std\ 1003.1-2001, \fI<stdio.h>\fP
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group. In the
+event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .