man1: make all openssl command line tool documentation generated.
[openssl.git] / doc / man1 / openssl-list.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-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<-kdf-algorithms>]
18 [B<-mac-algorithms>]
19 [B<-cipher-commands>]
20 [B<-cipher-algorithms>]
21 [B<-public-key-algorithms>]
22 [B<-public-key-methods>]
23 [B<-engines>]
24 [B<-disabled>]
25 [B<-objects>]
26 [B<-options> I<command>]
27
28 =head1 DESCRIPTION
29
30 This command is used to generate list of algorithms or disabled
31 features.
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item B<-help>
38
39 Display a usage message.
40
41 =item B<-verbose>
42
43 Displays extra information.
44 The options below where verbosity applies say a bit more about what that means.
45
46 =item B<-1>
47
48 List the commands, digest-commands, or cipher-commands in a single column.
49 If used, this option must be given first.
50
51 =item B<-commands>
52
53 Display a list of standard commands.
54
55 =item B<-digest-commands>
56
57 Display a list of message digest commands, which are typically used
58 as input to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
59
60 =item B<-cipher-commands>
61
62 Display a list of cipher commands, which are typically used as input
63 to the L<openssl-dgst(1)> or L<openssl-speed(1)> commands.
64
65 =item B<-digest-algorithms>, B<-kdf-algorithms>, B<-mac-algorithms>,
66 B<-cipher-algorithms>
67
68 Display a list of cipher, digest, kdf and mac algorithms.
69 See L</Display of algorithm names> for a description of how names are
70 displayed.
71
72 In verbose mode, the algorithms provided by a provider will get additional
73 information on what parameters each implementation supports.
74
75 =item B<-public-key-algorithms>
76
77 Display a list of public key algorithms, with each algorithm as
78 a block of multiple lines, all but the first are indented.
79
80 =item B<-public-key-methods>
81
82 Display a list of public key method OIDs.
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 =item B<-options> I<command>
99
100 Output a two-column list of the options accepted by the specified I<command>.
101 The first is the option name, and the second is a one-character indication
102 of what type of parameter it takes, if any.
103 This is an internal option, used for checking that the documentation
104 is complete.
105
106 =back
107
108 =head2 Display of algorithm names
109
110 Algorithm names may be displayed in one of two manners:
111
112 =over 4
113
114 =item Legacy implementations
115
116 Legacy implementations will simply display the main name of the
117 algorithm on a line of its own, or in the form C<<foo > bar>> to show
118 that C<foo> is an alias for the main name, C<bar>
119
120 =item Provided implementations
121
122 Implementations from a provider are displayed like this if the
123 implementation is labeled with a single name:
124
125  foo @ bar
126
127 or like this if it's labeled with multiple names:
128
129  { foo1, foo2 } @bar
130
131 In both cases, C<bar> is the name of the provider.
132
133 =back
134
135 =head1 COPYRIGHT
136
137 Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
138
139 Licensed under the Apache License 2.0 (the "License").  You may not use
140 this file except in compliance with the License.  You can obtain a copy
141 in the file LICENSE in the source distribution or at
142 L<https://www.openssl.org/source/license.html>.
143
144 =cut