secure/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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 "2018-03-27" "1.0.2o" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version \- get OpenSSL version number
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 2
 142 \& #include <openssl/opensslv.h>
 143 \& #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
 144 \&
 145 \& #include <openssl/crypto.h>
 146 \& long SSLeay(void);
 147 \& const char *SSLeay_version(int t);
 148 .Ve
 149 .SH "DESCRIPTION"
 150 .IX Header "DESCRIPTION"
 151 \&\s-1OPENSSL_VERSION_NUMBER\s0 is a numeric release version identifier:
 152 .PP
 153 .Vb 1
 154 \& MNNFFPPS: major minor fix patch status
 155 .Ve
 156 .PP
 157 The status nibble has one of the values 0 for development, 1 to e for betas
 158 1 to 14, and f for release.
 159 .PP
 160 for example
 161 .PP
 162 .Vb 3
 163 \& 0x000906000 == 0.9.6 dev
 164 \& 0x000906023 == 0.9.6b beta 3
 165 \& 0x00090605f == 0.9.6e release
 166 .Ve
 167 .PP
 168 Versions prior to 0.9.3 have identifiers < 0x0930.
 169 Versions between 0.9.3 and 0.9.5 had a version identifier with this
 170 interpretation:
 171 .PP
 172 .Vb 1
 173 \& MMNNFFRBB major minor fix final beta/patch
 174 .Ve
 175 .PP
 176 for example
 177 .PP
 178 .Vb 2
 179 \& 0x000904100 == 0.9.4 release
 180 \& 0x000905000 == 0.9.5 dev
 181 .Ve
 182 .PP
 183 Version 0.9.5a had an interim interpretation that is like the current one,
 184 except the patch level got the highest bit set, to keep continuity.  The
 185 number was therefore 0x0090581f.
 186 .PP
 187 For backward compatibility, \s-1SSLEAY_VERSION_NUMBER\s0 is also defined.
 188 .PP
 189 \&\fISSLeay()\fR returns this number. The return value can be compared to the
 190 macro to make sure that the correct version of the library has been
 191 loaded, especially when using DLLs on Windows systems.
 192 .PP
 193 \&\fISSLeay_version()\fR returns different strings depending on \fBt\fR:
 194 .IP "\s-1SSLEAY_VERSION\s0" 4
 195 .IX Item "SSLEAY_VERSION"
 196 The text variant of the version number and the release date.  For example,
 197 \&\*(L"OpenSSL 0.9.5a 1 Apr 2000\*(R".
 198 .IP "\s-1SSLEAY_CFLAGS\s0" 4
 199 .IX Item "SSLEAY_CFLAGS"
 200 The compiler flags set for the compilation process in the form
 201 \&\*(L"compiler: ...\*(R"  if available or \*(L"compiler: information not available\*(R"
 202 otherwise.
 203 .IP "\s-1SSLEAY_BUILT_ON\s0" 4
 204 .IX Item "SSLEAY_BUILT_ON"
 205 The date of the build process in the form \*(L"built on: ...\*(R" if available
 206 or \*(L"built on: date not available\*(R" otherwise.
 207 .IP "\s-1SSLEAY_PLATFORM\s0" 4
 208 .IX Item "SSLEAY_PLATFORM"
 209 The \*(L"Configure\*(R" target of the library build in the form \*(L"platform: ...\*(R"
 210 if available or \*(L"platform: information not available\*(R" otherwise.
 211 .IP "\s-1SSLEAY_DIR\s0" 4
 212 .IX Item "SSLEAY_DIR"
 213 The \*(L"\s-1OPENSSLDIR\*(R"\s0 setting of the library build in the form \*(L"\s-1OPENSSLDIR: \*(R"..."\*(L"\s0
 214 if available or \*(R"\s-1OPENSSLDIR: N/A"\s0 otherwise.
 215 .PP
 216 For an unknown \fBt\fR, the text \*(L"not available\*(R" is returned.
 217 .SH "RETURN VALUE"
 218 .IX Header "RETURN VALUE"
 219 The version number.
 220 .SH "SEE ALSO"
 221 .IX Header "SEE ALSO"
 222 \&\fIcrypto\fR\|(3)
 223 .SH "HISTORY"
 224 .IX Header "HISTORY"
 225 \&\fISSLeay()\fR and \s-1SSLEAY_VERSION_NUMBER\s0 are available in all versions of SSLeay and OpenSSL.
 226 \&\s-1OPENSSL_VERSION_NUMBER\s0 is available in all versions of OpenSSL.
 227 \&\fB\s-1SSLEAY_DIR\s0\fR was added in OpenSSL 0.9.7.