xref: /openssl/doc/man1/openssl-version.pod.in (revision 7ed6de99)
1=pod
2{- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4=head1 NAME
5
6openssl-version - print OpenSSL version information
7
8=head1 SYNOPSIS
9
10B<openssl version>
11[B<-help>]
12[B<-a>]
13[B<-v>]
14[B<-b>]
15[B<-o>]
16[B<-f>]
17[B<-p>]
18[B<-d>]
19[B<-e>]
20[B<-m>]
21[B<-r>]
22[B<-c>]
23[B<-w>]
24
25=head1 DESCRIPTION
26
27This command is used to print out version information about OpenSSL.
28
29=head1 OPTIONS
30
31=over 4
32
33=item B<-help>
34
35Print out a usage message.
36
37=item B<-a>
38
39All information, this is the same as setting all the other flags.
40
41=item B<-v>
42
43The current OpenSSL version.
44
45=item B<-b>
46
47The date the current version of OpenSSL was built.
48
49=item B<-o>
50
51Option information: various options set when the library was built.
52
53=item B<-f>
54
55Compilation flags.
56
57=item B<-p>
58
59Platform setting.
60
61=item B<-d>
62
63OPENSSLDIR setting.
64
65=item B<-e>
66
67ENGINESDIR settings.
68
69=item B<-m>
70
71MODULESDIR settings.
72
73=item B<-r>
74
75The random number generator source settings.
76
77=item B<-c>
78
79The OpenSSL CPU settings info.
80
81=item B<-w>
82
83The OpenSSL B<OSSL_WINCTX> build time variable, if set.
84Used for computing Windows registry key names.  This option is unavailable on
85non-Windows platforms.
86
87=back
88
89=head1 HISTORY
90
91In OpenSSL versions prior to 3.4, OpenSSL had a limitation regarding the
92B<OPENSSLDIR>, B<MODULESDIR> and B<ENGINESDIR> build time macros.  These macros
93were defined at build time, and represented filesystem paths.  This is common
94practice on unix like systems, as there was an expectation that a given build
95would be installed to a pre-determined location.  On Windows however, there is
96no such expectation, as libraries can be installed to arbitrary locations.
97B<OSSL_WINCTX> was introduced as a new build time variable to define a set of
98registry keys identified by the name openssl-<version>-<ctx>, in which the
99<version> value is derived from the version string in the openssl source, and
100the <ctx> extension is derived from the B<OSSL_WINCTX> variable.  The values of
101B<OPENSSLDIR>, B<ENGINESDIR> and B<MODULESDIR> can be set to various paths
102underneath this key to break the requirement to predict the installation path at
103build time.
104
105=head1 NOTES
106
107The output of C<openssl version -a> would typically be used when sending
108in a bug report.
109
110=head1 COPYRIGHT
111
112Copyright 2000-2024 The OpenSSL Project Authors. All Rights Reserved.
113
114Licensed under the Apache License 2.0 (the "License").  You may not use
115this file except in compliance with the License.  You can obtain a copy
116in the file LICENSE in the source distribution or at
117L<https://www.openssl.org/source/license.html>.
118
119=cut
120