- fix link entity names, patch from Carsten Gross

- regenerate READMEs git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@4630 689a6050-402a-0410-94f2-e92a70836424
2600hz-archive · Aug 7, 2008 · 989206b · 989206b
1 parent 7d4a2cc
commit 989206b
Show file tree

Hide file tree

Showing 86 changed files with 4,668 additions and 5,030 deletions.
diff --git a/modules_k/acc/README b/modules_k/acc/README
diff --git a/modules_k/alias_db/README b/modules_k/alias_db/README
@@ -1,4 +1,3 @@
-
 ALIAS_DB Module
 
 Daniel-Constantin Mierla
@@ -18,7 +17,7 @@ Daniel-Constantin Mierla
    Copyright � 2005 voice-system.ro
 
    Copyright � 2008 asipto.com
-     _________________________________________________________
+     __________________________________________________________
 
    Table of Contents
 
@@ -43,7 +42,7 @@ Daniel-Constantin Mierla
 
         1.4. Exported Functions
 
-              1.4.1. alias_db_lookup(table_name) 
+              1.4.1. alias_db_lookup(table_name)
 
    List of Examples
 
@@ -67,9 +66,9 @@ Chapter 1. Admin Guide
    for search (no memory caching).
 
    Having no memory caching the speed of search can decrease but
-   the provisioning is easier. With very fast databases like
-   MySQL the speed penalty can be lowered. Also, the search can
-   be performed on different tables in the same script.
+   the provisioning is easier. With very fast databases like MySQL
+   the speed penalty can be lowered. Also, the search can be
+   performed on different tables in the same script.
 
 1.2. Dependencies
 
@@ -91,19 +90,19 @@ Chapter 1. Admin Guide
    Database URL.
 
    Default value is
-   "mysql://openserro:openserro@localhost/openser". 
+   "mysql://openserro:openserro@localhost/openser".
 
    Example 1.1. Set db_url parameter
 ...
