libtpms/man/man3/TPMLIB_SetDebugFD.pod
Stefan Berger 7fb176bcc4 Implement API calls for enabling debug output
Add API calls TPMLIB_SetDebugFD(), TPMLIB_SetDebugLevel(),
TPMLIB_SetDebugPrefix().

Convert the internal printing of debugging strings to
correspond to the log level. Print the prefix in front
of every line.

Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
2017-01-23 18:53:31 -05:00

39 lines
1.0 KiB
Plaintext

=head1 NAME
TPMLIB_SetDebugFD - Set the file descriptor to send the debug output to
TPMLIB_SetDebugLevel - Set the debugging level
TPMLIB_SetDebugPrefix - Set the prefix for each debugging line
=head1 LIBRARY
TPM library (libtpms, -ltpms)
=head1 SYNOPSIS
B<#include <libtpms/tpm_library.h>>
B<uint32_t TPMLIB_SetDebugFD(int fd);>
B<uint32_t TPMLIB_SetDebugLevel(unsigned int level);>
B<uint32_t TPMLIB_SetDebugPrefix(const char *prefix);>
=head1 DESCRIPTION
B<TPMLIB_SetDebugFD()> allows to set the file descriptor
to send the debug output to.
B<TPMLIB_SetDebugLevel()> allows 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
to be printed in front of every line of debugging output. The
prefix can be used for further indentation.
=cut