Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libcrypto / man / OPENSSL_VERSION_NUMBER.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
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
e257b235
PA
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-
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 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
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.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
8b0cefbb
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
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
984263bc 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
8b0cefbb
JR
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'
984263bc 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
8b0cefbb 115. \" corrections for vroff
984263bc
MD
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'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
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
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "OPENSSL_VERSION_NUMBER 3"
e257b235
PA
135.TH OPENSSL_VERSION_NUMBER 3 "2009-01-11" "0.9.8j" "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
984263bc 140.SH "NAME"
74dab6c2 141OPENSSL_VERSION_NUMBER, SSLeay, SSLeay_version \- get OpenSSL version number
984263bc 142.SH "SYNOPSIS"
8b0cefbb 143.IX Header "SYNOPSIS"
984263bc
MD
144.Vb 2
145\& #include <openssl/opensslv.h>
146\& #define OPENSSL_VERSION_NUMBER 0xnnnnnnnnnL
e257b235 147\&
984263bc
MD
148\& #include <openssl/crypto.h>
149\& long SSLeay(void);
150\& const char *SSLeay_version(int t);
151.Ve
152.SH "DESCRIPTION"
8b0cefbb
JR
153.IX Header "DESCRIPTION"
154\&\s-1OPENSSL_VERSION_NUMBER\s0 is a numeric release version identifier:
984263bc
MD
155.PP
156.Vb 1
157\& MMNNFFPPS: major minor fix patch status
158.Ve
8b0cefbb 159.PP
984263bc
MD
160The status nibble has one of the values 0 for development, 1 to e for betas
1611 to 14, and f for release.
162.PP
163for 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
8b0cefbb 170.PP
984263bc
MD
171Versions prior to 0.9.3 have identifiers < 0x0930.
172Versions between 0.9.3 and 0.9.5 had a version identifier with this
173interpretation:
174.PP
175.Vb 1
176\& MMNNFFRBB major minor fix final beta/patch
177.Ve
8b0cefbb 178.PP
984263bc
MD
179for example
180.PP
181.Vb 2
182\& 0x000904100 == 0.9.4 release
183\& 0x000905000 == 0.9.5 dev
184.Ve
8b0cefbb 185.PP
984263bc
MD
186Version 0.9.5a had an interim interpretation that is like the current one,
187except the patch level got the highest bit set, to keep continuity. The
188number was therefore 0x0090581f.
189.PP
8b0cefbb 190For backward compatibility, \s-1SSLEAY_VERSION_NUMBER\s0 is also defined.
984263bc 191.PP
8b0cefbb 192\&\fISSLeay()\fR returns this number. The return value can be compared to the
984263bc
MD
193macro to make sure that the correct version of the library has been
194loaded, especially when using DLLs on Windows systems.
195.PP
8b0cefbb
JR
196\&\fISSLeay_version()\fR returns different strings depending on \fBt\fR:
197.IP "\s-1SSLEAY_VERSION\s0" 4
198.IX Item "SSLEAY_VERSION"
984263bc 199The text variant of the version number and the release date. For example,
8b0cefbb
JR
200\&\*(L"OpenSSL 0.9.5a 1 Apr 2000\*(R".
201.IP "\s-1SSLEAY_CFLAGS\s0" 4
202.IX Item "SSLEAY_CFLAGS"
984263bc 203The compiler flags set for the compilation process in the form
8b0cefbb 204\&\*(L"compiler: ...\*(R" if available or \*(L"compiler: information not available\*(R"
984263bc 205otherwise.
8b0cefbb
JR
206.IP "\s-1SSLEAY_BUILT_ON\s0" 4
207.IX Item "SSLEAY_BUILT_ON"
984263bc
MD
208The date of the build process in the form \*(L"built on: ...\*(R" if available
209or \*(L"built on: date not available\*(R" otherwise.
8b0cefbb
JR
210.IP "\s-1SSLEAY_PLATFORM\s0" 4
211.IX Item "SSLEAY_PLATFORM"
984263bc
MD
212The \*(L"Configure\*(R" target of the library build in the form \*(L"platform: ...\*(R"
213if available or \*(L"platform: information not available\*(R" otherwise.
8b0cefbb
JR
214.IP "\s-1SSLEAY_DIR\s0" 4
215.IX Item "SSLEAY_DIR"
216The \*(L"\s-1OPENSSLDIR\s0\*(R" setting of the library build in the form \*(L"\s-1OPENSSLDIR:\s0 \*(R"..."\*(L"
217if available or \*(R"\s-1OPENSSLDIR:\s0 N/A" otherwise.
984263bc
MD
218.PP
219For an unknown \fBt\fR, the text \*(L"not available\*(R" is returned.
220.SH "RETURN VALUE"
8b0cefbb 221.IX Header "RETURN VALUE"
984263bc
MD
222The version number.
223.SH "SEE ALSO"
74dab6c2 224.IX Header "SEE ALSO"
8b0cefbb
JR
225\&\fIcrypto\fR\|(3)
226.SH "HISTORY"
984263bc 227.IX Header "HISTORY"
8b0cefbb
JR
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.