secure/lib/libcrypto/man/man3/OPENSSL_VERSION_NUMBER.3

   1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.41)
   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 .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 "2020-12-08" "1.1.1i" "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, OPENSSL_VERSION_TEXT, OpenSSL_version, OpenSSL_version_num \- get OpenSSL version number
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 3
 146 \& #include <openssl/opensslv.h>
 147 \& #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
 148 \& #define OPENSSL_VERSION_TEXT "OpenSSL x.y.z xx XXX xxxx"
 149 \&
 150 \& #include <openssl/crypto.h>
 151 \&
 152 \& unsigned long OpenSSL_version_num();
 153 \& const char *OpenSSL_version(int t);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\s-1OPENSSL_VERSION_NUMBER\s0 is a numeric release version identifier:
 158 .PP
 159 .Vb 1
 160 \& MNNFFPPS: major minor fix patch status
 161 .Ve
 162 .PP
 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 .PP
 174 Versions prior to 0.9.3 have identifiers < 0x0930.
 175 Versions between 0.9.3 and 0.9.5 had a version identifier with this
 176 interpretation:
 177 .PP
 178 .Vb 1
 179 \& MMNNFFRBB major minor fix final beta/patch
 180 .Ve
 181 .PP
 182 for example
 183 .PP
 184 .Vb 2
 185 \& 0x000904100 == 0.9.4 release
 186 \& 0x000905000 == 0.9.5 dev
 187 .Ve
 188 .PP
 189 Version 0.9.5a had an interim interpretation that is like the current one,
 190 except the patch level got the highest bit set, to keep continuity.  The
 191 number was therefore 0x0090581f.
 192 .PP
 193 \&\s-1OPENSSL_VERSION_TEXT\s0 is the text variant of the version number and the
 194 release date.  For example,
 195 \&\*(L"OpenSSL 1.0.1a 15 Oct 2015\*(R".
 196 .PP
 197 \&\fBOpenSSL_version_num()\fR returns the version number.
 198 .PP
 199 \&\fBOpenSSL_version()\fR returns different strings depending on \fBt\fR:
 200 .IP "\s-1OPENSSL_VERSION\s0" 4
 201 .IX Item "OPENSSL_VERSION"
 202 The text variant of the version number and the release date.  For example,
 203 \&\*(L"OpenSSL 1.0.1a 15 Oct 2015\*(R".
 204 .IP "\s-1OPENSSL_CFLAGS\s0" 4
 205 .IX Item "OPENSSL_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-1OPENSSL_BUILT_ON\s0" 4
 210 .IX Item "OPENSSL_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-1OPENSSL_PLATFORM\s0" 4
 214 .IX Item "OPENSSL_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-1OPENSSL_DIR\s0" 4
 218 .IX Item "OPENSSL_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 .IP "\s-1OPENSSL_ENGINES_DIR\s0" 4
 222 .IX Item "OPENSSL_ENGINES_DIR"
 223 The \*(L"\s-1ENGINESDIR\*(R"\s0 setting of the library build in the form \*(L"\s-1ENGINESDIR: \*(R"..."\*(L"\s0
 224 if available or \*(R"\s-1ENGINESDIR: N/A"\s0 otherwise.
 225 .PP
 226 For an unknown \fBt\fR, the text \*(L"not available\*(R" is returned.
 227 .SH "RETURN VALUES"
 228 .IX Header "RETURN VALUES"
 229 \&\fBOpenSSL_version_num()\fR returns the version number.
 230 .PP
 231 \&\fBOpenSSL_version()\fR returns requested version strings.
 232 .SH "SEE ALSO"
 233 .IX Header "SEE ALSO"
 234 \&\fBcrypto\fR\|(7)
 235 .SH "COPYRIGHT"
 236 .IX Header "COPYRIGHT"
 237 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 238 .PP
 239 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 240 this file except in compliance with the License.  You can obtain a copy
 241 in the file \s-1LICENSE\s0 in the source distribution or at
 242 <https://www.openssl.org/source/license.html>.