فهرست منبع

uac: regenerated readme with new wiki link

Daniel-Constantin Mierla 12 سال پیش
والد
کامیت
6835b9bc1c
1فایلهای تغییر یافته به همراه33 افزوده شده و 33 حذف شده
  1. 33 33
      modules/uac/README

+ 33 - 33
modules/uac/README

@@ -14,9 +14,9 @@ Ramona-Elena Modroiu
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright © 2009-2010 asipto.com
+   Copyright © 2009-2010 asipto.com
 
 
-   Copyright © 2005 Voice Sistem
+   Copyright © 2005 Voice Sistem
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -158,7 +158,7 @@ Chapter 1. Admin Guide
      * Authentication does not support qop auth-int, just qop auth;
      * Authentication does not support qop auth-int, just qop auth;
      * CSeq is not increased during authentication - the response may be
      * CSeq is not increased during authentication - the response may be
        rejected.
        rejected.
-     * The “uac_replace_*� functions can only be run once on the same SIP
+     * The "uac_replace_*" functions can only be run once on the same SIP
        request. Try to save needed changes in a pseudovariable and apply
        request. Try to save needed changes in a pseudovariable and apply
        them once.
        them once.
 
 
@@ -172,9 +172,9 @@ Chapter 1. Admin Guide
    The following modules must be loaded before this module:
    The following modules must be loaded before this module:
      * TM - Transaction Module
      * TM - Transaction Module
      * RR - Record-Route Module, but only if restore mode for From: URI is
      * RR - Record-Route Module, but only if restore mode for From: URI is
-       set to “auto�.
+       set to "auto".
      * Dialog Module, but only if restore mode for From: URI is set to
      * Dialog Module, but only if restore mode for From: URI is set to
-       “auto� and you want uac_replace_from or uac_replace_to to store the
+       "auto" and you want uac_replace_from or uac_replace_to to store the
        values of the URIs as dialog variables.
        values of the URIs as dialog variables.
 
 
 2.2. External Libraries or Applications
 2.2. External Libraries or Applications
@@ -207,7 +207,7 @@ Chapter 1. Admin Guide
    Name of Record-Route header parameter that will be used to store an
    Name of Record-Route header parameter that will be used to store an
    encoded version of the original FROM URI.
    encoded version of the original FROM URI.
 
 
-   This parameter is optional, it's default value being “vsf�.
+   This parameter is optional, it's default value being "vsf".
 
 
    Example 1.1. Set rr_from_store_param parameter
    Example 1.1. Set rr_from_store_param parameter
 ...
 ...
@@ -219,7 +219,7 @@ modparam("uac","rr_from_store_param","my_param")
    Name of Record-Route header parameter that will be used to store
    Name of Record-Route header parameter that will be used to store
    (encoded) the original TO URI.
    (encoded) the original TO URI.
 
 
-   This parameter is optional, it's default value being “vst�.
+   This parameter is optional, it's default value being "vst".
 
 
    Example 1.2. Set rr_to_store_param parameter
    Example 1.2. Set rr_to_store_param parameter
 ...
 ...
@@ -230,16 +230,16 @@ modparam("uac","rr_to_store_param","my_param")
 
 
    There are 3 modes of restoring the original FROM URI and the original
    There are 3 modes of restoring the original FROM URI and the original
    TO URI:
    TO URI:
-     * “none� - no information about original URI is stored; restoration
+     * "none" - no information about original URI is stored; restoration
        is not possible.
        is not possible.
-     * “manual� - all following replies will be restored, but not also the
+     * "manual" - all following replies will be restored, but not also the
        sequential requests - this must be manually updated based on
        sequential requests - this must be manually updated based on
        original URI.
        original URI.
-     * “auto� - all sequential requests and replies will be automatically
+     * "auto" - all sequential requests and replies will be automatically
        updated based on stored original URI. For this option you have to
        updated based on stored original URI. For this option you have to
-       set “modparam("rr", "append_fromtag", 1)�.
+       set "modparam("rr", "append_fromtag", 1)".
 
 
-   This parameter is optional, it's default value being “auto�.
+   This parameter is optional, it's default value being "auto".
 
 
    Example 1.3. Set restore_mode parameter
    Example 1.3. Set restore_mode parameter
 ...
 ...
@@ -331,9 +331,9 @@ modparam("uac","credential","username:domain:password")
    This can be used if the realm upstream will be using is not known in
    This can be used if the realm upstream will be using is not known in
    advance.
    advance.
 
 
-   If you define it, you also need to define “auth_username_avp�
-   (Section 3.10, “auth_username_avp (string)�) and “auth_username_avp�
-   (Section 3.11, “auth_password_avp (string)�).
+   If you define it, you also need to define "auth_username_avp"
+   (Section 3.10, "auth_username_avp (string)") and "auth_username_avp"
+   (Section 3.11, "auth_password_avp (string)").
 
 
    Example 1.9. Set auth_realm_avp parameter
    Example 1.9. Set auth_realm_avp parameter
 ...
 ...
@@ -345,9 +345,9 @@ modparam("uac","auth_realm_avp","$avp(i:10)")
    The definition of an AVP that might contain the username to be used to
    The definition of an AVP that might contain the username to be used to
    perform authentication.
    perform authentication.
 
 
-   If you define it, you also need to define “auth_realm_avp�
-   (Section 3.9, “auth_realm_avp (string)�) and “auth_username_avp�
-   (Section 3.11, “auth_password_avp (string)�).
+   If you define it, you also need to define "auth_realm_avp"
+   (Section 3.9, "auth_realm_avp (string)") and "auth_username_avp"
+   (Section 3.11, "auth_password_avp (string)").
 
 
    Example 1.10. Set auth_username_avp parameter
    Example 1.10. Set auth_username_avp parameter
 ...
 ...
@@ -359,9 +359,9 @@ modparam("uac","auth_username_avp","$avp(i:11)")
    The definition of an AVP that might contain the password to be used to
    The definition of an AVP that might contain the password to be used to
    perform authentication.
    perform authentication.
 
 
-   If you define it, you also need to define “auth_password_avp�
-   (Section 3.11, “auth_password_avp (string)�) and “auth_username_avp�
-   (Section 3.11, “auth_password_avp (string)�).
+   If you define it, you also need to define "auth_password_avp"
+   (Section 3.11, "auth_password_avp (string)") and "auth_username_avp"
+   (Section 3.11, "auth_password_avp (string)").
 
 
    Example 1.11. Set auth_password_avp parameter
    Example 1.11. Set auth_password_avp parameter
 ...
 ...
@@ -408,7 +408,7 @@ modparam("uac", "reg_retry_interval", 300)
 
 
    DB table name to fetch user profiles for registration.
    DB table name to fetch user profiles for registration.
 
 
-   This parameter is optional, it's default value being “uacreg�.
+   This parameter is optional, it's default value being "uacreg".
 
 
    Example 1.15. Set reg_db_table parameter
    Example 1.15. Set reg_db_table parameter
 ...
 ...
@@ -440,7 +440,7 @@ modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
    4.9. uac_reg_lookup(uuid, dst)
    4.9. uac_reg_lookup(uuid, dst)
    4.10. uac_reg_request_to(user, mode)
    4.10. uac_reg_request_to(user, mode)
 
 
-4.1.  uac_replace_from(display,uri)
+4.1. uac_replace_from(display,uri)
 
 
    Replace in FROM header the display name and the URI part.
    Replace in FROM header the display name and the URI part.
 
 
@@ -478,7 +478,7 @@ uac_replace_from("","sip:[email protected]");
 uac_replace_from("","");
 uac_replace_from("","");
 ...
 ...
 
 
-4.2.  uac_replace_from(uri)
+4.2. uac_replace_from(uri)
 
 
    Replace in FROM header the URI part without altering the display name.
    Replace in FROM header the URI part without altering the display name.
 
 
