kata-containers/s390-tools
1
0
Fork 0
mirror of https://github.com/ibm-s390-linux/s390-tools.git synced 2026-08-05 02:14:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

pvsecret: Update man files

Browse Source 
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
This commit is contained in:
Steffen Eiden
2026-05-21 16:41:59 +02:00
committed by Jan Höppner
parent f223069f0b
commit b6a4d7a6c1
5 changed files with 30 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
rust/pvsecret/README.md
View File

@@ -429,14 +429,14 @@ Print help (see a summary with '-h').
## pvsecret add
### Synopsis
`pvsecret add [OPTIONS] [FILE]`
`pvsecret add [OPTIONS] [INPUT]`
### Description
Submit an add-secret request to the Ultravisor (s390x only). Perform an
add-secret request using a previously generated add-secret request. Only
available on s390x.
### Arguments
`<FILE>`
`<INPUT>`
<ul>
Specify the request to be sent.
</ul>
@@ -473,17 +473,16 @@ fail. Only available on s390x.
## pvsecret list
### Synopsis
`pvsecret list [OPTIONS] [FILE]`
`pvsecret list [OPTIONS] [OUTPUT]`
### Description
List all ultravisor secrets (s390x only). Lists the IDs of all non-null secrets
currently stored in the ultravisor for the currently running IBM Secure
Execution guest. Only available on s390x.
### Arguments
`<FILE>`
`<OUTPUT>`
<ul>
Store the result in FILE.
Default value: '-'
</ul>
@@ -514,7 +513,7 @@ Print help (see a summary with '-h').
## pvsecret verify
### Synopsis
`pvsecret verify [OPTIONS] [FILE] [FILE]`
`pvsecret verify [OPTIONS] [INPUT] [OUTPUT]`
### Description
Verifies that the given request is an Add-Secret request by testing for some
values to be present. If the request contains signed user-data, the signature
@@ -554,17 +553,16 @@ The verification process works as follows:
### Arguments
`<FILE>`
`<INPUT>`
<ul>
Specify the request to be checked.
</ul>
`<FILE>`
`<OUTPUT>`
<ul>
Store the result in FILE If the request contained abirtary user-data the output
contains this user-data with padded zeros if available.
Default value: '-'
</ul>
@@ -588,7 +586,7 @@ curve over a 521 bit prime field (secp521r1).
</ul>
`-o`, `--output <FILE>`
`-o`, `--output <OUTPUT>`
<ul>
Store the result in FILE If the request contained abirtary user-data the output
contains this user-data with padded zeros if available.
@@ -603,13 +601,13 @@ Print help (see a summary with '-h').
## pvsecret retrieve
### Synopsis
`pvsecret retrieve [OPTIONS] [ID] [FILE]`
`pvsecret retr [OPTIONS] [ID] [FILE]`
`pvsecret retrieve [OPTIONS] [INPUT] [OUTPUT]`
`pvsecret retr [OPTIONS] [INPUT] [OUTPUT]`
### Description
Retrieve a secret from the UV secret store (s390x only)
### Arguments
`<ID>`
`<INPUT>`
<ul>
Specify the secret ID to be retrieved. Input type depends on '--inform'. If
`yaml` (default) is specified, it must be a yaml created by the create
@@ -621,16 +619,15 @@ retrieved.
</ul>
`<FILE>`
`<OUTPUT>`
<ul>
Specify the output path to place the secret value.
Default value: '-'
</ul>
### Options
`-i`, `--input <FILE>`
`-i`, `--input <ID>`
<ul>
Specify the secret ID to be retrieved. Input type depends on '--inform'. If
`yaml` (default) is specified, it must be a yaml created by the create

6
rust/pvsecret/man/pvsecret-add.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVSECRET-ADD" "1" "2026-05-19" "s390-tools" "UV\-Secret Manual"
.TH "PVSECRET-ADD" "1" "2026-05-21" "s390-tools" "UV\-Secret Manual"
.nh
.ad l
.SH NAME
@@ -11,7 +11,7 @@ pvsecret-add \- Submit an add-secret request to the Ultravisor (s390x only)
.SH SYNOPSIS
.nf
.fam C
pvsecret add [OPTIONS] [FILE]
pvsecret add [OPTIONS] [INPUT]
.fam C
.fi
.SH DESCRIPTION
@@ -19,7 +19,7 @@ Perform an add\-secret request using a previously generated add\-secret request.
Only available on s390x.
.SH OPTIONS
.PP
<FILE>
<INPUT>
.RS 4
Specify the request to be sent.
.RE

