Browse code

Merge pull request #926 from mslehto/doc

documentation updates

Daniel-Constantin Mierla authored on 14/01/2017 12:02:24 • GitHub committed on 14/01/2017 12:02:24
Showing 18 changed files
... ...
@@ -74,7 +74,7 @@
74 74
 			<listitem>
75 75
 			<para>
76 76
 				0 - Enable per-timer enabling. Single timers are inactive by default
77
-				and can be activated through the MI interface as soon as that feature is
77
+				and can be activated through the RPC interface as soon as that feature is
78 78
 				implemented.
79 79
 			</para>
80 80
 			</listitem>
... ...
@@ -297,8 +297,8 @@ bm_log_timer("test");
297 297
 </programlisting>
298 298
 			</example>
299 299
 		</section>
300
-		<section id="benachmark.rpc.granularity">
301
-			<title><function moreinfo="none">benachmark.granularity</function></title>
300
+		<section id="benchmark.rpc.granularity">
301
+			<title><function moreinfo="none">benchmark.granularity</function></title>
302 302
 			<para>
303 303
 				Modifies the benchmarking granularity. See "granularity" variable.
304 304
 			</para>
... ...
@@ -1,4 +1,4 @@
1
-<?xml version="1.0" encoding='ISO-8859-1'?>
1
+<?xml version="1.0" encoding='UTF-8'?>
2 2
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 3
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 4
 
... ...
@@ -1,7 +1,8 @@
1
-<?xml version="1.0" encoding='ISO-8859-1'?>
1
+<?xml version="1.0" encoding='UTF-8'?>
2 2
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 3
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
-
4
+<!ENTITY % local.common.attrib
5
+	"xmlns:xi CDATA #FIXED 'http://www.w3.org/2001/XInclude'">
5 6
 <!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
6 7
 %docentities;
7 8
 
... ...
@@ -37,7 +38,7 @@
37 38
 		database driven routing creates.
38 39
 	</para>
39 40
 	<para>
40
-		Routing tables can be reloaded and edited (in config file mode) with the MI
41
+		Routing tables can be reloaded and edited (in config file mode) with the RPC
41 42
 		interface, the config file is updated according the changes. This is not
42 43
 		implemented for the db interface, because its easier to do the changes
43 44
 		directly on the db. But the reload and dump functions works of course here
... ...
@@ -648,6 +649,8 @@ cr_tree_rewrite_uri(tree, domain)
648 649
 	</section>
649 650
     </section>
650 651
 
652
+<xi:include href="rpc.xml"/>
653
+
651 654
     <section>
652 655
 	    <title><acronym>MI</acronym> Commands</title>
653 656
 		<para>All commands understand the "-?" parameter to print a short help message.
... ...
@@ -656,22 +659,9 @@ cr_tree_rewrite_uri(tree, domain)
656 659
 		like "-d prox*").</para>
657 660
 	<section>
658 661
 	    <title><function moreinfo="none">cr_reload_routes</function></title>
659
-	    <para>
660
-		This command reloads the routing data from the data source.
661
-		</para>
662
-		<para>
663
-		Important: When new domains have been added, a restart of the server must be
664
-		done, because the mapping of the ids used in the config script cannot be
665
-		updated at runtime at the moment. So a reload could result in a wrong routing
666
-		behaviour, because the ids used in the script could differ from the one used
667
-		internally from the server. Modifying of already existing domains is no problem.
668
-	    </para>
669 662
 	</section>
670 663
 	<section>
671 664
 	    <title><function moreinfo="none">cr_dump_routes</function></title>
672
-	    <para>
673
-		This command prints the route rules on the command line.
674
-	    </para>
675 665
 	</section>
676 666
 	<section>
677 667
 	    <title><function moreinfo="none">cr_replace_host</function></title>
... ...
@@ -1,4 +1,4 @@
1
-<?xml version="1.0" encoding='ISO-8859-1'?>
1
+<?xml version="1.0" encoding='UTF-8'?>
2 2
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 3
 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 4
 
