crypto/external/bsd/openssl/lib/libcrypto/man/OPENSSL_VERSION_NUMBER.3

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