secure/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

   1 .rn '' }`
   2 ''' $RCSfile$$Revision$$Date$
   3 '''
   4 ''' $Log$
   5 '''
   6 .de Sh
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve
  30 .ft R
  31
  32 .fi
  33 ..
  34 '''
  35 '''
  36 '''     Set up \*(-- to give an unbreakable dash;
  37 '''     string Tr holds user defined translation string.
  38 '''     Bell System Logo is used as a dummy character.
  39 '''
  40 .tr \(*W-|\(bv\*(Tr
  41 .ie n \{\
  42 .ds -- \(*W-
  43 .ds PI pi
  44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  46 .ds L" ""
  47 .ds R" ""
  48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
  49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
  50 '''   such as .IP and .SH, which do another additional levels of
  51 '''   double-quote interpretation
  52 .ds M" """
  53 .ds S" """
  54 .ds N" """""
  55 .ds T" """""
  56 .ds L' '
  57 .ds R' '
  58 .ds M' '
  59 .ds S' '
  60 .ds N' '
  61 .ds T' '
  62 'br\}
  63 .el\{\
  64 .ds -- \(em\|
  65 .tr \*(Tr
  66 .ds L" ``
  67 .ds R" ''
  68 .ds M" ``
  69 .ds S" ''
  70 .ds N" ``
  71 .ds T" ''
  72 .ds L' `
  73 .ds R' '
  74 .ds M' `
  75 .ds S' '
  76 .ds N' `
  77 .ds T' '
  78 .ds PI \(*p
  79 'br\}
  80 .\"     If the F register is turned on, we'll generate
  81 .\"     index entries out stderr for the following things:
  82 .\"             TH      Title
  83 .\"             SH      Header
  84 .\"             Sh      Subsection
  85 .\"             Ip      Item
  86 .\"             X<>     Xref  (embedded
  87 .\"     Of course, you have to process the output yourself
  88 .\"     in some meaninful fashion.
  89 .if \nF \{
  90 .de IX
  91 .tm Index:\\$1\t\\n%\t"\\$2"
  92 ..
  93 .nr % 0
  94 .rr F
  95 .\}
  96 .TH OPENSSL_VERSION_NUMBER 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
  97 .UC
  98 .if n .hy 0
  99 .if n .na
 100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 101 .de CQ          \" put $1 in typewriter font
 102 .ft CW
 103 'if n "\c
 104 'if t \\&\\$1\c
 105 'if n \\&\\$1\c
 106 'if n \&"
 107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
 108 '.ft R
 109 ..
 110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
 111 .       \" AM - accent mark definitions
 112 .bd B 3
 113 .       \" fudge factors for nroff and troff
 114 .if n \{\
 115 .       ds #H 0
 116 .       ds #V .8m
 117 .       ds #F .3m
 118 .       ds #[ \f1
 119 .       ds #] \fP
 120 .\}
 121 .if t \{\
 122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 123 .       ds #V .6m
 124 .       ds #F 0
 125 .       ds #[ \&
 126 .       ds #] \&
 127 .\}
 128 .       \" simple accents for nroff and troff
 129 .if n \{\
 130 .       ds ' \&
 131 .       ds ` \&
 132 .       ds ^ \&
 133 .       ds , \&
 134 .       ds ~ ~
 135 .       ds ? ?
 136 .       ds ! !
 137 .       ds /
 138 .       ds q
 139 .\}
 140 .if t \{\
 141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
 147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
 148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
 150 .\}
 151 .       \" troff and (daisy-wheel) nroff accents
 152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
 155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
 156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
 157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
 158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 163 .ds ae a\h'-(\w'a'u*4/10)'e
 164 .ds Ae A\h'-(\w'A'u*4/10)'E
 165 .ds oe o\h'-(\w'o'u*4/10)'e
 166 .ds Oe O\h'-(\w'O'u*4/10)'E
 167 .       \" corrections for vroff
 168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 170 .       \" for low resolution devices (crt and lpr)
 171 .if \n(.H>23 .if \n(.V>19 \
 172 \{\
 173 .       ds : e
 174 .       ds 8 ss
 175 .       ds v \h'-1'\o'\(aa\(ga'
 176 .       ds _ \h'-1'^
 177 .       ds . \h'-1'.
 178 .       ds 3 3
 179 .       ds o a
 180 .       ds d- d\h'-1'\(ga
 181 .       ds D- D\h'-1'\(hy
 182 .       ds th \o'bp'
 183 .       ds Th \o'LP'
 184 .       ds ae ae
 185 .       ds Ae AE
 186 .       ds oe oe
 187 .       ds Oe OE
 188 .\}
 189 .rm #[ #] #H #V #F C
 190 .SH "NAME"
 191 OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version \- get OpenSSL version number
 192 .SH "SYNOPSIS"
 193 .PP
 194 .Vb 2
 195 \& #include <openssl/opensslv.h>
 196 \& #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
 197 .Ve
 198 .Vb 3
 199 \& #include <openssl/crypto.h>
 200 \& long SSLeay(void);
 201 \& const char *SSLeay_version(int t);
 202 .Ve
 203 .SH "DESCRIPTION"
 204 OPENSSL_VERSION_NUMBER is a numeric release version identifier:
 205 .PP
 206 .Vb 1
 207 \& MMNNFFPPS: major minor fix patch status
 208 .Ve
 209 The status nibble has one of the values 0 for development, 1 to e for betas
 210 1 to 14, and f for release.
 211 .PP
 212 for example
 213 .PP
 214 .Vb 3
 215 \& 0x000906000 == 0.9.6 dev
 216 \& 0x000906023 == 0.9.6b beta 3
 217 \& 0x00090605f == 0.9.6e release
 218 .Ve
 219 Versions prior to 0.9.3 have identifiers < 0x0930.
 220 Versions between 0.9.3 and 0.9.5 had a version identifier with this
 221 interpretation:
 222 .PP
 223 .Vb 1
 224 \& MMNNFFRBB major minor fix final beta/patch
 225 .Ve
 226 for example
 227 .PP
 228 .Vb 2
 229 \& 0x000904100 == 0.9.4 release
 230 \& 0x000905000 == 0.9.5 dev
 231 .Ve
 232 Version 0.9.5a had an interim interpretation that is like the current one,
 233 except the patch level got the highest bit set, to keep continuity.  The
 234 number was therefore 0x0090581f.
 235 .PP
 236 For backward compatibility, SSLEAY_VERSION_NUMBER is also defined.
 237 .PP
 238 \fISSLeay()\fR returns this number. The return value can be compared to the
 239 macro to make sure that the correct version of the library has been
 240 loaded, especially when using DLLs on Windows systems.
 241 .PP
 242 \fISSLeay_version()\fR returns different strings depending on \fBt\fR:
 243 .Ip "\s-1SSLEAY_VERSION\s0" 4
 244 The text variant of the version number and the release date.  For example,
 245 \*(L"OpenSSL 0.9.5a 1 Apr 2000\*(R".
 246 .Ip "\s-1SSLEAY_CFLAGS\s0" 4
 247 The compiler flags set for the compilation process in the form
 248 \*(L"compiler: ...\*(R"  if available or \*(L"compiler: information not available\*(R"
 249 otherwise.
 250 .Ip "\s-1SSLEAY_BUILT_ON\s0" 4
 251 The date of the build process in the form \*(L"built on: ...\*(R" if available
 252 or \*(L"built on: date not available\*(R" otherwise.
 253 .Ip "\s-1SSLEAY_PLATFORM\s0" 4
 254 The \*(L"Configure\*(R" target of the library build in the form \*(L"platform: ...\*(R"
 255 if available or \*(L"platform: information not available\*(R" otherwise.
 256 .Ip "\s-1SSLEAY_DIR\s0" 4
 257 The "\s-1OPENSSLDIR\s0" setting of the library build in the form "\s-1OPENSSLDIR\s0: "...""
 258 if available or "\s-1OPENSSLDIR\s0: N/A" otherwise.
 259 .PP
 260 For an unknown \fBt\fR, the text \*(L"not available\*(R" is returned.
 261 .SH "RETURN VALUE"
 262 The version number.
 263 .SH "SEE ALSO"
 264 crypto(3)
 265 .SH "HISTORY"
 266 \fISSLeay()\fR and SSLEAY_VERSION_NUMBER are available in all versions of SSLeay and OpenSSL.
 267 OPENSSL_VERSION_NUMBER is available in all versions of OpenSSL.
 268 \fBSSLEAY_DIR\fR was added in OpenSSL 0.9.7.
 269
 270 .rn }` ''
 271 .IX Title "OPENSSL_VERSION_NUMBER 3"
 272 .IX Name "OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version - get OpenSSL version number"
 273
 274 .IX Header "NAME"
 275
 276 .IX Header "SYNOPSIS"
 277
 278 .IX Header "DESCRIPTION"
 279
 280 .IX Item "\s-1SSLEAY_VERSION\s0"
 281
 282 .IX Item "\s-1SSLEAY_CFLAGS\s0"
 283
 284 .IX Item "\s-1SSLEAY_BUILT_ON\s0"
 285
 286 .IX Item "\s-1SSLEAY_PLATFORM\s0"
 287
 288 .IX Item "\s-1SSLEAY_DIR\s0"
 289
 290 .IX Header "RETURN VALUE"
 291
 292 .IX Header "SEE ALSO"
 293
 294 .IX Header "HISTORY"
 295