d6b333bba6f9dffa720ce7332b86776e4036d107
[openssl.git] / doc / apps / speed.pod
1 =pod
2
3 =head1 NAME
4
5 speed - test library performance
6
7 =head1 SYNOPSIS
8
9 B<openssl speed>
10 [B<-help>]
11 [B<-engine id>]
12 [B<-elapsed>]
13 [B<-evp algo>]
14 [B<-decrypt>]
15 [B<md2>]
16 [B<mdc2>]
17 [B<md5>]
18 [B<hmac>]
19 [B<sha1>]
20 [B<rmd160>]
21 [B<idea-cbc>]
22 [B<rc2-cbc>]
23 [B<rc5-cbc>]
24 [B<bf-cbc>]
25 [B<des-cbc>]
26 [B<des-ede3>]
27 [B<rc4>]
28 [B<rsa512>]
29 [B<rsa1024>]
30 [B<rsa2048>]
31 [B<rsa4096>]
32 [B<dsa512>]
33 [B<dsa1024>]
34 [B<dsa2048>]
35 [B<idea>]
36 [B<rc2>]
37 [B<des>]
38 [B<rsa>]
39 [B<blowfish>]
40
41 =head1 DESCRIPTION
42
43 This command is used to test the performance of cryptographic algorithms.
44
45 =head1 OPTIONS
46
47 =over 4
48
49 =item B<-help>
50
51 Print out a usage message.
52
53 =item B<-engine id>
54
55 specifying an engine (by its unique B<id> string) will cause B<speed>
56 to attempt to obtain a functional reference to the specified engine,
57 thus initialising it if needed. The engine will then be set as the default
58 for all available algorithms.
59
60 =item B<-elapsed>
61
62 Measure time in real time instead of CPU time. It can be useful when testing
63 speed of hardware engines.
64
65 =item B<-evp algo>
66
67 Use the specified cipher or message digest algorithm via the EVP interface.
68
69 =item B<-decrypt>
70
71 Time the decryption instead of encryption. Affects only the EVP testing.
72
73 =item B<[zero or more test algorithms]>
74
75 If any options are given, B<speed> tests those algorithms, otherwise all of
76 the above are tested.
77
78 =back
79
80 =cut
81
82 =head1 COPYRIGHT
83
84 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
85
86 Licensed under the OpenSSL license (the "License").  You may not use
87 this file except in compliance with the License.  You can obtain a copy
88 in the file LICENSE in the source distribution or at
89 L<https://www.openssl.org/source/license.html>.
90
91 =cut