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 February 18, 2013
  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 Note that these defaults may be altered using the
  87 .Xr stdbuf 1
  88 utility.
  89 .Pp
  90 The
  91 .Fn setvbuf
  92 function
  93 may be used to alter the buffering behavior of a stream.
  94 The
  95 .Fa mode
  96 argument must be one of the following three macros:
  97 .Bl -tag -width _IOFBF -offset indent
  98 .It Dv _IONBF
  99 unbuffered
 100 .It Dv _IOLBF
 101 line buffered
 102 .It Dv _IOFBF
 103 fully buffered
 104 .El
 105 .Pp
 106 The
 107 .Fa size
 108 argument may be given as zero
 109 to obtain deferred optimal-size buffer allocation as usual.
 110 If it is not zero,
 111 then except for unbuffered files, the
 112 .Fa buf
 113 argument should point to a buffer at least
 114 .Fa size
 115 bytes long;
 116 this buffer will be used instead of the current buffer.
 117 If
 118 .Fa buf
 119 is not
 120 .Dv NULL ,
 121 it is the caller's responsibility to
 122 .Xr free 3
 123 this buffer after closing the stream.
 124 (If the
 125 .Fa size
 126 argument
 127 is not zero but
 128 .Fa buf
 129 is
 130 .Dv NULL ,
 131 a buffer of the given size will be allocated immediately,
 132 and released on close.
 133 This is an extension to ANSI C;
 134 portable code should use a size of 0 with any
 135 .Dv NULL
 136 buffer.)
 137 .Pp
 138 The
 139 .Fn setvbuf
 140 function may be used at any time,
 141 but may have peculiar side effects
 142 (such as discarding input or flushing output)
 143 if the stream is ``active''.
 144 Portable applications should call it only once on any given stream,
 145 and before any
 146 .Tn I/O
 147 is performed.
 148 .Pp
 149 The other three calls are, in effect, simply aliases for calls to
 150 .Fn setvbuf .
 151 Except for the lack of a return value, the
 152 .Fn setbuf
 153 function is exactly equivalent to the call
 154 .Pp
 155 .Dl "setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);"
 156 .Pp
 157 The
 158 .Fn setbuffer
 159 function
 160 is the same, except that the size of the buffer is up to the caller,
 161 rather than being determined by the default
 162 .Dv BUFSIZ .
 163 The
 164 .Fn setlinebuf
 165 function
 166 is exactly equivalent to the call:
 167 .Pp
 168 .Dl "setvbuf(stream, (char *)NULL, _IOLBF, 0);"
 169 .Sh RETURN VALUES
 170 The
 171 .Fn setvbuf
 172 function returns 0 on success, or
 173 .Dv EOF
 174 if the request cannot be honored
 175 (note that the stream is still functional in this case).
 176 .Pp
 177 The
 178 .Fn setlinebuf
 179 function returns what the equivalent
 180 .Fn setvbuf
 181 would have returned.
 182 .Sh SEE ALSO
 183 .Xr stdbuf 1 ,
 184 .Xr fclose 3 ,
 185 .Xr fopen 3 ,
 186 .Xr fread 3 ,
 187 .Xr malloc 3 ,
 188 .Xr printf 3 ,
 189 .Xr puts 3
 190 .Sh STANDARDS
 191 The
 192 .Fn setbuf
 193 and
 194 .Fn setvbuf
 195 functions
 196 conform to
 197 .St -isoC .
 198 .Sh BUGS
 199 .Fn setbuf
 200 usually uses a suboptimal buffer size and should be avoided.