tm: notes about avp parameters format

- they can be either PV style $avp(name) for K compat mode or just the
  name of avp for S compat mode

modules/tm/README

@@ -911,9 +911,16 @@ modparam("tm", "fr_inv_timer_next", 10000)
    Default value is "NULL" (t_load_contacts()/t_next_contacts() functions
    are disabled).
 
+   In Kamailio compatibility mode (defined by #!KAMAILIO), the value of
+   the parameter must be the name of an AVP in pseudo-variable format:
+   $avp(name). In SER compatibility mode it must by just AVP name.
+
    Example 27. Set contacts_avp parameter
 ...
+# K mode
 modparam("tm", "contacts_avp", "$avp(i:25)")
+# S mode
+modparam("tm", "contacts_avp", "i:25")
 ...
 
 1.4.28. fr_timer_avp (string)
@@ -940,9 +947,15 @@ Note
 
    See also: t_set_fr(), fr_timer.
 
+   In Kamailio compatibility mode (defined by #!KAMAILIO), the value of
+   the parameter must be the name of an AVP in pseudo-variable format:
+   $avp(name). In SER compatibility mode it must by just AVP name.
+
    Example 28. Set fr_timer_avp parameter
 ...
 modparam("tm", "fr_timer_avp", "i:708")
+# K mode
+modparam("tm", "fr_timer_avp", "$avp(i:708)")
 ...
 
 1.4.29. fr_inv_timer_avp (string)
@@ -970,9 +983,15 @@ Note
 
    See also: t_set_fr(), fr_inv_timer.
 
+   In Kamailio compatibility mode (defined by #!KAMAILIO), the value of
+   the parameter must be the name of an AVP in pseudo-variable format:
+   $avp(name). In SER compatibility mode it must by just AVP name.
+
    Example 29. Set fr_inv_timer_avp parameter
 ...
 modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer")
+# K mode
+modparam("tm", "fr_inv_timer_avp", "$avp(my_fr_inv_timer)")
 ...
 
 1.4.30. unmatched_cancel (string)
@@ -1136,7 +1155,7 @@ modparam("tm", "local_ack_mode", 1)
    Revision History
    Revision $Revision$ $Date$
 
-1.5.1. t_relay_to_udp(ip, port), t_relay_to_udp(), t_relay_to_tcp(ip, port)
+1.5.1.  t_relay_to_udp(ip, port), t_relay_to_udp(), t_relay_to_tcp(ip, port)
 t_relay_to_tcp() t_relay_to_tls(ip, port) t_relay_to_tls()
 t_relay_to_sctp(ip, port) t_relay_to_sctp()
 
@@ -1164,7 +1183,7 @@ else
         t_relay_to_tcp(); # relay to msg. uri, but over tcp
 ...
 
-1.5.2. t_relay() t_relay(host, port)
+1.5.2.  t_relay() t_relay(host, port)
 
    Relay a message statefully either to the destination indicated in the
    current URI (if called without any parameters) or to the specified host
@@ -1192,7 +1211,7 @@ if (!t_relay())
 };
 ...
 
-1.5.3. t_on_failure(failure_route)
+1.5.3.  t_on_failure(failure_route)
 
    Sets failure routing block, to which control is passed after a
    transaction completed with a negative result but before sending a final
@@ -1229,7 +1248,7 @@ failure_route[1] {
    See test/onr.cfg for a more complex example of combination of serial
    with parallel forking.
 
-1.5.4. t_on_reply(onreply_route)
+1.5.4.  t_on_reply(onreply_route)
 
    Sets the reply routing block, to which control is passed when a reply
    for the current transaction is received. Note that the set of commands
@@ -1259,7 +1278,7 @@ es');
         }
 }
 
-1.5.5. t_on_branch(branch_route)
+1.5.5.  t_on_branch(branch_route)
 
    Sets the branch routing block, to which control is passed after forking
    (when a new branch is created). For now branch routes are intended only
@@ -1283,7 +1302,7 @@ branch_route[1] {
         }
 }
 
-1.5.6. append_branch()
+1.5.6.  append_branch()
 
    Similarly to t_fork_to, it extends destination set by a new entry. The
    difference is that current URI is taken as new entry.
@@ -1297,7 +1316,7 @@ t_fork();
 t_relay();
 ...
 
-1.5.7. t_newtran()
+1.5.7.  t_newtran()
 
    Creates a new transaction, returns a negative value on error. This is
    the only way a script can add a new transaction in an atomic way.
