[thirdparty/openssl.git] / doc / man1 / speed.pod

=pod

=head1 NAME

openssl-speed,
speed - test library performance

=head1 SYNOPSIS

B<openssl speed>
[B<-help>]
[B<-engine id>]
[B<-elapsed>]
[B<-evp algo>]
[B<-decrypt>]
[B<-rand file...>]
[B<-writerand file>]
[B<algorithm...>]

=head1 DESCRIPTION

This command is used to test the performance of cryptographic algorithms.
To see the list of supported algorithms, use the I<list --digest-commands>
or I<list --cipher-commands> command. The global CSPRNG is denoted by
the I<rand> algorithm name.

=head1 OPTIONS

=over 4

=item B<-help>

Print out a usage message.

=item B<-engine id>

Specifying an engine (by its unique B<id> string) will cause B<speed>
to attempt to obtain a functional reference to the specified engine,
thus initialising it if needed. The engine will then be set as the default
for all available algorithms.

=item B<-elapsed>

Measure time in real time instead of CPU time. It can be useful when testing
speed of hardware engines.

=item B<-evp algo>

Use the specified cipher or message digest algorithm via the EVP interface.

=item B<-decrypt>

Time the decryption instead of encryption. Affects only the EVP testing.

=item B<-rand file...>

A file or files containing random data used to seed the random number
generator.
Multiple files can be specified separated by an OS-dependent character.
The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
all others.

=item [B<-writerand file>]

Writes random data to the specified I<file> upon exit.
This can be used with a subsequent B<-rand> flag.

=item B<[zero or more test algorithms]>

If any options are given, B<speed> tests those algorithms, otherwise all of
the above are tested.

=back

=head1 COPYRIGHT

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

Licensed under the OpenSSL license (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
b20b78b7 UM	1	=pod
	2
	3	=head1 NAME
	4
3f2181e6	5	openssl-speed,
b20b78b7 UM	6	speed - test library performance
	7
	8	=head1 SYNOPSIS
	9
	10	B<openssl speed>
0ae9e292	11	[B<-help>]
5270e702	12	[B<-engine id>]
a0474357 RS	13	[B<-elapsed>]
	14	[B<-evp algo>]
	15	[B<-decrypt>]
3ee1eac2 RS	16	[B<-rand file...>]
3ee1eac2 RS	17	[B<-writerand file>]
1a627771	18	[B<algorithm...>]
b20b78b7 UM	19
	20	=head1 DESCRIPTION
	21
	22	This command is used to test the performance of cryptographic algorithms.
1a627771	23	To see the list of supported algorithms, use the I<list --digest-commands>
65e6b9a4 PS	24	or I<list --cipher-commands> command. The global CSPRNG is denoted by
65e6b9a4 PS	25	the I<rand> algorithm name.
b20b78b7 UM	26
	27	=head1 OPTIONS
	28
5270e702 RL	29	=over 4
5270e702 RL	30
0ae9e292 RS	31	=item B<-help>
	32
	33	Print out a usage message.
	34
5270e702 RL	35	=item B<-engine id>
5270e702 RL	36
c4de074e	37	Specifying an engine (by its unique B<id> string) will cause B<speed>
5270e702 RL	38	to attempt to obtain a functional reference to the specified engine,
	39	thus initialising it if needed. The engine will then be set as the default
	40	for all available algorithms.
	41
a0474357 RS	42	=item B<-elapsed>
	43
	44	Measure time in real time instead of CPU time. It can be useful when testing
	45	speed of hardware engines.
	46
	47	=item B<-evp algo>
	48
	49	Use the specified cipher or message digest algorithm via the EVP interface.
	50
	51	=item B<-decrypt>
	52
	53	Time the decryption instead of encryption. Affects only the EVP testing.
	54
3ee1eac2 RS	55	=item B<-rand file...>
	56
	57	A file or files containing random data used to seed the random number
	58	generator.
	59	Multiple files can be specified separated by an OS-dependent character.
	60	The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
	61	all others.
	62
	63	=item [B<-writerand file>]
	64
	65	Writes random data to the specified I<file> upon exit.
	66	This can be used with a subsequent B<-rand> flag.
	67
5270e702 RL	68	=item B<[zero or more test algorithms]>
5270e702 RL	69
4c0aee5a	70	If any options are given, B<speed> tests those algorithms, otherwise all of
b20b78b7 UM	71	the above are tested.
b20b78b7 UM	72
eaad02a7 LJ	73	=back
eaad02a7 LJ	74
e2f92610 RS	75	=head1 COPYRIGHT
e2f92610 RS	76
c4de074e	77	Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
e2f92610 RS	78
	79	Licensed under the OpenSSL license (the "License"). You may not use
	80	this file except in compliance with the License. You can obtain a copy
	81	in the file LICENSE in the source distribution or at
	82	L<https://www.openssl.org/source/license.html>.
	83
	84	=cut