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

src/modules/app_lua/README

@@ -139,7 +139,14 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
 
 3.2. register (string)
 
-   Use this function to register optional SIP Router submodules to Lua.
+   NOTE: Since Kamailio v5.0, KEMI exports are available in Lua script
+   under KSR module. These exports cover most of the modules, a lot more
+   that those listed next. The KEMI exports are the recommended to be
+   used, the old 'sr' module might be obsoleted soon. To read more about
+   KEMI exports and available KSR submodules, see:
+     * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
+
+   Use this parameter to register optional Kamailio submodules to Lua.
    Available submodules are:
      * alias_db - register functions from alias_db module under
        'sr.alias_db'.

src/modules/dialog/README

@@ -397,9 +397,10 @@ Chapter 1. Admin Guide
 
 2. How it works
 
-   To create the dialog associated with an initial request, the flag
-   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) must be set before
-   creating the corresponding transaction.
+   To create the dialog associated with an initial INVITE request, execute
+   the function “dlg_manage()” or set the flag specified by parameter
+   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) before creating the
+   corresponding transaction.
 
    The dialog is automatically destroyed when a “BYE” is received. In case
    of no “BYE”, the dialog lifetime is controlled via the default timeout
@@ -576,6 +577,10 @@ modparam("dialog", "rr_param", "xyz")
    Flag to be used for marking if a dialog should be constructed for the
    current request (this make sense only for initial requests).
 
+   Note: it is not needed to set this parameter and its corresponding flag
+   for initial request in case the “dlg_manage()” function is used. In
+   other words, using “dlg_manage()” alone is enough.
+
    Default value is “none”.
 
    Example 1.4. Set dlg_flag parameter

src/modules/dialplan/README

@@ -424,7 +424,8 @@ xlog("translated to var $var(y) \n");
 
 6.2.  dp_reload()
 
-   Forces an update of the translation rules from the database.
+   Reload the translation rules from the database. Note that there is a
+   rate limiting of maximum one reload in five seconds.
 
    Name: dp_reload
 
@@ -468,11 +469,14 @@ xlog("translated to var $var(y) \n");
    Name: dialplan.translate
 
    Parameters: 2
-     * Dial plan ID
-     * Input String
+     * Dial plan ID (number)
+     * Input string (string) - it can be prefixed with 's:' to avoid
+       auto-conversion when the command is executed with CLI apps such as
+       kamcmd.
 
    Example:
                 kamcmd dialplan.translate 1 "abcdxyz"
+                kamcmd dialplan.translate 1 s:123456789
 
 8. Installation
 

src/modules/siputils/README

@@ -890,9 +890,11 @@ if (is_supported("outbound")) { ... }
    sender. For incoming SIP requests, it means there is only one Via
    header. For incoming SIP replies, it means that top Record-Route URI is
    'myself' and source address is not matching it (to avoid detecting in
-   case of local loops). Note that it does not detect spirals, which can
-   have the condition for replies true also in the case of additional SIP
-   reply receival.
+   case of local loops). The detection is done only when Record-Route has
+   an IP address in its URI (for a domain, it returns -1/false).
+
+   Note that it does not detect spirals, which can have the condition for
+   replies true also in the case of additional SIP reply reception.
 
    This function can be used from ANY_ROUTE.
 

src/modules/tsilo/README

