d44d40cfec489c07568aa53d96ae858e3a0643ac
[openssl.git] / doc / man1 / openssl-cmds.pod
1 =pod
2
3 =head1 NAME
4
5 =for openssl names: openssl-cmds
6
7 asn1parse,
8 ca,
9 ciphers,
10 cms,
11 crl,
12 crl2pkcs7,
13 dgst,
14 dhparam,
15 dsa,
16 dsaparam,
17 ec,
18 ecparam,
19 enc,
20 engine,
21 errstr,
22 gendsa,
23 genpkey,
24 genrsa,
25 info,
26 kdf,
27 mac,
28 nseq,
29 ocsp,
30 passwd,
31 pkcs12,
32 pkcs7,
33 pkcs8,
34 pkey,
35 pkeyparam,
36 pkeyutl,
37 prime,
38 rand,
39 rehash,
40 req,
41 rsa,
42 rsautl,
43 s_client,
44 s_server,
45 s_time,
46 sess_id,
47 smime,
48 speed,
49 spkac,
50 srp,
51 storeutl,
52 ts,
53 verify,
54 version,
55 x509
56 - OpenSSL application commands
57
58 =for openssl foreign manual apropos(1)
59
60 =head1 SYNOPSIS
61
62 =for openssl generic
63
64 B<openssl> I<cmd> B<-help> | [I<-option> | I<-option> I<arg>] ... [I<arg>] ...
65
66 =head1 DESCRIPTION
67
68 Every I<cmd> listed above is a (sub-)command of the L<openssl(1)> application.
69 It has its own detailed manual page at B<openssl-I<cmd>>(1). For example, to
70 view the manual page for the B<openssl dgst> command, type C<man openssl-dgst>.
71
72 =head1 OPTIONS
73
74 Among others, every subcommand has a help option.
75
76 =over 4
77
78 =item B<-help>
79
80 Print out a usage message for the subcommand.
81
82 =back
83
84 =head1 SEE ALSO
85
86 L<openssl(1)>,
87 L<openssl-asn1parse(1)>,
88 L<openssl-ca(1)>,
89 L<openssl-ciphers(1)>,
90 L<openssl-cms(1)>,
91 L<openssl-crl(1)>,
92 L<openssl-crl2pkcs7(1)>,
93 L<openssl-dgst(1)>,
94 L<openssl-dhparam(1)>,
95 L<openssl-dsa(1)>,
96 L<openssl-dsaparam(1)>,
97 L<openssl-ec(1)>,
98 L<openssl-ecparam(1)>,
99 L<openssl-enc(1)>,
100 L<openssl-engine(1)>,
101 L<openssl-errstr(1)>,
102 L<openssl-gendsa(1)>,
103 L<openssl-genpkey(1)>,
104 L<openssl-genrsa(1)>,
105 L<openssl-info(1)>,
106 L<openssl-kdf(1)>,
107 L<openssl-mac(1)>,
108 L<openssl-nseq(1)>,
109 L<openssl-ocsp(1)>,
110 L<openssl-passwd(1)>,
111 L<openssl-pkcs12(1)>,
112 L<openssl-pkcs7(1)>,
113 L<openssl-pkcs8(1)>,
114 L<openssl-pkey(1)>,
115 L<openssl-pkeyparam(1)>,
116 L<openssl-pkeyutl(1)>,
117 L<openssl-prime(1)>,
118 L<openssl-rand(1)>,
119 L<openssl-rehash(1)>,
120 L<openssl-req(1)>,
121 L<openssl-rsa(1)>,
122 L<openssl-rsautl(1)>,
123 L<openssl-s_client(1)>,
124 L<openssl-s_server(1)>,
125 L<openssl-s_time(1)>,
126 L<openssl-sess_id(1)>,
127 L<openssl-smime(1)>,
128 L<openssl-speed(1)>,
129 L<openssl-spkac(1)>,
130 L<openssl-srp(1)>,
131 L<openssl-storeutl(1)>,
132 L<openssl-ts(1)>,
133 L<openssl-verify(1)>,
134 L<openssl-version(1)>,
135 L<openssl-x509(1)>,
136
137 =head1 HISTORY
138
139 =for openssl foreign manual apropos(1)
140
141 Initially, the manual page entry for the C<openssl I<cmd>> command used
142 to be available at I<cmd>(1). Later, the alias B<openssl-I<cmd>>(1) was
143 introduced, which made it easier to group the openssl commands using
144 the L<apropos(1)> command or the shell's tab completion.
145
146 In order to reduce cluttering of the global manual page namespace,
147 the manual page entries without the 'openssl-' prefix have been
148 deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0.
149
150 =head1 COPYRIGHT
151
152 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
153
154 Licensed under the Apache License 2.0 (the "License").  You may not use
155 this file except in compliance with the License.  You can obtain a copy
156 in the file LICENSE in the source distribution or at
157 L<https://www.openssl.org/source/license.html>.
158
159 =cut