Forráskód Böngészése

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

Kamailio Dev 2 éve
szülő
commit
877f1b47fd
54 módosított fájl, 130 hozzáadás és 130 törlés
  1. 2 2
      src/modules/acc/README
  2. 6 6
      src/modules/app_perl/README
  3. 1 1
      src/modules/async/README
  4. 6 6
      src/modules/auth/README
  5. 11 11
      src/modules/auth_db/README
  6. 7 7
      src/modules/auth_radius/README
  7. 1 1
      src/modules/call_obj/README
  8. 7 8
      src/modules/carrierroute/README
  9. 2 2
      src/modules/cdp/README
  10. 1 1
      src/modules/cfgutils/README
  11. 3 3
      src/modules/crypto/README
  12. 1 1
      src/modules/ctl/README
  13. 2 2
      src/modules/db_cassandra/README
  14. 1 1
      src/modules/db_mysql/README
  15. 1 1
      src/modules/debugger/README
  16. 4 4
      src/modules/dialog/README
  17. 1 1
      src/modules/dialplan/README
  18. 2 2
      src/modules/dispatcher/README
  19. 3 3
      src/modules/drouting/README
  20. 3 3
      src/modules/erlang/README
  21. 1 1
      src/modules/gzcompress/README
  22. 1 1
      src/modules/h350/README
  23. 1 1
      src/modules/http_client/README
  24. 1 1
      src/modules/ims_auth/README
  25. 2 2
      src/modules/ims_charging/README
  26. 3 3
      src/modules/ims_dialog/README
  27. 5 5
      src/modules/ims_qos/README
  28. 1 1
      src/modules/kafka/README
  29. 1 1
      src/modules/mqtt/README
  30. 9 9
      src/modules/nat_traversal/README
  31. 1 1
      src/modules/ndb_cassandra/README
  32. 1 1
      src/modules/osp/README
  33. 1 1
      src/modules/pdt/README
  34. 2 2
      src/modules/peering/README
  35. 2 2
      src/modules/permissions/README
  36. 4 3
      src/modules/presence/README
  37. 1 1
      src/modules/pua/README
  38. 1 1
      src/modules/pua_dialoginfo/README
  39. 2 2
      src/modules/pv/README
  40. 1 1
      src/modules/rabbitmq/README
  41. 1 1
      src/modules/ratelimit/README
  42. 1 1
      src/modules/registrar/README
  43. 2 2
      src/modules/rtpengine/README
  44. 1 1
      src/modules/rtpproxy/README
  45. 1 1
      src/modules/seas/README
  46. 1 1
      src/modules/sipcapture/README
  47. 1 1
      src/modules/sipt/README
  48. 3 3
      src/modules/siputils/README
  49. 3 3
      src/modules/tls/README
  50. 1 1
      src/modules/tm/README
  51. 2 2
      src/modules/uac/README
  52. 2 2
      src/modules/userblocklist/README
  53. 4 4
      src/modules/usrloc/README
  54. 1 1
      src/modules/xcap_client/README

+ 2 - 2
src/modules/acc/README

@@ -582,8 +582,8 @@ Note
    it is necessary to store the caller and callee for each leg. All this
    helps to identify the involved phone partners and forwarding chain.
    When you route such calls multiple times to the same Proxy, you could
-   store the caller and callee within an transaction based avp and write
-   it into the dialog based dlg_var pv during a 200 INVITE.
+   store the caller and callee within a transaction based avp and write it
+   into the dialog based dlg_var pv during a 200 INVITE.
 
 4.3.2.1. Example for a spiraled Proxy
 

+ 6 - 6
src/modules/app_perl/README

@@ -686,9 +686,9 @@ Kamailio::log(L_INFO, "foobar");
    2.19. append_branch(branch,qval)
    2.20. getParsedRURI()
 
-   This package provides access functions for an Kamailio sip_msg
-   structure and its sub-components. Through its means it is possible to
-   fully configure alternative routing decisions.
+   This package provides access functions for a Kamailio sip_msg structure
+   and its sub-components. Through its means it is possible to fully
+   configure alternative routing decisions.
 
 2.1. getType()
 
