Fix typo in flag name
[openssl.git] / doc / man1 / openssl-crl.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-crl - CRL utility
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<crl>
10 [B<-help>]
11 [B<-inform> B<DER>|B<PEM>]
12 [B<-outform> B<DER>|B<PEM>]
13 [B<-text>]
14 [B<-in> I<filename>]
15 [B<-out> I<filename>]
16 [B<-nameopt> I<option>]
17 [B<-noout>]
18 [B<-hash>]
19 [B<-issuer>]
20 [B<-lastupdate>]
21 [B<-nextupdate>]
22 [B<-CAfile> I<file>]
23 [B<-CApath> I<dir>]
24
25 =for comment ifdef hash_old
26
27 =head1 DESCRIPTION
28
29 The B<crl> command processes CRL files in DER or PEM format.
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-help>
36
37 Print out a usage message.
38
39 =item B<-inform> B<DER>|B<PEM>
40
41 This specifies the input format. B<DER> format is DER encoded CRL
42 structure. B<PEM> (the default) is a base64 encoded version of
43 the DER form with header and footer lines.
44
45 =item B<-outform> B<DER>|B<PEM>
46
47 This specifies the output format, the options have the same meaning and default
48 as the B<-inform> option.
49
50 =item B<-in> I<filename>
51
52 This specifies the input filename to read from or standard input if this
53 option is not specified.
54
55 =item B<-out> I<filename>
56
57 Specifies the output filename to write to or standard output by
58 default.
59
60 =item B<-text>
61
62 Print out the CRL in text form.
63
64 =item B<-nameopt> I<option>
65
66 Option which determines how the subject or issuer names are displayed. See
67 the description of B<-nameopt> in L<x509(1)>.
68
69 =item B<-noout>
70
71 Don't output the encoded version of the CRL.
72
73 =item B<-hash>
74
75 Output a hash of the issuer name. This can be use to lookup CRLs in
76 a directory by issuer name.
77
78 =item B<-hash_old>
79
80 Outputs the "hash" of the CRL issuer name using the older algorithm
81 as used by OpenSSL before version 1.0.0.
82
83 =item B<-issuer>
84
85 Output the issuer name.
86
87 =item B<-lastupdate>
88
89 Output the lastUpdate field.
90
91 =item B<-nextupdate>
92
93 Output the nextUpdate field.
94
95 =item B<-CAfile> I<file>
96
97 Verify the signature on a CRL by looking up the issuing certificate in
98 B<file>.
99
100 =item B<-CApath> I<dir>
101
102 Verify the signature on a CRL by looking up the issuing certificate in
103 B<dir>. This directory must be a standard certificate directory: that
104 is a hash of each subject name (using B<x509 -hash>) should be linked
105 to each certificate.
106
107 =back
108
109 =head1 NOTES
110
111 The PEM CRL format uses the header and footer lines:
112
113  -----BEGIN X509 CRL-----
114  -----END X509 CRL-----
115
116 =head1 EXAMPLES
117
118 Convert a CRL file from PEM to DER:
119
120  openssl crl -in crl.pem -outform DER -out crl.der
121
122 Output the text form of a DER encoded certificate:
123
124  openssl crl -in crl.der -inform DER -text -noout
125
126 =head1 BUGS
127
128 Ideally it should be possible to create a CRL using appropriate options
129 and files too.
130
131 =head1 SEE ALSO
132
133 L<openssl(1)>,
134 L<openssl-crl2pkcs7(1)>,
135 L<openssl-ca(1)>,
136 L<openssl-x509(1)>
137
138 =head1 COPYRIGHT
139
140 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
141
142 Licensed under the Apache License 2.0 (the "License").  You may not use
143 this file except in compliance with the License.  You can obtain a copy
144 in the file LICENSE in the source distribution or at
145 L<https://www.openssl.org/source/license.html>.
146
147 =cut