901a2668dd57a64a1ecfcb05ea8372dd2607f33f
[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
57 =item B<-mac-algorithms>
58
59 Display a list of message authentication code 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
63 =item B<-cipher-commands>
64
65 Display a list of cipher commands, which are typically used as input
66 to the L<dgst(1)> or L<speed(1)> commands.
67
68 =item B<-cipher-algorithms>
69
70 Display a list of cipher 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<-public-key-algorithms>
75
76 Display a list of public key algorithms, with each algorithm as
77 a block of multiple lines, all but the first are indented.
78
79 =item B<-public-key-methods>
80
81 Display a list of public key method OIDs: this also includes public key methods
82 without an associated ASN.1 method, for example, KDF algorithms.
83
84 =item B<-engines>
85
86 Display a list of loaded engines.
87
88 =item B<-disabled>
89
90 Display a list of disabled features, those that were compiled out
91 of the installation.
92
93 =item B<-objects>
94
95 Display a list of built in objects, i.e. OIDs with names.  They're listed in the
96 format described in L<config(5)/ASN1 Object Configuration Module>.
97
98 =back
99
100 =head1 COPYRIGHT
101
102 Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
103
104 Licensed under the Apache License 2.0 (the "License").  You may not use
105 this file except in compliance with the License.  You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 L<https://www.openssl.org/source/license.html>.
108
109 =cut