X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=doc%2Fcrypto%2FOPENSSL_VERSION_NUMBER.pod;h=d87d7197e5dd39f62c1d3bb7e224742ae3289d8d;hp=e333b30723f02b43d521a3e717a53dcad0f32579;hb=8483a003bfca5fac61cda3daea4db2ca20d10ef2;hpb=e65c84abb054d9cd91a011cfcf822c2cc18ebdc7 diff --git a/doc/crypto/OPENSSL_VERSION_NUMBER.pod b/doc/crypto/OPENSSL_VERSION_NUMBER.pod index e333b30723..d87d7197e5 100644 --- a/doc/crypto/OPENSSL_VERSION_NUMBER.pod +++ b/doc/crypto/OPENSSL_VERSION_NUMBER.pod @@ -2,7 +2,8 @@ =head1 NAME -OPENSSL_VERSION_NUMBER, SSLeay SSLeay_version - get OpenSSL version number +OPENSSL_VERSION_NUMBER, OpenSSL_version, +OpenSSL_version_num - get OpenSSL version number =head1 SYNOPSIS @@ -10,14 +11,15 @@ OPENSSL_VERSION_NUMBER, SSLeay SSLeay_version - get OpenSSL version number #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL #include - long SSLeay(void); - char *SSLeay_version(int t); + + unsigned long OpenSSL_version_num(); + const char *OpenSSL_version(int t); =head1 DESCRIPTION OPENSSL_VERSION_NUMBER is a numeric release version identifier: - MMNNFFPPS: major minor fix patch status + MNNFFPPS: 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. @@ -39,36 +41,48 @@ for example 0x000904100 == 0.9.4 release 0x000905000 == 0.9.5 dev -Version 0.9.5a had an interrim interpretation that is like the current one, +Version 0.9.5a had an interim interpretation that is like the current one, except the patch level got the highest bit set, to keep continuity. The number was therefore 0x0090581f. +OpenSSL_version_num() returns the version number. -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. - -SSLeay_version() returns different strings depending on B: +OpenSSL_version() returns different strings depending on B: =over 4 -=item SSLEAY_VERSION +=item OPENSSL_VERSION + The text variant of the version number and the release date. For example, -"OpenSSL 0.9.5a 1 Apr 2000". +"OpenSSL 1.0.1a 15 Oct 2015". -=item SSLEAY_CFLAGS -The flags given to the C compiler when compiling OpenSSL are returned in a -string. +=item OPENSSL_CFLAGS -=item SSLEAY_PLATFORM -The platform name used when OpenSSL was configured is returned. +The compiler flags set for the compilation process in the form +"compiler: ..." if available or "compiler: information not available" +otherwise. -=back +=item OPENSSL_BUILT_ON + +The date of the build process in the form "built on: ..." if available +or "built on: date not available" otherwise. + +=item OPENSSL_PLATFORM + +The "Configure" target of the library build in the form "platform: ..." +if available or "platform: information not available" otherwise. -If the data request isn't available, a text saying that the information is -not available is returned. +=item OPENSSL_DIR + +The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "..."" +if available or "OPENSSLDIR: N/A" otherwise. + +=item OPENSSL_ENGINES_DIR + +The "ENGINESDIR" setting of the library build in the form "ENGINESDIR: "..."" +if available or "ENGINESDIR: N/A" otherwise. + +=back For an unknown B, the text "not available" is returned. @@ -78,11 +92,6 @@ The version number. =head1 SEE ALSO -L - -=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. +L =cut