@@ -1313,7 +1332,7 @@ if (t_newtran()) {
 
    See test/uas.cfg for more examples.
 
-1.5.8. t_reply(code, reason_phrase)
+1.5.8.  t_reply(code, reason_phrase)
 
    Sends a stateful reply after a transaction has been established. See
    t_newtran for usage.
@@ -1327,7 +1346,7 @@ if (t_newtran()) {
 t_reply("404", "Not found");
 ...
 
-1.5.9. t_lookup_request()
+1.5.9.  t_lookup_request()
 
    Checks if a transaction exists. Returns a positive value if so,
    negative otherwise. Most likely you will not want to use it, as a
@@ -1342,7 +1361,7 @@ if (t_lookup_request()) {
 };
 ...
 
-1.5.10. t_retransmit_reply()
+1.5.10.  t_retransmit_reply()
 
    Retransmits a reply sent previously by UAS transaction.
 
@@ -1351,7 +1370,7 @@ if (t_lookup_request()) {
 t_retransmit_reply();
 ...
 
-1.5.11. t_release()
+1.5.11.  t_release()
 
    Remove transaction from memory (it will be first put on a wait timer to
    absorb delayed messages).
@@ -1361,7 +1380,7 @@ t_retransmit_reply();
 t_release();
 ...
 
-1.5.12. t_forward_nonack() t_forward_nonack(ip, port)
+1.5.12.  t_forward_nonack() t_forward_nonack(ip, port)
 t_forward_nonack_udp(ip, port) t_forward_nonack_tcp(ip, port)
 t_forward_nonack_tls(ip, port) t_forward_nonack_sctp(ip, port)
 
@@ -1376,7 +1395,7 @@ t_forward_nonack_tls(ip, port) t_forward_nonack_sctp(ip, port)
 t_forward_nonack("1.2.3.4", "5060");
 ...
 
-1.5.13. t_set_fr(fr_inv_timeout [, fr_timeout])
+1.5.13.  t_set_fr(fr_inv_timeout [, fr_timeout])
 
    Sets the fr_inv_timeout and optionally fr_timeout for the current
    transaction or for transactions created during the same script
@@ -1410,7 +1429,7 @@ branch_route[1] {
         }
 }
 
-1.5.14. t_reset_fr()
+1.5.14.  t_reset_fr()
 
    Resets the fr_inv_timer and fr_timer for the current transaction to the
    default values (set using the tm module parameters fr_inv_timer and
@@ -1429,7 +1448,7 @@ route {
 ...
 }
 
-1.5.15. t_set_max_lifetime(inv_lifetime, noninv_lifetime)
+1.5.15.  t_set_max_lifetime(inv_lifetime, noninv_lifetime)
 
    Sets the maximum lifetime for the current INVITE or non-INVITE
    transaction, or for transactions created during the same script
@@ -1458,7 +1477,7 @@ route {
                                           # INVITE and to 15s if not
 }
 
-1.5.16. t_reset_max_lifetime()
+1.5.16.  t_reset_max_lifetime()
 
    Resets the the maximum lifetime for the current INVITE or non-INVITE
    transaction to the default value (set using the tm module parameter
@@ -1477,7 +1496,7 @@ route {
 ...
 }
 
-1.5.17. t_set_retr(retr_t1_interval, retr_t2_interval)
+1.5.17.  t_set_retr(retr_t1_interval, retr_t2_interval)
 
    Sets the retr_t1_interval and retr_t2_interval for the current
    transaction or for transactions created during the same script
@@ -1523,7 +1542,7 @@ branch_route[1] {
         }
 }
 
-1.5.18. t_reset_retr()
+1.5.18.  t_reset_retr()
 
    Resets the retr_timer1 and retr_timer2 for the current transaction to
    the default values (set using the tm module parameters retr_timer1 and
@@ -1542,7 +1561,7 @@ route {
 ...
 }
 
-1.5.19. t_set_auto_inv_100(0|1)
+1.5.19.  t_set_auto_inv_100(0|1)
 
    Switch automatically sending 100 replies to INVITEs on/off on a per
    transaction basis. It overrides the auto_inv_100 value for the current
@@ -1559,7 +1578,7 @@ route {
 ...
 }
 
-1.5.20. t_branch_timeout()
+1.5.20.  t_branch_timeout()
 
    Returns true if the failure route is executed for a branch that did
    timeout. It can be used only from the failure_route.
@@ -1573,7 +1592,7 @@ failure_route[0]{
         }
 }
 
-1.5.21. t_branch_replied()
+1.5.21.  t_branch_replied()
 
    Returns true if the failure route is executed for a branch that did
    receive at least one reply in the past (the "current" reply is not
@@ -1591,7 +1610,7 @@ failure_route[0]{
         }
 }
 
-1.5.22. t_any_timeout()
+1.5.22.  t_any_timeout()
 
    Returns true if at least one of the current transactions branches did
    timeout.
@@ -1607,7 +1626,7 @@ failure_route[0]{
         }
 }
 
-1.5.23. t_any_replied()
+1.5.23.  t_any_replied()
 
    Returns true if at least one of the current transactions branches did
    receive some reply in the past. If called from a failure or onreply
@@ -1622,7 +1641,7 @@ onreply_route[0]{
         }
 }
 
-1.5.24. t_grep_status("code")
+1.5.24.  t_grep_status("code")
 
    Returns true if "code" is the final reply received (or locally
    generated) in at least one of the current transactions branches.
@@ -1636,7 +1655,7 @@ onreply_route[0]{
         }
 }
 
