blob: b93c03e7832ce00a30aa40218409b2eabbf70977 (
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
.Dd January 15, 2017
.Dt GZFLUSH 3
.Os
.
.Sh NAME
.Nm gzflush
.Nd flush output to compressed file
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft int
.Fn gzflush "gzFile file" "int flush"
.
.Sh DESCRIPTION
Flushes all pending output
into the compressed file.
The parameter
.Fa flush
is as in the
.Xr deflate 3
function.
.Fn gzflush
is only permitted when writing.
.
.Pp
If the
.Fa flush
parameter is
.Dv Z_FINISH ,
the remaining data is written
and the gzip stream
is completed in the output.
If
.Xr gzwrite 3
is called again,
a new gzip stream
will be started in the output.
.Xr gzread 3
is able to read
such concatenated gzip streams.
.
.Pp
.Fn gzflush
should be called only when strictly necessary
because it will degrade compression
if called too often.
.
.Sh RETURN VALUES
The return value
is the zlib error number
.Po
see function
.Xr gzerror 3
.Pc .
.
.Sh SEE ALSO
.Xr deflate 3 ,
.Xr gzerror 3 ,
.Xr gzread 3 ,
.Xr gzwrite 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
|