Debian Codegraph @

upstream/debian-unstable/man7/openssl_user_macros.7ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL_USER_MACROS 7SSL"
58 .TH OPENSSL_USER_MACROS 7SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl_user_macros, OPENSSL_API_COMPAT, OPENSSL_NO_DEPRECATED
65 \&\- User defined macros
66 .SH DESCRIPTION
67 .IX Header "DESCRIPTION"
68 User defined macros allow the programmer to control certain aspects of
69 what is exposed by the OpenSSL headers.
70 .PP
71 \&\fBNOTE:\fR to be effective, a user defined macro \fImust be defined
72 before including any header file that depends on it\fR, either in the
73 compilation command (\f(CW\*(C`cc \-DMACRO=value\*(C'\fR) or by defining the macro in
74 source before including any headers.
75 .PP
76 Other manual pages may refer to this page when declarations depend on
77 user defined macros.
78 .SS "The macros"
79 .IX Subsection "The macros"
80 .IP \fBOPENSSL_API_COMPAT\fR 4
81 .IX Item "OPENSSL_API_COMPAT"
82 The value is a version number, given in one of the following two forms:
83 .RS 4
84 .ie n .IP """0xMNNFF000L""" 4
85 .el .IP \f(CW0xMNNFF000L\fR 4
86 .IX Item "0xMNNFF000L"
87 This is the form supported for all versions up to 1.1.x, where \f(CW\*(C`M\*(C'\fR
88 represents the major number, \f(CW\*(C`NN\*(C'\fR represents the minor number, and
89 \&\f(CW\*(C`FF\*(C'\fR represents the fix number, as a hexadecimal number. For version
90 1.1.0, that's \f(CW\*(C`0x10100000L\*(C'\fR.
91 .Sp
92 Any version number may be given, but these numbers are
93 the current known major deprecation points, making them the most
94 meaningful:
95 .RS 4
96 .ie n .IP """0x00908000L"" (version 0.9.8)" 4
97 .el .IP "\f(CW0x00908000L\fR (version 0.9.8)" 4
98 .IX Item "0x00908000L (version 0.9.8)"
99 .PD 0
100 .ie n .IP """0x10000000L"" (version 1.0.0)" 4
101 .el .IP "\f(CW0x10000000L\fR (version 1.0.0)" 4
102 .IX Item "0x10000000L (version 1.0.0)"
103 .ie n .IP """0x10100000L"" (version 1.1.0)" 4
104 .el .IP "\f(CW0x10100000L\fR (version 1.1.0)" 4
105 .IX Item "0x10100000L (version 1.1.0)"
106 .RE
107 .RS 4
108 .PD
109 .Sp
110 For convenience, higher numbers are accepted as well, as long as
111 feasible. For example, \f(CW\*(C`0x60000000L\*(C'\fR will work as expected.
112 However, it is recommended to start using the second form instead:
113 .RE
114 .ie n .IP """mmnnpp""" 4
115 .el .IP \f(CWmmnnpp\fR 4
116 .IX Item "mmnnpp"
117 This form is a simple decimal number calculated with this formula:
118 .Sp
119 \&\fImajor\fR * 10000 + \fIminor\fR * 100 + \fIpatch\fR
120 .Sp
121 where \fImajor\fR, \fIminor\fR and \fIpatch\fR are the desired major,
122 minor and patch components of the version number. For example:
123 .RS 4
124 .IP "30000 corresponds to version 3.0.0" 4
125 .IX Item "30000 corresponds to version 3.0.0"
126 .PD 0
127 .IP "10002 corresponds to version 1.0.2" 4
128 .IX Item "10002 corresponds to version 1.0.2"
129 .IP "420101 corresponds to version 42.1.1" 4
130 .IX Item "420101 corresponds to version 42.1.1"
131 .RE
132 .RS 4
133 .RE
134 .RE
135 .RS 4
136 .PD
137 .Sp
138 If \fBOPENSSL_API_COMPAT\fR is undefined, this default value is used in its
139 place:
140 \&\f(CW30600\fR
141 .RE
142 .IP \fBOPENSSL_NO_DEPRECATED\fR 4
143 .IX Item "OPENSSL_NO_DEPRECATED"
144 If this macro is defined, all deprecated public symbols in all OpenSSL
145 versions up to and including the version given by \fBOPENSSL_API_COMPAT\fR
146 (or the default value given above, when \fBOPENSSL_API_COMPAT\fR isn't defined)
147 will be hidden.
148 .SH COPYRIGHT
149 .IX Header "COPYRIGHT"
150 Copyright 2018\-2021 The OpenSSL Project Authors. All Rights Reserved.
151 .PP
152 Licensed under the Apache License 2.0 (the "License"). You may not use
153 this file except in compliance with the License. You can obtain a copy
154 in the file LICENSE in the source distribution or at
155 <https://www.openssl.org/source/license.html>.