Remove SSLeay history, etc., from docs
[openssl.git] / doc / crypto / OPENSSL_VERSION_NUMBER.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_VERSION_NUMBER, OpenSSL_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  const char *OpenSSL_version(int t);
14
15 =head1 DESCRIPTION
16
17 OPENSSL_VERSION_NUMBER is a numeric release version identifier:
18
19  MNNFFPPS: major minor fix patch status
20
21 The status nibble has one of the values 0 for development, 1 to e for betas
22 1 to 14, and f for release.
23
24 for example
25
26  0x000906000 == 0.9.6 dev
27  0x000906023 == 0.9.6b beta 3
28  0x00090605f == 0.9.6e release
29
30 Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
31 Versions between 0.9.3 and 0.9.5 had a version identifier with this
32 interpretation:
33
34  MMNNFFRBB major minor fix final beta/patch
35
36 for example
37
38  0x000904100 == 0.9.4 release
39  0x000905000 == 0.9.5 dev
40
41 Version 0.9.5a had an interim interpretation that is like the current one,
42 except the patch level got the highest bit set, to keep continuity.  The
43 number was therefore 0x0090581f.
44
45
46 For backward compatibility, OPENSSL_VERSION_NUMBER is also defined.
47
48 OpenSSL_version() returns different strings depending on B<t>:
49
50 =over 4
51
52 =item OPENSSL_VERSION
53
54 The text variant of the version number and the release date.  For example,
55 "OpenSSL 1.0.1a 15 Oct 2015".
56
57 =item OPENSSL_CFLAGS
58
59 The compiler flags set for the compilation process in the form
60 "compiler: ..."  if available or "compiler: information not available"
61 otherwise.
62
63 =item OPENSSL_BUILT_ON
64
65 The date of the build process in the form "built on: ..." if available
66 or "built on: date not available" otherwise.
67
68 =item OPENSSL_PLATFORM
69
70 The "Configure" target of the library build in the form "platform: ..."
71 if available or "platform: information not available" otherwise.
72
73 =item OPENSSL_DIR
74
75 The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
76 if available or "OPENSSLDIR: N/A" otherwise.
77
78 =back
79
80 For an unknown B<t>, the text "not available" is returned.
81
82 =head1 RETURN VALUE
83
84 The version number.
85
86 =head1 SEE ALSO
87
88 L<crypto(3)>
89
90 =cut