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

lszcrypt: Escape hyphens in man page correctly

Browse Source 
Insert backslash(es) to escape the hyphens used
in the lszcrypt man page correctly.

Suggested-by: Jan Hoeppner <hoeppner@linux.ibm.com>
Signed-off-by: Harald Freudenberger <freude@linux.ibm.com>
Reviewed-by: Steffen Eiden <seiden@linux.ibm.com>
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
This commit is contained in:
Harald Freudenberger
2024-05-14 09:02:36 +02:00
committed by Steffen Eiden
parent 474c6adf8f
commit ab35922161
1 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
zconf/zcrypt/lszcrypt.8
View File

@@ -17,27 +17,27 @@ lszcrypt \- display zcrypt device and configuration information
.TP 9
.B lszcrypt
.RB "[" <filteroptions> "]"
.RB "[" -V "]"
.RB "[" \-V "]"
[
.I <device-id>
[...]]
.TP
.B lszcrypt
.B -c
.B \-c
<device-id>
.TP
.B lszcrypt -b
.B lszcrypt \-b
.TP
.B lszcrypt -d
.B lszcrypt \-d
.TP
.B lszcrypt -h
.B lszcrypt \-h
.TP
.B lszcrypt -s
.B lszcrypt \-s
.TP
.B lszcrypt -v
.B lszcrypt \-v
. TP
.B <filteroptions>
[--accelonly|--ccaonly|--ep11only] [--cardonly|--queueonly]
[\-\-accelonly|\-\-ccaonly|\-\-ep11only] [\-\-cardonly|\-\-queueonly]
.SH DESCRIPTION
The
.B lszcrypt
@@ -57,7 +57,7 @@ configuration timer, poll thread status, poll timeout, and AP
interrupt status.
.SH OPTIONS
.TP 8
.B -V, --verbose
.B \-V, \-\-verbose
The verbose level for cryptographic device information. With this
verbose level additional information like hardware card type, hardware
queue depth, pending requests count, installed function facilities and
@@ -70,7 +70,7 @@ specified information about all available devices is displayed.
Please note that the card device representation and the queue device
are both in hexadecimal notation.
.TP 8
.B -b, --bus
.B \-b, \-\-bus
Displays the AP bus attributes and exits.
There is also a list of AP bus features shown here:
@@ -87,7 +87,7 @@ RC8A - Firmware reports 0x8A instead of 0x42 on some error conditions.
APSB - AP bus has Secure Execution AP pass-through support.
.RE
.TP 8
.B -c, --capability <device-id>
.B \-c, \-\-capability <device-id>
Shows the capabilities of a cryptographic card or queue device of
hardware type 6 or higher. A card device id value may be given as
decimal or hex value (with a leading 0x), a queue device needs to be
@@ -127,7 +127,7 @@ mkvp(s) (Master Key Verification Pattern) of the current master WK
mode) are shown here.
.RE
.TP 8
.B -d, --domains
.B \-d, \-\-domains
Shows the usage and control domains of the cryptographic devices. The
displayed domains of the cryptographic device depends on the initial
cryptographic configuration.
@@ -140,28 +140,28 @@ U - indicate a usage domain
B - indicate both (control and usage domain)
.RE
.TP 8
.B -h, --help
.B \-h, \-\-help
Displays help text and exits.
.TP 8
.B -s, --serial
.B \-s, \-\-serial
Shows the serial numbers for CCA and EP11 crypto cards.
.TP 8
.B -v, --version
.B \-v, \-\-version
Displays version information and exits.
.TP 8
.B --accelonly
.B \-\-accelonly
Show only information for cards/queues in Accelerator mode.
.TP 8
.B --ccaonly
.B \-\-ccaonly
Show only information for cards/queues in CCA-Coprocessor mode.
.TP 8
.B --ep11only
.B \-\-ep11only
Show only information for cards/queues in EP11-Coprocessor mode.
.TP 8
.B --cardonly
.B \-\-cardonly
Show only information for cards but no queue info.
.TP 8
.B --queueonly
.B \-\-queueonly
Show only information for queues but no card info.
.SH LISTING DETAILS
Here is an explanation of the columns displayed. Please note that some
@@ -201,7 +201,7 @@ switched on or off with the help of the chzcrypt application.
.br
A crypto card can also be 'configured' or 'deconfigured'. This state
may be adjusted on the HMC. The chzcrypt application can also trigger
this state with the --config-on and --config-off options.
this state with the \-\-config\-on and \-\-config\-off options.
.br
lszcrypt shows 'online' when a card or queue is available for
cryptographic operations. 'offline' is displayed when a card or queue
@@ -285,9 +285,9 @@ Execution guest.
.br
illicit - AP queue is not available for this Secure Execution guest.
.SH NOTES
Use only one of the mode filtering options --accelonly, --ccaonly,
--ep11only. Same with card/queue filtering: Use only one of
--cardonly, --queueonly. However, one of the mode filtering options
Use only one of the mode filtering options \-\-accelonly, \-\-ccaonly,
\-\-ep11only. Same with card/queue filtering: Use only one of
\-\-cardonly, \-\-queueonly. However, one of the mode filtering options
and one of the card/queue filtering can be combined.
.SH EXAMPLES
.TP
@@ -300,7 +300,7 @@ devices.
Displays the card/domain ID, card type, mode, online status and
request count for cryptographic devices 1, 3, and 5.
.TP
.B lszcrypt -V 3 7 11
.B lszcrypt \-V 3 7 11
Displays the card/domain ID, card type, mode, online status, request
count, number of requests in the hardware queue, number of outstanding
requests and installed function facilities for cryptographic devices
@@ -314,10 +314,10 @@ respectively card id 16 (0x10) with domain 56 (0x38).
Displays information of all available queue devices (potentially
multiple adapters) with domain 56 (0x38).
.TP
.B lszcrypt -b
.B lszcrypt \-b
Displays AP bus information.
.TP
.B lszcrypt -c 7
.B lszcrypt \-c 7
.RS
.br
Coprocessor card07 provides capability for: