mirror of
https://github.com/stefanberger/libtpms
synced 2026-08-12 18:28:32 +00:00
man: fix various typos found by Lintian
Signed-off-by: Luca Boccassi <luca.boccassi@gmail.com>
This commit is contained in:
parent
e96a61c1ef
commit
2c1deb52aa
@ -14,8 +14,8 @@ B<char *TPMLIB_GetInfo(TPMLIB_InfoFlags flags);>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<TPMLIB_GetInfo()> function allows to query for TPM implementation
|
||||
specifics and get a JSON string in return. Which data is to be returned
|
||||
The B<TPMLIB_GetInfo()> function allows the caller to query for TPM implementation
|
||||
specifics and to get a JSON string in return. Which data is to be returned
|
||||
can be specified in the flags parameter that may be a logical 'or' concatenation
|
||||
of flags. If passed flags are not supported, nothing is returned . If a 0 is
|
||||
passed in, an empty JSON Object '{}' is returned.
|
||||
|
||||
@ -21,7 +21,7 @@ B<TPM_RESULT TPMLIB_RegisterCallbacks(struct tpmlibrary_callbacks *);>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<TPMLIB_RegisterCallbacks()> functions allows to register several
|
||||
The B<TPMLIB_RegisterCallbacks()> functions allows callers to register several
|
||||
callback functions with libtpms that enable a user to implement customized
|
||||
behavior of several library-internal functions. This feature will typically
|
||||
be used if the behavior of the provided internal functions is not as needed.
|
||||
|
||||
@ -16,7 +16,7 @@ B<uint32_t TPMLIB_SetBufferSize(uint32_t, uint32_t *, uint32_t *);>
|
||||
|
||||
The B<TPMLIB_SetBufferSize()> function sets the size of the buffer
|
||||
the TPM can use for input and output and that it advertises to users.
|
||||
It also allows to get the minimum and maximum supported buffer
|
||||
It also allows users to get the minimum and maximum supported buffer
|
||||
size.
|
||||
|
||||
If 0 is given on input, the currently used buffer size is returned.
|
||||
|
||||
@ -22,16 +22,16 @@ B<uint32_t TPMLIB_SetDebugPrefix(const char *prefix);>
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
B<TPMLIB_SetDebugFD()> allows to set the file descriptor
|
||||
B<TPMLIB_SetDebugFD()> allows the caller to set the file descriptor
|
||||
to send the debug output to.
|
||||
|
||||
B<TPMLIB_SetDebugLevel()> allows to set the debug level.
|
||||
B<TPMLIB_SetDebugLevel()> allows the caller to set the debug level.
|
||||
Only debug levels greater than 1 will produce output. The indentation
|
||||
level of a line will determine whether it is printed. Lines with
|
||||
0 indentation will be printed at debug level 1, 1 space of indentation
|
||||
at debug level 2 and so on.
|
||||
|
||||
B<TPMLIB_SetDebugPrefix()> allows to set a prefix that is
|
||||
B<TPMLIB_SetDebugPrefix()> allows the caller to set a prefix that is
|
||||
to be printed in front of every line of debugging output. The
|
||||
prefix can be used for further indentation.
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@ libtpms to version 0.9 from a later version.
|
||||
|
||||
Profiles with the prefix 'default' enable as many algorithms and commands
|
||||
as possible. The 'default-v1' profile, introduced with libtpms v0.10, allows
|
||||
to run with libtpms v0.10 and later but will not allow to downgrade to
|
||||
to run with libtpms v0.10 and later but will not allow downgrading to
|
||||
earlier versions of libtpms, such as v0.9.
|
||||
|
||||
A profile is a JSON map in string format. It must contain the 'Name'
|
||||
@ -204,8 +204,8 @@ This I<StateFormatLevel> enabled 4096-bit RSA.
|
||||
A user may specify the I<StateFormatLevel> when using the I<custom> profile.
|
||||
In this case the given I<StateFormatLevel> serves as the maximum
|
||||
I<StateFormatLevel> that the given algorithms and commands may require
|
||||
(e.g., '2' would not allow to enable the command ECC_Encrypt, which
|
||||
requires '3') or allows to enable key sizes, such as AES-192, when for
|
||||
(e.g., '2' would not allow enabling the command ECC_Encrypt, which
|
||||
requires '3') or allows enabling key sizes, such as AES-192, when for
|
||||
example I<StateFormatLevel> '4' is given. If I<StateFormatLevel> '3'
|
||||
is given then AES-192 will not be enabled.
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ B<TPM_RESULT TPMLIB_GetState(enum TPMLIB_StateType st,
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<TPMLIB_SetState()> function allows to set either one of the state blobs of
|
||||
The B<TPMLIB_SetState()> function allows setting either one of the state blobs of
|
||||
the TPM. The passed state blob is tested for whether it can be accepted and a TPM
|
||||
error code is returned in case it cannot be accepted. In case of acceptance, the
|
||||
state blob will be passed to the TPM upon B<TPM_MainInit()>. Setting a state blob
|
||||
@ -37,7 +37,7 @@ The order in which state blobs are set is important. The first state blob has
|
||||
to be the one representing the TPM's permanent state. Only after that either
|
||||
the volatile or save state blobs can be set.
|
||||
|
||||
The B<TPMLIB_GetState()> function allows to get the current state of the TPM.
|
||||
The B<TPMLIB_GetState()> function allows the caller to get the current state of the TPM.
|
||||
For as long as the TPM has not been started, this function either returns the state
|
||||
blob previously set with B<TPMLIB_SetState()> or the state is read from a file.
|
||||
Once the TPM has been started, the state of the running TPM is returned.
|
||||
|
||||
@ -16,8 +16,8 @@ B<uint32_t TPMLIB_ValidateState(TPMLIB_StateType st,
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
The B<TPMLIB_ValidateState()> function allows to validate the
|
||||
state blobs that the TPM would read upon B<TPMLIB_MainInit()> or
|
||||
The B<TPMLIB_ValidateState()> function allows the caller to validate
|
||||
the state blobs that the TPM would read upon B<TPMLIB_MainInit()> or
|
||||
once the TPM_Startup command has been sent to it.
|
||||
|
||||
This function is useful for TPM state migration between possibly
|
||||
|
||||
Loading…
Reference in New Issue
Block a user