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