Skip to content

Commit

Permalink
man: Extend man pages with --flags support for CUSE TPM
Browse files Browse the repository at this point in the history
Also fix an error in the man page on the way. 'startup-deactivated'
can only be used with a TPM 1.2, not a TPM 2.

Signed-off-by: Stfean Berger <stefanb@linux.ibm.com>
  • Loading branch information
stefanberger committed Oct 12, 2020
1 parent 5cb3a6d commit 72108f5
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 14 deletions.
28 changes: 14 additions & 14 deletions man/man8/swtpm.pod
Original file line number Diff line number Diff line change
Expand Up @@ -141,20 +141,6 @@ This operation requires root privileges.

The control channel enables out-of-band control of the TPM, such as resetting the TPM.

=item B<--flags [not-need-init] [,startup-clear|startup-state|startup-deactivated|startup-none]>

The I<not-need-init> flag enables the TPM to accept TPM commands right after
start without requiring a INIT to be sent to it through the command channel
(see the '-i' option of swtpm_ioctl).

The I<startup> options cause a TPM_Startup or TPM2_Startup command to
automatically be sent. The I<startup-deactivated> option is only valid for
a TPM 2.0. These options imply I<not-need-init>, except for the
I<startup-none> option, which results in no command being sent.

If I<--vtpm-proxy> is used, I<startup-clear> is automatically chosen but
this can be changed with this option.

=back


Expand Down Expand Up @@ -282,6 +268,20 @@ The I<log> action is only available if libseccomp supports logging.
This option is only available on Linux and only if swtpm was compiled with
libseccomp support.

=item B<--flags [not-need-init] [,startup-clear|startup-state|startup-deactivated|startup-none]>

The I<not-need-init> flag enables the TPM to accept TPM commands right after
start without requiring an INIT to be sent to it through the command channel
(see the '-i' option of swtpm_ioctl).

The I<startup> options cause a TPM_Startup or TPM2_Startup command to
automatically be sent. The I<startup-deactivated> option is only valid for
a TPM 1.2. These options imply I<not-need-init>, except for the
I<startup-none> option, which results in no command being sent.

If I<--vtpm-proxy> is used, I<startup-clear> is automatically chosen but
this can be changed with this option.

=item B<--print-capabilities> (since v0.2)

Print capabilities that were added to swtpm after version 0.1. The output
Expand Down
14 changes: 14 additions & 0 deletions man/man8/swtpm_cuse.pod
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,20 @@ The I<log> action is only available if libseccomp supports logging.
This option is only available on Linux and only if swtpm was compiled with
libseccomp support.

=item B<--flags [not-need-init] [,startup-clear|startup-state|startup-deactivated|startup-none]>

The I<not-need-init> flag enables the TPM to accept TPM commands right after
start without requiring an INIT to be sent to it through the command channel
(see the '-i' option of swtpm_ioctl).

The I<startup> options cause a TPM_Startup or TPM2_Startup command to
automatically be sent. The I<startup-deactivated> option is only valid for
a TPM 1.2. These options imply I<not-need-init>, except for the
I<startup-none> option, which results in no command being sent.

If I<--vtpm-proxy> is used, I<startup-clear> is automatically chosen but
this can be changed with this option.

=item B<--print-capabilities> (since v0.2)

Print capabilities that were added to swtpm after version 0.1. The output
Expand Down

0 comments on commit 72108f5

Please sign in to comment.