@@ -491,7 +491,7 @@ uac_replace_from("","");
 uac_replace_from("sip:[email protected]");
 uac_replace_from("sip:[email protected]");
 ...
 ...
 
 
-4.3.  uac_restore_from()
+4.3. uac_restore_from()
 
 
    This function will check if the FROM URI was modified and will use the
    This function will check if the FROM URI was modified and will use the
    information stored in header parameter to restore the original FROM URI
    information stored in header parameter to restore the original FROM URI
@@ -504,7 +504,7 @@ uac_replace_from("sip:[email protected]");
 uac_restore_from();
 uac_restore_from();
 ...
 ...
 
 
-4.4.  uac_replace_to(display,uri)
+4.4. uac_replace_to(display,uri)
 
 
    Replace in TO header the display name and the URI part.
    Replace in TO header the display name and the URI part.
 
 
@@ -524,7 +524,7 @@ uac_replace_to("","sip:[email protected]");
 uac_replace_to("","");
 uac_replace_to("","");
 ...
 ...
 
 
-4.5.  uac_replace_to(uri)
+4.5. uac_replace_to(uri)
 
 
    Replace in TO header the URI part without altering the display name.
    Replace in TO header the URI part without altering the display name.
 
 
@@ -555,7 +555,7 @@ uac_replace_to("","");
 uac_replace_to("sip:[email protected]");
 uac_replace_to("sip:[email protected]");
 ...
 ...
 
 
-4.6.  uac_restore_to()
+4.6. uac_restore_to()
 
 
    This function will check if the TO URI was modified and will use the
    This function will check if the TO URI was modified and will use the
    information stored in header parameter to restore the original TO URI
    information stored in header parameter to restore the original TO URI
@@ -568,7 +568,7 @@ uac_replace_to("sip:[email protected]");
 uac_restore_to();
 uac_restore_to();
 ...
 ...
 
 
-4.7.  uac_auth()
+4.7. uac_auth()
 
 
    This function can be called only from failure route and will build the
    This function can be called only from failure route and will build the
    authentication response header and insert it into the request without
    authentication response header and insert it into the request without
@@ -581,7 +581,7 @@ uac_restore_to();
 uac_auth();
 uac_auth();
 ...
 ...
 
 
-4.8.  uac_req_send()
+4.8. uac_req_send()
 
 
    This function sends a SIP message from the configuration file. The
    This function sends a SIP message from the configuration file. The
    message is built out of $uac_req(...) pseudo-variable.
    message is built out of $uac_req(...) pseudo-variable.
@@ -598,7 +598,7 @@ $uac_req(turi)="sip:kamailio.org";
 uac_req_send();
 uac_req_send();
 ...
 ...
 
 
-4.9.  uac_reg_lookup(uuid, dst)
+4.9. uac_reg_lookup(uuid, dst)
 
 
    This function sets the PV dst to SIP URI that correspond to uuid in uac
    This function sets the PV dst to SIP URI that correspond to uuid in uac
    registations table. uuid and dst must be pseudo-variables.
    registations table. uuid and dst must be pseudo-variables.
@@ -614,7 +614,7 @@ if(uac_reg_lookup("$rU", "$ru"))
 }
 }
 ...
 ...
 
 
-4.10.  uac_reg_request_to(user, mode)
+4.10. uac_reg_request_to(user, mode)
 
 
    This function can be used to send an authenticated request to a remote
    This function can be used to send an authenticated request to a remote
    user in the uac registrations table. It sets the request-uri, dst-uri
    user in the uac registrations table. It sets the request-uri, dst-uri
@@ -652,7 +652,7 @@ failure_route[REMOTE_AUTH] {
      * $uac_req(key)
      * $uac_req(key)
 
 
    Exported pseudo-variables are documented at
    Exported pseudo-variables are documented at
-   http://www.kamailio.org/dokuwiki/.
+   http://www.kamailio.org/wiki/.
 
 
 6. Remote Registration
 6. Remote Registration