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

tape390: Fix missing hyphen escapes in the man pages

Browse Source 
Hyphens are converted by groff to a different unicode character leading
to failing command execution of copy-pasted options or examples.

Ensure that all hyphens are properly escaped.

Reviewed-by: Stefan Haberland <sth@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
This commit is contained in:
Jan Höppner
2024-05-14 12:58:18 +02:00
committed by Steffen Eiden
parent e3a698c382
commit 202ded5d11
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
tape390/tape390_crypt.8
View File

@@ -48,20 +48,20 @@ The store type (either label or hash) specifies how the KEK in <value> is to be
human readable strings and hence more user friendly than hashes,
the default store type is label.
.br
The -k option can only be specified, if the tape medium is at load point.
The \-k option can only be specified, if the tape medium is at load point.
.br
While processing the -k option, the tape medium is initialized and all
While processing the \-k option, the tape medium is initialized and all
data eventually contained on the tape medium is lost.
To avoid inadvertent data loss a prompt message is issued asking the user
whether he or she really wants to proceed.
.br
The -k option can be specified maximal twice, because on the tape medium
The \-k option can be specified maximal twice, because on the tape medium
maximal two EEDKs (External Encrypted Data Keys) can be stored.
If specified once, two identical EEDKs are stored.
.br
<char> is a character separating the KEK in <value> from the store type
(either label or hash). This
delimiter can be specified with the -d option as explained below.
delimiter can be specified with the \-d option as explained below.
.TP
.BR "\-d <char>" " or " "\-\-delimiter=<char>
@@ -87,7 +87,7 @@ mount non-encrypted tape and write data with the
.B "default"
KEKs:
.br
tape390_crypt -e on /dev/ntibm0
tape390_crypt \-e on /dev/ntibm0
.br
tar cfz /dev/ntibm0 /data
@@ -97,7 +97,7 @@ mount non-encrypted tape and write data with
.B "specific"
KEKs:
.br
tape390_crypt -k my_first_key -k my_second_key:hash /dev/ntibm0
tape390_crypt \-k my_first_key \-k my_second_key:hash /dev/ntibm0
.br
tar cfz /dev/ntibm0 /data
@@ -105,4 +105,4 @@ tar cfz /dev/ntibm0 /data
.br
mount tape and display current encryption status:
.br
tape390_crypt -q /dev/ntibm0
tape390_crypt \-q /dev/ntibm0

30
tape390/tape390_display.8
View File

@@ -11,17 +11,17 @@ device.
.SH SYNOPSIS
.TP 16
.B tape390_display
.RB [ -b | --blink ]
.RB [ \-b | \-\-blink ]
.br
.RB [ -h | --help ]
.RB [ \-h | \-\-help ]
.br
.RB [ -l | --load ]
.RB [ \-l | \-\-load ]
.br
.RB [ -t <type>| --type <type>]
.RB [ \-t <type>| \-\-type <type>]
.br
.RB [ -q | --quiet ]
.RB [ \-q | \-\-quiet ]
.br
.RB [ -v | --version ]
.RB [ \-v | \-\-version ]
.br
.IR message1
.RB [
@@ -42,28 +42,28 @@ Spaces and shell-sensitive characters have to be quoted.
.SH OPTIONS
.TP 8
\fB-h\fR or \fB--help\fR
\fB\-h\fR or \fB\-\-help\fR
Print help text.
.TP
\fB-b\fR or \fB--blink\fR
\fB\-b\fR or \fB\-\-blink\fR
Display \fImessage1\fR repeatedly for 2 seconds at half-second intervals.
This option is ignored if two messages are specified on command line.
.TP
\fB-l\fR or \fB--load\fR
\fB\-l\fR or \fB\-\-load\fR
If this option is given the display request will cause a load request to be
sent to the automatic tape loader (if installed). The next indexed tape will
then be loaded if the loader is in 'system' mode. Otherwise the request is
ignored.
.TP
\fB-q\fR or \fB--quiet\fR
\fB\-q\fR or \fB\-\-quiet\fR
This option causes the command to run in quiet mode which will suppress
all warning messages.
.TP
\fB-t\fR \fItype\fR or \fB--type\fR \fItype\fR
\fB\-t\fR \fItype\fR or \fB\-\-type\fR \fItype\fR
Set the type of the message to be displayed. This influences how long
the message(s) stay on the display. Available types are:
@@ -94,7 +94,7 @@ into the drive.
.RE
.TP
\fB-v\fR or \fB--version\fR
\fB\-v\fR or \fB\-\-version\fR
Print the S/390 tools package version, the utility version and exit.
.TP 8
@@ -115,7 +115,7 @@ The tape device on which the message(s) will be displayed, e.g.:
.br
.SH EXAMPLES
\fBtape390_display --blink --type unload "TESTING" /dev/ntibm\fR\fI0\fR
\fBtape390_display \-\-blink \-\-type unload "TESTING" /dev/ntibm\fR\fI0\fR
.RS
Let the message TESTING blink on the display of the tape unit until the
tape is removed (or another message is given). If there is no tape in the
@@ -127,13 +127,13 @@ This will display the messages BACKUP and COMPLETE each for 2 seconds
until the tape is moved, ejected or (if there isn't a tape in the
device) inserted.
.RE
\fBtape390_display --type reload "UNLOAD" "LOAD" /dev/ntibm\fR\fI0\fR
\fBtape390_display \-\-type reload "UNLOAD" "LOAD" /dev/ntibm\fR\fI0\fR
.RS
The UNLOAD message will be displayed if there is a tape inserted and as
long as the tape isn't removed. After that the LOAD message is displayed
until a tape is inserted. If there is no tape inserted when the command
.RE
\fBtape390_display --load --type load "LOADING" /dev/ntibm\fR\fI0\fR
\fBtape390_display \-\-load \-\-type load "LOADING" /dev/ntibm\fR\fI0\fR
.RS
Causes the device to display the message LOADING until a tape is inserted
and to instruct the automatic stacker to load the next tape (if the mode