modules: readme files regenerated - modules ... [skip ci]

src/modules/auth/README

@@ -143,7 +143,8 @@ Chapter 1. Admin Guide
 
 2. Dependencies
 
-   The module does not depend on any other module.
+   The following modules must be loaded before this module:
+     * sl - stateless reply.
 
 3. Parameters
 

src/modules/cfgutils/README

@@ -757,11 +757,11 @@ $ kamcmd cfgutils.get_gflags
    Example 1.34. RANDOM pseudo-variable usage
 ...
 if (rand_event()) {
-  $avp(i:10) = ($RANDOM / 16777216); # 2^24
-  if ($avp(i:10) < 10) {
-     $avp(i:10) = 10;
+  $var(value) = ($RANDOM / 16777216); # 2^24
+  if ($var(value) < 10) {
+     $var(value) = 10;
   }
-  append_to_reply("Retry-After: $avp(i:10)\n");
+  append_to_reply("Retry-After: $var(value)\n");
   sl_send_reply("503", "Try later");
   exit;
 };

src/modules/db_cluster/README

@@ -197,7 +197,8 @@ modparam("db_cluster", "max_query_length", 5)
 modparam("db_cluster", "connection",
              "c1=>mysql://kamailio:kamailiorw@localhost/kamailio1")
 modparam("db_cluster", "connection",
-             "c2=>mysql://kamailio:kamailiorw@localhost/kamailio2")
+             "c2=>mysql://kamailio:kamailiorw@remotehost/kamailio2")
+
 modparam("db_cluster", "cluster", "k1=>c1=9r9p;c2=9r9p")
 
 modparam("acc", "db_url", "cluster://k1")

src/modules/nathelper/README

@@ -706,9 +706,11 @@ if(is_rfc1918("$rd")) {
 5.9.  set_contact_alias([trim])
 
    Adds an “;alias=ip~port~transport” parameter to the contact URI
-   containing the received ip, port, and transport protocol. The new
-   contact URI is immediately visible to other modules in the way the
-   fix_nated_contact() does it.
+   containing the received ip, port, and transport protocol. The update of
+   contact URI is signaled to a few other modules in the way the
+   fix_nated_contact() does it by using the internal flags. The new value
+   is not visible to pseudo-variables and it does not change the SIP
+   message buffer.
 
    Meaning of parameters:
      * trim - by default, set_contact_alias() will not detect and trim an

src/modules/ratelimit/README

@@ -514,5 +514,5 @@ modparam("ratelimit", "pipe", "4:NETWORK:10000")
 
    The pipes and queues are stored as static vectors, so no more than
    MAX_PIPES/MAX_QUEUES can be added without recompilation.
-     * MAX_PIPES - 16
-     * MAX_QUEUES - 10
+     * MAX_PIPES - 32
+     * MAX_QUEUES - 32

src/modules/tm/README

@@ -144,7 +144,7 @@ Daniel-Constantin Mierla
               5.1. tm.list
               5.2. tm.t_uac_start
               5.3. tm.t_uac_wait
-              5.4. tm.t_uac_wait
+              5.4. tm.t_uac_wait_block
               5.5. tm.cancel
               5.6. tm.hash_stats
               5.7. tm.reply
@@ -404,7 +404,7 @@ Chapter 1. Admin Guide
         5.1. tm.list
         5.2. tm.t_uac_start
         5.3. tm.t_uac_wait
-        5.4. tm.t_uac_wait
+        5.4. tm.t_uac_wait_block
         5.5. tm.cancel
         5.6. tm.hash_stats
         5.7. tm.reply
@@ -2975,7 +2975,7 @@ t_clean();
    5.1. tm.list
    5.2. tm.t_uac_start
    5.3. tm.t_uac_wait
-   5.4. tm.t_uac_wait
+   5.4. tm.t_uac_wait_block
    5.5. tm.cancel
    5.6. tm.hash_stats
    5.7. tm.reply
@@ -3010,7 +3010,7 @@ t_clean();
    Similar to tm.t_uac_start, but waits asynchronously for the SIP
    response and tries to provide its details via RPC response.
 
-5.4.  tm.t_uac_wait
+5.4.  tm.t_uac_wait_block
 
    Similar to tm.t_uac_start, but blocks waiting for the SIP response and
    returns the SIP reply code and reason text via RPC response. It waits

src/modules/xhttp/README

@@ -131,11 +131,15 @@ Chapter 1. Admin Guide
 
 3.2. Kamailio Core Settings
 
-   SIP requires a Content-Length header for TCP transport. But most HTTP
-   clients do not set the content length for normal GET requests.
-   Therefore, the core must be configured to allow incoming requests
-   without content length header:
-     * tcp_accept_no_cl=yes
+   Related core settings:
+     * tcp_accept_no_cl=yes - SIP requires the Content-Length header for
+       TCP transport. But most HTTP clients do not set the content length
+       for normal GET requests. Therefore, the core must be configured to
+       allow incoming requests without content length header.
+     * http_reply_parse=yes - various Kamailio modules may parse what it
+       is sent out (e.g., for replication, topology management). In such
+       case errors are printed if the outgoing message is not SIP and this
+       parameter is not set.
 
 3.3. External Libraries or Applications