summaryrefslogtreecommitdiffstats
path: root/doc/man1/openssl-version.pod.in
blob: dcfd60b9c343bbca323f24ca5727e5263086163c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
=pod
{- OpenSSL::safe::output_do_not_edit_headers(); -}

=head1 NAME

openssl-version - print OpenSSL version information

=head1 SYNOPSIS

B<openssl version>
[B<-help>]
[B<-a>]
[B<-v>]
[B<-b>]
[B<-o>]
[B<-f>]
[B<-p>]
[B<-d>]
[B<-e>]
[B<-m>]
[B<-r>]
[B<-c>]
[B<-w>]

=head1 DESCRIPTION

This command is used to print out version information about OpenSSL.

=head1 OPTIONS

=over 4

=item B<-help>

Print out a usage message.

=item B<-a>

All information, this is the same as setting all the other flags.

=item B<-v>

The current OpenSSL version.

=item B<-b>

The date the current version of OpenSSL was built.

=item B<-o>

Option information: various options set when the library was built.

=item B<-f>

Compilation flags.

=item B<-p>

Platform setting.

=item B<-d>

OPENSSLDIR setting.

=item B<-e>

ENGINESDIR settings.

=item B<-m>

MODULESDIR settings.

=item B<-r>

The random number generator source settings.

=item B<-c>

The OpenSSL CPU settings info.

=item B<-w>

The OpenSSL B<OSSL_WINCTX> build time variable, if set.
Used for computing Windows registry key names.  This option is unavailable on
non-Windows platforms.

=back

=head1 HISTORY

In OpenSSL versions prior to 3.4, OpenSSL had a limitation regarding the
B<OPENSSLDIR>, B<MODULESDIR> and B<ENGINESDIR> build time macros.  These macros
were defined at build time, and represented filesystem paths.  This is common
practice on unix like systems, as there was an expectation that a given build
would be installed to a pre-determined location.  On Windows however, there is
no such expectation, as libraries can be installed to arbitrary locations.
B<OSSL_WINCTX> was introduced as a new build time variable to define a set of
registry keys identified by the name openssl-<version>-<ctx>, in which the
<version> value is derived from the version string in the openssl source, and
the <ctx> extension is derived from the B<OSSL_WINCTX> variable.  The values of
B<OPENSSLDIR>, B<ENGINESDIR> and B<MODULESDIR> can be set to various paths
underneath this key to break the requirement to predict the installation path at
build time.

=head1 NOTES

The output of C<openssl version -a> would typically be used when sending
in a bug report.

=head1 COPYRIGHT

Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut