2
0
Эх сурвалжийг харах

modules dockbook: a bit of restructuring for better ToC

Daniel-Constantin Mierla 14 жил өмнө
parent
commit
9f5e182d73

+ 19 - 14
modules/blst/README

@@ -4,7 +4,7 @@ Andrei Pelinescu-Onciul
 
 
    iptelorg GmbH
    iptelorg GmbH
 
 
-   Copyright © 2007 iptelorg GmbH
+   Copyright © 2007 iptelorg GmbH
      __________________________________________________________________
      __________________________________________________________________
 
 
    1.1. Overview
    1.1. Overview
@@ -14,11 +14,10 @@ Andrei Pelinescu-Onciul
         1.2.2. blst_add_retry_after(min, max)
         1.2.2. blst_add_retry_after(min, max)
         1.2.3. blst_del()
         1.2.3. blst_del()
         1.2.4. blst_is_blacklisted()
         1.2.4. blst_is_blacklisted()
-        1.2.5. blst_set_ignore() blst_set_ignore(flags)
-                blst_rpl_set_ignore() blst_rpl_set_ignore(flags)
-
-        1.2.6. blst_clear_ignore() blst_clear_ignore(flags)
-                blst_rpl_clear_ignore() blst_rpl_clear_ignore(flags)
+        1.2.5. blst_set_ignore([flags])
+        1.2.6. blst_rpl_set_ignore([flags])
+        1.2.7. blst_clear_ignore([flags])
+        1.2.8. blst_rpl_clear_ignore([flags])
 
 
 1.1. Overview
 1.1. Overview
 
 
@@ -26,7 +25,7 @@ Andrei Pelinescu-Onciul
 
 
 1.2. Functions
 1.2. Functions
 
 
-1.2.1.  blst_add([timeout])
+1.2.1. blst_add([timeout])
 
 
    Adds the source of the current message to the blacklist for timeout
    Adds the source of the current message to the blacklist for timeout
    seconds. If timeout is missing or 0 it uses the default blacklist
    seconds. If timeout is missing or 0 it uses the default blacklist
@@ -40,7 +39,7 @@ else
     blst_add();  # use default blacklist timeout
     blst_add();  # use default blacklist timeout
 ...
 ...
 
 
-1.2.2.  blst_add_retry_after(min, max)
+1.2.2. blst_add_retry_after(min, max)
 
 
    Adds the source of the current message to the blacklist for the time
    Adds the source of the current message to the blacklist for the time
    interval specified in the Retry-After header. If the Retry-After header
    interval specified in the Retry-After header. If the Retry-After header
@@ -58,7 +57,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 }
 }
 ...
 ...
 
 
-1.2.3.  blst_del()
+1.2.3. blst_del()
 
 
    Removes the source of the current message from the blacklist. If the
    Removes the source of the current message from the blacklist. If the
    address is not present in the blacklist at the time of the call it
    address is not present in the blacklist at the time of the call it
@@ -69,7 +68,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
     blst_del();
     blst_del();
 ...
 ...
 
 
-1.2.4.  blst_is_blacklisted()
+1.2.4. blst_is_blacklisted()
 
 
    Returns true if the source of the current message is blacklisted.
    Returns true if the source of the current message is blacklisted.
 
 
@@ -81,8 +80,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
    }
    }
 ...
 ...
 
 
-1.2.5.  blst_set_ignore() blst_set_ignore(flags) blst_rpl_set_ignore()
-blst_rpl_set_ignore(flags)
+1.2.5. blst_set_ignore([flags])
 
 
    Set errors that will not be taken into account when deciding whether to
    Set errors that will not be taken into account when deciding whether to
    blacklist a destination for the current message or a local reply to the
    blacklist a destination for the current message or a local reply to the
@@ -113,8 +111,11 @@ Note
    Example 5. blst_set_ignore usage
    Example 5. blst_set_ignore usage
     blst_set_ignore(6); # ignore send and connect errors
     blst_set_ignore(6); # ignore send and connect errors
 
 
-1.2.6.  blst_clear_ignore() blst_clear_ignore(flags) blst_rpl_clear_ignore()
-blst_rpl_clear_ignore(flags)
+1.2.6. blst_rpl_set_ignore([flags])
+
+   See function blst_set_ignore([flags]).
+
+1.2.7. blst_clear_ignore([flags])
 
 
    Clears blacklist ignore flags previously set by the corresponding
    Clears blacklist ignore flags previously set by the corresponding
    blst_set_ignore(...) or blst_rpl_set_ignore(...) functions.
    blst_set_ignore(...) or blst_rpl_set_ignore(...) functions.
@@ -123,3 +124,7 @@ blst_rpl_clear_ignore(flags)
 
 
    Example 6. blst_clear_ignore usage
    Example 6. blst_clear_ignore usage
     blst_clear_ignore(4); # ignore connect errors
     blst_clear_ignore(4); # ignore connect errors
