Merge from vendor branch OPENSSL:
[dragonfly.git] / secure / usr.bin / openssl / man / crl.1
1 .\" Automatically generated by Pod::Man version 1.15
2 .\" Wed Feb 19 16:49:31 2003
3 .\"
4 .\" Standard preamble:
5 .\" ======================================================================
6 .de Sh \" Subsection heading
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp \" Vertical space (when we can't use .PP)
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip \" List item
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb \" Begin verbatim text
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve \" End verbatim text
30 .ft R
31
32 .fi
33 ..
34 .\" Set up some character translations and predefined strings.  \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote.  | will give a
37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
40 .tr \(*W-|\(bv\*(Tr
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
42 .ie n \{\
43 .    ds -- \(*W-
44 .    ds PI pi
45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
47 .    ds L" ""
48 .    ds R" ""
49 .    ds C` ""
50 .    ds C' ""
51 'br\}
52 .el\{\
53 .    ds -- \|\(em\|
54 .    ds PI \(*p
55 .    ds L" ``
56 .    ds R" ''
57 'br\}
58 .\"
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
63 .if \nF \{\
64 .    de IX
65 .    tm Index:\\$1\t\\n%\t"\\$2"
66 ..
67 .    nr % 0
68 .    rr F
69 .\}
70 .\"
71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
73 .hy 0
74 .if n .na
75 .\"
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
78 .bd B 3
79 .    \" fudge factors for nroff and troff
80 .if n \{\
81 .    ds #H 0
82 .    ds #V .8m
83 .    ds #F .3m
84 .    ds #[ \f1
85 .    ds #] \fP
86 .\}
87 .if t \{\
88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 .    ds #V .6m
90 .    ds #F 0
91 .    ds #[ \&
92 .    ds #] \&
93 .\}
94 .    \" simple accents for nroff and troff
95 .if n \{\
96 .    ds ' \&
97 .    ds ` \&
98 .    ds ^ \&
99 .    ds , \&
100 .    ds ~ ~
101 .    ds /
102 .\}
103 .if t \{\
104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
110 .\}
111 .    \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 .    \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 .    \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
126 \{\
127 .    ds : e
128 .    ds 8 ss
129 .    ds o a
130 .    ds d- d\h'-1'\(ga
131 .    ds D- D\h'-1'\(hy
132 .    ds th \o'bp'
133 .    ds Th \o'LP'
134 .    ds ae ae
135 .    ds Ae AE
136 .\}
137 .rm #[ #] #H #V #F C
138 .\" ======================================================================
139 .\"
140 .IX Title "CRL 1"
141 .TH CRL 1 "0.9.7a" "2003-02-19" "OpenSSL"
142 .UC
143 .SH "NAME"
144 crl \- \s-1CRL\s0 utility
145 .SH "SYNOPSIS"
146 .IX Header "SYNOPSIS"
147 \&\fBopenssl\fR \fBcrl\fR
148 [\fB\-inform PEM|DER\fR]
149 [\fB\-outform PEM|DER\fR]
150 [\fB\-text\fR]
151 [\fB\-in filename\fR]
152 [\fB\-out filename\fR]
153 [\fB\-noout\fR]
154 [\fB\-hash\fR]
155 [\fB\-issuer\fR]
156 [\fB\-lastupdate\fR]
157 [\fB\-nextupdate\fR]
158 [\fB\-CAfile file\fR]
159 [\fB\-CApath dir\fR]
160 .SH "DESCRIPTION"
161 .IX Header "DESCRIPTION"
162 The \fBcrl\fR command processes \s-1CRL\s0 files in \s-1DER\s0 or \s-1PEM\s0 format.
163 .SH "COMMAND OPTIONS"
164 .IX Header "COMMAND OPTIONS"
165 .Ip "\fB\-inform DER|PEM\fR" 4
166 .IX Item "-inform DER|PEM"
167 This specifies the input format. \fB\s-1DER\s0\fR format is \s-1DER\s0 encoded \s-1CRL\s0
168 structure. \fB\s-1PEM\s0\fR (the default) is a base64 encoded version of
169 the \s-1DER\s0 form with header and footer lines.
170 .Ip "\fB\-outform DER|PEM\fR" 4
171 .IX Item "-outform DER|PEM"
172 This specifies the output format, the options have the same meaning as the 
173 \&\fB\-inform\fR option.
174 .Ip "\fB\-in filename\fR" 4
175 .IX Item "-in filename"
176 This specifies the input filename to read from or standard input if this
177 option is not specified.
178 .Ip "\fB\-out filename\fR" 4
179 .IX Item "-out filename"
180 specifies the output filename to write to or standard output by
181 default.
182 .Ip "\fB\-text\fR" 4
183 .IX Item "-text"
184 print out the \s-1CRL\s0 in text form.
185 .Ip "\fB\-noout\fR" 4
186 .IX Item "-noout"
187 don't output the encoded version of the \s-1CRL\s0.
188 .Ip "\fB\-hash\fR" 4
189 .IX Item "-hash"
190 output a hash of the issuer name. This can be use to lookup CRLs in
191 a directory by issuer name.
192 .Ip "\fB\-issuer\fR" 4
193 .IX Item "-issuer"
194 output the issuer name.
195 .Ip "\fB\-lastupdate\fR" 4
196 .IX Item "-lastupdate"
197 output the lastUpdate field.
198 .Ip "\fB\-nextupdate\fR" 4
199 .IX Item "-nextupdate"
200 output the nextUpdate field.
201 .Ip "\fB\-CAfile file\fR" 4
202 .IX Item "-CAfile file"
203 verify the signature on a \s-1CRL\s0 by looking up the issuing certificate in
204 \&\fBfile\fR
205 .Ip "\fB\-CApath dir\fR" 4
206 .IX Item "-CApath dir"
207 verify the signature on a \s-1CRL\s0 by looking up the issuing certificate in
208 \&\fBdir\fR. This directory must be a standard certificate directory: that
209 is a hash of each subject name (using \fBx509 \-hash\fR) should be linked
210 to each certificate.
211 .SH "NOTES"
212 .IX Header "NOTES"
213 The \s-1PEM\s0 \s-1CRL\s0 format uses the header and footer lines:
214 .PP
215 .Vb 2
216 \& -----BEGIN X509 CRL-----
217 \& -----END X509 CRL-----
218 .Ve
219 .SH "EXAMPLES"
220 .IX Header "EXAMPLES"
221 Convert a \s-1CRL\s0 file from \s-1PEM\s0 to \s-1DER:\s0
222 .PP
223 .Vb 1
224 \& openssl crl -in crl.pem -outform DER -out crl.der
225 .Ve
226 Output the text form of a \s-1DER\s0 encoded certificate:
227 .PP
228 .Vb 1
229 \& openssl crl -in crl.der -text -noout
230 .Ve
231 .SH "BUGS"
232 .IX Header "BUGS"
233 Ideally it should be possible to create a \s-1CRL\s0 using appropriate options
234 and files too.
235 .SH "SEE ALSO"
236 .IX Header "SEE ALSO"
237 crl2pkcs7(1), ca(1), x509(1)