diff options
Diffstat (limited to 'src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3')
| -rw-r--r-- | src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 b/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 new file mode 100644 index 0000000000..660a964427 --- /dev/null +++ b/src/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3 | |||
| @@ -0,0 +1,96 @@ | |||
| 1 | .Dd $Mdocdate: November 3 2016 $ | ||
| 2 | .Dt OPENSSL_VERSION_NUMBER 3 | ||
| 3 | .Os | ||
| 4 | .Sh NAME | ||
| 5 | .Nm OPENSSL_VERSION_NUMBER , | ||
| 6 | .Nm SSLeay , | ||
| 7 | .Nm SSLeay_version | ||
| 8 | .Nd get OpenSSL version number | ||
| 9 | .Sh SYNOPSIS | ||
| 10 | .In openssl/opensslv.h | ||
| 11 | .Fd #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL | ||
| 12 | .In openssl/crypto.h | ||
| 13 | .Ft long | ||
| 14 | .Fn SSLeay void | ||
| 15 | .Ft const char * | ||
| 16 | .Fo SSLeay_version | ||
| 17 | .Fa "int t" | ||
| 18 | .Fc | ||
| 19 | .Sh DESCRIPTION | ||
| 20 | .Dv OPENSSL_VERSION_NUMBER | ||
| 21 | is a numeric release version identifier. | ||
| 22 | The first two digits contain the major release number, | ||
| 23 | the third and fourth digits the minor release number, | ||
| 24 | the fifth and sixth digits the fix release number, | ||
| 25 | the seventh and eight digits the patch release number. | ||
| 26 | The final digit is 0 for development, 1 to e for betas 1 to 14, or f | ||
| 27 | for release. | ||
| 28 | .Pp | ||
| 29 | For example: | ||
| 30 | .Bd -literal -offset indent | ||
| 31 | 0x000906000 == 0.9.6 dev | ||
| 32 | 0x000906023 == 0.9.6b beta 3 | ||
| 33 | 0x00090605f == 0.9.6e release | ||
| 34 | .Ed | ||
| 35 | .Pp | ||
| 36 | Versions prior to 0.9.3 had identifiers < 0x0930. | ||
| 37 | For versions between 0.9.3 and 0.9.5, | ||
| 38 | the seventh digit was 1 for release and 0 otherwise, | ||
| 39 | and the eighth and ninth digits were the patch release number. | ||
| 40 | .Pp | ||
| 41 | For example: | ||
| 42 | .Bd -literal | ||
| 43 | 0x000904100 == 0.9.4 release | ||
| 44 | 0x000905000 == 0.9.5 dev | ||
| 45 | .Ed | ||
| 46 | .Pp | ||
| 47 | Version 0.9.5a had an interim interpretation that is like the current | ||
| 48 | one, except the patch level got the highest bit set, to keep continuity. | ||
| 49 | The number was therefore 0x0090581f. | ||
| 50 | .Pp | ||
| 51 | For backward compatibility, SSLEAY_VERSION_NUMBER is also defined. | ||
| 52 | .Pp | ||
| 53 | .Fn SSLeay | ||
| 54 | returns this number. | ||
| 55 | The return value can be compared to the macro to make sure that the | ||
| 56 | correct version of the library has been loaded, especially when using | ||
| 57 | DLLs on Windows systems. | ||
| 58 | .Pp | ||
| 59 | .Fn SSLeay_version | ||
| 60 | returns different strings depending on | ||
| 61 | .Fa t : | ||
| 62 | .Bl -tag -width Ds | ||
| 63 | .It Dv SSLEAY_VERSION | ||
| 64 | The text variant of the version number and the release date. | ||
| 65 | For example, "OpenSSL 0.9.5a 1 Apr 2000". | ||
| 66 | .It Dv SSLEAY_CFLAGS | ||
| 67 | The compiler flags set for the compilation process in the form | ||
| 68 | "compiler: ..." if available or "compiler: information not available" | ||
| 69 | otherwise. | ||
| 70 | .It Dv SSLEAY_BUILT_ON | ||
| 71 | The date of the build process in the form "built on: ..." if available | ||
| 72 | or "built on: date not available" otherwise. | ||
| 73 | .It Dv SSLEAY_PLATFORM | ||
| 74 | The "Configure" target of the library build in the form "platform: ..." | ||
| 75 | if available or "platform: information not available" otherwise. | ||
| 76 | .It Dv SSLEAY_DIR | ||
| 77 | The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: | ||
| 78 | "..."" if available or "OPENSSLDIR: N/A" otherwise. | ||
| 79 | .El | ||
| 80 | .Pp | ||
| 81 | For an unknown | ||
| 82 | .Fa t , | ||
| 83 | the text "not available" is returned. | ||
| 84 | .Sh RETURN VALUE | ||
| 85 | The version number. | ||
| 86 | .Sh SEE ALSO | ||
| 87 | .Xr crypto 3 | ||
| 88 | .Sh HISTORY | ||
| 89 | .Fn SSLeay | ||
| 90 | and | ||
| 91 | .Dv SSLEAY_VERSION_NUMBER | ||
| 92 | are available in all versions of SSLeay and OpenSSL. | ||
| 93 | .Dv OPENSSL_VERSION_NUMBER | ||
| 94 | is available in all versions of OpenSSL. | ||
| 95 | .Dv SSLEAY_DIR | ||
| 96 | was added in OpenSSL 0.9.7. | ||
