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