5 5
new file mode 100644
... ...
@@ -0,0 +1,46 @@
1
+<?xml version="1.0" encoding="UTF-8"?>
2
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
+   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
4
+
5
+<section id="carrierroute.rpc" xmlns:xi="http://www.w3.org/2001/XInclude">
6
+	<title>RPC Commands</title>
7
+
8
+	<section id="carrierroute.rpc.reload_routes">
9
+			<title>
10
+				<function moreinfo="none">cr.reload_routes</function>
11
+			</title>
12
+			<para>This command reloads the routing data from the data source.</para>
13
+			<para>
14
+			Name: <emphasis>cr.reload_routes</emphasis>
15
+			</para>
16
+			<para>Parameters:</para>
17
+			<itemizedlist>
18
+				<listitem><para>
19
+					<emphasis>none</emphasis>
20
+				</para></listitem>
21
+			</itemizedlist>
22
+
23
+			<para>Important: When new domains have been added, a restart of the server must be
24
+			done, because the mapping of the ids used in the config script cannot be
25
+			updated at runtime at the moment. So a reload could result in a wrong routing
26
+			behaviour, because the ids used in the script could differ from the one used
27
+			internally from the server. Modifying of already existing domains is no problem.</para>
28
+	</section>
29
+
30
+	<section id="carrierroute.rpc.dump_routes">
31
+			<title>
32
+				<function moreinfo="none">cr.dump_routes</function>
33
+			</title>
34
+			<para>This command prints the route rules on the command line.</para>
35
+			<para>
36
+			Name: <emphasis>cr.dump_routes</emphasis>
37
+			</para>
38
+			<para>Parameters:</para>
39
+			<itemizedlist>
40
+				<listitem><para>
41
+					<emphasis>none</emphasis>
42
+				</para></listitem>
43
+			</itemizedlist>
44
+	</section>
45
+
46
+</section>
... ...
@@ -2130,7 +2130,7 @@ dlg_remote_profile("add", "caller", "test", "$sruid", "$var(exp)");
2130 2130
 		<para>RPC Command Format:</para>
2131 2131
 		<programlisting  format="linespecific">
2132 2132
 ...
2133
-&kamcmd; dlg_list
2133
+&kamcmd; dlg.list
2134 2134
 ...
2135 2135
 		</programlisting>
2136 2136
 		</section>
... ...
@@ -531,7 +531,7 @@ xlog("translated to var $var(y) \n");
531 531
 			Example:
532 532
 			</para>
533 533
         <programlisting  format="linespecific">
534
-		&sercmd; dialplan.dump 100
534
+		&kamcmd; dialplan.dump 100
535 535
 		</programlisting>
536 536
 		</section>
537 537
 		<section id="dialplan.r.dp.reload">
... ...
@@ -547,11 +547,11 @@ xlog("translated to var $var(y) \n");
547 547
 			Example:
548 548
 			</para>
549 549
         <programlisting  format="linespecific">
550
-		&sercmd; dialplan.reload
550
+		&kamcmd; dialplan.reload
551 551
 		</programlisting>
552 552
 		</section>
553 553
 
554
-    		<section>
554
+		<section id="dialplan.r.dp.translate">
555 555
 			<title><varname>dialplan.translate</varname></title>
556 556
 			<para>
557 557
                 	Will apply a translation rule identified by a dialplan
... ...
@@ -572,9 +572,8 @@ xlog("translated to var $var(y) \n");
572 572
 			<para>
573 573
 			Example:
574 574
 			</para>
575
-        <programlisting  format="linespecific">
576
-        # &sercmd; dp_translate dpid "input"
577
-        &sercmd; dp_translate 1 "abcdxyz"
575
+		<programlisting  format="linespecific">
576
+		&kamcmd; dialplan.translate 1 "abcdxyz"
578 577
 		</programlisting>
579 578
 		</section>
580 579
 	</section>
