Files
s390-tools/rust/pvimg/man/pvimg-info.1
T
Marc Hartmayer 7be364aa84 rust/pvimg/man: Fix whatis-entries in manpages
Before this change:
$ lexgrog -w -m man/pvimg-create.1
man/pvimg-create.1: parse failed

After this change:

$ lexgrog -w -m man/pvimg-create.1
man/pvimg-create.1: "pvimg-create - Create an IBM Secure Execution image"

In addition, pvimg is highlighted in the manpage description section.

Github-ID: https://github.com/ibm-s390-linux/s390-tools/issues/170
Signed-off-by: Marc Hartmayer <mhartmay@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
2024-12-20 13:12:34 +01:00

71 lines
1.4 KiB
Groff

.\" Copyright 2024 IBM Corp.
.\" s390-tools is free software; you can redistribute it and/or modify
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVIMG-INFO" "1" "2024-12-19" "s390-tools" "Pvimg Manual"
.nh
.ad l
.SH NAME
pvimg-info \- Print information about the IBM Secure Execution image
.SH SYNOPSIS
.nf
.fam C
pvimg info [OPTIONS] --format <FORMAT> <INPUT>
.fam C
.fi
.SH DESCRIPTION
Note that the API and output format is experimental and subject to change.
.SH OPTIONS
.PP
<INPUT>
.RS 4
Use INPUT as the Secure Execution image.
.RE
.RE
.PP
\-\-format <FORMAT>
.RS 4
The output format.
Possible values:
.RS 4
\- \fBjson\fP: JSON format.
.RE
.RE
.PP
\-\-hdr\-key <FILE>
.RS 4
Use the key in FILE to decrypt the Secure Execution header. It is the key that
was specified with the command line option \fB\-\-hdr\-key\fR at the Secure
Execution image creation.
.RE
.RE
.PP
\-h, \-\-help
.RS 4
Print help (see a summary with \fB\-h\fR).
.RE
.RE
.SH EXIT STATUS
.TP 8
.B 0 \- Program finished successfully
The command was executed successfully.
.RE
.TP 8
.B 1 \- Generic error
Something went wrong during the operation. Refer to the error
message.
.RE
.TP 8
.B 2 \- Usage error
The command was used incorrectly, for example: unsupported command
line flag, or wrong number of arguments.
.RE
.SH "SEE ALSO"
.sp
\fBpvimg\fR(1) \fBzipl\fR(8) \fBqemu\fR(1)