summaryrefslogtreecommitdiff
path: root/static/openbsd/man3/setbuf.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
commita9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch)
tree9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man3/setbuf.3
parent160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff)
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man3/setbuf.3')
-rw-r--r--static/openbsd/man3/setbuf.3140
1 files changed, 140 insertions, 0 deletions
diff --git a/static/openbsd/man3/setbuf.3 b/static/openbsd/man3/setbuf.3
new file mode 100644
index 00000000..8dd17aca
--- /dev/null
+++ b/static/openbsd/man3/setbuf.3
@@ -0,0 +1,140 @@
+.\" $OpenBSD: setbuf.3,v 1.16 2014/11/25 19:08:14 millert Exp $
+.\"
+.\" Copyright (c) 1980, 1991, 1993
+.\" The Regents of the University of California. All rights reserved.
+.\"
+.\" This code is derived from software contributed to Berkeley by
+.\" 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. 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.
+.\"
+.Dd $Mdocdate: November 25 2014 $
+.Dt SETBUF 3
+.Os
+.Sh NAME
+.Nm setbuf ,
+.Nm setbuffer ,
+.Nm setlinebuf
+.Nd stream buffering operations
+.Sh SYNOPSIS
+.In stdio.h
+.Ft void
+.Fn setbuf "FILE *stream" "char *buf"
+.Ft void
+.Fn setbuffer "FILE *stream" "char *buf" "size_t size"
+.Ft int
+.Fn setlinebuf "FILE *stream"
+.Sh DESCRIPTION
+.Bf -symbolic
+These interfaces are obsoleted by
+.Xr setvbuf 3 .
+.Ef
+.Pp
+The
+.Fn setbuf ,
+.Fn setbuffer ,
+and
+.Fn setlinebuf
+functions are used to modify the buffering of a stream.
+These functions are provided for compatibility with legacy code.
+New code should use
+.Xr setvbuf 3
+instead.
+.Pp
+Except for the lack of a return value, the
+.Fn setbuf
+function is exactly equivalent to the call
+.Pp
+.Dl "setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);"
+.Pp
+The
+.Fn setbuffer
+function is the same, except that the size of the buffer is up to the caller,
+rather than being determined by the default
+.Dv BUFSIZ .
+.Pp
+The
+.Fn setlinebuf
+function is exactly equivalent to the call:
+.Pp
+.Dl "setvbuf(stream, NULL, _IOLBF, 0);"
+.Sh RETURN VALUES
+Upon successful completion, the
+.Fn setlinebuf
+function returns 0.
+If the request cannot be honored, a non-zero value is returned,
+possibly setting
+.Va errno
+to indicate the error.
+The stream is not modified in the error case.
+.Sh ERRORS
+The
+.Fn setbuf ,
+.Fn setbuffer ,
+and
+.Fn setlinebuf
+functions will fail if:
+.Bl -tag -width Er
+.It Bq Er EBADF
+The
+.Fa stream
+specified is not associated with a valid file descriptor.
+.El
+.Sh SEE ALSO
+.Xr fclose 3 ,
+.Xr fopen 3 ,
+.Xr fread 3 ,
+.Xr malloc 3 ,
+.Xr printf 3 ,
+.Xr puts 3 ,
+.Xr setvbuf 3
+.Sh STANDARDS
+The
+.Fn setbuf
+function conforms to
+.St -isoC-99 .
+The
+.Fn setbuffer
+and
+.Fn setlinebuf
+functions are non-standard and should not be used if portability is required.
+.Sh HISTORY
+The
+.Fn setbuf
+function first appeared in
+.At v7 .
+The
+.Fn setbuffer
+function first appeared in
+.Bx 4.1c .
+The
+.Fn setlinebuf
+function first appeared in
+.Bx 4.2 .
+.Sh BUGS
+The
+.Fn setbuf
+function usually uses a suboptimal buffer size and should be avoided.