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