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