[sr-dev] git:master: presence_xml: readme updated

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Thu Jun 11 22:21:28 2009 +0300

presence_xml: readme updated

- documented passive_mode parameter and mentioned $xml(...) PV

---

 modules_k/presence_xml/README                     |   26 ++++++++++++++++
 modules_k/presence_xml/doc/presence_xml_admin.xml |   33 +++++++++++++++++++++
 2 files changed, 59 insertions(+), 0 deletions(-)

diff --git a/modules_k/presence_xml/README b/modules_k/presence_xml/README
index 25a8be2..d9fafe5 100644
--- a/modules_k/presence_xml/README
+++ b/modules_k/presence_xml/README
@@ -35,9 +35,11 @@ Anca-Maria Vamanu
               3.7. pidf_manipulation (int)
               3.8. integrated_xcap_server (int)
               3.9. xcap_server (str)
+              3.10. passive_mode(int)
 
         4. Exported Functions
         5. Installation
+        6. Exported pseudo-variables
 
    2. Developer Guide
 
@@ -52,6 +54,7 @@ Anca-Maria Vamanu
    1.7. Set pidf_manipulation parameter
    1.8. Set integrated_xcap_server parameter
    1.9. Set xcap_server parameter
+   1.10. Set passive_mode parameter
 
 Chapter 1. Admin Guide
 
@@ -74,9 +77,11 @@ Chapter 1. Admin Guide
         3.7. pidf_manipulation (int)
         3.8. integrated_xcap_server (int)
         3.9. xcap_server (str)
+        3.10. passive_mode(int)
 
    4. Exported Functions
    5. Installation
+   6. Exported pseudo-variables
 
 1. Overview
 
@@ -123,6 +128,7 @@ Chapter 1. Admin Guide
    3.7. pidf_manipulation (int)
    3.8. integrated_xcap_server (int)
    3.9. xcap_server (str)
+   3.10. passive_mode(int)
 
 3.1. db_url(str)
 
@@ -252,6 +258,19 @@ modparam("presence_xml", "xcap_server", "xcap_server.example.org")
 modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
 ...
 
+3.10. passive_mode(int)
+
+   If set to 1, module acts in passive mode - no bind to presence module,
+   no connection to database. Useful when needing only to use $xml(...)
+   pseudoc-variable.
+
+   Default value: "0" (0 - active mode, 1 - passive mode).
+
+   Example 1.10. Set passive_mode parameter
+...
+modparam("presence_xml", "passive_mode", 1)
+...
+
 4. Exported Functions
 
    None to be used in configuration file.
@@ -264,6 +283,13 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
    the complete database documentation on the project webpage,
    http://www.kamailio.org/docs/db-tables/kamailio-db-devel.html.
 
+6. Exported pseudo-variables
+
+     * $xml(name=>spec)
+
+   Exported pseudo-variables are documented at
+   http://www.kamailio.org/dokuwiki/.
+
 Chapter 2. Developer Guide
 
    The module exports no function to be used in other Kamailio modules.
diff --git a/modules_k/presence_xml/doc/presence_xml_admin.xml b/modules_k/presence_xml/doc/presence_xml_admin.xml
index f706705..16a22bd 100644
--- a/modules_k/presence_xml/doc/presence_xml_admin.xml
+++ b/modules_k/presence_xml/doc/presence_xml_admin.xml
@@ -276,6 +276,27 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
 </programlisting>
 		</example>
 	</section>
+	<section>
+		<title><varname>passive_mode</varname>(int)</title>
+		<para>
+		If set to 1, module acts in passive mode - no bind to presence module,
+		no connection to database. Useful when needing only to use $xml(...)
+		pseudoc-variable.
+		</para>
+		<para>
+			<emphasis>Default value: <quote>0</quote> (0 - active mode,
+				1 - passive mode).
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>passive_mode</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("presence_xml", "passive_mode", 1)
+...
+</programlisting>
+		</example>
+	</section>
 </section>
 <section>
 	<title>Exported Functions</title>
@@ -295,5 +316,17 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
 	</para>
 </section>
 
+<section>
+	<title>Exported pseudo-variables</title>
+	<itemizedlist>
+		<listitem><para>
+			<emphasis>$xml(name=>spec)</emphasis>
+		</para></listitem>
+	</itemizedlist>
+	<para>
+	Exported pseudo-variables are documented at &kamwikilink;.
+	</para>
+</section>
+
 </chapter>