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

src/modules/mohqueue/README

@@ -327,7 +327,7 @@ $var(mohq) = "operators";
    volatile database in memory of call status. If the module is restarted
    it loses the internal database and clears the external one.
 
-   On a reqular basis it checks the external table that defines the queues
+   On a regular basis it checks the external table that defines the queues
    to see if the definition has changed. It makes this check under the
    following conditions: the queue has not been checked in the last 60
    seconds AND no call is currently in queue or transitioning in or out.

src/modules/osp/README

@@ -221,7 +221,7 @@ modparam("osp","device_ip","[1.1.1.1]")
 
    The device_port (string) parameter is an optional field which includes
    the SIP port being used by Kamailio in the peering request (as
-   SourceAlternate type=network) to the peering server. If is not
+   SourceAlternate type=network) to the peering server. If it is not
    configured, this information is not included in the peering request.
    This field is useful if multiple Kamailio are running on the same Linux
    computer since it enables the peering server to administer different
@@ -393,7 +393,7 @@ modparam("osp","redirection_uri_format",1)
    value is "$avp(s:_osp_source_networkid_)". Then the source network ID
    can be set by "$avp(s:_osp_source_networkid_) = pseudo-variables". All
    pseudo variables are described in
-   http://kamailio.org/dokuwiki/doku.php/pseudovariables:1.3.x.
+   https://www.kamailio.org/wikidocs/cookbooks/devel/pseudovariables/.
 
    Example 1.17. Setting the source network ID AVP
 modparam("osp","source_networkid_avp","$avp(s:snid)")

src/modules/pike/README

@@ -307,7 +307,7 @@ tree root /                \ - 142
    necessary to block an IP.
 
    The maximum number of hits to turn an address red are (n is the
-   address's number of bytes):
+   address' number of bytes):
 
    1 (first byte) + x (second byte) + (x / 2) * (n - 2) (for the rest of
    the bytes) + (n - 1) (to turn the node to red).

src/modules/qos/README

@@ -174,11 +174,12 @@ Chapter 2. Developer Guide
    Register a new callback to the qos.
 
    Meaning of the parameters is as follows:
-     * struct qos_ctx_st* qos - qos to register callback to. If maybe NULL
-       only for QOSCB_CREATED callback type, which is not a per qos type.
-     * int type - types of callbacks; more types may be register for the
-       same callback function; only QOSCB_CREATED must be register alone.
-       Possible types:
+     * struct qos_ctx_st* qos - qos to register callback to. It may be
+       NULL only for QOSCB_CREATED callback type, which is not a per qos
+       type.
+     * int type - types of callbacks; more types may be registered for the
+       same callback function; only QOSCB_CREATED must be registered
+       alone. Possible types:
           + QOSCB_CREATED - called when a new qos context is created -
             it's a global type (not associated to any qos).
           + QOSCB_ADD_SDP - called when a new SDP was added to the qos

src/modules/ratelimit/README

@@ -490,8 +490,8 @@ modparam("ratelimit", "pipe", "4:NETWORK:10000")
    Name: rl.push_load
 
    Parameters:
-     * load - the forced value of load (it must be greater then 0.0 and
-       smaller then 1.0).
+     * load - the forced value of load (it must be greater than 0.0 and
+       less than 1.0).
 
    RPC Command Format:
                 kamcmd rl.push_load 0.85

src/modules/registrar/README

@@ -646,7 +646,7 @@ modparam("registrar", "method_filtering", 1)
 
 3.20. use_path (integer)
 
-   If set to 1, the “Path:” header is handled according to the parameter
+   If set to 1, the “Path:” header is handled according to the parameter.
    This parameter can be modified via Kamailio config framework.
    “path_mode”.
 
@@ -686,7 +686,7 @@ modparam("registrar", "path_mode", 0)
    registration is set as received-uri and the NAT branch flag is set for
    this contact. This is useful if the registrar is placed behind a SIP
    loadbalancer, which passes the nat'ed UAC address as “received”
-   parameter in it's Path uri.
+   parameter in its Path uri.
 
    Default value is 0 (disabled).
 
@@ -750,7 +750,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
        save() on a reply route to set the connecion of the original
        request. Used in save().
 
-   For example. if this parameter is set to 'reg', then the number of
+   For example if this parameter is set to 'reg', then the number of
    maximum contacts can be set in $xavp(reg=>max_contacts).
 
    Default value is NULL (disabled).
@@ -1030,16 +1030,16 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
             is set.
        The flags may be given in decimal or hexadecimal format.
      * uri (optional - flags param has to be set and can be 0 for default
-       behavior) - SIP URI to do be used instead of To header URI. It can
-       be a dynamic string with pseudo-variables.
+       behavior) - SIP URI to be used instead of To header URI. It can be
+       a dynamic string with pseudo-variables.
 
    Return codes:
      * -2 - error, too many contacts for AOR.
