openssl-pkeyparam.1ossl 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "OPENSSL-PKEYPARAM 1ossl"
  58. .TH OPENSSL-PKEYPARAM 1ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. openssl\-pkeyparam \- public key algorithm parameter processing command
  65. .SH SYNOPSIS
  66. .IX Header "SYNOPSIS"
  67. \&\fBopenssl\fR \fBpkeyparam\fR
  68. [\fB\-help\fR]
  69. [\fB\-in\fR \fIfilename\fR]
  70. [\fB\-out\fR \fIfilename\fR]
  71. [\fB\-text\fR]
  72. [\fB\-noout\fR]
  73. [\fB\-check\fR]
  74. [\fB\-engine\fR \fIid\fR]
  75. [\fB\-provider\fR \fIname\fR]
  76. [\fB\-provider\-path\fR \fIpath\fR]
  77. [\fB\-propquery\fR \fIpropq\fR]
  78. .SH DESCRIPTION
  79. .IX Header "DESCRIPTION"
  80. This command processes public key algorithm parameters.
  81. They can be checked for correctness and their components printed out.
  82. .SH OPTIONS
  83. .IX Header "OPTIONS"
  84. .IP \fB\-help\fR 4
  85. .IX Item "-help"
  86. Print out a usage message.
  87. .IP "\fB\-in\fR \fIfilename\fR" 4
  88. .IX Item "-in filename"
  89. This specifies the input filename to read parameters from or standard input if
  90. this option is not specified.
  91. .IP "\fB\-out\fR \fIfilename\fR" 4
  92. .IX Item "-out filename"
  93. This specifies the output filename to write parameters to or standard output if
  94. this option is not specified.
  95. .IP \fB\-text\fR 4
  96. .IX Item "-text"
  97. Prints out the parameters in plain text in addition to the encoded version.
  98. .IP \fB\-noout\fR 4
  99. .IX Item "-noout"
  100. Do not output the encoded version of the parameters.
  101. .IP \fB\-check\fR 4
  102. .IX Item "-check"
  103. This option checks the correctness of parameters.
  104. .IP "\fB\-engine\fR \fIid\fR" 4
  105. .IX Item "-engine id"
  106. See "Engine Options" in \fBopenssl\fR\|(1).
  107. This option is deprecated.
  108. .IP "\fB\-provider\fR \fIname\fR" 4
  109. .IX Item "-provider name"
  110. .PD 0
  111. .IP "\fB\-provider\-path\fR \fIpath\fR" 4
  112. .IX Item "-provider-path path"
  113. .IP "\fB\-propquery\fR \fIpropq\fR" 4
  114. .IX Item "-propquery propq"
  115. .PD
  116. See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
  117. .SH EXAMPLES
  118. .IX Header "EXAMPLES"
  119. Print out text version of parameters:
  120. .PP
  121. .Vb 1
  122. \& openssl pkeyparam \-in param.pem \-text
  123. .Ve
  124. .SH NOTES
  125. .IX Header "NOTES"
  126. There are no \fB\-inform\fR or \fB\-outform\fR options for this command because only
  127. PEM format is supported because the key type is determined by the PEM headers.
  128. .SH "SEE ALSO"
  129. .IX Header "SEE ALSO"
  130. \&\fBopenssl\fR\|(1),
  131. \&\fBopenssl\-genpkey\fR\|(1),
  132. \&\fBopenssl\-rsa\fR\|(1),
  133. \&\fBopenssl\-pkcs8\fR\|(1),
  134. \&\fBopenssl\-dsa\fR\|(1),
  135. \&\fBopenssl\-genrsa\fR\|(1),
  136. \&\fBopenssl\-gendsa\fR\|(1)
  137. .SH HISTORY
  138. .IX Header "HISTORY"
  139. The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
  140. .SH COPYRIGHT
  141. .IX Header "COPYRIGHT"
  142. Copyright 2006\-2021 The OpenSSL Project Authors. All Rights Reserved.
  143. .PP
  144. Licensed under the Apache License 2.0 (the "License"). You may not use
  145. this file except in compliance with the License. You can obtain a copy
  146. in the file LICENSE in the source distribution or at
  147. <https://www.openssl.org/source/license.html>.