openssl-pkeyparam.pod.in 2.0 KB

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