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

src/modules/auth/README

@@ -721,8 +721,8 @@ if (has_credentials("myrealm")) {
    The function challenges a user agent. It will generate a WWW-Authorize
    header field containing a digest challenge, it will put the header
    field into a response generated from the request the server is
-   processing and send the reply. Upon reception of such a reply the user
-   agent should compute credentials and retry the request. For more
+   processing and send the 401 reply. Upon reception of such a reply the
+   user agent should compute credentials and retry the request. For more
    information regarding digest authentication see RFC2617. See module
    parameter force_stateless_reply regarding sending of the reply.
 
@@ -758,10 +758,10 @@ if (!www_authenticate("$td", "subscriber")) {
    The function challenges a user agent. It will generate a
    Proxy-Authorize header field containing a digest challenge, it will put
    the header field into a response generated from the request the server
-   is processing and send the reply. Upon reception of such a reply the
-   user agent should compute credentials and retry the request. For more
-   information regarding digest authentication see RFC2617. See module
-   parameter force_stateless_reply regarding sending of the reply.
+   is processing and send the 407 reply. Upon reception of such a reply
+   the user agent should compute credentials and retry the request. For
+   more information regarding digest authentication see RFC2617. See
+   module parameter force_stateless_reply regarding sending of the reply.
 
    Meaning of the parameters is the same as for function
    www_challenge(realm, flags)
@@ -780,7 +780,9 @@ if (!proxy_authenticate("$fd", "subscriber")) {
    The function challenges a user agent for authentication. It combines
    the functions www_challenge() and proxy_challenge(), by calling
    internally the first one for REGISTER requests and the second one for
-   the rest of other request types.
+   the rest of other request types. In other words, it challenges for
+   authentication by sending a 401 reply for REGISTER requests and 407
+   reply for the other types of SIP requests.
 
    Meaning of the parameters the same as for function www_challenge(realm,
    flags)

src/modules/cnxcc/README

@@ -41,11 +41,11 @@ Carlos Ruiz Díaz
 
         6. Events
         7. Web Interface
-        8. Sample
+        8. Sample Config
 
    List of Examples
 
-   1.1. dlg_flag
+   1.1.
    1.2. credit_check_period
    1.3. cnxcc_set_max_credit()
    1.4. cnxcc_set_max_time()
@@ -86,7 +86,7 @@ Chapter 1. Admin Guide
 
    6. Events
    7. Web Interface
-   8. Sample
+   8. Sample Config
 
 1. Overview
 
@@ -138,11 +138,11 @@ Chapter 1. Admin Guide
    3.1. redis (integer)
    3.2. credit_check_period (integer)
 
-3.1.  redis (integer)
+3.1. redis (integer)
 
    Redis datasource connection information
 
-   Example 1.1. dlg_flag
+   Example 1.1.
 ...
 modparam("cnxcc", "redis", "addr=127.0.0.1;port=6379;db=1")
 ...
@@ -354,7 +354,7 @@ event_route[cnxcc:call-shutdown]
 
    Link: https://github.com/caruizdiaz/cnxcc-web
 
-8. Sample
+8. Sample Config
 
    Example 1.8. kamailio-cnxcc.cfg
 ...

src/modules/db_postgres/README

@@ -26,6 +26,7 @@ Greg Fausak
               3.1. retries (integer)
               3.2. timeout (integer)
               3.3. tcp_keepalive (integer)
+              3.4. lockset (integer)
 
         4. Functions
 
@@ -34,6 +35,7 @@ Greg Fausak
    1.1. Set retries parameter
    1.2. Set timeout parameter
    1.3. Set tcp_keepalive parameter
+   1.4. Set lockset parameter
 
 Chapter 1. Admin Guide
 
@@ -50,6 +52,7 @@ Chapter 1. Admin Guide
         3.1. retries (integer)
         3.2. timeout (integer)
         3.3. tcp_keepalive (integer)
+        3.4. lockset (integer)
 
    4. Functions
 
@@ -81,6 +84,7 @@ Chapter 1. Admin Guide
    3.1. retries (integer)
    3.2. timeout (integer)
    3.3. tcp_keepalive (integer)
+   3.4. lockset (integer)
 
 3.1. retries (integer)
 
@@ -127,6 +131,18 @@ modparam("db_postgres", "timeout", 10)
 modparam("db_postgres", "tcp_keepalive", 600)
 ...
 
+3.4. lockset (integer)
+
+   The value is used as power of two to compute the size of the lock set
+   needed to implement the equivalent of REPLACE SQL statement.
+
+   Default value is 4 (lock set size is 16).
+
+   Example 1.4. Set lockset parameter
+...
+modparam("db_postgres", "lockset", 6)
+...
+
 4. Functions
 
    NONE

src/modules/dialog/README

@@ -1833,10 +1833,11 @@ kamcmd dlg.profile_list inbound_calls
      * from - SIP address to initiate the call
      * to - SIP address to refer 'from' to
      * op (optional) - outbound proxy SIP address
+     * body (optional) - SDP body for initial INVITE
 
    RPC Command Format:
 ...
-kamcmd dlg.list _from_ _to_ _op_
+kamcmd dlg.bridge_dlg _from_ _to_ _op_
 ...
 
 10. Exported Variables
@@ -1898,15 +1899,17 @@ kamcmd dlg.list _from_ _to_ _op_
 
 11.1. event_route[dialog:start]
 
-   Executed when 200OK for INVITE is processed.
+   Executed when 200OK reply for INVITE is processed.
 
 11.2. event_route[dialog:end]
 
-   Executed when BYE is processed or dialog timed out.
+   Executed when the BYE for the call is processed or the dialog timed
+   out.
 
 11.3. event_route[dialog:failed]
 
-   Executed when dialog is not completed (+300 reply to INVITE).
+   Executed when dialog is not completed (300 or greater reply code to
+   INVITE).
 
 Chapter 2. Developer Guide
 

src/modules/domainpolicy/README

@@ -49,14 +49,13 @@ Klaus Darilion
               4.1. dp_can_connect()
               4.2. dp_apply_policy()
 
-        5. RPC Commands
-        6. Usage Scenarios
+        5. Usage Scenarios
 
-              6.1. TLS Based Federation
-              6.2. SIP Hub based Federation
-              6.3. Walled Garden Federation
+              5.1. TLS Based Federation
+              5.2. SIP Hub based Federation
+              5.3. Walled Garden Federation
 
-        7. Known Limitations
+        6. Known Limitations
 
    List of Examples
 
@@ -101,14 +100,13 @@ Chapter 1. Admin Guide
         4.1. dp_can_connect()
         4.2. dp_apply_policy()
 
-   5. RPC Commands
-   6. Usage Scenarios
+   5. Usage Scenarios
 
-        6.1. TLS Based Federation
-        6.2. SIP Hub based Federation
-        6.3. Walled Garden Federation
+        5.1. TLS Based Federation
+        5.2. SIP Hub based Federation
+        5.3. Walled Garden Federation
 
-   7. Known Limitations
+   6. Known Limitations
 
 1. Overview
 
@@ -407,18 +405,16 @@ if (dp_apply_policy()) {
 }
 ...
 
-5. RPC Commands
+5. Usage Scenarios
 
-6. Usage Scenarios
-
-   6.1. TLS Based Federation
-   6.2. SIP Hub based Federation
-   6.3. Walled Garden Federation
+   5.1. TLS Based Federation
+   5.2. SIP Hub based Federation
+   5.3. Walled Garden Federation
 
    This section describes how this module can be use to implement
    selective VoIP peerings.
 
-6.1. TLS Based Federation
+5.1. TLS Based Federation
 
    This example shows how a secure peering fabric can be configured based
    on TLS and Domain Policies.
@@ -460,7 +456,7 @@ tls_client_domain["tlsfed"] {
  tls_verify_server = 1
 }
 
-6.2. SIP Hub based Federation
+5.2. SIP Hub based Federation
 
    This example shows how a peering fabric based on a central SIP hub can
    be configured.
@@ -490,7 +486,7 @@ mysql> select * from domainpolicy;
 | 1  | http://HUBFED.org/ | fed  | domainreplacement | sip.HUBFED.org |
 +----+--------------------+------+-------------------+----------------+
 
-6.3. Walled Garden Federation
+5.3. Walled Garden Federation
 
    This example assumes that a set of SIP providers have established a
    secure Layer 3 network between their proxies. It does not matter
@@ -529,4 +525,4 @@ mysql> select * from domainpolicy;
 | 1  | http://l3fed.org/ | fed  | domainprefix | l3fed |
 +----+-------------------+------+--------------+-------+
 
-7. Known Limitations
+6. Known Limitations

src/modules/mediaproxy/README

@@ -25,7 +25,7 @@ Dan Pascu
               4.1. SIP Router Modules
               4.2. External Libraries or Applications
 
-        5. Exported parameters
+        5. Parameters
 
               5.1. disable (int)
               5.2. mediaproxy_socket (string)
@@ -66,7 +66,7 @@ Chapter 1. Admin Guide
         4.1. SIP Router Modules
         4.2. External Libraries or Applications
 
-   5. Exported parameters
+   5. Parameters
 
         5.1. disable (int)
         5.2. mediaproxy_socket (string)
@@ -160,7 +160,7 @@ Chapter 1. Admin Guide
      * Mediaproxy version 2.4.2 or higher (but not necessarily on the same
        host as SIP Router).
 
-5. Exported parameters
+5. Parameters
 
    5.1. disable (int)
    5.2. mediaproxy_socket (string)

src/modules/misc_radius/README

@@ -182,6 +182,7 @@ Chapter 1. Admin Guide
    Example 1.2. radius_config parameter usage
 ...
 modparam("misc_radius", "radius_config", "/etc/radiusclient.conf")
+...
 
 3.2. caller_service_type (integer)
 
@@ -193,6 +194,7 @@ modparam("misc_radius", "radius_config", "/etc/radiusclient.conf")
    Example 1.3. caller_service_type parameter usage
 ...
 modparam("misc_radius", "caller_service_type", 18)
+...
 
 3.3. callee_service_type (integer)
 
@@ -204,6 +206,7 @@ modparam("misc_radius", "caller_service_type", 18)
    Example 1.4. callee_service_type parameter usage
 ...
 modparam("misc_radius", "callee_service_type", 19)
+...
 
 3.4. group_service_type (integer)
 
@@ -215,6 +218,7 @@ modparam("misc_radius", "callee_service_type", 19)
    Example 1.5. group_service_type parameter usage
 ...
 modparam("misc_radius", "group_service_type", 20)
+...
 
 3.5. uri_service_type (integer)
 
@@ -226,6 +230,7 @@ modparam("misc_radius", "group_service_type", 20)
    Example 1.6. uri_service_type parameter usage
 ...
 modparam("misc_radius", "uri_service_type", 21)
+...
 
 3.6. caller_extra (string)
 
@@ -240,6 +245,7 @@ modparam("misc_radius", "uri_service_type", 21)
    Example 1.7. caller_extra parameter usage
 ...
 modparam("misc_radius", "caller_extra", "Calling-Station-Id=$fu")
+...
 
 3.7. callee_extra (string)
 
@@ -254,6 +260,7 @@ modparam("misc_radius", "caller_extra", "Calling-Station-Id=$fu")
    Example 1.8. callee_extra parameter usage
 ...
 modparam("misc_radius", "callee_extra", "SIP-URI-User=$rU;SIP-URI-Host=$rd")
+...
 
 3.8. group_extra (string)
 
@@ -268,6 +275,7 @@ modparam("misc_radius", "callee_extra", "SIP-URI-User=$rU;SIP-URI-Host=$rd")
    Example 1.9. group_extra parameter usage
 ...
 modparam("misc_radius", "group_extra", "My-Special=$avp(i:100)")
+...
 
 3.9. uri_extra (string)
 
@@ -282,6 +290,7 @@ modparam("misc_radius", "group_extra", "My-Special=$avp(i:100)")
    Example 1.10. uri_extra parameter usage
 ...
 modparam("misc_radius", "uri_extra", "Called-Station-Id=$tu")
+...
 
 3.10. use_sip_uri_host (integer)
 
@@ -295,6 +304,7 @@ modparam("misc_radius", "uri_extra", "Called-Station-Id=$tu")
    Example 1.11. use_sip_uri_host parameter usage
 ...
 modparam("misc_radius", "use_sip_uri_host", 1)
+...
 
 3.11. common_response (integer)
 

src/modules/nat_traversal/README

@@ -50,7 +50,7 @@ Dan Pascu
               6.3. subscribed_endpoints
               6.4. dialog_endpoints
 
-        7. Exported pseudo-variables
+        7. Pseudo Variables
 
               7.1. $keepalive.socket(nat_endpoint)
               7.2. $source_uri
@@ -113,7 +113,7 @@ Chapter 1. Admin Guide
         6.3. subscribed_endpoints
         6.4. dialog_endpoints
 
-   7. Exported pseudo-variables
+   7. Pseudo Variables
 
         7.1. $keepalive.socket(nat_endpoint)
         7.2. $source_uri
@@ -605,7 +605,7 @@ if ((method=="REGISTER" || method=="SUBSCRIBE" ||
    Indicates how many of the NAT endpoints are kept alive for taking part
    in an INVITE dialog.
 
-7. Exported pseudo-variables
+7. Pseudo Variables
 
    7.1. $keepalive.socket(nat_endpoint)
    7.2. $source_uri

src/modules/presence_xml/README

@@ -119,8 +119,8 @@ Chapter 1. Admin Guide
      * presence.
      * sl.
      * xcap_client.
-       Only compulsory if not using an integrated xcap server (if
-       'integrated_xcap_server' parameter is not set).
+       Needed only when not using the integrated xcap server (if
+       'integrated_xcap_server' parameter is set to 0).
 
 2.2. External Libraries or Applications
 
@@ -223,15 +223,15 @@ modparam("presence_xml", "force_active", 1)
    This parameter is a flag for the type of XCAP servers used. If the XCAP
    server is integrated with Kamailio presence_xml module and access the
    same database tables directly, like the embedded XCAP server
-   implemented in xcap_server module, the parameter should be set to a
-   positive value. Apart from updating in xcap table, if the integrated
-   server is not running on the same Kamailio instance, it must send an
-   RPC command presence.refreshWatchers [pres_uri] [event] when a user
-   modifies a rules document, to instruct the presence_xml module to
-   update states from the database and, if needed, send NOTIFY updates.
-
-   Otherwise, it uses xcap_client module to fetch documents from the XCAP
-   servers with HTTP requests.
+   implemented in xcap_server module, the parameter has to be set to 1.
+   Apart from updating in xcap table, if the integrated server is not
+   running on the same Kamailio instance, it must send an RPC command
+   presence.refreshWatchers [pres_uri] [event] when a user modifies a
+   rules document, to instruct the presence_xml module to update states
+   from the database and, if needed, send NOTIFY updates.
+
+   Otherwise (if set to 0) it uses xcap_client module to fetch documents
+   from the XCAP servers with HTTP requests.
 
    Default value is “0”.