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

src/modules/acc/README

@@ -959,7 +959,7 @@ modparam("acc", "db_table_missed_calls", "myMC_table")
 
 6.20. db_url (string)
 
-   SQL address -- database specific. If is set to NULL or empty string,
+   SQL address -- database specific. If it is set to NULL or empty string,
    the SQL support is disabled.
 
    Default value is “NULL” (SQL disabled).

src/modules/acc_json/README

@@ -117,8 +117,8 @@ Chapter 1. Admin Guide
 
 2.1. Kamailio Modules
 
-   The module depends on the following modules (in the other words the
-   listed modules must be loaded before this module):
+   The module depends on the following modules (in other words the listed
+   modules must be loaded before this module):
      * acc - accounting module
      * mqueue - mqueue module (optional)
 

src/modules/acc_radius/README

@@ -92,8 +92,8 @@ Chapter 1. Admin Guide
 
 2.1. Kamailio Modules
 
-   The module depends on the following modules (in the other words the
-   listed modules must be loaded before this module):
+   The module depends on the following modules (in other words the listed
+   modules must be loaded before this module):
      * acc - accounting module
 
 2.2. External Libraries or Applications

src/modules/alias_db/README

@@ -93,7 +93,7 @@ Chapter 1. Admin Guide
    to supplement the registration in the location database. Users are this
    way on a proxy reachable with several request URIs.
 
-   As the module use no memory caching the lookup is a bit slower but the
+   As the module uses no memory caching the lookup is a bit slower but the
    data provisioning is easier. With very fast databases like MySQL the
    speed penalty can be lowered. Also, the search can be performed on
    different tables in the same script.

src/modules/app_java/README

@@ -295,9 +295,8 @@ ure.
 NULL.
         Parameters count should be exactly the same as signature count.
         Note 1: Arrays representation (symbol '[') is not supported yet.
-        Note 2: You shall use a correct signature, e.g. the following examples o
-f
-        combinations are invalid:
+        Note 2: You shall use a correct signature, e.g. the following examples
+        of combinations are invalid:
         java_method_exec("ExampleMethod", "ZI", "False");
         java_method_exec("ExampleMethod", "LI", "something", "5");
 

src/modules/app_jsdt/README

@@ -98,7 +98,7 @@ Chapter 1. Admin Guide
        Therefore jsdt_run() cannot execute functions from scripts loaded
        via jsdt_dofile() in config. This is kind of caching mode, avoiding
        reading file every time, but you must be sure you do not have
-       someting that is executed by default and requires access to SIP
+       something that is executed by default and requires access to SIP
        message. This environment is also used by KEMI framework for the
        config SIP routing functions.
 
@@ -129,7 +129,7 @@ Chapter 1. Admin Guide
    Set the path to the JavaScript file to be loaded at startup. Then you
    can use jsdt_run(function, params) to execute a function from the
    script at runtime. If you use it for KEMI configuration, then it has to
-   include the requited functions.
+   include the required functions.
 
    Default value is “null”.
 

src/modules/app_lua/README

@@ -92,7 +92,7 @@ Chapter 1. Admin Guide
    the KEMI framework and exporting Lua module 'KSR'.
 
    To read more about KEMI exports and available KSR submodules, see:
-     * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
+     * https://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
 
    Note: to have the old Lua module 'sr' available, load the 'app_lua_sr'
    Kamailio module.

src/modules/app_lua_sr/README

@@ -98,10 +98,10 @@ Chapter 1. Admin Guide
 
    NOTE: Since Kamailio v5.0, KEMI exports are available in Lua script
    under KSR module exposed by 'app_lua'. These exports cover most of the
-   modules, a lot more that those listed next. The KEMI exports are the
+   modules, a lot more than 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/
+     * https://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
 
    Use this parameter to register optional Kamailio submodules to Lua.
    Available submodules are:

src/modules/app_perl/README

@@ -386,7 +386,7 @@ modparam("app_perl", "modpath", "/usr/local/lib/kamailio/perl/")
    that not all Kamailio processes will reset the interpreter at the same
    time. Each will do it when it has executed the script for the number of
    reset_cycles. Also, be aware that the reset of the interpreter is
-   taking a bit of time (in the order of tens of mili-seconds).
+   taking a bit of time (in the order of tens of milliseconds).
 
    Default value is 0 - never reset the interpreter.
 
@@ -413,7 +413,7 @@ modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
    is the value for application exit and can break reloading.
 
    If set to 0, continue even of perl_parse() returns non-zero, logging a
-   warning. If set to 1, realod fails on non-zero return code and triggers
+   warning. If set to 1, reload fails on non-zero return code and triggers
    an exit.
 
    Default value is 0.