-1.5.25. t_is_canceled()
+1.5.25.  t_is_canceled()
 
    Returns true if the current transaction was canceled.
 
@@ -1649,7 +1668,7 @@ failure_route[0]{
         }
 }
 
-1.5.26. t_is_expired()
+1.5.26.  t_is_expired()
 
    Returns true if the current transaction has already been expired, i.e.
    the max_inv_lifetime/max_noninv_lifetime interval has already elapsed.
@@ -1663,7 +1682,7 @@ failure_route[0]{
         }
 }
 
-1.5.27. t_relay_cancel()
+1.5.27.  t_relay_cancel()
 
    Forwards the CANCEL if the corresponding INVITE transaction exists. The
    function is supposed to be used at the very beginning of the script,
@@ -1688,7 +1707,7 @@ if (method == CANCEL) {
         # do the same as for INVITEs
 }
 
-1.5.28. t_lookup_cancel(), t_lookup_cancel(1)
+1.5.28.  t_lookup_cancel(), t_lookup_cancel(1)
 
    Returns true if the corresponding INVITE transaction exists for a
    CANCEL request. The function can be called at the beginning of the
@@ -1720,7 +1739,7 @@ if (method == CANCEL) {
         # do the same as for INVITEs
 }
 
-1.5.29. t_drop_replies([mode])
+1.5.29.  t_drop_replies([mode])
 
    Drops all the previously received replies in failure_route block to
    make sure that none of them is picked up again.
@@ -1748,7 +1767,7 @@ failure_route[0]{
         }
 }
 
-1.5.30. t_save_lumps()
+1.5.30.  t_save_lumps()
 
    Forces the modifications of the processed SIP message to be saved in
    shared memory before t_relay() is called. The new branches which are
@@ -1788,7 +1807,7 @@ failure_route[1] {
         t_relay();
 }
 
-1.5.31. t_load_contacts()
+1.5.31.  t_load_contacts()
 
    This is the first of the two functions that can be used to implement
    serial/parallel forking based on the q value of individual branches in
@@ -1841,7 +1860,7 @@ if (!t_load_contacts()) {
 };
 ...
 
-1.5.32. t_next_contacts()
+1.5.32.  t_next_contacts()
 
    The function t_next_contacts is the second of the two functions that
    can be used to implement serial/parallel forking based on the q value
@@ -1904,7 +1923,7 @@ if (!t_next_contacts()) {
 };
 ...
 
-1.5.33. t_check_trans()
+1.5.33.  t_check_trans()
 
    t_check_trans() can be used to quickly check if a message belongs or is
    related to a transaction. It behaves differently for different types of
@@ -1954,7 +1973,7 @@ if ( method == "CANCEL" && !t_check_trans())
         sl_reply("403", "cancel out of the blue forbidden");
 # note: in this example t_check_trans() can be replaced by t_lookup_cancel()
 
-1.5.34. t_set_disable_6xx(0|1)
+1.5.34.  t_set_disable_6xx(0|1)
 
    Turn off/on 6xx replies special rfc conformant handling on a per
    transaction basis. If turned off (t_set_disable_6xx("1")) 6XXs will be
@@ -1973,7 +1992,7 @@ route {
 ...
 }
 