-       -1 - error.
-       1 - contacts inserted.
-       2 - contacts updated.
-       3 - contacts deleted.
-       4 - contacts returned.
+     * -1 - error.
+     * 1 - contacts inserted.
+     * 2 - contacts updated.
+     * 3 - contacts deleted.
+     * 4 - contacts returned.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE and
    REPLY_ROUTE.
@@ -1067,14 +1067,14 @@ save("location", "0x00", "sip:[email protected]");
 
    Meaning of the parameters is as follows:
      * domain - Name of table that should be used for the lookup.
-     * uri (optional) - SIP URI to do be used instead of R-URI. It can be
-       a dynamic string with pseudo-variables.
+     * uri (optional) - SIP URI to be used instead of R-URI. It can be a
+       dynamic string with pseudo-variables.
 
    Return codes:
      * 1 - contacts found and returned.
-       -1 - no contact found.
-       -2 - contacts found, but method not supported.
-       -3 - internal error during processing.
+     * -1 - no contact found.
+     * -2 - contacts found, but method not supported.
+     * -3 - internal error during processing.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
@@ -1163,8 +1163,8 @@ xinfo("first contact record - socket: $xavp(cul>socket)\n");
 
    Meaning of the parameters is as follows:
      * domain - Name of table that should be used for the lookup.
-     * uri (optional) - SIP URI to do be used instead of Request/To-URI.
-       It can be a dynamic string with pseudo-variables.
+     * uri (optional) - SIP URI to be used instead of Request/To-URI. It
+       can be a dynamic string with pseudo-variables.
      * match_option (optional) - flag parameter to restrict contact
        search. use xavp_cfg to set the values to compare to.
        flag values is as follows:

src/modules/rr/README

@@ -765,7 +765,7 @@ record_route_advertised_address("1.2.3.4:5090");
 
 1.3.  add_rr_param(msg, param)
 
-   Adds a parameter to the requests's Record-Route URI (param must be in
+   Adds a parameter to the requests' Record-Route URI (param must be in
    “;name=value” format).
 
    The function returns 0 on success. Otherwise, -1 is returned.

src/modules/rtimer/README

@@ -119,7 +119,7 @@ modparam("rtimer", "default_interval", 300)
 ...
 # time interval set to 10 seconds
 modparam("rtimer", "timer", "name=ta;interval=10;mode=1;")
-# time interval set to 100 mili-seconds
+# time interval set to 100 milliseconds
 modparam("rtimer", "timer", "name=ta;interval=100000u;mode=1;")
 ...
 

src/modules/rtp_media_server/README

@@ -129,7 +129,7 @@ Chapter 1. Admin Guide
    If you want to build oRTP and mediastreamer from source, you can use
    the provided script for Debian "install_bc.sh".
      * oRTP git clone git://git.linphone.org/ortp.git