@@ -1175,7 +1175,7 @@ my $conf = new Kamailio::LDAPUtils::LDAPConf();
 
    This module may be used to retrieve the global LDAP configuration as
    used by other LDAP software, such as nsswitch.ldap and pam-ldap. The
-   configuration is usualy stored in /etc/openldap/ldap.conf
+   configuration is usually stored in /etc/openldap/ldap.conf
 
    When used from an account with sufficient privileges (e.g. root), the
    ldap manager password is also retrieved.
@@ -1667,7 +1667,7 @@ Chapter 3. Perl samples
 
    The Kamailio::Utils::PhoneNumbers package provides two methods for the
    transformation of local to canonical telephone numbers, and vice versa.
-   This script demonstrates it's use.
+   This script demonstrates its use.
 
 1.1.10. pseudovars.pl
 

src/modules/app_python/README

@@ -78,8 +78,8 @@ Chapter 1. Admin Guide
    'modules/app_python/python_examples/'.
 
    As python2 is deprecated in Debian and other distributions, please use
-   the “app_python3” module instead. This module will be removed future
-   releases.
+   the “app_python3” module instead. This module will be removed in a
+   future release.
 
 2. Dependencies
 

src/modules/app_ruby/README

@@ -116,7 +116,7 @@ Chapter 1. Admin Guide
    Set the path to the Ruby file to be loaded at startup. Then you can use
    Ruby_run(function, params) to execute a function from the script at
    runtime. If you use it for KEMI configuration, then it has to include
-   the requited functions.
+   the required functions.
 
    Default value is “null”.
 

src/modules/app_sqlang/README

@@ -123,7 +123,7 @@ Chapter 1. Admin Guide
    Set the path to the SQLang file to be loaded at startup. Then you can
    use sqlang_run(function, params) to execute a function from the script
    at runtime. If you use it for KEMI configuration, then it has to
-   include the requited functions.
+   include the required functions.
 
    Default value is “null”.
 

src/modules/async/README