+
+1.2.8. blst_rpl_clear_ignore([flags])
+
+   See function blst_clear_ignore([flags]).

+ 20 - 8
modules/blst/doc/functions.xml

@@ -104,10 +104,7 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 
 
 	<section id="blst_set_ignore">
 	<section id="blst_set_ignore">
 	<title>
 	<title>
-		<function>blst_set_ignore()</function>
-		<function>blst_set_ignore(flags)</function>
-		<function>blst_rpl_set_ignore()</function>
-		<function>blst_rpl_set_ignore(flags)</function>
+		<function>blst_set_ignore([flags])</function>
 	</title>
 	</title>
 	<para>
 	<para>
 		Set errors that will not be taken into account when deciding
 		Set errors that will not be taken into account when deciding
@@ -160,12 +157,18 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 	</example>
 	</example>
 	</section>
 	</section>
 
 
+	<section id="blst_rpl_set_ignore">
+	<title>
+		<function>blst_rpl_set_ignore([flags])</function>
+	</title>
+	<para>
+		See function <function>blst_set_ignore([flags])</function>.
+	</para>
+	</section>
+
 	<section id="blst_clear_ignore">
 	<section id="blst_clear_ignore">
 	<title>
 	<title>
-		<function>blst_clear_ignore()</function>
-		<function>blst_clear_ignore(flags)</function>
-		<function>blst_rpl_clear_ignore()</function>
-		<function>blst_rpl_clear_ignore(flags)</function>
+		<function>blst_clear_ignore([flags])</function>
 	</title>
 	</title>
 	<para>
 	<para>
 		Clears blacklist ignore flags previously set by the corresponding
 		Clears blacklist ignore flags previously set by the corresponding
