[thirdparty/openssl.git] / doc / man1 / openssl-info.pod

=pod

=head1 NAME

openssl-info - print OpenSSL built-in information

=head1 SYNOPSIS

B<openssl info>
[B<-help>]
[B<-configdir> | B<-c>]
[B<-enginesdir> | B<-e>]
[B<-modulesdir> | B<-m>]
[B<-dsoext>]
[B<-dirfilesep>]
[B<-listsep]>

=head1 DESCRIPTION

This command is used to print out information about OpenSSL.
The information is written exactly as it is with no extra text, which
makes useful for scripts.

As a consequence, only one item may be chosen for each run of this
command.

=head1 OPTIONS

=over 4

=item B<-help>

Print out a usage message.

=item B<-configdir>, B<-c>

Outputs the default directory for OpenSSL configuration files.

=item B<-enginesdir>, B<-e>

Outputs the default directory for OpenSSL engine modules.

=item B<-modulesdir>, B<-m>

Outputs the default directory for OpenSSL dynamically loadable modules
other than engine modules.

=item B<-dsoext>

Outputs the DSO extension OpenSSL uses.

=item B<-dirnamesep>

Outputs the separator character between a directory specification and
a file name.
Note that on some operating systems, this is not the same as the
separator between directory elements.

=item B<-listsep>

Outputs the OpenSSL list separator character.
This is typically used to construct C<$PATH> (C<%PATH%> on Windows)
style lists.

=back

=head1 HISTORY

The B<openssl info> command was added in OpenSSL 3.0.

=head1 COPYRIGHT

Copyright 2019 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
Commit	Line	Data
0109e030 RL	1	=pod
	2
	3	=head1 NAME
	4
b6b66573	5	openssl-info - print OpenSSL built-in information
0109e030 RL	6
	7	=head1 SYNOPSIS
	8
	9	B<openssl info>
	10	[B<-help>]
	11	[B<-configdir> \| B<-c>]
	12	[B<-enginesdir> \| B<-e>]
	13	[B<-modulesdir> \| B<-m>]
	14	[B<-dsoext>]
	15	[B<-dirfilesep>]
	16	[B<-listsep]>
	17
	18	=head1 DESCRIPTION
	19
	20	This command is used to print out information about OpenSSL.
	21	The information is written exactly as it is with no extra text, which
	22	makes useful for scripts.
	23
	24	As a consequence, only one item may be chosen for each run of this
	25	command.
	26
	27	=head1 OPTIONS
	28
	29	=over 4
	30
	31	=item B<-help>
	32
	33	Print out a usage message.
	34
	35	=item B<-configdir>, B<-c>
	36
	37	Outputs the default directory for OpenSSL configuration files.
	38
	39	=item B<-enginesdir>, B<-e>
	40
	41	Outputs the default directory for OpenSSL engine modules.
	42
	43	=item B<-modulesdir>, B<-m>
	44
	45	Outputs the default directory for OpenSSL dynamically loadable modules
	46	other than engine modules.
	47
	48	=item B<-dsoext>
	49
	50	Outputs the DSO extension OpenSSL uses.
	51
	52	=item B<-dirnamesep>
	53
	54	Outputs the separator character between a directory specification and
	55	a file name.
	56	Note that on some operating systems, this is not the same as the
	57	separator between directory elements.
	58
	59	=item B<-listsep>
	60
	61	Outputs the OpenSSL list separator character.
	62	This is typically used to construct C<$PATH> (C<%PATH%> on Windows)
	63	style lists.
	64
	65	=back
	66
	67	=head1 HISTORY
	68
	69	The B<openssl info> command was added in OpenSSL 3.0.
70
71	=head1 COPYRIGHT
72
73	Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
74
75	Licensed under the Apache License 2.0 (the "License"). You may not use
76	this file except in compliance with the License. You can obtain a copy
77	in the file LICENSE in the source distribution or at
78	L<https://www.openssl.org/source/license.html>.
79
80	=cut