doc: Removed hardoded kamctl value and replaced it with an XML entity

This will allow for faster documentation changes regarding the ser-kamailio ctl tools unification proposal

docbook/entities.xml

@@ -33,6 +33,9 @@
 <!ENTITY kamailiousersmail "<email>[email protected]</email>">
 <!ENTITY kamailiodevmail "<email>[email protected]</email>">
 
+<!ENTITY ctltool "kamctl">
+<!ENTITY ctltoolrc "kamctlrc">
+
 <!ENTITY adminguide "Admin Guide">
 <!ENTITY develguide "Developer Guide">
 <!ENTITY faqguide "Frequently Asked Questions">

modules/carrierroute/doc/carrierroute_admin.xml

@@ -663,7 +663,7 @@ cr_tree_rewrite_uri(tree, domain)
 		<title><function>cr_replace_host</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2"
+&ctltool; fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2"
 ...
 		</programlisting>
 	    </example>
@@ -696,7 +696,7 @@ kamctl fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2"
 		<title><function>cr_deactivate_host</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo cr_deactivate_host "-d proxy -p 49 -h proxy1"
+&ctltool; fifo cr_deactivate_host "-d proxy -p 49 -h proxy1"
 ...
 		</programlisting>
 	    </example>
@@ -723,7 +723,7 @@ kamctl fifo cr_deactivate_host "-d proxy -p 49 -h proxy1"
 		<title><function>cr_activate_host</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo cr_activate_host "-d proxy -p 49 -h proxy1"
+&ctltool; fifo cr_activate_host "-d proxy -p 49 -h proxy1"
 ...
 		</programlisting>
 	    </example>
@@ -766,7 +766,7 @@ kamctl fifo cr_activate_host "-d proxy -p 49 -h proxy1"
 		<title><function>cr_add_host</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
+&ctltool; fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
 ...
 		</programlisting>
 	    </example>
@@ -810,7 +810,7 @@ kamctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
 		<title><function>cr_delete_host</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo cr_delete_host "-d proxy -p 49 -h proxy1 -w 0.25"
+&ctltool; fifo cr_delete_host "-d proxy -p 49 -h proxy1 -w 0.25"
 ...
 		</programlisting>
 	    </example>

modules/db_berkeley/doc/db_berkeley_admin.xml

@@ -153,7 +153,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		
 		<para>Parameters: <emphasis>tablename (or db_path); to reload a particular table 
 		provide the tablename as the arguement (eg subscriber); to reload all tables provide the db_path to
-		the db files. The path can be found in kamctlrc DB_PATH variable. 
+		the db files. The path can be found in &ctltool;rc DB_PATH variable. 
 		</emphasis></para>
 	</section>
 	</section>
@@ -206,14 +206,14 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		<para>
 		Decide where (on the filesystem) you want to install the Berkeley DB files.
 		For instance, '/usr/local/etc/kamailio/db_berkeley' directory.
-		Make note of this directory as we need to add this path to the kamctlrc file.
+		Make note of this directory as we need to add this path to the &ctltool;rc file.
 		Note: SIP-router will not startup without these DB files.
 		</para>
 		
 		<para>
-		Edit kamctlrc - There are two parameters in this file that should be 
+		Edit &ctltool;rc - There are two parameters in this file that should be 
 		configured before kamdbctl script can work properly: DBENGINE and DB_PATH.
-		Edit file: '/usr/local/etc/sip-router/kamctlrc'
+		Edit file: '/usr/local/etc/sip-router/&ctltool;rc'
 		</para>
 	        <programlisting  format="linespecific">
 		## database type: MYSQL, PGSQL, DB_BERKELEY, or DBTEXT, by default none is loaded
@@ -500,7 +500,7 @@ username(str) domain(str) password(str) ha1(str) ha1b(str) first_name(str) last_
 	
 	<para>
 	Use the kamdbctl script for maintaining SIP-router Berkeley DB tables.
-	This script assumes you have DBENGINE and DB_PATH setup correctly in kamctlrc.
+	This script assumes you have DBENGINE and DB_PATH setup correctly in &ctltool;rc.
 	Note Unsupported commands are- backup, restore, migrate, copy, serweb.
 	<example>
 	<title>kamdbctl</title>

modules/db_berkeley/km_doc/db_berkeley_admin.xml