@@ -183,4 +186,13 @@ if (msg_status==503){ # blacklist 503 source for Retry-After seconds
 	</example>
 	</example>
 	</section>
 	</section>
 
 
+	<section id="blst_rpl_clear_ignore">
+	<title>
+		<function>blst_rpl_clear_ignore([flags])</function>
+	</title>
+	<para>
+		See function <function>blst_clear_ignore([flags])</function>.
+	</para>
+	</section>
+
 </section>
 </section>

+ 67 - 59
modules/rtpproxy/README

@@ -24,13 +24,13 @@ Edited by
 
 
 Sas Ovidiu
 Sas Ovidiu
 
 
-   Copyright © 2003-2008 Sippy Software, Inc.
+   Copyright © 2003-2008 Sippy Software, Inc.
 
 
-   Copyright © 2005 Voice Sistem SRL
+   Copyright © 2005 Voice Sistem SRL
 
 
-   Copyright © 2009 TuTPro Inc.
+   Copyright © 2009 TuTPro Inc.
 
 
-   Copyright © 2010 VoIPEmbedded Inc.
+   Copyright © 2010 VoIPEmbedded Inc.
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -63,10 +63,10 @@ Sas Ovidiu
               5.5. unforce_rtp_proxy()
               5.5. unforce_rtp_proxy()
               5.6. rtpproxy_manage([flags [, ip_address]])
               5.6. rtpproxy_manage([flags [, ip_address]])
               5.7. rtpproxy_stream2uac(prompt_name, count),
               5.7. rtpproxy_stream2uac(prompt_name, count),
-                      rtpproxy_stream2uas(prompt_name, count)
-
-              5.8. rtpproxy_stop_stream2uac(), rtpproxy_stop_stream2uas()
-              5.9. start_recording()
+              5.8. rtpproxy_stream2uas(prompt_name, count)
+              5.9. rtpproxy_stop_stream2uac(),
+              5.10. start_recording()
+              5.11. rtpproxy_stop_stream2uas(prompt_name, count)
 
 
         6. Exported Pseudo Variables
         6. Exported Pseudo Variables
 
 
@@ -129,10 +129,10 @@ Chapter 1. Admin Guide
         5.5. unforce_rtp_proxy()
         5.5. unforce_rtp_proxy()
         5.6. rtpproxy_manage([flags [, ip_address]])
         5.6. rtpproxy_manage([flags [, ip_address]])
         5.7. rtpproxy_stream2uac(prompt_name, count),
         5.7. rtpproxy_stream2uac(prompt_name, count),
-                rtpproxy_stream2uas(prompt_name, count)
-
-        5.8. rtpproxy_stop_stream2uac(), rtpproxy_stop_stream2uas()
-        5.9. start_recording()
+        5.8. rtpproxy_stream2uas(prompt_name, count)
+        5.9. rtpproxy_stop_stream2uac(),
+        5.10. start_recording()
+        5.11. rtpproxy_stop_stream2uas(prompt_name, count)
 
 
    6. Exported Pseudo Variables
    6. Exported Pseudo Variables
 
 
@@ -162,7 +162,7 @@ Chapter 1. Admin Guide
    load-balancing will be performed over a set and the user has the
    load-balancing will be performed over a set and the user has the
    ability to choose what set should be used. The set is selected via its
    ability to choose what set should be used. The set is selected via its
    id - the id being defined along with the set. Refer to the
    id - the id being defined along with the set. Refer to the
-   “rtpproxy_sock� module parameter definition for syntax description.
+   "rtpproxy_sock" module parameter definition for syntax description.
 
 
    The balancing inside a set is done automatically by the module based on
    The balancing inside a set is done automatically by the module based on
    the weight of each rtpproxy from the set.
    the weight of each rtpproxy from the set.
@@ -210,7 +210,7 @@ Chapter 1. Admin Guide
    Definition of socket(s) used to connect to (a set) RTPProxy. It may
    Definition of socket(s) used to connect to (a set) RTPProxy. It may
    specify a UNIX socket or an IPv4/IPv6 UDP socket.
    specify a UNIX socket or an IPv4/IPv6 UDP socket.
 
 
-   Default value is “NONE� (disabled).
+   Default value is "NONE" (disabled).
 
 
    Example 1.1. Set rtpproxy_sock parameter
    Example 1.1. Set rtpproxy_sock parameter
 ...
 ...
@@ -232,7 +232,7 @@ modparam("rtpproxy", "rtpproxy_sock",
    will not attempt to establish communication to RTPProxy for
    will not attempt to establish communication to RTPProxy for
    rtpproxy_disable_tout seconds.
    rtpproxy_disable_tout seconds.
 
 
-   Default value is “60�.
+   Default value is "60".
 
 
    Example 1.2. Set rtpproxy_disable_tout parameter
    Example 1.2. Set rtpproxy_disable_tout parameter
 ...
 ...
@@ -243,7 +243,7 @@ modparam("rtpproxy", "rtpproxy_disable_tout", 20)
 
 
    Timeout value in waiting for reply from RTPProxy.
    Timeout value in waiting for reply from RTPProxy.
 
 
-   Default value is “1�.
+   Default value is "1".
 
 
    Example 1.3. Set rtpproxy_tout parameter
    Example 1.3. Set rtpproxy_tout parameter
 ...
 ...
@@ -255,7 +255,7 @@ modparam("rtpproxy", "rtpproxy_tout", 2)
    How many times rtpproxy should retry to send and receive after timeout
    How many times rtpproxy should retry to send and receive after timeout
    was generated.
    was generated.
 
 
-   Default value is “5�.
+   Default value is "5".
 
 
    Example 1.4. Set rtpproxy_retr parameter
    Example 1.4. Set rtpproxy_retr parameter
 ...
 ...
@@ -267,7 +267,7 @@ modparam("rtpproxy", "rtpproxy_retr", 2)
    Socket to be forced in communicating to RTPProxy. It makes sense only
    Socket to be forced in communicating to RTPProxy. It makes sense only
    for UDP communication. If no one specified, the OS will choose.
    for UDP communication. If no one specified, the OS will choose.
 
 
-   Default value is “NULL�.
+   Default value is "NULL".
 
 
    Example 1.5. Set force_socket parameter
    Example 1.5. Set force_socket parameter
 ...
 ...
@@ -285,7 +285,7 @@ Note
 
 
    The string must be a complete SDP line, including the EOH (\r\n).
    The string must be a complete SDP line, including the EOH (\r\n).
 
 
-   Default value is “a=nortpproxy:yes\r\n�.
+   Default value is "a=nortpproxy:yes\r\n".
 
 
    Example 1.6. Set nortpproxy_str parameter
    Example 1.6. Set nortpproxy_str parameter
 ...
 ...
@@ -300,7 +300,7 @@ modparam("rtpproxy", "nortpproxy_str", "a=sdpmangled:yes\r\n")
    If it is an empty string, no timeout socket will be transmitted to the
    If it is an empty string, no timeout socket will be transmitted to the
    RTP-Proxy.
    RTP-Proxy.
 
 
-   Default value is “� (nothing).
+   Default value is "" (nothing).
 
 
    Example 1.7. Set timeout_socket parameter
    Example 1.7. Set timeout_socket parameter
 ...
 ...
@@ -316,12 +316,12 @@ modparam("nathelper", "timeout_socket", "xmlrpc:http://127.0.0.1:8000/RPC2")
    5.5. unforce_rtp_proxy()
    5.5. unforce_rtp_proxy()
    5.6. rtpproxy_manage([flags [, ip_address]])
    5.6. rtpproxy_manage([flags [, ip_address]])
    5.7. rtpproxy_stream2uac(prompt_name, count),
    5.7. rtpproxy_stream2uac(prompt_name, count),
-          rtpproxy_stream2uas(prompt_name, count)
+   5.8. rtpproxy_stream2uas(prompt_name, count)
+   5.9. rtpproxy_stop_stream2uac(),
+   5.10. start_recording()
+   5.11. rtpproxy_stop_stream2uas(prompt_name, count)
 
 
-   5.8. rtpproxy_stop_stream2uac(), rtpproxy_stop_stream2uas()
-   5.9. start_recording()
-
-5.1.  set_rtp_proxy_set()
+5.1. set_rtp_proxy_set()
 
 
    Sets the Id of the rtpproxy set to be used for the next
    Sets the Id of the rtpproxy set to be used for the next
    unforce_rtp_proxy(), rtpproxy_offer() or rtpproxy_answer() command.
    unforce_rtp_proxy(), rtpproxy_offer() or rtpproxy_answer() command.
@@ -335,7 +335,7 @@ set_rtp_proxy_set("2");
 rtpproxy_offer();
 rtpproxy_offer();
 ...
 ...
 
 
-5.2.  rtpproxy_offer([flags [, ip_address]])
+5.2. rtpproxy_offer([flags [, ip_address]])
 
 
    Rewrites SDP body to ensure that media is passed through an RTP proxy.
    Rewrites SDP body to ensure that media is passed through an RTP proxy.
    To be invoked on INVITE for the cases the SDPs are in INVITE and 200 OK
    To be invoked on INVITE for the cases the SDPs are in INVITE and 200 OK
@@ -345,7 +345,7 @@ rtpproxy_offer();
      * flags - flags to turn on some features.
      * flags - flags to turn on some features.
           + a - flags that UA from which message is received doesn't
           + a - flags that UA from which message is received doesn't
             support symmetric RTP. (automatically sets the 'r' flag)
             support symmetric RTP. (automatically sets the 'r' flag)
-          + l - force “lookup�, that is, only rewrite SDP when
+          + l - force "lookup", that is, only rewrite SDP when
             corresponding session is already exists in the RTP proxy. By
             corresponding session is already exists in the RTP proxy. By
             default is on when the session is to be completed.
             default is on when the session is to be completed.
           + i, e - these flags specify the direction of the SIP message.
           + i, e - these flags specify the direction of the SIP message.
@@ -423,7 +423,7 @@ onreply_route[2]
 ...
 ...
 }
 }
 
 
