secure/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "OPENSSL_VERSION_NUMBER 3"
 132 .TH OPENSSL_VERSION_NUMBER 3 "2006-09-06" "0.9.8c" "OpenSSL"
 133 .SH "NAME"
 134 OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version \- get OpenSSL version number
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 2
 138 \& #include <openssl/opensslv.h>
 139 \& #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
 140 .Ve
 141 .PP
 142 .Vb 3
 143 \& #include <openssl/crypto.h>
 144 \& long SSLeay(void);
 145 \& const char *SSLeay_version(int t);
 146 .Ve
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 \&\s-1OPENSSL_VERSION_NUMBER\s0 is a numeric release version identifier:
 150 .PP
 151 .Vb 1
 152 \& MMNNFFPPS: major minor fix patch status
 153 .Ve
 154 .PP
 155 The status nibble has one of the values 0 for development, 1 to e for betas
 156 1 to 14, and f for release.
 157 .PP
 158 for example
 159 .PP
 160 .Vb 3
 161 \& 0x000906000 == 0.9.6 dev
 162 \& 0x000906023 == 0.9.6b beta 3
 163 \& 0x00090605f == 0.9.6e release
 164 .Ve
 165 .PP
 166 Versions prior to 0.9.3 have identifiers < 0x0930.
 167 Versions between 0.9.3 and 0.9.5 had a version identifier with this
 168 interpretation:
 169 .PP
 170 .Vb 1
 171 \& MMNNFFRBB major minor fix final beta/patch
 172 .Ve
 173 .PP
 174 for example
 175 .PP
 176 .Vb 2
 177 \& 0x000904100 == 0.9.4 release
 178 \& 0x000905000 == 0.9.5 dev
 179 .Ve
 180 .PP
 181 Version 0.9.5a had an interim interpretation that is like the current one,
 182 except the patch level got the highest bit set, to keep continuity.  The
 183 number was therefore 0x0090581f.
 184 .PP
 185 For backward compatibility, \s-1SSLEAY_VERSION_NUMBER\s0 is also defined.
 186 .PP
 187 \&\fISSLeay()\fR returns this number. The return value can be compared to the
 188 macro to make sure that the correct version of the library has been
 189 loaded, especially when using DLLs on Windows systems.
 190 .PP
 191 \&\fISSLeay_version()\fR returns different strings depending on \fBt\fR:
 192 .IP "\s-1SSLEAY_VERSION\s0" 4
 193 .IX Item "SSLEAY_VERSION"
 194 The text variant of the version number and the release date.  For example,
 195 \&\*(L"OpenSSL 0.9.5a 1 Apr 2000\*(R".
 196 .IP "\s-1SSLEAY_CFLAGS\s0" 4
 197 .IX Item "SSLEAY_CFLAGS"
 198 The compiler flags set for the compilation process in the form
 199 \&\*(L"compiler: ...\*(R"  if available or \*(L"compiler: information not available\*(R"
 200 otherwise.
 201 .IP "\s-1SSLEAY_BUILT_ON\s0" 4
 202 .IX Item "SSLEAY_BUILT_ON"
 203 The date of the build process in the form \*(L"built on: ...\*(R" if available
 204 or \*(L"built on: date not available\*(R" otherwise.
 205 .IP "\s-1SSLEAY_PLATFORM\s0" 4
 206 .IX Item "SSLEAY_PLATFORM"
 207 The \*(L"Configure\*(R" target of the library build in the form \*(L"platform: ...\*(R"
 208 if available or \*(L"platform: information not available\*(R" otherwise.
 209 .IP "\s-1SSLEAY_DIR\s0" 4
 210 .IX Item "SSLEAY_DIR"
 211 The \*(L"\s-1OPENSSLDIR\s0\*(R" setting of the library build in the form \*(L"\s-1OPENSSLDIR:\s0 \*(R"..."\*(L"
 212 if available or \*(R"\s-1OPENSSLDIR:\s0 N/A" otherwise.
 213 .PP
 214 For an unknown \fBt\fR, the text \*(L"not available\*(R" is returned.
 215 .SH "RETURN VALUE"
 216 .IX Header "RETURN VALUE"
 217 The version number.
 218 .SH "SEE ALSO"
 219 .IX Header "SEE ALSO"
 220 \&\fIcrypto\fR\|(3)
 221 .SH "HISTORY"
 222 .IX Header "HISTORY"
 223 \&\fISSLeay()\fR and \s-1SSLEAY_VERSION_NUMBER\s0 are available in all versions of SSLeay and OpenSSL.
 224 \&\s-1OPENSSL_VERSION_NUMBER\s0 is available in all versions of OpenSSL.
 225 \&\fB\s-1SSLEAY_DIR\s0\fR was added in OpenSSL 0.9.7.