-       oRTP is a library implemeting Real-time Transport Protocol (RFC
+       oRTP is a library implementing Real-time Transport Protocol (RFC
        3550), distributed under GNU GPLv2 or proprietary license.
      * mediastreamer2 git clone git://git.linphone.org/mediastreamer2.git
        Mediastreamer2 is a powerful and lightweight streaming engine
@@ -278,8 +278,8 @@ e in-dialog request needs to be handled by it.
 
 5.6. rms_play (file, event_route)
 
-   Play a wav file, a resampler is automaticaly configured to resample and
-   convert stereo to mono if needed.
+   Play a wav file, a resampler is automatically configured to resample
+   and convert stereo to mono if needed.
 
    The second parameter is the event route that will be called when the
    file was played.

src/modules/ruxc/README

@@ -129,7 +129,7 @@ Chapter 1. Admin Guide
 
 3.1. http_timeout (int)
 
-   The interval in miliseconds after which the HTTP GET or POST query
+   The interval in milliseconds after which the HTTP GET or POST query
    times out. It is the overall timeout, including DNS resolution,
    connecting time, redirects, and reading the response body. Slow DNS
    resolution may cause a request to exceed the timeout, because the DNS
@@ -149,9 +149,9 @@ modparam("ruxc", "http_timeout", 2000)
 
 3.2. http_timeout_connect (int)
 
-   The interval in miliseconds after which to give up on connecting to the
-   HTTP/S server. If http_timeout is set, this one takes precedence. The
-   library beneath has a default 30 seconds connect timeout.
+   The interval in milliseconds after which to give up on connecting to
+   the HTTP/S server. If http_timeout is set, this one takes precedence.
+   The library beneath has a default 30 seconds connect timeout.
 
    Use 0 to disable setting it in the library.
 
@@ -164,7 +164,7 @@ modparam("ruxc", "http_timeout_connect", 2000)
 
 3.3. http_timeout_read (int)
 
-   The interval in miliseconds after which the read on HTTP/S connection
+   The interval in milliseconds after which the read on HTTP/S connection
    socket timeouts. If http_timeout is set, it takes precedence.
 
    Use 0 to disable setting it in the library.
@@ -178,7 +178,7 @@ modparam("ruxc", "http_timeout_read", 2000)
 
 3.4. http_timeout_write (int)
 
-   The interval in miliseconds after which the write on HTTP/S connection
+   The interval in milliseconds after which the write on HTTP/S connection
    socket timeouts. If http_timeout is set, it takes precedence.
 
    Use 0 to disable setting it in the library.

src/modules/statsd/README

@@ -170,7 +170,7 @@ route [gauge_method]{
 3.4.  statsd_start(key)
 
    statsd_start set an avp with the key name, and when statsd_stop(key) is
-   used, the module will send statsd the difference in milliseconds. this
+   used, the module will send statsd the difference in milliseconds. This
    is useful to know the time of a SQL query, or how much time your
    replies take.
 

src/modules/tcpops/README

@@ -90,9 +90,8 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This modules allows Kamailio to control the TCP connection options
-   (such as the keepalive mechanism), on demand, and on a per-socket
-   basis.
+   This module allows Kamailio to control the TCP connection options (such
+   as the keepalive mechanism), on demand, and on a per-socket basis.
 
    Note: the keepalive functions only work on systems with the
    HAVE_TCP_KEEPIDLE, HAVE_TCP_KEEPCNT and HAVE_TCP_KEEPINTVL macros
@@ -139,7 +138,7 @@ modparam("tcpops", "event_callback", "ksr_tcpops_event")
 ...
 -- event callback function implemented in Lua
 function ksr_tcpops_event(evname)
-        KSR.info("===== evapi module triggered event: " .. evname .. "\n");
+        KSR.info("===== tcpops module triggered event: " .. evname .. "\n");
         return 1;
 end
 ...

src/modules/textops/README

@@ -876,8 +876,8 @@ append_urihf("CC-Diversion: ", "\r\n");
 
 Note
 
-   The function is also able to distinguish the compact names. For exmaple
-   “From” will match with “f”
+   The function is also able to distinguish the compact names. For example
+   “From” will match with “f”.
 
    Meaning of the parameters is as follows:
      * hf_name - Header field name (long or compact form). It can be only

src/modules/textopsx/README

@@ -320,7 +320,7 @@ if(fnmatch("$rU", "123*"))
    Meaning of the parameters is as follows:
      * hf - Header field to be appended. Format: HFNAME [ [IDX] ]. If
        index is not specified new header is inserted at the end of
-       message. The index 1 correxponds to the first header.
+       message. The index 1 corresponds to the first header.
      * hvalue - Value to be added, config var formatting supported.
 
    Example 1.8. append_hf_value usage
@@ -341,7 +341,7 @@ ot exists add new header
    Meaning of the parameters is as follows:
      * hf - Header field to be appended. Format: HFNAME [ [IDX] ]. If
        index is not specified new header is inserted at the top of
-       message. The index 1 correxponds to the first header.
+       message. The index 1 corresponds to the first header.
      * hvalue - Value to be added, config var formatting supported.
 
    Example 1.9. insert_hf_value usage
@@ -359,7 +359,7 @@ insert_hf_value("foo[1]", "gogo") # try add to the first header
    Meaning of the parameters is as follows:
      * hf_par - Header field/param to be removed. Format: HFNAME [ [IDX] ]
        [. PARAM ] If asterisk is specified as index then all values are
-       affected. The index 1 correxponds to the first header.
+       affected. The index 1 corresponds to the first header.
 
    Example 1.10. remove_hf_value usage
 ...
@@ -379,7 +379,7 @@ remove_hf_value("foo[*].bar") # for each foo delete bar parameters
    Meaning of the parameters is as follows:
      * hf_par - Header/param to be removed. Format: HFNAME [ [IDX] ] [.
        PARAM ] If asterisk is specified as index then all values are
-       affected. The index 1 correxponds to the first header.
+       affected. The index 1 corresponds to the first header.
 
    Example 1.11. remove_hf_value2 usage
 ...
@@ -398,7 +398,7 @@ remove_hf_value2("foo[*].bar") # for each foo delete bar parameters
    Meaning of the parameters is as follows:
      * hf_para - Header field value / param to be appended. Format: HFNAME
        [ [IDX] ] [. PARAM] If asterisk is specified as index then all
-       values are affected. The index 1 correxponds to the first header.
+       values are affected. The index 1 corresponds to the first header.
      * hvalue - Value to be assigned, config var formatting supported. If
        value is empty then no equal sign appears in param.
 
@@ -422,7 +422,7 @@ assign_hf_value("foo[*].bar", "")  # set empty value (ex. lr)
    Meaning of the parameters is as follows:
      * hf_para - Header field value / param to be appended. Format: HFNAME
        [ [IDX] ] [. PARAM] If asterisk is specified as index then all
-       values are affected. The index 1 correxponds to the first header.
+       values are affected. The index 1 corresponds to the first header.
      * hvalue - Value to be assigned, config var formatting supported. If
        value is empty then no equal sign appears in param.