Commit 7a6d121e authored by Daniel Bevenius's avatar Daniel Bevenius Committed by Richard Levitte
Browse files

Document OPENSSL_VERSION_TEXT macro 



This commit documents the OPENSSL_VERSION_TEXT which is currently
missing in the man page.

Reviewed-by: default avatarTim Hudson <tjh@openssl.org>
Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/7301)

(cherry picked from commit 7c694957)
parent 459b128a

doc/crypto/OPENSSL_VERSION_NUMBER.pod

+7 −2
Original line number Diff line number Diff line
@@ -2,12 +2,14 @@ 


=head1 NAME



OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version - get OpenSSL version number

OPENSSL_VERSION_NUMBER, OPENSSL_VERSION_TEXT, SSLeay, SSLeay_version

- get OpenSSL version number



=head1 SYNOPSIS



 #include <openssl/opensslv.h>

 #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL

 #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"



 #include <openssl/crypto.h>

 long SSLeay(void);
@@ -43,9 +45,12 @@ 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.





For backward compatibility, SSLEAY_VERSION_NUMBER is also defined.



OPENSSL_VERSION_TEXT is the text variant of the version number and the

release date.  For example,

"OpenSSL 1.0.1a 15 Oct 2015".



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.