Re-implement the cipher and digest listings for 'openssl list'
[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<-1>]
13 [B<-commands>]
14 [B<-digest-commands>]
15 [B<-digest-algorithms>]
16 [B<-mac-algorithms>]
17 [B<-cipher-commands>]
18 [B<-cipher-algorithms>]
19 [B<-public-key-algorithms>]
20 [B<-public-key-methods>]
21 [B<-engines>]
22 [B<-disabled>]
23
24 =head1 DESCRIPTION
25
26 This command is used to generate list of algorithms or disabled
27 features.
28
29 =head1 OPTIONS
30
31 =over 4
32
33 =item B<-help>
34
35 Display a usage message.
36
37 =item B<-1>
38
39 List the commands, digest-commands, or cipher-commands in a single column.
40 If used, this option must be given first.
41
42 =item B<-commands>
43
44 Display a list of standard commands.
45
46 =item B<-digest-commands>
47
48 Display a list of message digest commands, which are typically used
49 as input to the L<dgst(1)> or L<speed(1)> commands.
50
51 =item B<-digest-algorithms>
52
53 Display a list of message digest algorithms.
54 If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
55 official algorithm name, B<bar>.
56 If a line is of the form C<foo @ bar>, then B<foo> is provided by the provider
57 B<bar>.
58
59 =item B<-mac-algorithms>
60
61 Display a list of message authentication code algorithms.
62 If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
63 official algorithm name, B<bar>.
64
65 =item B<-cipher-commands>
66
67 Display a list of cipher commands, which are typically used as input
68 to the L<dgst(1)> or L<speed(1)> commands.
69
70 =item B<-cipher-algorithms>
71
72 Display a list of cipher algorithms.
73 If a line is of the form C<foo =E<gt> bar> then B<foo> is an alias for the
74 official algorithm name, B<bar>.
75 If a line is of the form C<foo @ bar>, then B<foo> is provided by the provider
76 B<bar>.
77
78 =item B<-public-key-algorithms>
79
80 Display a list of public key algorithms, with each algorithm as
81 a block of multiple lines, all but the first are indented.
82
83 =item B<-public-key-methods>
84
85 Display a list of public key method OIDs: this also includes public key methods
86 without an associated ASN.1 method, for example, KDF algorithms.
87
88 =item B<-engines>
89
90 Display a list of loaded engines.
91
92 =item B<-disabled>
93
94 Display a list of disabled features, those that were compiled out
95 of the installation.
96
97 =item B<-objects>
98
99 Display a list of built in objects, i.e. OIDs with names.  They're listed in the
100 format described in L<config(5)/ASN1 Object Configuration Module>.
101
102 =back
103
104 =head1 COPYRIGHT
105
106 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
107
108 Licensed under the Apache License 2.0 (the "License").  You may not use
109 this file except in compliance with the License.  You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 L<https://www.openssl.org/source/license.html>.
112
113 =cut