7
rust/pvsecret/man/pvsecret-list.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVSECRET-LIST" "1" "2026-05-19" "s390-tools" "UV\-Secret Manual"
.TH "PVSECRET-LIST" "1" "2026-05-21" "s390-tools" "UV\-Secret Manual"
.nh
.ad l
.SH NAME
@@ -11,7 +11,7 @@ pvsecret-list \- List all ultravisor secrets (s390x only)
.SH SYNOPSIS
.nf
.fam C
pvsecret list [OPTIONS] [FILE]
pvsecret list [OPTIONS] [OUTPUT]
.fam C
.fi
.SH DESCRIPTION
@@ -19,10 +19,9 @@ Lists the IDs of all non\-null secrets currently stored in the ultravisor for
the currently running IBM Secure Execution guest. Only available on s390x.
.SH OPTIONS
.PP
<FILE>
<OUTPUT>
.RS 4
Store the result in FILE.
[default: '-']
.RE
.RE

13
rust/pvsecret/man/pvsecret-retrieve.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVSECRET-RETRIEVE" "1" "2026-05-20" "s390-tools" "UV\-Secret Manual"
.TH "PVSECRET-RETRIEVE" "1" "2026-05-21" "s390-tools" "UV\-Secret Manual"
.nh
.ad l
.SH NAME
@@ -11,8 +11,8 @@ pvsecret-retrieve \- Retrieve a secret from the UV secret store (s390x only)
.SH SYNOPSIS
.nf
.fam C
pvsecret retrieve [OPTIONS] [ID] [FILE]
pvsecret retr [OPTIONS] [ID] [FILE]
pvsecret retrieve [OPTIONS] [INPUT] [OUTPUT]
pvsecret retr [OPTIONS] [INPUT] [OUTPUT]
.fam C
.fi
.SH DESCRIPTION
@@ -24,7 +24,7 @@ keys the PEM name \fBIBM PROTECTED KEY\fP is used.
.SH OPTIONS
.PP
<ID>
<INPUT>
.RS 4
Specify the secret ID to be retrieved. Input type depends on \fB\-\-inform\fR.
If `yaml` (default) is specified, it must be a yaml created by the create
@@ -36,15 +36,14 @@ retrieved.
.RE
.RE
.PP
<FILE>
<OUTPUT>
.RS 4
Specify the output path to place the secret value.
[default: '-']
.RE
.RE
.PP
\-i, \-\-input <FILE>
\-i, \-\-input <ID>
.RS 4
Specify the secret ID to be retrieved. Input type depends on \fB\-\-inform\fR.
If `yaml` (default) is specified, it must be a yaml created by the create

11
rust/pvsecret/man/pvsecret-verify.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVSECRET-VERIFY" "1" "2026-05-19" "s390-tools" "UV\-Secret Manual"
.TH "PVSECRET-VERIFY" "1" "2026-05-21" "s390-tools" "UV\-Secret Manual"
.nh
.ad l
.SH NAME
@@ -11,7 +11,7 @@ pvsecret-verify \- Verify that an add-secret request is sane
.SH SYNOPSIS
.nf
.fam C
pvsecret verify [OPTIONS] [FILE] [FILE]
pvsecret verify [OPTIONS] [INPUT] [OUTPUT]
.fam C
.fi
.SH DESCRIPTION
@@ -81,17 +81,16 @@ verify the signature of the request but the last 16 bytes
.SH OPTIONS
.PP
<FILE>
<INPUT>
.RS 4
Specify the request to be checked.
.RE
.RE
.PP
<FILE>
<OUTPUT>
.RS 4
Store the result in FILE If the request contained abirtary user\-data the output
contains this user\-data with padded zeros if available.
[default: '-']
.RE
.RE
@@ -114,7 +113,7 @@ curve over a 521 bit prime field (secp521r1).
.RE
.RE
.PP
\-o, \-\-output <FILE>
\-o, \-\-output <OUTPUT>
.RS 4
Store the result in FILE If the request contained abirtary user\-data the output
contains this user\-data with padded zeros if available.