doc/apps/pkeyparam.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 pkeyparam - public key algorithm parameter processing tool
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<pkeyparam>
  10 [B<-help>]
  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<-help>
  27
  28 Print out a usage message.
  29
  30 =item B<-in filename>
  31
  32 This specifies the input filename to read parameters from or standard input if
  33 this option is not specified.
  34
  35 =item B<-out filename>
  36
  37 This specifies the output filename to write parameters to or standard output if
  38 this option is not specified.
  39
  40 =item B<-text>
  41
  42 prints out the parameters in plain text in addition to the encoded version.
  43
  44 =item B<-noout>
  45
  46 do not output the encoded version of the parameters.
  47
  48 =item B<-engine id>
  49
  50 specifying an engine (by its unique B<id> string) will cause B<pkeyparam>
  51 to attempt to obtain a functional reference to the specified engine,
  52 thus initialising it if needed. The engine will then be set as the default
  53 for all available algorithms.
  54
  55 =back
  56
  57 =head1 EXAMPLE
  58
  59 Print out text version of parameters:
  60
  61  openssl pkeyparam -in param.pem -text
  62
  63 =head1 NOTES
  64
  65 There are no B<-inform> or B<-outform> options for this command because only
  66 PEM format is supported because the key type is determined by the PEM headers.
  67
  68 =head1 SEE ALSO
  69
  70 L<genpkey(1)>, L<rsa(1)>, L<pkcs8(1)>,
  71 L<dsa(1)>, L<genrsa(1)>, L<gendsa(1)>
  72
  73 =head1 COPYRIGHT
  74
  75 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
  76
  77 Licensed under the OpenSSL license (the "License").  You may not use
  78 this file except in compliance with the License.  You can obtain a copy
  79 in the file LICENSE in the source distribution or at
  80 L<https://www.openssl.org/source/license.html>.
  81
  82 =cut