diff options
| -rw-r--r-- | Makefile | 1 | ||||
| -rw-r--r-- | gzbuffer.3 | 45 |
2 files changed, 46 insertions, 0 deletions
diff --git a/Makefile b/Makefile index 9a75d20..02dee6a 100644 --- a/Makefile +++ b/Makefile @@ -18,6 +18,7 @@ MAN += deflateReset.3 MAN += deflateSetDictionary.3 MAN += deflateSetHeader.3 MAN += deflateTune.3 +MAN += gzbuffer.3 MAN += gzopen.3 MAN += inflate.3 MAN += inflateBack.3 diff --git a/gzbuffer.3 b/gzbuffer.3 new file mode 100644 index 0000000..a97e317 --- /dev/null +++ b/gzbuffer.3 @@ -0,0 +1,45 @@ +.Dd November 12, 2018 +.Dt GZBUFFER 3 +.Os +. +.Sh NAME +.Nm gzbuffer +.Nd set buffer size +. +.Sh LIBRARY +.Lb libz +. +.Sh SYNOPSIS +.In zlib.h +.Ft int +.Fn gzbuffer "gzFile file" "unsigned size" +. +.Sh DESCRIPTION +Set the internal buffer size +used by this library's functions. +The default buffer size is 8192 bytes. +This function must be called after +.Xr gzopen 3 +or +.Xr gzdopen 3 , +and before any other calls +that read or write the file. +The buffer memory allocation +is always deferred to the first read or write. +Three times that size in buffer space is allocated. +A larger buffer size of, +for example, +64K or 128K bytes +will noticeably increase the speed +of decompression (reading). +. +.Pp +The new buffer size also affects +the maximum length for +.Xr gzprintf 3 . +. +.Sh RETURN VALUES +.Fn gzbuffer +returns 0 on success, +or -1 on failure, +such as being called too late. |