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

src/modules/app_lua/README

@@ -149,7 +149,7 @@ Chapter 1. Admin Guide
 
    Set the path to the Lua script to be loaded at startup. Then you can
    use lua_run(function, params) to execute a function from the script at
-   runtime.
+   runtime. The script can be in Lua-source or bytecode.
 
    Default value is “null”.
 

src/modules/htable/README

@@ -1132,13 +1132,17 @@ if(sht_match_str_value("ha", "eq", "alice")) {
 
    Parameters:
      * htable : Name of the hash table to dump
-     * key : Key name of the hash table value to dump
+     * key : Key name of the hash table value to dump. Note: if key name
+       is an integer value, it should be prefixed with s:
 
    Example:
 ...
 # Dump $sht(students=>alice)
 kamcmd htable.get students alice
 
+# Dump $sht(students=>15)
+kamcmd htable.get students s:15
+
 # Dump first entry in array key course $sht(students=>course[0])
 kamcmd htable.get students course[0]
 ...
@@ -1151,13 +1155,17 @@ kamcmd htable.get students course[0]
 
    Parameters:
      * htable : Name of the hash table to delete
-     * key : Key name of the hash table value to delete
+     * key : Key name of the hash table value to delete. Note: if key name
+       is an integer value, it should be prefixed with s:
 
    Example:
 ...
 # Delete $sht(students=>alice)
 kamcmd htable.delete students alice
 
+# Delete $sht(students=>15)
+kamcmd htable.delete students s:15
+
 # Delete first entry in array key course $sht(students=>course[0])
 kamcmd htable.delete students course[0]
 ...
@@ -1170,7 +1178,8 @@ kamcmd htable.delete students course[0]
 
    Parameters:
      * htable : Name of the hash table
-     * key : Key name in the hash table
+     * key : Key name in the hash table. Note: if key name is an integer
+       value, it should be prefixed with s:
      * Value : String value for the item
 
    Example:
@@ -1178,6 +1187,9 @@ kamcmd htable.delete students course[0]
 # Set $sht(test=>x) as string
 kamcmd htable.sets test x abc
 
+# Set $sht(test=>5) as string
+kamcmd htable.sets test s:5 abc
+
 # Set firsti entry in array key x $sht(test=>x[0]) as string
 kamcmd htable.sets test x[0] abc
 ...
@@ -1190,7 +1202,8 @@ kamcmd htable.sets test x[0] abc
 
    Parameters:
      * htable : Name of the hash table
-     * key : Key name in the hash table
+     * key : Key name in the hash table. Note: if key name is an integer
+       value, it should be prefixed with s:
      * Value : Integer value for the item
 
    Example:
@@ -1198,6 +1211,9 @@ kamcmd htable.sets test x[0] abc
 # Set $sht(test=>x) as integer
 kamcmd htable.seti test x 123
 
+# Set $sht(test=>5) as integer
+kamcmd htable.seti test s:5 123
+
 # Set first entry in array key x $sht(test=>x[0]) as integer
 kamcmd htable.seti test x[0] 123
 ...
@@ -1210,13 +1226,17 @@ kamcmd htable.seti test x[0] 123
 
    Parameters:
      * htable : name of the hash table
-     * key : key name in the hash table
+     * key : key name in the hash table. Note: if key name is an integer
+       value, it should be prefixed with s:
      * expire : integer value for the expire (seconds)
 
    Example:
 ...
 # set  expire for $sht(test=>x) to 120 secs
-kamctl rpc htable.seti test x 120
+kamctl rpc htable.setex test x 120
+
+# set  expire for $sht(test=>10) to 120 secs
+kamctl rpc htable.setex test s:10 120
 ...
 
 6.6.  htable.setxs htable key value expire
@@ -1227,7 +1247,8 @@ kamctl rpc htable.seti test x 120
 
    Parameters:
      * htable : name of the hash table
-     * key : key name in the hash table
+     * key : key name in the hash table. Note: if key name is an integer
+       value, it should be prefixed with s:
      * value : string value for the item
      * expire : integer value for the expire (seconds)
 
@@ -1235,6 +1256,9 @@ kamctl rpc htable.seti test x 120
 ...
 # set value to 'abc' and expire for $sht(test=>x) to 120 secs
 kamctl rpc htable.setxs test x abc 120
+
+# set value to 'abc' and expire for $sht(test=>10) to 120 secs
+kamctl rpc htable.setxs test s:10 abc 120
 ...
 
 6.7.  htable.setxi htable key value expire
@@ -1245,7 +1269,8 @@ kamctl rpc htable.setxs test x abc 120
 
    Parameters:
      * htable : name of the hash table
-     * key : key name in the hash table
+     * key : key name in the hash table. Note: if key name is an integer
+       value, it should be prefixed with s:
      * value : integer value for the item
      * expire : integer value for the expire (seconds)
 
@@ -1253,6 +1278,9 @@ kamctl rpc htable.setxs test x abc 120
 ...
 # set value to 10 and expire for $sht(test=>x) to 120 secs
 kamctl rpc htable.setxi test x 10 120
+
+# set value to 10 and expire for $sht(test=>5) to 120 secs
+kamctl rpc htable.setxi test s:5 10 120
 ...
 
 6.8.  htable.dump htable

src/modules/http_async_client/README

@@ -146,7 +146,8 @@ Chapter 1. Admin Guide
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
-     * libcurl libev
+     * libcurl - https://curl.se/libcurl/
+     * libevent - https://libevent.org/
 
 3. Parameters
 

src/modules/kemix/README

@@ -44,7 +44,7 @@ Chapter 1. Admin Guide
    It does not provide functions for the native Kamailio.cfg.
 
    To see the KEMI functions exported by this module, see:
-     * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
+     * https://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
 
 2. Dependencies
 

src/modules/mqueue/README

@@ -176,12 +176,12 @@ val character varying(4096) DEFAULT "" NOT NULL
           + size: size of the queue. Specifies the maximum number of items
             in queue. If exceeded the oldest one is removed. If not set
             the queue will be limitless.
-          + dbmode: If set to 1, the content of the queue is written to
-            database table when the SIP server is stopped (i.e., ensure
-            persistency over restarts). If set to 2, it is written at
-            shutdown but not read at startup. If set to 3, it is read at
-            sartup but not written at shutdown. Default value is 0 (no db
-            table interaction).
+          + dbmode: If set to 1, the content of the queue is read from
+            database at startup and is written to database table when the
+            SIP server is stopped (i.e., ensure persistency over
+            restarts). If set to 2, it is read at startup but not written
+            at shutdown. If set to 3, it is written at shutdown but not
+            read at startup. Default value is 0 (no db table interaction).
           + addmode: how to add new (key,value) pairs.
                o 0: Will push all new (key,value) pairs at the end of the
                  queue. (default)

src/modules/xhttp/README

@@ -83,8 +83,8 @@ Chapter 1. Admin Guide
    SIP parser can easily handle HTTP requests just by adding a fake Via
    header.
 
-   The <module>xmlrpc</module> module uses the same concept. The xHTTP
-   module offers a generic way of handling the HTTP protocol, by calling
+   The xmlrpc module uses the same concept. The xHTTP module offers a
+   generic way of handling the HTTP protocol, by calling
    event_route[xhttp:request] in your config. You can check the HTTP URL
    via the config variable $hu. Note that use of $ru will raise errors
    since the structure of an HTTP URL is not compatible with that of a SIP
@@ -222,7 +222,10 @@ event_route[xhttp:request] {
 
 6.1.  xhttp:request
 
-   The event route is executed when a new HTTP request is received.
+   The event route is executed when a new HTTP request is received. Most
+   of the variables related to a SIP request can be used inside this event
+   route to get HTTP request attributes (e.g., $si - source IP, $hdr(X) -
+   body of header X, $rm - request method, $rb - request body, ...).
 ...
 tcp_accept_no_cl=yes
 ...

src/modules/xlog/README

@@ -266,7 +266,7 @@ kamcmd cfg.set_now_int xlog methods_filter 15
 
    Example 1.8. Set methods_filter parameter
 ...
-modparam("xlog", "long_format", 1)
+modparam("xlog", "methods_filter", 15)
 ...
 
 5. Functions