<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>Open SCAP Library: Debug</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.4 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Open SCAP Library</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#define-members">Defines</a> </div> <div class="headertitle"> <div class="title">Debug</div> </div> <div class="ingroups"><a class="el" href="group__COMMON.html">Common</a></div></div> <div class="contents"> <p>Debuging mechanism. <a href="#details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Debug.html#gaf00d3dee02bec38d88b90114c440d7e2">OSCAP_DEBUG_FILE</a>   "oscap_debug.log"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Hardcodede output filename. <a href="#gaf00d3dee02bec38d88b90114c440d7e2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gadac017b064344cfb872d2c585efeac56"></a><!-- doxytag: member="Debug::OSCAP_DEBUG_FILE_ENV" ref="gadac017b064344cfb872d2c585efeac56" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Debug.html#gadac017b064344cfb872d2c585efeac56">OSCAP_DEBUG_FILE_ENV</a>   "OSCAP_DEBUG_FILE"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the environment variable that can be used to change the default output filename. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Debug.html#gac0c33ea248158ac24ddda0a9abf42f8b">OSCAP_DEBUG_LEVEL_ENV</a>   "OSCAP_DEBUG_LEVEL"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the environment variable that can be used to change the debug level, i.e. <a href="#gac0c33ea248158ac24ddda0a9abf42f8b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Debug.html#gadf5618c604c8c636560b0e461781aa6d">OSCAP_DEBUG_PATHSTRIP_ENV</a>   "OSCAP_DEBUG_PSTRIP"</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Name of the environment variable that can be used to enable striping of __FILE__ paths. <a href="#gadf5618c604c8c636560b0e461781aa6d"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <p>Debuging mechanism. </p> <p>If you compile library with enabled debugging support, you will get log messages in file named according to OSCAP_DEBUG_FILE macro. You can change log file name by setting OSCAP_DEBUG_FILE environment variable to your needs. </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="gaf00d3dee02bec38d88b90114c440d7e2"></a><!-- doxytag: member="debug.h::OSCAP_DEBUG_FILE" ref="gaf00d3dee02bec38d88b90114c440d7e2" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_DEBUG_FILE   "oscap_debug.log"</td> </tr> </table> </div> <div class="memdoc"> <p>Hardcodede output filename. </p> <p>This is used as the default filename if the variable specified by OSCAP_DEBUG_FILE_ENV isn't defined. </p> </div> </div> <a class="anchor" id="gac0c33ea248158ac24ddda0a9abf42f8b"></a><!-- doxytag: member="debug.h::OSCAP_DEBUG_LEVEL_ENV" ref="gac0c33ea248158ac24ddda0a9abf42f8b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_DEBUG_LEVEL_ENV   "OSCAP_DEBUG_LEVEL"</td> </tr> </table> </div> <div class="memdoc"> <p>Name of the environment variable that can be used to change the debug level, i.e. </p> <p>the number and verbosity of the debug messages. XXX: not implemented yet </p> </div> </div> <a class="anchor" id="gadf5618c604c8c636560b0e461781aa6d"></a><!-- doxytag: member="debug.h::OSCAP_DEBUG_PATHSTRIP_ENV" ref="gadf5618c604c8c636560b0e461781aa6d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define OSCAP_DEBUG_PATHSTRIP_ENV   "OSCAP_DEBUG_PSTRIP"</td> </tr> </table> </div> <div class="memdoc"> <p>Name of the environment variable that can be used to enable striping of __FILE__ paths. </p> <p>It's numeric value specifies how many path tokens from the end should remain after striping. Value 1 is equal to basename(__FILE__) If this environment variable isn't defined or is set to 0 then no striping is done. </p> </div> </div> </div> <hr class="footer"/><address class="footer"><small>Generated on Mon Jul 25 2011 for Open SCAP Library by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>