Bladeren bron

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

Kamailio Dev 2 jaren geleden
bovenliggende
commit
5a2df203a2

+ 1 - 1
src/modules/call_control/README

@@ -111,7 +111,7 @@ Chapter 1. Admin Guide
 
    Callcontrol is invoked by calling the call_control() function for the
    initial INVITE of every call we want to apply a limit to. This will end
-   up as a request to the callcontrol application, which will interogate
+   up as a request to the callcontrol application, which will interrogate
    the rating engine for a time limit for the given caller and
    destination. The rating engine will determine if the destination has
    any associated cost and if the caller has any credit limit and if so

+ 2 - 2
src/modules/cfgutils/README

@@ -230,8 +230,8 @@ Chapter 1. Admin Guide
 
 2. Dependencies
 
-   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):
      * none
 
 3. Parameters

+ 1 - 1
src/modules/janssonrpcc/README

@@ -167,7 +167,7 @@ modparam("janssonrpcc", "server", "conn=tests;srv=_test1._tcp.example.net");
 modparam("janssonrpcc", "server", "conn=tests;srv=_test2._tcp.example.net");
 modparam("janssonrpcc", "server", "conn=local;addr=localhost;port=8080;priority=
 10;weight=10");
-modparam("janssonrpcc", "server", "conn=user_db;addr=rpc.prod.exmaple.net;port=5
+modparam("janssonrpcc", "server", "conn=user_db;addr=rpc.prod.example.net;port=5
 060;priority=10;weight=10");
 ...
 

+ 1 - 1
src/modules/jsonrpcs/README

@@ -335,7 +335,7 @@ modparam("jsonrpcs", "dgram_user", "root")
 
 4.13. dgram_timeout (int)
 
-   The reply will expire after trying to sent it for socket_timeout
+   The reply will expire after trying to send it for socket_timeout
    milliseconds.
 
    Default value is 2000.

+ 3 - 3
src/modules/jwt/README

@@ -122,7 +122,7 @@ modparam("jwt", "key_mode", 1)
 
    The parameters are:
      * prvkey - path to private key
-     * alg - the algoritm to build the signature, as supported by the
+     * alg - the algorithm to build the signature, as supported by the
        libjwt (e.g., RS256, HS256, ES256, ...)
      * claims - the list of claims to be added to JWT, in the format
        "name1=value1;name2=value2;..." (same as the SIP parameters
@@ -151,7 +151,7 @@ modparam("jwt", "key_mode", 1)
 
    The parameters are:
      * pubkeypath - path to public key file
-     * alg - the algoritm to build the signature, as supported by the
+     * alg - the algorithm to build the signature, as supported by the
        libjwt (e.g., RS256, HS256, ES256, ...)
      * claims - the list of claims to be checked they are in the JWT, in
        the format "name1=value1;name2=value2;..." (same as the SIP
@@ -176,7 +176,7 @@ modparam("jwt", "key_mode", 1)
 
    The parameters are:
      * pubkeyval - public key value
-     * alg - the algoritm to build the signature, as supported by the
+     * alg - the algorithm to build the signature, as supported by the
        libjwt (e.g., RS256, HS256, ES256, ...)
      * claims - the list of claims to be checked they are in the JWT, in
        the format "name1=value1;name2=value2;..." (same as the SIP

+ 1 - 1
src/modules/kazoo/README

@@ -498,7 +498,7 @@ modparam("kazoo", "consume_messages_on_reconnect", 0)
 4.2.5. single_consumer_on_reconnect(int)
 
    When the main loop receives a message from rabbitmq it will defer the
-   execution to a worker in a round-robin manner. this parameter allows to
+   execution to a worker in a round-robin manner. This parameter allows to
    use the same worker when kazoo reconnects to rabbitmq.
 
    Default value is 1.

+ 6 - 6
src/modules/keepalive/README

@@ -178,7 +178,7 @@ modparam("keepalive", "destination", "sip.provider.com")
 
 2.3.3. delete_counter(int)
 
-   Unsuccessful attemps increase delete_counter. After passing it,
+   Unsuccessful attempts increase delete_counter. After passing it,
    keepalive module doesn't try to send options requests. Ignored if it's
    set to 0.
 
@@ -206,7 +206,7 @@ modparam("keepalive", "ping_from", "sip:[email protected]")
 
    Get destination status.
 
-   The Parameter destination is destination you want to check status
+   The parameter destination is destination you want to check status
 
    Returned value:
      * 1 if destination is up
@@ -230,10 +230,10 @@ if(ka_is_alive("192.168.10.20") == 1) {
    Meaning of the parameters:
      * sip_uri (string) - address of destination to monitor. Valid format
        is [protoschema:]ip[:port], with: 'protoschema' being one of 'sip'
-       or 'sips' (SIP over TLS) - if omitted, 'sip'is used by default;
+       or 'sips' (SIP over TLS) - if omitted, 'sip' is used by default;
        'port' is optional (using default standard port 5060 for sip and
        5061 for sips)
-     * owner (string) - module name “owning” the destination (for
+     * owner (string) - module name “owning” the destination (for
        informational purpose)
 
    Returned value:
@@ -260,10 +260,10 @@ ka_add_destination("sip:192.168.1.10:5060;transport=tcp", "config");
    Meaning of the parameters:
      * sip_uri (string) - address of monitored destination. Valid format
        is [protoschema:]ip[:port], with: 'protoschema' being one of 'sip'
-       or 'sips' (SIP over TLS) - if omitted, 'sip'is used by default;
+       or 'sips' (SIP over TLS) - if omitted, 'sip' is used by default;
        'port' is optional (using default standard port 5060 for sip and
        5061 for sips)
-     * owner (string) - module name “owning” the destination (for
+     * owner (string) - module name “owning” the destination (for
        informational purpose)
 
    Returned value:

+ 1 - 1
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
 

+ 6 - 6
src/modules/kex/README

@@ -230,7 +230,7 @@ setsflag("$var(flag)");
 
 3.2. issflagset(flag)
 
-   Return true of the script flag is set.
+   Return true if the script flag is set.
 
    Meaning of the parameters is as follows:
      * flag - the index of the script flag to be tested. Can be integer or
@@ -284,7 +284,7 @@ setbflag("$var(flag)", "1");
 
 3.5. isbflagset(flag [, branch])
 
-   Return true of the branch flag is set.
+   Return true if the branch flag is set.
 
    Meaning of the parameters is as follows:
      * flag - the index of the branch flag to be tested. Can be integer or
@@ -661,9 +661,9 @@ kamcmd core.modules
    Print the list of available internal statistics.
 
    NOTE: the result is an array of strings that have the list of
-   statistics formated like "name = value", being propagated over the time
-   from the MI variant. Use "stats.fetch" or "stats.fetchn"commands to
-   have a more JSON-friendly output.
+   statistics formatted like "name = value", being propagated over the
+   time from the MI variant. Use "stats.fetch" or "stats.fetchn"commands
+   to have a more JSON-friendly output.
 
    Parameters: statsid - which statistics to be printed. If set to 'all'
    then all statistics are printed; if set to 'statsgroup:' then all
@@ -681,7 +681,7 @@ kamcmd core.modules
    Print the list of available internal statistics with a more json
    friendly output. Each printed statistic is a field in the output
    structure: {"statsgroup.statsname" : "statsvalue"}. The value is
-   represented as string to accomodate large numbers.
+   represented as string to accommodate large numbers.
 
    Parameters: statsid - which statistics to be printed. If set to 'all'
    then all statistics are printed; if set to 'statsgroup:' then all