diff options
author | Bodo Möller <bodo@openssl.org> | 2002-01-04 15:17:09 +0000 |
---|---|---|
committer | Bodo Möller <bodo@openssl.org> | 2002-01-04 15:17:09 +0000 |
commit | dc4ddcd2bb8c20f711b1aad9a79cbcaf6d53cccd (patch) | |
tree | 9d4a25906c915e09ce9ae51f13925593da602d59 /doc | |
parent | 5256b021f3f41396763cb4a93653460a396f393e (diff) |
add documentation for SSLeay_version(SSLEAY_DIR) and
'openssl version -d'
use some descriptions from Lutz' redundant manual page
instead of the previous ones
Diffstat (limited to 'doc')
-rw-r--r-- | doc/apps/version.pod | 8 | ||||
-rw-r--r-- | doc/crypto/OPENSSL_VERSION_NUMBER.pod | 25 | ||||
-rw-r--r-- | doc/crypto/SSLeay_version.pod | 74 |
3 files changed, 100 insertions, 7 deletions
diff --git a/doc/apps/version.pod b/doc/apps/version.pod index 5d261a6405..e00324c446 100644 --- a/doc/apps/version.pod +++ b/doc/apps/version.pod @@ -46,6 +46,10 @@ compilation flags. platform setting. +=item B<-d> + +OPENSSLDIR setting. + =back =head1 NOTES @@ -53,4 +57,8 @@ platform setting. The output of B<openssl version -a> would typically be used when sending in a bug report. +=head1 HISTORY + +The B<-d> option was added in OpenSSL 0.9.7. + =cut diff --git a/doc/crypto/OPENSSL_VERSION_NUMBER.pod b/doc/crypto/OPENSSL_VERSION_NUMBER.pod index 6ee8ad634f..7a468003e9 100644 --- a/doc/crypto/OPENSSL_VERSION_NUMBER.pod +++ b/doc/crypto/OPENSSL_VERSION_NUMBER.pod @@ -55,22 +55,32 @@ SSLeay_version() returns different strings depending on B<t>: =over 4 =item SSLEAY_VERSION + The text variant of the version number and the release date. For example, "OpenSSL 0.9.5a 1 Apr 2000". =item SSLEAY_CFLAGS -The flags given to the C compiler when compiling OpenSSL are returned in a -string. + +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 platform name used when OpenSSL was configured is returned. -=back +The "Configure" target of the library build in the form "platform: ..." +if available or "platform: information not available" otherwise. + +=item SSLEAY_DIR -If the data request isn't available, a text saying that the information is -not available is returned. +The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "..."" +if available or "OPENSSLDIR: N/A" otherwise. -For an unknown B<t>, the text "not available" is returned. +=back =head1 RETURN VALUE @@ -84,5 +94,6 @@ L<crypto(3)|crypto(3)> SSLeay() and SSLEAY_VERSION_NUMBER are available in all versions of SSLeay and OpenSSL. OPENSSL_VERSION_NUMBER is available in all versions of OpenSSL. +B<SSLEAY_DIR> was added in OpenSSL 0.9.7. =cut diff --git a/doc/crypto/SSLeay_version.pod b/doc/crypto/SSLeay_version.pod new file mode 100644 index 0000000000..1500c2af91 --- /dev/null +++ b/doc/crypto/SSLeay_version.pod @@ -0,0 +1,74 @@ +=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. + +=item SSLEAY_DIR + +The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "..."" +if available or "OPENSSLDIR: N/A" 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)> + +=head1 HISTORY + +B<SSLEAY_DIR> was added in OpenSSL 0.9.7. + +=cut |