Command docs: more reference fixes
[openssl.git] / doc / man1 / openssl-list.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-list - list algorithms and features
6
7 =head1 SYNOPSIS
8
9 B<openssl list>
10 [B<-help>]
11 [B<-verbose>]
12 [B<-1>]
13 [B<-commands>]
14 [B<-digest-commands>]
15 [B<-digest-algorithms>]
16 [B<-kdf-algorithms>]
17 [B<-mac-algorithms>]
18 [B<-cipher-commands>]
19 [B<-cipher-algorithms>]
20 [B<-public-key-algorithms>]
21 [B<-public-key-methods>]
22 [B<-engines>]
23 [B<-disabled>]
24
25 =head1 DESCRIPTION
26
27 This command is used to generate list of algorithms or disabled
28 features.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-help>
35
36 Display a usage message.
37
38 =item B<-verbose>
39
40 Displays extra information.
41 The options below where verbosity applies say a bit more about what that means.
42
43 =item B<-1>
44
45 List the commands, digest-commands, or cipher-commands in a single column.
46 If used, this option must be given first.
47
48 =item B<-commands>
49
50 Display a list of standard commands.
51
52 =item B<-digest-commands>
53
54 Display a list of message digest commands, which are typically used
55 as input to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
56
57 =item B<-digest-algorithms>
58
59 Display a list of message digest algorithms.
60 If a line is of the form C<foo =E<gt> bar> then C<foo> is an alias for the
61 official algorithm name, C<bar>.
62 If a line is of the form C<foo @ bar>, then C<foo> is provided by the provider
63 C<bar>.
64
65 In verbose mode, the algorithms provided by a provider will get additional
66 information on what parameters each implementation supports.
67
68 =item B<-kdf-algorithms>
69
70 Display a list of key derivation function algorithms.
71
72 =item B<-mac-algorithms>
73
74 Display a list of message authentication code algorithms.
75
76 =item B<-cipher-commands>
77
78 Display a list of cipher commands, which are typically used as input
79 to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
80
81 =item B<-cipher-algorithms>
82
83 Display a list of cipher algorithms.
84 If a line is of the form C<foo =E<gt> bar> then C<foo> is an alias for the
85 official algorithm name, B<bar>.
86 If a line is of the form C<foo @ bar>, then C<foo> is provided by the provider
87 C<bar>.
88
89 In verbose mode, the algorithms provided by a provider will get additional
90 information on what parameters each implementation supports.
91
92 =item B<-public-key-algorithms>
93
94 Display a list of public key algorithms, with each algorithm as
95 a block of multiple lines, all but the first are indented.
96
97 =item B<-public-key-methods>
98
99 Display a list of public key method OIDs.
100
101 =item B<-engines>
102
103 Display a list of loaded engines.
104
105 =item B<-disabled>
106
107 Display a list of disabled features, those that were compiled out
108 of the installation.
109
110 =item B<-objects>
111
112 Display a list of built in objects, i.e. OIDs with names.  They're listed in the
113 format described in L<config(5)/ASN1 Object Configuration Module>.
114
115 =back
116
117 =head1 COPYRIGHT
118
119 Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
120
121 Licensed under the Apache License 2.0 (the "License").  You may not use
122 this file except in compliance with the License.  You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 L<https://www.openssl.org/source/license.html>.
125
126 =cut