@@ -927,7 +927,7 @@ if ($m->getRURI() =~ m/\@somedomain.net/) {
 
 2.20. getParsedRURI()
 
-   Returns the current destination URI as an Kamailio::URI object.
+   Returns the current destination URI as a Kamailio::URI object.
 
 3. Kamailio::URI
 
@@ -1052,7 +1052,7 @@ if ($m->getRURI() =~ m/\@somedomain.net/) {
 
    Add an AVP.
 
-   Add an Kamailio AVP to its environment. name and val may both be
+   Add a Kamailio AVP to its environment. name and val may both be
    integers or strings; this function will try to guess what is correct.
    Please note that
 Kamailio::AVP::add("10", "10")
@@ -1067,7 +1067,7 @@ Kamailio::AVP::add(10, 10)
 
 4.2. get(name)
 
-   get an Kamailio AVP:
+   get a Kamailio AVP:
 my $numavp = Kamailio::AVP::get(5);
 my $stravp = Kamailio::AVP::get("foo");
 

+ 1 - 1
src/modules/async/README

@@ -363,7 +363,7 @@ route[RESUME] {
 
 4.7.  async_task_data(routename, data)
 
-   Send the data to a asynchronous task process (in the first group) that
+   Send the data to an asynchronous task process (in the first group) that
    executes the route[rountename] and makes the data available via
    $async(data).
 

+ 6 - 6
src/modules/auth/README

@@ -728,9 +728,9 @@ if (has_credentials("myrealm")) {
    parameter force_stateless_reply regarding sending of the reply.
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use.
-       Usually this is domain of the host the server is running on.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. Usually this is domain of the host the server is running on.
        It must not be empty string “”. In case of REGISTER requests, the
        To header field domain (e.g., variable $td) can be used (because
        this header field represents the user being registered), for all
@@ -820,9 +820,9 @@ if (!auth_check("$fd", "subscriber", "1")) {
        a previous request
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use.
-       Usually this is domain of the host the server is running on.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. Usually this is domain of the host the server is running on.
        It must not be empty string “”. In case of REGISTER requests To
        header field domain (e.g., variable $td) can be used (because this
        header field represents a user being registered), for all other

+ 11 - 11
src/modules/auth_db/README

@@ -345,14 +345,14 @@ modparam("auth_db", "force_generate_avps", 1)
        header with the correct realm.
      * -6 (nonce reused) - the nonce has already been used to authenticate
        a previous request
-     * -8 (authuser mismatch) - depending on the method, th From/To/RURI
+     * -8 (authuser mismatch) - depending on the method, the From/To/RURI
        user does not match the authentication user (see auth_check()
        function).
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use.
-       Usually this is domain of the host the server is running on.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. Usually this is domain of the host the server is running on.
        It must not be empty string “”. In case of REGISTER requests To
        header field domain (e.g., variable $td) can be used (because this
        header field represents the user being registered), for all other
@@ -392,9 +392,9 @@ if (!www_authorize("kamailio.org", "subscriber")) {
    Negative return codes have the same meaning as for www_authenticate().
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use.
-       Usually this is domain of the host the server is running on.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. Usually this is domain of the host the server is running on.
        It must not be empty string “”. Apart of a static string, typical
        value is From header field domain (e.g., variable $fd).
        If an empty string “” is used then the server will generate it from
@@ -431,9 +431,9 @@ if (!proxy_authorize("$fd", "subscriber)) {
    Negative return codes have the same meaning as for www_authenticate().
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use.
-       Usually this is domain of the host the server is running on.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. Usually this is domain of the host the server is running on.
        It must not be empty string “”. Apart of a static string, typical
        value is From header field domain (e.g., variable $fd).
        The string may contain pseudo variables.
@@ -472,7 +472,7 @@ if (!auth_check("$fd", "subscriber", "1")) {
    authentication functions.
 
    In addition, if the subscriber record is found, then the
-   load_credentials attributes are loaded. An use case can be loading the
+   load_credentials attributes are loaded. A use case can be loading the
    credential attributes for callee.
 
    Meaning of the parameters is as follows:

+ 7 - 7
src/modules/auth_radius/README

@@ -276,9 +276,9 @@ modparam("auth_radius", "append_realm_to_username", 0)
    credentials and return whether they are valid or not.
 
    Meaning of the parameter is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use. In
-       case of REGISTER requests it is usually hostpart of To URI.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. In case of REGISTER requests it is usually hostpart of To URI.
        The string may contain pseudo variables.
      * uri_user - Uri_user is an optional pseudo variable parameter whose
        value, if present, will be given to Radius server as value of
@@ -327,10 +327,10 @@ modparam("auth_radius", "append_realm_to_username", 0)
    credentials and return whether they are valid or not.
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent should present
-       to the user so he can decide what username and password to use. In
-       case of non-REGISTER requests it is usually hostpart of From or
-       P-Preferred-Identity URI.
+     * realm - Realm is an opaque string that the user agent should
+       present to the user so he can decide what username and password to
+       use. In case of non-REGISTER requests it is usually hostpart of
+       From or P-Preferred-Identity URI.
        The string may contain pseudo variables.
      * uri_user - Uri_user is an optional pseudo variable parameter whose
        value, if present, will be given to Radius server as value of

+ 1 - 1
src/modules/call_obj/README

@@ -84,7 +84,7 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module provides a way to identify calls using a increasing
+   This module provides a way to identify calls using an increasing
    sequence of integers.
 
    It starts assigning an integer to a call. Next call gets next free

+ 7 - 8
src/modules/carrierroute/README

@@ -219,7 +219,7 @@ Chapter 1. Admin Guide
 
    The module provides routing, balancing and blocklisting capabilities.
    It reads routing entries from a database source or from a config file
-   at Kamailio startup. It can uses one routing tree (for one carrier), or
+   at Kamailio startup. It can use one routing tree (for one carrier), or
    if needed for every user a different routing tree (unique for each
    carrier) for number prefix based routing. It supports several route
    tree domains, e.g. for fallback routes or different routing rules for
@@ -243,7 +243,7 @@ Chapter 1. Admin Guide
    Routing tables can be reloaded and edited (in config file mode) with
    the RPC interface, the config file is updated according the changes.
    This is not implemented for the db interface, because its easier to do
-   the changes directly on the db. But the reload and dump functions works
+   the changes directly on the db. But the reload and dump functions work
    of course here too.
 
    Some module functionality is not fully available in the config file
@@ -262,7 +262,7 @@ Chapter 1. Admin Guide
    data structures. So from a performance point of view it is better to
    pass only IDs in AVPs to the routing functions.
 
-   Basically this module could be used as an replacement for the lcr and
+   Basically this module could be used as a replacement for the lcr and
    the dispatcher module, if you have certain flexibility, integration
    and/or performance requirements that can't be satisfied with these
    modules. But for smaller installations it probably make more sense to
@@ -825,15 +825,14 @@ failure_route[1] {
    Example 1.16. Configuration example - module configuration
 
    The following config file specifies within the default carrier two
-   domains, each with an prefix that contains two hosts. It is not
-   possible to specify another carrier if you use the config file as data
-   source.
+   domains, each with a prefix that contains two hosts. It is not possible
+   to specify another carrier if you use the config file as data source.
 
    All traffic will be equally distributed between the hosts, both are
    active. The hash algorithm will working over the [1,2] set, messages
    hashed to one will go to the first host, the other to the second one.
    Don't use a hash index value of zero. If you omit the hash completely,
-   the module gives them a autogenerated value, starting from one.
+   the module gives them an autogenerated value, starting from one.
 
    Use the “NULL” prefix to specify an empty prefix in the config file.
    Please note that the prefix is matched against the request URI (or to
@@ -930,7 +929,7 @@ domain register {
    and a default route for other prefixes over carrier 2 and carrier 1.
    The gateways for the default carrier will be used for functions that
    don't support the user specific carrier lookup. The routing rules for
-   carrier 1 and carrier 2 for the “49” prefix contains a additional rule
+   carrier 1 and carrier 2 for the “49” prefix contains an additional rule
    with the domain 2, that can be used for example as fallback if the
    gateways in domain 1 are not reachable. Two more fallback rules (domain
    3 and 4) for carrier 1 are also supplied to support the functionality

+ 2 - 2
src/modules/cdp/README

@@ -799,7 +799,7 @@ is_statefull,AAASessionCallback_f *cb,void *generic_data)
 
 1.18. AAADropAuthSession(AAASession *s)
 
-   Deallocates the memory taken by a Authorisation session
+   Deallocates the memory taken by an Authorisation session
 
    Meaning of the parameters is as follows:
      * AAASession *s - Session to drop and deallocate memory for
@@ -814,7 +814,7 @@ is_statefull,AAASessionCallback_f *cb,void *generic_data)
 1.20. AAATransaction* AAACreateTransaction(AAAApplicationId
 app_id,AAACommandCode cmd_code)
 
-   Create a AAATransaction for the given request
+   Create an AAATransaction for the given request
 
    Meaning of the parameters is as follows:
      * AAAApplicationId app_id - ID of the request's application

+ 1 - 1
src/modules/cfgutils/README

@@ -199,7 +199,7 @@ Chapter 1. Admin Guide
    “set_prob”, “reset_prob” and “get_prob”.
 
    This module can be used for simple load-shedding, e.g. reply 5% of the
-   Invites with a 503 error and a adequate random Retry-After value.
+   Invites with a 503 error and an adequate random Retry-After value.
 
    The module provides as well functions to delay the execution of the
    server. The functions “sleep” and “usleep” could be used to let the

+ 3 - 3
src/modules/crypto/README

@@ -143,7 +143,7 @@ Chapter 1. Admin Guide
 
    The salt is a binary array that is appended to the encryption password
    for better protection against dictionary attacks. Same salt and
-   password need to be when encrypting and decrypting.
+   password need to be used when encrypting and decrypting.
 
    Default value is "..." (see code).
 
@@ -184,8 +184,8 @@ modparam("crypto", "register_evcb", 1)
 
 3.4. kevcb_netio (str)
 
-   Name of the KEMI callbac functio for netio events. It receives a string
-   parameter with event route name.
+   Name of the KEMI callback function for netio events. It receives a
+   string parameter with event route name.
 
    Default value is not set.
 

+ 1 - 1
src/modules/ctl/README

@@ -143,7 +143,7 @@ $ kamcmd ps
 
    If the protocol part is missing and the address/path part looks like a
    file system path it will default to a Unix stream socket and if not to
-   an Unix UDP socket. Examples:
+   a Unix UDP socket. Examples:
      * "/tmp/unix_test" - equivalent to "unixs:/tmp/unix_test".
      * "localhost:3000" - equivalent to "udp:localhost:3000".
 

+ 2 - 2
src/modules/db_cassandra/README

@@ -127,7 +127,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type';
    script by means of the AVPOPS module. Keep in mind that when passing
    back the results from the database only the first row is used to set
    the AVP variables. (default AVPOPS behaviour) The script lines below
-   can be used as an example for issuing the query towards an cassandra
+   can be used as an example for issuing the query towards a cassandra
    instance.(This example will work once the column family `location` is
    configured correctly in the cassandra keyspace)
    ...
@@ -284,7 +284,7 @@ tance(string) reg_id(int)
    ...
 
    The alternative would have been to define an index on the expire column
-   and run a external job to periodically delete the expired records.
+   and run an external job to periodically delete the expired records.
    However, obviously, this would be more costly.
 
 7. Limitations

+ 1 - 1
src/modules/db_mysql/README

@@ -133,7 +133,7 @@ modparam("db_mysql", "server_timezone", 1)
 
 3.3. timeout_interval (integer)
 
-   Time interval (in seconds) after that an connection attempt, read or
+   Time interval (in seconds) after that a connection attempt, read or
    write request is aborted. The value counts three times, as several
    retries are done from the driver before it gives up.
 

+ 1 - 1
src/modules/debugger/README

@@ -151,7 +151,7 @@ Chapter 1. Admin Guide
    (e.g., XMLRPC, kamcmd, siremis).
 
    The framework to set breakpoints on specific actions and config lines
-   is not exported to RPC. Each action can be accompanied by an breakpoint
+   is not exported to RPC. Each action can be accompanied by a breakpoint
    or you can use dbg_breakpoint() function to set a breakpoint at certain
    line. Global breakpoints can be enabled/disabled at runtime. The script
    running trace can also be enabled/disabled at runtime.

+ 4 - 4
src/modules/dialog/README

@@ -461,14 +461,14 @@ Chapter 1. Admin Guide
    common application discussed for illustrative purposes; there are many
    others.
 
-   The dialog module provides dialog awareness for the Kamailio proxy.
-   It's functionality is to keep track of the current dialogs, to offer
+   The dialog module provides dialog awareness for the Kamailio proxy. Its
+   functionality is to keep track of the current dialogs, to offer
    information about them (e.g. how many dialogs are active), and to
    manage various characteristics of dialogs. The module exports several
    functions that can be used directly from the configuration route script
    as well as functions for the RPC interface.
 
-   This module also provides a API foundation on which to build more
+   This module also provides an API foundation on which to build more
    complex dialog-oriented functionality in other Kamailio modules.
 
 2. How it works
@@ -1618,7 +1618,7 @@ unset_dlg_profile("caller","$fu");
    Example 1.70. is_in_profile usage
 ...
 if (is_in_profile("inbound_call")) {
-        log("this request belongs to a inbound call\n");
+        log("this request belongs to an inbound call\n");
 }
 ...
 if (is_in_profile("caller","XX")) {

+ 1 - 1
src/modules/dialplan/README

@@ -501,7 +501,7 @@ xlog("the attributes associated with '+49$rU' are '$var(attrs)'\n");
             with the value of the output string.
           + script var
             - At input the function will get the input string from an
-            existing script variable. At output the function will set an
+            existing script variable. At output the function will set a
             script variable with the value of the output string.
 
    This function can be used from ANY_ROUTE.

+ 2 - 2
src/modules/dispatcher/README

@@ -2099,7 +2099,7 @@ route[WITHINDLG] {
                 return;
         }
 
-        # sequential request withing a dialog should
+        # sequential request within a dialog should
         # take the path determined by record-routing
         if (loose_route()) {
                 if (is_method("BYE")) {
@@ -2259,7 +2259,7 @@ Chapter 2. Frequently Asked Questions
 
    E-mails regarding any stable version should be sent to
    <[email protected]> and e-mail regarding development versions
-   or GIT snapshots should be send to <[email protected]>.
+   or GIT snapshots should be sent to <[email protected]>.
 
    2.5.
 

+ 3 - 3
src/modules/drouting/README

@@ -466,7 +466,7 @@ Chapter 1. Admin Guide
        gateway is added to the request URI and then the request is
        forwarded.
 
-   If no rule is found to match the selection criteria an default action
+   If no rule is found to match the selection criteria a default action
    must be taken (e.g., error response sent back). If the gateway in the
    chain has no prefix the request is forwarded without adding any prefix
    to the request URI.
@@ -551,8 +551,8 @@ modparam("drouting", "drg_table", "groups")
 3.5. drl_table(str)
 
    The name of the db table storing definitions of destination lists (to
-   be used directly by the routing rules). You will have a identifier to a
-   group of gateways instead of having all the members of the group as a
+   be used directly by the routing rules). You will have an identifier to
+   a group of gateways instead of having all the members of the group as
    individual elements. Very useful to reuse a list of gateways in
    different places.
 

+ 3 - 3
src/modules/erlang/README

@@ -225,9 +225,9 @@ modparam("erlang", "cnode_host", "kamailio.lan")
 
 3.4. erlang_nodename (str)
 
-   The format of the node name is an name@host where name is the name
-   given by the user and host is the full host name if long names are
-   used, or the first part of the host name if short names are used.
+   The format of the node name is a name@host where name is the name given
+   by the user and host is the full host name if long names are used, or
+   the first part of the host name if short names are used.
 
    Example 1.4. Set erlang_nodename parameter
 ...

+ 1 - 1
src/modules/gzcompress/README

@@ -91,7 +91,7 @@ Chapter 1. Admin Guide
    smaller than the original size (e.g., a body of 431 bytes was
    compressed to 230).
 
-   An use case can be when having peering traffic between two Kamailio
+   A use case can be when having peering traffic between two Kamailio
    servers. Before relaying to the other Kamailio, use in config file:
    append_hf("Content-Encoding: deflate\r\n").
 

+ 1 - 1
src/modules/h350/README

@@ -83,7 +83,7 @@ Chapter 1. Admin Guide
 
    1.1. Example H.350 commObject LDAP Entry
 
-   The Kamailio H350 module enables an Kamailio SIP proxy server to access
+   The Kamailio H350 module enables a Kamailio SIP proxy server to access
    SIP account data stored in an LDAP [RFC4510] directory containing H.350
    [H.350] commObjects. ITU-T Recommendation H.350 standardizes LDAP
    object classes to store Real-Time Communication (RTC) account data. In

+ 1 - 1
src/modules/http_client/README

@@ -635,7 +635,7 @@ tstuff;timeout=12;failover=apione")
    Kamailio main config file.
 
    To set a string value to null, in order to override default settings,
-   you can specify an value of "" - two quotation marks. In order to
+   you can specify a value of "" - two quotation marks. In order to
    disable a http proxy setting you can set the port to zero.
 
    Example 1.19. Set config_file parameter

+ 1 - 1
src/modules/ims_auth/README

@@ -215,7 +215,7 @@ modparam("ims_auth", "auth_vector_timeout", "domain")
 
 3.4. auth_data_timeout (int)
 
-   Time, in seconds, an used auth vector is valid for.
+   Time, in seconds, a used auth vector is valid for.
 
    Default value is “60”.
 

+ 2 - 2
src/modules/ims_charging/README

@@ -203,7 +203,7 @@ Chapter 1. Admin Guide
 1. Overview
 
    This module contains all methods related to the IMS charging control
-   functions performed by an network element (e.g. a S-CSCF) over the Ro
+   functions performed by a network element (e.g. a S-CSCF) over the Ro
    interface. This module is dependent on the CDP (C Diameter Peer)
    modules for communicating with a Charging-Server as specified in 3GPP
    specification TS xx.xxx.
@@ -907,7 +907,7 @@ n");
 
 6.12. CCRs requests, which ended with a timeout (ccr_timeouts)
 
-   Number of CCR-Requests, which ran into an timeout.
+   Number of CCR-Requests, which ran into a timeout.
 
 6.13. Billed seconds (billed_secs)
 

+ 3 - 3
src/modules/ims_dialog/README

@@ -571,7 +571,7 @@ unset_dlg_profile("caller","$fu");
    Example 1.13.  is_in_profile usage
 ...
 if (is_in_profile("inbound_call")) {
-        log("this request belongs to a inbound call\n");
+        log("this request belongs to an inbound call\n");
 }
 ...
 if (is_in_profile("caller","XX")) {
@@ -1040,7 +1040,7 @@ Chapter 2. Developer Guide
 Chapter 3. Frequently Asked Questions
 
    3.1. What happened with “use_tight_match” parameter?
-   3.2. Why is there a ims_dialog module and a dialog module?
+   3.2. Why is there an ims_dialog module and a dialog module?
    3.3. Where can I find more about Kamailio?
    3.4. Where can I post a question about this module?
    3.5. How can I report a bug?
@@ -1055,7 +1055,7 @@ Chapter 3. Frequently Asked Questions
 
    3.2.
 
-   Why is there a ims_dialog module and a dialog module?
+   Why is there an ims_dialog module and a dialog module?
 
    The ims_dialog module addresses shortcomings in the initial dialog
    module design. It makes some large changes to the API and therefore

+ 5 - 5
src/modules/ims_qos/README

@@ -335,7 +335,7 @@ modparam("ims_qos", "video_default_bandwidth", 256)
    This sets the default Reason, when a call is terminated in early stage
    due to QoS-failure.
 
-   Default value is "QoS released", an call in early stage would be
+   Default value is "QoS released", a call in early stage would be
    released with "488 QoS released".
 
    Example 1.11. early_qosrelease_reason parameter usage
@@ -345,7 +345,7 @@ modparam("ims_qos", "early_qosrelease_reason", "Sorry - QoS failed")
 
 3.12. confirmed_qosrelease_headers (String)
 
-   These headers are added to the BYE-Message, when an confirmed call is
+   These headers are added to the BYE-Message, when a confirmed call is
    terminated due to a QoS failure.
 
    Default value is "", no Extra-Headers
@@ -500,7 +500,7 @@ modparam("ims_qos", "rr_default_bandwidth", 2000)
 
 4.1. Rx_AAR_Register(route_block, domain)
 
-   Perform a AAR on Diameter RX interface to subscribe to signalling
+   Perform an AAR on Diameter RX interface to subscribe to signalling
    status. This purpose of this is tell a Diameter server (typically a
    PCRF) to inform the requesting Diameter client on changes to the status
    of signalling bearer for the same framed IP address. For more details
@@ -545,7 +545,7 @@ route[REG_AAR_REPLY]
 
 4.2. Rx_AAR(route_block, direction, subscription_id, subscription_id_type)
 
-   Perform a AAR on Diameter RX interface to request resource
+   Perform an AAR on Diameter RX interface to request resource
    authorisation from a Diameter server (typically a PCRF). For more
    details see 3GGP TS 29.214.
 
@@ -588,7 +588,7 @@ route[ORIGN_SESSION_AAR_REPLY]
 
 5.1. AAR Timeouts (aar_timeouts)
 
-   The number of timeouts on sending a AAR. i.e. no response to AAR.
+   The number of timeouts on sending an AAR. i.e. no response to AAR.
 
 5.2. Average AAR Response Time (aar_avg_response_time)
 

+ 1 - 1
src/modules/kafka/README

@@ -174,7 +174,7 @@ ue.buffering.max.messages=500000;debug=all;metadata.request.timeout.ms=900000")
    Each topic property is a list of attribute = value separated by
    semicolon.
 
-   name atribute indicates the topic name. It is mandatory. Other
+   name attribute indicates the topic name. It is mandatory. Other
    attributes mean names of properties and are optional.
 
    This parameter is optional. Each topic needs a topic parameter so

+ 1 - 1
src/modules/mqtt/README

@@ -454,7 +454,7 @@ mqtt_publish("kamailio/event", "some message", 0);
 
 5.1.  mqtt:connected
 
-   If defined, the module calls event_route[mqtt:connected] when a
+   If defined, the module calls event_route[mqtt:connected] when an
    outgoing broker connection is established.
 
    MQTT subscriptions are not durable, so you should use this event route

+ 9 - 9
src/modules/nat_traversal/README

@@ -158,7 +158,7 @@ Chapter 1. Admin Guide
    cases, including distributed environments with multiple proxies. Unlike
    existing keepalive solutions that only send keepalive messages to user
    agents that have registered (during their registration), the
-   nat_traversal module can keepalive an user agent based on multiple
+   nat_traversal module can keepalive a user agent based on multiple
    conditions, making it not only more flexible and more efficient, but
    also able to work in environments and with use cases where a simple
    keepalive implementation based on keeping alive registrations alone
@@ -198,7 +198,7 @@ Chapter 1. Admin Guide
    keepalive implementation based on sending keepalive messages only to
    registered user agents, will also fail to work in common cases, exactly
    because of this artificial association. For example lets assume that we
-   have an user agent that is registered. If during an outgoing call
+   have a user agent that is registered. If during an outgoing call
    initiated by this user agent, the agent stops registering, then it will
    not be able to receive further in-dialog messages after the NAT binding
    expires. The same is true for a presence agent, receiving notifications
@@ -284,13 +284,13 @@ Chapter 1. Admin Guide
    detects from the stateless replies or the TM relayed replies if the NAT
    endpoint needs to be kept alive for the condition triggered by the
    request for which the nat_keepalive() function was called. For example
-   assume a network where a proxy P1 receives a REGISTER from an user
-   agent behind NAT. P1 will determine that the user agent is behind NAT
-   so it needs keepalive functionality, but another proxy called P2 is
-   actually handling the subscriber registrations. In this case P1 has to
-   call nat_keepalive() even though it doesn't yet know the answer P2 will
-   give to the REGISTER request (which may even be a negative reply) or if
-   P2 will restrict the proposed expiration time in any way. Thus P1 calls
+   assume a network where a proxy P1 receives a REGISTER from a user agent
+   behind NAT. P1 will determine that the user agent is behind NAT so it
+   needs keepalive functionality, but another proxy called P2 is actually
+   handling the subscriber registrations. In this case P1 has to call
+   nat_keepalive() even though it doesn't yet know the answer P2 will give
+   to the REGISTER request (which may even be a negative reply) or if P2
+   will restrict the proposed expiration time in any way. Thus P1 calls
    nat_keepalive() after which it calls t_relay(). When the reply from P2
    arrives, a callback is triggered which will determine if the request
    did get a positive reply, and if so it will extract the registration

+ 1 - 1
src/modules/ndb_cassandra/README

@@ -124,7 +124,7 @@ modparam("ndb_cassandra", "port", 9160)
    keyspace. There must be an existing keyspace called 'keyspace' with a
    column_family called 'column_family' in the targeted Cassandra node.
 
-   value will be returned as well as a integer return code.
+   value will be returned as well as an integer return code.
 
    Return integer needs to be checked:
      * ret < 0, error

+ 1 - 1
src/modules/osp/README

@@ -556,7 +556,7 @@ if (prepareallosproute()) {
    message contains an OSP cookie, the function will forward originating
    and/or terminating duration usage information to a peering server. The
    function returns TRUE if the BYE includes an OSP cookie. The actual
-   usage message will be send on a different thread and will not delay BYE
+   usage message will be sent on a different thread and will not delay BYE
    processing. The function should be called before relaying the message.
 
    Meaning of the parameter is as follows:

+ 1 - 1
src/modules/pdt/README

@@ -291,7 +291,7 @@ modparam("pdt", "check_domain", 0)
    it does not match the prefix parameter or there is no domain associated
    with a possible prefix from user part). Returns -1 in error cases.
 
-   The translation is done based on lookup up for a entry in the database
+   The translation is done based on lookup up for an entry in the database
    where the sdomain equals the domain in FROM uri, and the prefix matches
    the beginning of the user part of the RURI. If such an entry is found,
    then the domain in RURI is updated with the domain of this entry

+ 2 - 2
src/modules/peering/README

@@ -170,7 +170,7 @@ modparam("peering", "verify_source_service_type", 22)
 
    [#]name(:|#)value
 
-   Value of each SIP-AVP reply attribute is mapped to an Kamailio AVP.
+   Value of each SIP-AVP reply attribute is mapped to a Kamailio AVP.
    Prefix # in front of name or value indicates a string name or string
    value, respectively.
 
@@ -211,7 +211,7 @@ if (verify_destination()) {
 
    [#]name(:|#)value
 
-   Value of each SIP-AVP reply attribute is mapped to an Kamailio AVP.
+   Value of each SIP-AVP reply attribute is mapped to a Kamailio AVP.
    Prefix # in front of name or value indicates a string name or string
    value, respectively.
 

+ 2 - 2
src/modules/permissions/README

@@ -275,8 +275,8 @@ Chapter 1. Admin Guide
    created.
 
    Instead of the From header field the function uses the To header field
-   because th To header field in REGISTER messages contains the URI of the
-   person being registered. Instead of the Request-URI of branches the
+   because the To header field in REGISTER messages contains the URI of
+   the person being registered. Instead of the Request-URI of branches the
    function uses the Contact header field.
 
    Thus, the pairs used in matching will look like this: (To, Contact 1),

+ 4 - 3
src/modules/presence/README

@@ -543,7 +543,8 @@ modparam("presence", "min_expires", 1800)
 
 3.16. min_expires_action (int)
 
-   The action to take when UA sends a expires value less then min_expires.
+   The action to take when UA sends an expires value less then
+   min_expires.
 
    Possible Values
      * 1 : RFC Compliant, returns “423 Interval Too Brief”
@@ -665,7 +666,7 @@ modparam("presence", "pres_htable_size", 11)
    This parameter enables or disables the sending of an initial empty
    NOTIFY after a SUBSCRIBE/reSUBSCRIBE. This caused problems for MWI
    application, because some CPEs (like Samsung) fail to understand an
-   empty NOTIFY to an message-summary event. This parameter is enabled by
+   empty NOTIFY to a message-summary event. This parameter is enabled by
    default, thus adhering to the standard.
 
    Default value is “1 ”.
@@ -718,7 +719,7 @@ modparam("presence", "fetch_rows", 1000)
 
 3.26. db_table_lock_type (integer)
 
-   Enable (=1) or disable (=0) the Locks for table during an transaction.
+   Enable (=1) or disable (=0) the Locks for table during a transaction.
    Locking only the "current" table causes problems with a MySQL-Databases
    in "DB-Only" mode.
 

+ 1 - 1
src/modules/pua/README

@@ -308,7 +308,7 @@ modparam("pua", "db_mode", 0)
 
 3.11. db_table_lock_write (integer)
 
-   Enable (=1) or disable (=0) the Locks for table during an transaction.
+   Enable (=1) or disable (=0) the Locks for table during a transaction.
    Locking only the "current" table causes problems with a MySQL-Databases
    in "DB-Only" mode.
 

+ 1 - 1
src/modules/pua_dialoginfo/README

@@ -147,7 +147,7 @@ Chapter 1. Admin Guide
    The module is based on code (copy/paste) from pua_usrloc and
    nat_traversal module.
 
-   Following you will show some examples of an dialog-info XML document
+   Following you will show some examples of a dialog-info XML document
    taken from RFC 4235. This will help you to understand the meaning of
    the module parameters:
 <?xml version="1.0"?>

+ 2 - 2
src/modules/pv/README

@@ -441,7 +441,7 @@ xinfo("AFTER $xavp(d[2]=>x) == [d-2-x] $xavp(d[2]=>y) == [d-2-y]\n");
 
 4.8.  xavp_params_explode(sparams, xname)
 
-   Convert a parameters string in xavp atributes.
+   Convert a parameters string in xavp attributes.
 
    The first parameter has to be a string in the format of SIP header
    parameters (name1=value1;...;nameN=valueN). The second parameter is the
@@ -485,7 +485,7 @@ xavp_params_implode("x", "$var(out)");
 
 4.10.  xavu_params_explode(sparams, xname)
 
-   Convert a parameters string in xavu atributes.
+   Convert a parameters string in xavu attributes.
 
    The first parameter has to be a string in the format of SIP header
    parameters (name1=value1;...;nameN=valueN). The second parameter is the

+ 1 - 1
src/modules/rabbitmq/README

@@ -76,7 +76,7 @@ Chapter 1. Admin Guide
 
    This module offers amqp communication using librabbitmq. This module
    was created using rabbitmq-c C client
-   (https://github.com/alanxz/rabbitmq-c). An new amqp connection is setup
+   (https://github.com/alanxz/rabbitmq-c). A new amqp connection is setup
    on a per-children basis, when Kamailio starts. If connection is lost,
    the process tries to re-establish it when a new amqp action is
    required.

+ 1 - 1
src/modules/ratelimit/README

@@ -135,7 +135,7 @@ Chapter 1. Admin Guide
 
    Limiting the rate messages are processed on a system directly
    influences the load. The ratelimit module can be used to protect a
-   single host or to protect an Kamailio cluster when run on the
+   single host or to protect a Kamailio cluster when run on the
    dispatching box in front.
 
    A sample configuration snippet might look like this:

+ 1 - 1
src/modules/registrar/README

@@ -1222,7 +1222,7 @@ add_sock_hdr("Sock-Info");
      * uri - The SIP URI address of the user which to remove the contact
        addresses for. It can contain pseudo-variables that are evaluated
        at runtime.
-     * ruid - The record unique ID for a a specific contact to be removed.
+     * ruid - The record unique ID for a specific contact to be removed.
        It can contain pseudo-variables that are evaluated at runtime.
 
    This function can be used from ANY_ROUTE.

+ 2 - 2
src/modules/rtpengine/README

@@ -754,7 +754,7 @@ modparam("rtpengine", "setid_avp", "$avp(setid)")
    be sent from the specified local interface. Both IPv4 and IPv6
    addresses are supported. If not specified, the default interface
    selected by the operating system will be used. Note: when
-   rtpengine_sock is a IPv6 link-local address, one _must_ set this
+   rtpengine_sock is an IPv6 link-local address, one _must_ set this
    parameter in order to successfully connect to RTP engine. This is
    necessarily because OS needs additional scope_id hint to communicate
    over IPv6 link locals. The scope_id is resolved based on the given
@@ -2780,7 +2780,7 @@ $ kamcmd rtpengine.reload
    recheck_ticks are grater than 0, the proxy is considered disabled
    temporary, and it is not taken into consideration for sending data.
    When the recheck_ticks are 0, the proxy is retested when trying to send
-   data (not automatically retested), and data can be send to it on
+   data (not automatically retested), and data can be sent to it on
    success.
 
    NOTE: If you specify an IPv6 RTP, the proxy url must be prefixed with

+ 1 - 1
src/modules/rtpproxy/README

@@ -489,7 +489,7 @@ rtpproxy_offer();
           + x - this flag a shortcut for using the "ie" or "ei"-flags of
             RTP-Proxy, in order to do automatic bridging between IPv4 on
             the "internal network" and IPv6 on the "external network". The
-            distinction is done by the given IP in the SDP, e.g. a IPv4
+            distinction is done by the given IP in the SDP, e.g. an IPv4
             Address will always call "ie" to the RTPProxy (IPv4(i) to
             IPv6(e)) and an IPv6Address will always call "ei" to the
             RTPProxy (IPv6(e) to IPv4(i)).

+ 1 - 1
src/modules/seas/README

@@ -1359,7 +1359,7 @@ Chapter 2. Developer Guide
    all the Route Headers were requested by the application, then a lookup
    in this table would be necessary, looking for the value '9'
    (corresponding to the Route header) in each of the positions multiple
-   of 3 (0,3,6,9,12, etc). This can be done in a extremely fast and easy
+   of 3 (0,3,6,9,12, etc). This can be done in an extremely fast and easy
    way, as this snipped of pseudo code explains:
 
    for(int j=0,int i=0;i<table_length;i+=3){

+ 1 - 1
src/modules/sipcapture/README

@@ -347,7 +347,7 @@ modparam("sipcapture", "raw_moni_capture_on", 1)
 
 3.11. raw_socket_listen (string)
 
-   Parameter indicate an listen IP address of RAW socket for IPIP
+   Parameter indicate a listen IP address of RAW socket for IPIP
    capturing. You can also define a port/portrange for IPIP/Mirroring
    mode, to capture SIP messages in specific ports:
 

+ 1 - 1
src/modules/sipt/README

@@ -213,7 +213,7 @@ sipt_forwarfing($avp(s:forwarding_number), 3);
 
 3.5. sipt_has_isup_body()
 
-   The function returns true if the SIP message has a ISUP body attached.
+   The function returns true if the SIP message has an ISUP body attached.
 
    Example 1.5. sipt_has_isup_body() usage
 ...

+ 3 - 3
src/modules/siputils/README

@@ -443,7 +443,7 @@ modparam("siputils", "e164_max_len", 20)
 4.1.  options_reply()
 
    This function checks if the request method is OPTIONS and if the
-   request URI does not contain an username. If both is true the request
+   request URI does not contain a username. If both is true the request
    will be answered stateless with “200 OK” and the capabilities from the
    modules parameters.
 
@@ -454,8 +454,8 @@ modparam("siputils", "e164_max_len", 20)
    because it is also done by the function itself. But you should not call
    this function outside the myself check because in this case the
    function could answer OPTIONS requests which are sent to you as
-   outbound proxy but with an other destination then your proxy (this
-   check is currently missing in the function).
+   outbound proxy but with another destination then your proxy (this check
+   is currently missing in the function).
 
    This function can be used from REQUEST_ROUTE.
 

+ 3 - 3
src/modules/tls/README

@@ -292,7 +292,7 @@ request_route {
 
    For OpenSSL (libssl) v1.1.x, it is required to preload
    'openssl_mutex_shared' library shipped by Kamailio. For more details
-   see 'src/modules/tls/openssl_mutex_shared/README.md'.
+   see 'src/modules/tls/utils/openssl_mutex_shared/README.md'.
 
    This module includes several workarounds for various Openssl bugs (like
    compression and Kerberos using the wrong memory allocations functions,
@@ -563,7 +563,7 @@ modparam("tls", "engine_config", "/usr/local/etc/kamailio/thales.cnf")
 modparam("tls", "engine_algorithms", "EC")
 ...
 
-/usr/local/etc/kamailio/thales.cnf is a OpenSSL config format file used to
+/usr/local/etc/kamailio/thales.cnf is an OpenSSL config format file used to
 bootstrap the engine, e.g., pass the PIN.
 
 ...
@@ -1507,7 +1507,7 @@ modparam("tls", "engine_algorithms", "ALL")
 
 10.35. engine_config (string)
 
-   A OpenSSL configuration file to initialize the engine. Typically used
+   An OpenSSL configuration file to initialize the engine. Typically used
    to send PIN to HSMs to unlock private keys. See the HSM howto for an
    example. This global param is not supported in the tls config file.
 

+ 1 - 1
src/modules/tm/README

@@ -3136,7 +3136,7 @@ reply_route {
 
 5.9.  tm.clean
 
-   Trigger an hard clean of expired transactions.
+   Trigger a hard clean of expired transactions.
 
    Parameters:
      * none

+ 2 - 2
src/modules/uac/README

@@ -430,7 +430,7 @@ modparam("uac","credential","username:domain:password")
 
 3.9. auth_realm_avp (string)
 
-   The definition of an PV that might contain the realm to be used to
+   The definition of a PV that might contain the realm to be used to
    perform authentication.
 
    When the PV value is an empty string or NULL when uac_auth() is called,
@@ -630,7 +630,7 @@ modparam("uac", "reg_use_domain", 1)
    entry.
 
    By default no default socket is defined, the send socket is choosen
-   from the “tm” module when the requests is send out.
+   from the “tm” module when the requests is sent out.
 
    If you want to force a certain TCP port (e.g. 5060), you will need to
    set the tcp_reuse_port=yes core parameter as well.

+ 2 - 2
src/modules/userblocklist/README

@@ -297,7 +297,7 @@ modparam("userblocklist", "userblocklist_prefix_col", "prefix")
 
 3.9. userblocklist_allowlist_col (string)
 
-   Specify if this a blocklist (0) or a allowlist (1) entry.
+   Specify if this is a blocklist (0) or an allowlist (1) entry.
 
    Example 1.9. Set userblocklist_allowlist_col parameter
 ...
@@ -337,7 +337,7 @@ modparam("userblocklist", "globalblocklist_prefix_col", "prefix")
 
 3.13. globalblocklist_allowlist_col (string)
 
-   Specify if this a blocklist (0) or a allowlist (1) entry.
+   Specify if this is a blocklist (0) or an allowlist (1) entry.
 
    Example 1.13. Set globalblocklist_allowlist_col parameter
 ...

+ 4 - 4
src/modules/usrloc/README

@@ -304,9 +304,9 @@ Chapter 1. Admin Guide
 
    1.1. Contact matching
 
-   The User location module module keeps a user location table and
-   provides access to the table for other modules. The module exports no
-   functions that can be used directly from routing scripts.
+   The User location module keeps a user location table and provides
+   access to the table for other modules. The module exports no functions
+   that can be used directly from routing scripts.
 
 1.1. Contact matching
 
@@ -1309,7 +1309,7 @@ modparam("usrloc", "db_clean_tcp", 1)
 
 4.6.  ul.add
 
-   Adds a new contact for an user AOR.
+   Adds a new contact for a user AOR.
 
    Parameters:
      * table name - table where the contact will be added (Ex: location).

+ 1 - 1
src/modules/xcap_client/README

@@ -88,7 +88,7 @@ Chapter 1. Admin Guide
    promise that the newest version will always be present in database.
 
    The update method is also configurable, either through periodical
-   queries, applicable to any kind of XCAP server or with an management
+   queries, applicable to any kind of XCAP server or with a management
    command that should be sent by the server upon an update.
 
    The module is currently used by the “presence_xml” module, if the