... ...
@@ -1020,16 +1020,10 @@ modparam("dispatcher", "force_dst", 1)
1020 1020
 			stored in AVP list for further failovers (the first selected
1021 1021
 			destination and default destination are the first to be put in
1022 1022
 			the list)
1023
-                        </para>
1024
-                </listitem>
1023
+			</para>
1024
+		</listitem>
1025 1025
 		</itemizedlist>
1026 1026
 		<para>
1027
-		If the bit 2 in 'flags' is set, the rest of the addresses from the
1028
-		destination set is stored in AVP list. You can use 'ds_next_dst()' to
1029
-		use next address to achieve serial forking to all possible
1030
-		destinations.
1031
-		</para>
1032
-		<para>
1033 1027
 		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1034 1028
 		</para>
1035 1029
 		<example>
... ...
@@ -623,7 +623,7 @@ modparam("htable", "db_expires", 1)
623 623
 		<para>
624 624
 			If set to 1, will enable DMQ replication of actions performed upon
625 625
 			entries in all tables having "dmqreplicate" parameter set. Any update
626
-			action performed via pseudo-variables, MI and RPC commands will be
626
+			action performed via pseudo-variables and RPC commands will be
627 627
 			repeated on all other nodes. Therefore, it is important to ensure the
628 628
 			table definition (size, autoexpire etc.) is identical across all instances.
629 629
 		</para>
... ...
@@ -516,7 +516,7 @@ resetdebug();
516 516
 ...
517 517
 		</programlisting>
518 518
     </section>
519
-	<section id="kex.r.version">
519
+	<section id="kex.r.core.version">
520 520
 		<title>
521 521
 		<function moreinfo="none">version</function>
522 522
 		</title>
... ...
@@ -544,7 +544,7 @@ resetdebug();
544 544
 		Print list of available RPC commands.
545 545
 		</para>
546 546
 		<para>
547
-		Name: <emphasis>which</emphasis>
547
+		Name: <emphasis>system.listMethods</emphasis>
548 548
 		</para>
549 549
 		<para>Parameters: <emphasis>none</emphasis>.</para>
550 550
  		<para>
... ...
@@ -588,7 +588,7 @@ resetdebug();
588 588
 		Reset internal statistics.
589 589
 		</para>
590 590
 		<para>
591
-		Name: <emphasis>statsreset_statistics</emphasis>
591
+		Name: <emphasis>stats.reset_statistics</emphasis>
592 592
 		</para>
593 593
 		<para>Parameters: <emphasis>statsid</emphasis> - which statistics to
594 594
 			be reset, give as name.</para>
... ...
@@ -597,19 +597,19 @@ resetdebug();
597 597
 		</para>
598 598
 		<programlisting  format="linespecific">
599 599
 ...
600
-&kamcmd; reset_statistics _statsid_
600
+&kamcmd; stats.reset_statistics _statsid_
601 601
 ...
602 602
 		</programlisting>
603 603
     </section>
604 604
 	<section id="kex.r.stats.clear_statistics">
605 605
 		<title>
606
-		<function moreinfo="none">clear_statistics</function>
606
+		<function moreinfo="none">stats.clear_statistics</function>
607 607
 		</title>
608 608
 		<para>
609 609
 			Return statistics and reset their value in one command.
610 610
 		</para>
611 611
 		<para>
612
-		Name: <emphasis>stats.get_statistics</emphasis>
612
+		Name: <emphasis>stats.clear_statistics</emphasis>
613 613
 		</para>
614 614
 		<para>Parameters: <emphasis>statsid</emphasis> - same as for
615 615
 			get_statistics.</para>
... ...
@@ -618,7 +618,7 @@ resetdebug();
618 618
 		</para>
619 619
 		<programlisting  format="linespecific">
620 620
 ...
621
-&kamcmd; clear_statistics _statsid_
621
+&kamcmd; stats.clear_statistics _statsid_
622 622
 ...
623 623
 		</programlisting>
624 624
     </section>
... ...
@@ -501,10 +501,9 @@ pd_translate("*", "$var(a)");
501 501
 		<para>
502 502
 		RPC Command Example:
