[thirdparty/openssl.git] / doc / crypto / OPENSSL_VERSION_NUMBER.pod

=pod

=head1 NAME

OPENSSL_VERSION_NUMBER, OpenSSL_version - get OpenSSL version number

=head1 SYNOPSIS

 #include <openssl/opensslv.h>
 #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL

 #include <openssl/crypto.h>
 const char *OpenSSL_version(int t);

=head1 DESCRIPTION

OPENSSL_VERSION_NUMBER is a numeric release version identifier:

 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.

for example

 0x000906000 == 0.9.6 dev
 0x000906023 == 0.9.6b beta 3
 0x00090605f == 0.9.6e release

Versions prior to 0.9.3 have identifiers E<lt> 0x0930.
Versions between 0.9.3 and 0.9.5 had a version identifier with this
interpretation:

 MMNNFFRBB major minor fix final beta/patch

for example

 0x000904100 == 0.9.4 release
 0x000905000 == 0.9.5 dev

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, OPENSSL_VERSION_NUMBER is also defined.

OpenSSL_version() returns different strings depending on B<t>:

=over 4

=item OPENSSL_VERSION

The text variant of the version number and the release date.  For example,
"OpenSSL 1.0.1a 15 Oct 2015".

=item OPENSSL_CFLAGS

The compiler flags set for the compilation process in the form
"compiler: ..."  if available or "compiler: information not available"
otherwise.

=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.

=item OPENSSL_DIR

The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
if available or "OPENSSLDIR: N/A" otherwise.

=back

For an unknown B<t>, the text "not available" is returned.

=head1 RETURN VALUE

The version number.

=head1 SEE ALSO

L<crypto(3)>

=cut
Commit	Line	Data
9f7b1b24 UM	1	=pod
	2
	3	=head1 NAME
	4
a528d4f0	5	OPENSSL_VERSION_NUMBER, OpenSSL_version - get OpenSSL version number
9f7b1b24 UM	6
	7	=head1 SYNOPSIS
	8
	9	#include <openssl/opensslv.h>
	10	#define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
	11
	12	#include <openssl/crypto.h>
a528d4f0	13	const char *OpenSSL_version(int t);
9f7b1b24 UM	14
	15	=head1 DESCRIPTION
	16
	17	OPENSSL_VERSION_NUMBER is a numeric release version identifier:
	18
9208640a	19	MNNFFPPS: major minor fix patch status
e65c84ab RL	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
9f7b1b24 UM	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
c8973693	41	Version 0.9.5a had an interim interpretation that is like the current one,
e65c84ab RL	42	except the patch level got the highest bit set, to keep continuity. The
	43	number was therefore 0x0090581f.
	44
	45
a528d4f0	46	For backward compatibility, OPENSSL_VERSION_NUMBER is also defined.
9f7b1b24	47
a528d4f0	48	OpenSSL_version() returns different strings depending on B<t>:
e65c84ab RL	49
	50	=over 4
	51
a528d4f0	52	=item OPENSSL_VERSION
dc4ddcd2	53
e65c84ab	54	The text variant of the version number and the release date. For example,
a528d4f0	55	"OpenSSL 1.0.1a 15 Oct 2015".
e65c84ab	56
a528d4f0	57	=item OPENSSL_CFLAGS
dc4ddcd2 BM	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
a528d4f0	63	=item OPENSSL_BUILT_ON
dc4ddcd2 BM	64
	65	The date of the build process in the form "built on: ..." if available
	66	or "built on: date not available" otherwise.
e65c84ab	67
a528d4f0	68	=item OPENSSL_PLATFORM
e65c84ab	69
dc4ddcd2 BM	70	The "Configure" target of the library build in the form "platform: ..."
	71	if available or "platform: information not available" otherwise.
	72
a528d4f0	73	=item OPENSSL_DIR
e65c84ab	74
dc4ddcd2 BM	75	The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
dc4ddcd2 BM	76	if available or "OPENSSLDIR: N/A" otherwise.
e65c84ab	77
dc4ddcd2	78	=back
e65c84ab	79
31cafe53 BM	80	For an unknown B<t>, the text "not available" is returned.
31cafe53 BM	81
9f7b1b24 UM	82	=head1 RETURN VALUE
	83
	84	The version number.
	85
	86	=head1 SEE ALSO
	87
9b86974e	88	L<crypto(3)>
9f7b1b24	89
9f7b1b24	90	=cut