OPENSSL_VERSION_NUMBER.pod 2.5 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

R
Rich Salz 已提交
5 6
OPENSSL_VERSION_NUMBER, OpenSSL_version,
OpenSSL_version_num - get OpenSSL version number
U
Ulf Möller 已提交
7 8 9 10 11 12 13

=head1 SYNOPSIS

 #include <openssl/opensslv.h>
 #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL

 #include <openssl/crypto.h>
R
Rich Salz 已提交
14 15

 unsigned long OpenSSL_version_num();
R
Rich Salz 已提交
16
 const char *OpenSSL_version(int t);
U
Ulf Möller 已提交
17 18 19 20 21

=head1 DESCRIPTION

OPENSSL_VERSION_NUMBER is a numeric release version identifier:

22
 MNNFFPPS: major minor fix patch status
23 24 25 26 27 28 29 30 31 32 33 34 35 36

The status nibble has one of the values 0 for development, 1 to e for betas
1 to 14, and f for release.

for example

 0x000906000 == 0.9.6 dev
 0x000906023 == 0.9.6b beta 3
 0x00090605f == 0.9.6e release

Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
Versions between 0.9.3 and 0.9.5 had a version identifier with this
interpretation:

U
Ulf Möller 已提交
37 38 39 40 41 42 43
 MMNNFFRBB major minor fix final beta/patch

for example

 0x000904100 == 0.9.4 release
 0x000905000 == 0.9.5 dev

U
ispell.  
Ulf Möller 已提交
44
Version 0.9.5a had an interim interpretation that is like the current one,
45 46 47
except the patch level got the highest bit set, to keep continuity.  The
number was therefore 0x0090581f.

R
Rich Salz 已提交
48
OpenSSL_version_num() returns the version number.
U
Ulf Möller 已提交
49

R
Rich Salz 已提交
50
OpenSSL_version() returns different strings depending on B<t>:
51 52 53

=over 4

R
Rich Salz 已提交
54
=item OPENSSL_VERSION
55

56
The text variant of the version number and the release date.  For example,
R
Rich Salz 已提交
57
"OpenSSL 1.0.1a 15 Oct 2015".
58

R
Rich Salz 已提交
59
=item OPENSSL_CFLAGS
60 61 62 63 64

The compiler flags set for the compilation process in the form
"compiler: ..."  if available or "compiler: information not available"
otherwise.

R
Rich Salz 已提交
65
=item OPENSSL_BUILT_ON
66 67 68

The date of the build process in the form "built on: ..." if available
or "built on: date not available" otherwise.
69

R
Rich Salz 已提交
70
=item OPENSSL_PLATFORM
71

72 73 74
The "Configure" target of the library build in the form "platform: ..."
if available or "platform: information not available" otherwise.

R
Rich Salz 已提交
75
=item OPENSSL_DIR
76

77 78
The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
if available or "OPENSSLDIR: N/A" otherwise.
79

80 81 82 83 84
=item OPENSSL_ENGINES_DIR

The "ENGINESDIR" setting of the library build in the form "ENGINESDIR: "...""
if available or "ENGINESDIR: N/A" otherwise.

85
=back
86

87 88
For an unknown B<t>, the text "not available" is returned.

U
Ulf Möller 已提交
89 90 91 92 93 94
=head1 RETURN VALUE

The version number.

=head1 SEE ALSO

R
Rich Salz 已提交
95
L<crypto(3)>
U
Ulf Möller 已提交
96 97

=cut
R
Rich Salz 已提交
98 99 100 101 102 103 104 105 106 107 108

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (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
L<https://www.openssl.org/source/license.html>.

=cut