-5.3.  rtpproxy_answer([flags [, ip_address]])
+5.3. rtpproxy_answer([flags [, ip_address]])
 
 
    Rewrites SDP body to ensure that media is passed through an RTP proxy.
    Rewrites SDP body to ensure that media is passed through an RTP proxy.
    To be invoked on 200 OK for the cases the SDPs are in INVITE and 200 OK
    To be invoked on 200 OK for the cases the SDPs are in INVITE and 200 OK
@@ -439,7 +439,7 @@ onreply_route[2]
 
 
    See rtpproxy_offer() function example above for example.
    See rtpproxy_offer() function example above for example.
 
 
-5.4.  rtpproxy_destroy()
+5.4. rtpproxy_destroy()
 
 
    Tears down the RTPProxy session for the current call.
    Tears down the RTPProxy session for the current call.
 
 
@@ -450,11 +450,11 @@ onreply_route[2]
 rtpproxy_destroy();
 rtpproxy_destroy();
 ...
 ...
 
 
-5.5.  unforce_rtp_proxy()
+5.5. unforce_rtp_proxy()
 
 
    Same as rtpproxy_destroy().
    Same as rtpproxy_destroy().
 
 
-5.6.  rtpproxy_manage([flags [, ip_address]])
+5.6. rtpproxy_manage([flags [, ip_address]])
 
 
    Manage the RTPProxy session - it combines the functionality of
    Manage the RTPProxy session - it combines the functionality of
    rtpproxy_offer(), rtpproxy_answer() and unfroce_rtpproxy(), detecting
    rtpproxy_offer(), rtpproxy_answer() and unfroce_rtpproxy(), detecting
@@ -468,7 +468,8 @@ rtpproxy_destroy();
        internal flag FL_SDP_BODY to know that the 1xx and 2xx are for
        internal flag FL_SDP_BODY to know that the 1xx and 2xx are for
        rtpproxy answer
        rtpproxy answer
      * if ACK with SDP, then do rtpproxy answer
      * if ACK with SDP, then do rtpproxy answer
-     * if BYE or CANCEL, then do unforce rtpproxy
+     * if BYE or CANCEL, or called within a failure_route[], then do
+       unforce rtpproxy
      * if reply to INVITE with code >= 300 do unfrce rtp proxy
      * if reply to INVITE with code >= 300 do unfrce rtp proxy
      * if reply with SDP to INVITE having code 1xx and 2xx, then do
      * if reply with SDP to INVITE having code 1xx and 2xx, then do
        rtpproxy answer if the request had SDP or tm is not loaded,
        rtpproxy answer if the request had SDP or tm is not loaded,
@@ -481,8 +482,7 @@ rtpproxy_destroy();
 rtpproxy_manage();
 rtpproxy_manage();
 ...
 ...
 
 
-5.7.  rtpproxy_stream2uac(prompt_name, count),
-rtpproxy_stream2uas(prompt_name, count)
+5.7. rtpproxy_stream2uac(prompt_name, count),
 
 
    Instruct the RTPproxy to stream prompt/announcement pre-encoded with
    Instruct the RTPproxy to stream prompt/announcement pre-encoded with
    the makeann command from the RTPproxy distribution. The uac/uas suffix
    the makeann command from the RTPproxy distribution. The uac/uas suffix
@@ -524,7 +524,11 @@ rtpproxy_stream2uas(prompt_name, count)
     };
     };
 ...
 ...
 
 
-5.8.  rtpproxy_stop_stream2uac(), rtpproxy_stop_stream2uas()
+5.8. rtpproxy_stream2uas(prompt_name, count)
+
+   See function rtpproxy_stream2uac(prompt_name, count).
+
+5.9. rtpproxy_stop_stream2uac(),
 
 
    Stop streaming of announcement/prompt/MOH started previously by the
    Stop streaming of announcement/prompt/MOH started previously by the
    respective rtpproxy_stream2xxx. The uac/uas suffix selects whose
    respective rtpproxy_stream2xxx. The uac/uas suffix selects whose
@@ -533,7 +537,7 @@ rtpproxy_stream2uas(prompt_name, count)
 
 
    These functions can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
    These functions can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
 
 
-5.9.  start_recording()
+5.10. start_recording()
 
 
    This command will send a signal to the RTP-Proxy to record the RTP
    This command will send a signal to the RTP-Proxy to record the RTP
    stream on the RTP-Proxy.
    stream on the RTP-Proxy.
@@ -545,6 +549,10 @@ rtpproxy_stream2uas(prompt_name, count)
 start_recording();
 start_recording();
 ...
 ...
 
 
+5.11. rtpproxy_stop_stream2uas(prompt_name, count)
+
+   See function rtpproxy_stop_stream2uac(prompt_name, count).
+
 6. Exported Pseudo Variables
 6. Exported Pseudo Variables
 
 
    6.1. $rtpstart
    6.1. $rtpstart
@@ -579,7 +587,7 @@ start_recording();
    NOTE: if a rtpproxy is defined multiple times (in the same or diferente
    NOTE: if a rtpproxy is defined multiple times (in the same or diferente
    sete), all its instances will be enables/disabled.
    sete), all its instances will be enables/disabled.
 
 
-   Example 1.16.  nh_enable_rtpp usage
+   Example 1.16. nh_enable_rtpp usage
 ...
 ...
 $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
 $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
 ...
 ...
@@ -591,52 +599,52 @@ $ kamctl fifo nh_enable_rtpp udp:192.168.2.133:8081 0
 
 
    No parameter.
    No parameter.
 
 
-   Example 1.17.  nh_show_rtpp usage
+   Example 1.17. nh_show_rtpp usage
 ...
 ...
 $ kamctl fifo nh_show_rtpp
 $ kamctl fifo nh_show_rtpp
 ...
 ...
 
 
 Chapter 2. Frequently Asked Questions
 Chapter 2. Frequently Asked Questions
 
 
-   2.1. What happend with “rtpproxy_disable� parameter?
+   2.1. What happend with "rtpproxy_disable" parameter?
    2.2. Where can I find more about Kamailio?
    2.2. Where can I find more about Kamailio?
    2.3. Where can I post a question about this module?
    2.3. Where can I post a question about this module?
    2.4. How can I report a bug?
    2.4. How can I report a bug?
 
 
    2.1.
    2.1.
 
 
-       What happend with “rtpproxy_disable� parameter?
+   What happend with "rtpproxy_disable" parameter?
 
 
-       It was removed as it became obsolete - now “rtpproxy_sock� can take
-       empty value to disable the rtpproxy functionality.
+   It was removed as it became obsolete - now "rtpproxy_sock" can take
+   empty value to disable the rtpproxy functionality.
 
 
    2.2.
    2.2.
 
 
-       Where can I find more about Kamailio?
+   Where can I find more about Kamailio?
 
 
-       Take a look at http://www.kamailio.org/.
+   Take a look at http://www.kamailio.org/.
 
 
    2.3.
    2.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 -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
-         * Developer Mailing List -
-           http://lists.sip-router.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 -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
+     * Developer Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
 
 
-       E-mails regarding any stable Kamailio release should be sent to
-       <[email protected]> and e-mails regarding development
-       versions should be sent to <[email protected]>.
+   E-mails regarding any stable Kamailio release should be sent to
+   <[email protected]> and e-mails regarding development
+   versions should be sent to <[email protected]>.
 
 
-       If you want to keep the mail private, send it to
-       <[email protected]>.
+   If you want to keep the mail private, send it to
+   <[email protected]>.
 
 
    2.4.
    2.4.
 
 
