Command docs: diverse small fixes
[openssl.git] / doc / man1 / openssl-engine.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-engine - load and query engines
6
7 =head1 SYNOPSIS
8
9 B<openssl engine>
10 [B<-v>]
11 [B<-vv>]
12 [B<-vvv>]
13 [B<-vvvv>]
14 [B<-c>]
15 [B<-t>]
16 [B<-tt>]
17 [B<-pre> I<command>] ...
18 [B<-post> I<command>] ...
19 [I<engine> ...]
20
21 =head1 DESCRIPTION
22
23 This command is used to query the status and capabilities
24 of the specified I<engine>s.
25 Engines may be specified before and after all other command-line flags.
26 Only those specified are queried.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-v> B<-vv> B<-vvv> B<-vvvv>
33
34 Provides information about each specified engine. The first flag lists
35 all the possible run-time control commands; the second adds a
36 description of each command; the third adds the input flags, and the
37 final option adds the internal input flags.
38
39 =item B<-c>
40
41 Lists the capabilities of each engine.
42
43 =item B<-t>
44
45 Tests if each specified engine is available, and displays the answer.
46
47 =item B<-tt>
48
49 Displays an error trace for any unavailable engine.
50
51 =item B<-pre> I<command>
52
53 =item B<-post> I<command>
54
55 Command-line configuration of engines.
56 The B<-pre> command is given to the engine before it is loaded and
57 the B<-post> command is given after the engine is loaded.
58 The I<command> is of the form I<cmd>:I<val> where I<cmd> is the command,
59 and I<val> is the value for the command.
60 See the example below.
61
62 These two options are cumulative, so they may be given more than once in the
63 same command.
64
65 =back
66
67 =head1 EXAMPLES
68
69 To list all the commands available to a dynamic engine:
70
71  $ openssl engine -t -tt -vvvv dynamic
72  (dynamic) Dynamic engine loading support
73       [ unavailable ]
74       SO_PATH: Specifies the path to the new ENGINE shared library
75            (input flags): STRING
76       NO_VCHECK: Specifies to continue even if version checking fails (boolean)
77            (input flags): NUMERIC
78       ID: Specifies an ENGINE id name for loading
79            (input flags): STRING
80       LIST_ADD: Whether to add a loaded ENGINE to the internal list (0=no,1=yes,2=mandatory)
81            (input flags): NUMERIC
82       DIR_LOAD: Specifies whether to load from 'DIR_ADD' directories (0=no,1=yes,2=mandatory)
83            (input flags): NUMERIC
84       DIR_ADD: Adds a directory from which ENGINEs can be loaded
85            (input flags): STRING
86       LOAD: Load up the ENGINE specified by other settings
87            (input flags): NO_INPUT
88
89 To list the capabilities of the B<rsax> engine:
90
91  $ openssl engine -c
92  (rsax) RSAX engine support
93   [RSA]
94  (dynamic) Dynamic engine loading support
95
96 =head1 ENVIRONMENT
97
98 =over 4
99
100 =item B<OPENSSL_ENGINES>
101
102 The path to the engines directory.
103
104 =back
105
106 =head1 SEE ALSO
107
108 L<openssl(1)>,
109 L<config(5)>
110
111 =head1 COPYRIGHT
112
113 Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
114
115 Licensed under the Apache License 2.0 (the "License").  You may not use
116 this file except in compliance with the License.  You can obtain a copy
117 in the file LICENSE in the source distribution or at
118 L<https://www.openssl.org/source/license.html>.
119
120 =cut