-modparam("alias_db", "db_url", "dbdriver://username:password@dbhost/dbn
-ame")
+modparam("alias_db", "db_url", "dbdriver://username:password@dbhost/dbna
+me")
 ...
 
 1.3.2. user_column (str)
 
    Name of the column storing username.
 
-   Default value is "username". 
+   Default value is "username".
 
    Example 1.2. Set user_column parameter
 ...
@@ -114,7 +113,7 @@ modparam("alias_db", "user_column", "susername")
 
    Name of the column storing user's domain.
 
-   Default value is "domain". 
+   Default value is "domain".
 
    Example 1.3. Set domain_column parameter
 ...
@@ -125,7 +124,7 @@ modparam("alias_db", "domain_column", "sdomain")
 
    Name of the column storing alias username.
 
-   Default value is "alias_username". 
+   Default value is "alias_username".
 
    Example 1.4. Set alias_user_column parameter
 ...
@@ -136,7 +135,7 @@ modparam("alias_db", "alias_user_column", "auser")
 
    Name of the column storing alias domain.
 
-   Default value is "alias_domain". 
+   Default value is "alias_domain".
 
    Example 1.5. Set alias_domain_column parameter
 ...
@@ -149,7 +148,7 @@ modparam("alias_db", "alias_domain_column", "adomain")
    searching for alias. If set to 0, the domain from R-URI is not
    used, if set to 1 the domain from R-URI is used.
 
-   Default value is "0". 
+   Default value is "0".
 
    Example 1.6. Set use_domain parameter
 ...
@@ -161,7 +160,7 @@ modparam("alias_db", "use_domain", 1)
    Specifies the prefix to be stripped from the domain in R-URI
    before doing the search.
 
-   Default value is "NULL". 
+   Default value is "NULL".
 
    Example 1.7. Set domain_prefix parameter
 ...
@@ -174,7 +173,7 @@ modparam("alias_db", "domain_prefix", "sip.")
    the R-URI, the rest are added as branches.
 
    Default value is "0" (0 - don't add branches; 1 - add
-   branches). 
+   branches).
 
    Example 1.8. Set append_branches parameter
 ...
@@ -185,12 +184,12 @@ modparam("alias_db", "append_branches", 1)
 
 1.4.1.  alias_db_lookup(table_name)
 
-   The function takes the R-URI and search to see whether it is
-   an alias or not. If it is an alias for a local user, the R-URI
-   is replaced with user's SIP uri.
+   The function takes the R-URI and search to see whether it is an
+   alias or not. If it is an alias for a local user, the R-URI is
+   replaced with user's SIP uri.
 
-   The function returns TRUE if R-URI is alias and it was
-   replaced by user's SIP uri.
+   The function returns TRUE if R-URI is alias and it was replaced
+   by user's SIP uri.
 
    Meaning of the parameters is as follows:
      * table_name - the name of the table where to search for

diff --git a/modules_k/auth/README b/modules_k/auth/README
@@ -29,8 +29,8 @@ Jan Janak
 
    Copyright � 2005 voice-system.ro
    Revision History
-   Revision $Revision$ $Date: 2008-08-06 13:08:33 +0300
-                              (Wed, 06 Aug 2008) $
+   Revision $Revision$ $Date: 2008-08-06 12:08:33 +0200
+                              (Mi, 06 Aug 2008) $
      __________________________________________________________
 
    Table of Contents

diff --git a/modules_k/auth_db/README b/modules_k/auth_db/README
@@ -1,4 +1,3 @@
-
 Auth_db Module
 
 Jan Janak
@@ -30,8 +29,8 @@ Jan Janak
    Copyright � 2005 voice-system.ro
    Revision History
    Revision $Revision$ $Date: 2008-03-19 21:40:18 +0100
-   (Wed, 19 Mar 2008) $
-     _________________________________________________________
+                              (Mi, 19 Mär 2008) $
+     __________________________________________________________
 
    Table of Contents
 
@@ -56,8 +55,8 @@ Jan Janak
 
         1.4. Exported Functions
 
-              1.4.1. www_authorize(realm, table) 
-              1.4.2. proxy_authorize(realm, table) 
+              1.4.1. www_authorize(realm, table)
+              1.4.2. proxy_authorize(realm, table)
 
    List of Examples
 
@@ -88,11 +87,11 @@ Chapter 1. Admin Guide
 
 1.2.1. Kamailio Modules
 
-   The module depends on the following modules (in the other
-   words the listed modules must be loaded before this module):
+   The module depends on the following modules (in the other words
+   the listed modules must be loaded before this module):
      * auth -- Generic authentication functions
-     * database -- Any database module (currently mysql,
-       postgres, dbtext)
+     * database -- Any database module (currently mysql, postgres,
+       dbtext)
 
 1.2.2. External Libraries or Applications
 
@@ -107,22 +106,22 @@ Chapter 1. Admin Guide
    This is URL of the database to be used. Value of the parameter
    depends on the database module used. For example for mysql and
    postgres modules this is something like
-   mysql://username:password@host:port/database. For dbtext
-   module (which stores data in plaintext files) it is directory
-   in which the database resides.
+   mysql://username:password@host:port/database. For dbtext module
+   (which stores data in plaintext files) it is directory in which
+   the database resides.
 
    Default value is
-   "mysql://openserro:openserro@localhost/openser". 
+   "mysql://openserro:openserro@localhost/openser".
 
    Example 1.1. db_url parameter usage
-modparam("auth_db", "db_url", "dbdriver://username:password@dbhost/dbna
-me")
+modparam("auth_db", "db_url", "dbdriver://username:password@dbhost/dbnam
+e")
 
 1.3.2. user_column (string)
 
-   This is the name of the column holding usernames. Default
-   value is fine for most people. Use the parameter if you really
-   need to change it.
+   This is the name of the column holding usernames. Default value
+   is fine for most people. Use the parameter if you really need
+   to change it.
 
    Default value is "username".
 
@@ -132,8 +131,8 @@ modparam("auth_db", "user_column", "user")
 1.3.3. domain_column (string)
 
    This is the name of the column holding domains of users.
-   Default value is fine for most people. Use the parameter if
-   you really need to change it.
+   Default value is fine for most people. Use the parameter if you
+   really need to change it.
 
    Default value is "domain".
 
@@ -142,12 +141,12 @@ modparam("auth_db", "domain_column", "domain")
 
 1.3.4. password_column (string)
 
-   This is the name of the column holding passwords. Passwords
-   can be either stored as plain text or pre-calculated HA1
-   strings. HA1 strings are MD5 hashes of username, password, and
-   realm. HA1 strings are more safe because the server doesn't
-   need to know plaintext passwords and they cannot be obtained
-   from HA1 strings.
+   This is the name of the column holding passwords. Passwords can
+   be either stored as plain text or pre-calculated HA1 strings.
+   HA1 strings are MD5 hashes of username, password, and realm.
+   HA1 strings are more safe because the server doesn't need to
+   know plaintext passwords and they cannot be obtained from HA1
+   strings.
 
    Default value is "ha1".
 
@@ -158,10 +157,9 @@ modparam("auth_db", "password_column", "password")
 
    As described in the previous section this parameter contains
    name of column holding pre-calculated HA1 string that were
-   calculated including the domain in the username. This
-   parameter is used only when calculate_ha1 is set to 0 and user
-   agent send a credentials containing the domain in the
-   username.
+   calculated including the domain in the username. This parameter
+   is used only when calculate_ha1 is set to 0 and user agent send
+   a credentials containing the domain in the username.
 
    Default value of the parameter is ha1b.
 
@@ -170,14 +168,13 @@ modparam("auth_db", "password_column_2", "ha1_2")
 
 1.3.6. calculate_ha1 (integer)
 
-   This parameter tells the server whether it should use
-   plaintext passwords or a pre-calculated HA1 string for
-   authentification.
+   This parameter tells the server whether it should use plaintext
+   passwords or a pre-calculated HA1 string for authentification.
 
    If the parameter is set to 1 and the username parameter of
    credentials contains also "@domain" (some user agents append
-   the domain to the username parameter), then the server will
-   use the HA1 values from the column specified in the
+   the domain to the username parameter), then the server will use
+   the HA1 values from the column specified in the
    "password_column_2" parameter. If the username parameter
    doesn't contain a domain, the server will use the HA1 values
    from the column given in the "password_column"parameter.
@@ -186,15 +183,15 @@ modparam("auth_db", "password_column_2", "ha1_2")
    calculated from the column specified in the "password_column"
    parameter.
 
-   The "password_column_2"column contain also HA1 strings but
-   they should be calculated including the domain in the username
-   parameter (as opposed to password_column which (when
-   containing HA1 strings) should always contains HA1 strings
-   calculated without domain in username.
+   The "password_column_2"column contain also HA1 strings but they
+   should be calculated including the domain in the username
+   parameter (as opposed to password_column which (when containing
+   HA1 strings) should always contains HA1 strings calculated
+   without domain in username.
 
    This ensures that the authentication will always work when
-   using pre-calculated HA1 strings, not depending on the
-   presence of the domain in username.
+   using pre-calculated HA1 strings, not depending on the presence
+   of the domain in username.
 
    Default value of this parameter is 0.
 
@@ -225,19 +222,18 @@ modparam("auth_db", "use_domain", 1)
    name as the column name.
 
    Parameter syntax:
-     * load_credentials = credential (';' credential)* 
+     * load_credentials = credential (';' credential)*
      * credential = (avp_specification '=' column_name) |
-       (column_name) 
+       (column_name)
      * avp_specification = '$avp(' + 'i:'ID | 's:'NAME | alias +
-       ')' 
+       ')'
 
    Default value of this parameter is "rpid".
 
    Example 1.8. load_credentials parameter usage
 # load rpid column into $avp(i:13) and email_address column
 # into $avp(s:email_address)
-modparam("auth_db", "load_credentials", "$avp(i:13)=rpid;email_address"
-)
+modparam("auth_db", "load_credentials", "$avp(i:13)=rpid;email_address")
 
 1.4. Exported Functions
 
@@ -261,15 +257,15 @@ modparam("auth_db", "load_credentials", "$avp(i:13)=rpid;email_address"
      * -1 (invalid user) - authentication user does not exist.
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent
-       should present to the user so he can decide what username
-       and password to use. Usually this is domain of the host
-       the server is running on.
-       If an empty string "" is used then the server will
-       generate it from the request. In case of REGISTER requests
-       To header field domain will be used (because this header
-       field represents a user being registered), for all other
-       messages From header field domain will be used.
+     * realm - Realm is a opaque string that the user agent should
+       present to the user so he can decide what username and
+       password to use. Usually this is domain of the host the
+       server is running on.
+       If an empty string "" is used then the server will generate
+       it from the request. In case of REGISTER requests To header
+       field domain will be used (because this header field
+       represents a user being registered), for all other messages
+       From header field domain will be used.
        The string may contain pseudo variables.
      * table - Table to be used to lookup usernames and passwords
        (usually subscribers table).
@@ -303,13 +299,13 @@ if (www_authorize("siphub.net", "subscriber")) {
      * -1 (invalid user) - authentication user does not exist.
 
    Meaning of the parameters is as follows:
-     * realm - Realm is a opaque string that the user agent
-       should present to the user so he can decide what username
-       and password to use. Usually this is domain of the host
-       the server is running on.
-       If an empty string "" is used then the server will
-       generate it from the request. From header field domain
-       will be used as realm.
+     * realm - Realm is a opaque string that the user agent should
+       present to the user so he can decide what username and
+       password to use. Usually this is domain of the host the
+       server is running on.
+       If an empty string "" is used then the server will generate
+       it from the request. From header field domain will be used
+       as realm.
        The string may contain pseudo variables.
      * table - Table to be used to lookup usernames and passwords
        (usually subscribers table).