[sr-dev] git:master: xlog(k): readme updated with log_facility param

[Elena-Ramona Modroiu]

Module: sip-router
Branch: master
Commit: 2bc80f622d415d9745ba47909c6a47d340dad8b9
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=2bc80f622d415d9745ba47909c6a47d340dad8b9

Author: Elena-Ramona Modroiu <ramona at asipto.com>
Committer: Elena-Ramona Modroiu <ramona at asipto.com>
Date:   Thu Jun 30 11:17:32 2011 +0200

xlog(k): readme updated with log_facility param

---

 modules_k/xlog/README             |   24 ++++++++++++++++++++----
 modules_k/xlog/doc/xlog_admin.xml |   19 +++++++++++++++++++
 2 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/modules_k/xlog/README b/modules_k/xlog/README
index d1e0f92..bf433d8 100644
--- a/modules_k/xlog/README
+++ b/modules_k/xlog/README
@@ -33,6 +33,7 @@ Elena-Ramona Modroiu
               4.2. force_color (integer)
               4.3. long_format (integer)
               4.4. prefix (str)
+              4.5. log_facility (string)
 
         5. Exported Functions
 
@@ -47,8 +48,9 @@ Elena-Ramona Modroiu
    1.2. Set force_color parameter
    1.3. Set long_format parameter
    1.4. Set prefix parameter
-   1.5. xlog usage
-   1.6. xdbg usage
+   1.5. log_facility example
+   1.6. xlog usage
+   1.7. xdbg usage
 
 Chapter 1. Admin Guide
 
@@ -67,6 +69,7 @@ Chapter 1. Admin Guide
         4.2. force_color (integer)
         4.3. long_format (integer)
         4.4. prefix (str)
+        4.5. log_facility (string)
 
    5. Exported Functions
 
@@ -122,6 +125,7 @@ Chapter 1. Admin Guide
    4.2. force_color (integer)
    4.3. long_format (integer)
    4.4. prefix (str)
+   4.5. log_facility (string)
 
 4.1. buf_size (integer)
 
@@ -168,6 +172,18 @@ modparam("xlog", "long_format", 1)
 modparam("xlog", "prefix", "-xlog: ")
 ...
 
+4.5. log_facility (string)
+
+   Syslog facility to be used when printing xlog messages. In this way you
+   can get the xlog messages in a separate syslog file than the debug
+   messages issued from source code.
+
+   Default value is NULL (unset - use same facility as source code debug
+   messages).
+
+   Example 1.5. log_facility example
+modparam("xlog", "log_facility", "LOG_DAEMON")
+
 5. Exported Functions
 
    5.1. xlog([level,] format)
@@ -199,7 +215,7 @@ modparam("xlog", "prefix", "-xlog: ")
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.5. xlog usage
+   Example 1.6. xlog usage
 ...
 xlog("L_ERR", "time [$Tf] method ($rm) r-uri ($ru) 2nd via ($hdr(via[1]))\n");
 ...
@@ -218,7 +234,7 @@ xlog("$var(loglevel)", "time [$Tf] method ($rm) r-uri ($ru)\n");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.6. xdbg usage
+   Example 1.7. xdbg usage
 ...
 xdbg("time $Cbx[$Tf]$Cxx method ($rm) r-uri ($ru)\n");
 ...
diff --git a/modules_k/xlog/doc/xlog_admin.xml b/modules_k/xlog/doc/xlog_admin.xml
index 683d110..bcd1c46 100644
--- a/modules_k/xlog/doc/xlog_admin.xml
+++ b/modules_k/xlog/doc/xlog_admin.xml
@@ -170,6 +170,25 @@ modparam("xlog", "prefix", "-xlog: ")
 </programlisting>
 		</example>
 	</section>
+	<section>
+		<title><varname>log_facility</varname> (string)</title>
+		<para>
+		Syslog facility to be used when printing xlog messages.
+		In this way you can get the xlog messages in a separate syslog file
+		than the debug messages issued from source code.
+		</para>
+		<para>
+		Default value is NULL (unset - use same facility as source code debug
+		messages).
+		</para>
+		<example>
+		<title>log_facility example</title>
+		<programlisting format="linespecific">
+modparam("xlog", "log_facility", "LOG_DAEMON")
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 	<section>
 	<title>Exported Functions</title>