d7e062bf014de665a1f883ad27428999d9496033
[openssl.git] / doc / man1 / openssl-list.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-list - list algorithms and features
7
8 =head1 SYNOPSIS
9
10 B<openssl list>
11 [B<-help>]
12 [B<-verbose>]
13 [B<-1>]
14 [B<-commands>]
15 [B<-digest-commands>]
16 [B<-digest-algorithms>]
17 [B<-kdf-algorithms>]
18 [B<-mac-algorithms>]
19 [B<-cipher-commands>]
20 [B<-cipher-algorithms>]
21 [B<-public-key-algorithms>]
22 [B<-public-key-methods>]
23 [B<-engines>]
24 [B<-disabled>]
25 [B<-objects>]
26 [B<-options> I<command>]
27 {- $OpenSSL::safe::opt_provider_synopsis -}
28
29 =head1 DESCRIPTION
30
31 This command is used to generate list of algorithms or disabled
32 features.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-help>
39
40 Display a usage message.
41
42 =item B<-verbose>
43
44 Displays extra information.
45 The options below where verbosity applies say a bit more about what that means.
46
47 =item B<-1>
48
49 List the commands, digest-commands, or cipher-commands in a single column.
50 If used, this option must be given first.
51
52 =item B<-commands>
53
54 Display a list of standard commands.
55
56 =item B<-digest-commands>
57
58 Display a list of message digest commands, which are typically used
59 as input to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
60
61 =item B<-cipher-commands>
62
63 Display a list of cipher commands, which are typically used as input
64 to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
65
66 =item B<-digest-algorithms>, B<-kdf-algorithms>, B<-mac-algorithms>,
67 B<-cipher-algorithms>
68
69 Display a list of cipher, digest, kdf and mac algorithms.
70 See L</Display of algorithm names> for a description of how names are
71 displayed.
72
73 In verbose mode, the algorithms provided by a provider will get additional
74 information on what parameters each implementation supports.
75
76 =item B<-public-key-algorithms>
77
78 Display a list of public key algorithms, with each algorithm as
79 a block of multiple lines, all but the first are indented.
80
81 =item B<-public-key-methods>
82
83 Display a list of public key method OIDs.
84
85 =item B<-engines>
86
87 Display a list of loaded engines.
88
89 =item B<-disabled>
90
91 Display a list of disabled features, those that were compiled out
92 of the installation.
93
94 =item B<-objects>
95
96 Display a list of built in objects, i.e. OIDs with names.  They're listed in the
97 format described in L<config(5)/ASN1 Object Configuration Module>.
98
99 =item B<-options> I<command>
100
101 Output a two-column list of the options accepted by the specified I<command>.
102 The first is the option name, and the second is a one-character indication
103 of what type of parameter it takes, if any.
104 This is an internal option, used for checking that the documentation
105 is complete.
106
107 {- $OpenSSL::safe::opt_provider_item -}
108
109 =back
110
111 =head2 Display of algorithm names
112
113 Algorithm names may be displayed in one of two manners:
114
115 =over 4
116
117 =item Legacy implementations
118
119 Legacy implementations will simply display the main name of the
120 algorithm on a line of its own, or in the form C<<foo > bar>> to show
121 that C<foo> is an alias for the main name, C<bar>
122
123 =item Provided implementations
124
125 Implementations from a provider are displayed like this if the
126 implementation is labeled with a single name:
127
128  foo @ bar
129
130 or like this if it's labeled with multiple names:
131
132  { foo1, foo2 } @bar
133
134 In both cases, C<bar> is the name of the provider.
135
136 =back
137
138 =head1 COPYRIGHT
139
140 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
141
142 Licensed under the Apache License 2.0 (the "License").  You may not use
143 this file except in compliance with the License.  You can obtain a copy
144 in the file LICENSE in the source distribution or at
145 L<https://www.openssl.org/source/license.html>.
146
147 =cut