Debian Codegraph @

upstream/debian-unstable/man1/openssl-pkeyparam.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
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 1SSL"
58 .TH OPENSSL-PKEYPARAM 1SSL 2026-04-07 3.6.2 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\-provparam\fR \fI[name:]key=value\fR]
78 [\fB\-propquery\fR \fIpropq\fR]
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This command processes public key algorithm parameters.
82 They can be checked for correctness and their components printed out.
83 .SH OPTIONS
84 .IX Header "OPTIONS"
85 .IP \fB\-help\fR 4
86 .IX Item "-help"
87 Print out a usage message.
88 .IP "\fB\-in\fR \fIfilename\fR" 4
89 .IX Item "-in filename"
90 This specifies the input file to read parameters from or standard input if
91 this option is not specified.
92 .IP "\fB\-out\fR \fIfilename\fR" 4
93 .IX Item "-out filename"
94 This specifies the output filename to write parameters to or standard output if
95 this option is not specified.
96 The output filename can be the same as the input filename,
97 which leads to replacing the file contents.
98 Note that file I/O is not atomic. The output file is truncated and then written.
99 .IP \fB\-text\fR 4
100 .IX Item "-text"
101 Prints out the parameters in plain text in addition to the encoded version.
102 .IP \fB\-noout\fR 4
103 .IX Item "-noout"
104 Do not output the encoded version of the parameters.
105 .IP \fB\-check\fR 4
106 .IX Item "-check"
107 This option checks the correctness of parameters.
108 .IP "\fB\-engine\fR \fIid\fR" 4
109 .IX Item "-engine id"
110 See "Engine Options" in \fBopenssl\fR\|(1).
111 This option is deprecated.
112 .IP "\fB\-provider\fR \fIname\fR" 4
113 .IX Item "-provider name"
114 .PD 0
115 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
116 .IX Item "-provider-path path"
117 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
118 .IX Item "-provparam [name:]key=value"
119 .IP "\fB\-propquery\fR \fIpropq\fR" 4
120 .IX Item "-propquery propq"
121 .PD
122 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
123 .SH EXAMPLES
124 .IX Header "EXAMPLES"
125 Print out text version of parameters:
126 .PP
127 .Vb 1
128 \& openssl pkeyparam \-in param.pem \-text
129 .Ve
130 .SH NOTES
131 .IX Header "NOTES"
132 There are no \fB\-inform\fR or \fB\-outform\fR options for this command because only
133 PEM format is supported because the key type is determined by the PEM headers.
134 .SH "SEE ALSO"
135 .IX Header "SEE ALSO"
136 \&\fBopenssl\fR\|(1),
137 \&\fBopenssl\-genpkey\fR\|(1),
138 \&\fBopenssl\-rsa\fR\|(1),
139 \&\fBopenssl\-pkcs8\fR\|(1),
140 \&\fBopenssl\-dsa\fR\|(1),
141 \&\fBopenssl\-genrsa\fR\|(1),
142 \&\fBopenssl\-gendsa\fR\|(1)
143 .SH HISTORY
144 .IX Header "HISTORY"
145 The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
146 .SH COPYRIGHT
147 .IX Header "COPYRIGHT"
148 Copyright 2006\-2021 The OpenSSL Project Authors. All Rights Reserved.
149 .PP
150 Licensed under the Apache License 2.0 (the "License"). You may not use
151 this file except in compliance with the License. You can obtain a copy
152 in the file LICENSE in the source distribution or at
153 <https://www.openssl.org/source/license.html>.