OPENSSL_VERSION_NUMBER.pod revision 340704
1=pod
2
3=head1 NAME
4
5OPENSSL_VERSION_NUMBER, OPENSSL_VERSION_TEXT, SSLeay, SSLeay_version
6- get OpenSSL version number
7
8=head1 SYNOPSIS
9
10 #include <openssl/opensslv.h>
11 #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
12 #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"
13
14 #include <openssl/crypto.h>
15 long SSLeay(void);
16 const char *SSLeay_version(int t);
17
18=head1 DESCRIPTION
19
20OPENSSL_VERSION_NUMBER is a numeric release version identifier:
21
22 MNNFFPPS: major minor fix patch status
23
24The status nibble has one of the values 0 for development, 1 to e for betas
251 to 14, and f for release.
26
27for example
28
29 0x000906000 == 0.9.6 dev
30 0x000906023 == 0.9.6b beta 3
31 0x00090605f == 0.9.6e release
32
33Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
34Versions between 0.9.3 and 0.9.5 had a version identifier with this
35interpretation:
36
37 MMNNFFRBB major minor fix final beta/patch
38
39for example
40
41 0x000904100 == 0.9.4 release
42 0x000905000 == 0.9.5 dev
43
44Version 0.9.5a had an interim interpretation that is like the current one,
45except the patch level got the highest bit set, to keep continuity.  The
46number was therefore 0x0090581f.
47
48For backward compatibility, SSLEAY_VERSION_NUMBER is also defined.
49
50OPENSSL_VERSION_TEXT is the text variant of the version number and the
51release date.  For example,
52"OpenSSL 1.0.1a 15 Oct 2015".
53
54SSLeay() returns this number. The return value can be compared to the
55macro to make sure that the correct version of the library has been
56loaded, especially when using DLLs on Windows systems.
57
58SSLeay_version() returns different strings depending on B<t>:
59
60=over 4
61
62=item SSLEAY_VERSION
63
64The text variant of the version number and the release date.  For example,
65"OpenSSL 0.9.5a 1 Apr 2000".
66
67=item SSLEAY_CFLAGS
68
69The compiler flags set for the compilation process in the form
70"compiler: ..."  if available or "compiler: information not available"
71otherwise.
72
73=item SSLEAY_BUILT_ON
74
75The date of the build process in the form "built on: ..." if available
76or "built on: date not available" otherwise.
77
78=item SSLEAY_PLATFORM
79
80The "Configure" target of the library build in the form "platform: ..."
81if available or "platform: information not available" otherwise.
82
83=item SSLEAY_DIR
84
85The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
86if available or "OPENSSLDIR: N/A" otherwise.
87
88=back
89
90For an unknown B<t>, the text "not available" is returned.
91
92=head1 RETURN VALUE
93
94The version number.
95
96=head1 SEE ALSO
97
98L<crypto(3)|crypto(3)>
99
100=head1 HISTORY
101
102SSLeay() and SSLEAY_VERSION_NUMBER are available in all versions of SSLeay and OpenSSL.
103OPENSSL_VERSION_NUMBER is available in all versions of OpenSSL.
104B<SSLEAY_DIR> was added in OpenSSL 0.9.7.
105
106=cut
107