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: Fix incorrect font escape sequences in man page

Browse Source 
There are a couple place with incorrectly used font escape sequences.

$ man --warnings -E UTF-8 -l -Tutf8 -Z rust/pvsecret/man/pvsecret.1

troff:<standard input>:107: warning: cannot select font 'F'
troff:<standard input>:107: warning: cannot select font 'E'

$ man --warnings -E UTF-8 -l -Tutf8 -Z rust/pvsecret/man/pvsecret-verify.1
troff:<standard input>:119: warning: cannot select font 'F'
troff:<standard input>:119: warning: cannot select font 'F'
troff:<standard input>:119: warning: cannot select font 'F'
troff:<standard input>:119: warning: cannot select font 'F'
troff:<standard input>:119: warning: cannot select font 'F'
troff:<standard input>:131: warning: cannot select font 'F'

Use the correct escape sequences and regenerate the man pages.

Github-ID: https://github.com/ibm-s390-linux/s390-tools/issues/170
Reviewed-by: Steffen Eiden <seiden@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
This commit is contained in:
Jan Höppner
2025-03-12 16:13:11 +01:00
parent c93b74b527
commit 3fd8c48245
2 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
rust/pvsecret/man/pvsecret-verify.1
+13 -3
View File
@@ -116,11 +116,18 @@ Print help (see a summary with \fB\-h\fR).
.SH EXAMPLES
.PP
Create the add-secret request on a trusted system with signed user datai similar to the example for \fFpvsecret\fP. Let's assume there are three more files present .\fFuser_data\fP contains ascii "some example user-data", a private user-signing key e.g. rsa3072 \fFusr_sgn_key.priv.pem\fF, and a certificate containing the corresponding public key to the private rsa3072 key \fFuser_cert.pem\fP.
Create the add-secret request on a trusted system with signed user data similar
to the example for \fBpvsecret\fR. Let's assume there are three more files
present. \fIuser_data\fR contains ascii "some example user-data", a private
user-signing key e.g. rsa3072 \fIusr_sgn_key.priv.pem\fR, and a certificate
containing the corresponding public key to the private rsa3072 key
\fIuser_cert.pem\fR.
.PP
.RS
.IP trusted:~$ 12
pvsecret create \-k hkd.crt \-\-cert CA.crt \-\-cert ibmsk.crt \-\-hdr pvimage \-o addsecreq.bin \-\-user\-data user_data \-\-user\-sign\-key usr_sgn_key.priv.pem association EXAMPLE
pvsecret create \-k hkd.crt \-\-cert CA.crt \-\-cert ibmsk.crt \-\-hdr pvimage
\-o addsecreq.bin \-\-user\-data user_data \-\-user\-sign\-key
usr_sgn_key.priv.pem association EXAMPLE
.RE
.RS
Successfully generated the request
@@ -128,7 +135,10 @@ Successfully generated the request
Successfully wrote association info to 'EXAMPLE.yaml'
.RE
For example, on the SE-guest, perform \fIverify\fP on the request to verify the user-signature and the saneness of the request. On success, The user-data is printed to stdout (if \fI\-\-output\fP was not specified) and \fFSuccesfully verified the request.\fP is printed to stderr.
For example, on the SE-guest, perform \fIverify\fP on the request to verify the
user-signature and the saneness of the request. On success, The user-data is
printed to stdout (if \fI\-\-output\fP was not specified) and \fBSuccesfully
verified the request.\fR is printed to stderr.
.PP
.RS
.IP seguest:~$ 12
rust/pvsecret/man/pvsecret.1
+1 -1
View File
@@ -104,7 +104,7 @@ Print help (see a summary with \fB\-h\fR).
.SH EXAMPLES
.PP
Create the add-secret request on a trusted system. The program generates two
files. \fFaddsecreq.bin\fP contains the add-secret request. \fEXAMPLE.yaml\fP
files. \fBaddsecreq.bin\fR contains the add-secret request. \fBEXAMPLE.yaml\fR
contains the non-confidential information about the generated secret. It
contains name and id of the secret.
.PP