-       How can I report a bug?
+   How can I report a bug?
 
 
-       Please follow the guidelines provided at:
-       http://sip-router.org/tracker.
+   Please follow the guidelines provided at:
+   http://sip-router.org/tracker.

+ 18 - 4
modules/rtpproxy/doc/rtpproxy_admin.xml

@@ -524,10 +524,9 @@ rtpproxy_manage();
 		</example>
 		</example>
         </section>
         </section>
 
 
-	<section id="rtpproxy_stream2xxx">
+	<section id="rtpproxy_stream2uac">
 	<title>
 	<title>
 	    <function>rtpproxy_stream2uac(prompt_name, count)</function>,
 	    <function>rtpproxy_stream2uac(prompt_name, count)</function>,
-	    <function>rtpproxy_stream2uas(prompt_name, count)</function>
 	</title>
 	</title>
 	<para>
 	<para>
 	    Instruct the RTPproxy to stream prompt/announcement pre-encoded with
 	    Instruct the RTPproxy to stream prompt/announcement pre-encoded with
@@ -589,10 +588,17 @@ rtpproxy_manage();
 	    </programlisting>
 	    </programlisting>
 	</example>
 	</example>
 	</section>
 	</section>
-	<section id="rtpproxy_stop_stream2xxx">
+	<section id="rtpproxy_stream2uas">
+	<title>
+	    <function>rtpproxy_stream2uas(prompt_name, count)</function>
+	</title>
+	<para>
+		See function <function>rtpproxy_stream2uac(prompt_name, count)</function>.
+	</para>
+	</section>
+	<section id="rtpproxy_stop_stream2uac">
 	<title>
 	<title>
 	    <function>rtpproxy_stop_stream2uac()</function>,
 	    <function>rtpproxy_stop_stream2uac()</function>,
-	    <function>rtpproxy_stop_stream2uas()</function>
 	</title>
 	</title>
 	<para>
 	<para>
 	    Stop streaming of announcement/prompt/MOH started previously by the
 	    Stop streaming of announcement/prompt/MOH started previously by the
@@ -624,6 +630,14 @@ start_recording();
 		</programlisting>
 		</programlisting>
 		</example>
 		</example>
 	</section>
 	</section>
+	<section id="rtpproxy_stop_stream2uas">
+	<title>
+	    <function>rtpproxy_stop_stream2uas(prompt_name, count)</function>
+	</title>
+	<para>
+		See function <function>rtpproxy_stop_stream2uac(prompt_name, count)</function>.
+	</para>
+	</section>
 
 
 
 
 	</section>
 	</section>

+ 19 - 20
modules_k/presence_xml/README

@@ -8,7 +8,7 @@ Edited by
 
 
 Anca-Maria Vamanu
 Anca-Maria Vamanu
 
 
-   Copyright © 2007 Voice Sistem SRL
+   Copyright © 2007 Voice Sistem SRL
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -36,9 +36,8 @@ Anca-Maria Vamanu
 
 
         4. Exported Functions
         4. Exported Functions
 
 
-              4.1. pres_check_basic(char *presentity_uri, char *status)
-              4.2. pres_check_activities(char *presentity_uri, char
-                      *activity)
+              4.1. pres_check_basic(presentity_uri, status)
+              4.2. pres_check_activities(presentity_uri, activity)
 
 
         5. Installation
         5. Installation
         6. Exported pseudo-variables
         6. Exported pseudo-variables
@@ -85,8 +84,8 @@ Chapter 1. Admin Guide
 
 
    4. Exported Functions
    4. Exported Functions
 
 
-        4.1. pres_check_basic(char *presentity_uri, char *status)
-        4.2. pres_check_activities(char *presentity_uri, char *activity)
+        4.1. pres_check_basic(presentity_uri, status)
+        4.2. pres_check_activities(presentity_uri, activity)
 
 
    5. Installation
    5. Installation
    6. Exported pseudo-variables
    6. Exported pseudo-variables
@@ -145,7 +144,7 @@ Chapter 1. Admin Guide
 
 
    The database URL.
    The database URL.
 
 
-   Default value is “mysql://openser:openserrw@localhost/openser�.
+   Default value is "mysql://openser:openserrw@localhost/openser".
 
 
    Example 1.1. Set db_url parameter
    Example 1.1. Set db_url parameter
 ...
 ...
@@ -156,7 +155,7 @@ modparam("presence_xml", "db_url", "dbdriver://username:password@dbhost/dbname")
 
 
    The name of the database table where XCAP documents are stored.
    The name of the database table where XCAP documents are stored.
 
 
