Refactor -engine documentation
[openssl.git] / doc / man1 / openssl-pkcs7.pod.in
1 =pod
2
3 =begin comment
4 {- join("\n", @autowarntext) -}
5
6 =end comment
7
8 =head1 NAME
9
10 openssl-pkcs7 - PKCS#7 utility
11
12 =head1 SYNOPSIS
13
14 B<openssl> B<pkcs7>
15 [B<-help>]
16 [B<-inform> B<DER>|B<PEM>]
17 [B<-outform> B<DER>|B<PEM>]
18 [B<-in> I<filename>]
19 [B<-out> I<filename>]
20 [B<-print_certs>]
21 [B<-text>]
22 [B<-noout>]
23 {- $OpenSSL::safe::opt_engine_synopsis -}
24
25 =for openssl ifdef engine
26
27 =head1 DESCRIPTION
28
29 This command processes PKCS#7 files.  Note that it only understands PKCS#7
30 v 1.5 as specified in IETF RFC 2315.  It cannot currently parse CMS as
31 described in IETF RFC 2630.
32
33 There is no option to print out all the fields of a PKCS#7 file.
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-help>
40
41 Print out a usage message.
42
43 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
44
45 The input and formats; the default is B<PEM>.
46 See L<openssl(1)/Format Options> for details.
47
48 The data is a PKCS#7 Version 1.5 structure.
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<-print_certs>
61
62 Prints out any certificates or CRLs contained in the file. They are
63 preceded by their subject and issuer names in one line format.
64
65 =item B<-text>
66
67 Prints out certificates details in full rather than just subject and
68 issuer names.
69
70 =item B<-noout>
71
72 Don't output the encoded version of the PKCS#7 structure (or certificates
73 is B<-print_certs> is set).
74
75 {- $OpenSSL::safe::opt_engine_item -}
76
77 =back
78
79 =head1 EXAMPLES
80
81 Convert a PKCS#7 file from PEM to DER:
82
83  openssl pkcs7 -in file.pem -outform DER -out file.der
84
85 Output all certificates in a file:
86
87  openssl pkcs7 -in file.pem -print_certs -out certs.pem
88
89 =head1 SEE ALSO
90
91 L<openssl(1)>,
92 L<openssl-crl2pkcs7(1)>
93
94 =head1 COPYRIGHT
95
96 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
97
98 Licensed under the Apache License 2.0 (the "License").  You may not use
99 this file except in compliance with the License.  You can obtain a copy
100 in the file LICENSE in the source distribution or at
101 L<https://www.openssl.org/source/license.html>.
102
103 =cut