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