1=head1 NAME
2
3tpm_nvread
4
5=head1 SYNOPSIS
6
7B<tpm_nvread [OPTIONS]>
8
9=head1 DESCRIPTION
10
11B<tpm_nvread> reads data from an NVRAM area and either displays them or writes
12them into a file. The user must provide the index of the NVRAM area. If the
13user provided the number of bytes to read then this will be the maximum
14number of bytes that will be read from the NVRAM area, otherwise the whole
15NVRAM area will be read. Some NVRAM areas only allow read sizes of zero,
16i.e., NVRAM area index 0. Optionally an offset into the NVRAM
17area can be given where the reading of the data is to start. If the NVRAM
18area has permission bits set that require owner or NVRAM area authentication,
19then the password must be provided via the password option.
20
21The following options are supported:
22
23=over 4
24
25=item B<-h, --help>
26
27Display command usage info.
28
29=item B<-v, --version>
30
31Display command version info.
32
33=item B<-l, --log [none|error|info|debug]>
34
35Set logging level.
36
37=item B<-u, --unicode>
38
39Use TSS UNICODE encoding for passwords to comply with applications
40using TSS popup boxes
41
42=item B<-z, --well-known>
43
44Use a secret of all zeros (20 bytes of zeros) as either the NVRAM area or owner secret.
45
46=item B<-p, --password>
47
48Depending on what type of authentication is required for the NVRAM area, this must either
49be the NVRAM area or owner password.
50
51A password may be directly provided for example by using '--password=password' or
52'-ppassword'. If no password is provided then the program will prompt the user for the
53password.
54
55=item B<-i, --index>
56
57The index of the NVRAM area.
58The parameter may either be a decimal number or a hexadecimal number starting with '0x'.
59
60=item B<-s, --size>
61
62The number of bytes to read from the NVRAM area.
63The parameter may either be a decimal number or a hexadecimal number starting with '0x'.
64
65=item B<-n, --offset> (optional parameter)
66
67The offset into the NVRAM area from where to start reading.
68The parameter may either be a decimal number or a hexadecimal number starting with '0x'.
69
70=item B<-f, --filename> (optional parameter)
71
72The name of a file the read data will be written into. If no filename is
73given the data will be printed to stdout.
74
75
76=back
77
78=head1 SEE ALSO
79
80B<tpm_nvdefine>(8), B<tpm_nvinfo>(8), B<tpm_nvrelease>(8), B<tpm_nvwrite>(8)
81
82=head1 REPORTING BUGS
83
84Report bugs to <trousers-users@lists.sourceforge.net>
85