lib/libc/stdio/setbuf.3

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)setbuf.3    8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt SETBUF 3
  37 .Os
  38 .Sh NAME
  39 .Nm setbuf ,
  40 .Nm setbuffer ,
  41 .Nm setlinebuf ,
  42 .Nm setvbuf
  43 .Nd stream buffering operations
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In stdio.h
  48 .Ft void
  49 .Fn setbuf "FILE * restrict stream" "char * restrict buf"
  50 .Ft void
  51 .Fn setbuffer "FILE *stream" "char *buf" "int size"
  52 .Ft int
  53 .Fn setlinebuf "FILE *stream"
  54 .Ft int
  55 .Fn setvbuf "FILE * restrict stream" "char * restrict buf" "int mode" "size_t size"
  56 .Sh DESCRIPTION
  57 The three types of buffering available are unbuffered, block buffered,
  58 and line buffered.
  59 When an output stream is unbuffered, information appears on the
  60 destination file or terminal as soon as written;
  61 when it is block buffered many characters are saved up and written as a block;
  62 when it is line buffered characters are saved up until a newline is
  63 output or input is read from any stream attached to a terminal device
  64 (typically
  65 .Dv stdin ) .
  66 The function
  67 .Xr fflush 3
  68 may be used to force the block out early.
  69 (See
  70 .Xr fclose 3 . )
  71 .Pp
  72 Normally all files are block buffered.
  73 When the first
  74 .Tn I/O
  75 operation occurs on a file,
  76 .Xr malloc 3
  77 is called,
  78 and an optimally-sized buffer is obtained.
  79 If a stream refers to a terminal
  80 (as
  81 .Dv stdout
  82 normally does) it is line buffered.
  83 The standard error stream
  84 .Dv stderr
  85 is always unbuffered.
  86 .Pp
  87 The
  88 .Fn setvbuf
  89 function
  90 may be used to alter the buffering behavior of a stream.
  91 The
  92 .Fa mode
  93 argument must be one of the following three macros:
  94 .Bl -tag -width _IOFBF -offset indent
  95 .It Dv _IONBF
  96 unbuffered
  97 .It Dv _IOLBF
  98 line buffered
  99 .It Dv _IOFBF
 100 fully buffered
 101 .El
 102 .Pp
 103 The
 104 .Fa size
 105 argument may be given as zero
 106 to obtain deferred optimal-size buffer allocation as usual.
 107 If it is not zero,
 108 then except for unbuffered files, the
 109 .Fa buf
 110 argument should point to a buffer at least
 111 .Fa size
 112 bytes long;
 113 this buffer will be used instead of the current buffer.
 114 If
 115 .Fa buf
 116 is not
 117 .Dv NULL ,
 118 it is the caller's responsibility to
 119 .Xr free 3
 120 this buffer after closing the stream.
 121 (If the
 122 .Fa size
 123 argument
 124 is not zero but
 125 .Fa buf
 126 is
 127 .Dv NULL ,
 128 a buffer of the given size will be allocated immediately,
 129 and released on close.
 130 This is an extension to ANSI C;
 131 portable code should use a size of 0 with any
 132 .Dv NULL
 133 buffer.)
 134 .Pp
 135 The
 136 .Fn setvbuf
 137 function may be used at any time,
 138 but may have peculiar side effects
 139 (such as discarding input or flushing output)
 140 if the stream is ``active''.
 141 Portable applications should call it only once on any given stream,
 142 and before any
 143 .Tn I/O
 144 is performed.
 145 .Pp
 146 The other three calls are, in effect, simply aliases for calls to
 147 .Fn setvbuf .
 148 Except for the lack of a return value, the
 149 .Fn setbuf
 150 function is exactly equivalent to the call
 151 .Pp
 152 .Dl "setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);"
 153 .Pp
 154 The
 155 .Fn setbuffer
 156 function
 157 is the same, except that the size of the buffer is up to the caller,
 158 rather than being determined by the default
 159 .Dv BUFSIZ .
 160 The
 161 .Fn setlinebuf
 162 function
 163 is exactly equivalent to the call:
 164 .Pp
 165 .Dl "setvbuf(stream, (char *)NULL, _IOLBF, 0);"
 166 .Sh RETURN VALUES
 167 The
 168 .Fn setvbuf
 169 function returns 0 on success, or
 170 .Dv EOF
 171 if the request cannot be honored
 172 (note that the stream is still functional in this case).
 173 .Pp
 174 The
 175 .Fn setlinebuf
 176 function returns what the equivalent
 177 .Fn setvbuf
 178 would have returned.
 179 .Sh SEE ALSO
 180 .Xr fclose 3 ,
 181 .Xr fopen 3 ,
 182 .Xr fread 3 ,
 183 .Xr malloc 3 ,
 184 .Xr printf 3 ,
 185 .Xr puts 3
 186 .Sh STANDARDS
 187 The
 188 .Fn setbuf
 189 and
 190 .Fn setvbuf
 191 functions
 192 conform to
 193 .St -isoC .
 194 .Sh BUGS
 195 The
 196 .Fn setbuffer
 197 and
 198 .Fn setlinebuf
 199 functions are not portable to versions of
 200 .Bx
 201 before
 202 .Bx 4.2 .
 203 On
 204 .Bx 4.2
 205 and
 206 .Bx 4.3
 207 systems,
 208 .Fn setbuf
 209 always uses a suboptimal buffer size and should be avoided.