doc/apps/pkeyparam.pod

   1
   2 =pod
   3
   4 =head1 NAME
   5
   6 pkeyparam - public key algorithm parameter processing tool
   7
   8 =head1 SYNOPSIS
   9
  10 B<openssl> B<pkeyparam>
  11 [B<-help>]
  12 [B<-in filename>]
  13 [B<-out filename>]
  14 [B<-text>]
  15 [B<-noout>]
  16 [B<-engine id>]
  17
  18 =head1 DESCRIPTION
  19
  20 The B<pkey> command processes public or private keys. They can be converted
  21 between various forms and their components printed out.
  22
  23 =head1 COMMAND OPTIONS
  24
  25 =over 4
  26
  27 =item B<-help>
  28
  29 Print out a usage message.
  30
  31 =item B<-in filename>
  32
  33 This specifies the input filename to read parameters from or standard input if
  34 this option is not specified.
  35
  36 =item B<-out filename>
  37
  38 This specifies the output filename to write parameters to or standard output if
  39 this option is not specified.
  40
  41 =item B<-text>
  42
  43 prints out the parameters in plain text in addition to the encoded version.
  44
  45 =item B<-noout>
  46
  47 do not output the encoded version of the parameters.
  48
  49 =item B<-engine id>
  50
  51 specifying an engine (by its unique B<id> string) will cause B<pkeyparam>
  52 to attempt to obtain a functional reference to the specified engine,
  53 thus initialising it if needed. The engine will then be set as the default
  54 for all available algorithms.
  55
  56 =back
  57
  58 =head1 EXAMPLE
  59
  60 Print out text version of parameters:
  61
  62  openssl pkeyparam -in param.pem -text
  63
  64 =head1 NOTES
  65
  66 There are no B<-inform> or B<-outform> options for this command because only
  67 PEM format is supported because the key type is determined by the PEM headers.
  68
  69 =head1 SEE ALSO
  70
  71 L<genpkey(1)>, L<rsa(1)>, L<pkcs8(1)>,
  72 L<dsa(1)>, L<genrsa(1)>, L<gendsa(1)>
  73
  74 =cut