-   Default value is “xcap�.
+   Default value is "xcap".
 
 
    Example 1.2. Set xcap_table parameter
    Example 1.2. Set xcap_table parameter
 ...
 ...
@@ -167,7 +166,7 @@ modparam("presence_xml", "xcap_table", "xcaps")
 
 
    Set this parameter to disable the handling of the "presence" event.
    Set this parameter to disable the handling of the "presence" event.
 
 
-   Default value: “0�.
+   Default value: "0".
 
 
    Example 1.3. Set disable_presence parameter
    Example 1.3. Set disable_presence parameter
 ...
 ...
@@ -179,7 +178,7 @@ modparam("presence_xml", "disable_presence", 1)
    Set this parameter to disable the handling of the "presence.winfo"
    Set this parameter to disable the handling of the "presence.winfo"
    event.
    event.
 
 
-   Default value: “0�.
+   Default value: "0".
 
 
    Example 1.4. Set disable_winfo parameter
    Example 1.4. Set disable_winfo parameter
 ...
 ...
@@ -190,7 +189,7 @@ modparam("presence_xml", "disable_winfo", 1)
 
 
    Set this parameter to disable the handling of the "dialog;sla" event.
    Set this parameter to disable the handling of the "dialog;sla" event.
 
 
-   Default value: “1� (0 - enabled, 1 - disabled).
+   Default value: "1" (0 - enabled, 1 - disabled).
 
 
    Example 1.5. Set disable_bla parameter
    Example 1.5. Set disable_bla parameter
 ...
 ...
@@ -210,7 +209,7 @@ modparam("presence_xml", "disable_bla", 1)
    Note: When switching from one value to another, the watchers table must
    Note: When switching from one value to another, the watchers table must
    be emptied.
    be emptied.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
    Example 1.6. Set force_active parameter
    Example 1.6. Set force_active parameter
 ...
 ...
@@ -228,7 +227,7 @@ modparam("presence_xml", "force_active", 1)
    if not issuing any Publish (useful for services such as email, SMS,
    if not issuing any Publish (useful for services such as email, SMS,
    MMS).
    MMS).
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
    Example 1.7. Set pidf_manipulation parameter
    Example 1.7. Set pidf_manipulation parameter
 ...
 ...
@@ -249,7 +248,7 @@ modparam("presence_xml", "pidf_manipulation", 1)
    Otherwise, it uses xcap_client module to fetch documents from the XCAP
    Otherwise, it uses xcap_client module to fetch documents from the XCAP
    servers with HTTP requests. This mode is currently not supported.
    servers with HTTP requests. This mode is currently not supported.
 
 
-   Default value is “0�.
+   Default value is "0".
 
 
    Example 1.8. Set integrated_xcap_server parameter
    Example 1.8. Set integrated_xcap_server parameter
 ...
 ...
@@ -275,7 +274,7 @@ modparam("presence_xml", "xcap_server", "xcap_server.ag.org")
    no connection to database. Useful when needing only to use $xml(...)
    no connection to database. Useful when needing only to use $xml(...)
    pseudoc-variable.
    pseudoc-variable.
 
 
-   Default value: “0� (0 - active mode, 1 - passive mode).
+   Default value: "0" (0 - active mode, 1 - passive mode).
 
 
    Example 1.10. Set passive_mode parameter
    Example 1.10. Set passive_mode parameter
 ...
 ...
@@ -284,10 +283,10 @@ modparam("presence_xml", "passive_mode", 1)
 
 
 4. Exported Functions
 4. Exported Functions
 
 
-   4.1. pres_check_basic(char *presentity_uri, char *status)
-   4.2. pres_check_activities(char *presentity_uri, char *activity)
+   4.1. pres_check_basic(presentity_uri, status)
+   4.2. pres_check_activities(presentity_uri, activity)
 
 
-4.1.  pres_check_basic(char *presentity_uri, char *status)
+4.1. pres_check_basic(presentity_uri, status)
 
 
    Checks the /presence/tuple/status/basic nodes in the presentity for
    Checks the /presence/tuple/status/basic nodes in the presentity for
    presentity_uri against the value in status.
    presentity_uri against the value in status.
@@ -310,7 +309,7 @@ modparam("presence_xml", "passive_mode", 1)
     }
     }
 ...
 ...
 
 
-4.2.  pres_check_activities(char *presentity_uri, char *activity)
+4.2. pres_check_activities(presentity_uri, activity)
 
 
    Checks whether a /presence/person/activities/activity node exists in
    Checks whether a /presence/person/activities/activity node exists in
    the presentity for presentity_uri.
    the presentity for presentity_uri.
@@ -337,7 +336,7 @@ modparam("presence_xml", "passive_mode", 1)
 
 
 5. Installation
 5. Installation
 
 
