secure/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

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