summary refs log tree commit diff
path: root/doc/zlib/gzbuffer.3
blob: 92438c488a6f34fc3f3c7a6c70115274ba9718d5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.Dd January 15, 2017
.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.
.
.Sh SEE ALSO
.Xr gzopen 3 ,
.Xr gzprintf 3
.
.Sh HISTORY
This manual page was converted from
.In zlib.h
to mdoc format by
.An June McEnroe Aq Mt june@causal.agency .
.
.Sh AUTHORS
.An Jean-loup Gailly Aq Mt jloup@gzip.org
.An Mark Adler Aq Mt madler@alumni.caltech.edu
r>2018-02-06Add tags targetJune McEnroe 2018-02-06Replace gfxx SCALE macro with interp functionJune McEnroe 2018-02-05Rename gfxx space indexed and add palette samplingJune McEnroe 2018-02-05Take scale into account for when to stop drawing in gfxxJune McEnroe 2018-02-05Always skip most significant bits in gfxxJune McEnroe 2018-02-05Set title in gfcocoaJune McEnroe 2018-02-05Double-buffer gfb frontendJune McEnroe 2018-02-05Rewrite gfxx bit handlingJune McEnroe 2018-02-05Add flip option to gfxxJune McEnroe 2018-02-05Remove gfxx reverse optionJune McEnroe 2018-02-04Fix gfxx draw stop conditionJune McEnroe 2018-02-04Reuse CGColorSpace and CGDataProvider in gfcocoaJune McEnroe 2018-02-04Mark mac target phonyJune McEnroe 2018-02-04Set up Makefile for gfxx-cocoa or gfxx-fbJune McEnroe 2018-02-04Avoid doing excessive work in gfxxJune McEnroe 2018-02-04Handle window resizing in gfcocoaJune McEnroe 2018-02-04Set cinoptionsJune McEnroe 2018-02-04Tweak colorscheme moreJune McEnroe 2018-02-04Color MatchParen DarkYellowJune McEnroe 2018-02-04Add palette sampling to gfxxJune McEnroe 2018-02-04Add 4-bit RGB to gfxxJune McEnroe 2018-02-04Add Quit menu item to gfcocoaJune McEnroe 2018-02-04Switch back to sane Objective-C styleJune McEnroe 2018-02-04Quit gfcocoa when window closesJune McEnroe 2018-02-03Apparently this is how people write Objective-CJune McEnroe