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
nused and the dlsym fwrite/write hacks horrify me. Clean it up. 2021-01-20Fix tests for diff spansJune McEnroe 2021-01-20Avoid matching ':' in make tagsJune McEnroe Otherwise a :: rule includes one of the ':'s in the tag name. 2021-01-19Prefer tag matches not preceded by [[:alnum:]]June McEnroe Otherwise the "id" in "void" matches for "void id". 2021-01-19Escape \ and / in mtags search patternsJune McEnroe 2021-01-20Use mtags in source-filterJune McEnroe 2021-01-19Add mtags to generate tags for make and mdocJune McEnroe 2021-01-19Map tags to IDs using only [[:alnum:]-._]June McEnroe 2021-01-19Don't use a pager if reading standard inputJune McEnroe 2021-01-19Support BSD make syntax and match *.amJune McEnroe These don't really go together, but... 2021-01-19Match tab following escaped newline in make assignmentsJune McEnroe Otherwise it ends up going into Shell state. 2021-01-18Allow matching lexers using first input lineJune McEnroe