OPENSSL_VERSION_NUMBER.pod 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. =pod
  2. =head1 NAME
  3. OPENSSL_VERSION_NUMBER, OPENSSL_VERSION_TEXT, OpenSSL_version,
  4. OpenSSL_version_num - get OpenSSL version number
  5. =head1 SYNOPSIS
  6. #include <openssl/opensslv.h>
  7. #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
  8. #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"
  9. #include <openssl/crypto.h>
  10. unsigned long OpenSSL_version_num();
  11. const char *OpenSSL_version(int t);
  12. =head1 DESCRIPTION
  13. OPENSSL_VERSION_NUMBER is a numeric release version identifier:
  14. MNNFFPPS: major minor fix patch status
  15. The status nibble has one of the values 0 for development, 1 to e for betas
  16. 1 to 14, and f for release.
  17. for example
  18. 0x000906000 == 0.9.6 dev
  19. 0x000906023 == 0.9.6b beta 3
  20. 0x00090605f == 0.9.6e release
  21. Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
  22. Versions between 0.9.3 and 0.9.5 had a version identifier with this
  23. interpretation:
  24. MMNNFFRBB major minor fix final beta/patch
  25. for example
  26. 0x000904100 == 0.9.4 release
  27. 0x000905000 == 0.9.5 dev
  28. Version 0.9.5a had an interim interpretation that is like the current one,
  29. except the patch level got the highest bit set, to keep continuity. The
  30. number was therefore 0x0090581f.
  31. OPENSSL_VERSION_TEXT is the text variant of the version number and the
  32. release date. For example,
  33. "OpenSSL 1.0.1a 15 Oct 2015".
  34. OpenSSL_version_num() returns the version number.
  35. OpenSSL_version() returns different strings depending on B<t>:
  36. =over 4
  37. =item OPENSSL_VERSION
  38. The text variant of the version number and the release date. For example,
  39. "OpenSSL 1.0.1a 15 Oct 2015".
  40. =item OPENSSL_CFLAGS
  41. The compiler flags set for the compilation process in the form
  42. "compiler: ..." if available or "compiler: information not available"
  43. otherwise.
  44. =item OPENSSL_BUILT_ON
  45. The date of the build process in the form "built on: ..." if available
  46. or "built on: date not available" otherwise.
  47. =item OPENSSL_PLATFORM
  48. The "Configure" target of the library build in the form "platform: ..."
  49. if available or "platform: information not available" otherwise.
  50. =item OPENSSL_DIR
  51. The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
  52. if available or "OPENSSLDIR: N/A" otherwise.
  53. =item OPENSSL_ENGINES_DIR
  54. The "ENGINESDIR" setting of the library build in the form "ENGINESDIR: "...""
  55. if available or "ENGINESDIR: N/A" otherwise.
  56. =back
  57. For an unknown B<t>, the text "not available" is returned.
  58. =head1 RETURN VALUE
  59. The version number.
  60. =head1 SEE ALSO
  61. L<crypto(3)>
  62. =head1 COPYRIGHT
  63. Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
  64. Licensed under the OpenSSL license (the "License"). You may not use
  65. this file except in compliance with the License. You can obtain a copy
  66. in the file LICENSE in the source distribution or at
  67. L<https://www.openssl.org/source/license.html>.
  68. =cut