RT4194: Restore old engine parameter parsing.
[openssl.git] / doc / apps / engine.pod
1
2 =pod
3
4 =head1 NAME
5
6 engine - load and query engines
7
8 =head1 SYNOPSIS
9
10 B<openssl engine>
11 [ I<engine...> ]
12 [B<-v>]
13 [B<-vv>]
14 [B<-vvv>]
15 [B<-vvv>]
16 [B<-vvv>]
17 [B<-c>]
18 [B<-t>]
19 [B<-tt>]
20 [B<-pre> I<command>]
21 [B<-post> I<command>]
22 [ I<engine...> ]
23
24 =head1 DESCRIPTION
25
26 The B<engine> command is used to query the status and capabilities
27 of the specified B<engine>'s.
28 Engines may be speicifed before and after all other command-line flags.
29 Only those specified are queried.
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-v> B<-vv> B<-vvv> B<-vvvv>
36
37 Provides information about each specified engine. The first flag lists
38 all the possible run-time control commands; the second adds a
39 description of each command; the third adds the input flags, and the
40 final option adds the internal input flags.
41
42 =item B<-c>
43
44 Lists the capabilities of each engine.
45
46 =item B<-t>
47
48 Tests if each specified engine is available, and displays the answer.
49
50 =item B<-tt>
51
52 Displays an error trace for any unavailable engine.
53
54 =item B<-pre> I<command>
55 =item B<-post> I<command>
56
57 Command-line configuration of engines.
58 The B<-pre> command is given to the engine before it is loaded and
59 the B<-post> command is given after the engine is loaded.
60 The I<command> is of the form I<cmd:val> where I<cmd> is the command,
61 and I<val> is the value for the command.
62 See the example below.
63
64 =back
65
66 =head1 EXAMPLE
67
68 To list all the commands available to a dynamic engine:
69
70  % openssl engine -t -tt -vvvv dynamic
71  (dynamic) Dynamic engine loading support
72       [ unavailable ]
73       SO_PATH: Specifies the path to the new ENGINE shared library
74            (input flags): STRING
75       NO_VCHECK: Specifies to continue even if version checking fails (boolean)
76            (input flags): NUMERIC
77       ID: Specifies an ENGINE id name for loading
78            (input flags): STRING
79       LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
80            (input flags): NUMERIC
81       DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)
82            (input flags): NUMERIC
83       DIR_ADD: Adds a directory from which ENGINEs can be loaded
84            (input flags): STRING
85       LOAD: Load up the ENGINE specified by other settings
86            (input flags): NO_INPUT
87
88 To list the capabilities of the I<rsax> engine:
89
90  % openssl engine -c
91  (rsax) RSAX engine support
92   [RSA]
93  (dynamic) Dynamic engine loading support
94
95 =cut