@@ -153,7 +153,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		
 		<para>Parameters: <emphasis>tablename (or db_path); to reload a particular table 
 		provide the tablename as the arguement (eg subscriber); to reload all tables provide the db_path to
-		the db files. The path can be found in kamctlrc DB_PATH variable. 
+		the db files. The path can be found in &ctltool;rc DB_PATH variable. 
 		</emphasis></para>
 	</section>
 	</section>
@@ -206,14 +206,14 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
 		<para>
 		Decide where (on the filesystem) you want to install the Berkeley DB files.
 		For instance, '/usr/local/etc/kamailio/db_berkeley' directory.
-		Make note of this directory as we need to add this path to the kamctlrc file.
+		Make note of this directory as we need to add this path to the &ctltool;rc file.
 		Note: Kamailio will not startup without these DB files.
 		</para>
 		
 		<para>
-		Edit kamctlrc - There are two parameters in this file that should be 
+		Edit &ctltool;rc - There are two parameters in this file that should be 
 		configured before openserctrdb script can work properly: DBENGINE and DB_PATH.
-		Edit file: '/usr/local/etc/kamailio/kamctlrc'
+		Edit file: '/usr/local/etc/kamailio/&ctltool;rc'
 		</para>
 	        <programlisting  format="linespecific">
 		## database type: MYSQL, PGSQL, DB_BERKELEY, or DBTEXT, by default none is loaded
@@ -500,7 +500,7 @@ username(str) domain(str) password(str) ha1(str) ha1b(str) first_name(str) last_
 	
 	<para>
 	Use the kamdbctl script for maintaining Kamailio Berkeley DB tables.
-	This script assumes you have DBENGINE and DB_PATH setup correctly in kamctlrc.
+	This script assumes you have DBENGINE and DB_PATH setup correctly in &ctltool;rc.
 	Note Unsupported commands are- backup, restore, migrate, copy, serweb.
 	<example>
 	<title>kamdbctl</title>

modules/db_flatstore/km_doc/db_flatstore_admin.xml

@@ -98,7 +98,7 @@ mv acc_4.log acc_3.log.20050605
 			Send &kamailio; the MI command to close and reopen the
 			renamed files. For example, using FIFO:
 			<screen>
-kamctl fifo flat_rotate
+&ctltool; fifo flat_rotate
 			</screen>
 			This will force &kamailio; to close the renamed files and open
 			new ones with original names, such as

modules/pdb/doc/pdb_admin.xml

@@ -139,7 +139,7 @@ cr_route("$avp(i:82)", "$rd", "$rU", "$rU", "call_id");
 				<title><function>pdb_status</function> usage</title>
 				<programlisting format="linespecific">
 ...
-kamctl fifo pdb_status
+&ctltool; fifo pdb_status
 ...
 				</programlisting>
 	    </example>
@@ -155,7 +155,7 @@ kamctl fifo pdb_status
 				<title><function>pdb_activate</function> usage</title>
 				<programlisting format="linespecific">
 ...
-kamctl fifo pdb_activate
+&ctltool; fifo pdb_activate
 ...
 				</programlisting>
 	    </example>
@@ -173,7 +173,7 @@ kamctl fifo pdb_activate
 				<title><function>pdb_deactivate</function> usage</title>
 				<programlisting format="linespecific">
 ...
-kamctl fifo pdb_deactivate
+&ctltool; fifo pdb_deactivate
 ...
 				</programlisting>
 	    </example>

modules/utils/doc/utils_admin.xml