-   The module requires one table in Kamailio database: “xcap�. The SQL
+   The module requires one table in Kamailio database: "xcap". The SQL
    syntax to create it can be found in presence-create.sql script in the
    syntax to create it can be found in presence-create.sql script in the
    database directories in the kamailio/scripts folder. You can also find
    database directories in the kamailio/scripts folder. You can also find
    the complete database documentation on the project webpage,
    the complete database documentation on the project webpage,

+ 2 - 2
modules_k/presence_xml/doc/presence_xml_admin.xml

@@ -317,7 +317,7 @@ modparam("presence_xml", "passive_mode", 1)
 	<title>Exported Functions</title>
 	<title>Exported Functions</title>
 	<section>
 	<section>
 		<title>
 		<title>
-		<function moreinfo="none">pres_check_basic(char *presentity_uri, char *status)</function>
+		<function moreinfo="none">pres_check_basic(presentity_uri, status)</function>
 		</title>
 		</title>
 		<para>
 		<para>
 		Checks the /presence/tuple/status/basic nodes in the presentity for
 		Checks the /presence/tuple/status/basic nodes in the presentity for
@@ -359,7 +359,7 @@ modparam("presence_xml", "passive_mode", 1)
 	</section>
 	</section>
 	<section>
 	<section>
 		<title>
 		<title>
-		<function moreinfo="none">pres_check_activities(char *presentity_uri, char *activity)</function>
+		<function moreinfo="none">pres_check_activities(presentity_uri, activity)</function>
 		</title>
 		</title>
 		<para>
 		<para>
 		Checks whether a /presence/person/activities/<emphasis>activity</emphasis>
 		Checks whether a /presence/person/activities/<emphasis>activity</emphasis>

+ 6 - 6
modules_k/pua_xmpp/README

@@ -8,7 +8,7 @@ Edited by
 
 
 Anca-Maria Vamanu
 Anca-Maria Vamanu
 
 
-   Copyright © 2007 Voice Sistem SRL
+   Copyright © 2007 Voice Sistem SRL
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -28,7 +28,7 @@ Anca-Maria Vamanu
         4. Exported Functions
         4. Exported Functions
 
 
               4.1. pua_xmpp_notify()
               4.1. pua_xmpp_notify()
-              4.2. pua_xmpp_req_winfo(char* request_uri, char* expires)
+              4.2. pua_xmpp_req_winfo(request_uri, expires)
 
 
         5. Filtering
         5. Filtering
 
 
@@ -57,7 +57,7 @@ Chapter 1. Admin Guide
    4. Exported Functions
    4. Exported Functions
 
 
         4.1. pua_xmpp_notify()
         4.1. pua_xmpp_notify()
-        4.2. pua_xmpp_req_winfo(char* request_uri, char* expires)
+        4.2. pua_xmpp_req_winfo(request_uri, expires)
 
 
    5. Filtering
    5. Filtering
 
 
@@ -102,11 +102,11 @@ modparam("pua_xmpp", "server_address", "sip:160.23.23.10")
 4. Exported Functions
 4. Exported Functions
 
 
    4.1. pua_xmpp_notify()
    4.1. pua_xmpp_notify()
-   4.2. pua_xmpp_req_winfo(char* request_uri, char* expires)
+   4.2. pua_xmpp_req_winfo(request_uri, expires)
 
 
    Functions exported to be used in configuration file.
    Functions exported to be used in configuration file.
 
 
-4.1.  pua_xmpp_notify()
+4.1. pua_xmpp_notify()
 
 
    Function that handles Notify messages addressed to a user from an xmpp
    Function that handles Notify messages addressed to a user from an xmpp
    domain. It requires filtering after method and domain in configuration
    domain. It requires filtering after method and domain in configuration
@@ -124,7 +124,7 @@ modparam("pua_xmpp", "server_address", "sip:160.23.23.10")
         }
         }
 ...
 ...
 
 
-4.2.  pua_xmpp_req_winfo(char* request_uri, char* expires)
+4.2. pua_xmpp_req_winfo(request_uri, expires)
 
 
    Function called when a Subscribe addressed to a user from a xmpp domain
    Function called when a Subscribe addressed to a user from a xmpp domain
    is received. It calls sending a Subscribe for winfo for the user, and
    is received. It calls sending a Subscribe for winfo for the user, and

+ 1 - 1
modules_k/pua_xmpp/doc/pua_xmpp_admin.xml

@@ -117,7 +117,7 @@ modparam("pua_xmpp", "server_address", "sip:160.23.23.10")
 
 
 	<section>
 	<section>
 		<title>
 		<title>
-		<function moreinfo="none">pua_xmpp_req_winfo(char* request_uri, char* expires)</function>
+		<function moreinfo="none">pua_xmpp_req_winfo(request_uri, expires)</function>
 		</title>
 		</title>
 		<para>
 		<para>
 		Function called when a Subscribe addressed to a user from a
 		Function called when a Subscribe addressed to a user from a