From 8868e624755c1d53fb7dac7140347eb375d3959c Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Wed, 28 Feb 2018 18:03:37 +0100 Subject: [PATCH] modules: readme files regenerated - acc ... [skip ci] --- src/modules/acc/README | 38 ++++++++++---------- src/modules/acc_diameter/README | 8 ++--- src/modules/acc_json/README | 8 ++--- src/modules/alias_db/README | 4 +-- src/modules/app_java/README | 14 ++++---- src/modules/app_jsdt/README | 4 +-- src/modules/app_lua/README | 2 +- src/modules/app_perl/README | 32 ++++++++--------- src/modules/app_python/README | 6 ++-- src/modules/app_python3/README | 6 ++-- src/modules/app_sqlang/README | 3 +- src/modules/auth/README | 10 +++--- src/modules/auth_db/README | 8 ++--- src/modules/auth_ephemeral/README | 2 +- src/modules/auth_radius/README | 14 ++++---- src/modules/auth_xkeys/README | 8 ++--- src/modules/avpops/README | 8 ++--- src/modules/benchmark/README | 2 +- src/modules/blst/README | 4 +-- src/modules/call_control/README | 4 +-- src/modules/carrierroute/README | 48 +++++++++++++------------- src/modules/cdp/README | 20 +++++------ src/modules/cdp_avp/README | 4 +-- src/modules/cfg_db/README | 2 +- src/modules/cfg_rpc/README | 2 +- src/modules/cfgt/README | 3 +- src/modules/cfgutils/README | 18 +++++----- src/modules/cnxcc/README | 6 ++-- src/modules/corex/README | 10 +++--- src/modules/cplc/README | 2 +- src/modules/ctl/README | 2 +- src/modules/db2_ldap/README | 4 +-- src/modules/db2_ops/README | 2 +- src/modules/db_berkeley/README | 14 ++++---- src/modules/db_cassandra/README | 2 +- src/modules/db_cluster/README | 2 +- src/modules/db_flatstore/README | 8 ++--- src/modules/db_mongodb/README | 2 +- src/modules/db_mysql/README | 6 ++-- src/modules/db_oracle/README | 4 +-- src/modules/db_perlvdb/README | 10 +++--- src/modules/db_postgres/README | 6 ++-- src/modules/debugger/README | 6 ++-- src/modules/dialog/README | 13 +++---- src/modules/dispatcher/README | 22 ++++++------ src/modules/dmq/README | 2 +- src/modules/dmq_usrloc/README | 8 ++--- src/modules/dnssec/README | 8 ++--- src/modules/domain/README | 2 +- src/modules/domainpolicy/README | 2 +- src/modules/drouting/README | 2 +- src/modules/enum/README | 6 ++-- src/modules/evrexec/README | 2 +- src/modules/geoip/README | 2 +- src/modules/gzcompress/README | 6 ++-- src/modules/htable/README | 16 ++++----- src/modules/http_async_client/README | 2 +- src/modules/http_client/README | 4 +-- src/modules/imc/README | 2 +- src/modules/ims_auth/README | 10 +++--- src/modules/ims_charging/README | 32 ++++++++--------- src/modules/ims_dialog/README | 10 +++--- src/modules/ims_icscf/README | 6 ++-- src/modules/ims_ocs/README | 6 ++-- src/modules/ims_qos/README | 2 +- src/modules/ims_registrar_pcscf/README | 4 +-- src/modules/ims_registrar_scscf/README | 10 +++--- src/modules/ims_usrloc_pcscf/README | 6 ++-- src/modules/ipops/README | 8 ++--- src/modules/jansson/README | 6 ++-- src/modules/janssonrpcc/README | 12 +++---- src/modules/jsonrpcc/README | 4 +-- src/modules/jsonrpcs/README | 6 ++-- src/modules/kazoo/README | 18 +++++----- src/modules/keepalive/README | 2 +- src/modules/kex/README | 8 ++--- src/modules/lcr/README | 4 +-- src/modules/ldap/README | 6 ++-- src/modules/malloc_test/README | 4 +-- src/modules/matrix/README | 2 +- src/modules/maxfwd/README | 8 ++--- src/modules/mediaproxy/README | 2 +- src/modules/memcached/README | 6 ++-- src/modules/misc_radius/README | 6 ++-- src/modules/mohqueue/README | 4 +-- src/modules/mqueue/README | 2 +- src/modules/msilo/README | 6 ++-- src/modules/mtree/README | 2 +- src/modules/nat_traversal/README | 4 +-- src/modules/nathelper/README | 14 ++++---- src/modules/ndb_mongodb/README | 2 +- src/modules/ndb_redis/README | 4 +-- src/modules/nosip/README | 2 +- src/modules/nsq/README | 14 ++++---- src/modules/osp/README | 2 +- src/modules/p_usrloc/README | 32 ++++++++--------- src/modules/pdb/README | 2 +- src/modules/peering/README | 2 +- src/modules/pike/README | 4 +-- src/modules/pipelimit/README | 14 ++++---- src/modules/presence/README | 10 +++--- src/modules/presence_conference/README | 2 +- src/modules/presence_dialoginfo/README | 10 +++--- src/modules/presence_xml/README | 2 +- src/modules/print_lib/README | 2 +- src/modules/pua_dialoginfo/README | 20 +++++------ src/modules/pua_xmpp/README | 2 +- src/modules/pv/README | 4 +-- src/modules/ratelimit/README | 2 +- src/modules/regex/README | 4 +-- src/modules/registrar/README | 12 +++---- src/modules/rls/README | 8 ++--- src/modules/rr/README | 8 ++--- src/modules/rtpengine/README | 18 +++++----- src/modules/rtpproxy/README | 12 +++---- src/modules/sanity/README | 2 +- src/modules/sdpops/README | 2 +- src/modules/seas/README | 36 +++++++++---------- src/modules/sipcapture/README | 2 +- src/modules/sipdump/README | 2 +- src/modules/sipt/README | 4 +-- src/modules/siptrace/README | 2 +- src/modules/siputils/README | 6 ++-- src/modules/sms/README | 2 +- src/modules/snmpstats/README | 6 ++-- src/modules/speeddial/README | 6 ++-- src/modules/sqlops/README | 4 +-- src/modules/sst/README | 4 +-- src/modules/statsc/README | 8 ++--- src/modules/tcpops/README | 6 ++-- src/modules/textops/README | 22 ++++++------ src/modules/textopsx/README | 8 ++--- src/modules/timer/README | 2 +- src/modules/tls/README | 15 ++++---- src/modules/tm/README | 22 ++++++------ src/modules/tmrec/README | 4 +-- src/modules/tmx/README | 4 +-- src/modules/topoh/README | 8 ++--- src/modules/topos/README | 2 +- src/modules/tsilo/README | 2 +- src/modules/uac/README | 2 +- src/modules/uac_redirect/README | 8 ++--- src/modules/uid_avp_db/README | 4 +-- src/modules/uid_domain/README | 2 +- src/modules/uri_db/README | 2 +- src/modules/userblacklist/README | 6 ++-- src/modules/usrloc/README | 31 ++++++++--------- src/modules/xcap_server/README | 12 +++---- src/modules/xhttp_pi/README | 8 ++--- src/modules/xlog/README | 2 +- src/modules/xmlrpc/README | 2 +- src/modules/xmpp/README | 4 +-- src/modules/xprint/README | 10 +++--- 153 files changed, 577 insertions(+), 578 deletions(-) diff --git a/src/modules/acc/README b/src/modules/acc/README index 0ad48e06dc3..272b8f1f6a4 100644 --- a/src/modules/acc/README +++ b/src/modules/acc/README @@ -456,7 +456,7 @@ if (uri=~"sip:+40") /* calls to Romania */ { one SIP call but with 2 legs ( A to B and B to C). Accounting the legs of a call is required for proper billing of the calls (if C is a PSTN number and the call is billed, user B must pay for the call - as last - party modifing the call destination-, and not A - as initiator of the + party modifying the call destination-, and not A - as initiator of the call. Call forwarding on server is only one example which shows the necessity of the having an accounting engine with multiple legs support. @@ -465,7 +465,7 @@ if (uri=~"sip:+40") /* calls to Romania */ { First how it works: The idea is to have a set of AVPs and for each call leg to store a set of values in the AVPs. The meaning of the AVP - content is stricly decided by the script writer - it can be the origin + content is strictly decided by the script writer - it can be the origin and source of the leg, its status or any other related information. If you have a set of 4 AVPS (AVP1, AVP2, AVP3, AVP4), then for the "A call B and B forwards to C" example, you need to set a different set of @@ -493,8 +493,8 @@ if (uri=~"sip:+40") /* calls to Romania */ { call-leg info. Note - You will need to add in your DB (all acc related tables) the colums - for call-leg info (a column for each AVP of the set). + You will need to add in your DB (all acc related tables) the + columns for call-leg info (a column for each AVP of the set). * Radius -- all sets will be added to the same Radius accounting message as RADIUS AVPs - for each call-leg a set of RADIUS AVPs will be added (corresponding to the per-leg AVP set). Note that @@ -593,10 +593,10 @@ Note with the corresponding caller and callee in a dialog based pseudo-variable (dlg_var) (e.g. chain=B;cfa;C|C;cfnr;D). Additionally it is necessary to store the caller and callee for each leg. All this - helps to identify the involved phone parners 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. + 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. 4.3.2.1. Example for a spiraled Proxy @@ -768,7 +768,7 @@ modparam("acc", "report_cancels", 1) 6.6. detect_direction (integer) - Controlles the direction detection for sequential requests. If enabled + Controls the direction detection for sequential requests. If enabled (non zero value), for sequential requests with upstream direction (from callee to caller), the FROM and TO will be swapped (the direction will be preserved as in the original request). @@ -871,7 +871,7 @@ modparam("acc", "log_level", 2) # Set log_level to 2 (L_INFO) 6.13. log_facility (string) Log facility to which accounting messages are issued to syslog. This - allows to easily seperate the accounting specific logging from the + allows to easily separate the accounting specific logging from the other log messages. Default value is LOG_DAEMON. @@ -919,7 +919,7 @@ modparam("acc", "db_missed_flag", 3) 6.17. db_table_acc (string) - Table name of accounting successfull calls -- database specific. It can + Table name of accounting successful calls -- database specific. It can contain config variables that will be evaluated at runtime. Default value is “acc” @@ -944,8 +944,8 @@ modparam("acc", "db_table_missed_calls", "myMC_table") 6.19. db_url (string) - SQL address -- database specific. If is set to NULL or emty string, the - SQL support is disabled. + SQL address -- database specific. If is set to NULL or empty string, + the SQL support is disabled. Default value is “NULL” (SQL disabled). @@ -1001,7 +1001,7 @@ modparam("acc", "acc_callid_column", "callid") 6.24. acc_sip_code_column (string) - Column name in accounting table to store the final reply's numric code + Column name in accounting table to store the final reply's numeric code value in string format. Default value is “sip_code”. @@ -1336,7 +1336,7 @@ modparam("acc", "reason_from_hf", 1) If set to 1, request structure from transaction is cloned temporarily in the callback to get acc attributes. It is required if you account - values from SIP headers to avoid concurent access to the shared memory + values from SIP headers to avoid concurrent access to the shared memory transaction structure, specially when accounting 1xx events. If set to 0, it uses directly the shared memory structure, be sure you store all needed attributes in AVPs/XAVPs inside request route. @@ -1468,15 +1468,15 @@ Chapter 2. Frequently Asked Questions The parameter became obsolete with the restructure of the data logged by ACC module (refer to the Overview chapter). For similar behaviour - you can use the extra accouting (see the coresponding chapter). + you can use the extra accounting (see the corresponding chapter). 2.2. What happened with old multi_leg_enabled parameter - The parameter becaome obsolete by the addition of the new - multi_leg_info parameter. The multi-leg accouting is automatically - enabled when multi_leg_info is defined. + The parameter became obsolete by the addition of the new multi_leg_info + parameter. The multi-leg accounting is automatically enabled when + multi_leg_info is defined. 2.3. diff --git a/src/modules/acc_diameter/README b/src/modules/acc_diameter/README index d2da0a07547..8d481d3f2f7 100644 --- a/src/modules/acc_diameter/README +++ b/src/modules/acc_diameter/README @@ -10,7 +10,7 @@ Ramona-Elena Modroiu rosdev.ro - Copyright 2002, 2003 FhG FOKUS + Copyright © 2002, 2003 FhG FOKUS __________________________________________________________________ Table of Contents @@ -73,7 +73,7 @@ Chapter 1. Admin Guide NOTE: This was developed based on some very early version of the Diameter protocol, and has not been really tested for many years. It is - verly likely to be deleted in upcoming releases. If you want to revive + very likely to be deleted in upcoming releases. If you want to revive this module, you are welcome, be sure you do proper testing before using in production -- it also may need to be updated first to match the exported API by 'acc' module. @@ -143,7 +143,7 @@ modparam("acc_diameter", "diameter_missed_flag", 3) Hostname of the machine where the DIAMETER Client is running -- DIAMETER specific. - Default value is "localhost". + Default value is “localhost”. Example 1.3. diameter_client_host example ... @@ -179,7 +179,7 @@ email)") 4.1. acc_diam_request(comment) -4.1. acc_diam_request(comment) +4.1. acc_diam_request(comment) Like acc_log_request, acc_diam_request reports on a request. It reports to the configured Diameter server. diff --git a/src/modules/acc_json/README b/src/modules/acc_json/README index 04f08cab67d..15a3f3b278c 100644 --- a/src/modules/acc_json/README +++ b/src/modules/acc_json/README @@ -16,7 +16,7 @@ Julien Chavanton flowroute.com - Copyright 2018 Flowroute.com + Copyright © 2018 Flowroute.com __________________________________________________________________ Table of Contents @@ -142,7 +142,7 @@ modparam("acc_json", "acc_missed_flag", 3) 3.3. acc_extra (integer) - Extra values to be added to the json dictionnary. + Extra values to be added to the json dictionary. Default value is NULL. @@ -225,7 +225,7 @@ route[RUN_CDR_PUBLISH] { 3.7. output_syslog (integer) Control if the output of acc json should be sent to syslog. This is not - dependent on Kamailio global logging settigns, we can use syslog even + dependent on Kamailio global logging settings, we can use syslog even if Kamailio is not daemonized and/or logging is done to sdtout stderr. Default value is not-set (no flag). @@ -240,7 +240,7 @@ modparam("acc_json", "log_facility", "LOG_DAEMON") 3.8. log_facility (integer) Log facility to which accounting messages are issued to syslog. This - allows to easily seperate the accounting specific logging from the + allows to easily separate the accounting specific logging from the other log messages. Default value is LOG_DAEMON. diff --git a/src/modules/alias_db/README b/src/modules/alias_db/README index 16545a46c5a..d0301791200 100644 --- a/src/modules/alias_db/README +++ b/src/modules/alias_db/README @@ -87,8 +87,8 @@ Chapter 1. Admin Guide 1. Overview The ALIAS_DB module can be used as an alternative for user aliases via - usrloc. The main feature is that it does not store all addiacent data - as for user location and always uses the database for search (no memory + usrloc. The main feature is that it does not store all adjacent data as + for user location and always uses the database for search (no memory caching). A common use case is to provide additional user aliases, i.e. to supplement the registration in the location database. Users are this way on a proxy reachable with several request URIs. diff --git a/src/modules/app_java/README b/src/modules/app_java/README index 540fc06016a..dbe06dce0e7 100644 --- a/src/modules/app_java/README +++ b/src/modules/app_java/README @@ -229,7 +229,7 @@ modparam("app_java", "java_options", "-Xdebug -verbose:gc,class,jni 4.4. force_cmd_exec (int) - This parameter forces execution a kamailio comnmand with java native + This parameter forces execution a kamailio command with java native method “KamExec”. # Note: this is an untested yet feature, may cause (but may not) a memory leaks if used from embedded languages. @@ -291,8 +291,8 @@ modparam("app_java", "force_cmd_exec", 1) Each parameter passed to function will be cast according to given signat ure. - Parameters are optional, ommitting a parameter meant the passed value is - NULL. + Parameters are optional, omitting a parameter meant the passed value is +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 @@ -332,7 +332,7 @@ public int ExampleMethod(String param1, int param2); java_method_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml"); # Java -public int ExampleMethod(String SipMessageBuffer, int SipMessageLenght) +public int ExampleMethod(String SipMessageBuffer, int SipMessageLength) { ... do something with buffer; return 1; @@ -392,7 +392,7 @@ public static int ExampleMethod(String param1, int param2); java_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml"); # Java -public static int ExampleMethod(String SipMessageBuffer, int SipMessageLenght) +public static int ExampleMethod(String SipMessageBuffer, int SipMessageLength) { ... do something with buffer; return 1; @@ -453,7 +453,7 @@ java_s_method_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml"); # Java public synchronized int ExampleMethod(String SipMessageBuffer, int SipMessageLen -ght) +gth) { ... do something with buffer; return 1; @@ -516,7 +516,7 @@ java_s_staticmethod_exec("ExampleMethod", "Ljava/lang/String;I", "$mb", "$ml"); # Java public static synchronized int ExampleMethod(String SipMessageBuffer, int SipMes -sageLenght) +sageLength) { ... do something with buffer; return 1; diff --git a/src/modules/app_jsdt/README b/src/modules/app_jsdt/README index 462826360fd..8679cb1bd64 100644 --- a/src/modules/app_jsdt/README +++ b/src/modules/app_jsdt/README @@ -94,7 +94,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. @@ -113,7 +113,7 @@ Chapter 1. Admin Guide The following libraries or applications must be installed before running Kamailio with this module loaded: * libm - the math library (part of standard system libraries - it is - needed to complile embedded Duktape JS interpreter). + needed to compile embedded Duktape JS interpreter). 3. Parameters diff --git a/src/modules/app_lua/README b/src/modules/app_lua/README index 164cf70c324..c8bba9fdf07 100644 --- a/src/modules/app_lua/README +++ b/src/modules/app_lua/README @@ -102,7 +102,7 @@ Chapter 1. Admin Guide Therefore lua_run() cannot execute functions from scripts loaded via lua_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. 2. Dependencies diff --git a/src/modules/app_perl/README b/src/modules/app_perl/README index fb0aa288756..6a18764e473 100644 --- a/src/modules/app_perl/README +++ b/src/modules/app_perl/README @@ -268,7 +268,7 @@ pemap" The Perl module has two interfaces: The perl side, and the Kamailio side. Once a Perl function is defined and loaded via the module parameters (see below), it may be called in Kamailio's configuration at - an arbitary point. E.g., you could write a function "ldap_alias" in + an arbitrary point. E.g., you could write a function "ldap_alias" in Perl, and then execute ... if (perl_exec("ldap_alias")) { @@ -294,7 +294,7 @@ if (perl_exec("ldap_alias")) { 4.1. Kamailio Modules The following modules must be loaded before this module: - * The "sl" module is needed for sending replies uppon fatal errors. + * The "sl" module is needed for sending replies upon fatal errors. All other modules can be accessed from the Perl module, though. 4.2. External Libraries or Applications @@ -343,7 +343,7 @@ if (perl_exec("ldap_alias")) { 5.1. filename (string) This is the file name of your script. This may be set once only, but it - may include an arbitary number of functions and “use” as many Perl + may include an arbitrary number of functions and “use” as many Perl module as necessary. Must not be empty! @@ -1065,9 +1065,9 @@ my $phonenumbers = new Kamailio::Utils::PhoneNumbers( $canonical = $phonenumbers->canonicalForm("07612034567"); $number = $phonenumbers->dialNumber("+497612034567"); - A telphone number starting with a plus sign and containing all dial - prefixes is in canonical form. This is usally not the number to dial at - any location, so the dialing number depends on the context of the + A telephone number starting with a plus sign and containing all dial + prefixes is in canonical form. This is usually not the number to dial + at any location, so the dialing number depends on the context of the user/system. The idea to canonicalize numbers were taken from hylafax. @@ -1083,7 +1083,7 @@ $number = $phonenumbers->dialNumber("+497612034567"); 829. Then we add all the general dial prefixes - 49 (country) 761 (area) 4514 (pbx) and 829, the number itself => +497614514829 - To get the dialing number from a canonical phone number, we substract + To get the dialing number from a canonical phone number, we subtract all general prefixes until we have something As said before, the interpretation of a phone number depends on the @@ -1140,8 +1140,8 @@ my $conf = new Kamailio::LDAPUtils::LDAPConf(); used by other LDAP software, such as nsswitch.ldap and pam-ldap. The configuration is usualy stored in /etc/openldap/ldap.conf - When used from an account with sufficient privilegs (e.g. root), the - ldap manager passwort is also retrieved. + When used from an account with sufficient privileges (e.g. root), the + ldap manager password is also retrieved. 6.1. Constructor new() @@ -1162,14 +1162,14 @@ my $conf = new Kamailio::LDAPUtils::LDAPConf(); 6.5. Method uri() Returns an uri to contact the ldap server. When there is no ldap_uri in - the configuration file, an ldap: uri is constucted from host and port. + the configuration file, an ldap: uri is constructed from host and port. 6.6. Method rootbindpw() Returns the ldap "root" password. Note that the rootbindpw is only available when the current account has - sufficient privilegs to access /etc/openldap/ldap.secret. + sufficient privileges to access /etc/openldap/ldap.secret. 6.7. Method rootbinddn() @@ -1233,8 +1233,8 @@ ou=de"); 7.2. Function/Method search( conf, filter, base, [requested_attributes ...]) perform an ldap search, return the dn of the first matching directory - entry, unless a specific attribute has been requested, in wich case the - values(s) fot this attribute are returned. + entry, unless a specific attribute has been requested, in which case + the values(s) for this attribute are returned. When the first argument (conf) is a Kamailio::LDAPUtils::LDAPConnection, it will be used to perform the @@ -1270,7 +1270,7 @@ ou=de"); matching entries in the LDAP directory. When some requested_attributes are given, return an array with those - attibutes. When multiple entries match the query, the attribute lists + attributes. When multiple entries match the query, the attribute lists are concatenated. 8. Kamailio::VDB @@ -1371,7 +1371,7 @@ ou=de"); This package handles virtual tables and is used by the Kamailio::VDB class to store information about valid tables. The package is not - inteded for end user access. + intended for end user access. 17.1. new() @@ -1622,7 +1622,7 @@ Chapter 3. Perl samples When processing SIP messages, you may want to use persistent data across multiple calls to your Perl functions. Your first option is to use global variables in your script. Unfortunately, these globals are - not visible from the mulitple instances of Kamailio. You may want to + not visible from the multiple instances of Kamailio. You may want to use a mechanism such as the IPC::Shareable shared memory access package to correct this. diff --git a/src/modules/app_python/README b/src/modules/app_python/README index 54ea0697c78..cd5af6994fc 100644 --- a/src/modules/app_python/README +++ b/src/modules/app_python/README @@ -119,8 +119,8 @@ modparam("app_python", "load", "/usr/local/etc/kamailio/myscript.py") 3.3. mod_init_function (string) - The Python function to be executed by this module when it is initialied - by Kamailio. + The Python function to be executed by this module when it is + initialized by Kamailio. Default value is “mod_init”. @@ -132,7 +132,7 @@ modparam("app_python", "mod_init_function", "my_mod_init") 3.4. child_init_method (string) The Python function to be executed by this module when a new worker - process (child) is initialied by Kamailio. + process (child) is initialized by Kamailio. Default value is “child_init”. diff --git a/src/modules/app_python3/README b/src/modules/app_python3/README index 1010241b2c5..49bc5774445 100644 --- a/src/modules/app_python3/README +++ b/src/modules/app_python3/README @@ -135,8 +135,8 @@ modparam("app_python3", "load", "/usr/local/etc/kamailio/myscript.py") 3.3. mod_init_function (string) - The Python function to be executed by this module when it is initialied - by Kamailio. + The Python function to be executed by this module when it is + initialized by Kamailio. Default value is “mod_init”. @@ -148,7 +148,7 @@ modparam("app_python3", "mod_init_function", "my_mod_init") 3.4. child_init_method (string) The Python function to be executed by this module when a new worker - process (child) is initialied by Kamailio. + process (child) is initialized by Kamailio. Default value is “child_init”. diff --git a/src/modules/app_sqlang/README b/src/modules/app_sqlang/README index b2b82cf1bf4..ff1770c1fd0 100644 --- a/src/modules/app_sqlang/README +++ b/src/modules/app_sqlang/README @@ -1,4 +1,3 @@ - app_sqlang Module Daniel-Constantin Mierla @@ -95,7 +94,7 @@ Chapter 1. Admin Guide Therefore sqlang_run() cannot execute functions from scripts loaded via sqlang_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 + have 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. diff --git a/src/modules/auth/README b/src/modules/auth/README index e9337a5b7b1..c0badc4115e 100644 --- a/src/modules/auth/README +++ b/src/modules/auth/README @@ -317,7 +317,7 @@ modparam("auth", "qop", "auth") # set qop=auth Note: nonce_count should be enabled only in stateful mode (a transaction should be created prior to the authentication check to absorb possible retransmissions and all the replies should be sent - statefuly, using t_reply()). If nonce_count and the authentication + statefully, using t_reply()). If nonce_count and the authentication checks are used in the stateless mode then all retransmissions will be challenged. @@ -705,7 +705,7 @@ if (www_authenticate("realm", "subscriber")) { 4.2. has_credentials(realm) - This function returns true of the request has Autorization or + This function returns true of the request has Authorization or Proxy-Authorization header with provided realm. The parameter can be string with pseudo-variables. @@ -823,9 +823,9 @@ if (!auth_check("$fd", "subscriber", "1")) { 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., varibale $td) can be used (because this + header field domain (e.g., variable $td) can be used (because this header field represents a user being registered), for all other - messages From header field domain can be used (e.g., varibale $fd). + messages From header field domain can be used (e.g., variable $fd). The string may contain pseudo variables. * passwd - the password to be used for authentication. Can contain config variables. The Username is taken from Auth header. @@ -879,7 +879,7 @@ if (!pv_proxy_authenticate("$fd", "$avp(password)", "0")) { 4.8. pv_auth_check(realm, passwd, flags, checks) The function combines the functionalities of pv_www_authenticate and - pv_proxy_authenticate, first being exectuted if the SIP request is a + pv_proxy_authenticate, first being executed if the SIP request is a REGISTER, the second for the rest. Meaning of the first three parameters is the same as for diff --git a/src/modules/auth_db/README b/src/modules/auth_db/README index 63a6ed223bf..0896481c23f 100644 --- a/src/modules/auth_db/README +++ b/src/modules/auth_db/README @@ -219,7 +219,7 @@ modparam("auth_db", "password_column_2", "ha1_2") 3.6. calculate_ha1 (integer) This parameter tells the server whether it should use a pre-calculated - HA1 string or plaintext passwords for authentification. + HA1 string or plaintext passwords for authentication. If the parameter is set to 0 and the username parameter of credentials contains also “@domain” (some user agents append the domain to the @@ -268,7 +268,7 @@ modparam("auth_db", "use_domain", 1) This parameter specifies of credentials to be fetch from database when the authentication is performed. The loaded credentials will be stored - in AVPs. If the AVP name is not specificaly given, it will be used a + in AVPs. If the AVP name is not specifically given, it will be used a NAME AVP with the same name as the column name. Parameter syntax: @@ -276,7 +276,7 @@ modparam("auth_db", "use_domain", 1) * credential = (avp_specification '=' column_name) | (column_name) * avp_specification = '$avp(' + 'i:'ID | 's:'NAME | alias + ')' - Default value of this parameter is “NULL” (no credientials loaded). + Default value of this parameter is “NULL” (no credentials loaded). Example 1.8. load_credentials parameter usage ... @@ -431,7 +431,7 @@ if (!proxy_authorize("$fd", "subscriber)) { user. All other requests: From header must match the authentication user. If bit 2 is set as well (flags==3), the ID check is skipped for INVITE, BYE, PRACK, UPDATE, MESSAGE - these requests can come - with anonymoys caller id. + with anonymous caller id. Additionally all domains in the checked URIs and the realm in the authentication header will be checked to match the provided realm parameter. diff --git a/src/modules/auth_ephemeral/README b/src/modules/auth_ephemeral/README index 72b8c6d8d3b..8bc4c3e989c 100644 --- a/src/modules/auth_ephemeral/README +++ b/src/modules/auth_ephemeral/README @@ -224,7 +224,7 @@ modparam("auth_ephemeral", "username_format", 0) 3.3. sha_algorithm (integer) - The SHA algorhithm to be used for the Hash. + The SHA algorithm to be used for the Hash. * 0 - SHA1 (default, as per IETF/RFC) * 1 - SHA256 diff --git a/src/modules/auth_radius/README b/src/modules/auth_radius/README index 992258c22a3..ff0a1ad8660 100644 --- a/src/modules/auth_radius/README +++ b/src/modules/auth_radius/README @@ -62,7 +62,7 @@ Phil Lavin List of Examples - 1.1. “SIP-AVP” RADIUS AVP exmaples + 1.1. “SIP-AVP” RADIUS AVP examples 1.2. radius_config parameter usage 1.3. service_type parameter usage 1.4. auth_extra parameter usage @@ -108,13 +108,13 @@ Chapter 1. Admin Guide to make sure that only well formed credentials will get to the server. We have implemented radius authentication according to draft-sterman-aaa-sip-00. This module requires the radiusclient-ng - library version 0.5.0 or higheer or freeradius-client which is - available from https://github.com/FreeRADIUS/freeradius-client/. You - can also install this library from distribution repositories. + library version 0.5.0 or higher or freeradius-client which is available + from https://github.com/FreeRADIUS/freeradius-client/. You can also + install this library from distribution repositories. 2. Additional Credentials - When performing authentification, the RADIUS server may include + When performing authentication, the RADIUS server may include additional credentials in the response. This scheme is very useful in fetching additional user information from the RADIUS server without making extra queries. @@ -130,7 +130,7 @@ Chapter 1. Admin Guide The RPID value may be fetch via this mechanism. - Example 1.1. “SIP-AVP” RADIUS AVP exmaples + Example 1.1. “SIP-AVP” RADIUS AVP examples .... "email:joe@yahoo.com" - STRING NAME AVP (email) with STRING VALUE (joe@yahoo.com) @@ -156,7 +156,7 @@ Chapter 1. Admin Guide 3.2. External Libraries or Applications The following libraries or applications must be installed before - compilling Kamailio with this module loaded: + compiling Kamailio with this module loaded: One of these libraries. Notice that development of radiusclient-ng has stopped, as the project merged with freeradius-client. diff --git a/src/modules/auth_xkeys/README b/src/modules/auth_xkeys/README index 71050b31f23..d9e7bb91624 100644 --- a/src/modules/auth_xkeys/README +++ b/src/modules/auth_xkeys/README @@ -94,8 +94,8 @@ Chapter 1. Admin Guide of the new node. On large deployments, that can become rather complex. For example, as a replacement for IP trust relationships, the sender can hash the local IP with the secret shared key, add it in the header - and the receiver will check if the source ip hased with the key results - in the same value. + and the receiver will check if the source ip hashed with the key + results in the same value. Not being a challenge-reply mechanism, this can be used to authenticate SIP responses from trusted peers. @@ -143,7 +143,7 @@ modparam("auth_xkeys", "xkey", "id=abc;name=xyz;value=secret;expires=72000") 4.1. auth_xkeys_add(hdr, kid, alg, data) - Add a header computed with the first key in the group kid, hasing with + Add a header computed with the first key in the group kid, hashing with algorithm alg over the content of parameter data. The parameters can include variables. @@ -159,7 +159,7 @@ auth_xkeys_add("X-My-Key", "abc", "sha256", "$Ri:$fu:$ru:$hdr(CSeq)"); 4.2. auth_xkeys_check(hdr, kid, alg, data) Check if the value of header hdr matches the value computed with the - first key in the group kid, hasing with algorithm alg over the content + first key in the group kid, hashing with algorithm alg over the content of parameter data. The parameters can include variables. The algorithm can be: sha256, sha384, sha512. diff --git a/src/modules/avpops/README b/src/modules/avpops/README index c5db16a7fb8..0c199f17541 100644 --- a/src/modules/avpops/README +++ b/src/modules/avpops/README @@ -173,12 +173,12 @@ Chapter 1. Admin Guide all AVPs, regardless they have or not a script flag set (preserves the compatibility with the old naming schema). * avp_name = string | integer - string - might be any alphanumeric string, wich contain following + string - might be any alphanumeric string, which contain following characters: [a-z] [A-Z] [0-9] '_' integer - might be an unsigned integer, greater than zero, up to 2^16-1 * avp_alias = string - string - might be any alphanumeric string, wich contain following + string - might be any alphanumeric string, which contain following characters: [a-z] [A-Z] [0-9] '_' Example 1.1. AVP naming examples @@ -374,7 +374,7 @@ modparam("avpops","db_scheme", 'a' or 'A' means matching any of AVP name types ('i' and 's') (NOTE: matching_flags cannot be used with $db_scheme because the name of AVP to save in cannot be specified), the rest have - the meaning descriped in 'AVP naming format' chapter. + the meaning described in 'AVP naming format' chapter. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE, LOCAL_ROUTE and ONREPLY_ROUTE. @@ -534,7 +534,7 @@ avp_pushto("$br","$avp(i:680)"); + le - less or equal + gt - greater than + ge - greater or equal - + re - regexp (regular exression match) + + re - regexp (regular expression match) + fm - fast match (see: man fnmatch) + and - bitwise 'and' + or - bitwise 'or' diff --git a/src/modules/benchmark/README b/src/modules/benchmark/README index 30ac60e6d87..c69987a9afa 100644 --- a/src/modules/benchmark/README +++ b/src/modules/benchmark/README @@ -280,7 +280,7 @@ bm_log_timer("test"); 6.1. benchmark.enable_global Enables/disables the module. Parameter may be -1, 0 or 1. See - discription of "enable" parameter. + description of "enable" parameter. 6.2. benchmark.enable_timer diff --git a/src/modules/blst/README b/src/modules/blst/README index 87e6aba63cc..e6516a4fd55 100644 --- a/src/modules/blst/README +++ b/src/modules/blst/README @@ -137,13 +137,13 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds * 0x04 - connect failed (TCP, TLS or SCTP). * 0x08 - ICMP error (not currently used). * 0x10 - SIP transaction timeout. - * 0x20 - 503 reply (statefull mode only). For more details see + * 0x20 - 503 reply (stateful mode only). For more details see tmblst_503. Note TCP and TLS send and connect errors are handled per connection and not - per message. The connection blacklist ignore flags are inherithed from + per message. The connection blacklist ignore flags are inherited from the message that caused the connection establishment. Example 1.5. blst_set_ignore usage diff --git a/src/modules/call_control/README b/src/modules/call_control/README index 9444eef1b85..cdde5983df8 100644 --- a/src/modules/call_control/README +++ b/src/modules/call_control/README @@ -137,7 +137,7 @@ Chapter 1. Admin Guide to be used and it has to be started by engage_media_proxy() to be able to keep track of the call's dialog and end it on timeout. Even when mediaproxy is unable to end the dialog because it was not - started with engage_media_proxy(), the callcantrol application is + started with engage_media_proxy(), the callcontrol application is still able to detect calls that did timeout sending media, by looking in the radius accounting records for entries recorded by mediaproxy for calls that did timeout. These calls will also be @@ -226,7 +226,7 @@ modparam("call_control", "socket_timeout", 500) This is used by the rating engine which finds the rates to apply to a call based on caller's SIP URI, caller's SIP domain or caller's IP - address (whichever yields a rate forst, in this order). + address (whichever yields a rate first, in this order). Default value is “$avp(s:signaling_ip)”. diff --git a/src/modules/carrierroute/README b/src/modules/carrierroute/README index 633c63e0d60..7f2b5503689 100644 --- a/src/modules/carrierroute/README +++ b/src/modules/carrierroute/README @@ -237,13 +237,13 @@ Chapter 1. Admin Guide at Kamailio startup. It can uses 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 failback routes or different routing rules for + tree domains, e.g. for fallback routes or different routing rules for VoIP and PSTN targets. Based on the tree, the module decides which number prefixes are forwarded to which gateway. It can also distribute the traffic by ratio parameters. Furthermore, the requests can be distributed by a hash - funcion to predictable destinations. The hash source is configurable, + function to predictable destinations. The hash source is configurable, two different hash functions are available. This modules scales up to more than a few million users, and is able to @@ -286,7 +286,7 @@ Chapter 1. Admin Guide Starting with version 3.1 , if you want to use this module in failure routes, it is not needed to call“append_branch()” after rewriting the request URI in order to relay the message to the new target. Its also - supportes the usage of database derived failure routing descisions with + supports the usage of database derived failure routing decisions with the carrierfailureroute table. 2. Dependencies @@ -459,9 +459,9 @@ modparam("carrierroute", "db_load_description", 0) 3.12. match_mode (integer) The number of individual characters that are used for matching. Valid - values are 10 or 128. When you specifiy 10, only digits will be used - for matching, this operation mode is equivalent to the old behaviour. - When configured with 128, all standard ascii chars are available for + values are 10 or 128. When you specify 10, only digits will be used for + matching, this operation mode is equivalent to the old behaviour. When + configured with 128, all standard ascii chars are available for matching. Please be aware that memory requirements for storing the routing tree in shared memory will also increase by a factor of 12.8. @@ -540,9 +540,9 @@ descavp) Request URI is rewritten using rewrite_user and the given hash source and algorithm. Returns -1 if there is no data found or an empty rewrite host on the longest match is found. On success also the description is - stored in the given AVP (if obmitted, nothing is stored in an AVP). - This is useful if you need some additional informations that belongs to - each gw, like the destination or the number of channels. + stored in the given AVP (if omitted, nothing is stored in an AVP). This + is useful if you need some additional informations that belongs to each + gw, like the destination or the number of channels. Depending on the value of the avoid_failed_destinations module parameter, the function pays special attention to the failurerouting @@ -589,16 +589,16 @@ hash_source, descavp) Request URI is rewritten using rewrite_user and the given hash source and algorithm. Returns -1 if there is no data found or an empty rewrite host on the longest match is found. On success also the description is - stored in the given AVP (if obmitted, nothing is stored in an AVP). - This is useful if you need some additional informations that belongs to - each gw, like the destination or the number of channels. This function - is only usable with rewrite_user and prefix_matching containing a valid + stored in the given AVP (if omitted, nothing is stored in an AVP). This + is useful if you need some additional informations that belongs to each + gw, like the destination or the number of channels. This function is + only usable with rewrite_user and prefix_matching containing a valid string. This string needs to be numerical if the match_mode parameter is set to 10. It uses the standard CRC32 algorithm to calculate the hash values. In contrast to the normal cr_route function the backup rules of (now - obselete) cr_prime_route is used. This means not the configured + obsolete) cr_prime_route is used. This means not the configured probabilities will be used, only a fixed hash distribution. This makes sense to distribute incoming register requests e.g. to a bunch of registrar servers. If one of the hash targets is not available and @@ -883,13 +883,13 @@ failure_route[1] { 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 ommit the hash completly, + 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. 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 URI), if they did not contain a valid (numerical) URI, no match is - possible. So for loadbalancing purposes e.g. for your registrars, you + possible. So for load-balancing purposes e.g. for your registrars, you should use an empty prefix. ... domain proxy { @@ -989,9 +989,9 @@ domain register { section. This table provides also a “carrier 1” routing rule for the “49” - prefix, that is only choosen if some message flags are set. If this + prefix, that is only chosen if some message flags are set. If this flags are not set, the other two rules are used. The “strip”, “mask” - and “comment” colums are omitted for brevity. + and “comment” columns are omitted for brevity. Example 1.23. Example database content - simple carrierfailureroute table @@ -1006,8 +1006,8 @@ domain register { This table contains two failure routes for the “gw.carrier1-1” and “-2” gateways. For any (failure) reply code the respective next domain is - choosen. After that no more failure routes are available, an error will - be returned from the “cr_next_domain” function. Not all table colums + chosen. After that no more failure routes are available, an error will + be returned from the “cr_next_domain” function. Not all table columns are show here for brevity. For each failure route domain and carrier that is added to the @@ -1033,13 +1033,13 @@ domain register { for example that indicates that ringing has happened. If this flag is set, there will be no further forwarding, because next_domain is empty. In the second and third routes are certain gateway errors matched, if - this errors have occurred, then the next domain will be choosen. Note + this errors have occurred, then the next domain will be chosen. Note that the reply_code must be 3 characters wide, and only the "." character is accepted as wildcard.The last route does forwarding according some flags, e.g. the customer came from a certain carrier, and has call-forwarding deactivated. In order to use the routing that is specified above, a matching carrierroute table must be provided, - that holds domain entries for this routing rules. Not all table colums + that holds domain entries for this routing rules. Not all table columns are show here for brevity. Example 1.25. Example database content - carrier_name table @@ -1072,7 +1072,7 @@ domain register { For a functional routing the “cr_preferred_carrier” column must be added to the subscriber table (or to the table and column that you - specified as modul parameter) to choose the actual carrier for the + specified as module parameter) to choose the actual carrier for the users. Example 1.27. Necessary extensions for the user table @@ -1314,7 +1314,7 @@ modparam("carrierroute", "carrierfailureroute_domain_col", "domain") 19. carrierfailureroute_scan_prefix_col (string) - Name of column contains the the scan prefixes. Scan prexies define the + Name of column contains the the scan prefixes. Scan prefixes define the matching portion of a phone number, e.g. we have the scan prefixes 49721 and 49, the called number is 49721913740, it matches 49721, because the longest match is taken. If no prefix matches, the number is diff --git a/src/modules/cdp/README b/src/modules/cdp/README index 8137baf7e28..9681c0bd3fa 100644 --- a/src/modules/cdp/README +++ b/src/modules/cdp/README @@ -246,7 +246,7 @@ modparam("cdp", "config_file", "/etc/kamailio/diametercfg.xml") 4.2. latency_threshold (int) - The time in ms above which a log error is wrtten to log file for long + The time in ms above which a log error is written to log file for long CDP transactions. Default value is “500”. @@ -292,7 +292,7 @@ modparam("cdp", "debug_heavy", 1) The method checks, if a specific peer is connected and ready. Meaning of the parameter is as follows: - * fqdn - the Fully qualified domai name of the peer, that should be + * fqdn - the Fully qualified domain name of the peer, that should be checked. The parameter may contain pseudovariables. Example 1.5. cdp_check_peer usage @@ -358,8 +358,8 @@ if(!cdp_has_app("16777216")) { @@ -477,13 +477,13 @@ CER/CEA in the tries will be used. Note: In case a message already contains a Destination-Host AVP, - Realm Routeing will not be + Realm Routing will not be applied. Note: Routing will only happen towards connected and application id supporting peers. - The metric is used to order the list of prefered peers, while lo -oking for a connected and + The metric is used to order the list of preferred peers, while l +ooking for a connected and application id supporting peer. In the end, of course, just one peer will be selected. --> @@ -916,7 +916,7 @@ searchType) Meaning of the parameters is as follows: * AAAResponseHandler_f *f - callback function to be called on incoming responses - * void *param - generic data to be bassed to callback function + * void *param - generic data to be passed to callback function Chapter 3. Frequently Asked Questions diff --git a/src/modules/cdp_avp/README b/src/modules/cdp_avp/README index 6203a78e45d..425b6e5b684 100644 --- a/src/modules/cdp_avp/README +++ b/src/modules/cdp_avp/README @@ -74,7 +74,7 @@ Chapter 1. Admin Guide 2. How it works - CDP AVP is a lightwieght helper module that doesn't really do much + CDP AVP is a lightweight helper module that doesn't really do much other than offer a set of AVP facilitating functions for various application uses. CDP AVP module is used in conjunction with CDP module. @@ -101,7 +101,7 @@ Chapter 1. Admin Guide 5. Functions - No functions available from configuraion. See API for internal + No functions available from configuration. See API for internal functions. Chapter 2. Developer Guide diff --git a/src/modules/cfg_db/README b/src/modules/cfg_db/README index f7ce4313c08..6223f35073e 100644 --- a/src/modules/cfg_db/README +++ b/src/modules/cfg_db/README @@ -100,7 +100,7 @@ modparam("cfg_db", "db_url", "mysql://SER:123@127.0.0.1:12345/SER"); used. The default values are declared in record having group_name called . The C-code "absolutely" default values ("cfg_var", "group_name", "name", "value"). The other keyword is asterisk * which - matches all parameters and will be used if parameter is not explicitely + matches all parameters and will be used if parameter is not explicitly mentioned. 3.3. custom_tbl (string) := "cfg_custom" diff --git a/src/modules/cfg_rpc/README b/src/modules/cfg_rpc/README index 9f3c25820ac..ac2dba93674 100644 --- a/src/modules/cfg_rpc/README +++ b/src/modules/cfg_rpc/README @@ -89,7 +89,7 @@ Chapter 1. Admin Guide such as debug, tcp/sctp/dns attributes, without the need of restart. RPC connector modules, such as “ctl” or “xmlrpc”, although not a - dependecy, should be loaded in order to execute the RPC commands + dependency, should be loaded in order to execute the RPC commands exported by this module. When the ctl module is loaded, the tool 'kamcmd' can be used to execute the RPC commands implemented in this module. diff --git a/src/modules/cfgt/README b/src/modules/cfgt/README index 8a098a69dc5..eb4ead159cc 100644 --- a/src/modules/cfgt/README +++ b/src/modules/cfgt/README @@ -171,7 +171,8 @@ modparam("debugger", "cfgtest", 1) processed and the SIP messages sent during that process execution. The flow of the configuration routes is defined by an array of routes - with the content of the variables controled by “mask” module parameter. + with the content of the variables controlled by “mask” module + parameter. Each routename has a prefix as “start|”, “return|”, when the route finish its execution and “exit|” or “drop|” if the route finish its diff --git a/src/modules/cfgutils/README b/src/modules/cfgutils/README index a80552c61e0..3d46af3ba33 100644 --- a/src/modules/cfgutils/README +++ b/src/modules/cfgutils/README @@ -52,7 +52,7 @@ Daniel-Constantin Mierla 4. Functions 4.1. rand_event() - 4.2. rand_set_prob(probabiltiy) + 4.2. rand_set_prob(probability) 4.3. rand_reset_prob() 4.4. rand_get_prob() 4.5. sleep(time) @@ -141,7 +141,7 @@ Chapter 1. Admin Guide 4. Functions 4.1. rand_event() - 4.2. rand_set_prob(probabiltiy) + 4.2. rand_set_prob(probability) 4.3. rand_reset_prob() 4.4. rand_get_prob() 4.5. sleep(time) @@ -291,7 +291,7 @@ modparam("cfgutils", "lock_set_size", 4) 4. Functions 4.1. rand_event() - 4.2. rand_set_prob(probabiltiy) + 4.2. rand_set_prob(probability) 4.3. rand_reset_prob() 4.4. rand_get_prob() 4.5. sleep(time) @@ -326,7 +326,7 @@ if (rand_event()) { # normal message processing follows ... -4.2. rand_set_prob(probabiltiy) +4.2. rand_set_prob(probability) Set the “probability” of the decision. @@ -339,7 +339,7 @@ rand_set_prob("4"); 4.3. rand_reset_prob() - Reset the probability back to the inital value. + Reset the probability back to the initial value. Example 1.7. rand_reset_prob() usage ... @@ -382,7 +382,7 @@ sleep("1"); Example 1.10. usleep usage ... -# wait 5 miliseconds +# wait 5 milliseconds usleep("5000"); ... @@ -508,7 +508,7 @@ if(is_gflag("4")) 4.15. lock(key) - Lock the key. Can be used to syncronize operations in config file, a + Lock the key. Can be used to synchronize operations in config file, a hash id is computed over the key and appropriate lock is set in the lock array controlled by parameter "lock_set_size". Do not use lock() after another lock() unless you are sure the keys hit different array @@ -632,7 +632,7 @@ core_hash("$ci", "", 4); 5.9. cfgutils.get_gflags Functions that check or change some global flags accepts one parameter - which is the flag bitmap/mask specifing the corresponding flags. It is + which is the flag bitmap/mask specifying the corresponding flags. It is not possible to specify directly the flag position that should be changed as in the functions available in the routing script. @@ -650,7 +650,7 @@ $ kamcmd cfgutils.rand_set_prob 10 5.2. cfgutils.rand_reset_prob - Reset the probability value to the inital start value. + Reset the probability value to the initial start value. This command don't need a parameter. diff --git a/src/modules/cnxcc/README b/src/modules/cnxcc/README index 2fe7f9d2162..b20ee01226b 100644 --- a/src/modules/cnxcc/README +++ b/src/modules/cnxcc/README @@ -154,7 +154,7 @@ modparam("cnxcc", "redis", "addr=127.0.0.1;port=6379;db=1") 3.2. credit_check_period (integer) Indicates how often the credit checking function should be called. It - is directly related to the precison of the module. The maximum + is directly related to the precision of the module. The maximum precision is 1, which means that every call is checked every one second. @@ -177,7 +177,7 @@ modparam("cnxcc", "credit_check_period", 1) Associates the call with a customer id and sets the max credit, cost per second, initial pulse and final pulse. The discount is calculated - in pulses (30/6, 1/1, etc) and sustracted from the pool of credit. + in pulses (30/6, 1/1, etc) and subtracted from the pool of credit. The customer value can be provided as a string or a variable holding a string. @@ -201,7 +201,7 @@ cnxcc_set_max_credit("john-doe", "100.5", "0.5", "20", "10"); $var(customer) = "john-doe-premium"; # customer id $var(credit) = "100"; # max credit $var(cps) = "2.00"; # cost per second -$var(initial_p) = 30; # intial pulse +$var(initial_p) = 30; # initial pulse $var(final_p) = 6; # final pulse cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(cps)", "$var(initial_p)", "$var(final_p)"); diff --git a/src/modules/corex/README b/src/modules/corex/README index 7e4f706c1ab..eeb318498b5 100644 --- a/src/modules/corex/README +++ b/src/modules/corex/README @@ -462,7 +462,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... } After executing of this event route, if msg_avp was defined and set then its value is used for further processing, otherwise, original value of $mb is used. If message was received from remote host, then it - is parsed and proceeds to appropriate route. Oterhwise if message set + is parsed and proceeds to appropriate route. Otherwise if message set to send out, then is sent to remote host per configured SIP timers in config script. @@ -493,7 +493,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... } proxy may be decrypted and sent to SIP application server at remote location unencrypted, where they are processed as normal. One the way back, the messages received from SIP application server at edge proxy - can be encrpyted before being sent to actual destination. The edge + can be encrypted before being sent to actual destination. The edge proxy can check whether received message came from end-user or SIP application server by using simple regular expressions. @@ -513,9 +513,9 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... } device UUID along with ITV key, encrypted using RSA or AES256 with pre-shared secret, as first packet, which is set as cookie by server in e.g. memcache. This cookie is referred by client app in each next - packet, so server can retrive encyption key from cache and use that for - decryption. Same can be done for server at client app side, so messages - encrypted by server can be decrypted at client app. + packet, so server can retrieve encryption key from cache and use that + for decryption. Same can be done for server at client app side, so + messages encrypted by server can be decrypted at client app. Next is a basic usage example where encoding and decoding is done using PERL, diff --git a/src/modules/cplc/README b/src/modules/cplc/README index 903fa0fc860..442a84baf08 100644 --- a/src/modules/cplc/README +++ b/src/modules/cplc/README @@ -337,7 +337,7 @@ modparam("cpl-c","realm_prefix","sip.") value of the Final Response INVITE timeout - it's used by the TIMEOUT attribute from the PROXY tag. - NOTE: take care and syncronize this value with the similar parameters + NOTE: take care and synchronize this value with the similar parameters in TM module. Default value of this parameter is NULL. diff --git a/src/modules/ctl/README b/src/modules/ctl/README index 5bb4170ca53..2eb67adbc33 100644 --- a/src/modules/ctl/README +++ b/src/modules/ctl/README @@ -228,7 +228,7 @@ modparam("ctl", "group", 100) Example 1.7. Set fifo parameter ... # old fifo support -modparam("ctl", "fifo", "fifo:/tmp/ser_fifo") # clasic fifo +modparam("ctl", "fifo", "fifo:/tmp/ser_fifo") # classic fifo modparam("ctl", "fifo", "/tmp/ser_fifo2") modparam("ctl", "fifo", "udp:*:2050") # fifo protocol over udp modparam("ctl", "fifo", "tcp:*:2050") # fifo over tcp diff --git a/src/modules/db2_ldap/README b/src/modules/db2_ldap/README index c47ffb3b63a..d94e5f30c8b 100644 --- a/src/modules/db2_ldap/README +++ b/src/modules/db2_ldap/README @@ -83,7 +83,7 @@ Chapter 1. Admin Guide "equal"/"non-equal" operator requires equality matching rule, the "greater"/"less" operator requires ordering matching rule. If required matching rule is missing the LDAP server silently returns empty result - set. In case of double filtering both at the LDAP servar and the LDAP + set. In case of double filtering both at the LDAP server and the LDAP module, e.g. multi-value and equal comparison, check the LDAP server matching rule satisfies your needs or use client_side_filtering feature. @@ -185,7 +185,7 @@ filter = "(objectClass=digestAuthCredentials)" # Mapping of field names to LDAP attribute names and vice versa. Names are # delimited using ':', the first name is database field name as used in SER # modules, the second name (after :) is corresponding LDAP attribute name, -# optionally preceeded with LDAP attribute syntax name in parentheses. +# optionally preceded with LDAP attribute syntax name in parentheses. field_map = password : (Binary) digestPassword field_map = realm : digestRealm field_map = auth_username : digestUsername diff --git a/src/modules/db2_ops/README b/src/modules/db2_ops/README index 4e818f8e627..c429ae5af53 100644 --- a/src/modules/db2_ops/README +++ b/src/modules/db2_ops/README @@ -206,7 +206,7 @@ tra_ops ] Executes query and in case of SELECT returns result via handle, seeks the first record and returns TRUE if table is not empty. The result is - accesible using @db.fetch select. See also declare_handle. Query_id + accessible using @db.fetch select. See also declare_handle. Query_id references to query declared using declare_query, handle references to query declared using declare_handle. diff --git a/src/modules/db_berkeley/README b/src/modules/db_berkeley/README index aecaee98564..305d0f9bce1 100644 --- a/src/modules/db_berkeley/README +++ b/src/modules/db_berkeley/README @@ -116,7 +116,7 @@ Chapter 1. Admin Guide 3.1. auto_reload (integer) The auto-reload will close and reopen a Berkeley DB when the files - inode has changed. The operation occurs only duing a query. Other + inode has changed. The operation occurs only during a query. Other operations such as insert or delete, do not invoke auto_reload. Default value is 0 (1 - on / 0 - off). @@ -177,7 +177,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600) Name: db_berkely.reload Parameters: tablename (or db_path); to reload a particular table - provide the tablename as the arguement (eg subscriber); to reload all + provide the tablename as the argument (eg subscriber); to reload all tables provide the db_path to the db files. The path can be found in kamctlrc DB_PATH variable. @@ -193,7 +193,7 @@ modparam("db_berkeley", "journal_roll_interval", 3600) compile in extra debug logs. However, it is not a recommended deployment to production servers. - Because the module dependes on an external library, the db_berkeley + Because the module depends on an external library, the db_berkeley module is not compiled and installed by default. You can use one of the next options. * edit the "Makefile" and remove "db_berkeley" from @@ -264,7 +264,7 @@ lt none is loaded natural key. Consider an example where use_domain = 0. In table subscriber, the db will be keying on 'username|NULL' because the default value will be used when that key column is not provided. This - effectivly means that later queries must consistently use the username + effectively means that later queries must consistently use the username (w.o domain) in order to find a result to that particular subscriber query. The main point is 'use_domain' can not be changed once the db_berkeley is setup. @@ -485,6 +485,6 @@ ast N files. 14. Known Limitations - The Berkeley DB does not nativly support an autoincrement (or sequence) - mechanism. Consequently, this version does not support surragate keys - in dbschema. These are the id columns in the tables. + The Berkeley DB does not natively support an autoincrement (or + sequence) mechanism. Consequently, this version does not support + surrogate keys in dbschema. These are the id columns in the tables. diff --git a/src/modules/db_cassandra/README b/src/modules/db_cassandra/README index 58e73123714..99cb2bac5b4 100644 --- a/src/modules/db_cassandra/README +++ b/src/modules/db_cassandra/README @@ -174,7 +174,7 @@ default_validation_class='UTF8Type' and key_validation_class='UTF8Type'; 5. Installation - Because the db_cassandra module dependes on an external library, it is + Because the db_cassandra module depends on an external library, it is not compiled and installed by default. You can use one of these options: * - edit the "Makefile" and remove "db_cassandra" from diff --git a/src/modules/db_cluster/README b/src/modules/db_cluster/README index 5bf50878da7..7fd611aea53 100644 --- a/src/modules/db_cluster/README +++ b/src/modules/db_cluster/README @@ -172,7 +172,7 @@ modparam("db_cluster", "max_query_length", 5) Practically, all the modules that want to use a cluster, have to set their db_url parameter to "cluster://clusterid". - Following rules apply when doing DB commands: the connecions with + Following rules apply when doing DB commands: the connections with highest priority are chosen first and the operations are performed according to the command mode. Note that for same priority, only one command mode is used (the one from the first connection with that diff --git a/src/modules/db_flatstore/README b/src/modules/db_flatstore/README index 16164ce65df..9baca736ac5 100644 --- a/src/modules/db_flatstore/README +++ b/src/modules/db_flatstore/README @@ -57,7 +57,7 @@ Chapter 1. Admin Guide information on sites with extremely high traffic. If MySQL is too slow or if you get a huge amount of accounting data then you can consider using this module. Please note that the acc module is the only module - that was tested with the flastore module. + that was tested with the flatstore module. The format of the files produced by this module is plain text. Each line consists of several fields, fields are separated by the "|" @@ -77,7 +77,7 @@ modparam("acc", "db_url", "flatstore:/var/log/acc") Name of files in that directory will follow the following pattern: _.log - For example, entries writen by the Kamailio process 8 into the acc + For example, entries written by the Kamailio process 8 into the acc table would be written in file acc_8.log. For each table there will be several files, one file for every Kamailio process that wrote some data into that table. The main reason why there are several files for each @@ -126,8 +126,8 @@ kamcmd flatstore.k_rotate 2.2. encode_delimiter (integer) - Enable or disable encoding tof the escaped character using ""%" HEX - HEX" mechanism for escaping from RFC 2396 + Enable or disable encoding of the escaped character using ""%" HEX HEX" + mechanism for escaping from RFC 2396 Default value is 1. Default delimiter '|' is replaced with %7C if found in any string diff --git a/src/modules/db_mongodb/README b/src/modules/db_mongodb/README index 7cbfa1d9b94..90c722c546f 100644 --- a/src/modules/db_mongodb/README +++ b/src/modules/db_mongodb/README @@ -67,7 +67,7 @@ Chapter 1. Admin Guide 3. Remarks - Using this module as a database dirver may require additional settings + Using this module as a database driver may require additional settings for various modules. For example, you have to set module parameter 'db_insert_null' to 1 for 'usrloc' module. If the module you are using with 'db_mongodb' fails, check its README for notes about using it with diff --git a/src/modules/db_mysql/README b/src/modules/db_mysql/README index 8e0391659b7..e78a7d1c86c 100644 --- a/src/modules/db_mysql/README +++ b/src/modules/db_mysql/README @@ -90,7 +90,7 @@ Chapter 1. Admin Guide The following libraries or applications must be installed before running Kamailio with this module loaded: - * mysql - the development libraries forthe Mysql database. In some + * mysql - the development libraries for the MySQL database. In some Linux distributions named "libmysqlclient-dev". 3. Parameters @@ -116,7 +116,7 @@ modparam("db_mysql", "ping_interval", 600) 3.2. server_timezone (integer) - Control if kamailio convers a time to string using the local timezone + Control if kamailio converts a time to string using the local timezone or if MySQL will convert it using FROM_UNIXTIME. This option is useful if kamailio and the database are configured for different timezones. @@ -187,7 +187,7 @@ modparam("db_mysql", "update_affected_found", 1) 5. Installation - Because it dependes on an external library, the mysql module is not + Because it depends on an external library, the mysql module is not compiled and installed by default. You can use one of these options. * - edit the "Makefile" and remove "db_mysql" from "excluded_modules" list. Then follow the standard procedure to install Kamailio: "make diff --git a/src/modules/db_oracle/README b/src/modules/db_oracle/README index 01ab1e5608c..e4f6f7a139e 100644 --- a/src/modules/db_oracle/README +++ b/src/modules/db_oracle/README @@ -135,7 +135,7 @@ modparam("db_oracle", "reconnect", 0.5) 5. Installation - Because it dependes on an external library, the oracle module is not + Because it depends on an external library, the oracle module is not compiled and installed by default. You can use one of the next options. * - edit the "Makefile" and remove "db_oracle" from "excluded_modules" list. Then follow the standard procedure to @@ -150,7 +150,7 @@ modparam("db_oracle", "reconnect", 0.5) command-line Oracle client (sqlplus) is not quite suitable for this, as it cannot align row width to real (received) data's (it always prints a cell width as described in the db scheme). This problem has been solved - by inclusion the utility openser_orasel, which formats printing + by inclusion the utility openser_oracle, which formats printing approximately in the same way as the 'mysql' client utility. In addition, this utility known about the "agreements and types" in DB that are used in Kamailio for the work with Oracle and formats printing diff --git a/src/modules/db_perlvdb/README b/src/modules/db_perlvdb/README index 653e9d8dac8..ba746b7bd03 100644 --- a/src/modules/db_perlvdb/README +++ b/src/modules/db_perlvdb/README @@ -182,19 +182,19 @@ my $val = new Kamailio::VDB::Value(DB_STRING, "foobar"); contains a column name (key). A new variable may be created with my $pair = new Kamailio::VDB::Pair("foo", DB_STRING, "bar"); - where foo is the key and bar is the value. Additonally to the methods + where foo is the key and bar is the value. Additionally to the methods of the Value class, it contains a key() method to get or set the key attribute. 3.3. Kamailio::VDB::ReqCond The ReqCond class is used for select condition and is derived from the - Pair class. It contains an addtional operator attribute. A new variable - may be created with + Pair class. It contains an additional operator attribute. A new + variable may be created with my $cond = new Kamailio::VDB::ReqCond("foo", ">", DB_INT, 5); where foo is the key, "greater" is the operator and 5 is the value to - compare. Additonally to the methods of the Pair class, it contains an + compare. Additionally to the methods of the Pair class, it contains an op() method to get or set the operator attribute. 3.4. Kamailio::VDB::Column @@ -274,7 +274,7 @@ my $cols = new Kamailio::VDB::Column(\@types, \@names); namespace. * Package/class. The defined class needs to have an init() function. - It will be called during the first call of that VTab. Addtionally, + It will be called during the first call of that VTab. Additionally, the package has to define the necessary functions insert, replace, update, delete and/or query. These functions will be called in a function context (first parameter is the class name). diff --git a/src/modules/db_postgres/README b/src/modules/db_postgres/README index 7640f36c18f..a1efc80ddb6 100644 --- a/src/modules/db_postgres/README +++ b/src/modules/db_postgres/README @@ -88,11 +88,11 @@ Chapter 1. Admin Guide 3.1. retries (integer) - How many retries to attept to reconnect if connection to Postgres + How many retries to attempt to reconnect if connection to Postgres server becomes broken. - Default value is 2 (that means three attepts to submit the query, first - will triger the connection error and two more (the value of this + Default value is 2 (that means three attempts to submit the query, + first will trigger the connection error and two more (the value of this parameter) after resetting the connection). Example 1.1. Set retries parameter diff --git a/src/modules/debugger/README b/src/modules/debugger/README index c33e1d14422..49a2379df63 100644 --- a/src/modules/debugger/README +++ b/src/modules/debugger/README @@ -304,7 +304,7 @@ modparam("debugger", "step_loops", 100) levels per module (e.g., if its set to 4, internal hash table has 16 slots). One must set it's value grater than 0 such that memory to be allocated to save the module specific debug levels or facility - configured by mod_level or mod_facility. This parameter is accesible + configured by mod_level or mod_facility. This parameter is accessible readonly via the Kamailio config framework. Default value is “0” - feature disabled. @@ -634,7 +634,7 @@ P-Hint: My hint Resets the message sequence ($mi). Internally there is no real change. This can be useful for unit test cases in order to be able to replicate exactly the same kamailio output. You need to set the debugger - parameter reset_msgid to 1 to activate this functionallity. + parameter reset_msgid to 1 to activate this functionality. Name: dbg.reset_msgid @@ -701,7 +701,7 @@ P-Hint: My hint A process blocked at a breakpoint is waiting for a command. Use 'dbg.bp next pid' to execute the current action and stop at the next one. 'dbg.bp eval pid PV' can be used to retrieve the value of PV. Once you - are done and want to continue the execution of the config wihtout + are done and want to continue the execution of the config without interaction use 'dbg.bp move pid'. Example of a session: diff --git a/src/modules/dialog/README b/src/modules/dialog/README index 03d531fb3c1..47b76d369c1 100644 --- a/src/modules/dialog/README +++ b/src/modules/dialog/README @@ -1170,7 +1170,7 @@ modparam("dialog", "send_bye", 1) 6.49. wait_ack (int) - If set to 1, dialog will be keept a bit longer in memory in order to + If set to 1, dialog will be kept a bit longer in memory in order to absorb the ACK negative replies of initial INVITE. If not, the dialog is destroyed when negative reply is sent out (less internal complexity). @@ -1417,9 +1417,10 @@ if (is_in_profile("caller","XX")) { Returns the number of dialogs belonging to a profile. If the profile supports values, the check can be reinforced to take into account a specific value, i.e. how many dialogs were inserted into the profile - with a specific value. If no value is passed, only the membersip of the - dialog in the profile per se is checked. Note that if the profile does - not support values, the value parameter will be silently discarded. + with a specific value. If no value is passed, only the membership of + the dialog in the profile per se is checked. Note that if the profile + does not support values, the value parameter will be silently + discarded. Meaning of the parameters is as follows: * profile - name of the profile to get the size for; @@ -2061,8 +2062,8 @@ Chapter 2. Developer Guide Meaning of parameters is as follows: * struct dlg_cell* dlg - dialog to terminate. - * str* hdrs - string containg extra headers (full format) to be added - to the BYE requests of the dialog. + * str* hdrs - string containing extra headers (full format) to be + added to the BYE requests of the dialog. Chapter 3. Frequently Asked Questions diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README index 058aa293795..6ea5b6f02aa 100644 --- a/src/modules/dispatcher/README +++ b/src/modules/dispatcher/README @@ -275,7 +275,7 @@ Chapter 1. Admin Guide This module offers SIP load balancer functionality and it can be used as SIP traffic dispatcher. There are many load balancing and traffic - dispaching algorithms that you can choose from, for example: + dispatching algorithms that you can choose from, for example: round-robin, weight based load balancing, call load distribution, and hashing over SIP message attributes. @@ -366,7 +366,7 @@ modparam("dispatcher", "list_file", "/var/run/kamailio/dispatcher.list") Example 1.2. Set “db_url” parameter ... -modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database") +modparam("dispatcher", "db_url", "mysql://user:passwd@localhost/database") ... 3.3. table_name (string) @@ -465,7 +465,7 @@ modparam("dispatcher", "force_dst", 1) If the parameter is set to 1, the last address in destination set is used as a final option to send the request to. For example, it is - useful when wanting to send the call to an anouncement server saying: + useful when wanting to send the call to an announcement server saying: "the gateways are full, try later". Default value is “0”. @@ -694,7 +694,7 @@ Note This parameter defines the valid response codes, which are accepted as a valid reply to the PING-Method. It is a list separated by colons, - whery you may define either a single code (e.g. "code=202" would accept + where you may define either a single code (e.g. "code=202" would accept 202 as an additional, valid response) or a class of responses, you want to accept (e.g. "class=2" would accept everything from 200 to 299 as valid response). This parameter can be modified via config framework. @@ -755,11 +755,11 @@ DEST: { FLAGS: AX PRIORITY: 9 LATENCY: { - AVG: 24.250000 # weigthed moving average for the last few weeks + AVG: 24.250000 # weighted moving average for the last few weeks STD: 1.035000 # standard deviation of AVG EST: 25.000000 # short term estimate, see parameter: ds_latency_ estimator_alpha - MAX: 26 # maximun value seen + MAX: 26 # maximum value seen TIMEOUT: 0 # count of ping timeouts } } @@ -774,7 +774,7 @@ estimator_alpha The value to be used to control the memory of the estimator EWMA "exponential weighted moving average" or "the speed at which the older - samples are dampened" a goog explanation can be found here : + samples are dampened" a good explanation can be found here : http://www.itl.nist.gov/div898/handbook/pmc/section3/pmc324.htm Because Kamailio doesn't support float parameter types, the value in the parameter is divided by 1000 and stored as float. For example, if you @@ -936,7 +936,7 @@ end It is the first column in destination list file. The parameter can be an integer or a variable holding an integer. * alg - the algorithm used to select the destination address. The - parameter can be an integer or a variable holding an interger. + parameter can be an integer or a variable holding an integer. + “0” - hash over callid + “1” - hash over from URI. + “2” - hash over to URI. @@ -984,7 +984,7 @@ end + “X” - if the algorithm is not implemented, the first entry in set is chosen. * limit - the maximum number of items to be stored in AVP list for - further failovers (the first selected destination and default + further fail-overs (the first selected destination and default destination are the first to be put in the list) This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. @@ -1710,8 +1710,8 @@ Chapter 2. Frequently Asked Questions Does dispatcher provide a fair distribution? - The algoritms doing hashing over parts of SIP message don't guarantee a - fair distribution. You should do some measurements to decide what + The algorithms doing hashing over parts of SIP message don't guarantee + a fair distribution. You should do some measurements to decide what hashing algorithm fits better in your environment. Other distribution algorithms such as round robin or call load diff --git a/src/modules/dmq/README b/src/modules/dmq/README index 3a15bfa0808..909443f69d1 100644 --- a/src/modules/dmq/README +++ b/src/modules/dmq/README @@ -129,7 +129,7 @@ Chapter 1. Admin Guide directly to a specific node). The system transparently deals with node discovery, consistency, retransmissions, etc. - Other entities ("peers") are then able to utlize the DMQ bus to pass + Other entities ("peers") are then able to utilize the DMQ bus to pass messages between themselves. Peers are grouped by name in order to ensure the correct messages are passed to the relevant peers. This grouping of peers can be compared to a topic in a typical pub/sub diff --git a/src/modules/dmq_usrloc/README b/src/modules/dmq_usrloc/README index 0c8e901f88f..3a05cbddfd2 100644 --- a/src/modules/dmq_usrloc/README +++ b/src/modules/dmq_usrloc/README @@ -99,7 +99,7 @@ Chapter 1. Admin Guide 3.1. enable (int) - The parameter controls whetner the replication is active or not. The + The parameter controls whether the replication is active or not. The value can be: * 0 - replication is disabled * 1 - replication is enabled @@ -113,7 +113,7 @@ modparam("dmq_usrloc", "enable", 1) 3.2. sync (int) - The parameter controls whetner to request synchronization of all usrloc + The parameter controls whether to request synchronization of all usrloc records at startup. The value can be: * 0 - disabled * 1 - enabled @@ -127,7 +127,7 @@ modparam("dmq_usrloc", "sync", 0) 3.3. batch_size (int) - The parameter controls whetner to throttle synchronization of all + The parameter controls whether to throttle synchronization of all contacts in batches. Once a batch of SIP requests is sent out, then sleep for 'batch_usleep' microseconds. The value can be: * <=0 - disabled (no batching) @@ -142,7 +142,7 @@ modparam("dmq_usrloc", "batch_size", 4000) 3.4. batch_usleep (int) - The parameter controls whetner to throttle synchronization of all + The parameter controls whether to throttle synchronization of all contacts in batches. Once a batch of SIP requests is sent out, then sleep for 'batch_usleep' microseconds. The value can be: * <=0 - no sleep (it disables the batching) diff --git a/src/modules/dnssec/README b/src/modules/dnssec/README index 0137c5a40ac..3e4d51089ef 100644 --- a/src/modules/dnssec/README +++ b/src/modules/dnssec/README @@ -45,10 +45,10 @@ Chapter 1. Admin Guide origin authentication of DNS data, authenticated denial of existence, and data integrity. - There is no module parameter that should be set nor fuction that has to - be executed by the configuration file. Existing SIP server deployments - can be updated to use DNSSEC by loading this module and setting - appropriate DNS server to the operating system. + There is no module parameter that should be set nor function that has + to be executed by the configuration file. Existing SIP server + deployments can be updated to use DNSSEC by loading this module and + setting appropriate DNS server to the operating system. Installing libval can be done from https://www.dnssec-tools.org. diff --git a/src/modules/domain/README b/src/modules/domain/README index 1cbd3658119..f7b0933583e 100644 --- a/src/modules/domain/README +++ b/src/modules/domain/README @@ -262,7 +262,7 @@ if (is_uri_host_local()) { 4.3. is_domain_local(domain) This function checks if the domain contained in the parameter is local. - The parameter can be a static string or contain pseduo-variables. + The parameter can be a static string or contain pseudo-variables. This function is a generalized form of the is_from_local() and is_uri_host_local() functions, being able to completely replace them diff --git a/src/modules/domainpolicy/README b/src/modules/domainpolicy/README index 29ad907372d..a943e10b973 100644 --- a/src/modules/domainpolicy/README +++ b/src/modules/domainpolicy/README @@ -498,7 +498,7 @@ mysql> select * from domainpolicy; A member of this federation (e.g. example.com) can not announce its SIP proxy's 10.x address in the standard SRV / A records of his domain, as this address is only meaningful for other members of this federation. - In order to facilite different IP address resolution paths within the + In order to facilitate different IP address resolution paths within the federation vs. outside the federation, all members of "http://l3fed.org/" agree to prefix the destination domains with "l3fed" before the SRV (or A) lookup. diff --git a/src/modules/drouting/README b/src/modules/drouting/README index 218609b6b5c..b24eb6c78dd 100644 --- a/src/modules/drouting/README +++ b/src/modules/drouting/README @@ -273,7 +273,7 @@ Chapter 1. Admin Guide destination list ( like: 2,4;5,78,23;4;7;2 ). The destinations from within a group may be act differently (like load-balancing, random selection, etc), depending of the “sort_order” module parameter - more - about this is available under the module paramters section. + about this is available under the module parameters section. 1.4.3. Routing Rules diff --git a/src/modules/enum/README b/src/modules/enum/README index 8cfd091153a..1de02049402 100644 --- a/src/modules/enum/README +++ b/src/modules/enum/README @@ -37,7 +37,7 @@ Otmar Lendl 1.1. Setting domain_suffix module parameter 1.2. Setting tel_uri_params module parameter 1.3. Setting i_enum_suffix module parameter - 1.4. Setting brachlabel module parameter + 1.4. Setting branchlabel module parameter 1.5. Zone file example 1.6. Zone file example 1.7. Setting the bl_algorithm module parameter @@ -108,7 +108,7 @@ Chapter 1. Admin Guide parameter starts with a '+' sign, the ENUM lookup also supports compound NAPTRs (e.g. "e2u+voice:sip+video:sip") and searching for multiple service types within one lookup. Multiple service types must - be separeted by a '+' sign. + be separated by a '+' sign. Most of the time you want to route based on the RURI. On rare occasions you may wish to route based on something else. The function @@ -180,7 +180,7 @@ modparam("enum", "i_enum_suffix", "e1234.arpa.") Default value is “"i"” - Example 1.4. Setting brachlabel module parameter + Example 1.4. Setting branchlabel module parameter modparam("enum", "branchlabel", "i") 3.5. bl_algorithm (string) diff --git a/src/modules/evrexec/README b/src/modules/evrexec/README index c259f43809e..02ae3c86b84 100644 --- a/src/modules/evrexec/README +++ b/src/modules/evrexec/README @@ -84,7 +84,7 @@ Chapter 1. Admin Guide The parameter can be set multiple times to get more exec tasks in same configuration file. * name - name of the event route to be executed. When used with a - KEMI embedded laguage, this has to be the name of a function from + KEMI embedded language, this has to be the name of a function from the KEMI script. The function must have a string parameter, which will retrieve the index of the works in string format. * workers - if set to 0 or 1 the task is executed in a dedicated diff --git a/src/modules/geoip/README b/src/modules/geoip/README index 46a1d464254..1ab9a0be06b 100644 --- a/src/modules/geoip/README +++ b/src/modules/geoip/README @@ -86,7 +86,7 @@ Chapter 1. Admin Guide Debian Linux squeeze includes already a database as dependency, but as this contain the wrong data, it will not work correctly with the - module. More acurate, the module expect the GeoIP City Edition, and + module. More accurate, the module expect the GeoIP City Edition, and will not work with the GeoIP Country Edition. In newer Debian Linux releases the package geoip-database-contrib should contain the necessary database. You can download the Lite edition of the DB from diff --git a/src/modules/gzcompress/README b/src/modules/gzcompress/README index b5393fb1911..0dcfd8d5cc2 100644 --- a/src/modules/gzcompress/README +++ b/src/modules/gzcompress/README @@ -87,7 +87,7 @@ Chapter 1. Admin Guide The immediate benefit of compressing the body is to reduce the size of the SIP message, increasing the chances to stay under MTU for UDP - packts. From observation, the compressed body is in between 50% to 67% + packets. From observation, the compressed body is in between 50% to 67% smaller than the original size (e.g., a body of 431 bytes was compressed to 230). @@ -145,7 +145,7 @@ modparam("gzcompress", "header_value", "gzip") If set to 1, gzcompress module will bind to sanity module in order to perform sanity checks over received SIP request. Default sanity checks - are done. It is useful to check if received request is well formated + are done. It is useful to check if received request is well formatted before proceeding to encoding/decoding. Default value is 0 (do not bind to sanity module). @@ -163,7 +163,7 @@ modparam("gzcompress", "sanity_checks", 1) Next example shows how to enable compression for forwarded requests, as well as replying with compressed body for HTTP requests. For SIP, the - request is recevied and forwarded to itself once, just for the sake of + request is received and forwarded to itself once, just for the sake of showing a simple example. Example 1.4. Enable body compression diff --git a/src/modules/htable/README b/src/modules/htable/README index fffa45a219d..a4c48fad203 100644 --- a/src/modules/htable/README +++ b/src/modules/htable/README @@ -209,11 +209,11 @@ $sht(a=>$ci::srcip) = $si; The next example shows a way to protect against dictionary attacks. If someone fails to authenticate 3 times, it is forbidden for 15 minutes. - Authenticatiion against database is expensive as it does a select on - the “subscriber” table. By disabling the DB auth for 15 minutes, - resources on the server are saved and time to discover the password is - increased substantially. Additional alerting can be done by writing a - message to syslog or sending email, etc. + Authentication against database is expensive as it does a select on the + “subscriber” table. By disabling the DB auth for 15 minutes, resources + on the server are saved and time to discover the password is increased + substantially. Additional alerting can be done by writing a message to + syslog or sending email, etc. To implement the logic, two hash table variables are used: one counting the failed authentications per user and one for storing the time of the @@ -759,7 +759,7 @@ sht_lock("ha=>test"); 4.8. sht_unlock(htable=>key) - Unlock the slot in htable corespoding to the key item. Note that the + Unlock the slot in htable corresponding to the key item. Note that the locking is re-entrant for the process, therefore the lock and unlock should be done by the same process. @@ -795,7 +795,7 @@ sht_iterator_start("i1", "h1"); 4.10. sht_iterator_end(iname) Close the iterator identified by iname parameter and release the hash - table slot aquired by the iterator. The iname value must be the same + table slot acquired by the iterator. The iname value must be the same used for sht_iterator_start(). The parameter can be dynamic string with variables. @@ -932,7 +932,7 @@ kamcmd htable.sets test x[0] abc # Set $sht(test=>x) as integer kamcmd htable.seti test x 123 -# Set firsti entry in array key x $sht(test=>x[0]) as integer +# Set first entry in array key x $sht(test=>x[0]) as integer kamcmd htable.sets test x[0] 123 ... diff --git a/src/modules/http_async_client/README b/src/modules/http_async_client/README index d61ae9c305e..e1b307ae76d 100644 --- a/src/modules/http_async_client/README +++ b/src/modules/http_async_client/README @@ -302,7 +302,7 @@ modparam("http_async_client", "tls_ca_path", "/etc/kamailio/ssl/ca/") 4.1. http_async_query(url, route_name) - Sends HTTP(S) request asyncronously to the URL given in “url” + Sends HTTP(S) request asynchronously to the URL given in “url” parameter, which is a string that may contain pseudo variables. Parameter “route_name” defines the route to be executed upon reception diff --git a/src/modules/http_client/README b/src/modules/http_client/README index 7f5718db5c1..182eb32a3f3 100644 --- a/src/modules/http_client/README +++ b/src/modules/http_client/README @@ -615,7 +615,7 @@ http_follow_redirect = no Sends HTTP GET or POST request to a given connection. For a POST request, content-type can be specified. - * connection - the name of an existing HTTP connection, definied by a + * connection - the name of an existing HTTP connection, defined by a httpcon modparam. url - the part of the URL to add to the predefined URL in the connection definition. @@ -655,7 +655,7 @@ xlog("L_INFO", "API-server HTTP connection: $avp(route) Result code $var(res)\n" to follow redirects (301,302) then the target URL, the result of the redirects can be retrieved with this function after a successful connection. - * connection - the name of an existing HTTP connection, definied by a + * connection - the name of an existing HTTP connection, defined by a httpcon modparam. result - The name of a pseudo variable that will contain the last used URL. diff --git a/src/modules/imc/README b/src/modules/imc/README index cf0a200fe64..4b1761f3efa 100644 --- a/src/modules/imc/README +++ b/src/modules/imc/README @@ -115,7 +115,7 @@ Chapter 1. Admin Guide conference's URI. To ease the integration in the configuration file, the interpreter of - the IMC commands are embeded in the module. From a configuration point + the IMC commands are embedded in the module. From a configuration point of view, there is only one function which has to be executed for both messages and commands. diff --git a/src/modules/ims_auth/README b/src/modules/ims_auth/README index 96695fe862d..42e8b0bd56d 100644 --- a/src/modules/ims_auth/README +++ b/src/modules/ims_auth/README @@ -149,7 +149,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules - The Following mouldes must be loaded before this module: + The Following modules must be loaded before this module: * TM - Transaction Manager * CDP - C Diameter Peer * CDP_AVP - CDP AVP Applications @@ -339,7 +339,7 @@ modparam("ims_auth", "add_authinfo_hdr", 0) It should be used only for testing, e.g. load balancing with SIPP where we don't want to worry about auth. - Default value is “0” (don't ingnore the failed authentication). + Default value is “0” (don't ignore the failed authentication). Example 1.14. ignore_failed_auth parameter usage ... @@ -432,7 +432,7 @@ if (!www_authorize("kamailio.org", "subscriber")) { * 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. - It must not be empty string “”. Apart of a static strinh, typical + 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 the request. From header field domain will be used as realm. @@ -476,7 +476,7 @@ e\n"); 4.4. ims_www_challenge(route_block, realm, algorithm) - Same as 4.3 except here there is the addiional option to specify the + Same as 4.3 except here there is the additional option to specify the authorisation algorithm * algorithm - The algorithm to be used when challenging the client. Can be AKAv1-MD5, AKAv2-MD5, MD5, or HSS-Selected. If left as an @@ -525,7 +525,7 @@ Unauthorized * 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. - It must not be empty string “”. Apart of a static strinh, typical + 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 the request. From header field domain will be used as realm. diff --git a/src/modules/ims_charging/README b/src/modules/ims_charging/README index 2d26fbaa4f4..ec8dd1118b7 100644 --- a/src/modules/ims_charging/README +++ b/src/modules/ims_charging/README @@ -75,9 +75,9 @@ Carlos Ruiz Diaz 6.1. Initial CCRs (initial_ccrs) 6.2. Interim CCRs (interim_ccrs) 6.3. Final CCRs (final_ccrs) - 6.4. Sucessful initial CCRs (successful_initial_ccrs) - 6.5. Sucessful interim CCRs (successful_interim_ccrs) - 6.6. Sucessful final CCRs (successful_final_ccrs) + 6.4. Successful initial CCRs (successful_initial_ccrs) + 6.5. Successful interim CCRs (successful_interim_ccrs) + 6.6. Successful final CCRs (successful_final_ccrs) 6.7. Failed initial CCRs (failed_initial_ccrs) 6.8. Failed interim CCRs (failed_interim_ccrs) 6.9. Failed final CCRs (failed_final_ccrs) @@ -173,9 +173,9 @@ Chapter 1. Admin Guide 6.1. Initial CCRs (initial_ccrs) 6.2. Interim CCRs (interim_ccrs) 6.3. Final CCRs (final_ccrs) - 6.4. Sucessful initial CCRs (successful_initial_ccrs) - 6.5. Sucessful interim CCRs (successful_interim_ccrs) - 6.6. Sucessful final CCRs (successful_final_ccrs) + 6.4. Successful initial CCRs (successful_initial_ccrs) + 6.5. Successful interim CCRs (successful_interim_ccrs) + 6.6. Successful final CCRs (successful_final_ccrs) 6.7. Failed initial CCRs (failed_initial_ccrs) 6.8. Failed interim CCRs (failed_interim_ccrs) 6.9. Failed final CCRs (failed_final_ccrs) @@ -202,7 +202,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules - The Following mouldes must be loaded before this module: + The Following modules must be loaded before this module: * ims_dialog * TM - Transaction Manager * CDP - C Diameter Peer @@ -244,7 +244,7 @@ Chapter 1. Admin Guide 3.1. Offline Charging (Rf) - For the offlinc charging (Rf), we have the following two + For the offline charging (Rf), we have the following two diameter-messages: * ACR - Accounting Request * ACA - Accounting Answer @@ -380,7 +380,7 @@ modparam("ims_charging", "hash_size", 1024) 4.2. interim_update_credits(int) How much credit should be requested interim request? At the start of - the call, we request the amout of seconds as per Command. For each + the call, we request the amount of seconds as per Command. For each interim request, we would request credit for "interim_update_credits". Default value is 30. @@ -703,7 +703,7 @@ incoming_trunk_id, outgoing_trunk_id * route_name route to be executed upon reception of charging requests * direction "orig"inating or "term"inating * reservation_units how many units (at the moment seconds) should be - reservated at the moment. + reserved at the moment. * domain Logical domain within registrar. * incoming_trunk_id Identifies the trunk group from which this originates. @@ -762,9 +762,9 @@ n"); 6.1. Initial CCRs (initial_ccrs) 6.2. Interim CCRs (interim_ccrs) 6.3. Final CCRs (final_ccrs) - 6.4. Sucessful initial CCRs (successful_initial_ccrs) - 6.5. Sucessful interim CCRs (successful_interim_ccrs) - 6.6. Sucessful final CCRs (successful_final_ccrs) + 6.4. Successful initial CCRs (successful_initial_ccrs) + 6.5. Successful interim CCRs (successful_interim_ccrs) + 6.6. Successful final CCRs (successful_final_ccrs) 6.7. Failed initial CCRs (failed_initial_ccrs) 6.8. Failed interim CCRs (failed_interim_ccrs) 6.9. Failed final CCRs (failed_final_ccrs) @@ -787,15 +787,15 @@ n"); The number of CCRs sent to terminate a session. -6.4. Sucessful initial CCRs (successful_initial_ccrs) +6.4. Successful initial CCRs (successful_initial_ccrs) Initial CCRs that ended with DIAMETER_SUCCESS response code. -6.5. Sucessful interim CCRs (successful_interim_ccrs) +6.5. Successful interim CCRs (successful_interim_ccrs) Interim CCRs that ended with DIAMETER_SUCCESS response code. -6.6. Sucessful final CCRs (successful_final_ccrs) +6.6. Successful final CCRs (successful_final_ccrs) Final CCRs that ended with DIAMETER_SUCCESS response code. diff --git a/src/modules/ims_dialog/README b/src/modules/ims_dialog/README index 5ed5f79315d..40f9dd9bd5b 100644 --- a/src/modules/ims_dialog/README +++ b/src/modules/ims_dialog/README @@ -1006,8 +1006,8 @@ Chapter 2. Developer Guide * str* callid - callid of dialog to terminate. * str* ftag - from_tag of dialog to terminate. * str* ttag - to tag of dialog to terminate. - * str* hdrs - string containg extra headers (full format) to be added - to the BYE requests of the dialog. + * str* hdrs - string containing extra headers (full format) to be + added to the BYE requests of the dialog. 1.3. lookup_terminate_dlg (unsigned int h_entry, unsigned int h_id, hdrs) @@ -1019,8 +1019,8 @@ Chapter 2. Developer Guide dialog * unsigned int h_id - Number of the entry in the table, where to find the dialog terminate. - * str* hdrs - string containg extra headers (full format) to be added - to the BYE requests of the dialog. + * str* hdrs - string containing extra headers (full format) to be + added to the BYE requests of the dialog. 1.4. set_dlg_var (dlg, key, val) @@ -1063,7 +1063,7 @@ Chapter 3. Frequently Asked Questions Why is there a ims_dialog module and a dialog module? - The ims_dialog module addresses shortcomings in the intial dialog + The ims_dialog module addresses shortcomings in the initial dialog module design. It makes some large changes to the API and therefore must be introduced slowly. It is currently in the early development stages. Eventually the ims_dialog module should replace the dialog diff --git a/src/modules/ims_icscf/README b/src/modules/ims_icscf/README index 926a5648123..105e352f796 100644 --- a/src/modules/ims_icscf/README +++ b/src/modules/ims_icscf/README @@ -232,7 +232,7 @@ modparam("ims_icscf", "preferred_scscf_uri", "sip:scscf.ims.smilecoms.com:6060") 4.1. I_scscf_select(initial) - This function is used to retrieve the next unused SCSCF from thelist + This function is used to retrieve the next unused SCSCF from the list for this request (based on callid). A positive return code (1) means an SCSCF was found and is armed for @@ -271,8 +271,8 @@ I_scscf_drop(); Perform a UAR on Diameter CXDX interface. This function will build a list of SCSCFs to be used and populate the SCSCF list for the request. - On a succesful return of this message you can get the next available - SCSCF by using the I_scscf_select functoin in 4.1. + On a successful return of this message you can get the next available + SCSCF by using the I_scscf_select function in 4.1. * Route block to resume after async UAR Diameter reply. * capabilities - whether to request capabilities or not "1" - with capabilities, "0" - no capabilities. diff --git a/src/modules/ims_ocs/README b/src/modules/ims_ocs/README index 09c2eab7b45..66647a0d454 100644 --- a/src/modules/ims_ocs/README +++ b/src/modules/ims_ocs/README @@ -82,7 +82,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules - The Following mouldes must be loaded before this module: + The Following modules must be loaded before this module: * CDP - C Diameter Peer * CDP_AVP - CDP AVP Applications @@ -116,7 +116,7 @@ Chapter 1. Admin Guide Interim and Stop Events) * P-Access-Network-Info - The used access network - if available * P-Service-Identifier - The service identifier, if you want to - diffentiate different services (e.g. Audio and Video) + differentiate different services (e.g. Audio and Video) 4. Functions @@ -133,7 +133,7 @@ Chapter 1. Admin Guide + “5030” - User unknown + “5031” - Rating failed + “4010” - End-User Service denied (e.g. Service blocked) - + “5006” - Ressources exceeded (e.g. too many concurrent calls) + + “5006” - Resources exceeded (e.g. too many concurrent calls) * grantedunits - the number of granted units for this particular user * finalunit - indication, that all following requests will be denied (this is the final unit for the session) diff --git a/src/modules/ims_qos/README b/src/modules/ims_qos/README index b1423ee97e0..00b854157ef 100644 --- a/src/modules/ims_qos/README +++ b/src/modules/ims_qos/README @@ -145,7 +145,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules - The Following mouldes must be loaded before this module: + The Following modules must be loaded before this module: * Dialog2 * Usrloc PCSCF * TM - Transaction Manager diff --git a/src/modules/ims_registrar_pcscf/README b/src/modules/ims_registrar_pcscf/README index ec90c6963eb..8d9e8563a4b 100644 --- a/src/modules/ims_registrar_pcscf/README +++ b/src/modules/ims_registrar_pcscf/README @@ -118,7 +118,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules - The Following mouldes must be loaded before this module: + The Following modules must be loaded before this module: * Usrloc PCSCF * PUA - if reginfo is used. @@ -315,7 +315,7 @@ pcscf_save("location"); 4.3. pcscf_follows_service_routes(domain) Returns true, if the request is following the "learned" service-routes - during registratin. + during registration. Meaning of the parameters is as follows: * domain - Logical domain within the registrar. If a database is used diff --git a/src/modules/ims_registrar_scscf/README b/src/modules/ims_registrar_scscf/README index 3401e825ef8..b55e9e6f60b 100644 --- a/src/modules/ims_registrar_scscf/README +++ b/src/modules/ims_registrar_scscf/README @@ -239,8 +239,8 @@ Chapter 1. Admin Guide random value in the intervalrdq [default_expires-default_expires_range%, default_expires+default_expires_range%]. The value is between 0 and 100 - and represent the maximim percentage from default_expires that will be - substracted or added when computing the value. Default in 0, meaning + and represent the maximum percentage from default_expires that will be + subtracted or added when computing the value. Default in 0, meaning default_expires is left unmodified. This parameter can be modified via ser config framework. @@ -302,8 +302,8 @@ om default_expires but a random value in the interval [subscription_default_expires-subscription_expires_range%, subscription_default_expires+subscription_expires_range%]. The value is - between 0 and 100 and represent the maximim percentage from - subscription_default_expires that will be substracted or added when + between 0 and 100 and represent the maximum percentage from + subscription_default_expires that will be subtracted or added when computing the value. Default in 0, meaning subscription_default_expires is left unmodified. @@ -547,7 +547,7 @@ if (!impu_registered("location")) { * -1 - Not found * -2 - Found, but method not allowed (check Allows header for INVITE, MESSAGE, etc). - * -3 - Error ocurred internally during processing + * -3 - Error occurred internally during processing This function can be used from REQUEST_ROUTE, FAILURE_ROUTE diff --git a/src/modules/ims_usrloc_pcscf/README b/src/modules/ims_usrloc_pcscf/README index f9173f7e432..2ceaed80f20 100644 --- a/src/modules/ims_usrloc_pcscf/README +++ b/src/modules/ims_usrloc_pcscf/README @@ -91,12 +91,12 @@ Chapter 1. Admin Guide the standard Kamailio module, usrloc, is a storage engine for standard SIP contacts. The concept of a contact in IMS, PCSCF specifically, is very different to that of std. SIP and as a result we have built this - new module. Alot of the design has been borrowed from the std. usrloc + new module. A lot of the design has been borrowed from the std. usrloc module. For example. An IMS contact, in PCSCF, needs things like: * Diameter Rx session for signalling bearer status. i.e. this is effectively QoS from the network to make sure the signalling link can be 'trusted' - * IPSEC Security Assocation for secure signalling between UE and + * IPSEC Security Association for secure signalling between UE and PCSCF (first point of contact) * IMPU, each contact can have a number of associated public identities (IMPU). @@ -170,7 +170,7 @@ modparam("ims_usrloc_pcscf", "db_url", * 0 - This disables DB mode. Only memory will be used for usrloc and data will not survive a restart. * 1 - Write-Through Scheme. All changes to usrloc are immediately - refelcted in the database. This is slow but very reliable. This + reflected in the database. This is slow but very reliable. This mode will ensure that no registration data is lost as a result of a restart or crash. diff --git a/src/modules/ipops/README b/src/modules/ipops/README index a8121ccd3bb..fef1be2220d 100644 --- a/src/modules/ipops/README +++ b/src/modules/ipops/README @@ -302,7 +302,7 @@ switch($rc) { Return value: * 1 - successful operation - * negative value - error occured + * negative value - error occurred This function can be used from ALL ROUTES @@ -326,7 +326,7 @@ switch($rc) { Return value: * 1 - successful operation - * negative value - error occured + * negative value - error occurred This function can be used from ALL ROUTES @@ -354,7 +354,7 @@ switch($rc) { Return value: * 1 - successful operation - * negative value - error occured + * negative value - error occurred This function can be used from ALL ROUTES @@ -483,7 +483,7 @@ if (!dns_sys_match_ip("myhost.com", "1.2.3.4")) { because the internal resolver targets to discover the first address to be used for relaying SIP traffic. Thus is better to use dns_sys_match_ip() if the host you want to check has many IP addresses, - in different address famililies (IPv4/6). + in different address families (IPv4/6). Parameters: * hostname - string or pseudo-variable containing the hostname. The diff --git a/src/modules/jansson/README b/src/modules/jansson/README index 6feb5983944..b79a31ba826 100644 --- a/src/modules/jansson/README +++ b/src/modules/jansson/README @@ -43,7 +43,7 @@ Carsten Bock 1.2. jansson_set usage 1.3. jansson_append usage 1.4. jansson_array_size usage - 1.5. array concatination + 1.5. array concatenation 1.6. jansson_get_field usage Chapter 1. Admin Guide @@ -127,7 +127,7 @@ xlog("L_INFO", "foo is $var(n)"); The path string works the same as in jansson_get. Valid 'type' parameters are 'integer', 'real', 'string', 'object', - 'array', 'true', 'false', and 'null' as well as abbriviated names such + 'array', 'true', 'false', and 'null' as well as abbreviated names such as 'int', 'str', and 'obj'. 'value' is ignored when type is 'true', 'false', or 'null'. @@ -212,7 +212,7 @@ while($var(count) < $var(size)) { } ... - Example 1.5. array concatination + Example 1.5. array concatenation ... $var(count) = 0; $var(appendme) = '[0,1]'; diff --git a/src/modules/janssonrpcc/README b/src/modules/janssonrpcc/README index 1a33053f2bd..64f1ccb8946 100644 --- a/src/modules/janssonrpcc/README +++ b/src/modules/janssonrpcc/README @@ -81,10 +81,10 @@ Chapter 1. Admin Guide It uses t_suspend() and t_continue() from the TM module for asynchronous processing. - Note that after invoking an asyncronous operation, the processing will + Note that after invoking an asynchronous operation, the processing will continue later, in another application process. Therefore, do not rely on variables stored in private memory, use shared memory if you want to - get values after the processing is resumend (e.g., $shv(...) or htable + get values after the processing is resumed (e.g., $shv(...) or htable $sht(...)). 2. Dependencies @@ -130,7 +130,7 @@ modparam("janssonrpcc", "min_srv_ttl", 30) 3.2. result_pv (string) The PV spec where to store the result of a call to - janssonrpc_request(). It can be any writtable PV. + janssonrpc_request(). It can be any writable PV. Default value is “$var(jsrpc_result)”. @@ -174,7 +174,7 @@ modparam("janssonrpcc", "server", "conn=user_db;addr=rpc.prod.exmaple.net;port=5 This will only be used if there is no route specified for the request. - An error code can be any interger, but is typically a negative number. + An error code can be any integer, but is typically a negative number. An error code range is delimited by ".." . For example, "-32099..-32000". @@ -228,7 +228,7 @@ janssonrpc_notification("user_db", "update_user", '{"id": 1234, "name": "Daniel" optional. + retry - number of times you retry a failed request. -1 means retry forever. Default is 0. Request will be retried if they - either timeout or fail to send. Retries untilize exponential + either timeout or fail to send. Retries utilize exponential back off between successive retries, up to 60 seconds. The equation for time between retries is: time = n^2 * timeout (for time < 60 seconds) @@ -240,7 +240,7 @@ janssonrpc_notification("user_db", "update_user", '{"id": 1234, "name": "Daniel" in the route specified. If no route is specified, then any errors are logged and successes are - ignored. The function will also not interupt script execution. + ignored. The function will also not interrupt script execution. Since the SIP request handling is resumed in another process, the config file execution is lost. Only shared variables ($shv, $avp, etc) diff --git a/src/modules/jsonrpcc/README b/src/modules/jsonrpcc/README index 8cdb2f2e8ad..9a617795006 100644 --- a/src/modules/jsonrpcc/README +++ b/src/modules/jsonrpcc/README @@ -69,10 +69,10 @@ Chapter 1. Admin Guide This module uses t_suspend() and t_continue() from the TM module. - Note that after invoking an asyncronous operation, the processing will + Note that after invoking an asynchronous operation, the processing will continue later, in another application process. Therefore, do not rely on variables stored in private memory, use shared memory if you want to - get values after the processing is resumend (e.g., $shv(...) or htable + get values after the processing is resumed (e.g., $shv(...) or htable $sht(...)). 2. Dependencies diff --git a/src/modules/jsonrpcs/README b/src/modules/jsonrpcs/README index d615babde52..af8df918800 100644 --- a/src/modules/jsonrpcs/README +++ b/src/modules/jsonrpcs/README @@ -325,7 +325,7 @@ modparam("jsonrpcs", "dgram_user", "root") 4.13. dgram_timeout (int) The reply will expire after trying to sent it for socket_timeout - miliseconds. + milliseconds. Default value is 2000. @@ -464,7 +464,7 @@ jsonrpc_exec('{"jsonrpc": "2.0", "method": "dispatcher.reload", "id": 1}'); 7.2. JSONRPC Over FIFO - This module can retrive JSONRPC requests via a local FIFO file. To + This module can retrieve JSONRPC requests via a local FIFO file. To enable this feature, 'fifo_name' parameter must be set and 'transport' parameter has to be 0 or 2. @@ -499,7 +499,7 @@ rm /tmp/kamailio_jsonrpc_reply_fifo 7.3. JSONRPC Over DATAGRAM - This module can retrive JSONRPC requests via a UNIX socket file or UDP + This module can retrieve JSONRPC requests via a UNIX socket file or UDP IPv4/IPv6 socket. To enable this feature, 'dgram_socket' parameter must be set and 'transport' parameter has to be 0 or 4. diff --git a/src/modules/kazoo/README b/src/modules/kazoo/README index 2a66143a92a..9989710d6c6 100644 --- a/src/modules/kazoo/README +++ b/src/modules/kazoo/README @@ -21,7 +21,7 @@ Luis Azedo 2. How it works 2.1. event routes - 2.2. aknowledge messages + 2.2. acknowledge messages 3. Dependencies @@ -51,7 +51,7 @@ Luis Azedo 4.3.1. amqp_consumer_ack_timeout(str) 4.3.2. amqp_interprocess_timeout(str) - 4.3.3. amqp_waitframe_tiemout(str) + 4.3.3. amqp_waitframe_timeout(str) 4.3.4. amqp_query_timeout(str) 4.3.5. amqp_query_timeout_avp(str) @@ -128,7 +128,7 @@ Chapter 1. Admin Guide 2. How it works 2.1. event routes - 2.2. aknowledge messages + 2.2. acknowledge messages 3. Dependencies @@ -158,7 +158,7 @@ Chapter 1. Admin Guide 4.3.1. amqp_consumer_ack_timeout(str) 4.3.2. amqp_interprocess_timeout(str) - 4.3.3. amqp_waitframe_tiemout(str) + 4.3.3. amqp_waitframe_timeout(str) 4.3.4. amqp_query_timeout(str) 4.3.5. amqp_query_timeout_avp(str) @@ -221,7 +221,7 @@ Chapter 1. Admin Guide 2. How it works 2.1. event routes - 2.2. aknowledge messages + 2.2. acknowledge messages The module works with a main forked process that does the communication with rabbitmq for issuing publishes, waiting for replies and consuming @@ -285,7 +285,7 @@ event_route[kazoo:consumer-event] # this event route is executed if we can't find the previous } -2.2. aknowledge messages +2.2. acknowledge messages Consumed messages have the option of being acknowledge in two ways: * immediately when received @@ -330,7 +330,7 @@ event_route[kazoo:consumer-event] 4.3.1. amqp_consumer_ack_timeout(str) 4.3.2. amqp_interprocess_timeout(str) - 4.3.3. amqp_waitframe_tiemout(str) + 4.3.3. amqp_waitframe_timeout(str) 4.3.4. amqp_query_timeout(str) 4.3.5. amqp_query_timeout_avp(str) @@ -495,7 +495,7 @@ modparam("kazoo", "single_consumer_on_reconnect", 0) 4.3.1. amqp_consumer_ack_timeout(str) - Timeout when checking for aknowledge from workers. + Timeout when checking for acknowledge from workers. Default value is 100000 micro. @@ -518,7 +518,7 @@ modparam("kazoo", "amqp_interprocess_timeout_sec", 1) modparam("kazoo", "amqp_interprocess_timeout_micro", 200000) ... -4.3.3. amqp_waitframe_tiemout(str) +4.3.3. amqp_waitframe_timeout(str) Timeout when checking for messages from rabbitmq. diff --git a/src/modules/keepalive/README b/src/modules/keepalive/README index 2600d018d9c..7defb322ce2 100644 --- a/src/modules/keepalive/README +++ b/src/modules/keepalive/README @@ -196,7 +196,7 @@ Chapter 2. Developer Guide Returned values: * 0 if ok - * -1 if an error occured + * -1 if an error occurred 1.2. Examples diff --git a/src/modules/kex/README b/src/modules/kex/README index 30aeea29e54..cd61ff61a93 100644 --- a/src/modules/kex/README +++ b/src/modules/kex/README @@ -320,7 +320,7 @@ resetbflag("1"); * uri - Valid SIP URI representing the address where to send the request. It must be a static string, no variables are evaluated at runtime. If you need to set outbound proxy address via a variable, - use assginment to $du. + use assignment to $du. This function can be used from ANY_ROUTE. @@ -356,7 +356,7 @@ if(isdsturiset()) 3.10. pv_printf(var, str) - Evalues the str and sets the resulting value to variable var. For + Evaluates the str and sets the resulting value to variable var. For backward compatibility reasons, the same function can be executed via 'avp_printf(var, str)'. @@ -614,7 +614,7 @@ kamcmd core.modules 4.22. pkg.stats Print private memory (pkg) usage statistics per process. It can take - optinally a filter to print statistics only for a specific process or + optionally a filter to print statistics only for a specific process or set of processes. If no filter is given, it prints statistics for all processes. @@ -715,7 +715,7 @@ kamcmd system.listMethods module or by all modules. NOTE: Processing is done only when the command is issued and involves - iterating throug the list of memory fragments and printing details + iterating through the list of memory fragments and printing details about them. NOTE: Only the module functions that directly calls shm_alloc or diff --git a/src/modules/lcr/README b/src/modules/lcr/README index aca7e6d6a2e..8fabc116ad3 100644 --- a/src/modules/lcr/README +++ b/src/modules/lcr/README @@ -697,7 +697,7 @@ modparam("lcr","weight_column", "target_weight") 3.28. lcr_count (integer) - Maximun value of lcr_id. + Maximum value of lcr_id. Default value is 1. @@ -764,7 +764,7 @@ modparam("lcr", "flags_avp", "$avp(i:712)") URI userpart to a mtree given as mtree parameter. If defined, must have the same value as mtree module pv_values - paramater. + parameter. There is NO default value. diff --git a/src/modules/ldap/README b/src/modules/ldap/README index 2249686988d..c7555ca3c60 100644 --- a/src/modules/ldap/README +++ b/src/modules/ldap/README @@ -546,7 +546,7 @@ ldap_result("telephoneNumber/$avp(s:tel_number)"); $avp(i:12) avp_type - Opional specification of destination AVP type, either str or + Optional specification of destination AVP type, either str or int. If this parameter is not specified then the LDAP attribute values are stored as AVP of type string. @@ -615,7 +615,7 @@ ldap_result("SIPIdentitySIPURI/$avp(i:10)", "/^[^@]+@(.+)$/\1/"); e.g. SIPIdentitySIPURI string_to_match - String to be matched. Included AVPs and pseudo variabels do get + String to be matched. Included AVPs and pseudo variables do get expanded. regex_subst @@ -727,7 +727,7 @@ if (ldap_result_next()) Function Parameters: string - String to apply RFC 4515 and URL escpaing rules to. AVPs and + String to apply RFC 4515 and URL escaping rules to. AVPs and pseudo variables do get expanded. Example: "cn=$avp(s:name)" avp_spec diff --git a/src/modules/malloc_test/README b/src/modules/malloc_test/README index df3bd001177..3a25dc5918c 100644 --- a/src/modules/malloc_test/README +++ b/src/modules/malloc_test/README @@ -226,14 +226,14 @@ mem_free(); 4.6. mt.mem_test_stop id - Stops the test indentified by id. + Stops the test identified by id. Example 1.10. mt.mem_test_stop usage $ kamcmd mt.mem_test_stop 1 4.7. mt.mem_test_destroy id - Destroys the test indentified by id (besides stopping it, it also frees + Destroys the test identified by id (besides stopping it, it also frees all the data, including the statistics). Example 1.11. mt.mem_test_destroy usage diff --git a/src/modules/matrix/README b/src/modules/matrix/README index 65054404092..ffd0bbd6d7b 100644 --- a/src/modules/matrix/README +++ b/src/modules/matrix/README @@ -101,7 +101,7 @@ Chapter 1. Admin Guide 1. Overview The matrix module can be used to arbitrary lookup operations over an - array. One possible usecase is to define which routing tree should be + array. One possible use-case is to define which routing tree should be used depending on the preferred carrier of the source number and the carrier id of the destination number. The matrix cells are read from a database and can be reloaded using a FIFO command. You do not have to diff --git a/src/modules/maxfwd/README b/src/modules/maxfwd/README index e18aa9b61af..2b382a00704 100644 --- a/src/modules/maxfwd/README +++ b/src/modules/maxfwd/README @@ -131,7 +131,7 @@ modparam("maxfwd", "max_limit", 32) (if not 0). The parameter can be a variable. Return codes: - * 2 (true) - header was not found and a new header was succesfully + * 2 (true) - header was not found and a new header was successfully added. * 1 (true) - header was found and its value was successfully decremented (had a non-0 value). @@ -139,7 +139,7 @@ modparam("maxfwd", "max_limit", 32) decremented). * -2 (false) - error during processing. - The return code may be extensivly tested via script variable “retcode” + The return code may be extensively tested via script variable “retcode” (or “$?”). Meaning of the parameters is as follows: @@ -173,14 +173,14 @@ if (!maxfwd_process("10") && $retcode==-1) { (if locally added). The parameter can be a variable. Retuning codes: - * 1 (true) - header was found or set and its value is stricly less + * 1 (true) - header was found or set and its value is strictly less than “max_value”. * -1 (false) - the header was found or set and its value is greater or equal to “max_value”. * -2 (false) - header was not found or not set. * -3 (false) - error during processing. - The return code may be extensivly tested via script variable “retcode” + The return code may be extensively tested via script variable “retcode” (or “$?”). Meaning of the parameters is as follows: diff --git a/src/modules/mediaproxy/README b/src/modules/mediaproxy/README index 7be9930e9c5..26960179ecf 100644 --- a/src/modules/mediaproxy/README +++ b/src/modules/mediaproxy/README @@ -251,7 +251,7 @@ modparam("mediaproxy", "media_relay_avp", "$avp(media_relay)") Indicates the type of ICE candidate that will be added to the SDP. It can take 3 values: 'none', 'low-priority' or 'high-priority'. If 'none' - is selected no candidate will be adeed to the SDP. If 'low-priority' is + is selected no candidate will be added to the SDP. If 'low-priority' is selected then a low priority candidate will be added and if 'high-priority' is selected a high priority one. diff --git a/src/modules/memcached/README b/src/modules/memcached/README index b10d4e39e18..5547341c94a 100644 --- a/src/modules/memcached/README +++ b/src/modules/memcached/README @@ -124,8 +124,8 @@ xlog("stored value is $mct(test)"); # will return replacement. In smaller architectures or installations where only one instance needs access to the hash table the htable module is easier to setup, as no dedicated server needs to be provided. But when a - distributed storage facilility is necessary, or one want to separate - the storage from the SIP server, this module could be used. + distributed storage facility is necessary, or one want to separate the + storage from the SIP server, this module could be used. 2. Implementation notes @@ -209,7 +209,7 @@ modparam("memcached", "servers", "localhost:11211") space in memory is exhausted. It is possible to override this default value when adding a key with - the mct psuedo-variable, or later on by setting a different timeout for + the mct pseudo-variable, or later on by setting a different timeout for an existing key with the mctex pseudo-variable. Default value is “10800”s (3h). diff --git a/src/modules/misc_radius/README b/src/modules/misc_radius/README index c5d41f59cd1..129ca733c76 100644 --- a/src/modules/misc_radius/README +++ b/src/modules/misc_radius/README @@ -47,7 +47,7 @@ Daniel-Constantin Mierla List of Examples - 1.1. “SIP-AVP” RADIUS AVP exmaples + 1.1. “SIP-AVP” RADIUS AVP examples 1.2. radius_config parameter usage 1.3. caller_service_type parameter usage 1.4. callee_service_type parameter usage @@ -113,7 +113,7 @@ Chapter 1. Admin Guide * SIP_AVP_NAME = STRING_NAME | '#'ID_NUMBER * SIP_AVP_VALUE = ':'STRING_VALUE | '#'NUMBER_VALUE - Example 1.1. “SIP-AVP” RADIUS AVP exmaples + Example 1.1. “SIP-AVP” RADIUS AVP examples .... "email:joe@yahoo.com" -> STRING NAME AVP (email) with STRING VALUE (joe@yahoo.com) @@ -338,7 +338,7 @@ $avp(SIP-AVP) has string value "email:sr-users@lists.sip-router.org session-tim eout#161 next-hop-ip:h323/0001111@myvoip-gate.kamailio.org" ... - When recieving negative response, check appropriate avp's: + When receiving negative response, check appropriate avp's: $avp(Reply-Message) = "Not enough money on deposit '-89.83'. Rejected" $avp(Filter-Id) = "neg_deposit" ... diff --git a/src/modules/mohqueue/README b/src/modules/mohqueue/README index 1122301663c..6ccd7b51184 100644 --- a/src/modules/mohqueue/README +++ b/src/modules/mohqueue/README @@ -422,7 +422,7 @@ $var(mohq) = "operators"; 7.1. mohqueue.debug - Turns debugging on or off for a queue. The first paramater is the queue + Turns debugging on or off for a queue. The first parameter is the queue name and the second is a number indicating whether debugging should be turned off or on (0=off, <>0=on). @@ -436,7 +436,7 @@ rpc.debug main 0 7.2. mohqueue.drop_call - Drops a call from a queue. The first paramater is the queue name and + Drops a call from a queue. The first parameter is the queue name and the second is the call ID. Using a call ID of "*" (asterisk) drops all calls from the queue. diff --git a/src/modules/mqueue/README b/src/modules/mqueue/README index 7615f903812..118cc534c8f 100644 --- a/src/modules/mqueue/README +++ b/src/modules/mqueue/README @@ -130,7 +130,7 @@ Chapter 1. Admin Guide + name: name of the queue. * Optional attributes: + size: size of the queue. Specifies the maximum number of items - in queue. If execeeded the oldest one is removed. If not set + in queue. If exceeded the oldest one is removed. If not set the queue will be limitless. The parameter can be set many times, each holding the definition of one diff --git a/src/modules/msilo/README b/src/modules/msilo/README index 5d4ff2146d3..0472947dcff 100644 --- a/src/modules/msilo/README +++ b/src/modules/msilo/README @@ -598,8 +598,8 @@ modparam("msilo", "max_messages", 0) 3.28. add_contact (int) - Wheter to add contact header to generated messages. The contact address - is the From URI. + Whether to add contact header to generated messages. The contact + address is the From URI. Default value is “0” (1==on; 0==off as per RFC3428). @@ -668,7 +668,7 @@ m_store("$tu"); 4.2. m_dump([owner]) - The method sends stored messages for the SIP user that has registerered + The method sends stored messages for the SIP user that has registered to the contact address in the registration. The method should be called when a REGISTER request is received and the “Expire” header has a value greater than zero. diff --git a/src/modules/mtree/README b/src/modules/mtree/README index 4dd2845b35d..36d3fee7500 100644 --- a/src/modules/mtree/README +++ b/src/modules/mtree/README @@ -195,7 +195,7 @@ modparam("mtree", "db_table", "mtrees") 3.3. mtree (string) - Definition of memory tree with using a prameters format string. The + Definition of memory tree with using a parameters format string. The parameter names can be: * name - the name of the tree to be used for referencing inside configuration file. diff --git a/src/modules/nat_traversal/README b/src/modules/nat_traversal/README index c3054862e49..c134b9e14be 100644 --- a/src/modules/nat_traversal/README +++ b/src/modules/nat_traversal/README @@ -507,7 +507,7 @@ tate") Check if the client is behind NAT. What tests are performed is specified by the type parameter which is an integer given by the sum of - the numbers corresponsing to the tests that one wishes to perform. The + the numbers corresponding to the tests that one wishes to perform. The numbers corresponding to individual tests are shown below: * 1 - tests if client has a private IP address (as defined by @@ -536,7 +536,7 @@ if (client_nat_test("3")) { 5.2. fix_contact() Will replace the IP and port in the Contact header with the IP and port - the SIP message was received from. Usually called after a succesful + the SIP message was received from. Usually called after a successful call to client_nat_test(type) This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, diff --git a/src/modules/nathelper/README b/src/modules/nathelper/README index d21c31c502f..711812b2d4d 100644 --- a/src/modules/nathelper/README +++ b/src/modules/nathelper/README @@ -198,7 +198,7 @@ Chapter 1. Admin Guide Currently, the nathelper module supports two types of NAT pings: * UDP packet - 4 bytes (zero filled) UDP packets are sent to the contact address. - + Advantages: low bandwitdh traffic, easy to generate by + + Advantages: low bandwidth traffic, easy to generate by Kamailio; + Disadvantages: unidirectional traffic through NAT (inbound - from outside to inside); As many NATs do update the bind @@ -210,7 +210,7 @@ Chapter 1. Admin Guide request from Kamailio (inbound traffic) will force the SIP client to generate a SIP reply (outbound traffic) - the NAT bind will be surely kept open. - + Disadvantages: higher bandwitdh traffic, more expensive (as + + Disadvantages: higher bandwidth traffic, more expensive (as time) to generate by Kamailio; 3. Dependencies @@ -407,7 +407,7 @@ modparam("nathelper", "nortpproxy_str", "a=sdpmangled:yes\r\n") 4.12. keepalive_timeout (int) - The parameter sets the interval in secods after which a natted contact + The parameter sets the interval in seconds after which a natted contact is removed from location table if it does not reply to SIP keepalives (usually OPTIONS ping requests). @@ -487,8 +487,8 @@ if (search("User-Agent: Cisco ATA.*") {fix_nated_contact();}; 5.2. fix_nated_sdp(flags [, ip_address]) - Alters the SDP information in orer to facilitate NAT traversal. What - changes to be performed may be controled via the “flags” parameter. + Alters the SDP information in order to facilitate NAT traversal. What + changes to be performed may be controlled via the “flags” parameter. Return value is -1 if error occurred, 1 if ip's were replaced, 2 if no ip's were replaced. @@ -502,8 +502,8 @@ if (search("User-Agent: Cisco ATA.*") {fix_nated_contact();}; + 0x08 - rewrite IP from origin description (o=) with source address of the message or the provided IP address (the provide IP address take precedence over the source address). - * ip_address - IP to be used for rewritting SDP. If not specified, - the received signalling IP will be used. The parameter allows + * ip_address - IP to be used for rewriting SDP. If not specified, the + received signalling IP will be used. The parameter allows pseudo-variables usage. NOTE: For the IP to be used, you need to use 0x02 or 0x08 flags, otherwise it will have no effect. diff --git a/src/modules/ndb_mongodb/README b/src/modules/ndb_mongodb/README index cac80810a45..24299696f3f 100644 --- a/src/modules/ndb_mongodb/README +++ b/src/modules/ndb_mongodb/README @@ -248,7 +248,7 @@ if(mongodb_find_one("mgs1", "kamailio", "subscriber", "{ \"username\" : \"111\" 4.5. mongodb_next(replyid) Moves to next document in a MongoDB reply. This function can be used - after a succesful mongodb_cmd() or mongodb_find(). It returns true if + after a successful mongodb_cmd() or mongodb_find(). It returns true if there is a shift to document. The current document becomes available via $mongodb(key) variable. diff --git a/src/modules/ndb_redis/README b/src/modules/ndb_redis/README index dd04331adcb..95456579452 100644 --- a/src/modules/ndb_redis/README +++ b/src/modules/ndb_redis/README @@ -65,7 +65,7 @@ Carsten Bock 1.3. Set connect_timeout parameter 1.4. Set cmd_timeout parameter 1.5. Set cluster parameter - 1.6. Set allowed_timeots parameter + 1.6. Set allowed_timeouts parameter 1.7. Set disable_time parameter 1.8. Set flush_on_reconnect parameter 1.9. Set allow_dynamic_nodes parameter @@ -249,7 +249,7 @@ modparam("ndb_redis", "cluster", 1) Default value is “-1” (disabled). - Example 1.6. Set allowed_timeots parameter + Example 1.6. Set allowed_timeouts parameter ... modparam("ndb_redis", "allowed_timeouts", 3) ... diff --git a/src/modules/nosip/README b/src/modules/nosip/README index bf7e0ef7783..06fe84fc0ea 100644 --- a/src/modules/nosip/README +++ b/src/modules/nosip/README @@ -160,7 +160,7 @@ event_route[nosip:msg] { There can be many useful cases when one wants to get a SIP worker back to handle a suspended SIP transaction. While this could be achieved via XMLRPC or HTTP for TCP workers, UDP workers are the least loaded in - terms of network interaction layer (ie., there is no overhad for + terms of network interaction layer (ie., there is no overhead for connections management like for TCP). Parsing of the non-sip message can be done using config file actions: diff --git a/src/modules/nsq/README b/src/modules/nsq/README index f109201549f..22b624a6451 100644 --- a/src/modules/nsq/README +++ b/src/modules/nsq/README @@ -20,7 +20,7 @@ Emmanuel Schmidbauer 1. Overview 2. How it works - 2.1. Aknowledge Messages + 2.1. Acknowledge Messages 3. Dependencies @@ -78,7 +78,7 @@ Chapter 1. Admin Guide 1. Overview 2. How it works - 2.1. Aknowledge Messages + 2.1. Acknowledge Messages 3. Dependencies @@ -112,7 +112,7 @@ Chapter 1. Admin Guide 1. Overview The module provides an NSQ consumer for Kamailio configuration file. - NSQ is a real time distributed messaging platofrm, more details about + NSQ is a real time distributed messaging platform, more details about it can be found at nsq.io. From a high-level perspective, the module may be used for: @@ -122,7 +122,7 @@ Chapter 1. Admin Guide while utilizing a message bus. * Rely on a distributed messaging layer, such that machines processing requests/responses/events can go up/down or share the - workload, whithout impacting Kamailio's activity. + workload, without impacting Kamailio's activity. Supported NSQ operations are: * Subscribe to a Topic and Channel @@ -132,14 +132,14 @@ Chapter 1. Admin Guide 2. How it works - 2.1. Aknowledge Messages + 2.1. Acknowledge Messages The module creates an additional NSQ manager process that does the communication with NSQ for consuming messages. This one defers the - message for processing to other NSQ worker processs so that it doesn't + message for processing to other NSQ worker process so that it doesn't block itself, nor the SIP worker processes. -2.1. Aknowledge Messages +2.1. Acknowledge Messages Consumed messages have the option of being acknowledge in two ways: * immediately when received diff --git a/src/modules/osp/README b/src/modules/osp/README index 5e1c908d47d..cb17088273e 100644 --- a/src/modules/osp/README +++ b/src/modules/osp/README @@ -365,7 +365,7 @@ modparam("osp","validate_call_id",1) The use_rpid_for_calling_number (integer) parameter instructs the OSP module to use the calling number in the Remote-Party-ID of the SIP INVITE message. If this value is set to 1, the OSP Module uses the - calling number in the Reomte-Party-ID header of the INVITE message when + calling number in the Remote-Party-ID header of the INVITE message when a Remote-Party-ID exists. If this value is set to 0, the OSP Module will use the calling number in the From header of the INVITE message. The default value is 1. diff --git a/src/modules/p_usrloc/README b/src/modules/p_usrloc/README index 97f7d37f604..5effbeab550 100644 --- a/src/modules/p_usrloc/README +++ b/src/modules/p_usrloc/README @@ -184,18 +184,18 @@ Chapter 1. User's Guide The parameters and the interface for the p_usrloc module are thus almost the same, so in this document only extra parameters (specific only to p_usrloc module) and differences are noted. For a complete - description of the paramters that are inherited from usrloc see the + description of the parameters that are inherited from usrloc see the page here. Note that the modparam statement must still refer to the p_usrloc module. - The goal of the p_usrloc module is to provide partionioned user - location service to Kamailio/SER. This provides three major benefits: + The goal of the p_usrloc module is to provide partitioned user location + service to Kamailio/SER. This provides three major benefits: * Redundancy Failure of a location database does not mean that the location service is down * Load Balancing DB performance is greatly increased as queries are automatically split on a pool of ID(number configurable at runtime). Furthermore, a read only db handler can be used to - further increase the spead of the "select" queries. + further increase the spread of the "select" queries. * Failover A faulty DB server is detected and taken out. When it recovers, the module makes sure that no stale contacts are returned from it. @@ -205,7 +205,7 @@ Chapter 1. User's Guide The number of databases used for replication is configurable at compile time by modifying the DB_NUM define. Its main field of application is for storing and retrieving location data. The actual database for this - subscriber is choosen from a set that is specified in the master + subscriber is chosen from a set that is specified in the master database. Read queries are executed on one database of the set. If this database is not available, the other database would be used. This failure is recorded in the master database. @@ -222,7 +222,7 @@ Chapter 1. User's Guide installed, and write only errors and other status information to a central master database. It is also possible to specify different failover schemas and even use transaction to provide additional data - safety. This module could further try to minimise the impact of a + safety. This module could further try to minimize the impact of a database error with the usage of spare databases that are automatically activated. It also supports the manual deactivation of redundant databases for maintenance purposes. @@ -292,7 +292,7 @@ sename") 3.2. read_db_url (string) The url to the master database where the distribution data is read - from. It is seperated from write access, so for better performance, a + from. It is separated from write access, so for better performance, a local replicate can be used for read access. Default value is mysql://kamailio:kamailiorw@localhost/kamailio . @@ -715,7 +715,7 @@ modparam("p_usrloc", "db_mode", 2) 6.2. Maintenance - The module supports the decativation of redundant databases for + The module supports the deactivation of redundant databases for maintenance reasons. This can be done by setting the status column of the respective database in the p_usrloc to the value “2”. This setting is autodetected from all modules on the server cluster. Changes in the @@ -727,8 +727,8 @@ modparam("p_usrloc", "db_mode", 2) finished, the respective status column needs to be set to “0”. This is autodetected as well, the first module that noticed the change will set the status column to “1” and setting the failover column to the current - time and date. Write requests are now transfered again to the database, - but no reads are done yet. + time and date. Write requests are now transferred again to the + database, but no reads are done yet. After the configured expire_time has been passed, i.e. every contact has been inserted at least one time in the database the respective @@ -783,7 +783,7 @@ Chapter 2. Developer's Guide _k, db_val_t* _v, int _n) Lookup the first and if needed the second key, and insert the given - values into the choosen databases. + values into the chosen databases. Meaning of the parameters is as follows: * table - Pointer to the table name. @@ -798,7 +798,7 @@ _k, db_op_t * _op, db_val_t* _v, db_key_t* _uk, db_val_t* _uv, int _n, int _un); Lookup the first and if needed the second key, and update the given - values in the choosen databases. + values in the chosen databases. Meaning of the parameters is as follows: * table - Pointer to the table name. @@ -816,7 +816,7 @@ _un); db_key_t* _k, db_val_t* _v, int _n) Lookup the first and if needed the second key, and insert on duplicate - key update the given values in the choosen databases. This is like an + key update the given values in the chosen databases. This is like an insert, but update if the key already exist. Meaning of the parameters is as follows: @@ -831,7 +831,7 @@ db_key_t* _k, db_val_t* _v, int _n) db_key_t* _k, db_val_t* _v, int _n) Lookup the first and if needed the second key, and replace the given - values in the choosen databases. + values in the chosen databases. Meaning of the parameters is as follows: * table - Pointer to the table name. @@ -845,7 +845,7 @@ db_key_t* _k, db_val_t* _v, int _n) _k, db_op_t* _o, db_val_t* _v, int _n) Lookup the first and if needed the second key, and delete the given - values into the choosen databases. + values into the chosen databases. Meaning of the parameters is as follows: * table - Pointer to the table name. @@ -861,7 +861,7 @@ _k, db_op_t* _o, db_val_t* _v, int _n) _nc, db_key_t _o, db_res_t** _r); Lookup the first and if needed the second key, and performs a query in - one of the choosen databases. The returned handle _r_h must be used to + one of the chosen databases. The returned handle _r_h must be used to free the result set after the usage of the returned database entries, otherwise a memory leak will occur.You must call ul_db_free_result before you can call ul_db_query again! diff --git a/src/modules/pdb/README b/src/modules/pdb/README index 625a0086f15..1857dbf2b20 100644 --- a/src/modules/pdb/README +++ b/src/modules/pdb/README @@ -87,7 +87,7 @@ Chapter 1. Admin Guide The pdb module allows Kamailio to send queries to a list of servers and store the answer in an AVP. The idea is to ask all servers in parallel and use the first answer, that comes back. A timeout for the query can - be defined in milliseconds. The queying can be activated and + be defined in milliseconds. The querying can be activated and deactivated using FIFO commands. More about the new communication protocol between this module and diff --git a/src/modules/peering/README b/src/modules/peering/README index 54260b4926a..d06635c16aa 100644 --- a/src/modules/peering/README +++ b/src/modules/peering/README @@ -101,7 +101,7 @@ Chapter 1. Admin Guide 2.2. External Libraries or Applications The following libraries or applications must be installed before - compilling Kamailio with this module loaded: + compiling Kamailio with this module loaded: * radiusclient-ng 0.5.0 or higher -- library and development files. See http://developer.berlios.de/projects/radiusclient-ng/. diff --git a/src/modules/pike/README b/src/modules/pike/README index 58dc8ba39f7..34a26d70204 100644 --- a/src/modules/pike/README +++ b/src/modules/pike/README @@ -84,7 +84,7 @@ Chapter 1. Admin Guide The module does not implement any actions on blocking - it just simply reports that there is high traffic from an IP; what to do, is the - administator decision (via scripting). + administrator decision (via scripting). 2. Dependencies @@ -146,7 +146,7 @@ modparam("pike", "reqs_density_per_unit", 30) Specifies for how long the IP address will be kept in memory after the last request from that IP address. It's a sort of timeout value, in seconds. Note that it is not the duration to keep the IP in state - 'blocked'. An IP is unblocked next occurence of 'sampling_time_unit' + 'blocked'. An IP is unblocked next occurrence of 'sampling_time_unit' that does not exceed 'reqs_density_per_unit'. Keeping an IP in memory results in faster reaching of blocked state -- see the notes about the limits of getting to state 'blocked'. diff --git a/src/modules/pipelimit/README b/src/modules/pipelimit/README index 0a174e2fbe6..974eaed33b2 100644 --- a/src/modules/pipelimit/README +++ b/src/modules/pipelimit/README @@ -121,9 +121,9 @@ Chapter 1. Admin Guide The module defines in an abstract mode the notion of 'pipe', which can be a reference to an IP address, to a network or a trunk. The - associtiation of traffic to a pipe is done in the config file, - therefore, a pipe could represent SIP traffic coming from a user or the - flow of specific SIP requests such as INVITE or REGISTER. + association of traffic to a pipe is done in the config file, therefore, + a pipe could represent SIP traffic coming from a user or the flow of + specific SIP requests such as INVITE or REGISTER. Pipelimit started from ratelimit module, adding support for definition of pipes limits in database and dynamic names. Complexity of keeping @@ -283,7 +283,7 @@ modparam("pipelimit", "plp_algorithm_column", "name") each timer_interval, therefore the amounts of messages have to be divided by this timer_interval value to get the messages per second value. For example, if you want to allow an average of 10 messages per - second with a timer inteval of 10 seconds, then the limit value has to + second with a timer interval of 10 seconds, then the limit value has to be 100. Note: A too small value may lead to performance penalties due to timer @@ -342,7 +342,7 @@ kamcmd cfg.set_now_string pipelimit reply_reason "Limiting" to algorithm is done and the pipe limit is set to the 'limit' parameter value, if this is greater than 0. Algorithm is case sensitive. - The pipe name can be provided via a pseudo variabile. + The pipe name can be provided via a pseudo variable. The method will return: * -2 if no pipe was found @@ -450,8 +450,8 @@ with unexpected retcode=$var(check_result)\n"); 5.1. pl.stats - Lists the parameters and variabiles in the pipelimit module: pipe id, - pipe load and pipe couter. + Lists the parameters and variables in the pipelimit module: pipe id, + pipe load and pipe counter. Name: pl.stats diff --git a/src/modules/presence/README b/src/modules/presence/README index 0a694340221..f40ff9ecd6d 100644 --- a/src/modules/presence/README +++ b/src/modules/presence/README @@ -252,7 +252,7 @@ Chapter 1. Admin Guide performance). For subscriptions it supports the 4 storage modes: Memory Only, Write Back, Write Through and DB Only. For publishes, it stores the state documents in database only(because of the large size) and it - can store a publish cache in memory to avoid unnecessairy database + can store a publish cache in memory to avoid unnecessary database queries. Read the subs_db_mode and publ_cache parameter sections to decide which is the best storage configuration for you. @@ -658,7 +658,7 @@ modparam("presence", "pres_htable_size", 11) 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 - default, thus addering to the standard. + default, thus adhering to the standard. Default value is “1 ”. @@ -957,7 +957,7 @@ if (method=="MESSAGE") { 4.5. pres_refresh_watchers(uri, event, type[, file_uri, filename]) - The function can be used in configuration to triger notifies to + The function can be used in configuration to trigger notifies to watchers if a change in watchers authorization or in published state occurred (i.e., updates of xcap documents). @@ -1192,7 +1192,7 @@ typedef struct presence_api { /* function to extract dialog information from a SUBSCRIBE message */ extract_sdialog_info_t extract_sdialog_info; - /* function to request sphere defition for a presentity */ + /* function to request sphere definition for a presentity */ pres_get_sphere_t get_sphere; }presence_api_t; @@ -1333,7 +1333,7 @@ typedef void(free_body_t)(char* body); body for each watcher. E.g. if the XML body includes a 'version' parameter which will be increased for each NOTIFY, on a "per watcher" basis. The module can either allocate a new buffer for the new body an - return it (aux_free_body function must be set too) or it manipualtes + return it (aux_free_body function must be set too) or it manipulates the original body directly and returns NULL. Filed type: diff --git a/src/modules/presence_conference/README b/src/modules/presence_conference/README index 3914c825bdf..9490db7e07f 100644 --- a/src/modules/presence_conference/README +++ b/src/modules/presence_conference/README @@ -79,7 +79,7 @@ Chapter 1. Admin Guide 3.1. use_partial_states (int) - Control usage of partial state notifiations. + Control usage of partial state notifications. Default value is “0”. diff --git a/src/modules/presence_dialoginfo/README b/src/modules/presence_dialoginfo/README index 3db72e9ae03..70ffe87ae7a 100644 --- a/src/modules/presence_dialoginfo/README +++ b/src/modules/presence_dialoginfo/README @@ -94,7 +94,7 @@ Chapter 1. Admin Guide multiple dialog elements. In this case use the ..... module parameter. To get better understanding how all the module works together please - take a look at the follwing figure: + take a look at the following figure: Main Proxy and Presence Server on the same Instance caller proxy & callee watcher @@ -136,7 +136,7 @@ alice@example presence bob@example watcher@example send the PUBLISH stateful) * PUBLISH is received and handled by presence module. Presence module updates the "presentity". Presence module checks for active - watchers of the presentity. It gives all the XML dcouments to + watchers of the presentity. It gives all the XML documents to presence_dialoginfo module to aggregate them into a single XML document. Then it sends the NOTIFY with the aggregated XML document to all active watchers. @@ -203,11 +203,11 @@ alice@example server server bob@example watcher@example If this parameter is set, only the dialog element with the currently most interesting dialog state will be put into the dialog-info document. Thus, the dialog-info element will contain only a single - "dialog" element. The algorithm chooses the state based onf the + "dialog" element. The algorithm chooses the state based on the following order of priority (least important first): terminated, trying, proceeding, confirmed, early. Note: I consider the "early" - state more intersting than confirmed as often you might want to pickup - a call if the originall callee is already busy in a call. + state more interesting than confirmed as often you might want to pickup + a call if the original callee is already busy in a call. Default value is “0”. diff --git a/src/modules/presence_xml/README b/src/modules/presence_xml/README index 045edce2d94..20983953739 100644 --- a/src/modules/presence_xml/README +++ b/src/modules/presence_xml/README @@ -257,7 +257,7 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org") If set to 1, module acts in passive mode - no bind to presence module, no connection to database. Useful when needing only to use $xml(...) - pseudoc-variable. + pseudo-variable. Default value: “0” (0 - active mode, 1 - passive mode). diff --git a/src/modules/print_lib/README b/src/modules/print_lib/README index 973de71b7f0..9dc7782cf83 100644 --- a/src/modules/print_lib/README +++ b/src/modules/print_lib/README @@ -33,7 +33,7 @@ Chapter 1. Admin Guide This is an example module. It implements only one function that prints its string parameter to stderr (it won't work if server is started in - daemon mode). Its prupose is to show how to link to an internal library + daemon mode). Its purpose is to show how to link to an internal library (lib/print). 2. Functions diff --git a/src/modules/pua_dialoginfo/README b/src/modules/pua_dialoginfo/README index edb4c29f00c..15c83d19757 100644 --- a/src/modules/pua_dialoginfo/README +++ b/src/modules/pua_dialoginfo/README @@ -54,7 +54,7 @@ Phil Lavin 5.10. pubruri_caller_avp (int) 5.11. pubruri_callee_avp (int) 5.12. pubruri_caller_dlg_var (str) - 5.13. pubruri_callee_dlg_var (str) + 5.13. pubruri_callee_dlg_var (int) 5.14. callee_trying (int) 6. Functions @@ -102,7 +102,7 @@ Chapter 1. Admin Guide 5.10. pubruri_caller_avp (int) 5.11. pubruri_callee_avp (int) 5.12. pubruri_caller_dlg_var (str) - 5.13. pubruri_callee_dlg_var (str) + 5.13. pubruri_callee_dlg_var (int) 5.14. callee_trying (int) 6. Functions @@ -154,20 +154,18 @@ Chapter 1. Admin Guide the id parameter to the same value as the call-id parameter. The "local-tag" indicates the local tag of the entity. The remote-tag indicates the tag of the remote party. The "direction" indicates if the - entity was the initator of the dialog or the recepient (aka if the + entity was the initiator of the dialog or the recipient (aka if the entity sent or received the first INVITE). The "state" element describes the state of the dialog state machine and must be either: trying, proceeding, early, confirmed or terminated. The dialog element can contain optional "local" and "remote" elements - which decsribes the local and the remote party in more detail, for + which describes the local and the remote party in more detail, for example: + version="1" state="full"> * com.voztele.javax.sip.THREAD_POOL_SIZE (integer) Specifies the number of threads there must be in the pool to - process incoming SIP messages. If unspecificed, the default is + process incoming SIP messages. If unspecified, the default is "infinity". * com.voztele.javax.sip.SPIRAL_HDR This property tells WeSIP and SEAS that every SipRequest and UAC @@ -652,8 +652,8 @@ route{ the Connectors. It must have a "name" attribute with whatever name you feel like. It needs to have another attribute called "defaultHost" which will be the default host to which to pass the incoming request - (in HTTP/1.0 the requests dont have a Host header, so they will be - passed to this default host, in SIP, this attribute doesn't have a + (in HTTP/1.0 the requests don’t have a Host header, so they will be + passed to this default host, in SIP, this attribute doesn’t have a meaning.). In order to have this Engine handling also SIP messages, the "className" attribute of the Engine must be "com.voztele.sipservlet.core.ConvergedEngine". @@ -728,7 +728,7 @@ route{ Proxy/Registrar/Redirect and the second cooperating with WeSIP to act as the Application Server. This is the preferred deployment layout, as the first Kamailio works as usual, and the requests that need special - services are relaied to another Kamailio which acts on behalf of the + services are relayed to another Kamailio which acts on behalf of the WeSIP AS. This configuration profile distributes load (call-routing logic in one instance, and Application Services in the other), and is also more fault-tolerant. On the other hand, you can have all your @@ -1156,8 +1156,8 @@ Chapter 2. Developer Guide The end of the field, will be the place where the following pointer points to, minus one (note that all the fields present in a URI are preceded by 1 character, ie - sip[:user][:passwod][@host][:port][;param1=x][;param2=y][?hdr1=a][&hdr2 - =b]) it will also be necessary to have a pointer at the end, pointing + sip[:user][:password][@host][:port][;param1=x][;param2=y][?hdr1=a][&hdr + 2=b]) it will also be necessary to have a pointer at the end, pointing two past the end of the URI, so that the length of the last header can be computed. diff --git a/src/modules/sipcapture/README b/src/modules/sipcapture/README index c4adc983e60..15ca18b75c3 100644 --- a/src/modules/sipcapture/README +++ b/src/modules/sipcapture/README @@ -174,7 +174,7 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules The following modules must be loaded before this module: - * database module - mysql, postrgress, dbtext, unixodbc... + * database module - mysql, postgres, dbtext, unixodbc... 2.2. External Libraries or Applications diff --git a/src/modules/sipdump/README b/src/modules/sipdump/README index e1408cec6f9..f4e5a7d0ed0 100644 --- a/src/modules/sipdump/README +++ b/src/modules/sipdump/README @@ -182,7 +182,7 @@ modparam("sipdump", "fprefix", "ksipdump-") 4.1. sipdump_send(tag) - Send the details of the current SIP message to the writter process and + Send the details of the current SIP message to the writer process and get it stored in the file. The parameter "tag" can be any string, it is going to be written in the diff --git a/src/modules/sipt/README b/src/modules/sipt/README index 142ab06b52f..d4139010216 100644 --- a/src/modules/sipt/README +++ b/src/modules/sipt/README @@ -95,7 +95,7 @@ Chapter 1. Admin Guide 1. Overview - Module for updating ISUP encapuslated in SIP (SIP-T/SIP-I) + Module for updating ISUP encapsulated in SIP (SIP-T/SIP-I) The sipt module can be used to update various ss7 headers contained inside a message. @@ -120,7 +120,7 @@ Chapter 1. Admin Guide number to “destination” with the nature address specified in “nai” and decrementing the hop counter value if present. If the hop counter header is missing it will be added with the value of “hops”. If - “terminator” is set to 1, then F will be appened to digit string to + “terminator” is set to 1, then F will be appended to digit string to indicate the number is complete (default). Example 1.1. sipt_destination(destination, hops, nai) usage diff --git a/src/modules/siptrace/README b/src/modules/siptrace/README index 383250d6f7c..3a7ec66b641 100644 --- a/src/modules/siptrace/README +++ b/src/modules/siptrace/README @@ -152,7 +152,7 @@ Chapter 1. Admin Guide (using HEP, the Homer encapsulation protocol, or plain SIP mode) There are multiple ways of storing information: - * by calling the sip_trace() method explicitely in the Kamailio + * by calling the sip_trace() method explicitly in the Kamailio configuration file. In this case the original message is processed. * by setting the flag equal with the value of “trace_flag” (e.g., setflag(__trace_flag__)) parameter of the module. In this case, the diff --git a/src/modules/siputils/README b/src/modules/siputils/README index 11ecba4d666..884dbdf36a4 100644 --- a/src/modules/siputils/README +++ b/src/modules/siputils/README @@ -806,8 +806,8 @@ append_rpid_hf(); # Append Remote-Party-ID header field Meaning of the parameters is as follows: * prefix - Prefix of the Remote-Party-ID URI. The string will be - added at the begining of body of the header field, just before the - URI. + added at the beginning of the body of the header field, just before + the URI. * suffix - Suffix of the Remote-Party-ID header field. The string will be appended at the end of the header field. It can be used to set various URI parameters, for example. @@ -929,7 +929,7 @@ if (is_supported("outbound")) { ... } 'myself' and source address is not matching it (to avoid detecting in case of local loops). Note that it does not detect spirals, which can have the condition for replies true also in the case of additional SIP - reply receival. + reply reception. This function can be used from ANY_ROUTE. diff --git a/src/modules/sms/README b/src/modules/sms/README index 24f278f34bb..552dbb5b9a5 100644 --- a/src/modules/sms/README +++ b/src/modules/sms/README @@ -170,7 +170,7 @@ modem_param = name "=" value * t=to (optional) - uri for sip header TO. Default is NULL. * s=scan (optional) - Values: 0: NOT SCAN uri from body sms, use URI in t=to. 1: SCAN uri from body sms (normal mode, default mode, - clasic mode) 2: SCAN MIX (both modes), First SCAN Default is 1 + classic mode) 2: SCAN MIX (both modes), First SCAN Default is 1 (SCAN). Note diff --git a/src/modules/snmpstats/README b/src/modules/snmpstats/README index d8b539831dc..b6fead7914c 100644 --- a/src/modules/snmpstats/README +++ b/src/modules/snmpstats/README @@ -483,8 +483,8 @@ modparam("snmpstats", "export_registrar", 1) The specifics of what is returned depends on how the system was configured. If your NetSNMP installation was installed from an RPM (or another packaged version), then there is a good chance that - net-snmp-config will return something unecessarily longer. It is highly - recommended you install NetSNMP from source to avoid bringing in + net-snmp-config will return something unnecessarily longer. It is + highly recommended you install NetSNMP from source to avoid bringing in excessive dependencies to the SNMPStats module. 6.2. Configuring NetSNMP to allow connections from the SNMPStats module. @@ -542,7 +542,7 @@ modparam("snmpstats", "export_registrar", 1) 6.4. Testing for a proper Configuration As a quick test to make sure that the SNMPStats module sub-agent can - succesfully connect to the NetSNMP Master agent, start snmpd with the + successfully connect to the NetSNMP Master agent, start snmpd with the following: snmpd -f -Dagentx -x tcp:localhost:705 2>&1 | less diff --git a/src/modules/speeddial/README b/src/modules/speeddial/README index fa3027b4f69..1711d7d9683 100644 --- a/src/modules/speeddial/README +++ b/src/modules/speeddial/README @@ -86,7 +86,7 @@ Chapter 1. Admin Guide 1. Overview - This module provides on-server speed dial facilities. An user can store + This module provides on-server speed dial facilities. A user can store records consisting of pairs short numbers (2 digits) and SIP addresses into a table of Kamailio. Then it can dial the two digits whenever it wants to call the SIP address associated with them. @@ -202,7 +202,7 @@ modparam("speeddial", "domain_prefix", "tel.") 3.8. use_domain (int) - The parameter specifies wheter or not to use the domain when searching + The parameter specifies whether or not to use the domain when searching a speed dial record (0 - no domain, 1 - use domain from From URI, 2 - use both domains, from From URI and from request URI). @@ -225,7 +225,7 @@ modparam("speeddial", "use_domain", 1) Meaning of the parameters is as follows: * table - The name of the table storing the speed dial records. * owner - The SIP URI of the owner of short dialing codes. If not - pressent, URI of From header is used. + present, URI of From header is used. This function can be used from REQUEST_ROUTE. diff --git a/src/modules/sqlops/README b/src/modules/sqlops/README index 7e919f114c9..0e32950ef96 100644 --- a/src/modules/sqlops/README +++ b/src/modules/sqlops/README @@ -159,7 +159,7 @@ modparam("sqlops","sqlcon","ca=>dbdriver://username:password@dbhost/dbname") The definition of a database result ID. The value of the parameter can be any string. Results IDs are also added at fixup time when - sql_query() parameters are parsed, so there is no need to decalare them + sql_query() parameters are parsed, so there is no need to declare them via module parameter unless you want to use them from within other modules and be available in all application processes. @@ -298,7 +298,7 @@ sql_result_free("ra"); result is not available back to config, thus it should be used only for sql statements that don't return values (e.g., insert, delete, update...). Note that async_workers core parameter must be set in order - to enable the asyncronous framework needed by this function. + to enable the asynchronous framework needed by this function. * connection - the name of the connection to be used for the query (defined via “sqlcon” parameter). * query - SQL query string or pseudo-variables containing SQL query. diff --git a/src/modules/sst/README b/src/modules/sst/README index 77eee87a2c6..725cffc95d6 100644 --- a/src/modules/sst/README +++ b/src/modules/sst/README @@ -203,7 +203,7 @@ modparam("sst", "enable_stats", 0) 4.2. min_se (integer) The value is used to set the proxies MIN-SE value and is used in the - 422 error reply as the proxys MIN-SE: header value if the + 422 error reply as the proxies MIN-SE: header value if the “sstCheckMin()” flag is set to true and the check fails. If not set and “sstCheckMin()” is called with the send-reply flag set @@ -295,7 +295,7 @@ route { value is less than the modules minimum value, this function will return true. - If the fuction is called with the send_reply_flag set to true (1) and + If the function is called with the send_reply_flag set to true (1) and the requested Session-Expires / MIN-SE values are too small, a 422 reply will be sent for you. The 422 will carry a MIN-SE: header with the sst min_se parameter value set. diff --git a/src/modules/statsc/README b/src/modules/statsc/README index a43e2ff5c4c..2ef41cc72d5 100644 --- a/src/modules/statsc/README +++ b/src/modules/statsc/README @@ -113,15 +113,15 @@ modparam("statsc", "items", 200) 3.3. track (str) Specify the statistics to track. The parameter can be set many times - and one value can speficy many statistics. + and one value can specify many statistics. The format is "rname=sname", where the rname is the name for report and sname is internal Kamailio statistic name. Next statistics are tracked by default: - * shm.free - the internal statistc 'free_size' (from group 'shmem'). - * shm.used - the internal statistc 'used_size' (from group 'shmem'). - * shm.real_used - the internal statistc 'real_used_size' (from group + * shm.free - the internal statistic 'free_size' (from group 'shmem'). + * shm.used - the internal statistic 'used_size' (from group 'shmem'). + * shm.real_used - the internal statistic 'real_used_size' (from group 'shmem'). Default value is "". diff --git a/src/modules/tcpops/README b/src/modules/tcpops/README index 896eed34a6a..e288bfe0c2c 100644 --- a/src/modules/tcpops/README +++ b/src/modules/tcpops/README @@ -270,7 +270,7 @@ request_route { Explicitly enables the "tcp:closed" event route on a TCP connection. Meaning of the parameters is as follows: - * conid (optionnal): the Kamailio internal connection id. If no + * conid (optional): the Kamailio internal connection id. If no parameter is given, it will be enabled on the current message source connection. @@ -302,7 +302,7 @@ event_route[tcp:closed] { set in the variable named by pvname parameter. Meaning of the parameters is as follows: - * hostport - target "host:port" address, the port can be ommited + * hostport - target "host:port" address, the port can be omitted (default to 5060) and the parameter can contain variables. * pvname - target variable name. @@ -310,7 +310,7 @@ event_route[tcp:closed] { 1: connection was found - -1: connection was not found or an error occured + -1: connection was not found or an error occurred Example 1.8. tcp_get_conid usage ... diff --git a/src/modules/textops/README b/src/modules/textops/README index 3ea2fdcb1cf..dbe6b237d2a 100644 --- a/src/modules/textops/README +++ b/src/modules/textops/README @@ -456,8 +456,8 @@ if(has_body() && replace_body_atonce("^.+$", "")) * '/re/repl/flags' - sed like regular expression. flags can be a combination of i (case insensitive), g (global) or s (match newline don't treat it as end of line). - 're' - is regular expresion - 'repl' - is replacement string - may contain pseudo-varibales + 're' - is regular expression + 'repl' - is replacement string - may contain pseudo-variables 'flags' - substitution flags (i - ignore case, g - global) This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, @@ -483,8 +483,8 @@ if ( subst('/^To:(.*)sip:[^@]*@[a-zA-Z0-9.]+(.*)$/t:\1$avp(sip_address)\2/ig') ) * '/re/repl/flags' - sed like regular expression. flags can be a combination of i (case insensitive), g (global) or s (match newline don't treat it as end of line). - 're' - is regular expresion - 'repl' - is replacement string - may contain pseudo-varibales + 're' - is regular expression + 'repl' - is replacement string - may contain pseudo-variables 'flags' - substitution flags (i - ignore case, g - global) This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, @@ -511,8 +511,8 @@ if (subst_uri('/^sip:([0-9]+)@(.*)$/sip:$avp(uri_prefix)\1@\2;orig_uri=\0/i')){$ * '/re/repl/flags' - sed like regular expression. flags can be a combination of i (case insensitive), g (global) or s (match newline don't treat it as end of line). - 're' - is regular expresion - 'repl' - is replacement string - may contain pseudo-varibales + 're' - is regular expression + 'repl' - is replacement string - may contain pseudo-variables 'flags' - substitution flags (i - ignore case, g - global) This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, @@ -537,8 +537,8 @@ if (subst_user('/(.*)3642$/$avp(user_prefix)\13642/')){$ * '/re/repl/flags' - sed like regular expression. flags can be a combination of i (case insensitive), g (global) or s (match newline don't treat it as end of line). - 're' - is regular expresion - 'repl' - is replacement string - may contain pseudo-varibales + 're' - is regular expression + 'repl' - is replacement string - may contain pseudo-variables 'flags' - substitution flags (i - ignore case, g - global) This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, @@ -749,7 +749,7 @@ if (is_present_hf_re("^P-")) log(1, "There are headers starting with P-\n"); * %M minutes * %S seconds - Return true if a header was succesfully appended. + Return true if a header was successfully appended. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE. @@ -771,7 +771,7 @@ append_time(); * %M minutes * %S seconds - Return true if a header was succesfully appended. + Return true if a header was successfully appended. This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE. @@ -1056,7 +1056,7 @@ if (starts_with("$rU", "+358")) BRANCH_ROUTE. The core will take care of the last boundary ending "--". Detecting - wich one is the last and fixing the others if needed. + which one is the last and fixing the others if needed. Note: it may be required that msg_apply_changes() from textopsx module has to be executed if there are other operations over the new body. diff --git a/src/modules/textopsx/README b/src/modules/textopsx/README index 60b458d189c..bd0328b446e 100644 --- a/src/modules/textopsx/README +++ b/src/modules/textopsx/README @@ -234,7 +234,7 @@ ot exists add new header Insert new header value before an existing header, if no index acquired insert before first hf header. Note that a header may consist of comma - delimited list of values. To insert value behing last value use + delimited list of values. To insert value behind last value use appenf_hf_value. Meaning of the parameters is as follows: @@ -299,7 +299,7 @@ remove_hf_value2("foo[*].bar") # for each foo delete bar parameters [ [IDX] ] [. PARAM] If asterisk is specified as index then all values are affected. * hvalue - Value to be assigned, config var formatting supported. If - value is empty then no equal sign apears in param. + value is empty then no equal sign appears in param. Example 1.10. assign_hf_value usage ... @@ -323,7 +323,7 @@ assign_hf_value("foo[*].bar", "") # set empty value (ex. lr) [ [IDX] ] [. PARAM] If asterisk is specified as index then all values are affected. * hvalue - Value to be assigned, config var formatting supported. If - value is empty then no equal sign apears in param. + value is empty then no equal sign appears in param. Example 1.11. assign_hf_value2 usage ... @@ -392,7 +392,7 @@ if (@hf_value_exists.supported.path == "1") { treated as value delimiter. Formats: @hf_value.HFNAME[IDX] # idx value, negative value counts from bottom @hf_value.HFNAME.PARAM_NAME @hf_value.HFNAME[IDX].PARAM_NAME @hf_value.HFNAME.p.PARAM_NAME # or - .param., useful if requred called "uri", "p", "param" + .param., useful if required called "uri", "p", "param" @hf_value.HFNAME[IDX].p.PARAM_NAME # dtto @hf_value.HFNAME[IDX].uri # (< & > excluded) @hf_value.HFNAME[*] # return comma delimited list of all values (combines headers) @hf_value.HFNAME # the same as above [*] diff --git a/src/modules/timer/README b/src/modules/timer/README index 85004102e51..853fe7304a3 100644 --- a/src/modules/timer/README +++ b/src/modules/timer/README @@ -142,7 +142,7 @@ modparam("timer", "declare_timer", "MY_TIMER=MY_TIMER_ROUTE,10,slow,enable"); handler by itself not to decrease performance. Disabling and enabling in sequence may be tricky. * timer_id references to timer declared by declare_timer. - * enable_distable - set to 1 to enable timer, to 0 to disable. + * enable_disable - set to 1 to enable timer, to 0 to disable. Example 1.2. timer_enable usage ... diff --git a/src/modules/tls/README b/src/modules/tls/README index dcdbfed6de1..2f746210db0 100644 --- a/src/modules/tls/README +++ b/src/modules/tls/README @@ -391,7 +391,8 @@ certs = $dir/certs # Where the issued certs are kept crl_dir = $dir/crl # Where the issued crl are kept database = $dir/index.txt # database index file. #unique_subject = no # Set to 'no' to allow creation of - # several ctificates with same subject. + # several certificates with same subject +. new_certs_dir = $dir/newcerts # default place for new certs. certificate = $dir/cacert.pem # The CA certificate @@ -864,7 +865,7 @@ modparam("tls", "ssl_freelist_max_len", 0) Sets the maximum number of bytes (from the clear text) sent into one TLS record. Valid values are between 512 and 16384. Note however that - even valid low values might not be big enough to allow a succesfull + even valid low values might not be big enough to allow a successful handshake (try minimum 1024). Lower values would lead to less memory usage, but values lower then the @@ -876,7 +877,7 @@ modparam("tls", "ssl_freelist_max_len", 0) Note Values on the lower side, even if valid (> 512), might not allow for a - succesfull initial handshake. This happens if the certificate does not + successful initial handshake. This happens if the certificate does not fit inside one send fragment. Values lower then 1024 should not be used. Even with higher values, if the handshake fails, try increasing the value. @@ -979,7 +980,7 @@ modparam("tls", "ct_wq_max", 4194304) 9.22. ct_wq_blk_size (integer) Minimum block size for the internal clear-text send queues (debugging / - advanced tunning). Good values are multiple of typical datagram sizes. + advanced tuning). Good values are multiple of typical datagram sizes. The default value is 4096. @@ -1043,7 +1044,7 @@ modparam("tls", "tls_debug", 10) writing this is not true for any OpenSSL version (including 0.9.8e). If an ill-behaved OpenSSL version is detected, a very conservative - value is choosed, which depends on the maximum possible number of + value is chosen, which depends on the maximum possible number of simultaneously created TLS connections (and hence on the process number). @@ -1075,7 +1076,7 @@ modparam("tls", "low_mem_threshold1", -1) not true for any OpenSSL version (including 0.9.8e). If an ill-behaved OpenSSL version is detected, a very conservative - value is choosed, which depends on the maximum possible number of + value is chosen, which depends on the maximum possible number of simultaneously created TLS connections (and hence on the process number). @@ -1101,7 +1102,7 @@ modparam("tls", "low_mem_threshold2", -1) If enabled Kamailio will start even if some of the OpenSSL sanity checks fail (turn it on at your own risk). - If any of the following sanity checks fal, Kamailio will not start: + If any of the following sanity checks fail, Kamailio will not start: * the version of the library the TLS module was compiled with is "too different" from the library used at runtime. The versions should have the same major, minor and fix level (e.g.: 0.9.8a and 0.9.8c diff --git a/src/modules/tm/README b/src/modules/tm/README index 0b484fa6a96..823f1a1ae6f 100644 --- a/src/modules/tm/README +++ b/src/modules/tm/README @@ -1063,7 +1063,7 @@ modparam("tm", "blst_503_max_timeout", 604800) Change the value carefully, because requests that doesn't get a provisional response (everything but INVITE) can easily cause the next - hop to be inserted into the blacklist by mistake. For exmaple the next + hop to be inserted into the blacklist by mistake. For example the next hop is a proxy, it is alive, but waiting for the response of the UAS, and has higher fr_timer value. @@ -1685,7 +1685,7 @@ end and port. In the later case (host and port specified) the protocol used is the same protocol on which the message was received. - t_relay() is the statefull version for forward() while t_relay(host, + t_relay() is the stateful version for forward() while t_relay(host, port) is similar to forward(host, port). In the forward to uri case (t_relay()), if the original URI was @@ -1721,7 +1721,7 @@ if (!t_relay()) * port - Port number. If no parameters are specified the message is sent to a destination - derived from the message uri (using sip sepcific DNS lookups), but with + derived from the message uri (using sip specific DNS lookups), but with the protocol corresponding to the function name. Example 1.49. t_relay_to_udp usage @@ -2407,7 +2407,7 @@ failure_route[1] { and then stores the branches in reverse order into the XAVP. The q parameter of a branch contains a value from range 0-1.0 and it - expresses relative preferrence of the branch among all branches in the + expresses relative preference of the branch among all branches in the destination set. The higher the q value the more preference the user agent gave to the branch. Branches with higher q values will be tried before branches with lower ones when serial forking takes place. @@ -2514,7 +2514,7 @@ event_route[tm:branch-failure:outbound] 4.41. t_check_status(re) - Returns true if the regular expresion “re” match the reply code of the + Returns true if the regular expression “re” match the reply code of the response message as follows: * in routing block - the code of the last sent reply. * in on_reply block - the code of the current received reply. @@ -2555,7 +2555,7 @@ Note elapses, when the INVITE transaction no longer exists and thus would not match anything. There are also cases when tm would not keep all the information needed for e2e ACK matching (since this is - not needed for a statefull proxy and it requires additional memory, + not needed for a stateful proxy and it requires additional memory, tm will not keep this information unless needed by some other module or callbacks). * For other requests (non ACKs and non CANCELs), in case of a @@ -2584,7 +2584,7 @@ if ( method == "CANCEL" && !t_check_trans()) 4.43. t_set_disable_6xx(0|1) - Turn off/on 6xx replies special rfc conformant handling on a per + Turn off/on 6xx replies special rfc conforming handling on a per transaction basis. If turned off (t_set_disable_6xx("1")) 6XXs will be treated like normal replies. @@ -2679,8 +2679,8 @@ t_replicate_to_udp("1.2.3.4", "5060"); Meaning of the parameters is as follows: * proxy - address where the request should be sent. Format is: - "proto:host:port" - any of proto or port can be ommitted, along - with the semicolon after or before. + "proto:host:port" - any of proto or port can be omitted, along with + the semicolon after or before. * flags - bitmask integer value to control the internal behavior. Bits can be: + 0x01 - do not generate 100 reply. @@ -3080,8 +3080,8 @@ action *route) For programmatic use only. This function is for revoking t_suspend() from the same process as it was executed before. t_cancel_suspend() can be used when something fails after t_suspend() has already been - executed and it turns out that the transcation should not have been - suspended. The function cancels the FR timer of the transacation. + executed and it turns out that the transaction should not have been + suspended. The function cancels the FR timer of the transaction. The message lumps are saved by t_suspend() which cannot be restored. diff --git a/src/modules/tmrec/README b/src/modules/tmrec/README index c573475832a..bcb8380ee93 100644 --- a/src/modules/tmrec/README +++ b/src/modules/tmrec/README @@ -103,7 +103,7 @@ Chapter 1. Admin Guide 3.1. separator (str) - Separator character used to delimit attributes in time reccurence + Separator character used to delimit attributes in time reccurrence definitions. Default value is '|'. @@ -148,7 +148,7 @@ modparam("tmrec", "separator", ";") duration means “forever”. Negative-length durations are not allowed. See RFC 2445 for the format of duration. In short for common cases - when the duration doesn't exeed a data, it must start with PT + when the duration doesn't exceed a data, it must start with PT followed by the value for hours, minutes or seconds - e.g., a duration of 8 hours must be written as PT8H. * frequency - can be one of the following values: “daily” - specify diff --git a/src/modules/tmx/README b/src/modules/tmx/README index d9c8024c3f7..120c36c3bec 100644 --- a/src/modules/tmx/README +++ b/src/modules/tmx/README @@ -166,7 +166,7 @@ Chapter 1. Admin Guide Enable/disable transaction pre-check via t_precheck_trans() function. If set to 0, the internal structures are not created at startup and the - funcation will return false always. + function will return false always. Default value is 1 (enabled). @@ -347,7 +347,7 @@ route[abc] { ... if(t_suspend()) { - xlog("proceesing suspended in trasaction [$T(id_index):$T(id_label)]\n"); + xlog("processing suspended in transaction [$T(id_index):$T(id_label)]\n"); exit; } ... diff --git a/src/modules/topoh/README b/src/modules/topoh/README index 2c6e3d17b73..45e4b904d7f 100644 --- a/src/modules/topoh/README +++ b/src/modules/topoh/README @@ -93,7 +93,7 @@ Chapter 1. Admin Guide The module is transparent for the configuration writer. It only needs to be loaded (tune the parameters if needed). The SIP server can be - restarted whitout affecting ongoing calls - once it is up, can + restarted without affecting ongoing calls - once it is up, can encode/decode topology details, thus no call will be lost. By using same mask_key, many SIP servers can decode the message, for @@ -234,7 +234,7 @@ modparam("topoh", "callid_prefix", "***") If set to 1, topoh module will bind to sanity module in order to perform sanity checks over received SIP request. Default sanity checks - are done. It is useful to check if received request is well formated + are done. It is useful to check if received request is well formatted before proceeding to encoding/decoding. Default value is 0 (do not bind to sanity module). @@ -253,8 +253,8 @@ modparam("topoh", "sanity_checks", 1) Note: do not enable this option if you have SIP devices that can alter the URI values it takes from Contact or Record-Route headers (like - adding port 5060 when no port is in received URIs, or thet introduce - new parameters at unknown position). + adding port 5060 when no port is in received URIs, or that introduces + new parameters at an unknown position). Default value is 0. diff --git a/src/modules/topos/README b/src/modules/topos/README index c9211171319..4a6f4d71836 100644 --- a/src/modules/topos/README +++ b/src/modules/topos/README @@ -163,7 +163,7 @@ modparam("topos", "mask_callid", 1) If set to 1, topoh module will bind to sanity module in order to perform sanity checks over received SIP request. Default sanity checks - are done. It is useful to check if received request is well formated + are done. It is useful to check if received request is well formatted before proceeding to encoding/decoding. Default value is 0 (do not bind to sanity module). diff --git a/src/modules/tsilo/README b/src/modules/tsilo/README index a60594a0441..453a9a7e4e6 100644 --- a/src/modules/tsilo/README +++ b/src/modules/tsilo/README @@ -214,7 +214,7 @@ if (is_method("REGISTER")) { pseudo-variable. * domain - Name of table that should be used for looking up new contacts for r-uri. - * uri (optiona) - uri for which to do lookup for new destinations. + * uri (optional) - uri for which to do lookup for new destinations. This function can be used from REQUEST_ROUTE, FAILURE_ROUTE. diff --git a/src/modules/uac/README b/src/modules/uac/README index 5ac08ebbb30..fa0e072fd61 100644 --- a/src/modules/uac/README +++ b/src/modules/uac/README @@ -710,7 +710,7 @@ uac_req_send(); 4.9. uac_reg_lookup(uuid, dst) This function sets the PV dst to SIP URI that correspond to uuid in uac - registations table. uuid and dst must be pseudo-variables. + registrations table. uuid and dst must be pseudo-variables. This function can be used from ANY_ROUTE. diff --git a/src/modules/uac_redirect/README b/src/modules/uac_redirect/README index 11e251ba7a4..db105862b06 100644 --- a/src/modules/uac_redirect/README +++ b/src/modules/uac_redirect/README @@ -160,8 +160,8 @@ modparam("uac_redirect","default_filter","deny") 4.2. deny_filter (string) - The regular expression for default deny filtering. It make sens to be - defined on only if the default_filter parameter is set to “accept”. All + The regular expression for default deny filtering. It makes sense to be + defined only if the default_filter parameter is set to “accept”. All contacts matching the deny_filter will be rejected; the rest of them will be accepted for redirection. @@ -178,8 +178,8 @@ modparam("uac_redirect","deny_filter",".*@siphub\.net") 4.3. accept_filter (string) - The regular expression for default accept filtering. It make sens to be - defined on only if the default_filter parameter is set to “deny”. All + The regular expression for default accept filtering. It makes sense to + be defined only if the default_filter parameter is set to “deny”. All contacts matching the accept_filter will be accepted; the rest of them will be rejected for redirection. diff --git a/src/modules/uid_avp_db/README b/src/modules/uid_avp_db/README index d5a1803a4ec..2dc71e383d0 100644 --- a/src/modules/uid_avp_db/README +++ b/src/modules/uid_avp_db/README @@ -84,7 +84,7 @@ Chapter 1. Admin Guide the contents of AVPs (Attribute-Value pairs). The AVPs are variables attached to the SIP message being processed. Each variable has its name and value. AVPs can be used to store arbitrary data or as a means of - inter-module comminication. + inter-module communication. You may also want to check the avpops module which is more flexible and contains more functions. In future SER releases the avp module will be @@ -296,7 +296,7 @@ route { id Identifier used for searching attributes. When searching for - user attributes it is UID, when searchnig uri attributes it is + user attributes it is UID, when searching uri attributes it is URI. 4.2. load_extra_attrs (group_id, id) diff --git a/src/modules/uid_domain/README b/src/modules/uid_domain/README index 08889ae5fb7..a10646eed53 100644 --- a/src/modules/uid_domain/README +++ b/src/modules/uid_domain/README @@ -256,7 +256,7 @@ iptel cached in memory, just like virtual domain themselves. If you disable caching then the domain module will attempt to load attributes from the database each time you call lookup_domain. Attributes cached in memory - can be realoaded with the domain.reload management function. + can be reloaded with the domain.reload management function. 1.3. Caching diff --git a/src/modules/uri_db/README b/src/modules/uri_db/README index c00e1d48584..b11772e641b 100644 --- a/src/modules/uri_db/README +++ b/src/modules/uri_db/README @@ -176,7 +176,7 @@ modparam("uri_db", "uriuser_column", "uri_user") 3.6. use_uri_table (integer) - Specify if the “uri” table should be used for checkings instead of + Specify if the “uri” table should be used for checking instead of “subscriber” table. A non-zero value means true. Default value is “0 (false)”. diff --git a/src/modules/userblacklist/README b/src/modules/userblacklist/README index b91c3e19211..d2d3c5444b4 100644 --- a/src/modules/userblacklist/README +++ b/src/modules/userblacklist/README @@ -234,9 +234,9 @@ modparam("userblacklist", "use_domain", 1) 3.2. match_mode (integer) The number of individual characters that are used for matching. Valid - values are 10 or 128. When you specifiy 10, only digits will be used - for matching, this operation mode is equivalent to the old behaviour. - When configured with 128, all standard ASCII chars are available for + values are 10 or 128. When you specify 10, only digits will be used for + matching, this operation mode is equivalent to the old behaviour. When + configured with 128, all standard ASCII chars are available for matching. Please be aware that memory requirements for storing the routing tree in shared memory will also increase by a factor of 12.8. diff --git a/src/modules/usrloc/README b/src/modules/usrloc/README index 58fe8f7d80a..579b1ff5d64 100644 --- a/src/modules/usrloc/README +++ b/src/modules/usrloc/README @@ -285,9 +285,8 @@ Chapter 1. Admin Guide The SIP RFC 3261 publishes a matching algorithm based only on the contact string with Call-id and Cseq extra checking (if the Call-ID is the same, it must have a higher Cseq number, otherwise it is invalid). - But as argumented above, this is not enough in NAT traversal context, - so the Kamailio implementation of contact matching offers more - algorithms: + But as argued above, this is not enough in NAT traversal context, so + the Kamailio implementation of contact matching offers more algorithms: * Contact based only - it is strict RFC 3261 compliancy - the Contact URI is matched as string and extra checked via Call-ID and cseq (if Call-ID is the same, it must have a higher cseq number, otherwise @@ -303,9 +302,9 @@ Chapter 1. Admin Guide * Call-id only based - it is not according to RFC3261, as it will check the Call-ID only (independent of the Contact-Header or Path). - To find out how to control/select the contact maching algorithm, please - see the module parameter matching_mode - Section 3.29, “matching_mode - (integer)”. + To find out how to control/select the contact matching algorithm, + please see the module parameter matching_mode - Section 3.29, + “matching_mode (integer)”. 2. Dependencies @@ -612,7 +611,7 @@ modparam("usrloc", "partition_column", "part") 3.22. use_domain (integer) If the domain part of the user should be also saved and used for - identifing the user (along with the username part). Useful in multi + identifying the user (along with the username part). Useful in multi domain scenarios. Non 0 value means true. Default value is “0 (false)”. @@ -688,7 +687,7 @@ modparam("usrloc", "db_url", "dbdriver://username:password@dbhost/dbname") more servers sharing the same DB without any replication at SIP level. The mode may be slower due the high number of DB operation. For example NAT pinging is a killer since during each ping cycle - all nated contact are loaded from the DB; The lack of memory + all natted contact are loaded from the DB; The lack of memory caching also disable the statistics exports. * 4 - This uses database to load records at startup but uses only memory during the runtime. Records are not written back at all, not @@ -847,7 +846,7 @@ modparam("usrloc", "db_check_update", 1) 3.36. timer_procs (string) Number of timer processes to be started by module. Timer processes take - care of checking expired records and syncronization with database. If + care of checking expired records and synchronization with database. If set to 0, no dedicated timer is started, the one from core will be used. @@ -947,7 +946,7 @@ modparam("usrloc", "db_raw_fetch_type", 1) not have table definitions that create automatically the null fields (e.g., db_mongodb) for each stored record. - When set to 0, the fiels that default to null are not added to the DB + When set to 0, the fields that default to null are not added to the DB insert statement if they don't have a different value, making the query smaller. @@ -1110,24 +1109,24 @@ modparam("usrloc", "rm_expired_delay", 30) 5.1. users Number of AOR existing in the USRLOC memory cache for that domain - can - not be resetted; this statistic will be register for each used domain - (Ex: location). + not be reset; this statistic will be register for each used domain (Ex: + location). 5.2. contacts Number of contacts existing in the USRLOC memory cache for that domain - - can not be resetted; this statistic will be register for each used + - can not be reset; this statistic will be register for each used domain (Ex: location). 5.3. expires - Total number of expired contacts for that domain - can be resetted; - this statistic will be register for each used domain (Ex: location). + Total number of expired contacts for that domain - can be reset; this + statistic will be register for each used domain (Ex: location). 5.4. registered_users Total number of AOR existing in the USRLOC memory cache for all domains - - can not be resetted. + - can not be reset. Chapter 2. Developer Guide diff --git a/src/modules/xcap_server/README b/src/modules/xcap_server/README index 7f8c9af6e88..8cff81ec738 100644 --- a/src/modules/xcap_server/README +++ b/src/modules/xcap_server/README @@ -88,15 +88,15 @@ Chapter 1. Admin Guide 1. Overview - This module provides an XCAP server functionaly inside Kamailio and SER - SIP servers. + This module provides an XCAP server functionally inside Kamailio and + SER SIP servers. Benefits brought by this integrated XCAP server: * reuse of SIP router transport layer - XCAP documents can be sent via SIP (UDP, TCP, TLS and SCTP) and via HTTP (TCP or TLS (HTTPS)). - For HTTP/S, you neet to load XHTTP module to handle HTTP/S + For HTTP/S, you need to load XHTTP module to handle HTTP/S requests. - * the Presence server has access imediatelly to the latest version of + * the Presence server has access immediately to the latest version of XCAP documents. No more need to trigger refresh of XCAP documents via RPC command. * can be used stand-alone, with a different Presence server. It is @@ -210,7 +210,7 @@ modparam("xcap_server", "xml_ns", The URLs in an org.oma.xcap-directory listing must be be paths a client can use to download the listed XCAP documents. In some cases (for example, when the XCAP server is accessed using HTTP from an HTTP proxy - the client connectes to using HTTPS) the XCAP server may not be able to + the client connected to using HTTPS) the XCAP server may not be able to automatically determine the correct scheme to use based on the HTTP connection. * -1 (default) - determine scheme automatically. HTTP for TCP @@ -232,7 +232,7 @@ modparam("xcap_server", "directory_scheme", 0) The URLs in an org.oma.xcap-directory listing must be be paths a client can use to download the listed XCAP documents. In some cases (for example, when the XCAP server is accessed through a proxy that - re-writes headers, or a client is non-conformant and does not include a + re-writes headers, or a client is non-conforming and does not include a Host: header) the XCAP server may not be able to automatically determine the correct hostname to use. diff --git a/src/modules/xhttp_pi/README b/src/modules/xhttp_pi/README index 967acef66b2..f1904aa2b8f 100644 --- a/src/modules/xhttp_pi/README +++ b/src/modules/xhttp_pi/README @@ -104,7 +104,7 @@ Chapter 1. Admin Guide 2. Usage - The layout of the provisionning interface is controlled via an external + The layout of the provisioning interface is controlled via an external xml file (see the framework parameter). An example of a framework xml file is provided inside the Kamailio's examples directory. A simple framework file can be generated by the kamdbctl command: @@ -221,7 +221,7 @@ kamdbctl pframework create 4. To-do Features to be added in the future: - * full subscriber provisionning with automatic ha1/ha1b fields. + * full subscriber provisioning with automatic ha1/ha1b fields. 5. Dependencies @@ -247,9 +247,9 @@ kamdbctl pframework create 6.1. xhttp_pi_root (str) - It specifies the root path for provisionning http requests. The link to + It specifies the root path for provisioning http requests. The link to the provisioning web interface must be constructed using the following - patern: http://[server_IP]:[tcp_port]/[xhttp_pi_root] + pattern: http://[server_IP]:[tcp_port]/[xhttp_pi_root] Default value is "pi". diff --git a/src/modules/xlog/README b/src/modules/xlog/README index 08422c3f339..82fe9285300 100644 --- a/src/modules/xlog/README +++ b/src/modules/xlog/README @@ -268,7 +268,7 @@ modparam("xlog", "long_format", 1) 5.1. xlog([ [facility,] level,] format) - Output a formated log message. + Output a formatted log message. Meaning of the parameters are as follows: * facility - The syslog facility that will be used for this single diff --git a/src/modules/xmlrpc/README b/src/modules/xmlrpc/README index 52554848e00..da60fb81b70 100644 --- a/src/modules/xmlrpc/README +++ b/src/modules/xmlrpc/README @@ -486,7 +486,7 @@ Content-Length: 276 trying to open tcp connection to xmlrpc clients that closed it). Alternatively ending the XMLRPC route with return -1, exit -1 or drop -1 can also be used, but note that this will not work for async rpcs - (it will close the connection immeidately and not on the async + (it will close the connection immediately and not on the async response). Example 1. diff --git a/src/modules/xmpp/README b/src/modules/xmpp/README index a42a56a1ed1..dd762ec174c 100644 --- a/src/modules/xmpp/README +++ b/src/modules/xmpp/README @@ -138,7 +138,7 @@ Chapter 1. Admin Guide In the XMPP stand-alone server mode, the XMPP module is a minimal XMPP/Jabber server. In this mode, another Jabber server is not needed. - The gateway will connect to other XMPP servers basaed on the JID domain + The gateway will connect to other XMPP servers based on the JID domain and by using the standardized XMPP S2S protocol. If you want to change to server-mode, you have to change the "backend" @@ -162,7 +162,7 @@ Chapter 1. Admin Guide 'delim' is a character that can be set via 'domain_separator' parameter. - If 'gwmap' parameter is used, then the addresses are not enconding the + If 'gwmap' parameter is used, then the addresses are not encoding the domains in the username part. They are going to be straight 'username@domain' always. diff --git a/src/modules/xprint/README b/src/modules/xprint/README index 4b0b4ee8c40..d86509ab4bb 100644 --- a/src/modules/xprint/README +++ b/src/modules/xprint/README @@ -94,7 +94,7 @@ Chapter 1. Admin Guide * %ft : 'From' tag * %Hn : host's hostname (if system hostname is FQDN, part before first .) - * %Hd : host's domain (if system hosntame is FQDN, part behind first + * %Hd : host's domain (if system hostname is FQDN, part behind first .) * %Hf : host's FQDN hostname * %Hi : host's IP address @@ -133,7 +133,7 @@ Chapter 1. Admin Guide headers of that type are printed. The module should identify most of compact header names (the ones recognized by ser which should be all at this moment), if not, the - compact form has to be specified explicitely. It is recommended to + compact form has to be specified explicitly. It is recommended to use dedicated specifiers for headers (e.g., %ua for user agent header), if they are available -- they are faster. * % : print the value of AVP optionally %indexed by the [N] @@ -147,8 +147,8 @@ Chapter 1. Admin Guide extend select framework calls). * %| or %(space) : end of %@select.framework identifier. If you need to concatenate select framework call and another non-whitespace - literal, you need to explicitelly set the end of the select - framework identifier. + literal, you need to explicitly set the end of the select framework + identifier. E.g. %@ruri.user%|@%@ruri.host converts all featured request uri into user@host form only. @@ -174,7 +174,7 @@ modparam("xprint", "buf_size", 8192) 4.1. xplog(level, format) - Print a formated message using LOG function. + Print a formatted message using LOG function. Meaning of the parameters is as follows: * level - The level that will be used in LOG function. It can be: