secure/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

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