summary refs log tree commit diff
path: root/doc/zlib/gzbuffer.3
blob: de7c706a3f56e9d245488ec4bbeb2720f5d456ef (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 C. 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
mmit/bin/psfed.c?id=dc173ca9c660f775675d6c712f82dcedccdf9db0&follow=1'>Remove Linux-specific utilitiesJune McEnroe 2021-09-22Call sandbox in CGI modeJune McEnroe 2021-09-22Support HTTP PUT in upJune McEnroe 2021-09-22Remove default faviconJune McEnroe 2021-09-21Use Z_FILTERED strategyJune McEnroe 2021-09-21Recalculate various lengths only as neededJune McEnroe 2021-09-21Rewrite pngo, add explicit optionsJune McEnroe 2021-09-16Fix /* **/ comment matchingJune McEnroe 2021-09-15Remove typer, add downgrade to READMEJune McEnroe 2021-09-15Set bot mode on downgradeJune McEnroe 2021-09-15Enter capsicum in downgradeJune McEnroe 2021-09-15Factor out common parts of downgrade messagesJune McEnroe 2021-09-14Add downgrade IRC botJune McEnroe 2021-09-14Sort by title if authors matchJune McEnroe 2021-09-13Swap-remove tags as they're foundJune McEnroe 2021-09-12Replace htagml regex with strncmpJune McEnroe 2021-09-11Also defer printing comment for lone close-parensJune McEnroe 2021-09-10Publish "git-comment"June McEnroe 2021-09-10Add git comment --pretty optionJune McEnroe 2021-09-08Defer printing comment if line is blank or closing braceJune McEnroe 2021-09-08Up default min-repeat to 30 linesJune McEnroe 2021-09-08Handle dirty lines in git-commentJune McEnroe 2021-09-08Document and install git-commentJune McEnroe 2021-09-08Add repeat and all options to git-commentJune McEnroe 2021-09-08Add group threshold to git-commentJune McEnroe