summary refs log tree commit diff
path: root/doc/zlib/zlibCompileFlags.3
blob: 59cc24a8da85b8081c9cb0768e5b433233cd26e2 (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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
.Dd January 15, 2017
.Dt ZLIBCOMPILEFLAGS 3
.Os
.
.Sh NAME
.Nm zlibCompileFlags
.Nd zlib compile-time options
.
.Sh LIBRARY
.Lb libz
.
.Sh SYNOPSIS
.In zlib.h
.Ft uLong
.Fn zlibCompileFlags void
.
.Sh DESCRIPTION
Return flags indicating compile-time options.
.
.Ss Type sizes
Two bits each,
00 = 16 bits,
01 = 32 bits,
10 = 64 bits,
11 = other.
.
.Pp
.Bl -tag -width Ds -compact
.It 1.0
size of
.Vt uInt
.It 3.2
size of
.Vt uLong
.It 5.4
size of
.Vt voidpf
(pointer)
.It 7.6
size of
.Vt z_off_t
.El
.
.Ss Compiler, assembler, and debug options
.Bl -tag -width Ds -compact
.It 8
.Dv ZLIB_DEBUG
.It 9
.Dv ASMV
or
.Dv ASMINF
\(em
use ASM code
.It 10
.Dv ZLIB_WINAPI
\(em
exported functions use the WINAPI calling convention
.It 11
0 (reserved)
.El
.
.Ss One-time table building
Smaller code,
but not thread-safe if true.
.
.Pp
.Bl -tag -width Ds -compact
.It 12
.Dv BUILDFIXED
\(em
build static block decoding tables when needed
.It 13
.Dv DYNAMIC_CRC_TABLE
\(em
build CRC calculation tables when needed
.It 14,15
0 (reserved)
.El
.
.Ss Library content
Indicates missing functionality.
.
.Pp
.Bl -tag -width Ds -compact
.It 16
.Dv NO_GZCOMPRESS
\(em
gz* functions cannot compress
(to avoid linking deflate code when not needed)
.It 17
.Dv NO_GZIP
\(em
.Xr deflate 3
can't write gzip streams,
and
.Xr inflate 3
can't detect and decode gzip streams
(to avoid linking crc code)
.It 18-19
0 (reserved)
.El
.
.Ss Operation variations
Changes in library functionality.
.
.Pp
.Bl -tag -width Ds -compact
.It 20
.Dv PKZIP_BUG_WORKAROUND
\(em
slightly more permissive
.Xr inflate 3
.It 21
.Dv FASTEST
\(em
deflate algorithm with only one,
lowest compression level
.It 22,23
0 (reserved)
.El
.
.Ss sprintf variant used by gzprintf
Zero is best.
.
.Pp
.Bl -tag -width Ds -compact
.It 24
0 = vs*,
1 = s*
\(em
1 means limited to 20 arguments after the format
.It 25
0 = *nprintf,
1 = *printf
\(em
1 means
.Xr gzprintf 3
not secure!
.It 26
0 = returns value,
1 = void
\(em
1 means inferred string length returned
.El
.
.Ss Remainder
.Bl -tag -width Ds -compact
.It 27-31
0 (reserved)
.El
.
.Sh SEE ALSO
.Xr zlibVersion 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