secure/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

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