Merge pull request #926 from mslehto/doc

documentation updates

src/modules/benchmark/doc/benchmark_admin.xml

@@ -74,7 +74,7 @@
 			<listitem>
 			<para>
 				0 - Enable per-timer enabling. Single timers are inactive by default
-				and can be activated through the MI interface as soon as that feature is
+				and can be activated through the RPC interface as soon as that feature is
 				implemented.
 			</para>
 			</listitem>
@@ -297,8 +297,8 @@ bm_log_timer("test");
 </programlisting>
 			</example>
 		</section>
-		<section id="benachmark.rpc.granularity">
-			<title><function moreinfo="none">benachmark.granularity</function></title>
+		<section id="benchmark.rpc.granularity">
+			<title><function moreinfo="none">benchmark.granularity</function></title>
 			<para>
 				Modifies the benchmarking granularity. See "granularity" variable.
 			</para>

src/modules/carrierroute/doc/carrierroute.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding='ISO-8859-1'?>
+<?xml version="1.0" encoding='UTF-8'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 

src/modules/carrierroute/doc/carrierroute_admin.xml

@@ -1,7 +1,8 @@
-<?xml version="1.0" encoding='ISO-8859-1'?>
+<?xml version="1.0" encoding='UTF-8'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-
+<!ENTITY % local.common.attrib
+	"xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">
 <!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
 %docentities;
 
@@ -37,7 +38,7 @@
 		database driven routing creates.
 	</para>
 	<para>
-		Routing tables can be reloaded and edited (in config file mode) with the MI
+		Routing tables can be reloaded and edited (in config file mode) with the RPC
 		interface, the config file is updated according the changes. This is not
 		implemented for the db interface, because its easier to do the changes
 		directly on the db. But the reload and dump functions works of course here
@@ -648,6 +649,8 @@ cr_tree_rewrite_uri(tree, domain)
 	</section>
     </section>
 
+<xi:include href="rpc.xml"/>
+
     <section>
 	    <title><acronym>MI</acronym> Commands</title>
 		<para>All commands understand the "-?" parameter to print a short help message.
@@ -656,22 +659,9 @@ cr_tree_rewrite_uri(tree, domain)
 		like "-d prox*").</para>
 	<section>
 	    <title><function moreinfo="none">cr_reload_routes</function></title>
-	    <para>
-		This command reloads the routing data from the data source.
-		</para>
-		<para>
-		Important: When new domains have been added, a restart of the server must be
-		done, because the mapping of the ids used in the config script cannot be
-		updated at runtime at the moment. So a reload could result in a wrong routing
-		behaviour, because the ids used in the script could differ from the one used
-		internally from the server. Modifying of already existing domains is no problem.
-	    </para>
 	</section>
 	<section>
 	    <title><function moreinfo="none">cr_dump_routes</function></title>
-	    <para>
-		This command prints the route rules on the command line.
-	    </para>
 	</section>
 	<section>
 	    <title><function moreinfo="none">cr_replace_host</function></title>

src/modules/carrierroute/doc/carrierroute_db.xml

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding='ISO-8859-1'?>
+<?xml version="1.0" encoding='UTF-8'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 

src/modules/carrierroute/doc/rpc.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+
+<section id="carrierroute.rpc" xmlns:xi="http://www.w3.org/2001/XInclude">
+	<title>RPC Commands</title>
+
+	<section id="carrierroute.rpc.reload_routes">
+			<title>
+				<function moreinfo="none">cr.reload_routes</function>
+			</title>
+			<para>This command reloads the routing data from the data source.</para>
+			<para>
+			Name: <emphasis>cr.reload_routes</emphasis>
+			</para>
+			<para>Parameters:</para>
+			<itemizedlist>
+				<listitem><para>
+					<emphasis>none</emphasis>
+				</para></listitem>
+			</itemizedlist>
+
+			<para>Important: When new domains have been added, a restart of the server must be
+			done, because the mapping of the ids used in the config script cannot be
+			updated at runtime at the moment. So a reload could result in a wrong routing
+			behaviour, because the ids used in the script could differ from the one used
+			internally from the server. Modifying of already existing domains is no problem.</para>
+	</section>
+
+	<section id="carrierroute.rpc.dump_routes">
+			<title>
+				<function moreinfo="none">cr.dump_routes</function>
+			</title>
+			<para>This command prints the route rules on the command line.</para>
+			<para>
+			Name: <emphasis>cr.dump_routes</emphasis>
+			</para>
+			<para>Parameters:</para>
+			<itemizedlist>
+				<listitem><para>
+					<emphasis>none</emphasis>
+				</para></listitem>
+			</itemizedlist>
+	</section>
+
+</section>

