7f9d351ac2435a6ba400acea7905dedcf81dbb86
[openssl.git] / doc / man1 / openssl-pkeyparam.pod.in
1 =pod
2
3 =begin comment
4 {- join("\n", @autowarntext) -}
5
6 =end comment
7
8 =head1 NAME
9
10 openssl-pkeyparam - public key algorithm parameter processing tool
11
12 =head1 SYNOPSIS
13
14 B<openssl> B<pkeyparam>
15 [B<-help>]
16 [B<-in> I<filename>]
17 [B<-out> I<filename>]
18 [B<-text>]
19 [B<-noout>]
20 [B<-check>]
21 {- $OpenSSL::safe::opt_engine_synopsis -}
22 {- $OpenSSL::safe::opt_provider_synopsis -}
23
24 =for openssl ifdef engine
25
26 =head1 DESCRIPTION
27
28 This command processes public key algorithm parameters.
29 They can be checked for correctness and their components printed out.
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-help>
36
37 Print out a usage message.
38
39 =item B<-in> I<filename>
40
41 This specifies the input filename to read parameters from or standard input if
42 this option is not specified.
43
44 =item B<-out> I<filename>
45
46 This specifies the output filename to write parameters to or standard output if
47 this option is not specified.
48
49 =item B<-text>
50
51 Prints out the parameters in plain text in addition to the encoded version.
52
53 =item B<-noout>
54
55 Do not output the encoded version of the parameters.
56
57 =item B<-check>
58
59 This option checks the correctness of parameters.
60
61 {- $OpenSSL::safe::opt_engine_item -}
62
63 {- $OpenSSL::safe::opt_provider_item -}
64
65 =back
66
67 =head1 EXAMPLES
68
69 Print out text version of parameters:
70
71  openssl pkeyparam -in param.pem -text
72
73 =head1 NOTES
74
75 There are no B<-inform> or B<-outform> options for this command because only
76 PEM format is supported because the key type is determined by the PEM headers.
77
78 =head1 SEE ALSO
79
80 L<openssl(1)>,
81 L<openssl-genpkey(1)>,
82 L<openssl-rsa(1)>,
83 L<openssl-pkcs8(1)>,
84 L<openssl-dsa(1)>,
85 L<openssl-genrsa(1)>,
86 L<openssl-gendsa(1)>
87
88 =head1 COPYRIGHT
89
90 Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
91
92 Licensed under the Apache License 2.0 (the "License").  You may not use
93 this file except in compliance with the License.  You can obtain a copy
94 in the file LICENSE in the source distribution or at
95 L<https://www.openssl.org/source/license.html>.
96
97 =cut