503 503
 		</para>
504
-		<programlisting  format="linespecific">
504
+		<programlisting format="linespecific">
505 505
 ...
506
-# &kamcmd; _sdomain_ _prefix_ _domain_
507
-&kamcmd; kamailio.org 123
506
+&kamcmd; pdt.list kamailio.org 123
508 507
 ...
509 508
 		</programlisting>
510 509
 		<para>
... ...
@@ -1183,7 +1183,7 @@ pres_update_watchers("sip:test@kamailio.org", "presence");
1183 1183
 		</para>
1184 1184
 		<programlisting  format="linespecific">
1185 1185
 ...
1186
-&kamcmd; refreshWatchers sip:test@kamailio.org presence 1
1186
+&kamcmd; presence.refreshWatchers sip:test@kamailio.org presence 1
1187 1187
 ...
1188 1188
 		</programlisting>
1189 1189
 	</section>
... ...
@@ -375,7 +375,7 @@ str* rules_doc);
375 375
 	This function is an external command that can be used to announce a change
376 376
 	in authorization rules for a presentity. It updates the stored status and
377 377
 	sends a Notify to the watchers whose status has changes. (used by
378
-	presence_xml module when notified through an MI command of a change in
378
+	presence_xml module when notified through an RPC command of a change in
379 379
 	an xcap document).
380 380
 	</para>
381 381
 </section>
... ...
@@ -228,7 +228,7 @@ modparam("presence_xml", "force_active", 1)
228 228
 		XCAP server implemented in xcap_server module, the parameter should be
229 229
 		set to a positive value. Apart from updating in xcap table,
230 230
 		if the integrated server is not running on the same &kamailio; instance,
231
-		it must send an MI command refershWatchers
231
+		it must send an RPC command presence.refreshWatchers
232 232
 		[pres_uri] [event] when a user modifies a rules document, to
233 233
 		instruct the presence_xml module to update states from the database
234 234
 		and, if needed, send NOTIFY updates.
... ...
@@ -18,7 +18,7 @@
18 18
 	<para>
19 19
 		This module implements rate limiting for SIP requests. In contrast to
20 20
 		the PIKE module this limits the flow based on a per SIP request type
21
-		basis and not per source IP. The MI interface can be used to
21
+		basis and not per source IP. The RPC interface can be used to
22 22
 		change tunables while running &kamailio;.
23 23
 	</para>
24 24
 	<para>
... ...
@@ -26,7 +26,7 @@
26 26
 			A text file containing regular expressions categorized in groups is compiled
27 27
 			when the module is loaded,  the resulting PCRE objects are stored in an array. A
28 28
 			function to match a string or pseudo-variable against any of these groups is
29
-			provided. The text file can be modified and reloaded at any time via a MI command.
29
+			provided. The text file can be modified and reloaded at any time via a RPC command.
30 30
 			The module also offers a function to perform a PCRE matching operation against a
31 31
 			regular expression provided as function parameter.
32 32
 		</para>
... ...
@@ -41,7 +41,7 @@
41 41
 		&kamailio; with this module loaded:
42 42
 		<itemizedlist>
43 43
 		<listitem>
44
-		<para><emphasis>none</emphasis>.</para>
44
+		<para><emphasis>None</emphasis></para>
45 45
 		</listitem>
46 46
 		</itemizedlist>
47 47
 		</para>
... ...
@@ -60,7 +60,7 @@
60 60
 	</section>
61 61
 
62 62
 	<section>
63
-	<title>MI Commands</title>
63
+	<title>RPC Commands</title>
64 64
 	<para><emphasis>None</emphasis></para>
65 65
 	</section>
66 66
 
... ...
@@ -34,7 +34,7 @@
34 34
 		<para>
35 35
 			the Presence server has access imediatelly to the latest version
36 36
 			of XCAP documents. No more need to trigger refresh of XCAP
37
-			documents via MI command
37
+			documents via RPC command.
38 38
 		</para>
39 39
 		</listitem>
40 40
 		<listitem>