@@ -196,7 +196,7 @@ if (is_method("INVITE")) {
    Example 1.4. ts_append usage
 ...
 if (is_method("REGISTER")) {
-        ts_append("location", "$tU");
+        ts_append("location", "$tu");
 }
 ...
 

src/modules/uac_redirect/README

@@ -196,12 +196,12 @@ modparam("uac_redirect","accept_filter",".*@siphub\.net")
 
 4.4. acc_function (string)
 
-   Specifies the accounting function to be used. Just be defining this
+   Specifies the accounting function to be used. Just by defining this
    parameter, the accounting support will not be enabled. Accounting may
    only be enabled via two parameters set_accept_filter() scripting
    function.
 
-   Its values my be:
+   Its values may be:
      * acc_log_request
      * acc_db_request
      * acc_rad_request
@@ -217,7 +217,7 @@ modparam("uac_redirect","acc_function","acc_db_request")
 4.5. acc_db_table (string)
 
    Specifies the accounting table to be used if DB accounting was chosen
-   (acc_function was set to “acc_db_request”). Just be defining this
+   (acc_function was set to “acc_db_request”). Just by defining this
    parameter, the accounting support will not be enabled. Accounting may
    only be enabled via two parameters set_accept_filter() scripting
    function.

src/modules/usrloc/README

@@ -74,9 +74,9 @@ Carsten Bock
               3.28. fetch_rows (integer)
               3.29. hash_size (integer)
               3.30. preload (string)
-              3.31. db_update_as_insert (string)
-              3.32. db_check_update (string)
-              3.33. timer_procs (string)
+              3.31. db_update_as_insert (int)
+              3.32. db_check_update (int)
+              3.33. timer_procs (int)
               3.34. xavp_contact (string)
               3.35. db_ops_ruid (int)
               3.36. handle_lost_tcp (int)
@@ -223,9 +223,9 @@ Chapter 1. Admin Guide
         3.28. fetch_rows (integer)
         3.29. hash_size (integer)
         3.30. preload (string)
-        3.31. db_update_as_insert (string)
-        3.32. db_check_update (string)
-        3.33. timer_procs (string)
+        3.31. db_update_as_insert (int)
+        3.32. db_check_update (int)
+        3.33. timer_procs (int)
         3.34. xavp_contact (string)
         3.35. db_ops_ruid (int)
         3.36. handle_lost_tcp (int)
@@ -346,9 +346,9 @@ Chapter 1. Admin Guide
    3.28. fetch_rows (integer)
    3.29. hash_size (integer)
    3.30. preload (string)
-   3.31. db_update_as_insert (string)
-   3.32. db_check_update (string)
-   3.33. timer_procs (string)
+   3.31. db_update_as_insert (int)
+   3.32. db_check_update (int)
+   3.33. timer_procs (int)
    3.34. xavp_contact (string)
    3.35. db_ops_ruid (int)
    3.36. handle_lost_tcp (int)
@@ -767,7 +767,7 @@ modparam("usrloc", "hash_size", 12)
 modparam("usrloc", "preload", "location")
 ...
 
-3.31. db_update_as_insert (string)
+3.31. db_update_as_insert (int)
 
    Set this parameter if you want to do INSERT DB operations instead of
    UPDATE DB operations. It is recommended to set this parameter if you
@@ -780,7 +780,7 @@ modparam("usrloc", "preload", "location")
 modparam("usrloc", "db_update_as_insert", 1)
 ...
 
-3.32. db_check_update (string)
+3.32. db_check_update (int)
 
    Set this parameter to 1 if you want to do DB INSERT if the number of
    affected rows by contact DB UPDATE operation is 0. The database module
@@ -795,7 +795,7 @@ modparam("usrloc", "db_update_as_insert", 1)
 modparam("usrloc", "db_check_update", 1)
 ...
 
-3.33. timer_procs (string)
+3.33. timer_procs (int)
 
    Number of timer processes to be started by module. Timer processes take
    care of checking expired records and syncronization with database. If

src/modules/websocket/README

@@ -200,7 +200,7 @@ event_route[xhttp:request] {
                 # Optional... perform HTTP authentication
 
                 # ws_handle_handshake() exits (no further configuration file
-                # processing of the request) when complete.
+                # processing of the request) when complete in case of failure.
                 if (ws_handle_handshake())
                 {
                         # Optional... cache some information about the
@@ -474,7 +474,8 @@ modparam("websocket", "verbose_list", 1)
 Note
 
    This function returns 0, stopping all further processing of the
-   request, when there is a problem.
+   request, when there is a problem. Otherwise, it returns 1 (or positive
+   number) in case of success.
 
    Example 1.11. ws_handle_handshake usage
 ...