SSLeay_version.pod 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. =pod
  2. =head1 NAME
  3. SSLeay_version - retrieve version/build information about OpenSSL library
  4. =head1 SYNOPSIS
  5. #include <openssl/crypto.h>
  6. const char *SSLeay_version(int type);
  7. =head1 DESCRIPTION
  8. SSLeay_version() returns a pointer to a constant string describing the
  9. version of the OpenSSL library or giving information about the library
  10. build.
  11. The following B<type> values are supported:
  12. =over 4
  13. =item SSLEAY_VERSION
  14. The version of the OpenSSL library including the release date.
  15. =item SSLEAY_CFLAGS
  16. The compiler flags set for the compilation process in the form
  17. "compiler: ..." if available or "compiler: information not available"
  18. otherwise.
  19. =item SSLEAY_BUILT_ON
  20. The date of the build process in the form "built on: ..." if available
  21. or "built on: date not available" otherwise.
  22. =item SSLEAY_PLATFORM
  23. The "Configure" target of the library build in the form "platform: ..."
  24. if available or "platform: information not available" otherwise.
  25. =item SSLEAY_DIR
  26. The "OPENSSLDIR" setting of the library build in the form "OPENSSLDIR: "...""
  27. if available or "OPENSSLDIR: N/A" otherwise.
  28. =back
  29. =head1 RETURN VALUES
  30. The following return values can occur:
  31. =over 4
  32. =item "not available"
  33. An invalid value for B<type> was given.
  34. =item Pointer to constant string
  35. Textual description.
  36. =back
  37. =head1 SEE ALSO
  38. L<crypto(3)|crypto(3)>
  39. =head1 HISTORY
  40. B<SSLEAY_DIR> was added in OpenSSL 0.9.7.
  41. =cut