@@ -209,7 +209,7 @@ route[RESUME] {
    the SIP request with the route[routename]. In case of internal errors,
    the function returns false, otherwise the function exits the execution
    of the script at that moment (return 0 behaviour). This function works
-   only if the ms_timer parameter has a value greater then 0.
+   only if the ms_timer parameter has a value greater than 0.
 
    The routename parameter can be a static string or a dynamic string
    value with config variables.
@@ -262,7 +262,7 @@ exit;
    Simulate a sleep of 'milliseconds' and then continue the processing of
    SIP request with the next action. In case of internal errors, the
    function returns false. This function works only if the ms_timer
-   parameter has a value greater then 0.
+   parameter has a value greater than 0.
 
    The sleep parameter represent the number of milliseconds to suspend the
    processing of SIP request. Maximum value is 30000 (30 sec). The

src/modules/auth/README

@@ -287,7 +287,7 @@ modparam("auth", "qop", "auth")   # set qop=auth
 
    If enabled the received nc value is remembered and checked against the
    older value (for a successful authentication the received nc must be
-   greater then the previously received one, see rfc2617 for more
+   greater than the previously received one, see rfc2617 for more
    details). This will provide protection against replay attacks while
    still allowing credentials caching at the UA side.
 
@@ -306,13 +306,13 @@ modparam("auth", "qop", "auth")   # set qop=auth
    maximum number of tracked nonces is set using the nc_array_size or
    nc_array_order parameters. If this number is exceeded, older entries
    will be overwritten. As long as the maximum rate of challengeable
-   messages per average response time is lower then nc_array_size, the
+   messages per average response time is lower than nc_array_size, the
    nonce_count checks should work flawlessly. For optimum performance
    (maximum reuse of cache credentials) nc_array_size divided by
-   nid_pool_no should be lower then the message rate multiplied by the
+   nid_pool_no should be lower than the message rate multiplied by the
    desired nonce_expire.
 
-   The maximum accepted nc value is 255. If nc becomes greater then this,
+   The maximum accepted nc value is 255. If nc becomes greater than this,
    the nonce will be considered stale and the UA will be re-challenged.
 
    Note: nonce_count should be enabled only in stateful mode (a
@@ -409,7 +409,7 @@ route{
    nonces. The maximum number of tracked nonces is set using the
    otn_in_flight_no or otn_in_flight_order parameters. If this number is
    exceeded, older entries will be overwritten. As long as the maximum
-   rate of challengeable messages per average response time is lower then
+   rate of challengeable messages per average response time is lower than
    otn_in_flight_no, the one_time_nonce checks should work flawlessly.
 
    The default value is 0 (off).
@@ -551,11 +551,11 @@ modparam("auth", "otn_in_flight_order", 23)   # 8 Mb (1Mb memory)
 
    If you use multiple servers in your installation, and would like to
    authenticate on the second server against the nonce generated at the
-   first one its necessary to explicitly set the secret to the same value
-   on all servers. However, as the use of a shared (and fixed) secret as
-   nonce is insecure, it is much better is to stay with the default. Any
-   clients should send the authenticated request to the server that issued
-   the challenge.
+   first one, it is necessary to explicitly set the secret to the same
+   value on all servers. However, as the use of a shared (and fixed)
+   secret as nonce is insecure, it is much better is to stay with the
+   default. Any clients should send the authenticated request to the
+   server that issued the challenge.
 
    Default value is randomly generated string.
 
@@ -589,7 +589,7 @@ modparam("auth", "nonce_expire", 600)   # Set nonce_expire to 600s
    In some cases, like shortly after a system time backward adjustment or
    when the current proxy is part of a cluster which is not
    time-synchronized, it's possible to receive a nonce with creation time
-   in the future. In this case if the difference is greater then
+   in the future. In this case if the difference is greater than
    nonce_auth_max_drift seconds, consider the nonce stale and re-challenge
    (otherwise after a dramatic time change backwards, it might happen that
    some previously generated nonces will be valid for too much time).
@@ -706,7 +706,7 @@ if (www_authenticate("realm", "subscriber")) {
 
 4.2. has_credentials(realm)
 
-   This function returns true of the request has Authorization or
+   This function returns true if the request has Authorization or
    Proxy-Authorization header with provided realm. The parameter can be
    string with pseudo-variables.
 

src/modules/auth_db/README

@@ -126,8 +126,8 @@ Chapter 1. Admin Guide
 
 2.1. Kamailio Modules
 
-   The module depends on the following modules (in the other words the
-   listed modules must be loaded before this module):
+   The module depends on the following modules (in other words the listed
+   modules must be loaded before this module):
      * auth -- Generic authentication functions
      * database -- Any database module (currently mysql, postgres, dbtext)
 
@@ -421,7 +421,7 @@ if (!proxy_authorize("$fd", "subscriber)) {
 4.5.  auth_check(realm, table, flags)
 
    The function combines the functionalities of www_authenticate and
-   proxy_authenticate, first being exectuted if the SIP request is a
+   proxy_authenticate, first being executed if the SIP request is a
    REGISTER, the second for the rest.
 
    In addition, a matter of flags parameter value, the function checks if

src/modules/auth_ephemeral/README

@@ -308,7 +308,7 @@ if (!autheph_www("$fd")) {
 4.3.  autheph_check(realm)
 
    This function combines the functionalities of autheph_www and
-   autheph_proxy, the first being exectuted if the SIP request is a
+   autheph_proxy, the first being executed if the SIP request is a
    REGISTER, the second for the rest.
 
 Note

src/modules/auth_identity/README

@@ -348,8 +348,7 @@ modparam("auth_identity","accept_pem_certs",1)
    then this function checks whether it falls in message timeout (set by
    msg_timeout parameter). If there is not any Date header then the module
    adds one. This function also checks whether the certificate of the
-   authentication service (set by certificate_path parameter) has been
-   expired.
+   authentication service (set by certificate_path parameter) has expired.
 
 6.1.1. Dependencies
 

src/modules/auth_radius/README

@@ -147,8 +147,8 @@ Chapter 1. Admin Guide
 
 3.1. Modules
 
-   The module depends on the following modules (in the other words the
-   listed modules must be loaded before this module):
+   The module depends on the following modules (in other words the listed
+   modules must be loaded before this module):
      * auth -- Generic authentication functions
 
 3.2. External Libraries or Applications

src/modules/avpops/README

@@ -210,7 +210,7 @@ $avp(i3:123) - the AVP identified by the integer 123 which has script flags 1
 
    DB URL for database connection.
 
-   This parameter is optional, it's default value being NULL.
+   The default value is NULL.
 
    Example 1.2. Set db_url parameter
 ...
@@ -221,8 +221,8 @@ modparam("avpops","db_url","mysql://user:passwd@host/database")
 
    DB table to be used.
 
-   This parameter is optional, it's default value being NULL. But if you
-   specify a db_url, you need also setup this parameter.
+   The default value is NULL. But if you specify a db_url, you need also
+   to setup this parameter.
 
    Example 1.3. Set avp_table parameter
 ...
@@ -445,7 +445,7 @@ avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
        many rows, then multiple AVPs with corresponding name will be
        added. The value type of the AVP (string or integer) will be
        derived from the type of the columns. Please note that only this
-       two datatypes are supported, so its not possible for example to
+       two datatypes are supported, so it is not possible for example to
        return floating point or big integer values this way.
 
    The function delivers the following return-codes: