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

src/modules/pua_dialoginfo/README

@@ -13,14 +13,10 @@ Klaus Darilion
    IPCom (Module implementation was partly sponsored by Silver Server
    (www.sil.at))
 
-Edited by
-
 Klaus Darilion
 
    IPCom
 
-Edited by
-
 Phil Lavin
 
    Copyright © 2006 Voice Sistem SRL
@@ -46,16 +42,17 @@ Phil Lavin
               5.2. include_tags (int)
               5.3. include_localremote (int)
               5.4. override_lifetime (int)
-              5.5. caller_confirmed (int)
-              5.6. send_publish_flag (int)
-              5.7. disable_caller_publish_flag (int)
-              5.8. disable_callee_publish_flag (int)
-              5.9. use_pubruri_avps (int)
-              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 (int)
-              5.14. callee_trying (int)
+              5.5. include_req_uri (int)
+              5.6. caller_confirmed (int)
+              5.7. send_publish_flag (int)
+              5.8. disable_caller_publish_flag (int)
+              5.9. disable_callee_publish_flag (int)
+              5.10. use_pubruri_avps (int)
+              5.11. pubruri_caller_avp (int)
+              5.12. pubruri_callee_avp (int)
+              5.13. pubruri_caller_dlg_var (str)
+              5.14. pubruri_callee_dlg_var (int)
+              5.15. callee_trying (int)
 
         6. Functions
 
@@ -65,16 +62,17 @@ Phil Lavin
    1.2. Set include_tags parameter
    1.3. Set include_localremote parameter
    1.4. Set override_lifetime parameter
-   1.5. Set caller_confirmed parameter
-   1.6. Set send_publish_flag parameter
-   1.7. Set disable_caller_publish_flag parameter
-   1.8. Set disable_callee_publish_flag parameter
-   1.9. Set use_pubruri_avps parameter
-   1.10. Set pubruri_caller_avp parameter
-   1.11. Set pubruri_callee_avp parameter
-   1.12. Set pubruri_caller_avp parameter
-   1.13. Set pubruri_callee_dlg_var parameter
-   1.14. Set callee_trying parameter
+   1.5. Set include_req_uri parameter
+   1.6. Set caller_confirmed parameter
+   1.7. Set send_publish_flag parameter
+   1.8. Set disable_caller_publish_flag parameter
+   1.9. Set disable_callee_publish_flag parameter
+   1.10. Set use_pubruri_avps parameter
+   1.11. Set pubruri_caller_avp parameter
+   1.12. Set pubruri_callee_avp parameter
+   1.13. Set pubruri_caller_avp parameter
+   1.14. Set pubruri_callee_dlg_var parameter
+   1.15. Set callee_trying parameter
 
 Chapter 1. Admin Guide
 
@@ -94,16 +92,17 @@ Chapter 1. Admin Guide
         5.2. include_tags (int)
         5.3. include_localremote (int)
         5.4. override_lifetime (int)
-        5.5. caller_confirmed (int)
-        5.6. send_publish_flag (int)
-        5.7. disable_caller_publish_flag (int)
-        5.8. disable_callee_publish_flag (int)
-        5.9. use_pubruri_avps (int)
-        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 (int)
-        5.14. callee_trying (int)
+        5.5. include_req_uri (int)
+        5.6. caller_confirmed (int)
+        5.7. send_publish_flag (int)
+        5.8. disable_caller_publish_flag (int)
+        5.9. disable_callee_publish_flag (int)
+        5.10. use_pubruri_avps (int)
+        5.11. pubruri_caller_avp (int)
+        5.12. pubruri_callee_avp (int)
+        5.13. pubruri_caller_dlg_var (str)
+        5.14. pubruri_callee_dlg_var (int)
+        5.15. callee_trying (int)
 
    6. Functions
 
@@ -276,16 +275,17 @@ Chapter 1. Admin Guide
    5.2. include_tags (int)
    5.3. include_localremote (int)
    5.4. override_lifetime (int)
-   5.5. caller_confirmed (int)
-   5.6. send_publish_flag (int)
-   5.7. disable_caller_publish_flag (int)
-   5.8. disable_callee_publish_flag (int)
-   5.9. use_pubruri_avps (int)
-   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 (int)
-   5.14. callee_trying (int)
+   5.5. include_req_uri (int)
+   5.6. caller_confirmed (int)
+   5.7. send_publish_flag (int)
+   5.8. disable_caller_publish_flag (int)
+   5.9. disable_callee_publish_flag (int)
+   5.10. use_pubruri_avps (int)
+   5.11. pubruri_caller_avp (int)
+   5.12. pubruri_callee_avp (int)
+   5.13. pubruri_caller_dlg_var (str)
+   5.14. pubruri_callee_dlg_var (int)
+   5.15. callee_trying (int)
 
 5.1. include_callid (int)
 
@@ -340,7 +340,19 @@ modparam("pua_dialoginfo", "include_localremote", 0)
 modparam("pua_dialoginfo", "override_lifetime", 300)
 ...
 
-5.5. caller_confirmed (int)
+5.5. include_req_uri (int)
+
+   controls if R-URI is going to be used instead of To header value in the
+   PUBLISH as "identity" on "remote" node.
+
+   Default value is “0”. Disabled
+
+   Example 1.5. Set include_req_uri parameter
+...
+modparam("pua_dialoginfo", "include_req_uri", 1)
+...
+
+5.6. caller_confirmed (int)
 
    Usually the dialog-info of the caller will be "trying -> early ->
    confirmed" and the dialog-info of the callee will be "early ->
