usrloc/registrar: Improve documentation

    * add URL anchors for modparams, functions, MI commands, etc.
    * fix some incorrect preset strings

modules/registrar/doc/registrar_admin.xml

@@ -143,7 +143,7 @@
 	</section>
 	<section>
 	<title>Exported Parameters</title>
-	<section>
+	<section id="default_expires" xreflabel="default_expires">
 		<title><varname>default_expires</varname> (integer)</title>
 		<para>
 		If the processed message contains neither Expires
@@ -165,7 +165,7 @@ modparam("registrar", "default_expires", 1800)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="min_expires" xreflabel="min_expires">
 		<title><varname>min_expires</varname> (integer)</title>
 		<para>
 		The minimum expires value of a Contact, values lower than this
@@ -186,7 +186,7 @@ modparam("registrar", "min_expires", 60)
 </programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="max_expires" xreflabel="max_expires">
 		<title><varname>max_expires</varname> (integer)</title>
 		<para>
 		The maximum expires value of a Contact, values higher than this
@@ -208,7 +208,7 @@ modparam("registrar", "max_expires", 120)
 		</example>
 	</section>
 
-	<section>
+	<section id="default_q" xreflabel="default_q">
 		<title><varname>default_q</varname> (integer)</title>
 		<para>
 		The parameter represents default q value for new contacts. Because
@@ -231,7 +231,7 @@ modparam("registrar", "default_q", 1000)
 		</example>
 	</section>
 
-	<section>
+	<section id="tcp_persistent_flag" xreflabel="tcp_persistent_flag">
 		<title><varname>tcp_persistent_flag</varname> (integer)</title>
 		<para>
 		The parameter specifies the message flag to be used to control the
@@ -256,7 +256,7 @@ modparam("registrar", "tcp_persistent_flag", 7)
 		</example>
 	</section>
 
-	<section>
+	<section id="realm_prefix" xreflabel="realm_prefix">
 		<title><varname>realm_prefix</varname> (string)</title>
 		<para>
 		 Prefix to be automatically strip from realm. As an alternative to
@@ -282,7 +282,7 @@ modparam("registrar", "realm_prefix", "sip.")
 	</section>
 
 
-	<section>
+	<section id="case_sensitive" xreflabel="case_sensitive">
 		<title><varname>case_sensitive</varname> (integer)</title>
 		<para>
 		If set to 1 then <acronym>AOR</acronym> comparison will be case
@@ -304,7 +304,7 @@ modparam("registrar", "case_sensitive", 0)
 		</example>
 	</section>
 
-	<section>
+	<section id="received_avp" xreflabel="received_avp">
 		<title><varname>received_avp</varname> (str)</title>
 		<para>
 		Registrar will store the value of the AVP configured by this
@@ -334,7 +334,7 @@ modparam("registrar", "received_avp", "$avp(rcv)")
 		</example>
 	</section>
 
-	<section>
+	<section id="received_param" xreflabel="received_param">
 		<title><varname>received_param</varname> (string)</title>
 		<para>
 		The name of the parameter that will be appended to Contacts of
@@ -356,7 +356,7 @@ modparam("registrar", "received_param", "rcv")
 	</section>
 
 
-	<section>
+	<section id="max_contacts" xreflabel="max_contacts">
 		<title><varname>max_contacts</varname> (integer)</title>
 		<para>
 		The parameter can be used to limit the number of contacts per
@@ -384,7 +384,7 @@ modparam("registrar", "max_contacts", 10)
 		</example>
 	</section>
 
-	<section>
+	<section id="retry_after" xreflabel="retry_after">
 		<title><varname>retry_after</varname> (integer)</title>
 		<para>
 		The registrar can generate 5xx reply to REGISTER in various
@@ -413,7 +413,7 @@ modparam("registrar", "retry_after", 30)
 		</example>
 	</section>
 
-	<section>
+	<section id="sock_hdr_name" xreflabel="sock_hdr_name">
 		<title><varname>sock_hdr_name</varname> (string)</title>
 		<para>
 		Header which contains a socket description (proto:IP:port) to override
@@ -438,7 +438,7 @@ modparam("registrar", "sock_hdr_name", "Sock-Info")
 		</example>
 	</section>
 
-	<section>
+	<section id="mcontact_avp" xreflabel="mcontact_avp">
 		<title><varname>mcontact_avp</varname> (string)</title>
 		<para>
 		AVP to store the modified binding that is set during cached
@@ -463,7 +463,7 @@ modparam("registrar", "mcontact_avp", "$avp(register)")
 		</programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="attr_avp" xreflabel="attr_avp">
 		<title><varname>attr_avp</varname> (string)</title>
 		<para>
 		AVP to store specific additional information for each registration.
