libcrypto/man/openssl_user_macros.7

     $NetBSD: openssl_user_macros.7,v 1.1 2024/07/12 21:01:14 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 Standard preamble:
 ========================================================================
..
..

..
 \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}

 Escape single quotes in literal strings from groff's Unicode transform.

 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'.
..
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
 ========================================================================

 Title "OPENSSL_USER_MACROS 7"  OPENSSL_USER_MACROS 7 2024-07-11 3.0.14 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
 NAME
openssl_user_macros, OPENSSL_API_COMPAT, OPENSSL_NO_DEPRECATED
\- User defined macros
 DESCRIPTION
 Header "DESCRIPTION" User defined macros allow the programmer to control certain aspects of
what is exposed by the OpenSSL headers.

\fBNOTE: to be effective, a user defined macro must be defined
before including any header file that depends on it, either in the
compilation command (\*(C`cc -DMACRO=value\*(C') or by defining the macro in
source before including any headers.

Other manual pages may refer to this page when declarations depend on
user defined macros.
 "The macros"
 Subsection "The macros"  OPENSSL_API_COMPAT 4
 Item "OPENSSL_API_COMPAT" The value is a version number, given in one of the following two forms:

 Item "0xMNNFF000L" This is the form supported for all versions up to 1.1.x, where \*(C`M\*(C'
represents the major number, \*(C`NN\*(C' represents the minor number, and
\f(CW\*(C`FF\*(C' represents the fix number, as a hexadecimal number. For version
1.1.0, that's \*(C`0x10100000L\*(C'.
.Sp
Any version number may be given, but these numbers are
the current known major deprecation points, making them the most
meaningful:

 Item "0x00908000L (version 0.9.8)"  0
 Item "0x10000000L (version 1.0.0)"  Item "0x10100000L (version 1.1.0)"


.Sp
For convenience, higher numbers are accepted as well, as long as
feasible. For example, \*(C`0x60000000L\*(C' will work as expected.
However, it is recommended to start using the second form instead:

 Item "mmnnpp" This form is a simple decimal number calculated with this formula:
.Sp
\fImajor * 10000 + minor * 100 + patch
.Sp
where major, minor and patch are the desired major,
minor and patch components of the version number. For example:

 "30000 corresponds to version 3.0.0" 4
 Item "30000 corresponds to version 3.0.0"  0
 "10002 corresponds to version 1.0.2" 4
 Item "10002 corresponds to version 1.0.2"  "420101 corresponds to version 42.1.1" 4
 Item "420101 corresponds to version 42.1.1"


.Sp
If OPENSSL_API_COMPAT is undefined, this default value is used in its
place:
\f(CW30000

 OPENSSL_NO_DEPRECATED 4
 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 OPENSSL_API_COMPAT
(or the default value given above, when OPENSSL_API_COMPAT isn't defined)
will be hidden.
 COPYRIGHT
 Header "COPYRIGHT" Copyright 2018-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.