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