csu3_am335x/EVSE/GPL/tpm2-tools-5.1/man/man1/tpm2_rc_decode.1

.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "tpm2_rc_decode" "1" "" "tpm2\-tools" "General Commands Manual"
.hy
.SH NAME
.PP
\f[B]tpm2_rc_decode\f[](1) \- Decode TPM2 error codes to a human
readable format.
.SH SYNOPSIS
.PP
\f[B]tpm2_rc_decode\f[] [\f[I]OPTIONS\f[]] [\f[I]ARGUMENT\f[]]
.SH DESCRIPTION
.PP
\f[B]tpm2_rc_decode\f[](1) \- Converts an \f[I]RC_CODE\f[] from the TPM
or TSS2 software stack into human readable errors.
Analogous to \f[B]strerror\f[](3), but for the TPM2 stack.
.SH OPTIONS
.PP
This tool takes no tool specific options.
.IP \[bu] 2
\f[B]ARGUMENT\f[] the command line argument specifies the error code to
be parsed.
.SS References
.SH COMMON OPTIONS
.PP
This collection of options are common to many programs and provide
information that many users may expect.
.IP \[bu] 2
\f[B]\-h\f[], \f[B]\-\-help=[man|no\-man]\f[]: Display the tools
manpage.
By default, it attempts to invoke the manpager for the tool, however, on
failure will output a short tool summary.
This is the same behavior if the "man" option argument is specified,
however if explicit "man" is requested, the tool will provide errors
from man on stderr.
If the "no\-man" option if specified, or the manpager fails, the short
options will be output to stdout.
.RS 2
.PP
To successfully use the manpages feature requires the manpages to be
installed or on \f[I]MANPATH\f[], See man(1) for more details.
.RE
.IP \[bu] 2
\f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
tool, supported tctis and exit.
.IP \[bu] 2
\f[B]\-V\f[], \f[B]\-\-verbose\f[]: Increase the information that the
tool prints to the console during its execution.
When using this option the file and line number are printed.
.IP \[bu] 2
\f[B]\-Q\f[], \f[B]\-\-quiet\f[]: Silence normal tool output to stdout.
.IP \[bu] 2
\f[B]\-Z\f[], \f[B]\-\-enable\-errata\f[]: Enable the application of
errata fixups.
Useful if an errata fixup needs to be applied to commands sent to the
TPM.
Defining the environment TPM2TOOLS_ENABLE_ERRATA is equivalent.
information many users may expect.
.SH EXAMPLES
.IP
.nf
\f[C]
tpm2_rc_decode\ 0x1d5
tpm:parameter(1):structure\ is\ the\ wrong\ size
\f[]
.fi
.SH Returns
.PP
Tools can return any of the following codes:
.IP \[bu] 2
0 \- Success.
.IP \[bu] 2
1 \- General non\-specific error.
.IP \[bu] 2
2 \- Options handling error.
.IP \[bu] 2
3 \- Authentication error.
.IP \[bu] 2
4 \- TCTI related error.
.IP \[bu] 2
5 \- Non supported scheme.
Applicable to tpm2_testparams.
.SH BUGS
.PP
Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
.SH HELP
.PP
See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)