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
447f&follow=1'>Set man_hard_wrap in nvimJune McEnroe 2019-02-18Use hi -o anchor in upJune McEnroe 2019-02-18Don't match nested parentheses in Tag for CJune McEnroe 2019-02-18Match whitespace between * [] {}June McEnroe 2019-02-18Fix function-like #define regexJune McEnroe 2019-02-18Match Tag in RustJune McEnroe 2019-02-18Match sh functions as TagJune McEnroe 2019-02-18Match Sh and Ss as Tag in mdocJune McEnroe 2019-02-18Match statics and typedefs as TagJune McEnroe 2019-02-18Clean up htmlHeaderJune McEnroe 2019-02-18Remove hi line numberingJune McEnroe 2019-02-18Add Tag class to hiJune McEnroe 2019-02-17Generate HTML with hi -n -f html -o anchorJune McEnroe 2019-02-17Add hi -f html -o anchor for line number linksJune McEnroe 2019-02-17Simplify temp trap in upJune McEnroe 2019-02-17Add line numbers to hiJune McEnroe 2019-02-17Always split spans after newlinesJune McEnroe 2019-02-15Color format specifiers light cyan in vimJune McEnroe 2019-02-15Highlight Interp as yellowJune McEnroe 2019-02-15Highlight strings in sh command substitutionsJune McEnroe 2019-02-15Add nmap gpJune McEnroe 2019-02-14Avoid newline when copying URL to pasteboardJune McEnroe 2019-02-13Add forgotten "sixth" book of H2G2June McEnroe