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