src/modules/dialog/doc/dialog_admin.xml

@@ -2130,7 +2130,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
 		<para>RPC Command Format:</para>
 		<programlisting  format="linespecific">
 ...
-&kamcmd; dlg_list
+&kamcmd; dlg.list
 ...
 		</programlisting>
 		</section>

src/modules/dialplan/doc/dialplan_admin.xml

@@ -531,7 +531,7 @@ xlog("translated to var $var(y) \n");
 			Example:
 			</para>
         <programlisting  format="linespecific">
-		&sercmd; dialplan.dump 100
+		&kamcmd; dialplan.dump 100
 		</programlisting>
 		</section>
 		<section id="dialplan.r.dp.reload">
@@ -547,11 +547,11 @@ xlog("translated to var $var(y) \n");
 			Example:
 			</para>
         <programlisting  format="linespecific">
-		&sercmd; dialplan.reload
+		&kamcmd; dialplan.reload
 		</programlisting>
 		</section>
 
-    		<section>
+		<section id="dialplan.r.dp.translate">
 			<title><varname>dialplan.translate</varname></title>
 			<para>
                 	Will apply a translation rule identified by a dialplan
@@ -572,9 +572,8 @@ xlog("translated to var $var(y) \n");
 			<para>
 			Example:
 			</para>
-        <programlisting  format="linespecific">
-        # &sercmd; dp_translate dpid "input"
-        &sercmd; dp_translate 1 "abcdxyz"
+		<programlisting  format="linespecific">
+		&kamcmd; dialplan.translate 1 "abcdxyz"
 		</programlisting>
 		</section>
 	</section>

src/modules/dispatcher/doc/dispatcher_admin.xml

@@ -1020,16 +1020,10 @@ modparam("dispatcher", "force_dst", 1)
 			stored in AVP list for further failovers (the first selected
 			destination and default destination are the first to be put in
 			the list)
-                        </para>
-                </listitem>
+			</para>
+		</listitem>
 		</itemizedlist>
 		<para>
-		If the bit 2 in 'flags' is set, the rest of the addresses from the
-		destination set is stored in AVP list. You can use 'ds_next_dst()' to
-		use next address to achieve serial forking to all possible
-		destinations.
-		</para>
-		<para>
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 		</para>
 		<example>

src/modules/htable/doc/htable_admin.xml

@@ -623,7 +623,7 @@ modparam("htable", "db_expires", 1)
 		<para>
 			If set to 1, will enable DMQ replication of actions performed upon
 			entries in all tables having "dmqreplicate" parameter set. Any update
-			action performed via pseudo-variables, MI and RPC commands will be
+			action performed via pseudo-variables and RPC commands will be
 			repeated on all other nodes. Therefore, it is important to ensure the
 			table definition (size, autoexpire etc.) is identical across all instances.
 		</para>

src/modules/kex/doc/kex_admin.xml

@@ -516,7 +516,7 @@ resetdebug();
 ...
 		</programlisting>
     </section>
-	<section id="kex.r.version">
+	<section id="kex.r.core.version">
 		<title>
 		<function moreinfo="none">version</function>
 		</title>
@@ -544,7 +544,7 @@ resetdebug();
 		Print list of available RPC commands.
 		</para>
 		<para>
-		Name: <emphasis>which</emphasis>
+		Name: <emphasis>system.listMethods</emphasis>
 		</para>
 		<para>Parameters: <emphasis>none</emphasis>.</para>
  		<para>
@@ -588,7 +588,7 @@ resetdebug();
 		Reset internal statistics.
 		</para>
 		<para>
-		Name: <emphasis>statsreset_statistics</emphasis>
+		Name: <emphasis>stats.reset_statistics</emphasis>
 		</para>
 		<para>Parameters: <emphasis>statsid</emphasis> - which statistics to
 			be reset, give as name.</para>
@@ -597,19 +597,19 @@ resetdebug();
 		</para>
 		<programlisting  format="linespecific">
 ...
-&kamcmd; reset_statistics _statsid_
+&kamcmd; stats.reset_statistics _statsid_
 ...
 		</programlisting>
     </section>
 	<section id="kex.r.stats.clear_statistics">
 		<title>
