summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorcvs2svn <cvs2svn>2002-01-04 14:55:39 +0000
committercvs2svn <cvs2svn>2002-01-04 14:55:39 +0000
commitedbbf22a0ed67ac8f5cd1b28770030b2000de49e (patch)
treef5bc419f80f56647124ca87d808fe3d0fd78e997 /doc
parent1cb892350784e386ccc47cde6b04ae60a0524fd1 (diff)
parent4ab1e7ceaf79c2f426ad41f4712afb4621a6473b (diff)
This commit was manufactured by cvs2svn to create branch
'OpenSSL_0_9_6-stable'.
Diffstat (limited to 'doc')
-rw-r--r--doc/crypto/SSLeay_version.pod65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/crypto/SSLeay_version.pod b/doc/crypto/SSLeay_version.pod
new file mode 100644
index 0000000000..6fa5aa109a
--- /dev/null
+++ b/doc/crypto/SSLeay_version.pod
@@ -0,0 +1,65 @@
+=pod
+
+=head1 NAME
+
+SSLeay_version - retrieve version/build information about OpenSSL library
+
+=head1 SYNOPSIS
+
+ #include <openssl/crypto.h>
+
+ const char *SSLeay_version(int type);
+
+=head1 DESCRIPTION
+
+SSLeay_version() returns a pointer to a constant string describing the
+version of the OpenSSL library or giving information about the library
+build.
+
+The following B<type> values are supported:
+
+=over 4
+
+=item SSLEAY_VERSION
+
+The version of the OpenSSL library including the release date.
+
+=item SSLEAY_CFLAGS
+
+The compiler flags set for the compilation process in the form
+"compiler: ..." if available or "compiler: information not available"
+otherwise.
+
+=item SSLEAY_BUILT_ON
+
+The date of the build process in the form "built on: ..." if available
+or "built on: date not available" otherwise.
+
+=item SSLEAY_PLATFORM
+
+The "Configure" target of the library build in the form "platform: ..."
+if available or "platform: information not available" otherwise.
+
+=back
+
+=head1 RETURN VALUES
+
+The following return values can occur:
+
+=over 4
+
+=item "not available"
+
+An invalid value for B<type> was given.
+
+=item Pointer to constant string
+
+Textual description.
+
+=back
+
+=head1 SEE ALSO
+
+L<crypto(3)|crypto(3)>
+
+=cut