mainpage.docs: udpated debug logging documentation

darcs-hash:20061011132250-65a35-4cf57a1b8caeac577a94538fee4b9824cdff04b7.gz

libsofia-sip-ua/docs/mainpage.docs

@@ -697,11 +697,11 @@ This file is generated by config.status and configure script.
 /**
 @page debug_logs Debugging Logs
 
-The Sofia-SIP components can output various debugging information. The detail of
-the debugging output is determined by the debugging level. The level is
-usually module-specific and can be modified by module-specific environment
-variable. There is also a default level for all modules, controlled by
-environment variable #SOFIA_DEBUG.
+The Sofia-SIP components can output various debugging information. The
+detail of the debugging output is determined by the debugging level. The
+level is usually module-specific and it can be modified by module-specific
+environment variable. There is also a default level for all modules,
+controlled by environment variable #SOFIA_DEBUG.
 
 The environment variables controlling the logging and other debug output are
 as follows:
@@ -717,12 +717,24 @@ as follows:
 - #SU_DEBUG	<a href="nea/index.html">su</a> module debug level (0..9)
 
 The defined debug output levels are:
-- 0 fatal errors, panic
-- 1 critical errors, minimal progress at subsystem level
-- 2 non-critical errors
-- 3 warnings, progress messages
-- 5 signaling protocol actions (incoming packets, ...)
-- 7 media protocol actions (incoming packets, ...)
-- 9 entering/exiting functions, very verbatim progress
+- 0 SU_DEBUG_0() - fatal errors, panic
+- 1 SU_DEBUG_1() - critical errors, minimal progress at subsystem level
+- 2 SU_DEBUG_2() - non-critical errors
+- 3 SU_DEBUG_3() - warnings, progress messages
+- 5 SU_DEBUG_5() - signaling protocol actions (incoming packets, ...)
+- 7 SU_DEBUG_7() - media protocol actions (incoming packets, ...)
+- 9 SU_DEBUG_9() - entering/exiting functions, very verbatim progress
+
+In addition to the macros mentioned above, there is also functions for 
+printing logging messages:
+- su_llog(), su_vllog()
+- su_perror(), su_perror2()
+
+The log level can be set (to a level defined in a configuration file, for
+instance) with following functions
+- su_log_set_level(), su_log_soft_set_level()
+
+The log output can be redirected to, e.g., system log or loggin server, with
+su_log_redirect().
 
 */