-		<function moreinfo="none">clear_statistics</function>
+		<function moreinfo="none">stats.clear_statistics</function>
 		</title>
 		<para>
 			Return statistics and reset their value in one command.
 		</para>
 		<para>
-		Name: <emphasis>stats.get_statistics</emphasis>
+		Name: <emphasis>stats.clear_statistics</emphasis>
 		</para>
 		<para>Parameters: <emphasis>statsid</emphasis> - same as for
 			get_statistics.</para>
@@ -618,7 +618,7 @@ resetdebug();
 		</para>
 		<programlisting  format="linespecific">
 ...
-&kamcmd; clear_statistics _statsid_
+&kamcmd; stats.clear_statistics _statsid_
 ...
 		</programlisting>
     </section>

src/modules/pdt/doc/pdt_admin.xml

@@ -501,10 +501,9 @@ pd_translate("*", "$var(a)");
 		<para>
 		RPC Command Example:
 		</para>
-		<programlisting  format="linespecific">
+		<programlisting format="linespecific">
 ...
-# &kamcmd; _sdomain_ _prefix_ _domain_
-&kamcmd; kamailio.org 123
+&kamcmd; pdt.list kamailio.org 123
 ...
 		</programlisting>
 		<para>

src/modules/presence/doc/presence_admin.xml

@@ -1183,7 +1183,7 @@ pres_update_watchers("sip:[email protected]", "presence");
 		</para>
 		<programlisting  format="linespecific">
 ...
-&kamcmd; refreshWatchers sip:[email protected] presence 1
+&kamcmd; presence.refreshWatchers sip:[email protected] presence 1
 ...
 		</programlisting>
 	</section>

src/modules/presence/doc/presence_devel.xml

@@ -375,7 +375,7 @@ str* rules_doc);
 	This function is an external command that can be used to announce a change
 	in authorization rules for a presentity. It updates the stored status and
 	sends a Notify to the watchers whose status has changes. (used by
-	presence_xml module when notified through an MI command of a change in
+	presence_xml module when notified through an RPC command of a change in
 	an xcap document).
 	</para>
 </section>

src/modules/presence_xml/doc/presence_xml_admin.xml

@@ -228,7 +228,7 @@ modparam("presence_xml", "force_active", 1)
 		XCAP server implemented in xcap_server module, the parameter should be
 		set to a positive value. Apart from updating in xcap table,
 		if the integrated server is not running on the same &kamailio; instance,
-		it must send an MI command refershWatchers
+		it must send an RPC command presence.refreshWatchers
 		[pres_uri] [event] when a user modifies a rules document, to
 		instruct the presence_xml module to update states from the database
 		and, if needed, send NOTIFY updates.

src/modules/ratelimit/doc/ratelimit_admin.xml

@@ -18,7 +18,7 @@
 	<para>
 		This module implements rate limiting for SIP requests. In contrast to
 		the PIKE module this limits the flow based on a per SIP request type
-		basis and not per source IP. The MI interface can be used to
+		basis and not per source IP. The RPC interface can be used to
 		change tunables while running &kamailio;.
 	</para>
 	<para>

src/modules/regex/doc/regex_admin.xml

@@ -26,7 +26,7 @@
 			A text file containing regular expressions categorized in groups is compiled
 			when the module is loaded,  the resulting PCRE objects are stored in an array. A
 			function to match a string or pseudo-variable against any of these groups is
-			provided. The text file can be modified and reloaded at any time via a MI command.
+			provided. The text file can be modified and reloaded at any time via a RPC command.
 			The module also offers a function to perform a PCRE matching operation against a
 			regular expression provided as function parameter.
 		</para>

src/modules/stun/doc/stun_admin.xml

@@ -41,7 +41,7 @@
 		&kamailio; with this module loaded:
 		<itemizedlist>
 		<listitem>
-		<para><emphasis>none</emphasis>.</para>
+		<para><emphasis>None</emphasis></para>
 		</listitem>
 		</itemizedlist>
 		</para>
@@ -60,7 +60,7 @@
 	</section>
 
 	<section>
-	<title>MI Commands</title>
+	<title>RPC Commands</title>
 	<para><emphasis>None</emphasis></para>
 	</section>
 

src/modules/xcap_server/doc/xcap_server_admin.xml

@@ -34,7 +34,7 @@
 		<para>
 			the Presence server has access imediatelly to the latest version
 			of XCAP documents. No more need to trigger refresh of XCAP
-			documents via MI command
+			documents via RPC command.
 		</para>
 		</listitem>
 		<listitem>