diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-12 17:45:56 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2020-01-07 18:52:25 +0100 |
commit | 018aaeb47874272e157d35c05c68e826301d57f5 (patch) | |
tree | 207e08dcd0dfeef4416edaa850d462b0c99e4e8b /doc/man1/openssl-pkeyparam.pod.in | |
parent | 9484b67dfb0fc69326b4d94c2040751b205baa24 (diff) |
Refactor -engine documentation
Common wording courtesy Richard Levitte.
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10128)
Diffstat (limited to 'doc/man1/openssl-pkeyparam.pod.in')
-rw-r--r-- | doc/man1/openssl-pkeyparam.pod.in | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/doc/man1/openssl-pkeyparam.pod.in b/doc/man1/openssl-pkeyparam.pod.in new file mode 100644 index 0000000000..4488119121 --- /dev/null +++ b/doc/man1/openssl-pkeyparam.pod.in @@ -0,0 +1,94 @@ +=pod + +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + +=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<-check>] +{- $OpenSSL::safe::opt_engine_synopsis -} + +=for openssl 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<-check> + +This option checks the correctness of parameters. + +{- $OpenSSL::safe::opt_engine_item -} + +=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 |