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