@@ -506,7 +506,7 @@ branch_route[branch_route_1] {
 		</programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="gruu_secret" xreflabel="gruu_secret">
 		<title><varname>gruu_secret</varname> (string)</title>
 		<para>
 		The string that will be used in XORing when generating
@@ -526,7 +526,7 @@ modparam("registrar", "gruu_secret", "top_secret")
 		</programlisting>
 		</example>
 	</section>
-	<section>
+	<section id="disable_gruu" xreflabel="disable_gruu">
 		<title><varname>disable_gruu</varname> (int)</title>
 		<para>
 			Globally disable GRUU handling
@@ -549,7 +549,7 @@ modparam("registrar", "disable_gruu", 0)
 
 	<section>
 	<title>Exported Functions</title>
-	<section>
+	<section id="save" xreflabel="save">
 		<title>
 		<function moreinfo="none">save(domain [,flags ,[aor]])</function>
 		</title>
@@ -696,7 +696,7 @@ save("location","mr", "$avp(aor)");
 		</example>
 	</section>
 
-	<section>
+	<section id="remove" xreflabel="remove">
 		<title>
 		<function moreinfo="none">remove(domain, AOR[, [contact], ip])</function>
 		</title>
@@ -770,7 +770,7 @@ remove("location", "sip:bob@atlanta.com", "sip:bob@46.50.64.78", "50.60.50.60");
 		</example>
 	</section>
 
-	<section>
+	<section id="lookup" xreflabel="lookup">
 		<title>
 		<function moreinfo="none">lookup(domain [, flags [, aor]])</function>
 		</title>
@@ -927,7 +927,7 @@ switch ($retcode) {
 		</example>
 	</section>
 
-	<section>
+	<section id="is_registered" xreflabel="is_registered">
 		<title>
 		<function moreinfo="none">is_registered(domain ,[AOR])</function>
 		</title>
@@ -981,7 +981,7 @@ if (is_registered("location","$fu")) {
 	</section>
 
 
-	<section>
+	<section id="is_contact_registered" xreflabel="is_contact_registered">
 		<title>
 		<function moreinfo="none">is_contact_registered(domain ,[AOR],[contact],[callid])</function>
 		</title>
@@ -1050,7 +1050,7 @@ if(is_method("INVITE")) {
 		</example>
 	</section>
 
-	<section>
+	<section id="is_ip_registered" xreflabel="is_ip_registered">
 		<title>
 		<function moreinfo="none">is_ip_registered(domain ,[AOR],IPvar)</function>
 		</title>
@@ -1108,7 +1108,7 @@ if (is_method("REGISTER")) {
 
 
 
-	<section>
+	<section id="add_sock_hdr" xreflabel="add_sock_hdr">
 		<title>
 		<function moreinfo="none">add_sock_hdr(hdr_name)</function>
 		</title>
@@ -1144,31 +1144,31 @@ add_sock_hdr("Sock-Info");
 
 <section>
 	<title>Exported Statistics</title>
-	<section>
+	<section id="max_expires_stat" xreflabel="max_expires_stat">
 		<title><varname>max_expires</varname></title>
 		<para>
 		Value of max_expires parameter.
 		</para>
 	</section>
-	<section>
+	<section id="max_contacts_stat" xreflabel="max_contacts_stat">
 		<title><varname>max_contacts</varname></title>
 		<para>
 		The value of max_contacts parameter.
 		</para>
 	</section>
-	<section>
+	<section id="defaults_expires" xreflabel="defaults_expires">
 		<title><varname>defaults_expires</varname></title>
 		<para>
 		The value of default_expires parameter.
 		</para>
 	</section>
-	<section>
+	<section id="accepted_regs" xreflabel="accepted_regs">
 		<title><varname>accepted_regs</varname></title>
 		<para>
 		Number of accepted registrations.
 		</para>
 	</section>
-	<section>
+	<section id="rejected_regs" xreflabel="rejected_regs">
 		<title><varname>rejected_regs</varname></title>
 		<para>
 		Number of rejected registrations.

modules/usrloc/README

@@ -351,8 +351,8 @@ Chapter 1. Admin Guide
 
    The following modules must be loaded before this module:
      * Optionally an SQL database module.
-     * clusterer, if location_cluster parameters is turned on
-       (contact replication via clusterer module).
+     * Optionally a NoSQL database module.
+     * clusterer, if cluster_mode is different than "none".
 
 1.4.2. External Libraries or Applications
 
@@ -683,14 +683,16 @@ modparam("usrloc", "db_mode", 2)
        NAT pinging is a killer since during each ping cycle all
        nated contact are loaded from the DB; The lack of memory
        caching also disable the statistics exports.
-     * "federation-cachedb" - OpenSIPS will run with a
+     * "federation-cachedb-cluster" - OpenSIPS will run with a
        "federation-cachedb" cluster_mode and "sync-from-cluster"
        restart_persistency.
-     * "full-sharing" - OpenSIPS will run with a "full-sharing"
-       cluster_mode and "sync-from-cluster" restart_persistency.
-     * "full-sharing-cachedb" - OpenSIPS will run with a
-       "full-sharing-cachedb" cluster_mode, which is NoSQL-only,
-       and has natural restart persistency.
+     * "full-sharing-cluster" - OpenSIPS will run with a
+       "full-sharing" cluster_mode and "sync-from-cluster"
+       restart_persistency.
+     * "full-sharing-cachedb-cluster" - OpenSIPS will run with a
+       "full-sharing-cachedb" cluster_mode, where all location
+       data strictly resides in a NoSQL database, thus it will
+       have natural restart persistency.
 
    Refer to section Distributed SIP User Location for details
    regarding the clustering topologies and their behavior.