@@ -354,63 +366,63 @@ modparam("pua_dialoginfo", "override_lifetime", 300)
 
    Default value is “0”.
 
-   Example 1.5. Set caller_confirmed parameter
+   Example 1.6. Set caller_confirmed parameter
 ...
 modparam("pua_dialoginfo", "caller_confirmed", 1)
 ...
 
-5.6. send_publish_flag (int)
+5.7. send_publish_flag (int)
 
    This message flag indicates whether to send PUBLISH requests or not. If
    not set, PUBLISH requests are sent out only if their R-URI is local
    (according to myself).
 
    Default value is “-1”.
 
-   Example 1.6. Set send_publish_flag parameter
+   Example 1.7. Set send_publish_flag parameter
 ...
 modparam("pua_dialoginfo", "send_publish_flag", 8)
 ...
 
-5.7. disable_caller_publish_flag (int)
+5.8. disable_caller_publish_flag (int)
 
    This message flag indicates whether to send caller (initiator) PUBLISH
    requests or not. If set, PUBLISH requests are not sent for the caller
    (initiator).
 
    Default value is “-1”.
 
-   Example 1.7. Set disable_caller_publish_flag parameter
+   Example 1.8. Set disable_caller_publish_flag parameter
 ...
 modparam("pua_dialoginfo", "disable_caller_publish_flag", 9)
 ...
 
-5.8. disable_callee_publish_flag (int)
+5.9. disable_callee_publish_flag (int)
 
    This message flag indicates whether to send callee (recipient) PUBLISH
    requests or not. If set, PUBLISH requests are not sent for the callee
    (recipient).
 
    Default value is “-1”.
 
-   Example 1.8. Set disable_callee_publish_flag parameter
+   Example 1.9. Set disable_callee_publish_flag parameter
 ...
 modparam("pua_dialoginfo", "disable_callee_publish_flag", 10)
 ...
 
-5.9. use_pubruri_avps (int)
+5.10. use_pubruri_avps (int)
 
    Get Publish R-Uri from avps (see corresponding avp params), not from
    request to/from uri.
 
    Default value is “0”.
 
-   Example 1.9. Set use_pubruri_avps parameter
+   Example 1.10. Set use_pubruri_avps parameter
 ...
 modparam("pua_dialoginfo", "use_pubruri_avps", 1)
 ...
 
-5.10. pubruri_caller_avp (int)
+5.11. pubruri_caller_avp (int)
 
    If use_pubruri_avps is enabled, PUBLISH-requests reporting
    dialog-information about the caller (entity=caller) are sent using the
@@ -421,12 +433,12 @@ modparam("pua_dialoginfo", "use_pubruri_avps", 1)
 
    Default value is “NULL”.
 
-   Example 1.10. Set pubruri_caller_avp parameter
+   Example 1.11. Set pubruri_caller_avp parameter
 ...
 modparam("pua_dialoginfo", "pubruri_caller_avp", "$avp(s:puburis_caller)")
 ...
 
-5.11. pubruri_callee_avp (int)
+5.12. pubruri_callee_avp (int)
 
    If use_pubruri_avps is enabled, PUBLISH-requests reporting
    dialog-information about the callee (entity=callee) are sent using the
@@ -437,12 +449,12 @@ modparam("pua_dialoginfo", "pubruri_caller_avp", "$avp(s:puburis_caller)")
 
    Default value is “NULL”.
 
-   Example 1.11. Set pubruri_callee_avp parameter
+   Example 1.12. Set pubruri_callee_avp parameter
 ...
 modparam("pua_dialoginfo", "pubruri_callee_avp", "$avp(s:puburis_callee)")
 ...
 
-5.12. pubruri_caller_dlg_var (str)
+5.13. pubruri_caller_dlg_var (str)
 
    Must be set to the name of dialog variable where to store the URI for
    caller, used to send the notifications. This is needed to restored the
@@ -451,12 +463,12 @@ modparam("pua_dialoginfo", "pubruri_callee_avp", "$avp(s:puburis_callee)")
 
    Default value is “NULL”.
 
-   Example 1.12. Set pubruri_caller_avp parameter
+   Example 1.13. Set pubruri_caller_avp parameter
 ...
 modparam("pua_dialoginfo", "pubruri_caller_dlg_var", "pubruri_caller")
 ...
 
-5.13. pubruri_callee_dlg_var (int)
+5.14. pubruri_callee_dlg_var (int)
 
    Must be set to the name of dialog variable where to store the URI for
    callee, used to send the notifications. This is needed to restored the
@@ -465,19 +477,19 @@ modparam("pua_dialoginfo", "pubruri_caller_dlg_var", "pubruri_caller")
 
    Default value is “NULL”.
 
-   Example 1.13. Set pubruri_callee_dlg_var parameter
+   Example 1.14. Set pubruri_callee_dlg_var parameter
 ...
 modparam("pua_dialoginfo", "pubruri_callee_dlg_var", "pubruri_callee")
 ...
 
-5.14. callee_trying (int)
+5.15. callee_trying (int)
 
    If this parameter is set, a "Trying" state will be sent for both the
    caller and callee, rather than just the caller.
 
    Default value is “0”.
 
-   Example 1.14. Set callee_trying parameter
+   Example 1.15. Set callee_trying parameter
 ...
 modparam("pua_dialoginfo", "callee_trying", 1)
 ...