mirror of
https://github.com/openssl/openssl.git
synced 2025-01-18 13:44:20 +08:00
35a810bb1d
Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
they are refered to like that and not just as the sub-command.
Self-references are avoided as much as is possible, and replaced with
"this command". In some cases, we even avoid that with a slight
rewrite of the sentence or paragrah they were in. However, in the few
cases where a self-reference is still admissible, they are done in
bold, i.e. openssl-speed.pod references itself like this:
B<openssl speed>
References to other commands are done as manual links, i.e. CA.pl.pod
references 'openssl req' like this: L<openssl-req(1)>
Some commands are examples rather than references; we enclose those in
C<>.
While we are it, we abolish "utility", replacing it with "command", or
remove it entirely in some cases.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)
95 lines
2.0 KiB
Plaintext
95 lines
2.0 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
openssl-pkeyparam - public key algorithm parameter processing tool
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<openssl> B<pkeyparam>
|
|
[B<-help>]
|
|
[B<-in> I<filename>]
|
|
[B<-out> I<filename>]
|
|
[B<-text>]
|
|
[B<-noout>]
|
|
[B<-engine> I<id>]
|
|
[B<-check>]
|
|
|
|
=for comment ifdef engine
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This command processes public key algorithm parameters.
|
|
They can be checked for correctness and their components printed out.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-help>
|
|
|
|
Print out a usage message.
|
|
|
|
=item B<-in> I<filename>
|
|
|
|
This specifies the input filename to read parameters from or standard input if
|
|
this option is not specified.
|
|
|
|
=item B<-out> I<filename>
|
|
|
|
This specifies the output filename to write parameters to or standard output if
|
|
this option is not specified.
|
|
|
|
=item B<-text>
|
|
|
|
Prints out the parameters in plain text in addition to the encoded version.
|
|
|
|
=item B<-noout>
|
|
|
|
Do not output the encoded version of the parameters.
|
|
|
|
=item B<-engine> I<id>
|
|
|
|
Specifying an engine (by its unique I<id> string) will cause this command
|
|
to attempt to obtain a functional reference to the specified engine,
|
|
thus initialising it if needed. The engine will then be set as the default
|
|
for all available algorithms.
|
|
|
|
=item B<-check>
|
|
|
|
This option checks the correctness of parameters.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
Print out text version of parameters:
|
|
|
|
openssl pkeyparam -in param.pem -text
|
|
|
|
=head1 NOTES
|
|
|
|
There are no B<-inform> or B<-outform> options for this command because only
|
|
PEM format is supported because the key type is determined by the PEM headers.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<openssl(1)>,
|
|
L<openssl-genpkey(1)>,
|
|
L<openssl-rsa(1)>,
|
|
L<openssl-pkcs8(1)>,
|
|
L<openssl-dsa(1)>,
|
|
L<openssl-genrsa(1)>,
|
|
L<openssl-gendsa(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|