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

=head1 NAME

5
OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version - get OpenSSL version number
U
Ulf Möller 已提交
6 7 8 9 10 11 12 13

=head1 SYNOPSIS

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

 #include <openssl/crypto.h>
 long SSLeay(void);
14
 const char *SSLeay_version(int t);
U
Ulf Möller 已提交
15 16 17 18 19

=head1 DESCRIPTION

OPENSSL_VERSION_NUMBER is a numeric release version identifier:

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
 MMNNFFPPS: major minor fix patch status

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 已提交
35 36 37 38 39 40 41
 MMNNFFRBB major minor fix final beta/patch

for example

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

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


U
Ulf Möller 已提交
47 48 49 50 51 52
For backward compatibility, SSLEAY_VERSION_NUMBER is also defined.

SSLeay() returns this number. The return value can be compared to the
macro to make sure that the correct version of the library has been
loaded, especially when using DLLs on Windows systems.

53 54 55 56 57
SSLeay_version() returns different strings depending on B<t>:

=over 4

=item SSLEAY_VERSION
58

59 60 61 62
The text variant of the version number and the release date.  For example,
"OpenSSL 0.9.5a 1 Apr 2000".

=item SSLEAY_CFLAGS
63 64 65 66 67 68 69 70 71

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

=item SSLEAY_BUILT_ON

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

=item SSLEAY_PLATFORM

75 76 77 78
The "Configure" target of the library build in the form "platform: ..."
if available or "platform: information not available" otherwise.

=item SSLEAY_DIR
79

80 81
The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
if available or "OPENSSLDIR: N/A" otherwise.
82

83
=back
84

U
Ulf Möller 已提交
85 86 87 88 89 90 91 92 93 94 95 96
=head1 RETURN VALUE

The version number.

=head1 SEE ALSO

L<crypto(3)|crypto(3)>

=head1 HISTORY

SSLeay() and SSLEAY_VERSION_NUMBER are available in all versions of SSLeay and OpenSSL.
OPENSSL_VERSION_NUMBER is available in all versions of OpenSSL.
97
B<SSLEAY_DIR> was added in OpenSSL 0.9.7.
U
Ulf Möller 已提交
98 99

=cut