doc/man7/openssl_user_macros.pod.in

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl_user_macros, OPENSSL_API_COMPAT - User defined macros
   6
   7 =head1 DESCRIPTION
   8
   9 User defined macros allow the programmer to control certain aspects of
  10 what is exposed by the OpenSSL headers.
  11
  12 B<NOTE:> to be effective, a user defined macro I<must be defined
  13 before including any header file that depends on it>, either in the
  14 compilation command (C<cc -DMACRO=value>) or by defining the macro in
  15 source before including any headers.
  16
  17 Other manual pages may refer to this page when declarations depend on
  18 user defined macros.
  19
  20 =head2 The macros
  21
  22 =over
  23
  24 =item B<OPENSSL_API_COMPAT>
  25
  26 The value is a version number similar to the
  27 L<OPENSSL_VERSION_NUMBER(3)> macro.  Any symbol that is deprecated in
  28 versions up to and including the version given in this macro will not
  29 be declared.  Any version number may be given, but these numbers are
  30 the current known major deprecation points, making them the most
  31 meaningful:
  32
  33 =over
  34
  35 =item C<0x00908000L> (version 0.9.8)
  36
  37 =item C<0x10000000L> (version 1.0.0)
  38
  39 =item C<0x10100000L> (version 1.1.0)
  40
  41 =back
  42
  43 If not set, this macro will default to
  44 C<{- join('', map { my @x = split /=/,$_; $x[1] }
  45               grep /^OPENSSL_MIN_API=/, @{$config{openssl_api_defines} // []})
  46      || '0x00000000L'
  47   -}>.
  48
  49 =back
  50
  51 =head1 COPYRIGHT
  52
  53 Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
  54
  55 Licensed under the OpenSSL license (the "License").  You may not use
  56 this file except in compliance with the License.  You can obtain a copy
  57 in the file LICENSE in the source distribution or at
  58 L<https://www.openssl.org/source/license.html>.
  59
  60 =cut