-1.5.35. t_set_disable_failover(0|1)
+1.5.35.  t_set_disable_failover(0|1)
 
    Turn off/on dns failover on a per transaction basis.
 
@@ -1988,7 +2007,7 @@ route {
 ...
 }
 
-1.5.36. t_replicate(params)
+1.5.36.  t_replicate(params)
 
    Replicate the SIP request to a specific address.
 
@@ -2023,7 +2042,7 @@ t_replicate("sip:$var(h);transport=tls");
 t_replicate_to_udp("1.2.3.4", "5060");
 ...
 
-1.5.37. t_relay_to(proxy, flags)
+1.5.37.  t_relay_to(proxy, flags)
 
    Forward the SIP request to a specific address, controlling internal
    behavior via flags.
@@ -2127,7 +2146,7 @@ end of body
 
 1.6.2. Functions
 
-1.6.2.1. register_tmcb(cb_type, cb_func)
+1.6.2.1.  register_tmcb(cb_type, cb_func)
 
    For programmatic use only--register a function to be called back on an
    event. See t_hooks.h for more details.
@@ -2136,7 +2155,7 @@ end of body
      * cb_type - Callback type.
      * cb_func - Callback function.
 
-1.6.2.2. load_tm(*import_structure)
+1.6.2.2.  load_tm(*import_structure)
 
    For programmatic use only--import exported TM functions. See the acc
    module for an example of use.
@@ -2144,7 +2163,7 @@ end of body
    Meaning of the parameters is as follows:
      * import_structure - Pointer to the import structure.
 
-1.6.2.3. int t_suspend(struct sip_msg *msg, unsigned int *hash_index,
+1.6.2.3.  int t_suspend(struct sip_msg *msg, unsigned int *hash_index,
 unsigned int *label)
 
    For programmatic use only. This function together with t_continue() can
@@ -2182,7 +2201,7 @@ unsigned int *label)
    t_suspend() should return 0 to make sure that the script processing
    does not continue.
 
-1.6.2.4. int t_continue(unsigned int hash_index, unsigned int label, struct
+1.6.2.4.  int t_continue(unsigned int hash_index, unsigned int label, struct
 action *route)
 
    For programmatic use only. This function is the pair of t_suspend(),

modules/tm/doc/params.xml

@@ -823,11 +823,20 @@ modparam("tm", "fr_inv_timer_next", 10000)
 			are disabled).
 		</emphasis>
 		</para>
+		<para>
+			In Kamailio compatibility mode (defined by #!KAMAILIO), the value
+			of the parameter must be the name of an AVP in pseudo-variable
+			format: $avp(name). In SER compatibility mode it must by just
+			AVP name.
+		</para>
 		<example>
 		<title>Set <varname>contacts_avp</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
+# K mode
 modparam("tm", "contacts_avp", "$avp(i:25)")
+# S mode
+modparam("tm", "contacts_avp", "i:25")
 ...
 </programlisting>
 		</example>
@@ -863,11 +872,19 @@ modparam("tm", "contacts_avp", "$avp(i:25)")
 			See also: <function>t_set_fr()</function>,
 			<varname>fr_timer</varname>.
 		</para>
+		<para>
+			In Kamailio compatibility mode (defined by #!KAMAILIO), the value
+			of the parameter must be the name of an AVP in pseudo-variable
+			format: $avp(name). In SER compatibility mode it must by just
+			AVP name.
+		</para>
 		<example>
 			<title>Set <varname>fr_timer_avp</varname> parameter</title>
 			<programlisting>
 ...
 modparam("tm", "fr_timer_avp", "i:708")
+# K mode
+modparam("tm", "fr_timer_avp", "$avp(i:708)")
 ...
 			</programlisting>
 		</example>
@@ -904,11 +921,19 @@ modparam("tm", "fr_timer_avp", "i:708")
 			See also: <function>t_set_fr()</function>,
 			<varname>fr_inv_timer</varname>.
 		</para>
+		<para>
+			In Kamailio compatibility mode (defined by #!KAMAILIO), the value
+			of the parameter must be the name of an AVP in pseudo-variable
+			format: $avp(name). In SER compatibility mode it must by just
+			AVP name.
+		</para>
 		<example>
 			<title>Set <varname>fr_inv_timer_avp</varname> parameter</title>
 			<programlisting>
 ...
 modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer")
+# K mode
+modparam("tm", "fr_inv_timer_avp", "$avp(my_fr_inv_timer)")
 ...
 			</programlisting>
 		</example>