From f8b099436b654515ef75c61acb1abb0fea53b62d Mon Sep 17 00:00:00 2001 From: Kamailio Dev Date: Thu, 11 Jun 2020 16:04:43 +0200 Subject: [PATCH] modules: readme files regenerated - modules ... [skip ci] --- src/modules/app_lua_sr/README | 4 +- src/modules/app_mono/README | 2 - src/modules/app_perl/README | 58 +++++++++++++------------- src/modules/auth_radius/README | 2 - src/modules/cdp_avp/README | 32 +++++++------- src/modules/dmq/README | 2 - src/modules/domainpolicy/README | 2 - src/modules/geoip/README | 2 - src/modules/ims_dialog/README | 56 +++++++++++-------------- src/modules/ims_usrloc_pcscf/README | 32 +++++++------- src/modules/jansson/README | 2 - src/modules/kemix/README | 2 +- src/modules/mqueue/README | 6 --- src/modules/msrp/README | 2 - src/modules/mtree/README | 2 - src/modules/path/README | 2 - src/modules/pdb/README | 2 - src/modules/permissions/README | 6 --- src/modules/pipelimit/README | 2 - src/modules/presence_dialoginfo/README | 2 - src/modules/presence_profile/README | 2 - src/modules/ratelimit/README | 4 -- src/modules/sdpops/README | 16 +++---- src/modules/siputils/README | 4 -- src/modules/snmpstats/README | 2 - src/modules/tmrec/README | 4 -- src/modules/uri_db/README | 2 - src/modules/xhttp/README | 2 - src/modules/xhttp_prom/README | 14 +++---- 29 files changed, 102 insertions(+), 168 deletions(-) diff --git a/src/modules/app_lua_sr/README b/src/modules/app_lua_sr/README index 77b82248d10..8446e0d2f1e 100644 --- a/src/modules/app_lua_sr/README +++ b/src/modules/app_lua_sr/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla - Copyright � 2010-2019 Daniel-Constantin Mierla (asipto.com) + Copyright © 2010-2019 Daniel-Constantin Mierla (asipto.com) __________________________________________________________________ Table of Contents @@ -138,7 +138,7 @@ Chapter 1. Admin Guide Note that 'sr', 'sr.hdr' and 'sr.pv' modules are always registered to Lua. - Default value is "null". + Default value is “null”. Example 1.2. Set register parameter ... diff --git a/src/modules/app_mono/README b/src/modules/app_mono/README index 52100a42a81..45fa2028bbc 100644 --- a/src/modules/app_mono/README +++ b/src/modules/app_mono/README @@ -10,8 +10,6 @@ Daniel-Constantin Mierla -Edited by - Alex Balashov diff --git a/src/modules/app_perl/README b/src/modules/app_perl/README index b554b3b8542..c6f42f585e0 100644 --- a/src/modules/app_perl/README +++ b/src/modules/app_perl/README @@ -1650,45 +1650,45 @@ Chapter 4. Frequently Asked Questions 4.1. - Are there known bugs in the Perl module? - - The Perl module does have a few shortcomings that may be regarded as - bugs. - * Missing module functions. Not all functions of other modules are - available for Perl access. The reason for this is a design property - of Kamailio. Making available more functions is work in progress. - * Perl and threads. Perl itself is, when compiled with the correct - parameters, thread safe; unfortunately, not all Perl modules are. - The DBI modules, especially (but not restricted to) DBI::ODBC are - known NOT to be thread safe. - Using DBI::ODBC -- and possibly other non-thread-safe Perl - extensions -- may result in erroneous behavior of Kamailio, - including (but not restricted to) server crashes and wrong routing. + Are there known bugs in the Perl module? + + The Perl module does have a few shortcomings that may be regarded as + bugs. + * Missing module functions. Not all functions of other modules are + available for Perl access. The reason for this is a design property + of Kamailio. Making available more functions is work in progress. + * Perl and threads. Perl itself is, when compiled with the correct + parameters, thread safe; unfortunately, not all Perl modules are. + The DBI modules, especially (but not restricted to) DBI::ODBC are + known NOT to be thread safe. + Using DBI::ODBC -- and possibly other non-thread-safe Perl + extensions -- may result in erroneous behavior of Kamailio, + including (but not restricted to) server crashes and wrong routing. 4.2. - Where can I find more about Kamailio? + Where can I find more about Kamailio? - Take a look at https://www.kamailio.org/. + Take a look at https://www.kamailio.org/. 4.3. - Where can I post a question about this module? + Where can I post a question about this module? - First at all check if your question was already answered on one of our - mailing lists: - * User Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users - * Developer Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev + First at all check if your question was already answered on one of our + mailing lists: + * User Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users + * Developer Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev - E-mails regarding any stable Kamailio release should be sent to - and e-mails regarding development - versions should be sent to . + E-mails regarding any stable Kamailio release should be sent to + and e-mails regarding development + versions should be sent to . 4.4. - How can I report a bug? + How can I report a bug? - Please follow the guidelines provided at: - https://github.com/kamailio/kamailio/issues. + Please follow the guidelines provided at: + https://github.com/kamailio/kamailio/issues. diff --git a/src/modules/auth_radius/README b/src/modules/auth_radius/README index ff0a1ad8660..4640043e998 100644 --- a/src/modules/auth_radius/README +++ b/src/modules/auth_radius/README @@ -22,8 +22,6 @@ Jan Janak -Edited by - Phil Lavin diff --git a/src/modules/cdp_avp/README b/src/modules/cdp_avp/README index 4cff2f2ed32..6466a28aeca 100644 --- a/src/modules/cdp_avp/README +++ b/src/modules/cdp_avp/README @@ -8,8 +8,6 @@ Edited by Jason Penton -Edited by - Richard Good Copyright © 2006 FhG Fokus @@ -1658,28 +1656,28 @@ Chapter 3. Frequently Asked Questions 3.1. - Where can I find more about Kamailio? + Where can I find more about Kamailio? - Take a look at https://www.kamailio.org/. + Take a look at https://www.kamailio.org/. 3.2. - Where can I post a question about this module? + Where can I post a question about this module? - First at all check if your question was already answered on one of our - mailing lists: - * User Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users - * Developer Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev + First at all check if your question was already answered on one of our + mailing lists: + * User Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users + * Developer Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev - E-mails regarding any stable Kamailio release should be sent to - and e-mails regarding development - versions should be sent to . + E-mails regarding any stable Kamailio release should be sent to + and e-mails regarding development + versions should be sent to . 3.3. - How can I report a bug? + How can I report a bug? - Please follow the guidelines provided at: - https://github.com/kamailio/kamailio/issues. + Please follow the guidelines provided at: + https://github.com/kamailio/kamailio/issues. diff --git a/src/modules/dmq/README b/src/modules/dmq/README index d4ddcb8645a..c4c0dab8a00 100644 --- a/src/modules/dmq/README +++ b/src/modules/dmq/README @@ -14,8 +14,6 @@ Edited by Marius Ovidiu Bucur -Edited by - Charles Chance Copyright © 2011 Marius Bucur diff --git a/src/modules/domainpolicy/README b/src/modules/domainpolicy/README index a943e10b973..4afc20a0fe4 100644 --- a/src/modules/domainpolicy/README +++ b/src/modules/domainpolicy/README @@ -14,8 +14,6 @@ Otmar Lendl -Edited by - Klaus Darilion diff --git a/src/modules/geoip/README b/src/modules/geoip/README index 1ab9a0be06b..051fba60b40 100644 --- a/src/modules/geoip/README +++ b/src/modules/geoip/README @@ -10,8 +10,6 @@ Daniel-Constantin Mierla -Edited by - Alex Balashov Evariste Systems LLC diff --git a/src/modules/ims_dialog/README b/src/modules/ims_dialog/README index 4560f2569d9..ee1f8603540 100644 --- a/src/modules/ims_dialog/README +++ b/src/modules/ims_dialog/README @@ -20,16 +20,10 @@ Edited by Bogdan-Andrei Iancu -Edited by - Carsten Bock -Edited by - Jason Penton -Edited by - Richard Good Copyright © 2006 Voice Sistem SRL @@ -1053,46 +1047,46 @@ Chapter 3. Frequently Asked Questions 3.1. - What happened with “use_tight_match” parameter? + What happened with “use_tight_match” parameter? - The parameter was removed with version 1.3 as the option of tight - matching became mandatory and not configurable. Now, the tight matching - is done all the time (when using DID matching). + The parameter was removed with version 1.3 as the option of tight + matching became mandatory and not configurable. Now, the tight matching + is done all the time (when using DID matching). 3.2. - Why is there a ims_dialog module and a dialog module? + Why is there a ims_dialog module and a dialog module? - The ims_dialog module addresses shortcomings in the initial dialog - module design. It makes some large changes to the API and therefore - must be introduced slowly. It is currently in the early development - stages. Eventually the ims_dialog module should replace the dialog - module. + 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 + module. 3.3. - Where can I find more about Kamailio? + Where can I find more about Kamailio? - Take a look at https://www.kamailio.org/. + Take a look at https://www.kamailio.org/. 3.4. - Where can I post a question about this module? + Where can I post a question about this module? - First at all check if your question was already answered on one of our - mailing lists: - * User Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users - * Developer Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev + First at all check if your question was already answered on one of our + mailing lists: + * User Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users + * Developer Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev - E-mails regarding any stable Kamailio release should be sent to - and e-mails regarding development - versions should be sent to . + E-mails regarding any stable Kamailio release should be sent to + and e-mails regarding development + versions should be sent to . 3.5. - How can I report a bug? + How can I report a bug? - Please follow the guidelines provided at: - https://github.com/kamailio/kamailio/issues. + Please follow the guidelines provided at: + https://github.com/kamailio/kamailio/issues. diff --git a/src/modules/ims_usrloc_pcscf/README b/src/modules/ims_usrloc_pcscf/README index c33652c9e09..93efefc0765 100644 --- a/src/modules/ims_usrloc_pcscf/README +++ b/src/modules/ims_usrloc_pcscf/README @@ -10,8 +10,6 @@ Richard Good Smile Communications -Edited by - Carsten Bock ng-voice GmbH @@ -234,28 +232,28 @@ Chapter 2. Frequently Asked Questions 2.1. - Where can I find more about Kamailio? + Where can I find more about Kamailio? - Take a look at https://www.kamailio.org/. + Take a look at https://www.kamailio.org/. 2.2. - Where can I post a question about this module? + Where can I post a question about this module? - First at all check if your question was already answered on one of our - mailing lists: - * User Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users - * Developer Mailing List - - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev + First at all check if your question was already answered on one of our + mailing lists: + * User Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users + * Developer Mailing List - + https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev - E-mails regarding any stable Kamailio release should be sent to - and e-mails regarding development - versions should be sent to . + E-mails regarding any stable Kamailio release should be sent to + and e-mails regarding development + versions should be sent to . 2.3. - How can I report a bug? + How can I report a bug? - Please follow the guidelines provided at: - https://github.com/kamailio/kamailio/issues. + Please follow the guidelines provided at: + https://github.com/kamailio/kamailio/issues. diff --git a/src/modules/jansson/README b/src/modules/jansson/README index b79a31ba826..a68d7f43f0c 100644 --- a/src/modules/jansson/README +++ b/src/modules/jansson/README @@ -10,8 +10,6 @@ Matthew Williams -Edited by - Carsten Bock diff --git a/src/modules/kemix/README b/src/modules/kemix/README index 1fa5a94af37..4f5272e2c6b 100644 --- a/src/modules/kemix/README +++ b/src/modules/kemix/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla - Copyright � 2019 asipto.com + Copyright © 2019 asipto.com __________________________________________________________________ Table of Contents diff --git a/src/modules/mqueue/README b/src/modules/mqueue/README index 9bc250dfd06..4ad5b6915a1 100644 --- a/src/modules/mqueue/README +++ b/src/modules/mqueue/README @@ -10,22 +10,16 @@ Elena-Ramona Modroiu -Edited by - Alex Balashov Evariste Systems -Edited by - Ovidiu Sas VoIP Embedded, Inc. -Edited by - Julien Chavanton diff --git a/src/modules/msrp/README b/src/modules/msrp/README index b55af6955d4..21335e35d34 100644 --- a/src/modules/msrp/README +++ b/src/modules/msrp/README @@ -10,8 +10,6 @@ Daniel-Constantin Mierla -Edited by - Alex Balashov diff --git a/src/modules/mtree/README b/src/modules/mtree/README index 36d3fee7500..9e401d79cea 100644 --- a/src/modules/mtree/README +++ b/src/modules/mtree/README @@ -14,8 +14,6 @@ Juha Heinanen tutpro.com -Edited by - Juha Heinanen diff --git a/src/modules/path/README b/src/modules/path/README index 4d6e7cba5c1..6cb156be0a8 100644 --- a/src/modules/path/README +++ b/src/modules/path/README @@ -8,8 +8,6 @@ Edited by Andreas Granig -Edited by - Richard Fuchs Copyright © 2006 Inode GmbH diff --git a/src/modules/pdb/README b/src/modules/pdb/README index 1857dbf2b20..95d023bb31f 100644 --- a/src/modules/pdb/README +++ b/src/modules/pdb/README @@ -7,8 +7,6 @@ Henning Westerholt 1&1 Internet AG -Edited by - Pawel Kuzak 1&1 Internet AG diff --git a/src/modules/permissions/README b/src/modules/permissions/README index 8452d58face..0a95a2c33f9 100644 --- a/src/modules/permissions/README +++ b/src/modules/permissions/README @@ -6,16 +6,10 @@ Edited by Miklos Tirpak -Edited by - Bogdan-Andrei Iancu -Edited by - Juha Heinanen -Edited by - Emmanuel Schmidbauer Copyright © 2003 Miklos Tirpak diff --git a/src/modules/pipelimit/README b/src/modules/pipelimit/README index 3a1a3cc1302..c98dd302a34 100644 --- a/src/modules/pipelimit/README +++ b/src/modules/pipelimit/README @@ -8,8 +8,6 @@ Edited by Ovidiu Sas -Edited by - Daniel-Constantin Mierla Copyright © 2013 VoIPEmbedded Inc. diff --git a/src/modules/presence_dialoginfo/README b/src/modules/presence_dialoginfo/README index 70ffe87ae7a..e21ea7acc24 100644 --- a/src/modules/presence_dialoginfo/README +++ b/src/modules/presence_dialoginfo/README @@ -13,8 +13,6 @@ Juha Heinanen -Edited by - Klaus Darilion diff --git a/src/modules/presence_profile/README b/src/modules/presence_profile/README index c5f670e8ff7..024a87e1982 100644 --- a/src/modules/presence_profile/README +++ b/src/modules/presence_profile/README @@ -10,8 +10,6 @@ Mészáros Mihály -Edited by - Alex Balashov diff --git a/src/modules/ratelimit/README b/src/modules/ratelimit/README index 8848155a9ce..ecd6fce79a1 100644 --- a/src/modules/ratelimit/README +++ b/src/modules/ratelimit/README @@ -10,12 +10,8 @@ Edited by Ovidiu Sas -Edited by - Bogdan Vasile Harjoc -Edited by - Hendrik Scholz Copyright © 2006 Freenet Cityline GmbH diff --git a/src/modules/sdpops/README b/src/modules/sdpops/README index 476ff7c410b..9ea0e33abb6 100644 --- a/src/modules/sdpops/README +++ b/src/modules/sdpops/README @@ -315,17 +315,17 @@ if(sdp_with_active_media("video")) contain the exact same number of "m=" lines as the request. - 6 Generating the Answer + 6 Generating the Answer - [...] + [...] - For each "m=" line in the offer, there MUST be a corresponding "m=" - line in the answer. The answer MUST contain exactly the same number of - "m=" lines as the offer. This allows for streams to be matched up based - on their order. This implies that if the offer contained zero "m=" - lines, the answer MUST contain zero "m=" lines. + For each "m=" line in the offer, there MUST be a corresponding "m=" + line in the answer. The answer MUST contain exactly the same number of + "m=" lines as the offer. This allows for streams to be matched up based + on their order. This implies that if the offer contained zero "m=" + lines, the answer MUST contain zero "m=" lines. - --RFC 3264 + --RFC 3264 So this may not work with all Endpoints, especially if they follow RFC 3264 precisely (e.g. JSSIP). diff --git a/src/modules/siputils/README b/src/modules/siputils/README index 390ef1b3cb0..74344a83c15 100644 --- a/src/modules/siputils/README +++ b/src/modules/siputils/README @@ -32,12 +32,8 @@ Edited by Jan Janak -Edited by - Bogdan-Andrei Iancu -Edited by - Gabriel Vasile Copyright © 2008, 2005, 2003 1&1 Internet AG, FhG Fokus, Voice Sistem diff --git a/src/modules/snmpstats/README b/src/modules/snmpstats/README index 464dd5e58b1..5308308e36a 100644 --- a/src/modules/snmpstats/README +++ b/src/modules/snmpstats/README @@ -8,8 +8,6 @@ Edited by Jeffrey Magder -Edited by - Olle E. Johansson Copyright © 2006 SOMA Networks, Inc. diff --git a/src/modules/tmrec/README b/src/modules/tmrec/README index bcb8380ee93..7da2a2e3876 100644 --- a/src/modules/tmrec/README +++ b/src/modules/tmrec/README @@ -10,14 +10,10 @@ Daniel-Constantin Mierla -Edited by - Alex Balashov -Edited by - Richard Fuchs diff --git a/src/modules/uri_db/README b/src/modules/uri_db/README index 589fba5b0a8..a4a19a8c1fe 100644 --- a/src/modules/uri_db/README +++ b/src/modules/uri_db/README @@ -8,8 +8,6 @@ Edited by Jan Janak -Edited by - Bogdan-Andrei Iancu Copyright © 2003 FhG FOKUS diff --git a/src/modules/xhttp/README b/src/modules/xhttp/README index babbed95462..a38599775fd 100644 --- a/src/modules/xhttp/README +++ b/src/modules/xhttp/README @@ -10,8 +10,6 @@ Daniel-Constantin Mierla -Edited by - Alex Balashov diff --git a/src/modules/xhttp_prom/README b/src/modules/xhttp_prom/README index df07cbff4f2..a6c2e958686 100644 --- a/src/modules/xhttp_prom/README +++ b/src/modules/xhttp_prom/README @@ -14,7 +14,7 @@ Javier Gallart - Copyright � 2019 www.sonoc.io + Copyright © 2019 www.sonoc.io __________________________________________________________________ Table of Contents @@ -296,7 +296,7 @@ modparam("xhttp_prom", "prom_gauge", "name=gg_third; label=method:handler;"); 4.5. prom_dispatch() 4.6. prom_check_uri() -4.1. prom_counter_reset(name, l0, l1, l2) +4.1. prom_counter_reset(name, l0, l1, l2) Get a counter based on its name and labels and reset its value to 0. Name parameter is mandatory. Values of labels are optional (from none @@ -325,7 +325,7 @@ prom_counter_reset("cnt01", "push", "192.168.0.1"); kamailio_cnt01 {method="push", IP="192.168.0.1"} 0 1234567890 ... -4.2. prom_gauge_reset(name, l0, l1, l2) +4.2. prom_gauge_reset(name, l0, l1, l2) Get a gauge based on its name and labels and reset its value to 0. Name parameter is mandatory. Values of labels are optional (from none up to @@ -352,7 +352,7 @@ prom_gauge_reset("cnt01", "push", "192.168.0.1"); kamailio_cnt01 {method="push", IP="192.168.0.1"} 0 1234567890 ... -4.3. prom_counter_inc(name, number, l0, l1, l2) +4.3. prom_counter_inc(name, number, l0, l1, l2) Get a counter identified by its name and labels and increase its value by a number. If counter does not exist it creates the counter, @@ -389,7 +389,7 @@ prom_counter_inc("cnt02", "15", "push", "192.168.0.1"); kamailio_cnt02 {method="push", IP="192.168.0.1"} 15 1234567890 ... -4.4. prom_gauge_set(name, number, l0, l1, l2) +4.4. prom_gauge_set(name, number, l0, l1, l2) Get a gauge identified by its name and labels and set its value to a number. If gauge does not exist it creates the gauge and assigns the @@ -426,7 +426,7 @@ prom_gauge_set("gg02", "2.8", "push", "192.168.0.1"); kamailio_gg02 {method="push", IP="192.168.0.1"} 2.8 1234567890 ... -4.5. prom_dispatch() +4.5. prom_dispatch() Handle the HTTP request and generate a response. @@ -526,7 +526,7 @@ kamailio_sl_sent_replies 15 1554839325427 kamailio_sl_xxx_replies 0 1554839325461 ... -4.6. prom_check_uri() +4.6. prom_check_uri() Check if path of HTTP URL equals /metrics. This avoids us to check hu variable from xHTTP module.