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