e333b30723f02b43d521a3e717a53dcad0f32579
[openssl.git] / doc / crypto / OPENSSL_VERSION_NUMBER.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_VERSION_NUMBER, SSLeay SSLeay_version - get OpenSSL version number
6
7 =head1 SYNOPSIS
8
9  #include <openssl/opensslv.h>
10  #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
11
12  #include <openssl/crypto.h>
13  long SSLeay(void);
14  char *SSLeay_version(int t);
15
16 =head1 DESCRIPTION
17
18 OPENSSL_VERSION_NUMBER is a numeric release version identifier:
19
20  MMNNFFPPS: major minor fix patch status
21
22 The status nibble has one of the values 0 for development, 1 to e for betas
23 1 to 14, and f for release.
24
25 for example
26
27  0x000906000 == 0.9.6 dev
28  0x000906023 == 0.9.6b beta 3
29  0x00090605f == 0.9.6e release
30
31 Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
32 Versions between 0.9.3 and 0.9.5 had a version identifier with this
33 interpretation:
34
35  MMNNFFRBB major minor fix final beta/patch
36
37 for example
38
39  0x000904100 == 0.9.4 release
40  0x000905000 == 0.9.5 dev
41
42 Version 0.9.5a had an interrim interpretation that is like the current one,
43 except the patch level got the highest bit set, to keep continuity.  The
44 number was therefore 0x0090581f.
45
46
47 For backward compatibility, SSLEAY_VERSION_NUMBER is also defined.
48
49 SSLeay() returns this number. The return value can be compared to the
50 macro to make sure that the correct version of the library has been
51 loaded, especially when using DLLs on Windows systems.
52
53 SSLeay_version() returns different strings depending on B<t>:
54
55 =over 4
56
57 =item SSLEAY_VERSION
58 The text variant of the version number and the release date.  For example,
59 "OpenSSL 0.9.5a 1 Apr 2000".
60
61 =item SSLEAY_CFLAGS
62 The flags given to the C compiler when compiling OpenSSL are returned in a
63 string.
64
65 =item SSLEAY_PLATFORM
66 The platform name used when OpenSSL was configured is returned.
67
68 =back
69
70 If the data request isn't available, a text saying that the information is
71 not available is returned.
72
73 For an unknown B<t>, the text "not available" is returned.
74
75 =head1 RETURN VALUE
76
77 The version number.
78
79 =head1 SEE ALSO
80
81 L<crypto(3)|crypto(3)>
82
83 =head1 HISTORY
84
85 SSLeay() and SSLEAY_VERSION_NUMBER are available in all versions of SSLeay and OpenSSL.
86 OPENSSL_VERSION_NUMBER is available in all versions of OpenSSL.
87
88 =cut