Various RT doc fixes
[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<-engine id>]
11 [B<-elapsed>]
12 [B<-evp algo>]
13 [B<-decrypt>]
14 [B<md2>]
15 [B<mdc2>]
16 [B<md5>]
17 [B<hmac>]
18 [B<sha1>]
19 [B<rmd160>]
20 [B<idea-cbc>]
21 [B<rc2-cbc>]
22 [B<rc5-cbc>]
23 [B<bf-cbc>]
24 [B<des-cbc>]
25 [B<des-ede3>]
26 [B<rc4>]
27 [B<rsa512>]
28 [B<rsa1024>]
29 [B<rsa2048>]
30 [B<rsa4096>]
31 [B<dsa512>]
32 [B<dsa1024>]
33 [B<dsa2048>]
34 [B<idea>]
35 [B<rc2>]
36 [B<des>]
37 [B<rsa>]
38 [B<blowfish>]
39
40 =head1 DESCRIPTION
41
42 This command is used to test the performance of cryptographic algorithms.
43
44 =head1 OPTIONS
45
46 =over 4
47
48 =item B<-engine id>
49
50 specifying an engine (by its unique B<id> string) will cause B<speed>
51 to attempt to obtain a functional reference to the specified engine,
52 thus initialising it if needed. The engine will then be set as the default
53 for all available algorithms.
54
55 =item B<-elapsed>
56
57 Measure time in real time instead of CPU time. It can be useful when testing
58 speed of hardware engines.
59
60 =item B<-evp algo>
61
62 Use the specified cipher or message digest algorithm via the EVP interface.
63
64 =item B<-decrypt>
65
66 Time the decryption instead of encryption. Affects only the EVP testing.
67
68 =item B<[zero or more test algorithms]>
69
70 If any options are given, B<speed> tests those algorithms, otherwise all of
71 the above are tested.
72
73 =back
74
75 =cut