apps-cleanup: the doc fixes
[openssl.git] / doc / crypto / SSLeay_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSLeay_version - retrieve version/build information about OpenSSL library
6
7 =head1 SYNOPSIS
8
9  #include <openssl/crypto.h>
10
11  const char *SSLeay_version(int type);
12
13 =head1 DESCRIPTION
14
15 SSLeay_version() returns a pointer to a constant string describing the
16 version of the OpenSSL library or giving information about the library
17 build.
18
19 The following B<type> values are supported:
20
21 =over 4
22
23 =item SSLEAY_VERSION
24
25 The version of the OpenSSL library including the release date.
26
27 =item SSLEAY_CFLAGS
28
29 The compiler flags set for the compilation process in the form
30 "compiler: ..."  if available or "compiler: information not available"
31 otherwise.
32
33 =item SSLEAY_BUILT_ON
34
35 The date of the build process in the form "built on: ..." if available
36 or "built on: date not available" otherwise.
37
38 =item SSLEAY_PLATFORM
39
40 The "Configure" target of the library build in the form "platform: ..."
41 if available or "platform: information not available" otherwise.
42
43 =item SSLEAY_DIR
44
45 The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
46 if available or "OPENSSLDIR: N/A" otherwise.
47
48 =back
49
50 =head1 RETURN VALUES
51
52 The following return values can occur:
53
54 =over 4
55
56 =item "not available"
57
58 An invalid value for B<type> was given.
59
60 =item Pointer to constant string
61
62 Textual description.
63
64 =back
65
66 =head1 SEE ALSO
67
68 L<crypto(3)|crypto(3)>
69
70 =head1 HISTORY
71
72 B<SSLEAY_DIR> was added in OpenSSL 0.9.7.
73
74 =cut