tss2_nvread.1 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. .\" Automatically generated by Pandoc 1.19.2.4
  2. .\"
  3. .TH "tss2_nvread" "1" "APRIL 2019" "tpm2\-tools" "General Commands Manual"
  4. .hy
  5. .SH NAME
  6. .PP
  7. \f[B]tss2_nvread\f[](1) \-
  8. .SH SYNOPSIS
  9. .PP
  10. \f[B]tss2_nvread\f[] [\f[I]OPTIONS\f[]]
  11. .SH SEE ALSO
  12. .PP
  13. \f[B]fapi\-config(5)\f[] to adjust Fapi parameters like the used
  14. cryptographic profile and TCTI or directories for the Fapi metadata
  15. storages.
  16. .PP
  17. \f[B]fapi\-profile(5)\f[] to determine the cryptographic algorithms and
  18. parameters for all keys and operations of a specific TPM interaction
  19. like the name hash algorithm, the asymmetric signature algorithm, scheme
  20. and parameters and PCR bank selection.
  21. .SH DESCRIPTION
  22. .PP
  23. \f[B]tss2_nvread\f[](1) \- This command reads the entire data from an NV
  24. index of the TPM.
  25. .SH OPTIONS
  26. .PP
  27. These are the availabe options:
  28. .IP \[bu] 2
  29. \f[B]\-f\f[], \f[B]\-\-force\f[]:
  30. .RS 2
  31. .PP
  32. Force overwriting the output file.
  33. .RE
  34. .IP \[bu] 2
  35. \f[B]\-o\f[], \f[B]\-\-data\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  36. stdout):
  37. .RS 2
  38. .PP
  39. Returns the value read from the NV space.
  40. .RE
  41. .IP \[bu] 2
  42. \f[B]\-p\f[], \f[B]\-\-nvPath\f[]=\f[I]STRING\f[]:
  43. .RS 2
  44. .PP
  45. Identifies the NV space to read.
  46. .RE
  47. .IP \[bu] 2
  48. \f[B]\-l\f[], \f[B]\-\-logData\f[]=\f[I]FILENAME\f[] or \f[I]\-\f[] (for
  49. stdout):
  50. .RS 2
  51. .PP
  52. Returns the JSON encoded log, if the NV index is of type "extend" and an
  53. empty string otherwise.
  54. Optional parameter.
  55. .RE
  56. .SH COMMON OPTIONS
  57. .PP
  58. This collection of options are common to all tss2 programs and provide
  59. information that many users may expect.
  60. .IP \[bu] 2
  61. \f[B]\-h\f[], \f[B]\-\-help [man|no\-man]\f[]: Display the tools
  62. manpage.
  63. By default, it attempts to invoke the manpager for the tool, however, on
  64. failure will output a short tool summary.
  65. This is the same behavior if the "man" option argument is specified,
  66. however if explicit "man" is requested, the tool will provide errors
  67. from man on stderr.
  68. If the "no\-man" option if specified, or the manpager fails, the short
  69. options will be output to stdout.
  70. .RS 2
  71. .PP
  72. To successfully use the manpages feature requires the manpages to be
  73. installed or on \f[I]MANPATH\f[], See \f[B]man\f[](1) for more details.
  74. .RE
  75. .IP \[bu] 2
  76. \f[B]\-v\f[], \f[B]\-\-version\f[]: Display version information for this
  77. tool, supported tctis and exit.
  78. .SH EXAMPLE
  79. .IP
  80. .nf
  81. \f[C]
  82. tss2_nvread\ \-\-nvPath=/nv/Owner/myNV\ \-\-data=data.file
  83. \f[]
  84. .fi
  85. .SH RETURNS
  86. .PP
  87. 0 on success or 1 on failure.
  88. .SH BUGS
  89. .PP
  90. Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
  91. .SH HELP
  92. .PP
  93. See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)