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