]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - crypto/openssl/doc/apps/pkeyparam.pod
Merge clang release_70 branch r338892, and resolve conflicts.
[FreeBSD/FreeBSD.git] / crypto / openssl / doc / apps / pkeyparam.pod
1
2 =pod
3
4 =head1 NAME
5
6 openssl-pkeyparam,
7 pkeyparam - public key algorithm parameter processing tool
8
9 =head1 SYNOPSIS
10
11 B<openssl> B<pkeyparam>
12 [B<-in filename>]
13 [B<-out filename>]
14 [B<-text>]
15 [B<-noout>]
16 [B<-engine id>]
17
18 =head1 DESCRIPTION
19
20 The B<pkey> command processes public or private keys. They can be converted
21 between various forms and their components printed out.
22
23 =head1 COMMAND OPTIONS
24
25 =over 4
26
27 =item B<-in filename>
28
29 This specifies the input filename to read parameters from or standard input if
30 this option is not specified.
31
32 =item B<-out filename>
33
34 This specifies the output filename to write parameters to or standard output if
35 this option is not specified.
36
37 =item B<-text>
38
39 prints out the parameters in plain text in addition to the encoded version. 
40
41 =item B<-noout>
42
43 do not output the encoded version of the parameters.
44
45 =item B<-engine id>
46
47 specifying an engine (by its unique B<id> string) will cause B<pkeyparam>
48 to attempt to obtain a functional reference to the specified engine,
49 thus initialising it if needed. The engine will then be set as the default
50 for all available algorithms.
51
52 =back
53
54 =head1 EXAMPLE
55
56 Print out text version of parameters:
57
58  openssl pkeyparam -in param.pem -text
59
60 =head1 NOTES
61
62 There are no B<-inform> or B<-outform> options for this command because only
63 PEM format is supported because the key type is determined by the PEM headers.
64
65 =head1 SEE ALSO
66
67 L<genpkey(1)|genpkey(1)>, L<rsa(1)|rsa(1)>, L<pkcs8(1)|pkcs8(1)>,
68 L<dsa(1)|dsa(1)>, L<genrsa(1)|genrsa(1)>, L<gendsa(1)|gendsa(1)> 
69
70 =cut