Mini Shell

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "OPENSSL_USER_MACROS 7ossl"
.TH OPENSSL_USER_MACROS 7ossl "2024-12-20" "3.1.7+quic" "OpenSSL"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
openssl_user_macros, OPENSSL_API_COMPAT, OPENSSL_NO_DEPRECATED
\&\- User defined macros
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
User defined macros allow the programmer to control certain aspects of
what is exposed by the OpenSSL headers.
.PP
\&\fB\s-1NOTE:\s0\fR to be effective, a user defined macro \fImust be defined
before including any header file that depends on it\fR, either in the
compilation command (\f(CW\*(C`cc \-DMACRO=value\*(C'\fR) or by defining the macro in
source before including any headers.
.PP
Other manual pages may refer to this page when declarations depend on
user defined macros.
.SS "The macros"
.IX Subsection "The macros"
.IP "\fB\s-1OPENSSL_API_COMPAT\s0\fR" 4
.IX Item "OPENSSL_API_COMPAT"
The value is a version number, given in one of the following two forms:
.RS 4
.ie n .IP """0xMNNFF000L""" 4
.el .IP "\f(CW0xMNNFF000L\fR" 4
.IX Item "0xMNNFF000L"
This is the form supported for all versions up to 1.1.x, where \f(CW\*(C`M\*(C'\fR
represents the major number, \f(CW\*(C`NN\*(C'\fR represents the minor number, and
\&\f(CW\*(C`FF\*(C'\fR represents the fix number, as a hexadecimal number.  For version
1.1.0, that's \f(CW\*(C`0x10100000L\*(C'\fR.
.Sp
Any version number may be given, but these numbers are
the current known major deprecation points, making them the most
meaningful:
.RS 4
.ie n .IP """0x00908000L"" (version 0.9.8)" 4
.el .IP "\f(CW0x00908000L\fR (version 0.9.8)" 4
.IX Item "0x00908000L (version 0.9.8)"
.PD 0
.ie n .IP """0x10000000L"" (version 1.0.0)" 4
.el .IP "\f(CW0x10000000L\fR (version 1.0.0)" 4
.IX Item "0x10000000L (version 1.0.0)"
.ie n .IP """0x10100000L"" (version 1.1.0)" 4
.el .IP "\f(CW0x10100000L\fR (version 1.1.0)" 4
.IX Item "0x10100000L (version 1.1.0)"
.RE
.RS 4
.PD
.Sp
For convenience, higher numbers are accepted as well, as long as
feasible.  For example, \f(CW\*(C`0x60000000L\*(C'\fR will work as expected.
However, it is recommended to start using the second form instead:
.RE
.ie n .IP """mmnnpp""" 4
.el .IP "\f(CWmmnnpp\fR" 4
.IX Item "mmnnpp"
This form is a simple decimal number calculated with this formula:
.Sp
\&\fImajor\fR * 10000 + \fIminor\fR * 100 + \fIpatch\fR
.Sp
where \fImajor\fR, \fIminor\fR and \fIpatch\fR are the desired major,
minor and patch components of the version number.  For example:
.RS 4
.IP "30000 corresponds to version 3.0.0" 4
.IX Item "30000 corresponds to version 3.0.0"
.PD 0
.IP "10002 corresponds to version 1.0.2" 4
.IX Item "10002 corresponds to version 1.0.2"
.IP "420101 corresponds to version 42.1.1" 4
.IX Item "420101 corresponds to version 42.1.1"
.RE
.RS 4
.RE
.RE
.RS 4
.PD
.Sp
If \fB\s-1OPENSSL_API_COMPAT\s0\fR is undefined, this default value is used in its
place:
\&\f(CW30100\fR
.RE
.IP "\fB\s-1OPENSSL_NO_DEPRECATED\s0\fR" 4
.IX Item "OPENSSL_NO_DEPRECATED"
If this macro is defined, all deprecated public symbols in all OpenSSL
versions up to and including the version given by \fB\s-1OPENSSL_API_COMPAT\s0\fR
(or the default value given above, when \fB\s-1OPENSSL_API_COMPAT\s0\fR isn't defined)
will be hidden.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2018\-2021 The OpenSSL Project Authors. All Rights Reserved.
.PP
Licensed under the Apache License 2.0 (the \*(L"License\*(R").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file \s-1LICENSE\s0 in the source distribution or at
<https://www.openssl.org/source/license.html>.