doc/man1/openssl-pkeyparam.pod.in

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