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