diff --git a/man/man3/TPMLIB_GetInfo.pod b/man/man3/TPMLIB_GetInfo.pod index 053b5981..3d2d5ec6 100644 --- a/man/man3/TPMLIB_GetInfo.pod +++ b/man/man3/TPMLIB_GetInfo.pod @@ -14,8 +14,8 @@ B =head1 DESCRIPTION -The B function allows to query for TPM implementation -specifics and get a JSON string in return. Which data is to be returned +The B 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. diff --git a/man/man3/TPMLIB_RegisterCallbacks.pod b/man/man3/TPMLIB_RegisterCallbacks.pod index 709f394a..9dd8680f 100644 --- a/man/man3/TPMLIB_RegisterCallbacks.pod +++ b/man/man3/TPMLIB_RegisterCallbacks.pod @@ -21,7 +21,7 @@ B =head1 DESCRIPTION -The B functions allows to register several +The B 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. diff --git a/man/man3/TPMLIB_SetBufferSize.pod b/man/man3/TPMLIB_SetBufferSize.pod index 6ba7afe8..b322a3fb 100644 --- a/man/man3/TPMLIB_SetBufferSize.pod +++ b/man/man3/TPMLIB_SetBufferSize.pod @@ -16,7 +16,7 @@ B The B 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. diff --git a/man/man3/TPMLIB_SetDebugFD.pod b/man/man3/TPMLIB_SetDebugFD.pod index 25eda9cc..23799ab5 100644 --- a/man/man3/TPMLIB_SetDebugFD.pod +++ b/man/man3/TPMLIB_SetDebugFD.pod @@ -22,16 +22,16 @@ B =head1 DESCRIPTION -B allows to set the file descriptor +B allows the caller to set the file descriptor to send the debug output to. -B allows to set the debug level. +B 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 allows to set a prefix that is +B 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. diff --git a/man/man3/TPMLIB_SetProfile.pod b/man/man3/TPMLIB_SetProfile.pod index ca3170e6..cf0c935e 100644 --- a/man/man3/TPMLIB_SetProfile.pod +++ b/man/man3/TPMLIB_SetProfile.pod @@ -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 enabled 4096-bit RSA. A user may specify the I when using the I profile. In this case the given I serves as the maximum I 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 '4' is given. If I '3' is given then AES-192 will not be enabled. diff --git a/man/man3/TPMLIB_SetState.pod b/man/man3/TPMLIB_SetState.pod index 0fa21d8a..6e724de3 100644 --- a/man/man3/TPMLIB_SetState.pod +++ b/man/man3/TPMLIB_SetState.pod @@ -20,7 +20,7 @@ B function allows to set either one of the state blobs of +The B 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. 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 function allows to get the current state of the TPM. +The B 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 or the state is read from a file. Once the TPM has been started, the state of the running TPM is returned. diff --git a/man/man3/TPMLIB_ValidateState.pod b/man/man3/TPMLIB_ValidateState.pod index e2580351..5480c5c8 100644 --- a/man/man3/TPMLIB_ValidateState.pod +++ b/man/man3/TPMLIB_ValidateState.pod @@ -16,8 +16,8 @@ B function allows to validate the -state blobs that the TPM would read upon B or +The B function allows the caller to validate +the state blobs that the TPM would read upon B or once the TPM_Startup command has been sent to it. This function is useful for TPM state migration between possibly