1817b59760d7d6a3232d2f66af690d20be98effd
[openssl.git] / doc / man1 / list.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-list,
6 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<-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<dgst(1)> or L<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 B<foo> is an alias for the
61 official algorithm name, B<bar>.
62 If a line is of the form C<foo @ bar>, then B<foo> is provided by the provider
63 B<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<-mac-algorithms>
69
70 Display a list of message authentication code algorithms.
71 If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
72 official algorithm name, B<bar>.
73
74 =item B<-cipher-commands>
75
76 Display a list of cipher commands, which are typically used as input
77 to the L<dgst(1)> or L<speed(1)> commands.
78
79 =item B<-cipher-algorithms>
80
81 Display a list of cipher algorithms.
82 If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
83 official algorithm name, B<bar>.
84 If a line is of the form C<foo @ bar>, then B<foo> is provided by the provider
85 B<bar>.
86
87 In verbose mode, the algorithms provided by a provider will get additional
88 information on what parameters each implementation supports.
89
90 =item B<-public-key-algorithms>
91
92 Display a list of public key algorithms, with each algorithm as
93 a block of multiple lines, all but the first are indented.
94
95 =item B<-public-key-methods>
96
97 Display a list of public key method OIDs: this also includes public key methods
98 without an associated ASN.1 method, for example, KDF algorithms.
99
100 =item B<-engines>
101
102 Display a list of loaded engines.
103
104 =item B<-disabled>
105
106 Display a list of disabled features, those that were compiled out
107 of the installation.
108
109 =item B<-objects>
110
111 Display a list of built in objects, i.e. OIDs with names.  They're listed in the
112 format described in L<config(5)/ASN1 Object Configuration Module>.
113
114 =back
115
116 =head1 COPYRIGHT
117
118 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
119
120 Licensed under the Apache License 2.0 (the "License").  You may not use
121 this file except in compliance with the License.  You can obtain a copy
122 in the file LICENSE in the source distribution or at
123 L<https://www.openssl.org/source/license.html>.
124
125 =cut