git:master: kex: added module documentation - sr-dev

16 Apr 2009

Module: sip-router
Branch: master
Commit: 618be5d48b24b62575ca9c5f0b2f10af4bd17c71
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=618be5d4...
Author: Daniel-Constantin Mierla miconda@gmail.com
Committer: Daniel-Constantin Mierla miconda@gmail.com
Date:   Thu Apr 16 22:08:04 2009 +0200
kex: added module documentation
- added source XML files and generated README
---
modules_k/kex/README            |  130 ++++++++++++++++++++++++++++++
 modules_k/kex/doc/kex.xml       |   47 +++++++++++
 modules_k/kex/doc/kex_admin.xml |  169 +++++++++++++++++++++++++++++++++++++++
 3 files changed, 346 insertions(+), 0 deletions(-)

diff --git a/modules_k/kex/README b/modules_k/kex/README
new file mode 100644
index 0000000..444a973
--- /dev/null
+++ b/modules_k/kex/README
@@ -0,0 +1,130 @@
+KEx Module
+
+Daniel-Constantin Mierla
+
+   asipto.com
+   miconda@gmail.com
+
+Edited by
+
+Daniel-Constantin Mierla
+
+   miconda@gmail.com
+
+   Copyright � 2009 Daniel-Constantin Mierla
+     __________________________________________________________
+
+   Table of Contents
+
+   1. Admin Guide
+
+        1.1. Overview
+        1.2. Dependencies
+
+              1.2.1. Kamailio Modules
+              1.2.2. External Libraries or Applications
+
+        1.3. Exported MI Functions
+
+              1.3.1. arg
+              1.3.2. kill
+              1.3.3. pwd
+              1.3.4. uptime
+              1.3.5. version
+              1.3.6. which
+
+Chapter 1. Admin Guide
+
+1.1. Overview
+
+   This module collects extensions from Kamailio core.
+
+   Kamailio Core CookBook is available at:
+   http://kamailio.org/dokuwiki/
+
+1.2. Dependencies
+
+1.2.1. Kamailio Modules
+
+   The following modules must be loaded before this module:
+     * No dependencies on other Kamailio modules.
+
+1.2.2. External Libraries or Applications
+
+   The following libraries or applications must be installed
+   before running Kamailio with this module loaded:
+     * None.
+
+1.3. Exported MI Functions
+
+1.3.1.  arg
+
+   Print command line arguments.
+
+   Name: arg
+
+   Parameters: none.
+
+   MI FIFO Command Format:
+                :arg:_reply_fifo_file_
+                _empty_line_
+
+1.3.2.  kill
+
+   Kill the application.
+
+   Name: kill
+
+   Parameters: none.
+
+   MI FIFO Command Format:
+                :kill:_reply_fifo_file_
+                _empty_line_
+
+1.3.3.  pwd
+
+   Print working directory.
+
+   Name: pwd
+
+   Parameters: none.
+
+   MI FIFO Command Format:
+                :pwd:_reply_fifo_file_
+                _empty_line_
+
+1.3.4.  uptime
+
+   Print uptime.
+
+   Name: uptime
+
+   Parameters: none.
+
+   MI FIFO Command Format:
+                :uptime:_reply_fifo_file_
+                _empty_line_
+
+1.3.5.  version
+
+   Print version information.
+
+   Name: version
+
+   Parameters: none.
+
+   MI FIFO Command Format:
+                :version:_reply_fifo_file_
+                _empty_line_
+
+1.3.6.  which
+
+   Print list of available MI commands.
+
+   Name: which
+
+   Parameters: none.
+
+   MI FIFO Command Format:
+                :which:_reply_fifo_file_
+                _empty_line_
diff --git a/modules_k/kex/doc/kex.xml b/modules_k/kex/doc/kex.xml
new file mode 100644
index 0000000..a9b3f52
--- /dev/null
+++ b/modules_k/kex/doc/kex.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+
+
+<!ENTITY admin SYSTEM "kex_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
+
+<!-- Include general documentation entities -->
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
+%docentities;
+
+]>
+
+<book>
+    <bookinfo>
+	<title>KEx Module</title>
+	<productname class="trade">&kamailioname;</productname>
+	<authorgroup>
+	    <author>
+		<firstname>Daniel-Constantin</firstname>
+		<surname>Mierla</surname>
+		<affiliation><orgname>asipto.com</orgname></affiliation>
+		<email>miconda@gmail.com</email>
+		<address>
+		<otheraddr>
+		<ulink url="http://www.asipto.com">http://www.asipto.com</ulink>
+		</otheraddr>
+		</address>
+	    </author>
+	    <editor>
+		<firstname>Daniel-Constantin</firstname>
+		<surname>Mierla</surname>
+		<email>miconda@gmail.com</email>
+	    </editor>
+	</authorgroup>
+	<copyright>
+	    <year>2009</year>
+	    <holder>Daniel-Constantin Mierla</holder>
+	</copyright>
+    </bookinfo>
+    <toc></toc>
+    
+    &admin;
+    &faq;
+    
+</book>
diff --git a/modules_k/kex/doc/kex_admin.xml b/modules_k/kex/doc/kex_admin.xml
new file mode 100644
index 0000000..50a5641
--- /dev/null
+++ b/modules_k/kex/doc/kex_admin.xml
@@ -0,0 +1,169 @@
+<!-- Module User's Guide -->
+
+<chapter>
+	
+	<title>&adminguide;</title>
+	
+	<section>
+	<title>Overview</title>
+	<para>
+	This module collects extensions from Kamailio core.
+	</para>
+	<para>
+	Kamailio Core CookBook is available at:
+	<ulink url="http://kamailio.org/dokuwiki/">
+	http://kamailio.org/dokuwiki/</ulink>
+	</para>
+	</section>
+	
+	<section>
+	<title>Dependencies</title>
+	<section>
+		<title>&kamailio; Modules</title>
+		<para>
+		The following modules must be loaded before this module:
+			<itemizedlist>
+			<listitem>
+			<para>
+				<emphasis>No dependencies on other &kamailio; modules</emphasis>.
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+	</section>
+	<section>
+		<title>External Libraries or Applications</title>
+		<para>
+		The following libraries or applications must be installed before running
+		&kamailio; with this module loaded:
+			<itemizedlist>
+			<listitem>
+			<para>
+				<emphasis>None</emphasis>.
+			</para>
+			</listitem>
+			</itemizedlist>
+		</para>
+	</section>
+	</section>
+
+	<section>
+	<title>Exported MI Functions</title>
+	<section>
+		<title>
+		<function moreinfo="none">arg</function>
+		</title>
+		<para>
+		Print command line arguments.
+		</para>
+		<para>
+		Name: <emphasis>arg</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis>.</para>
+ 		<para>
+		MI FIFO Command Format:
+		</para>
+        <programlisting  format="linespecific">
+		:arg:_reply_fifo_file_
+		_empty_line_
+		</programlisting>
+    </section>
+	<section>
+		<title>
+		<function moreinfo="none">kill</function>
+		</title>
+		<para>
+		Kill the application.
+		</para>
+		<para>
+		Name: <emphasis>kill</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis>.</para>
+ 		<para>
+		MI FIFO Command Format:
+		</para>
+        <programlisting  format="linespecific">
+		:kill:_reply_fifo_file_
+		_empty_line_
+		</programlisting>
+    </section>
+	<section>
+		<title>
+		<function moreinfo="none">pwd</function>
+		</title>
+		<para>
+		Print working directory.
+		</para>
+		<para>
+		Name: <emphasis>pwd</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis>.</para>
+ 		<para>
+		MI FIFO Command Format:
+		</para>
+        <programlisting  format="linespecific">
+		:pwd:_reply_fifo_file_
+		_empty_line_
+		</programlisting>
+    </section>
+	<section>
+		<title>
+		<function moreinfo="none">uptime</function>
+		</title>
+		<para>
+		Print uptime.
+		</para>
+		<para>
+		Name: <emphasis>uptime</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis>.</para>
+ 		<para>
+		MI FIFO Command Format:
+		</para>
+        <programlisting  format="linespecific">
+		:uptime:_reply_fifo_file_
+		_empty_line_
+		</programlisting>
+    </section>
+	<section>
+		<title>
+		<function moreinfo="none">version</function>
+		</title>
+		<para>
+		Print version information.
+		</para>
+		<para>
+		Name: <emphasis>version</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis>.</para>
+ 		<para>
+		MI FIFO Command Format:
+		</para>
+        <programlisting  format="linespecific">
+		:version:_reply_fifo_file_
+		_empty_line_
+		</programlisting>
+    </section>
+	<section>
+		<title>
+		<function moreinfo="none">which</function>
+		</title>
+		<para>
+		Print list of available MI commands.
+		</para>
+		<para>
+		Name: <emphasis>which</emphasis>
+		</para>
+		<para>Parameters: <emphasis>none</emphasis>.</para>
+ 		<para>
+		MI FIFO Command Format:
+		</para>
+        <programlisting  format="linespecific">
+		:which:_reply_fifo_file_
+		_empty_line_
+		</programlisting>
+    </section>
+    </section>
+
+</chapter>
+

    