openssl-pkeyparam.pod.in 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. =pod
  2. =begin comment
  3. {- join("\n", @autowarntext) -}
  4. =end comment
  5. =head1 NAME
  6. openssl-pkeyparam - public key algorithm parameter processing command
  7. =head1 SYNOPSIS
  8. B<openssl> B<pkeyparam>
  9. [B<-help>]
  10. [B<-in> I<filename>]
  11. [B<-out> I<filename>]
  12. [B<-text>]
  13. [B<-noout>]
  14. [B<-check>]
  15. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  16. =head1 DESCRIPTION
  17. This command processes public key algorithm parameters.
  18. They can be checked for correctness and their components printed out.
  19. =head1 OPTIONS
  20. =over 4
  21. =item B<-help>
  22. Print out a usage message.
  23. =item B<-in> I<filename>
  24. This specifies the input filename to read parameters from or standard input if
  25. this option is not specified.
  26. =item B<-out> I<filename>
  27. This specifies the output filename to write parameters to or standard output if
  28. this option is not specified.
  29. =item B<-text>
  30. Prints out the parameters in plain text in addition to the encoded version.
  31. =item B<-noout>
  32. Do not output the encoded version of the parameters.
  33. =item B<-check>
  34. This option checks the correctness of parameters.
  35. {- $OpenSSL::safe::opt_engine_item -}
  36. {- $OpenSSL::safe::opt_provider_item -}
  37. =back
  38. =head1 EXAMPLES
  39. Print out text version of parameters:
  40. openssl pkeyparam -in param.pem -text
  41. =head1 NOTES
  42. There are no B<-inform> or B<-outform> options for this command because only
  43. PEM format is supported because the key type is determined by the PEM headers.
  44. =head1 SEE ALSO
  45. L<openssl(1)>,
  46. L<openssl-genpkey(1)>,
  47. L<openssl-rsa(1)>,
  48. L<openssl-pkcs8(1)>,
  49. L<openssl-dsa(1)>,
  50. L<openssl-genrsa(1)>,
  51. L<openssl-gendsa(1)>
  52. =head1 HISTORY
  53. The B<-engine> option was deprecated in OpenSSL 3.0.
  54. =head1 COPYRIGHT
  55. Copyright 2006-2021 The OpenSSL Project Authors. All Rights Reserved.
  56. Licensed under the Apache License 2.0 (the "License"). You may not use
  57. this file except in compliance with the License. You can obtain a copy
  58. in the file LICENSE in the source distribution or at
  59. L<https://www.openssl.org/source/license.html>.
  60. =cut