@@ -246,7 +246,7 @@ if (method=="MESSAGE") {
 		<title><function>forward_list</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo forward_list
+&ctltool; fifo forward_list
 id switch                         filter proxy
  0    off      REGISTER:INVITE:SUBSCRIBE host-a.domain-a:5060
 ...
@@ -263,7 +263,7 @@ id switch                         filter proxy
 		<title><function>forward_switch</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo sp_forward_switch 0=on
+&ctltool; fifo sp_forward_switch 0=on
 ...
 		</programlisting>
 	    </example>
@@ -293,7 +293,7 @@ kamctl fifo sp_forward_switch 0=on
 		<title><function>forward_filter</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo sp_forward_filter 0=REGISTER:INVITE
+&ctltool; fifo sp_forward_filter 0=REGISTER:INVITE
 ...
 		</programlisting>
 	    </example>
@@ -312,7 +312,7 @@ kamctl fifo sp_forward_filter 0=REGISTER:INVITE
 		<title><function>forward_proxy</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo sp_forward_proxy 0=host-c.domain-c:5060
+&ctltool; fifo sp_forward_proxy 0=host-c.domain-c:5060
 ...
 		</programlisting>
 	    </example>

modules_k/benchmark/doc/benchmark_admin.xml

@@ -290,7 +290,7 @@ bm_log_timer("test");
 				<title>Enabling a timer</title>
 				<programlisting format="linespecific">
 ...
-kamctl fifo bm_enable_timer test 1
+&ctltool; fifo bm_enable_timer test 1
 ...
 </programlisting>
 			</example>

modules_k/cfgutils/doc/cfgutils_admin.xml

@@ -497,7 +497,7 @@ unlock("$rU");
 				<title><function moreinfo="none">rand_set_prob</function> usage</title>
 				<programlisting format="linespecific">
 ...
-$ kamctl fifo rand_set_prob 10
+$ &ctltool; fifo rand_set_prob 10
 ...
 </programlisting>
 			</example>
@@ -516,7 +516,7 @@ $ kamctl fifo rand_set_prob 10
 					<function moreinfo="none">rand_reset_prob</function> usage</title>
 				<programlisting format="linespecific">
 ...
-$ kamctl fifo rand_reset_prob
+$ &ctltool; fifo rand_reset_prob
 ...
 </programlisting>
 			</example>
@@ -533,7 +533,7 @@ $ kamctl fifo rand_reset_prob
 				<title><function moreinfo="none">rand_get_prob</function> usage</title>
 				<programlisting format="linespecific">
 ...
-$ kamctl fifo get_prob
+$ &ctltool; fifo get_prob
 The actual probability is 50 percent.
 ...
 </programlisting>
@@ -553,7 +553,7 @@ The actual probability is 50 percent.
 				<title><function moreinfo="none">check_config_hash</function> usage</title>
 				<programlisting format="linespecific">
 ...
-$ kamctl fifo check_config_hash
+$ &ctltool; fifo check_config_hash
 The actual config file hash is identical to the stored one.
 ...
 </programlisting>
@@ -572,7 +572,7 @@ The actual config file hash is identical to the stored one.
 				<title><function moreinfo="none">get_config_hash</function> usage</title>
 				<programlisting format="linespecific">
 ...
-$ kamctl fifo get_config_hash
+$ &ctltool; fifo get_config_hash
 1580a37104eb4de69ab9f31ce8d6e3e0
 ...
 </programlisting>
@@ -591,8 +591,8 @@ $ kamctl fifo get_config_hash
 			<title><function moreinfo="none">set_gflag</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo set_gflag 1
-$ kamctl fifo set_gflag 0x3
+$ &ctltool; fifo set_gflag 1
+$ &ctltool; fifo set_gflag 0x3
 ...
 </programlisting>
 			</example>
@@ -612,8 +612,8 @@ $ kamctl fifo set_gflag 0x3
 				<function moreinfo="none">reset_gflag</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo reset_gflag 1
-$ kamctl fifo reset_gflag 0x3
+$ &ctltool; fifo reset_gflag 1
+$ &ctltool; fifo reset_gflag 0x3
 ...
 </programlisting>
 			</example>
@@ -635,19 +635,19 @@ $ kamctl fifo reset_gflag 0x3
 			<title><function moreinfo="none">is_gflag</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo set_gflag 1024
-$ kamctl fifo is_gflag 1024
+$ &ctltool; fifo set_gflag 1024
+$ &ctltool; fifo is_gflag 1024
 TRUE
-$ kamctl fifo is_gflag 1025
+$ &ctltool; fifo is_gflag 1025
 TRUE
-$ kamctl fifo is_gflag 1023
+$ &ctltool; fifo is_gflag 1023
 FALSE
-$ kamctl fifo set_gflag 0x10
-$ kamctl fifo is_gflag 1023
+$ &ctltool; fifo set_gflag 0x10
+$ &ctltool; fifo is_gflag 1023
 TRUE
-$ kamctl fifo is_gflag 1007
+$ &ctltool; fifo is_gflag 1007
 FALSE
-$ kamctl fifo is_gflag 16
+$ &ctltool; fifo is_gflag 16
 TRUE
 ...
 </programlisting>
@@ -664,7 +664,7 @@ TRUE
 				<function moreinfo="none">get_gflags</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo get_gflags
+$ &ctltool; fifo get_gflags
 0x3039
 12345
 ...

modules_k/db_oracle/doc/db_oracle_admin.xml

@@ -145,7 +145,7 @@ modparam("db_oracle", "reconnect", 0.5)
 	<section>
 	<title>Utility openser_orasel</title>
 		<para>
-		For working with kamctl script, should be able to print the 'query' 
+		For working with &ctltool; script, should be able to print the 'query' 
 		results to the terminal in a user-readable form. The standard command-line 
 		Oracle client (sqlplus) is not quite suitable for this, as it cannot align 
 		row width to real (received) data's (it always prints a cell width as 

modules_k/drouting/doc/drouting_admin.xml

@@ -1321,7 +1321,7 @@ if (is_from_gw("3","1") {
 	<para>
 	The module requires 3 table in &kamailio; database: dr_groups,
 	dr_gateways, dr_rules. The SQL syntax to create them can be
-	found in drouting-create.sql script in kamctl db directories.
+	found in drouting-create.sql script in &ctltool; db directories.
 	You can also find the complete
 	database documentation on the project webpage, &kamailiodbdocslink;.
 	</para>

modules_k/nathelper/doc/nathelper_admin.xml

@@ -1149,7 +1149,7 @@ start_recording();
 			<title><function moreinfo="none">nh_enable_ping</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo nh_enable_ping 1
+$ &ctltool; fifo nh_enable_ping 1
 ...
 			</programlisting>
 			</example>
@@ -1177,7 +1177,7 @@ $ kamctl fifo nh_enable_ping 1
 			<function moreinfo="none">nh_enable_rtpp</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
+$ &ctltool; fifo nh_enable_rtpp udp:192.168.2.133:8081 0
 ...
 			</programlisting>
 			</example>
@@ -1197,7 +1197,7 @@ $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
 				<function moreinfo="none">nh_show_rtpp</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo nh_show_rtpp 
+$ &ctltool; fifo nh_show_rtpp 
 ...
 			</programlisting>
 			</example>

modules_k/pv/doc/pv_admin.xml

@@ -235,7 +235,7 @@ pv_unset("$avp("s:x")");
 			<title><function moreinfo="none">shv_set</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo shv_set debug int 0
+$ &ctltool; fifo shv_set debug int 0
 ...
 </programlisting>
 			</example>
@@ -262,8 +262,8 @@ $ kamctl fifo shv_set debug int 0
 			<title><function moreinfo="none">shv_get</function> usage</title>
 			<programlisting format="linespecific">
 ...
-$ kamctl fifo shv_get debug
-$ kamctl fifo shv_get
+$ &ctltool; fifo shv_get debug
+$ &ctltool; fifo shv_get
 ...
 </programlisting>
 			</example>

modules_k/siptrace/doc/siptrace_admin.xml

@@ -42,10 +42,10 @@
 	The tracing can be turned on/off using fifo commad.
 	</para>
 	<para>
-	kamctl fifo sip_trace on
+	&ctltool; fifo sip_trace on
 	</para>
 	<para>
-	kamctl fifo sip_trace off
+	&ctltool; fifo sip_trace off
 	</para>
 	</section>
 	<section>

modules_k/snmpstats/doc/snmpstats_faq.xml

@@ -207,7 +207,7 @@
 		</para>
 
 		<programlisting format="linespecific">
-    LD_LIBRARY_PATH=/usr/local/lib kamctl start
+    LD_LIBRARY_PATH=/usr/local/lib &ctltool; start
 		</programlisting>
 
 	    </answer>

modules_k/userblacklist/doc/userblacklist_admin.xml

@@ -188,7 +188,7 @@ if (!check_blacklist("global_blacklist")))
 		<title><function>reload_blacklists</function> usage</title>
 		<programlisting format="linespecific">
 ...
-kamctl fifo reload_blacklist
+&ctltool; fifo reload_blacklist
 ...
 		</programlisting>
 	    </example>