- modules documentation migrated from sgml to xml docbook format

- many thanks to Edson <4lists (at) gmail (dot) com> for providing script to replace headers and rename files
- contact updated
- follows re-sync with todays changes and update of Makefile to generate README and html files from XML



git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@3886 689a6050-402a-0410-94f2-e92a70836424

modules_k/acc/README

@@ -3,25 +3,35 @@ Acc Module
 Jiri Kuthan
 
    iptel.org
+   <[email protected]>
 
 Bogdan-Andrei Iancu
 
    voice-system.ro
+   <[email protected]>
 
 Ramona-Elena Modroiu
 
    rosdev.ro
+   <[email protected]>
 
 Edited by
 
 Bogdan-Andrei Iancu
 
+   voice-system.ro
+   <[email protected]>
+
    Copyright © 2002, 2003 FhG FOKUS
 
    Copyright © 2004, 2006 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -92,45 +102,45 @@ Bogdan-Andrei Iancu
    2. Frequently Asked Questions
 
    List of Examples
-   1-1. early_media example
-   1-2. failed_transaction_flag example
-   1-3. report_ack example
-   1-4. report_cancels example
-   1-5. detect_direction example
-   1-6. multi_leg_info example
-   1-7. log_flag example
-   1-8. log_missed_flag example
-   1-9. log_level example
-   1-10. log_facility example
-   1-11. log_extra example
-   1-12. radius_config example
-   1-13. radius_flag example
-   1-14. radius_missed_flag example
-   1-15. service_type example
-   1-16. radius_extra example
-   1-17. db_flag example
-   1-18. db_missed_flag example
-   1-19. db_table_acc example
-   1-20. db_table_missed_calls example
-   1-21. db_url example
-   1-22. acc_method_column example
-   1-23. acc_from_tag_column example
-   1-24. acc_to_tag_column example
-   1-25. acc_callid_column example
-   1-26. acc_sip_code_column example
-   1-27. acc_sip_reason_column example
-   1-28. acc_time_column example
-   1-29. db_extra example
-   1-30. diameter_flag example
-   1-31. diameter_missed_flag example
-   1-32. diameter_client_host example
-   1-33. diameter_client_host example
-   1-34. diameter_extra example
-   1-35. acc_log_request usage
-   1-36. acc_db_request usage
-   1-37. acc_rad_request usage
-   1-38. acc_diam_request usage
-     __________________________________________________________
+
+   1.1. early_media example
+   1.2. failed_transaction_flag example
+   1.3. report_ack example
+   1.4. report_cancels example
+   1.5. detect_direction example
+   1.6. multi_leg_info example
+   1.7. log_flag example
+   1.8. log_missed_flag example
+   1.9. log_level example
+   1.10. log_facility example
+   1.11. log_extra example
+   1.12. radius_config example
+   1.13. radius_flag example
+   1.14. radius_missed_flag example
+   1.15. service_type example
+   1.16. radius_extra example
+   1.17. db_flag example
+   1.18. db_missed_flag example
+   1.19. db_table_acc example
+   1.20. db_table_missed_calls example
+   1.21. db_url example
+   1.22. acc_method_column example
+   1.23. acc_from_tag_column example
+   1.24. acc_to_tag_column example
+   1.25. acc_callid_column example
+   1.26. acc_sip_code_column example
+   1.27. acc_sip_reason_column example
+   1.28. acc_time_column example
+   1.29. db_extra example
+   1.30. diameter_flag example
+   1.31. diameter_missed_flag example
+   1.32. diameter_client_host example
+   1.33. diameter_client_host example
+   1.34. diameter_extra example
+   1.35. acc_log_request usage
+   1.36. acc_db_request usage
+   1.37. acc_rad_request usage
+   1.38. acc_diam_request usage
 
 Chapter 1. User's Guide
 
@@ -142,23 +152,23 @@ Chapter 1. User's Guide
 
    To account a transaction and to choose which set of backends to
    be used, the script writer just has to set some flags (see the
-   module parameters section for flag definitions Section 1.5). If
-   the accouting flag for a specific backend is set, the acc
-   module will then report on completed transaction. A typical
-   usage of the module takes no acc-specific script command -- the
-   functionality binds invisibly through transaction processing.
-   Script writers just need to mark the transaction for accounting
-   with proper setflag. Even so, the module allows the script
-   writter to force accouting in special cases via some script
-   functions.
+   module parameters section for flag definitions Section 1.5,
+   "Exported Parameters"). If the accouting flag for a specific
+   backend is set, the acc module will then report on completed
+   transaction. A typical usage of the module takes no
+   acc-specific script command -- the functionality binds
+   invisibly through transaction processing. Script writers just
+   need to mark the transaction for accounting with proper
+   setflag. Even so, the module allows the script writter to force
+   accouting in special cases via some script functions.
 
    The accouting module will log by default a fixed set of
    attributes for the transaction - if you customize you accouting
    by adding more information to be logged, please see the next
-   chapter about extra accouting - Section 1.2.
+   chapter about extra accouting - Section 1.2, "Extra
+   accounting".
 
    The fixed minimal accouting information is:
-
      * Request Method name
      * From header TAG parameter
      * To header TAG parameter
@@ -171,7 +181,6 @@ Chapter 1. User's Guide
    accounted instead.
 
    Note that:
-
      * A single INVITE may produce multiple accounting reports --
        that's due to SIP forking feature
      * All flags related to accouting need to be set in request
@@ -211,7 +220,6 @@ Chapter 1. User's Guide
    specifications were updated in the meantime. Thus, the DIAMETER
    part in the module is obsolete and needs rework to be usable
    with opendiameter or other DIAMETER servers.
-     __________________________________________________________
 
 1.1.1. General Example
 
@@ -227,7 +235,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
         exit;
     }
 
-    if (method=="INVITE" & !check_from()) {
+    if (method=="INVITE" && !check_from()) {
         log("from!=digest\n");
         sl_send_reply("403","Forbidden");
     }
@@ -235,7 +243,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
     setflag(1); /* set for accounting (the same value as in log_flag!)
     t_relay();  /* enter stateful mode now */
 };
-     __________________________________________________________
 
 1.2. Extra accounting
 
@@ -245,7 +252,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
    dynamical selection of extra information to be logged. This
    allows you to log any pseudo-variable (AVPs, parts of the
    request, etc).
-     __________________________________________________________
 
 1.2.2. Definitions and syntax
 
@@ -254,7 +260,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
    log. This information is defined via pseudo-variables and may
    include headers or AVPs values or other message or system
    values. The syntax of the parameter is:
-
      * xxx_extra = extra_definition (';'extra_definition)*
      * extra_definition = log_name '=' pseudo_variable
 
@@ -264,7 +269,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 
    Via log_name you define how/where the data will be logged. Its
    meaning depends of the accounting support which is used:
-
      * LOG accounting - log_name will be just printed along with
        the data in log_name=data format;
      * DB accounting - log_name will be the name of the DB column
@@ -278,14 +282,12 @@ if (uri=~"sip:+40") /* calls to Romania */ {
        for packing the data into DIAMETER message. The AVP code is
        given directly as integer, since DIAMETER has no dictionary
        support yet. IMPORTANT: log_name must be a number.
-     __________________________________________________________
 
 1.2.3. How it works
 
    Some pseudo variables may return more than one value (like
    headers or AVPs). In this case, the returned values are
    embedded in a single string in a comma-separated format.
-     __________________________________________________________
 
 1.3. Multi Call-Legs accounting
 
@@ -301,7 +303,6 @@ if (uri=~"sip:+40") /* calls to Romania */ {
    Call forwarding on server is only one example which shows the
    necessity of the having an accounting engine with multiple legs
    support.
-     __________________________________________________________
 
 1.3.2. Configuration
 
@@ -323,14 +324,12 @@ if (uri=~"sip:+40") /* calls to Romania */ {
    By default, the multiple call-legs support is disabled - it can
    be enabled just be setting the per-leg set of AVPs via the
    multi_leg_info module parameter.
-     __________________________________________________________
 
 1.3.3. Logged data
 
    For each call, all the values of the AVP set (which defines a
    call-leg) will be logged. How the information will be actually
    logged, depends of the data backend:
-
      * syslog -- all leg-sets will be added to one record string
        as AVP1=xxx, AVP2=xxxx ,... sets.
      * database -- each pair will be separately logged (due DB
@@ -338,20 +337,18 @@ if (uri=~"sip:+40") /* calls to Romania */ {
        written, the difference between them being only the fields
        corresponding to the call-leg info.
 
-      Note
-
-           You will need to add in your DB (all acc related tables) the
-           colums for call-leg info (a column for each AVP for the set).
+Note
+       You will need to add in your DB (all acc related tables)
+       the colums for call-leg info (a column for each AVP for the
+       set).
      * Radius -- all sets will be added to same Radius accounting
        message as RADIUS AVPs - for each call-leg a set of RADIUS
        AVPs will be added (corresponding to the per-leg AVP set)
 
-    Note
-
-         You will need to add in your dictionaty the RADIUS AVPs used in
-         call-leg AVP set definition.
+Note
+       You will need to add in your dictionaty the RADIUS AVPs
+       used in call-leg AVP set definition.
      * Diameter same as for RADIUS.
-     __________________________________________________________
 
 1.4. Dependencies
 
@@ -359,22 +356,18 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * tm -- Transaction Manager
      * a database module -- If SQL support is used.
      * rr -- Record Route, if "detect_direction" module parameter
        is enabled.
-     __________________________________________________________
 
 1.4.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * radiusclient-ng 0.5.0 or higher -- if compiled with RADIUS
        support. See
        http://developer.berlios.de/projects/radiusclient-ng/.
-     __________________________________________________________
 
 1.5. Exported Parameters
 
@@ -384,9 +377,8 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 
    Default value is 0 (no).
 
-   Example 1-1. early_media example
+   Example 1.1. early_media example
 modparam("acc", "early_media", 1)
-     __________________________________________________________
 
 1.5.2. failed_transaction_flag (integer)
 
@@ -395,9 +387,8 @@ modparam("acc", "early_media", 1)
 
    Default value is not-set (no flag).
 
-   Example 1-2. failed_transaction_flag example
+   Example 1.2. failed_transaction_flag example
 modparam("acc", "failed_transaction_flag", 4)
-     __________________________________________________________
 
 1.5.3. report_ack (integer)
 
@@ -408,9 +399,8 @@ modparam("acc", "failed_transaction_flag", 4)
 
    Default value is 0 (no).
 
-   Example 1-3. report_ack example
+   Example 1.3. report_ack example
 modparam("acc", "report_ack", 1)
-     __________________________________________________________
 
 1.5.4. report_cancels (integer)
 
@@ -420,9 +410,8 @@ modparam("acc", "report_ack", 1)
 
    Default value is 0 (no).
 
-   Example 1-4. report_cancels example
+   Example 1.4. report_cancels example
 modparam("acc", "report_cancels", 1)
-     __________________________________________________________
 
 1.5.5. detect_direction (integer)
 
@@ -437,21 +426,20 @@ modparam("acc", "report_cancels", 1)
 
    Default value is 0 (disabled).
 
-   Example 1-5. detect_direction example
+   Example 1.5. detect_direction example
 modparam("acc", "detect_direction", 1)
-     __________________________________________________________
 
 1.5.6. multi_leg_info (string)
 
    Defines the AVP set to be used in per-call-leg accoutning. See
-   Section 1.3 for a detailed description of the Multi Call-Legs
-   accounting.
+   Section 1.3, "Multi Call-Legs accounting" for a detailed
+   description of the Multi Call-Legs accounting.
 
    If empty, the multi-leg accouting support will be disabled.
 
    Default value is 0 (disabled).
 
-   Example 1-6. multi_leg_info example
+   Example 1.6. multi_leg_info example
 # for syslog-based accouting, use any text you want to be printed
 modparam("acc", "multi_leg_info",
     "text1=$avp(src);text2=$avp(dst)")
@@ -464,7 +452,6 @@ modparam("acc", "multi_leg_info",
 # for DIAMETER-based accouting, use the DIAMETER AVP ID (as integer)
 modparam("acc", "multi_leg_info",
     "2345=$avp(src);2346=$avp(dst)")
-     __________________________________________________________
 
 1.5.7. log_flag (integer)
 
@@ -473,9 +460,8 @@ modparam("acc", "multi_leg_info",
 
    Default value is not-set (no flag).
 
-   Example 1-7. log_flag example
+   Example 1.7. log_flag example
 modparam("acc", "log_flag", 2)
-     __________________________________________________________
 
 1.5.8. log_missed_flag (integer)
 
@@ -484,9 +470,8 @@ modparam("acc", "log_flag", 2)
 
    Default value is not-set (no flag).
 
-   Example 1-8. log_missed_flag example
+   Example 1.8. log_missed_flag example
 modparam("acc", "log_missed_flag", 3)
-     __________________________________________________________
 
 1.5.9. log_level (integer)
 
@@ -494,9 +479,8 @@ modparam("acc", "log_missed_flag", 3)
 
    Default value is L_NOTICE.
 
-   Example 1-9. log_level example
+   Example 1.9. log_level example
 modparam("acc", "log_level", 2)   # Set log_level to 2
-     __________________________________________________________
 
 1.5.10. log_facility (string)
 
@@ -506,9 +490,8 @@ modparam("acc", "log_level", 2)   # Set log_level to 2
 
    Default value is LOG_DAEMON.
 
-   Example 1-10. log_facility example
+   Example 1.10. log_facility example
 modparam("acc", "log_facility", "LOG_DAEMON")
-     __________________________________________________________
 
 1.5.11. log_extra (string)
 
@@ -516,9 +499,8 @@ modparam("acc", "log_facility", "LOG_DAEMON")
 
    Default value is NULL.
 
-   Example 1-11. log_extra example
+   Example 1.11. log_extra example
 modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
-     __________________________________________________________
 
 1.5.12. radius_config (string)
 
@@ -535,9 +517,8 @@ modparam("acc", "log_extra", "ua=$hdr(User-Agent);uuid=$avp(i:123)")
    Default value is "/usr/local/etc/radiusclient/radiusclient.conf
    ".
 
-   Example 1-12. radius_config example
+   Example 1.12. radius_config example
 modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
-     __________________________________________________________
 
 1.5.13. radius_flag (integer)
 
@@ -546,9 +527,8 @@ modparam("acc", "radius_config", "/etc/radiusclient/radiusclient.conf")
 
    Default value is not-set (no flag).
 
-   Example 1-13. radius_flag example
+   Example 1.13. radius_flag example
 modparam("acc", "radius_flag", 2)
-     __________________________________________________________
 
 1.5.14. radius_missed_flag (integer)
 
@@ -557,9 +537,8 @@ modparam("acc", "radius_flag", 2)
 
    Default value is not-set (no flag).
 
-   Example 1-14. radius_missed_flag example
+   Example 1.14. radius_missed_flag example
 modparam("acc", "radius_missed_flag", 3)
-     __________________________________________________________
 
 1.5.15. service_type (integer)
 
@@ -567,9 +546,8 @@ modparam("acc", "radius_missed_flag", 3)
 
    Default value is 15 (SIP).
 
-   Example 1-15. service_type example
+   Example 1.15. service_type example
 modparam("acc", "service_type", 16)
-     __________________________________________________________
 
 1.5.16. radius_extra (string)
 
@@ -577,9 +555,8 @@ modparam("acc", "service_type", 16)
 
    Default value is NULL.
 
-   Example 1-16. radius_extra example
+   Example 1.16. radius_extra example
 modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
-     __________________________________________________________
 
 1.5.17. db_flag (integer)
 
@@ -588,9 +565,8 @@ modparam("acc", "radius_extra", "via=$hdr(Via[*]); email=$avp(s:email)")
 
    Default value is not-set (no flag).
 
-   Example 1-17. db_flag example
+   Example 1.17. db_flag example
 modparam("acc", "db_flag", 2)
-     __________________________________________________________
 
 1.5.18. db_missed_flag (integer)
 
@@ -599,9 +575,8 @@ modparam("acc", "db_flag", 2)
 
    Default value is not-set (no flag).
 
-   Example 1-18. db_missed_flag example
+   Example 1.18. db_missed_flag example
 modparam("acc", "db_missed_flag", 3)
-     __________________________________________________________
 
 1.5.19. db_table_acc (string)
 
@@ -610,9 +585,8 @@ modparam("acc", "db_missed_flag", 3)
 
    Default value is "acc"
 
-   Example 1-19. db_table_acc example
+   Example 1.19. db_table_acc example
 modparam("acc", "db_table_acc", "myacc_table")
-     __________________________________________________________
 
 1.5.20. db_table_missed_calls (string)
 
@@ -620,9 +594,8 @@ modparam("acc", "db_table_acc", "myacc_table")
 
    Default value is "missed_calls"
 
-   Example 1-20. db_table_missed_calls example
+   Example 1.20. db_table_missed_calls example
 modparam("acc", "db_table_missed_calls", "myMC_table")
-     __________________________________________________________
 
 1.5.21. db_url (string)
 
@@ -631,9 +604,8 @@ modparam("acc", "db_table_missed_calls", "myMC_table")
 
    Default value is "NULL" (SQL disabled).
 
-   Example 1-21. db_url example
+   Example 1.21. db_url example
 modparam("acc", "db_url", "mysql://user:password@localhost/openser")
-     __________________________________________________________
 
 1.5.22. acc_method_column (string)
 
@@ -642,9 +614,8 @@ modparam("acc", "db_url", "mysql://user:password@localhost/openser")
 
    Default value is "method".
 
-   Example 1-22. acc_method_column example
+   Example 1.22. acc_method_column example
 modparam("acc", "acc_method_column", "method")
-     __________________________________________________________
 
 1.5.23. acc_from_tag_column (string)
 
@@ -653,9 +624,8 @@ modparam("acc", "acc_method_column", "method")
 
    Default value is "from_tag".
 
-   Example 1-23. acc_from_tag_column example
+   Example 1.23. acc_from_tag_column example
 modparam("acc", "acc_from_tag_column", "from_tag")
-     __________________________________________________________
 
 1.5.24. acc_to_tag_column (string)
 
@@ -664,9 +634,8 @@ modparam("acc", "acc_from_tag_column", "from_tag")
 
    Default value is "to_tag".
 
-   Example 1-24. acc_to_tag_column example
+   Example 1.24. acc_to_tag_column example
 modparam("acc", "acc_to_tag_column", "to_tag")
-     __________________________________________________________
 
 1.5.25. acc_callid_column (string)
 
@@ -675,9 +644,8 @@ modparam("acc", "acc_to_tag_column", "to_tag")
 
    Default value is "callid".
 
-   Example 1-25. acc_callid_column example
+   Example 1.25. acc_callid_column example
 modparam("acc", "acc_callid_column", "callid")
-     __________________________________________________________
 
 1.5.26. acc_sip_code_column (string)
 
@@ -686,9 +654,8 @@ modparam("acc", "acc_callid_column", "callid")
 
    Default value is "sip_code".
 
-   Example 1-26. acc_sip_code_column example
+   Example 1.26. acc_sip_code_column example
 modparam("acc", "acc_sip_code_column", "sip_code")
-     __________________________________________________________
 
 1.5.27. acc_sip_reason_column (string)
 
@@ -697,9 +664,8 @@ modparam("acc", "acc_sip_code_column", "sip_code")
 
    Default value is "sip_reason".
 
-   Example 1-27. acc_sip_reason_column example
+   Example 1.27. acc_sip_reason_column example
 modparam("acc", "acc_sip_reason_column", "sip_reason")
-     __________________________________________________________
 
 1.5.28. acc_time_column (string)
 
@@ -708,9 +674,8 @@ modparam("acc", "acc_sip_reason_column", "sip_reason")
 
    Default value is "time".
 
-   Example 1-28. acc_time_column example
+   Example 1.28. acc_time_column example
 modparam("acc", "acc_time_column", "time")
-     __________________________________________________________
 
 1.5.29. db_extra (string)
 
@@ -718,10 +683,9 @@ modparam("acc", "acc_time_column", "time")
 
    Default value is NULL.
 
-   Example 1-29. db_extra example
+   Example 1.29. db_extra example
 modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)"
 )
-     __________________________________________________________
 
 1.5.30. diameter_flag (integer)
 
@@ -730,9 +694,8 @@ modparam("acc", "db_extra", "ct=$hdr(Content-type); email=$avp(s:email)"
 
    Default value is not-set (no flag).
 
-   Example 1-30. diameter_flag example
+   Example 1.30. diameter_flag example
 modparam("acc", "diameter_flag", 2)
-     __________________________________________________________
 
 1.5.31. diameter_missed_flag (integer)
 
@@ -741,9 +704,8 @@ modparam("acc", "diameter_flag", 2)
 
    Default value is not-set (no flag).
 
-   Example 1-31. diameter_missed_flag example
+   Example 1.31. diameter_missed_flag example
 modparam("acc", "diameter_missed_flag", 3)
-     __________________________________________________________
 
 1.5.32. diameter_client_host (string)
 
@@ -752,9 +714,8 @@ modparam("acc", "diameter_missed_flag", 3)
 
    Default value is "localhost".
 
-   Example 1-32. diameter_client_host example
+   Example 1.32. diameter_client_host example
 modparam("acc", "diameter_client_host", "3a_server.net")
-     __________________________________________________________
 
 1.5.33. diameter_client_port (int)
 
@@ -763,9 +724,8 @@ modparam("acc", "diameter_client_host", "3a_server.net")
 
    Default value is 3000.
 
-   Example 1-33. diameter_client_host example
+   Example 1.33. diameter_client_host example
 modparam("acc", "diameter_client_port", 3000)
-     __________________________________________________________
 
 1.5.34. diameter_extra (string)
 
@@ -773,14 +733,13 @@ modparam("acc", "diameter_client_port", 3000)
 
    Default value is NULL.
 
-   Example 1-34. diameter_extra example
+   Example 1.34. diameter_extra example
 modparam("acc", "diameter_extra", "7846=$hdr(Content-type);7847=$avp(s:e
 mail)")
-     __________________________________________________________
 
 1.6. Exported Functions
 
-1.6.1. acc_log_request(comment)
+1.6.1.  acc_log_request(comment)
 
    acc_request reports on a request, for example, it can be used
    to report on missed calls to off-line users who are replied 404
@@ -789,123 +748,117 @@ mail)")
    processing.
 
    Meaning of the parameters is as follows:
-
      * comment - Comment to be appended.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-35. acc_log_request usage
+   Example 1.35. acc_log_request usage
 ...
 acc_log_request("Some comment");
 ...
-     __________________________________________________________
 
-1.6.2. acc_db_request(comment, table)
+1.6.2.  acc_db_request(comment, table)
 
    Like acc_log_request, acc_db_request reports on a request. The
    report is sent to database at "db_url", in the table referred
    to in the second action parameter.
 
    Meaning of the parameters is as follows:
-
      * comment - Comment to be appended.
      * table - Database table to be used.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-36. acc_db_request usage
+   Example 1.36. acc_db_request usage
 ...
 acc_log_request("Some comment", "Some table");
 ...
-     __________________________________________________________
 
-1.6.3. acc_rad_request(comment)
+1.6.3.  acc_rad_request(comment)
 
    Like acc_log_request, acc_rad_request reports on a request. It
    reports to radius server as configured in "radius_config".
 
    Meaning of the parameters is as follows:
-
      * comment - Comment to be appended.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-37. acc_rad_request usage
+   Example 1.37. acc_rad_request usage
 ...
 acc_rad_request("Some comment");
 ...
-     __________________________________________________________
 
-1.6.4. acc_diam_request(comment)
+1.6.4.  acc_diam_request(comment)
 
    Like acc_log_request, acc_diam_request reports on a request. It
    reports to the configured Diameter server.
 
    Meaning of the parameters is as follows:
-
      * comment - Comment to be appended.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-38. acc_diam_request usage
+   Example 1.38. acc_diam_request usage
 ...
 acc_diam_request("Some comment");
 ...
-     __________________________________________________________
 
 Chapter 2. Frequently Asked Questions
 
-   2.1. What happend with old log_fmt parameter
-   2.2. What happend with old multi_leg_enabled parameter
-   2.3. What happend with old src_leg_avp_id & dst_leg_avp_id
-          parameters
+   2.1.
+
+       What happend with old log_fmt parameter
+
+       The parameter became obsolete with the restructure of the data
+       logged by ACC module (refer to the Overview chapter). For
+       similar behaviour you can use the extra accouting (see the
+       coresponding chapter).
+
+   2.2.
 
-   2.4. Where can I find more about OpenSER?
-   2.5. Where can I post a question about this module?
-   2.6. How can I report a bug?
+       What happend with old multi_leg_enabled parameter
 
-   2.1. What happend with old log_fmt parameter
+       The parameter becaome obsolete by the addition of the new
+       multi_leg_info parameter. The multi-leg accouting is
+       automatically enabled when multi_leg_info is defined.
 
-   The parameter became obsolete with the restructure of the data
-   logged by ACC module (refer to the Overview chapter). For
-   similar behaviour you can use the extra accouting (see the
-   coresponding chapter).
+   2.3.
 
-   2.2. What happend with old multi_leg_enabled parameter
+       What happend with old src_leg_avp_id and dst_leg_avp_id
+       parameters
 
-   The parameter becaome obsolete by the addition of the new
-   multi_leg_info parameter. The multi-leg accouting is
-   automatically enabled when multi_leg_info is defined.
+       The parameter was replaced by the more generic new parameter
+       multi_leg_info. This allows logging (per-leg) of more
+       information than just dst and src.
 
-   2.3. What happend with old src_leg_avp_id & dst_leg_avp_id
-   parameters
+   2.4.
 
-   The parameter was replaced by the more generic new parameter
-   multi_leg_info. This allows logging (per-leg) of more
-   information than just dst and src.
+       Where can I find more about OpenSER?
 
-   2.4. Where can I find more about OpenSER?
+       Take a look at http://openser.org/.
 
-   Take a look at http://openser.org/.
+   2.5.
 
-   2.5. 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:
+       First at all check if your question was already answered on one
+       of our mailing lists:
+         * User Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
 
-     * User Mailing List -
-       http://openser.org/cgi-bin/mailman/listinfo/users
-     * Developer Mailing List -
-       http://openser.org/cgi-bin/mailman/listinfo/devel
+       E-mails regarding any stable OpenSER release should be sent to
+       <[email protected]> and e-mails regarding development versions
+       should be sent to <[email protected]>.
 
-   E-mails regarding any stable OpenSER 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.6.
 
-   2.6. How can I report a bug?
+       How can I report a bug?
 
-   Please follow the guidelines provided at:
-   http://sourceforge.net/tracker/?group_id=139143.
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/acc/doc/acc.sgml → modules_k/acc/doc/acc.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "acc_user.sgml">
-<!ENTITY faq SYSTEM "acc_faq.sgml">
+<!ENTITY user SYSTEM "acc_admin.xml">
+<!ENTITY faq SYSTEM "acc_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -51,8 +53,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/acc/doc/acc_user.sgml → modules_k/acc/doc/acc_admin.xml

@@ -15,7 +15,7 @@
 	<para>
 		To account a transaction and to choose which set of backends to be 
 		used, the script writer just has to set some flags (see the module
-		parameters section for flag definitions <xref linkend="ACC-param-id">).
+		parameters section for flag definitions <xref linkend="ACC-param-id"/>).
 		If the accouting flag for a specific backend is set, the acc module 
 		will then report on completed transaction. A typical usage of the 
 		module takes no acc-specific script command -- the functionality 
@@ -28,7 +28,7 @@
 		The accouting module will log by default a fixed set of attributes 
 		for the transaction - if you customize you accouting by adding more
 		information to be logged, please see the next chapter about extra
-		accouting - <xref linkend="ACC-extra-id">.
+		accouting - <xref linkend="ACC-extra-id"/>.
 	</para>
 	<para>
 		The fixed minimal accouting information is: 
@@ -136,7 +136,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
         exit;
     }
 
-    if (method=="INVITE" & !check_from()) {
+    if (method=="INVITE" &amp;&amp; !check_from()) {
         log("from!=digest\n");
         sl_send_reply("403","Forbidden");
     }
@@ -163,7 +163,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 			<title>Definitions and syntax</title>
 			<para>
 			Selection of extra information is done via 
-			<emphasis>xxx_extra<emphasis> parameters by specifying the names
+			<emphasis>xxx_extra</emphasis> parameters by specifying the names
 			of additional information you want to log. This information is 
 			defined via pseudo-variables and may include headers or AVPs values
 			or other message or system values. The syntax of the parameter is:
@@ -193,14 +193,14 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 				</para></listitem>
 				<listitem><para><emphasis>DB accounting</emphasis> - log_name 
 				will be the name of the DB column where the data will be 
-				stored.<emphasis>IMPORTANT<emphasis>: add in db 
+				stored.<emphasis>IMPORTANT</emphasis>: add in db 
 				<emphasis>acc</emphasis> table the columns corresponding to 
 				each extra data;
 				</para></listitem>
 				<listitem><para><emphasis>RADIUS accounting</emphasis> - 
 				log_name will be the AVP name used for packing the data into 
 				RADIUS message. The log_name will be translated to AVP number 
-				via the dictionary. <emphasis>IMPORTANT<emphasis>: add in 
+				via the dictionary. <emphasis>IMPORTANT</emphasis>: add in 
 				RADIUS dictionary the <emphasis>log_name</emphasis> attribute.
 				</para></listitem>
 				<listitem><para><emphasis>DIAMETER accounting</emphasis> - 
@@ -335,6 +335,7 @@ if (uri=~"sip:+40") /* calls to Romania */ {
 			<para>
 			The following libraries or applications must be installed 
 			before running &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>radiusclient-ng</emphasis> 0.5.0 or higher -- 
@@ -442,7 +443,7 @@ modparam("acc", "detect_direction", 1)
 		<title><varname>multi_leg_info</varname> (string)</title>
 		<para>
 		Defines the AVP set to be used in per-call-leg accoutning.
-		See <xref linkend="multi-call-legs"> for a 
+		See <xref linkend="multi-call-legs"/> for a 
 		detailed description of the Multi Call-Legs accounting.
 		</para>
 		<para>

modules_k/acc/doc/acc_faq.sgml → modules_k/acc/doc/acc_faq.xml

@@ -34,7 +34,8 @@
 
 	<qandaentry>
 		<question>
-		<para>What happend with old src_leg_avp_id & dst_leg_avp_id parameters</para>
+			<para>What happend with old src_leg_avp_id and dst_leg_avp_id
+				parameters</para>
 		</question>
 		<answer>
 		<para>

modules_k/alias_db/README

@@ -2,16 +2,18 @@ ALIAS_DB Module
 
 Daniel-Constantin Mierla
 
-   voice-system.ro
-
 Edited by
 
 Daniel-Constantin Mierla
 
    Copyright © 2005 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -34,16 +36,18 @@ Daniel-Constantin Mierla
 
               1.4.1. alias_db_lookup(table_name)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set db_url parameter
-   1-2. Set user_column parameter
-   1-3. Set domain_column parameter
-   1-4. Set alias_user_column parameter
-   1-5. Set alias_domain_column parameter
-   1-6. Set use_domain parameter
-   1-7. Set domain_prefix parameter
-   1-8. alias_db_lookup() usage
-     __________________________________________________________
+
+   1.1. Set db_url parameter
+   1.2. Set user_column parameter
+   1.3. Set domain_column parameter
+   1.4. Set alias_user_column parameter
+   1.5. Set alias_domain_column parameter
+   1.6. Set use_domain parameter
+   1.7. Set domain_prefix parameter
+   1.8. alias_db_lookup() usage
 
 Chapter 1. User's Guide
 
@@ -58,24 +62,19 @@ Chapter 1. User's Guide
    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
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * database module (mysql, dbtext, ...).
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -85,11 +84,10 @@ Chapter 1. User's Guide
 
    Default value is "DEFAULT_RODB_URL".
 
-   Example 1-1. Set db_url parameter
+   Example 1.1. Set db_url parameter
 ...
 modparam("alias_db", "db_url", "mysql://user:passwd@localhost/openser")
 ...
-     __________________________________________________________
 
 1.3.2. user_column (str)
 
@@ -97,11 +95,10 @@ modparam("alias_db", "db_url", "mysql://user:passwd@localhost/openser")
 
    Default value is "username".
 
-   Example 1-2. Set user_column parameter
+   Example 1.2. Set user_column parameter
 ...
 modparam("alias_db", "user_column", "susername")
 ...
-     __________________________________________________________
 
 1.3.3. domain_column (str)
 
@@ -109,11 +106,10 @@ modparam("alias_db", "user_column", "susername")
 
    Default value is "domain".
 
-   Example 1-3. Set domain_column parameter
+   Example 1.3. Set domain_column parameter
 ...
 modparam("alias_db", "domain_column", "sdomain")
 ...
-     __________________________________________________________
 
 1.3.4. alias_user_column (str)
 
@@ -121,11 +117,10 @@ modparam("alias_db", "domain_column", "sdomain")
 
    Default value is "alias_username".
 
-   Example 1-4. Set alias_user_column parameter
+   Example 1.4. Set alias_user_column parameter
 ...
 modparam("alias_db", "alias_user_column", "auser")
 ...
-     __________________________________________________________
 
 1.3.5. alias_domain_column (str)
 
@@ -133,11 +128,10 @@ modparam("alias_db", "alias_user_column", "auser")
 
    Default value is "alias_domain".
 
-   Example 1-5. Set alias_domain_column parameter
+   Example 1.5. Set alias_domain_column parameter
 ...
 modparam("alias_db", "alias_domain_column", "adomain")
 ...
-     __________________________________________________________
 
 1.3.6. use_domain (int)
 
@@ -147,11 +141,10 @@ modparam("alias_db", "alias_domain_column", "adomain")
 
    Default value is "o".
 
-   Example 1-6. Set use_domain parameter
+   Example 1.6. Set use_domain parameter
 ...
 modparam("alias_db", "use_domain", 1)
 ...
-     __________________________________________________________
 
 1.3.7. domain_prefix (str)
 
@@ -160,15 +153,14 @@ modparam("alias_db", "use_domain", 1)
 
    Default value is "NULL".
 
-   Example 1-7. Set domain_prefix parameter
+   Example 1.7. Set domain_prefix parameter
 ...
 modparam("alias_db", "domain_prefix", "sip.")
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. alias_db_lookup(table_name)
+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
@@ -178,13 +170,45 @@ modparam("alias_db", "domain_prefix", "sip.")
    by user's SIP uri.
 
    Meaning of the parameters is as follows:
-
      * table_name - the name of the table where to search for
        alias.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-8. alias_db_lookup() usage
+   Example 1.8. alias_db_lookup() usage
 ...
 alias_db_lookup("dbaliases");
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/alias_db/doc/alias_db.sgml → modules_k/alias_db/doc/alias_db.xml

@@ -1,14 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "alias_db_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "alias_db_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!ENTITY aliasdbsql SYSTEM "alias_db.sql">
 
-<!ENTITY developeremail "[email protected]">
-
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -21,16 +21,15 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
 		<address>
-		<email>&developeremail;</email>
+		<email>[email protected]</email>
 		</address>
 	    </author>
 	    <editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
 		<address>
-		<email>&developeremail;</email>
+		<email>[email protected]</email>
 		</address>
 	    </editor>
 	</authorgroup>
@@ -40,8 +39,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/auth/README

@@ -3,25 +3,34 @@ Auth Module
 Jan Janak
 
    FhG Fokus
+   <[email protected]>
 
 Juha Heinanen
 
    Song Networks
+   <[email protected]>
 
 Bogdan-Andrei Iancu
 
    voice-system.ro
+   <[email protected]>
 
 Edited by
 
 Jan Janak
 
+   <[email protected]>
+
    Copyright © 2002, 2003 FhG FOKUS
 
    Copyright © 2005 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -53,25 +62,27 @@ Jan Janak
               1.4.7. pv_www_authorize(realm)
               1.4.8. pv_proxy_authorize(realm)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. secret parameter example
-   1-2. nonce_expire parameter example
-   1-3. rpid_prefix parameter example
-   1-4. rpid_suffix parameter example
-   1-5. realm_prefix parameter example
-   1-6. rpid_avp parameter example
-   1-7. username_spec parameter usage
-   1-8. password_spec parameter usage
-   1-9. calculate_ha1 parameter usage
-   1-10. www_challenge usage
-   1-11. proxy_challenge usage
-   1-12. consume_credentials example
-   1-13. is_rpid_user_e164 usage
-   1-14. append_rpid_hf usage
-   1-15. append_rpid_hf(prefix, suffix) usage
-   1-16. pv_www_authorize usage
-   1-17. pv_proxy_authorize usage
-     __________________________________________________________
+
+   1.1. secret parameter example
+   1.2. nonce_expire parameter example
+   1.3. rpid_prefix parameter example
+   1.4. rpid_suffix parameter example
+   1.5. realm_prefix parameter example
+   1.6. rpid_avp parameter example
+   1.7. username_spec parameter usage
+   1.8. password_spec parameter usage
+   1.9. calculate_ha1 parameter usage
+   1.10. www_challenge usage
+   1.11. proxy_challenge usage
+   1.12. consume_credentials example
+   1.13. is_rpid_user_e164 usage
+   1.14. append_rpid_hf usage
+   1.15. append_rpid_hf(prefix, suffix) usage
+   1.16. pv_www_authorize usage
+   1.17. pv_proxy_authorize usage
 
 Chapter 1. User's Guide
 
@@ -81,7 +92,6 @@ Chapter 1. User's Guide
    by other authentication related modules. Also, it can perform
    authentication taking username and password from
    pseudo-variables.
-     __________________________________________________________
 
 1.2. Dependencies
 
@@ -89,17 +99,13 @@ Chapter 1. User's Guide
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * sl -- Stateless replies
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * none
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -118,9 +124,8 @@ Chapter 1. User's Guide
    to stay with the default. Any clients should send the reply to
    the server that issued the request.
 
-   Example 1-1. secret parameter example
+   Example 1.1. secret parameter example
 modparam("auth", "secret", "johndoessecretphrase")
-     __________________________________________________________
 
 1.3.2. nonce_expire (integer)
 
@@ -135,9 +140,8 @@ modparam("auth", "secret", "johndoessecretphrase")
 
    The value is in seconds and default value is 300 seconds.
 
-   Example 1-2. nonce_expire parameter example
+   Example 1.2. nonce_expire parameter example
 modparam("auth", "nonce_expire", 600)   # Set nonce_expire to 600s
-     __________________________________________________________
 
 1.3.3. rpid_prefix (string)
 
@@ -146,9 +150,8 @@ modparam("auth", "nonce_expire", 600)   # Set nonce_expire to 600s
 
    Default value is "".
 
-   Example 1-3. rpid_prefix parameter example
+   Example 1.3. rpid_prefix parameter example
 modparam("auth", "rpid_prefix", "Whatever <")
-     __________________________________________________________
 
 1.3.4. rpid_suffix (string)
 
@@ -158,9 +161,8 @@ modparam("auth", "rpid_prefix", "Whatever <")
    Default value is
    ";party=calling;id-type=subscriber;screen=yes".
 
-   Example 1-4. rpid_suffix parameter example
+   Example 1.4. rpid_suffix parameter example
 modparam("auth", "rpid_suffix", "@1.2.3.4>")
-     __________________________________________________________
 
 1.3.5. realm_prefix (string)
 
@@ -174,9 +176,8 @@ modparam("auth", "rpid_suffix", "@1.2.3.4>")
 
    Default value is empty string.
 
-   Example 1-5. realm_prefix parameter example
+   Example 1.5. realm_prefix parameter example
 modparam("auth", "realm_prefix", "sip.")
-     __________________________________________________________
 
 1.3.6. rpid_avp (string)
 
@@ -190,9 +191,8 @@ modparam("auth", "realm_prefix", "sip.")
 
    Default value is "$avp(s:rpid)".
 
-   Example 1-6. rpid_avp parameter example
+   Example 1.6. rpid_avp parameter example
 modparam("auth", "rpid_avp", "$avp(i:13)")
-     __________________________________________________________
 
 1.3.7. username_spec (string)
 
@@ -200,9 +200,8 @@ modparam("auth", "rpid_avp", "$avp(i:13)")
 
    Default value is "NULL".
 
-   Example 1-7. username_spec parameter usage
+   Example 1.7. username_spec parameter usage
 modparam("auth", "username_spec", "$var(username)")
-     __________________________________________________________
 
 1.3.8. password_spec (string)
 
@@ -210,9 +209,8 @@ modparam("auth", "username_spec", "$var(username)")
 
    Default value is "NULL".
 
-   Example 1-8. password_spec parameter usage
+   Example 1.8. password_spec parameter usage
 modparam("auth", "password_spec", "$avp(s:password)")
-     __________________________________________________________
 
 1.3.9. calculate_ha1 (integer)
 
@@ -229,13 +227,12 @@ modparam("auth", "password_spec", "$avp(s:password)")
 
    Default value of this parameter is 0.
 
-   Example 1-9. calculate_ha1 parameter usage
+   Example 1.9. calculate_ha1 parameter usage
 modparam("auth", "calculate_ha1", 1)
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. www_challenge(realm, qop)
+1.4.1.  www_challenge(realm, qop)
 
    The function challenges a user agent. It will generate a
    WWW-Authorize header field containing a digest challenge, it
@@ -246,7 +243,6 @@ modparam("auth", "calculate_ha1", 1)
    regarding digest authentication see RFC2617.
 
    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
@@ -274,15 +270,14 @@ modparam("auth", "calculate_ha1", 1)
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-10. www_challenge usage
+   Example 1.10. www_challenge usage
 ...
 if (www_authorize("siphub.net", "subscriber")) {
         www_challenge("siphub.net", "1");
 };
 ...
-     __________________________________________________________
 
-1.4.2. proxy_challenge(realm, qop)
+1.4.2.  proxy_challenge(realm, qop)
 
    The function challenges a user agent. It will generate a
    Proxy-Authorize header field containing a digest challenge, it
@@ -293,7 +288,6 @@ if (www_authorize("siphub.net", "subscriber")) {
    regarding digest authentication see RFC2617.
 
    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
@@ -319,15 +313,14 @@ if (www_authorize("siphub.net", "subscriber")) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-11. proxy_challenge usage
+   Example 1.11. proxy_challenge usage
 ...
 if (!proxy_authorize("", "subscriber)) {
         proxy_challenge("", "1");  # Realm will be autogenerated
 };
 ...
-     __________________________________________________________
 
-1.4.3. consume_credentials()
+1.4.3.  consume_credentials()
 
    This function removes previously authorized credentials from
    the message being processed by the server. That means that the
@@ -339,15 +332,14 @@ if (!proxy_authorize("", "subscriber)) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-12. consume_credentials example
+   Example 1.12. consume_credentials example
 ...
 if (www_authorize("", "subscriber)) {
     consume_credentials();
 };
 ...
-     __________________________________________________________
 
-1.4.4. is_rpid_user_e164()
+1.4.4.  is_rpid_user_e164()
 
    The function checks if the SIP URI received from the database
    or radius server and will potentially be used in
@@ -358,15 +350,14 @@ if (www_authorize("", "subscriber)) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-13. is_rpid_user_e164 usage
+   Example 1.13. is_rpid_user_e164 usage
 ...
 if (is_rpid_user_e164()) {
     # do something here
 };
 ...
-     __________________________________________________________
 
-1.4.5. append_rpid_hf()
+1.4.5.  append_rpid_hf()
 
    Appends to the message a Remote-Party-ID header that contains
    header 'Remote-Party-ID: ' followed by the saved value of the
@@ -377,22 +368,20 @@ if (is_rpid_user_e164()) {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
 
-   Example 1-14. append_rpid_hf usage
+   Example 1.14. append_rpid_hf usage
 ...
 append_rpid_hf();  # Append Remote-Party-ID header field
 ...
-     __________________________________________________________
 
-1.4.6. append_rpid_hf(prefix, suffix)
+1.4.6.  append_rpid_hf(prefix, suffix)
 
-   This function is the same as Section 1.4.5. The only difference
-   is that it accepts two parameters--prefix and suffix to be
-   added to Remote-Party-ID header field. This function ignores
-   rpid_prefix and rpid_suffix parameters, instead of that allows
-   to set them in every call.
+   This function is the same as Section 1.4.5, "
+   append_rpid_hf()". The only difference is that it accepts two
+   parameters--prefix and suffix to be added to Remote-Party-ID
+   header field. This function ignores rpid_prefix and rpid_suffix
+   parameters, instead of that allows to set them in every call.
 
    Meaning of the parameters is as follows:
-
      * prefix - Prefix of the Remote-Party-ID URI. The string will
        be added at the begining of body of the header field, just
        before the URI.
@@ -403,14 +392,13 @@ append_rpid_hf();  # Append Remote-Party-ID header field
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
 
-   Example 1-15. append_rpid_hf(prefix, suffix) usage
+   Example 1.15. append_rpid_hf(prefix, suffix) usage
 ...
 # Append Remote-Party-ID header field
 append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
 ...
-     __________________________________________________________
 
-1.4.7. pv_www_authorize(realm)
+1.4.7.  pv_www_authorize(realm)
 
    The function verifies credentials according to RFC2617. If the
    credentials are verified successfully then the function will
@@ -421,7 +409,6 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
    which will challenge the user again.
 
    Negative codes may be interpreted as follows:
-
      * -5 (generic error) - some generic error occurred and no
        reply was sent out;
      * -4 (no credentials) - credentials were not found in
@@ -431,7 +418,6 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
      * -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
@@ -445,7 +431,7 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-16. pv_www_authorize usage
+   Example 1.16. pv_www_authorize usage
 ...
 $var(username)="abc";
 $avp(s:password)="xyz";
@@ -453,9 +439,8 @@ if (pv_www_authorize("openser.org")) {
         www_challenge("openser.org", "1");
 };
 ...
-     __________________________________________________________
 
-1.4.8. pv_proxy_authorize(realm)
+1.4.8.  pv_proxy_authorize(realm)
 
    The function verifies credentials according to RFC2617. If the
    credentials are verified successfully then the function will
@@ -467,7 +452,6 @@ if (pv_www_authorize("openser.org")) {
    negative return codes, see the above function.
 
    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
@@ -479,7 +463,7 @@ if (pv_www_authorize("openser.org")) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-17. pv_proxy_authorize usage
+   Example 1.17. pv_proxy_authorize usage
 ...
 $var(username)="abc";
 $avp(s:password)="xyz";
@@ -487,3 +471,36 @@ if (!pv_proxy_authorize("")) {
         proxy_challenge("", "1");  # Realm will be autogenerated
 };
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/auth/doc/auth.sgml → modules_k/auth/doc/auth.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "auth_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "auth_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -49,8 +51,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/auth/doc/auth_user.sgml → modules_k/auth/doc/auth_admin.xml

@@ -32,6 +32,7 @@
 			<para>
 			The following libraries or applications must be installed 
 			before running &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>none</emphasis></para>
@@ -99,7 +100,7 @@ modparam("auth", "nonce_expire", 600)   # Set nonce_expire to 600s
 		<example>
 		<title>rpid_prefix parameter example</title>
 		<programlisting format="linespecific">
-modparam("auth", "rpid_prefix", "Whatever <")
+modparam("auth", "rpid_prefix", "Whatever &lt;")
 </programlisting>
 		</example>
 	</section>
@@ -201,6 +202,7 @@ modparam("auth", "password_spec", "$avp(s:password)")
 		<para>
 		This parameter tells the server whether it should expect plaintext
 		passwords in the pseudo-variable or a pre-calculated HA1 string.
+		</para>
 		<para>
 		If the parameter is set to 1 then the server will assume that the
 		<quote>password_spec</quote> pseudo-variable contains plaintext passwords
@@ -429,7 +431,7 @@ append_rpid_hf();  # Append Remote-Party-ID header field
 		</title>
 		<para>
 		This function is the same as 
-		<xref linkend="append-rpid-hf-no-params">. The only difference is
+		<xref linkend="append-rpid-hf-no-params"/>. The only difference is
 		that it accepts two parameters--prefix and suffix to be added to 
 		Remote-Party-ID header field. This function ignores rpid_prefix and 
 		rpid_suffix parameters, instead of that allows to set them in every 

modules_k/auth_db/README

@@ -3,23 +3,33 @@ Auth_db Module
 Jan Janak
 
    FhG Fokus
+   <[email protected]>
 
 Jakob Schlyter
 
+   <[email protected]>
+
 Bogdan-Andrei Iancu
 
    voice-system.ro
+   <[email protected]>
 
 Edited by
 
 Jan Janak
 
+   <[email protected]>
+
    Copyright © 2002, 2003 FhG FOKUS
 
    Copyright © 2005 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -44,18 +54,20 @@ Jan Janak
               1.4.1. www_authorize(realm, table)
               1.4.2. proxy_authorize(realm, table)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. db_url parameter usage
-   1-2. user_column parameter usage
-   1-3. domain_column parameter usage
-   1-4. password_column parameter usage
-   1-5. password_column_2 parameter usage
-   1-6. calculate_ha1 parameter usage
-   1-7. use_domain parameter usage
-   1-8. load_credentials parameter usage
-   1-9. www_authorize usage
-   1-10. proxy_authorize usage
-     __________________________________________________________
+
+   1.1. db_url parameter usage
+   1.2. user_column parameter usage
+   1.3. domain_column parameter usage
+   1.4. password_column parameter usage
+   1.5. password_column_2 parameter usage
+   1.6. calculate_ha1 parameter usage
+   1.7. use_domain parameter usage
+   1.8. load_credentials parameter usage
+   1.9. www_authorize usage
+   1.10. proxy_authorize usage
 
 Chapter 1. User's Guide
 
@@ -68,7 +80,6 @@ Chapter 1. User's Guide
    want to use database to store authentication information like
    subscriber usernames and passwords. If you want to use radius
    authentication, then use auth_radius instead.
-     __________________________________________________________
 
 1.2. Dependencies
 
@@ -76,19 +87,15 @@ Chapter 1. User's Guide
 
    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)
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * none
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -104,10 +111,9 @@ Chapter 1. User's Guide
    Default value is
    "mysql://openserro:openserro@localhost/openser".
 
-   Example 1-1. db_url parameter usage
+   Example 1.1. db_url parameter usage
 modparam("auth_db", "db_url", "dbdriver://username:password@dbhost/dbnam
 e")
-     __________________________________________________________
 
 1.3.2. user_column (string)
 
@@ -117,9 +123,8 @@ e")
 
    Default value is "username".
 
-   Example 1-2. user_column parameter usage
+   Example 1.2. user_column parameter usage
 modparam("auth_db", "user_column", "user")
-     __________________________________________________________
 
 1.3.3. domain_column (string)
 
@@ -129,9 +134,8 @@ modparam("auth_db", "user_column", "user")
 
    Default value is "domain".
 
-   Example 1-3. domain_column parameter usage
+   Example 1.3. domain_column parameter usage
 modparam("auth_db", "domain_column", "domain")
-     __________________________________________________________
 
 1.3.4. password_column (string)
 
@@ -144,9 +148,8 @@ modparam("auth_db", "domain_column", "domain")
 
    Default value is "ha1".
 
-   Example 1-4. password_column parameter usage
+   Example 1.4. password_column parameter usage
 modparam("auth_db", "password_column", "password")
-     __________________________________________________________
 
 1.3.5. password_column_2 (string)
 
@@ -158,9 +161,8 @@ modparam("auth_db", "password_column", "password")
 
    Default value of the parameter is ha1b.
 
-   Example 1-5. password_column_2 parameter usage
+   Example 1.5. password_column_2 parameter usage
 modparam("auth_db", "password_column_2", "ha1_2")
-     __________________________________________________________
 
 1.3.6. calculate_ha1 (integer)
 
@@ -191,9 +193,8 @@ modparam("auth_db", "password_column_2", "ha1_2")
 
    Default value of this parameter is 0.
 
-   Example 1-6. calculate_ha1 parameter usage
+   Example 1.6. calculate_ha1 parameter usage
 modparam("auth_db", "calculate_ha1", 1)
-     __________________________________________________________
 
 1.3.7. use_domain (integer)
 
@@ -207,9 +208,8 @@ modparam("auth_db", "calculate_ha1", 1)
 
    Default value is "0 (false)".
 
-   Example 1-7. use_domain parameter usage
+   Example 1.7. use_domain parameter usage
 modparam("auth_db", "use_domain", 1)
-     __________________________________________________________
 
 1.3.8. load_credentials (string)
 
@@ -220,7 +220,6 @@ modparam("auth_db", "use_domain", 1)
    name as the column name.
 
    Parameter syntax:
-
      * load_credentials = credential (';' credential)*
      * credential = (avp_specification '=' column_name) |
        (column_name)
@@ -229,15 +228,14 @@ modparam("auth_db", "use_domain", 1)
 
    Default value of this parameter is "rpid".
 
-   Example 1-8. load_credentials parameter usage
+   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")
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. www_authorize(realm, table)
+1.4.1.  www_authorize(realm, table)
 
    The function verifies credentials according to RFC2617. If the
    credentials are verified successfully then the function will
@@ -248,7 +246,6 @@ modparam("auth_db", "load_credentials", "$avp(i:13)=rpid;email_address")
    which will challenge the user again.
 
    Negative codes may be interpreted as follows:
-
      * -5 (generic error) - some generic error occurred and no
        reply was sent out;
      * -4 (no credentials) - credentials were not found in
@@ -258,7 +255,6 @@ 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
@@ -274,15 +270,14 @@ modparam("auth_db", "load_credentials", "$avp(i:13)=rpid;email_address")
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-9. www_authorize usage
+   Example 1.9. www_authorize usage
 ...
 if (www_authorize("siphub.net", "subscriber")) {
         www_challenge("siphub.net", "1");
 };
 ...
-     __________________________________________________________
 
-1.4.2. proxy_authorize(realm, table)
+1.4.2.  proxy_authorize(realm, table)
 
    The function verifies credentials according to RFC2617. If the
    credentials are verified successfully then the function will
@@ -293,7 +288,6 @@ if (www_authorize("siphub.net", "subscriber")) {
    which will challenge the user again.
 
    Negative codes may be interpreted as follows:
-
      * -5 (generic error) - some generic error occurred and no
        reply was sent out;
      * -4 (no credentials) - credentials were not found in
@@ -303,7 +297,6 @@ 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
@@ -317,9 +310,42 @@ if (www_authorize("siphub.net", "subscriber")) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-10. proxy_authorize usage
+   Example 1.10. proxy_authorize usage
 ...
 if (!proxy_authorize("", "subscriber)) {
         proxy_challenge("", "1");  # Realm will be autogenerated
 };
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/auth_db/doc/auth_db.sgml → modules_k/auth_db/doc/auth_db.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "auth_db_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "auth_db_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -47,8 +49,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/auth_db/doc/auth_db_user.sgml → modules_k/auth_db/doc/auth_db_admin.xml

@@ -42,6 +42,7 @@
 			<para>
 			The following libraries or applications must be installed 
 			before running &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>none</emphasis></para>
@@ -59,13 +60,14 @@
 		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.
+		For dbtext module (which stores data in plaintext files) it is
+		directory in which the database resides.
 		</para>
 		<para>
 		<emphasis>
 			Default value is <quote>&defaultrodb;</quote>.
 		</emphasis>
+		</para>
 		<example>
 		<title><varname>db_url</varname> parameter usage</title>
 		<programlisting format="linespecific">
@@ -154,26 +156,32 @@ modparam("auth_db", "password_column_2", "ha1_2")
 		<para>
 		This parameter tells the server whether it should use plaintext 
 		passwords or a pre-calculated HA1 string for authentification.
+		</para>
 		<para>
-		If the parameter is set to 1 and the username parameter of credentials contains
-		also <quote>@domain</quote> (some user agents append the domain to the username
-		parameter), then the server will use the HA1 values from the column specified in the
-		<quote>password_column_2</quote> parameter. If the username parameter doesn't contain
-		a domain, the server will use the HA1 values from the column given in the
-		<quote>password_column</quote>parameter.
+		If the parameter is set to 1 and the username parameter of credentials
+		contains also <quote>@domain</quote> (some user agents append the
+		domain to the username parameter), then the server will use the HA1
+		values from the column specified in the 
+		<quote>password_column_2</quote> parameter. If the username parameter
+		doesn't contain a domain, the server will use the HA1 values from the
+		column given in the <quote>password_column</quote>parameter.
+		</para>
 		<para>
-		If the parameter is set to 0 then the HA1 value will be calculated from the column
-		specified in the <quote>password_column</quote> parameter.
+		If the parameter is set to 0 then the HA1 value will be calculated
+		from the column specified in the <quote>password_column</quote>
+		parameter.
 		</para>
 		<para>
-		The <quote>password_column_2</quote>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 <quote>password_column_2</quote>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.
 		</para>
 		<para>
-		This ensures that the authentication will always work when using pre-calculated
-		HA1 strings, not depending on the presence of the 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.
 		</para>
 		<para>
 		Default value of this parameter is 0.

modules_k/auth_diameter/README

@@ -9,9 +9,13 @@ Edited by
 Elena-Ramona Modroiu
 
    Copyright © 2003, 2004 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -32,17 +36,19 @@ Elena-Ramona Modroiu
               1.4.2. diameter_proxy_authorize(realm)
               1.4.3. diameter_is_user_in(who, group)
 
-        1.5. Installation & Running
+        1.5. Installation and Running
+
+   2. Frequently Asked Questions
 
    List of Examples
-   1-1. Digest Authentication
-   1-2. Set diameter_client_host parameter
-   1-3. Set diameter_client_port parameter
-   1-4. Set use_domain parameter
-   1-5. diameter_www_authorize usage
-   1-6. diameter_proxy_authorize usage
-   1-7. diameter_is_user_in usage
-     __________________________________________________________
+
+   1.1. Digest Authentication
+   1.2. Set diameter_client_host parameter
+   1.3. Set diameter_client_port parameter
+   1.4. Set use_domain parameter
+   1.5. diameter_www_authorize usage
+   1.6. diameter_proxy_authorize usage
+   1.7. diameter_is_user_in usage
 
 Chapter 1. User's Guide
 
@@ -61,7 +67,7 @@ Chapter 1. User's Guide
    The digest authentication mechanism is presented in next
    figure.
 
-   Example 1-1. Digest Authentication
+   Example 1.1. Digest Authentication
 ...
         a) First phase of Digest Authentication for SIP:
 
@@ -89,24 +95,19 @@ Chapter 1. User's Guide
                                   Result-Code=2001
 
 ...
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * sl - used to send stateless replies.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -116,11 +117,10 @@ Chapter 1. User's Guide
 
    Default value is "localhost".
 
-   Example 1-2. Set diameter_client_host parameter
+   Example 1.2. Set diameter_client_host parameter
 ...
 modparam("auth_diameter", "diameter_client_host", "10.10.10.10")
 ...
-     __________________________________________________________
 
 1.3.2. diameter_client_port (int)
 
@@ -128,11 +128,10 @@ modparam("auth_diameter", "diameter_client_host", "10.10.10.10")
 
    Default value is "3000".
 
-   Example 1-3. Set diameter_client_port parameter
+   Example 1.3. Set diameter_client_port parameter
 ...
 modparam("auth_diameter", "diameter_client_port", 3000)
 ...
-     __________________________________________________________
 
 1.3.3. use_domain (int)
 
@@ -141,15 +140,14 @@ modparam("auth_diameter", "diameter_client_port", 3000)
 
    Default value is "0 (0==false and 1==true )".
 
-   Example 1-4. Set use_domain parameter
+   Example 1.4. Set use_domain parameter
 ...
 modparam("auth_diameter", "use_domain", 1)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. diameter_www_authorize(realm)
+1.4.1.  diameter_www_authorize(realm)
 
    SIP Server checks for authorization having a DIAMETER server in
    backend. If no credentials are provided inside the SIP request
@@ -158,28 +156,25 @@ modparam("auth_diameter", "use_domain", 1)
    back.
 
    Negative codes may be interpreted as follows:
-
      * -5 (generic error) - some generic error occurred and no
        reply was sent out;
      * -3 (stale nonce) - stale nonce;
 
    Meaning of the parameters is as follows:
-
      * realm - the realm to be use for authentication and
        authorization. The string may contain pseudo variables.
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-5. diameter_www_authorize usage
+   Example 1.5. diameter_www_authorize usage
 ...
 if(!diameter_www_authorize("siphub.net"))
 { /* user is not authorized */
         exit;
 };
 ...
-     __________________________________________________________
 
-1.4.2. diameter_proxy_authorize(realm)
+1.4.2.  diameter_proxy_authorize(realm)
 
    SIP Proxy checks for authorization having a DIAMETER server in
    backend. If no credentials are provided inside the SIP request
@@ -189,27 +184,24 @@ if(!diameter_www_authorize("siphub.net"))
    function.
 
    Meaning of the parameters is as follows:
-
      * realm - the realm to be use for authentication and
        authorization. The string may contain pseudo variables.
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-6. diameter_proxy_authorize usage
+   Example 1.6. diameter_proxy_authorize usage
 ...
 if(!diameter_proxy_authorize("siphub.net"))
 { /* user is not authorized */
         exit;
 };
 ...
-     __________________________________________________________
 
-1.4.3. diameter_is_user_in(who, group)
+1.4.3.  diameter_is_user_in(who, group)
 
    The method performs group membership checking with DISC.
 
    Meaning of the parameters is as follows:
-
      * who - what header to be used to get the SIP URI that is
        wanted to be checked being member in a certain group. It
        can be: "Request-URI", "From", "To" or "Credentials".
@@ -218,15 +210,47 @@ if(!diameter_proxy_authorize("siphub.net"))
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-7. diameter_is_user_in usage
+   Example 1.7. diameter_is_user_in usage
 ...
 if(!diameter_is_user_in("From", "voicemail"))
 { /* user is not authorized */
         exit;
 };
 ...
-     __________________________________________________________
 
-1.5. Installation & Running
+1.5. Installation and Running
 
    Notes about installation and running.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/auth_diameter/doc/auth_diameter.sgml → modules_k/auth_diameter/doc/auth_diameter.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "auth_diameter_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "auth_diameter_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -38,8 +40,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/auth_diameter/doc/auth_diameter_user.sgml → modules_k/auth_diameter/doc/auth_diameter_admin.xml

@@ -266,7 +266,7 @@ if(!diameter_is_user_in("From", "voicemail"))
 	</section>
 	</section>
 	<section>
-	<title>Installation & Running</title>
+	<title>Installation and Running</title>
 	<para>Notes about installation and running.</para>
 	</section>
 </chapter>

modules_k/auth_radius/README

@@ -3,27 +3,36 @@ Auth_radius Module
 Jan Janak
 
    FhG Fokus
+   <[email protected]>
 
 Juha Heinanen
 
    Song Networks
+   <[email protected]>
 
 Stelios Sidiroglou-Douskos
 
 Bogdan-Andrei Iancu
 
    voice-system.ro
+   <[email protected]>
 
 Edited by
 
 Jan Janak
 
+   <[email protected]>
+
    Copyright © 2002, 2003 FhG FOKUS
 
    Copyright © 2005 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -44,14 +53,16 @@ Jan Janak
               1.5.1. radius_www_authorize(realm)
               1.5.2. radius_proxy_authorize(realm [, uri_user])
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. "SIP-AVP" RADIUS AVP exmaples
-   1-2. radius_config parameter usage
-   1-3. service_type parameter usage
-   1-4. use_ruri_flag parameter usage
-   1-5. radius_www_authorize usage
-   1-6. proxy_authorize usage
-     __________________________________________________________
+
+   1.1. "SIP-AVP" RADIUS AVP exmaples
+   1.2. radius_config parameter usage
+   1.3. service_type parameter usage
+   1.4. use_ruri_flag parameter usage
+   1.5. radius_www_authorize usage
+   1.6. proxy_authorize usage
 
 Chapter 1. User's Guide
 
@@ -69,7 +80,6 @@ Chapter 1. User's Guide
    draft-sterman-aaa-sip-00. This module requires radiusclient-ng
    library version 0.5.0 or higher which is available from
    http://developer.berlios.de/projects/radiusclient-ng/.
-     __________________________________________________________
 
 1.2. Additional Credentials
 
@@ -80,7 +90,6 @@ Chapter 1. User's Guide
 
    The additional credentials are embedded in the RADIUS reply as
    AVPs "SIP-AVP". The syntax of the value is:
-
      * value = SIP_AVP_NAME SIP_AVP_VALUE
      * SIP_AVP_NAME = STRING_NAME | '#'ID_NUMBER
      * SIP_AVP_VALUE = ':'STRING_VALUE | '#'NUMBER_VALUE
@@ -90,18 +99,17 @@ Chapter 1. User's Guide
 
    The RPID value may be fetch via this mechanism.
 
-   Example 1-1. "SIP-AVP" RADIUS AVP exmaples
+   Example 1.1. "SIP-AVP" RADIUS AVP exmaples
 ....
 "email:[email protected]"
-    -> STRING NAME AVP (email) with STRING VALUE ([email protected])
+    - STRING NAME AVP (email) with STRING VALUE ([email protected])
 "#14:[email protected]"
-    -> ID AVP (14) with STRING VALUE ([email protected])
+    - ID AVP (14) with STRING VALUE ([email protected])
 "age#28"
-    -> STRING NAME AVP (age) with INTEGER VALUE (28)
+    - STRING NAME AVP (age) with INTEGER VALUE (28)
 "#14#28"
-    -> ID AVP (14) with INTEGER VALUE (28)
+    - ID AVP (14) with INTEGER VALUE (28)
 ....
-     __________________________________________________________
 
 1.3. Dependencies
 
@@ -109,19 +117,15 @@ Chapter 1. User's Guide
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * auth -- Generic authentication functions
-     __________________________________________________________
 
 1.3.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before compilling OpenSER with this module loaded:
-
      * radiusclient-ng 0.5.0 or higher -- library and development
        files. See
        http://developer.berlios.de/projects/radiusclient-ng/.
-     __________________________________________________________
 
 1.4. Exported Parameters
 
@@ -133,9 +137,8 @@ Chapter 1. User's Guide
    Default value is
    "/usr/local/etc/radiusclient-ng/radiusclient.conf".
 
-   Example 1-2. radius_config parameter usage
+   Example 1.2. radius_config parameter usage
 modparam("auth_radius", "radius_config", "/etc/radiusclient.conf")
-     __________________________________________________________
 
 1.4.2. service_type (integer)
 
@@ -146,9 +149,8 @@ modparam("auth_radius", "radius_config", "/etc/radiusclient.conf")
 
    Default value is "15".
 
-   Example 1-3. service_type parameter usage
+   Example 1.3. service_type parameter usage
 modparam("auth_radius", "service_type", 15)
-     __________________________________________________________
 
 1.4.3. use_ruri_flag (integer)
 
@@ -164,9 +166,8 @@ modparam("auth_radius", "service_type", 15)
 
    Default value is "-1".
 
-   Example 1-4. use_ruri_flag parameter usage
+   Example 1.4. use_ruri_flag parameter usage
 modparam("auth_radius", "use_ruri_flag", 22)
-     __________________________________________________________
 
 1.5. Exported Functions
 
@@ -181,7 +182,6 @@ modparam("auth_radius", "use_ruri_flag", 22)
    which will challenge the user again.
 
    Negative codes may be interpreted as follows:
-
      * -5 (generic error) - some generic error occurred and no
        reply was sent out;
      * -4 (no credentials) - credentials were not found in
@@ -194,7 +194,6 @@ modparam("auth_radius", "use_ruri_flag", 22)
    they are valid or not.
 
    Meaning of the parameter 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
@@ -208,13 +207,12 @@ modparam("auth_radius", "use_ruri_flag", 22)
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-5. radius_www_authorize usage
+   Example 1.5. radius_www_authorize usage
 ...
 if (!radius_www_authorize("siphub.net")) {
         www_challenge("siphub.net", "1");
 };
 ...
-     __________________________________________________________
 
 1.5.2. radius_proxy_authorize(realm [, uri_user])
 
@@ -233,7 +231,6 @@ if (!radius_www_authorize("siphub.net")) {
    they are valid or not.
 
    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. This is usually one of the domains the
@@ -250,7 +247,7 @@ if (!radius_www_authorize("siphub.net")) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-6. proxy_authorize usage
+   Example 1.6. proxy_authorize usage
 ...
 if (!radius_proxy_authorize("")) {   # Realm and URI user will be autoge
 nerated
@@ -262,3 +259,36 @@ ken
         proxy_challenge("$pd", "1");         # from P-Preferred-Identity
 };                                           # header field
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/auth_radius/doc/auth_radius.sgml → modules_k/auth_radius/doc/auth_radius.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "auth_radius_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "auth_radius_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -52,8 +54,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/auth_radius/doc/auth_radius_user.sgml → modules_k/auth_radius/doc/auth_radius_admin.xml

@@ -56,13 +56,13 @@
 		<programlisting format="linespecific">
 ....
 "email:[email protected]"
-    -> STRING NAME AVP (email) with STRING VALUE ([email protected])
+    - STRING NAME AVP (email) with STRING VALUE ([email protected])
 "#14:[email protected]"
-    -> ID AVP (14) with STRING VALUE ([email protected])
+    - ID AVP (14) with STRING VALUE ([email protected])
 "age#28"
-    -> STRING NAME AVP (age) with INTEGER VALUE (28)
+    - STRING NAME AVP (age) with INTEGER VALUE (28)
 "#14#28"
-    -> ID AVP (14) with INTEGER VALUE (28)
+    - ID AVP (14) with INTEGER VALUE (28)
 ....
 		</programlisting>
 	</example>
@@ -88,6 +88,7 @@
 			<para>
 			The following libraries or applications must be installed 
 			before compilling &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>radiusclient-ng</emphasis> 0.5.0 or higher -- 

modules_k/avp_radius/README

@@ -2,14 +2,22 @@ avp_radius Module
 
 Juha Heinanen
 
+   <[email protected]>
+
 Edited by
 
 Daniel-Constantin Mierla
 
+   <[email protected]>
+
    Copyright © 2004 Juha Heinanen
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -28,13 +36,15 @@ Daniel-Constantin Mierla
 
               1.4.1. avp_load_radius(user)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. "SIP-AVP" RADIUS AVP exmaples
-   1-2. radius_config parameter usage
-   1-3. caller_service_type parameter usage
-   1-4. callee_service_type parameter usage
-   1-5. avp_load_radius() usage
-     __________________________________________________________
+
+   1.1. "SIP-AVP" RADIUS AVP exmaples
+   1.2. radius_config parameter usage
+   1.3. caller_service_type parameter usage
+   1.4. callee_service_type parameter usage
+   1.5. avp_load_radius() usage
 
 Chapter 1. User's Guide
 
@@ -46,12 +56,11 @@ Chapter 1. User's Guide
 
    The module assumes that Radius returns the AVPs as values of
    reply attribute SIP-AVP. Its value must be a string of form:
-
      * value = SIP_AVP_NAME SIP_AVP_VALUE
      * SIP_AVP_NAME = STRING_NAME | '#'ID_NUMBER
      * SIP_AVP_VALUE = ':'STRING_VALUE | '#'NUMBER_VALUE
 
-   Example 1-1. "SIP-AVP" RADIUS AVP exmaples
+   Example 1.1. "SIP-AVP" RADIUS AVP exmaples
 ....
 "email:[email protected]"
     -> STRING NAME AVP (email) with STRING VALUE ([email protected])
@@ -66,7 +75,6 @@ Chapter 1. User's Guide
    For AVP with STRING NAME, the module prefixes each attribute
    name as returned from Radius by string "caller_" or "callee_"
    depending if caller's or callee's attributes are loaded.
-     __________________________________________________________
 
 1.2. Dependencies
 
@@ -74,19 +82,15 @@ Chapter 1. User's Guide
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * none
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before compilling OpenSER with this module loaded:
-
      * radiusclient-ng 0.5.0 or higher -- library and development
        files. See
        http://developer.berlios.de/projects/radiusclient-ng/.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -98,9 +102,8 @@ Chapter 1. User's Guide
    Default value is
    "/usr/local/etc/radiusclient-ng/radiusclient.conf".
 
-   Example 1-2. radius_config parameter usage
+   Example 1.2. radius_config parameter usage
 modparam("avp_radius", "radius_config", "/etc/radiusclient.conf")
-     __________________________________________________________
 
 1.3.2. caller_service_type (integer)
 
@@ -110,9 +113,8 @@ modparam("avp_radius", "radius_config", "/etc/radiusclient.conf")
    Default value is dictionary value of "SIP-Caller-AVPs"
    Service-Type.
 
-   Example 1-3. caller_service_type parameter usage
+   Example 1.3. caller_service_type parameter usage
 modparam("avp_radius", "caller_service_type", 18)
-     __________________________________________________________
 
 1.3.3. callee_service_type (integer)
 
@@ -122,9 +124,8 @@ modparam("avp_radius", "caller_service_type", 18)
    Default value is dictionary value of "SIP-Callee-AVPs"
    Service-Type.
 
-   Example 1-4. callee_service_type parameter usage
+   Example 1.4. callee_service_type parameter usage
 modparam("avp_radius", "callee_service_type", 19)
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -133,7 +134,6 @@ modparam("avp_radius", "callee_service_type", 19)
    The functions loads user's attributes from radius and stores
    them into AVPs. Parameter "user" is used to indicate, whose
    attributes are loaded. Possible values are:
-
      * caller - attributes belong to the user of the From URI are
        loaded
      * callee - attributes belong to the user of the Request URI
@@ -147,7 +147,40 @@ modparam("avp_radius", "callee_service_type", 19)
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-5. avp_load_radius() usage
+   Example 1.5. avp_load_radius() usage
 ...
 avp_load_radius("callee");
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/avp_radius/doc/avp_radius.sgml → modules_k/avp_radius/doc/avp_radius.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "avp_radius_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "avp_radius_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -21,7 +23,7 @@
 		<editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<email>[email protected]</email>
+		<email>[email protected]</email>
 		</editor>
 	</authorgroup>
 	<copyright>
@@ -30,8 +32,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/avp_radius/doc/avp_radius_user.sgml → modules_k/avp_radius/doc/avp_radius_admin.xml

@@ -68,6 +68,7 @@
 			<para>
 			The following libraries or applications must be installed 
 			before compilling &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>radiusclient-ng</emphasis> 0.5.0 or higher -- 

modules_k/avpops/README

@@ -9,9 +9,13 @@ Edited by
 Ramona-Elena Modroiu
 
    Copyright © 2004, 2005 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -53,34 +57,36 @@ Ramona-Elena Modroiu
               1.5.13. is_avp_set(name)
               1.5.14. avp_print()
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. AVP naming examples
-   1-2. Set avp_url parameter
-   1-3. Set avp_table parameter
-   1-4. Set avp_aliases in config file
-   1-5. Set use_domain parameter
-   1-6. Set uuid_column parameter
-   1-7. Set username_column parameter
-   1-8. Set domain_column parameter
-   1-9. Set attribute_column parameter
-   1-10. Set value_column parameter
-   1-11. Set type_column parameter
-   1-12. Set db_scheme parameter
-   1-13. avp_db_load usage
-   1-14. avp_db_store usage
-   1-15. avp_db_delete usage
-   1-16. avp_db_query usage
-   1-17. avp_write migration
-   1-18. avp_delete usage
-   1-19. avp_pushto usage
-   1-20. avp_check usage
-   1-21. avp_copy usage
-   1-22. avp_printf usage
-   1-23. avp_subst usage
-   1-24. avp_op usage
-   1-25. is_avp_set usage
-   1-26. avp_print usage
-     __________________________________________________________
+
+   1.1. AVP naming examples
+   1.2. Set avp_url parameter
+   1.3. Set avp_table parameter
+   1.4. Set avp_aliases in config file
+   1.5. Set use_domain parameter
+   1.6. Set uuid_column parameter
+   1.7. Set username_column parameter
+   1.8. Set domain_column parameter
+   1.9. Set attribute_column parameter
+   1.10. Set value_column parameter
+   1.11. Set type_column parameter
+   1.12. Set db_scheme parameter
+   1.13. avp_db_load usage
+   1.14. avp_db_store usage
+   1.15. avp_db_delete usage
+   1.16. avp_db_query usage
+   1.17. avp_write migration
+   1.18. avp_delete usage
+   1.19. avp_pushto usage
+   1.20. avp_check usage
+   1.21. avp_copy usage
+   1.22. avp_printf usage
+   1.23. avp_subst usage
+   1.24. avp_op usage
+   1.25. is_avp_set usage
+   1.26. avp_print usage
 
 Chapter 1. User's Guide
 
@@ -106,31 +112,25 @@ Chapter 1. User's Guide
    explanations and commented examples) can be found on Voice
    Sistem documentation web page at
    http://voice-system.ro/docs/avpops .
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * Optionally a database module
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None
-     __________________________________________________________
 
 1.3. AVP naming format
 
    The format of the parameters specifying an AVP in functions
    exported by this module is: $avp(avp_flags:avp_name) or
    $avp(avp_alias).
-
      * avp_flags = type_flags [script_flags]; type_flags = 'I' |
        'i' | 'S' | 's'; script_flags = 0..255
        'I' or 'i' means that the type of avp name is integer (ID)
@@ -150,7 +150,7 @@ Chapter 1. User's Guide
        string - might be any alphanumeric string, wich contain
        following characters: [a-z] [A-Z] [0-9] '_'
 
-   Example 1-1. AVP naming examples
+   Example 1.1. AVP naming examples
 ...
 $avp(i:11) - the AVP identified by integer 11
 $avp(s:foo) - the AVP identified by the string 'foo'
@@ -159,7 +159,6 @@ $avp(i3:123) - the AVP identified by the integer 123 which has script fl
 ags 1
     and 2 set
 ...
-     __________________________________________________________
 
 1.4. Exported Parameters
 
@@ -169,16 +168,14 @@ ags 1
 
    This parameter is optional, it's default value being NULL.
 
-   Example 1-2. Set avp_url parameter
+   Example 1.2. Set avp_url parameter
 ...
 modparam("avpops","avp_url","mysql://user:passwd@host/database")
 ...
-     __________________________________________________________
 
 1.4.2. db_url (string)
 
    This parameter has the same meaning as "avp_url" parameter.
-     __________________________________________________________
 
 1.4.3. avp_table (string)
 
@@ -186,11 +183,10 @@ modparam("avpops","avp_url","mysql://user:passwd@host/database")
 
    This parameter is optional, it's default value being NULL.
 
-   Example 1-3. Set avp_table parameter
+   Example 1.3. Set avp_table parameter
 ...
 modparam("avpops","avp_table","avptable")
 ...
-     __________________________________________________________
 
 1.4.4. avp_aliases (string) - removed
 
@@ -198,11 +194,10 @@ modparam("avpops","avp_table","avptable")
    can be defined directly in configuration script, in global
    parameters section.
 
-   Example 1-4. Set avp_aliases in config file
+   Example 1.4. Set avp_aliases in config file
 ...
 avp_aliases="uuid=I:660;email=s:email_addr;fwd=i:753"
 ...
-     __________________________________________________________
 
 1.4.5. use_domain (integer)
 
@@ -211,11 +206,10 @@ avp_aliases="uuid=I:660;email=s:email_addr;fwd=i:753"
 
    Default value is 0 (no).
 
-   Example 1-5. Set use_domain parameter
+   Example 1.5. Set use_domain parameter
 ...
 modparam("avpops","use_domain",1)
 ...
-     __________________________________________________________
 
 1.4.6. uuid_column (string)
 
@@ -223,11 +217,10 @@ modparam("avpops","use_domain",1)
 
    Default value is "uuid".
 
-   Example 1-6. Set uuid_column parameter
+   Example 1.6. Set uuid_column parameter
 ...
 modparam("avpops","uuid_column","uuid")
 ...
-     __________________________________________________________
 
 1.4.7. username_column (string)
 
@@ -235,11 +228,10 @@ modparam("avpops","uuid_column","uuid")
 
    Default value is "username".
 
-   Example 1-7. Set username_column parameter
+   Example 1.7. Set username_column parameter
 ...
 modparam("avpops","username_column","username")
 ...
-     __________________________________________________________
 
 1.4.8. domain_column (string)
 
@@ -247,11 +239,10 @@ modparam("avpops","username_column","username")
 
    Default value is "domain".
 
-   Example 1-8. Set domain_column parameter
+   Example 1.8. Set domain_column parameter
 ...
 modparam("avpops","domain_column","domain")
 ...
-     __________________________________________________________
 
 1.4.9. attribute_column (string)
 
@@ -259,11 +250,10 @@ modparam("avpops","domain_column","domain")
 
    Default value is "attribute".
 
-   Example 1-9. Set attribute_column parameter
+   Example 1.9. Set attribute_column parameter
 ...
 modparam("avpops","attribute_column","attribute")
 ...
-     __________________________________________________________
 
 1.4.10. value_column (string)
 
@@ -271,11 +261,10 @@ modparam("avpops","attribute_column","attribute")
 
    Default value is "value".
 
-   Example 1-10. Set value_column parameter
+   Example 1.10. Set value_column parameter
 ...
 modparam("avpops","value_column","value")
 ...
-     __________________________________________________________
 
 1.4.11. type_column (string)
 
@@ -283,11 +272,10 @@ modparam("avpops","value_column","value")
 
    Default value is "type".
 
-   Example 1-11. Set type_column parameter
+   Example 1.11. Set type_column parameter
 ...
 modparam("avpops","type_column","type")
 ...
-     __________________________________________________________
 
 1.4.12. db_scheme (string)
 
@@ -295,7 +283,6 @@ modparam("avpops","type_column","type")
    Database information.
 
    Definition of a DB scheme. Scheme syntax is:
-
      * db_scheme = name':'element[';'element]*
      * element =
           + 'uuid_col='string
@@ -307,16 +294,15 @@ modparam("avpops","type_column","type")
 
    Default value is "NULL".
 
-   Example 1-12. Set db_scheme parameter
+   Example 1.12. Set db_scheme parameter
 ...
 modparam("avpops","db_scheme",
 "scheme1:table=subscriber;uuid_col=uuid;value_col=first_name")
 ...
-     __________________________________________________________
 
 1.5. Exported Functions
 
-1.5.1. avp_db_load(source,name)
+1.5.1.  avp_db_load(source,name)
 
    Loads from DB into memory the AVPs corresponding to the given
    source. If given, it sets the script flags for loaded AVPs. It
@@ -324,7 +310,6 @@ modparam("avpops","db_scheme",
    (db error, no avp loaded ...).
 
    Meaning of the parameters is as follows:
-
      * source - what info is used for identifying the AVPs.
        Parameter syntax:
           + source = (pvar|str_value)
@@ -347,16 +332,15 @@ modparam("avpops","db_scheme",
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-13. avp_db_load usage
+   Example 1.13. avp_db_load usage
 ...
 avp_db_load("$fu","$(i:678)");
 avp_db_load("$ru/domain","i:/domain_preferences");
 avp_db_load("$uuid","$avp(s:404fwd)/fwd_table");
 avp_db_load("$ru","$avp(i1:123)/$some_scheme");
 ...
-     __________________________________________________________
 
-1.5.2. avp_db_store(source,name)
+1.5.2.  avp_db_store(source,name)
 
    Stores to DB the AVPs corresponding to the given source.
 
@@ -367,14 +351,13 @@ avp_db_load("$ru","$avp(i1:123)/$some_scheme");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-14. avp_db_store usage
+   Example 1.14. avp_db_store usage
 ...
 avp_db_store("$tu","$avp(i:678)");
 avp_db_store("$ru/username","$avp(email)");
 ...
-     __________________________________________________________
 
-1.5.3. avp_db_delete(source,name)
+1.5.3.  avp_db_delete(source,name)
 
    Deletes from DB the AVPs corresponding to the given source.
 
@@ -385,20 +368,18 @@ avp_db_store("$ru/username","$avp(email)");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-15. avp_db_delete usage
+   Example 1.15. avp_db_delete usage
 ...
 avp_db_delete("$tu","$avp(i:678)");
 avp_db_delete("$ru/username","$avp(email)");
 avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
 ...
-     __________________________________________________________
 
-1.5.4. avp_db_query(query[,dest])
+1.5.4.  avp_db_query(query[,dest])
 
    Make a database query and store the result in AVPs.
 
    The meaning and usage of the parameters:
-
      * query - must be a valid SQL query. The parameter can
        contain pseudo-variables.
        You must escape any pseudo-variables manually to prevent
@@ -419,22 +400,21 @@ avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-16. avp_db_query usage
+   Example 1.16. avp_db_query usage
 ...
 avp_db_query("select password, ha1 from subscriber where username='$tu'"
 ,
         "$avp(i:678);$avp(i:679)");
 avp_db_query("delete from subscriber");
 ...
-     __________________________________________________________
 
-1.5.5. avp_write(value,name) - removed
+1.5.5.  avp_write(value,name) - removed
 
    The function has been removed from 'avpops' module. Same
    functionality can be achived directly in configuration script
-   via assignment operator.
+   via assignement operator.
 
-   Example 1-17. avp_write migration
+   Example 1.17. avp_write migration
 ...
 avp_write("$tu","$avp(i:678)");           => $avp(i:678) = $tu;
 avp_write("$ru/username","$avp(email)");  => $avp(email) = $rU;
@@ -444,14 +424,12 @@ avp_write("$hdr(call-id)","$avp(i:11)");  => $avp(i:11) = $hdr(call-id);
 avp_write("i:333","$avp(i:6)");           => $avp(i:6) = 333;
 avp_write("s:abc","$avp(i:7)");           => $avp(i:7) = "abc";
 ...
-     __________________________________________________________
 
-1.5.6. avp_delete(name)
+1.5.6.  avp_delete(name)
 
    Deletes from memory the AVPs with name or, if empty, all AVPs.
 
    Meaning of the parameters is as follows:
-
      * name - which AVPs will be deleted from memory. Parameter
        syntax is:
           + name = (matching_flags|avp_name|avp_alias)['/'flag]
@@ -462,21 +440,19 @@ avp_write("s:abc","$avp(i:7)");           => $avp(i:7) = "abc";
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-18. avp_delete usage
+   Example 1.18. avp_delete usage
 ...
 avp_delete("$avp(i:678)/g");
 avp_delete("$avp(email)");
 avp_delete("i");
 avp_delete("a3");
 ...
-     __________________________________________________________
 
-1.5.7. avp_pushto(destination,name)
+1.5.7.  avp_pushto(destination,name)
 
    Pushes the value of AVP(s) into the SIP message.
 
    Meaning of the parameters is as follows:
-
      * destination - as what will be the AVP value pushed into SIP
        message. Parameter syntax:
           + destination = '$ru' ['/'('username'|'domain')] | '$du'
@@ -494,7 +470,7 @@ avp_delete("a3");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-19. avp_pushto usage
+   Example 1.19. avp_pushto usage
 ...
 avp_pushto("$ru/domain","$fd");
 avp_pushto("$ru","$avp(i:678)");
@@ -502,14 +478,12 @@ avp_pushto("$ru/domain","$avp(s:backup_domains)/g");
 avp_pushto("$du","$avp(i:679)");
 avp_pushto("$br","$avp(i:680)");
 ...
-     __________________________________________________________
 
-1.5.8. avp_check(name,op_value)
+1.5.8.  avp_check(name,op_value)
 
    Checks the value of the AVP(s) against an operator and value.
 
    Meaning of the parameters is as follows:
-
      * name - which AVP(s) should be checked. Parameter syntax is:
           + name = ( pseudo-variable )
      * op_value - define the operator, the value and flags for
@@ -538,7 +512,7 @@ avp_pushto("$br","$avp(i:680)");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-20. avp_check usage
+   Example 1.20. avp_check usage
 ...
 avp_check("$avp(i:678)", "lt/i:345/g");
 avp_check("$fd","eq/$td/I");
@@ -546,14 +520,12 @@ avp_check("$avp(s:foo)","gt/$avp($bar)/g");
 avp_check("$avp(s:foo)","re/sip:.*@bar.net/g");
 avp_check("$avp(s:foo)","fm/$avp(fm_avp)/g");
 ...
-     __________________________________________________________
 
-1.5.9. avp_copy(old_name,new_name)
+1.5.9.  avp_copy(old_name,new_name)
 
    Copy / move an avp under a new name.
 
    Meaning of the parameters is as follows:
-
      * name1 - which AVP(s) should be copied/moved. Parameter
        syntax is:
           + name = ( avp_name | avp_alias )
@@ -565,14 +537,13 @@ avp_check("$avp(s:foo)","fm/$avp(fm_avp)/g");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-21. avp_copy usage
+   Example 1.21. avp_copy usage
 ...
 avp_copy("$avp(i:678)", "$avp(s:345)/g");
 avp_copy("$avp(old)","$avp(new)/gd");
 ...
-     __________________________________________________________
 
-1.5.10. avp_printf(dest, format)
+1.5.10.  avp_printf(dest, format)
 
    NOTE: since OpenSER 1.3.0 the function has been moved to core
    and it is an alias to pv_printf().
@@ -583,7 +554,6 @@ avp_copy("$avp(old)","$avp(new)/gd");
    found at: http://openser.org/dokuwiki/.
 
    Meaning of the parameters is as follows:
-
      * dest - in which AVP should be stored the result. Parameter
        syntax is:
           + name = ( avp_name | avp_alias )
@@ -592,19 +562,17 @@ avp_copy("$avp(old)","$avp(new)/gd");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-22. avp_printf usage
+   Example 1.22. avp_printf usage
 ...
 avp_printf("$avp(i:20)", "This is a $rm request with call-id $hdr(call-i
 d)");
 ...
-     __________________________________________________________
 
-1.5.11. avp_subst(avps, subst)
+1.5.11.  avp_subst(avps, subst)
 
    Perl/sed-like subst applied to AVPs having string value.
 
    Meaning of the parameters is as follows:
-
      * avps - source AVP, destination AVP and flags. Parameter
        syntax is:
           + avps = src_avp [ '/' dst_avp [ '/' flags ] ]
@@ -626,7 +594,7 @@ d)");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-23. avp_subst usage
+   Example 1.23. avp_subst usage
 ...
 # if avp i:678 has a string value in e-mail format, replace the
 # domain part with the value of domain part from R-URI
@@ -643,14 +611,12 @@ avp_subst("$avp(i:678)/$avp(i:679)/g", "/(.*)@(.*)/\1@$rd/");
    you have many src_avp and you make the substitution to be
    applied to all of them, after the first src_avp is processed,
    it will be added in avp list and next processing will use it.
-     __________________________________________________________
 
-1.5.12. avp_op(name,op_value)
+1.5.12.  avp_op(name,op_value)
 
    Different integer operations with avps.
 
    Meaning of the parameters is as follows:
-
      * name - 'source_avp/destination_avp' - which AVP(s) should
        be processed and where to store the result. If
        'destination_avp' is missing, same name as 'source_avp' is
@@ -673,19 +639,17 @@ avp_subst("$avp(i:678)/$avp(i:679)/g", "/(.*)@(.*)/\1@$rd/");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-24. avp_op usage
+   Example 1.24. avp_op usage
 ...
 avp_op("$avp(i:678)", "add/i:345/g");
 avp_op("$avp(number)","sub/$avp(number2)/d");
 ...
-     __________________________________________________________
 
-1.5.13. is_avp_set(name)
+1.5.13.  is_avp_set(name)
 
    Check if any AVP with name is set.
 
    Meaning of the parameters is as follows:
-
      * name - name of AVP to look for. Parameter syntax is:
           + name = avp_name|avp_alias [ '/' flags ])
             flags = ('e'|'s'|'n') - e = empty value; s = value
@@ -694,14 +658,13 @@ avp_op("$avp(number)","sub/$avp(number2)/d");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-25. is_avp_set usage
+   Example 1.25. is_avp_set usage
 ...
 if(is_avp_set("$avp(i:678)"))
     log("AVP with integer id 678 exists\n");
 ...
-     __________________________________________________________
 
-1.5.14. avp_print()
+1.5.14.  avp_print()
 
    Prints the list with all the AVPs from memory. This is only a
    helper/debug function.
@@ -709,7 +672,40 @@ if(is_avp_set("$avp(i:678)"))
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
 
-   Example 1-26. avp_print usage
+   Example 1.26. avp_print usage
 ...
 avp_print();
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/avpops/doc/avpops.sgml → modules_k/avpops/doc/avpops.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "avpops_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "avpops_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -38,8 +40,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-			<revnumber>$Revision$</revnumber>
-			<date>$Date$</date>
+			<revnumber>$Revision: 3839 $</revnumber>
+			<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/avpops/doc/avpops_user.sgml → modules_k/avpops/doc/avpops_admin.xml

@@ -304,6 +304,7 @@ modparam("avpops","value_column","value")
 			<title><varname>type_column</varname> (string)</title>
 			<para>
 				Name of column containing the AVP type.
+			</para>
 			<para>
 				<emphasis>Default value is <quote>type</quote>.
 				</emphasis>
@@ -470,6 +471,7 @@ avp_db_store("$ru/username","$avp(email)");
 			<para>
 			Deletes from DB the AVPs corresponding to the given
 			<emphasis>source</emphasis>.
+			</para>
 			<para>The meaning and usage of the parameters are identical as for
 			<emphasis>avp_db_load(source,name)</emphasis>
 			function. Please refer to its description.
@@ -522,6 +524,7 @@ avp_db_delete("$uuid","$avp(s:404fwd)/fwd_table");
 				many rows, then multiple AVPs with corresponding name will
 				be added. The value type of the AVP (string or integer) will
 				be derived from the type of the columns.
+				</para>
 			</listitem>
 			</itemizedlist>
 			<para>
@@ -546,7 +549,7 @@ avp_db_query("delete from subscriber");
 			<para>
 			The function has been removed from 'avpops' module. Same
 			functionality can be achived directly in configuration script
-			via assignment operator.
+			via assignement operator.
 			</para>
 			<example>
 				<title><function>avp_write</function> migration</title>

modules_k/benchmark/README

@@ -6,8 +6,6 @@ Bastian Friedrich
 
 Daniel-Constantin Mierla
 
-   Voice System SRL
-
 Edited by
 
 Bastian Friedrich
@@ -15,9 +13,13 @@ Bastian Friedrich
    Copyright © 2007 Collax GmbH
 
    Copyright © 2007 Voice System SRL
+   Revision History
+   Revision $Revision: 1.1.1.1 $ $Date: 2007-04-11 14:40:39 +0200
+                                 (Mi, 11 Apr 2007) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -53,18 +55,21 @@ Bastian Friedrich
               2.1.1. bm_register(name, mode, id)
               2.1.2. bm_start(id)
               2.1.3. bm_log(id)
-              2.1.4. Benchmark API Example
+
+        2.2. Benchmark API Example
+
+   3. Frequently Asked Questions
 
    List of Examples
-   1-1. Set enable parameter
-   1-2. Set granularity parameter
-   1-3. Set loglevel parameter
-   1-4. bm_start_timer usage
-   1-5. bm_log_timer usage
-   1-6. Enabling a timer
-   1-7. benchmark usage
-   2-1. Using the benchmark module's API from another module
-     __________________________________________________________
+
+   1.1. Set enable parameter
+   1.2. Set granularity parameter
+   1.3. Set loglevel parameter
+   1.4. bm_start_timer usage
+   1.5. bm_log_timer usage
+   1.6. Enabling a timer
+   1.7. benchmark usage
+   2.1. Using the benchmark module's API from another module
 
 Chapter 1. User's Guide
 
@@ -79,24 +84,19 @@ Chapter 1. User's Guide
    stored and logged via OpenSER's logging facility. Please note
    that all durations are given as microseconds (don't confuse
    with milliseconds!).
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -104,7 +104,6 @@ Chapter 1. User's Guide
 
    Even when the module is loaded, benchmarking is not enabled per
    default. This variable may have three different values:
-
      * -1 - Globally disable benchmarking
      * 0 - Enable per-timer enabling. Single timers are inactive
        by default and can be activated through the MI interface as
@@ -113,11 +112,10 @@ Chapter 1. User's Guide
 
    Default value is "0".
 
-   Example 1-1. Set enable parameter
+   Example 1.1. Set enable parameter
 ...
 modparam("benchmark", "enable", 1)
 ...
-     __________________________________________________________
 
 1.3.2. granularity (int)
 
@@ -127,17 +125,15 @@ modparam("benchmark", "enable", 1)
 
    Default value is "100".
 
-   Example 1-2. Set granularity parameter
+   Example 1.2. Set granularity parameter
 ...
 modparam("benchmark", "granularity", 500)
 ...
-     __________________________________________________________
 
 1.3.3. loglevel (int)
 
    Set the log level for the benchmark logs. These levels should
    be used:
-
      * -3 - L_ALERT
      * -2 - L_CRIT
      * -1 - L_ERR
@@ -148,32 +144,29 @@ modparam("benchmark", "granularity", 500)
 
    Default value is "3" (L_INFO).
 
-   Example 1-3. Set loglevel parameter
+   Example 1.3. Set loglevel parameter
 ...
 modparam("benchmark", "loglevel", 4)
 ...
 
    This will set the logging level to L_DBG.
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. bm_start_timer(name)
+1.4.1.  bm_start_timer(name)
 
    Start timer "name". A later call to "bm_log_timer()" logs this
    timer..
 
-   Example 1-4. bm_start_timer usage
+   Example 1.4. bm_start_timer usage
 ...
 bm_start_timer("test");
 ...
-     __________________________________________________________
 
-1.4.2. bm_log_timer(name)
+1.4.2.  bm_log_timer(name)
 
    This function logs the timer with the given ID. The following
    data are logged:
-
      * Last msgs is the number of calls in the last logging
        interval. This equals the granularity variable.
 
@@ -198,11 +191,10 @@ bm_start_timer("test");
 
      * Global avg possibly the most interesting value.
 
-   Example 1-5. bm_log_timer usage
+   Example 1.5. bm_log_timer usage
 ...
 bm_log_timer("test");
 ...
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
@@ -210,41 +202,36 @@ bm_log_timer("test");
 
    Enables/disables the module. Parameter may be -1, 0 or 1. See
    discription of "enable" parameter.
-     __________________________________________________________
 
 1.5.2. bm_enable_timer
 
    Enable or disable a single timer. The following example enables
    timer "test" (the second parameter must be 0 to disable):
 
-   Example 1-6. Enabling a timer
+   Example 1.6. Enabling a timer
 ...
 openserctl fifo bm_enable_timer test 1
 ...
-     __________________________________________________________
 
 1.5.3. bm_granularity
 
    Modifies the benchmarking granularity. See "granularity"
    variable.
-     __________________________________________________________
 
 1.5.4. bm_loglevel
 
    Modifies the module log level. See "loglevel" variable.
-     __________________________________________________________
 
 1.6. Example of usage
 
    Measure the duration of user location lookup.
 
-   Example 1-7. benchmark usage
+   Example 1.7. benchmark usage
 ...
 bm_start_timer("usrloc-lookup");
 lookup("location");
 bm_log_timer("usrloc-lookup");
 ...
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
@@ -254,33 +241,29 @@ Chapter 2. Developer's Guide
 
    Please note that this module is intended mainly for developers.
    It should be used with caution in production environments.
-     __________________________________________________________
 
 2.1. Available Functions
 
-2.1.1. bm_register(name, mode, id)
+2.1.1.  bm_register(name, mode, id)
 
    This function register a new timer and/or returns the internal
    ID associated with the timer. mode controls the creation of new
    timer if not found. id is to be used by start and log timer
    functions.
-     __________________________________________________________
 
-2.1.2. bm_start(id)
+2.1.2.  bm_start(id)
 
    This function equals the user-exported function bm_start_timer.
    The id is passed as an integer, though.
-     __________________________________________________________
 
-2.1.3. bm_log(id)
+2.1.3.  bm_log(id)
 
    This function equals the user-exported function bm_log_timer.
    The id is passed as an integer, though.
-     __________________________________________________________
 
-2.1.4. Benchmark API Example
+2.2. Benchmark API Example
 
-   Example 2-1. Using the benchmark module's API from another
+   Example 2.1. Using the benchmark module's API from another
    module
 ...
 #include "../benchmark/benchmark.h"
@@ -301,3 +284,36 @@ bmb.bm_start(id);
 do_something();
 bmb.bm_log(id);
 ...
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/benchmark/doc/benchmark.sgml → modules_k/benchmark/doc/benchmark.xml

@@ -1,12 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "benchmark_user.sgml">
-<!ENTITY devel SYSTEM "benchmark_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "benchmark_admin.xml">
+<!ENTITY devel SYSTEM "benchmark_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -27,9 +29,8 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<affiliation><orgname>Voice System SRL</orgname></affiliation>
 		<address>
-		    <email>[email protected]</email>
+		    <email>[email protected]</email>
 		</address>
 	    </author>
 	    <editor>

modules_k/benchmark/doc/benchmark_user.sgml → modules_k/benchmark/doc/benchmark_admin.xml

@@ -15,6 +15,7 @@
 		The duration between calls to start_timer and log_timer is stored and logged
 		via &ser;'s logging facility. Please note that all durations are given as
 		microseconds (don't confuse with milliseconds!).
+	</para>
 	</section>
 	<section>
 	<title>Dependencies</title>

modules_k/benchmark/doc/benchmark_devel.sgml → modules_k/benchmark/doc/benchmark_devel.xml

@@ -28,7 +28,7 @@
 		</para>
 	</section>
 
-<section>
+	<section>
 		<title>
 		<function moreinfo="none">bm_start(id)</function>
 		</title>
@@ -47,6 +47,7 @@
 		is passed as an integer, though.
 		</para>
 	</section>
+	</section>
 
 
 	<section>

modules_k/carrierroute/README

@@ -13,9 +13,13 @@ Henning Westerholt
    1&1 Internet AG
 
    Copyright © 2007 1&1 Internet AG
+   Revision History
+   Revision $Revision: 3794 $ $Date: 2008-02-28 19:22:36 +0200
+                              (Thu, 28 Feb 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -87,64 +91,66 @@ Henning Westerholt
               1.5.7. cr_delete_host
 
         1.6. Examples
-        1.7. Installation & Running
+        1.7. Installation and Running
 
               1.7.1. Database setup
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set db_url parameter
-   1-2. Set db_table parameter
-   1-3. Set id_column parameter
-   1-4. Set carrier_column parameter
-   1-5. Set scan_prefix_column parameter
-   1-6. Set domain_column parameter
-   1-7. Set prob_column parameter
-   1-8. Set rewrite_host_column parameter
-   1-9. Set strip_column parameter
-   1-10. Set comment_column parameter
-   1-11. Set carrier_table parameter
-   1-12. Set rewrite_prefix_column parameter
-   1-13. Set rewrite_suffix_column parameter
-   1-14. Set id_col parameter
-   1-15. Set carrier_name_col parameter
-   1-16. Set subscriber_table parameter
-   1-17. Set subscriber_user_col parameter
-   1-18. Set subscriber_domain_col parameter
-   1-19. Set subscriber_carrier_col parameter
-   1-20. Set config_source parameter
-   1-21. Set config_file parameter
-   1-22. Set default_tree parameter
-   1-23. Set use_domain parameter
-   1-24. Set fallback_default parameter
-   1-25. Set db_failuretable parameter
-   1-26. Set failure_id_column parameter
-   1-27. Set failure_carrier_column parameter
-   1-28. Set failure_scan_prefix_column parameter
-   1-29. Set failure_domain_column parameter
-   1-30. Set failure_host_name_column parameter
-   1-31. Set failure_reply_code_column parameter
-   1-32. Set failure_flags_column parameter
-   1-33. Set failure_mask_column parameter
-   1-34. Set failure_next_domain_column parameter
-   1-35. Set failure_comment_column parameter
-   1-36. cr_replace_host usage
-   1-37. cr_deactivate_host usage
-   1-38. cr_activate_host usage
-   1-39. cr_add_host usage
-   1-40. cr_delete_host usage
-   1-41. Configuration example - Routing to default tree
-   1-42. Configuration example - Routing to user tree
-   1-43. Configuration example - module configuration
-   1-44. Example database content - carrierroute table
-   1-45. Example database content - simple carrierfailureroute
+
+   1.1. Set db_url parameter
+   1.2. Set db_table parameter
+   1.3. Set id_column parameter
+   1.4. Set carrier_column parameter
+   1.5. Set scan_prefix_column parameter
+   1.6. Set domain_column parameter
+   1.7. Set prob_column parameter
+   1.8. Set rewrite_host_column parameter
+   1.9. Set strip_column parameter
+   1.10. Set comment_column parameter
+   1.11. Set carrier_table parameter
+   1.12. Set rewrite_prefix_column parameter
+   1.13. Set rewrite_suffix_column parameter
+   1.14. Set id_col parameter
+   1.15. Set carrier_name_col parameter
+   1.16. Set subscriber_table parameter
+   1.17. Set subscriber_user_col parameter
+   1.18. Set subscriber_domain_col parameter
+   1.19. Set subscriber_carrier_col parameter
+   1.20. Set config_source parameter
+   1.21. Set config_file parameter
+   1.22. Set default_tree parameter
+   1.23. Set use_domain parameter
+   1.24. Set fallback_default parameter
+   1.25. Set db_failuretable parameter
+   1.26. Set failure_id_column parameter
+   1.27. Set failure_carrier_column parameter
+   1.28. Set failure_scan_prefix_column parameter
+   1.29. Set failure_domain_column parameter
+   1.30. Set failure_host_name_column parameter
+   1.31. Set failure_reply_code_column parameter
+   1.32. Set failure_flags_column parameter
+   1.33. Set failure_mask_column parameter
+   1.34. Set failure_next_domain_column parameter
+   1.35. Set failure_comment_column parameter
+   1.36. cr_replace_host usage
+   1.37. cr_deactivate_host usage
+   1.38. cr_activate_host usage
+   1.39. cr_add_host usage
+   1.40. cr_delete_host usage
+   1.41. Configuration example - Routing to default tree
+   1.42. Configuration example - Routing to user tree
+   1.43. Configuration example - module configuration
+   1.44. Example database content - carrierroute table
+   1.45. Example database content - simple carrierfailureroute
           table
 
-   1-46. Example database content - more complex
+   1.46. Example database content - more complex
           carrierfailureroute table
 
-   1-47. Example database content - route_tree table
-   1-48. Necessary extensions for the user table
-     __________________________________________________________
+   1.47. Example database content - route_tree table
+   1.48. Necessary extensions for the user table
 
 Chapter 1. User's Guide
 
@@ -200,14 +206,12 @@ Chapter 1. User's Guide
    order to relay the message to the new target. Its also
    supportes the usage of database derived failure routing
    descisions with the carrierfailureroute table.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following module must be loaded before this module:
-
      * a database module, when a database is used as configuration
        data source. Only SQL based databases are supported, as
        this module needs the capability to issue raw queries. Its
@@ -215,15 +219,12 @@ Chapter 1. User's Guide
        moment.
      * The tm module, when you want to use the $T_reply_code
        pseudo-variable in the "cr_next_domain" function.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * libconfuse, a configuration file parser library.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -234,12 +235,11 @@ Chapter 1. User's Guide
    Default value is
    "mysql://openserro:openserro@localhost/openser".
 
-   Example 1-1. Set db_url parameter
+   Example 1.1. Set db_url parameter
 ...
 modparam("carrierroute", "db_url", "dbdriver://username:password@dbhost/
 dbname")
 ...
-     __________________________________________________________
 
 1.3.2. db_table (string)
 
@@ -247,11 +247,10 @@ dbname")
 
    Default value is "carrierroute".
 
-   Example 1-2. Set db_table parameter
+   Example 1.2. Set db_table parameter
 ...
 modparam("carrierroute", "db_table", "carrierroute")
 ...
-     __________________________________________________________
 
 1.3.3. id_column (string)
 
@@ -259,11 +258,10 @@ modparam("carrierroute", "db_table", "carrierroute")
 
    Default value is "id".
 
-   Example 1-3. Set id_column parameter
+   Example 1.3. Set id_column parameter
 ...
 modparam("carrierroute", "id_column", "id")
 ...
-     __________________________________________________________
 
 1.3.4. carrier_column (string)
 
@@ -271,11 +269,10 @@ modparam("carrierroute", "id_column", "id")
 
    Default value is "carrier".
 
-   Example 1-4. Set carrier_column parameter
+   Example 1.4. Set carrier_column parameter
 ...
 modparam("carrierroute", "carrier_column", "carrier")
 ...
-     __________________________________________________________
 
 1.3.5. scan_prefix_column (string)
 
@@ -288,11 +285,10 @@ modparam("carrierroute", "carrier_column", "carrier")
 
    Default value is "scan_prefix".
 
-   Example 1-5. Set scan_prefix_column parameter
+   Example 1.5. Set scan_prefix_column parameter
 ...
 modparam("carrierroute", "scan_prefix_column", "scan_prefix")
 ...
-     __________________________________________________________
 
 1.3.6. domain_column (string)
 
@@ -303,11 +299,10 @@ modparam("carrierroute", "scan_prefix_column", "scan_prefix")
 
    Default value is "domain".
 
-   Example 1-6. Set domain_column parameter
+   Example 1.6. Set domain_column parameter
 ...
 modparam("carrierroute", "domain_column", "domain")
 ...
-     __________________________________________________________
 
 1.3.7. prob_column (string)
 
@@ -327,11 +322,10 @@ modparam("carrierroute", "domain_column", "domain")
 
    Default value is "prob".
 
-   Example 1-7. Set prob_column parameter
+   Example 1.7. Set prob_column parameter
 ...
 modparam("carrierroute", "prob_column", "prob")
 ...
-     __________________________________________________________
 
 1.3.8. rewrite_host_column (string)
 
@@ -341,11 +335,10 @@ modparam("carrierroute", "prob_column", "prob")
 
    Default value is "rewrite_host".
 
-   Example 1-8. Set rewrite_host_column parameter
+   Example 1.8. Set rewrite_host_column parameter
 ...
 modparam("carrierroute", "rewrite_host_column", "rewrite_host")
 ...
-     __________________________________________________________
 
 1.3.9. strip_column (string)
 
@@ -355,11 +348,10 @@ modparam("carrierroute", "rewrite_host_column", "rewrite_host")
 
    Default value is "strip".
 
-   Example 1-9. Set strip_column parameter
+   Example 1.9. Set strip_column parameter
 ...
 modparam("carrierroute", "strip_column", "strip")
 ...
-     __________________________________________________________
 
 1.3.10. comment_column (string)
 
@@ -369,11 +361,10 @@ modparam("carrierroute", "strip_column", "strip")
 
    Default value is "comment".
 
-   Example 1-10. Set comment_column parameter
+   Example 1.10. Set comment_column parameter
 ...
 modparam("carrierroute", "comment_column", "comment")
 ...
-     __________________________________________________________
 
 1.3.11. carrier_table (string)
 
@@ -382,11 +373,10 @@ modparam("carrierroute", "comment_column", "comment")
 
    Default value is "route_tree".
 
-   Example 1-11. Set carrier_table parameter
+   Example 1.11. Set carrier_table parameter
 ...
 modparam("carrierroute", "carrier_table", "route_tree")
 ...
-     __________________________________________________________
 
 1.3.12. rewrite_prefix_column (string)
 
@@ -395,11 +385,10 @@ modparam("carrierroute", "carrier_table", "route_tree")
 
    Default value is "rewrite_prefix".
 
-   Example 1-12. Set rewrite_prefix_column parameter
+   Example 1.12. Set rewrite_prefix_column parameter
 ...
 modparam("carrierroute", "rewrite_prefix_column", "rewrite_prefix")
 ...
-     __________________________________________________________
 
 1.3.13. rewrite_suffix_column (string)
 
@@ -408,12 +397,11 @@ modparam("carrierroute", "rewrite_prefix_column", "rewrite_prefix")
 
    Default value is "rewrite_suffix".
 
-   Example 1-13. Set rewrite_suffix_column parameter
+   Example 1.13. Set rewrite_suffix_column parameter
                             ...
                             modparam("carrierroute", "rewrite_suffix_col
 umn", "rewrite_suffix")
                             ...
-     __________________________________________________________
 
 1.3.14. carrier_id_col (string)
 
@@ -422,11 +410,10 @@ umn", "rewrite_suffix")
 
    Default value is "id".
 
-   Example 1-14. Set id_col parameter
+   Example 1.14. Set id_col parameter
 ...
 modparam("carrierroute", "carrier_id_col", "id")
 ...
-     __________________________________________________________
 
 1.3.15. carrier_name_col (string)
 
@@ -435,11 +422,10 @@ modparam("carrierroute", "carrier_id_col", "id")
 
    Default value is "carrier".
 
-   Example 1-15. Set carrier_name_col parameter
+   Example 1.15. Set carrier_name_col parameter
 ...
 modparam("carrierroute", "carrier_name_col", "carrier")
 ...
-     __________________________________________________________
 
 1.3.16. subscriber_table (string)
 
@@ -447,11 +433,10 @@ modparam("carrierroute", "carrier_name_col", "carrier")
 
    Default value is "subscriber".
 
-   Example 1-16. Set subscriber_table parameter
+   Example 1.16. Set subscriber_table parameter
 ...
 modparam("carrierroute", "subscriber_table", "subscriber")
 ...
-     __________________________________________________________
 
 1.3.17. subscriber_user_col (string)
 
@@ -460,11 +445,10 @@ modparam("carrierroute", "subscriber_table", "subscriber")
 
    Default value is "username".
 
-   Example 1-17. Set subscriber_user_col parameter
+   Example 1.17. Set subscriber_user_col parameter
 ...
 modparam("carrierroute", "subscriber_user_col", "username")
 ...
-     __________________________________________________________
 
 1.3.18. subscriber_domain_col (string)
 
@@ -473,11 +457,10 @@ modparam("carrierroute", "subscriber_user_col", "username")
 
    Default value is "domain".
 
-   Example 1-18. Set subscriber_domain_col parameter
+   Example 1.18. Set subscriber_domain_col parameter
 ...
 modparam("carrierroute", "subscriber_domain_col", "domain")
 ...
-     __________________________________________________________
 
 1.3.19. subscriber_carrier_col (string)
 
@@ -486,12 +469,11 @@ modparam("carrierroute", "subscriber_domain_col", "domain")
 
    Default value is "cr_preferred_carrier".
 
-   Example 1-19. Set subscriber_carrier_col parameter
+   Example 1.19. Set subscriber_carrier_col parameter
 ...
 modparam("carrierroute", "subscriber_carrier_col", "cr_preferred_carrier
 ")
 ...
-     __________________________________________________________
 
 1.3.20. config_source (string)
 
@@ -500,11 +482,10 @@ modparam("carrierroute", "subscriber_carrier_col", "cr_preferred_carrier
 
    Default value is "file".
 
-   Example 1-20. Set config_source parameter
+   Example 1.20. Set config_source parameter
 ...
 modparam("carrierroute", "config_source", "file")
 ...
-     __________________________________________________________
 
 1.3.21. config_file (string)
 
@@ -512,12 +493,11 @@ modparam("carrierroute", "config_source", "file")
 
    Default value is "/etc/openser/carrierroute.conf".
 
-   Example 1-21. Set config_file parameter
+   Example 1.21. Set config_file parameter
 ...
 modparam("carrierroute", "config_file", "/etc/openser/carrierroute.conf"
 )
 ...
-     __________________________________________________________
 
 1.3.22. default_tree (string)
 
@@ -526,11 +506,10 @@ modparam("carrierroute", "config_file", "/etc/openser/carrierroute.conf"
 
    Default value is "default".
 
-   Example 1-22. Set default_tree parameter
+   Example 1.22. Set default_tree parameter
 ...
 modparam("carrierroute", "default_tree", "default")
 ...
-     __________________________________________________________
 
 1.3.23. use_domain (int)
 
@@ -539,11 +518,10 @@ modparam("carrierroute", "default_tree", "default")
 
    Default value is "0".
 
-   Example 1-23. Set use_domain parameter
+   Example 1.23. Set use_domain parameter
 ...
 modparam("carrierroute", "use_domain", 0)
 ...
-     __________________________________________________________
 
 1.3.24. fallback_default (int)
 
@@ -554,11 +532,10 @@ modparam("carrierroute", "use_domain", 0)
 
    Default value is "1".
 
-   Example 1-24. Set fallback_default parameter
+   Example 1.24. Set fallback_default parameter
 ...
 modparam("carrierroute", "fallback_default", 1)
 ...
-     __________________________________________________________
 
 1.3.25. db_failure_table (string)
 
@@ -566,11 +543,10 @@ modparam("carrierroute", "fallback_default", 1)
 
    Default value is "carrierfailureroute".
 
-   Example 1-25. Set db_failuretable parameter
+   Example 1.25. Set db_failuretable parameter
 ...
 modparam("carrierroute", "db_failuretable", "carrierfailureroute")
 ...
-     __________________________________________________________
 
 1.3.26. failure_id_column (string)
 
@@ -578,11 +554,10 @@ modparam("carrierroute", "db_failuretable", "carrierfailureroute")
 
    Default value is "id".
 
-   Example 1-26. Set failure_id_column parameter
+   Example 1.26. Set failure_id_column parameter
 ...
 modparam("carrierroute", "failure_id_column", "id")
 ...
-     __________________________________________________________
 
 1.3.27. failure_carrier_column (string)
 
@@ -590,11 +565,10 @@ modparam("carrierroute", "failure_id_column", "id")
 
    Default value is "carrier".
 
-   Example 1-27. Set failure_carrier_column parameter
+   Example 1.27. Set failure_carrier_column parameter
 ...
 modparam("carrierroute", "failure_carrier_column", "carrier")
 ...
-     __________________________________________________________
 
 1.3.28. failure_scan_prefix_column (string)
 
@@ -607,11 +581,10 @@ modparam("carrierroute", "failure_carrier_column", "carrier")
 
    Default value is "scan_prefix".
 
-   Example 1-28. Set failure_scan_prefix_column parameter
+   Example 1.28. Set failure_scan_prefix_column parameter
 ...
 modparam("carrierroute", "failure_scan_prefix_column", "scan_prefix")
 ...
-     __________________________________________________________
 
 1.3.29. failure_domain_column (string)
 
@@ -622,11 +595,10 @@ modparam("carrierroute", "failure_scan_prefix_column", "scan_prefix")
 
    Default value is "domain".
 
-   Example 1-29. Set failure_domain_column parameter
+   Example 1.29. Set failure_domain_column parameter
 ...
 modparam("carrierroute", "failure_domain_column", "domain")
 ...
-     __________________________________________________________
 
 1.3.30. failure_host_name_column (string)
 
@@ -635,11 +607,10 @@ modparam("carrierroute", "failure_domain_column", "domain")
 
    Default value is "host_name".
 
-   Example 1-30. Set failure_host_name_column parameter
+   Example 1.30. Set failure_host_name_column parameter
 ...
 modparam("carrierroute", "failure_host_name_column", "host_name")
 ...
-     __________________________________________________________
 
 1.3.31. failure_reply_code_column (string)
 
@@ -647,11 +618,10 @@ modparam("carrierroute", "failure_host_name_column", "host_name")
 
    Default value is "reply_code".
 
-   Example 1-31. Set failure_reply_code_column parameter
+   Example 1.31. Set failure_reply_code_column parameter
 ...
 modparam("carrierroute", "failure_reply_code_column", "reply_code")
 ...
-     __________________________________________________________
 
 1.3.32. failure_flags_column (string)
 
@@ -659,11 +629,10 @@ modparam("carrierroute", "failure_reply_code_column", "reply_code")
 
    Default value is "flags".
 
-   Example 1-32. Set failure_flags_column parameter
+   Example 1.32. Set failure_flags_column parameter
 ...
 modparam("carrierroute", "failure_flags_column", "flags")
 ...
-     __________________________________________________________
 
 1.3.33. failure_mask_column (string)
 
@@ -671,11 +640,10 @@ modparam("carrierroute", "failure_flags_column", "flags")
 
    Default value is "mask".
 
-   Example 1-33. Set failure_mask_column parameter
+   Example 1.33. Set failure_mask_column parameter
 ...
 modparam("carrierroute", "failure_mask_column", "mask")
 ...
-     __________________________________________________________
 
 1.3.34. failure_next_domain_column (string)
 
@@ -683,11 +651,10 @@ modparam("carrierroute", "failure_mask_column", "mask")
 
    Default value is "next_domain".
 
-   Example 1-34. Set failure_next_domain_column parameter
+   Example 1.34. Set failure_next_domain_column parameter
 ...
 modparam("carrierroute", "failure_next_domain_column", "next_domain")
 ...
-     __________________________________________________________
 
 1.3.35. failure_comment_column (string)
 
@@ -695,11 +662,10 @@ modparam("carrierroute", "failure_next_domain_column", "next_domain")
 
    Default value is "comment".
 
-   Example 1-35. Set failure_comment_column parameter
+   Example 1.35. Set failure_comment_column parameter
 ...
 modparam("carrierroute", "failure_comment_column", "comment")
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -730,9 +696,8 @@ cr_user_rewrite_uri(uri, domain)
 
 cr_tree_rewrite_uri(tree, domain)
 -> cr_route(tree, domain, "$rU", "$rU", "call_id", "crc32")
-     __________________________________________________________
 
-1.4.1. cr_user_carrier(user, domain, dstavp)
+1.4.1.  cr_user_carrier(user, domain, dstavp)
 
    This function loads the carrier and stores it in an AVP. It
    cannot be used in the config file mode, as it needs a mapping
@@ -741,16 +706,14 @@ cr_tree_rewrite_uri(tree, domain)
    "subscriber_table" variable.
 
    Meaning of the parameters is as follows:
-
      * user - Name of the user for the carrier tree lookup.
        Additional to a string any pseudo-variable could be used as
        input.
      * domain - Name of the routing domain to be used. Additional
        to a string any pseudo-variable could be used as input.
      * dstavp - Name of the AVP where to store the carrier id.
-     __________________________________________________________
 
-1.4.2. cr_route(carrier, domain, prefix_matching, rewrite_user,
+1.4.2.  cr_route(carrier, domain, prefix_matching, rewrite_user,
 hash_source, dstavp)
 
    This function searches for the longest match for the user given
@@ -765,7 +728,6 @@ hash_source, dstavp)
    algorithm to calculate the hash values.
 
    Meaning of the parameters is as follows:
-
      * carrier - The routing tree to be used. Additional to a
        string any pseudo-variable could be used as input.
      * domain - Name of the routing domain to be used. Additional
@@ -784,10 +746,9 @@ hash_source, dstavp)
        to_user.
      * dstavp - Name of the AVP where to store the rewritten host.
        This parameter is optional.
-     __________________________________________________________
 
-1.4.3. cr_prime_route(carrier, domain, prefix_matching, rewrite_user,
-hash_source, dstavp)
+1.4.3.  cr_prime_route(carrier, domain, prefix_matching,
+rewrite_user, hash_source, dstavp)
 
    This function searches for the longest match for the user given
    in prefix_matching at the given domain in the given carrier
@@ -801,7 +762,6 @@ hash_source, dstavp)
    to calculate the hash values.
 
    Meaning of the parameters is as follows:
-
      * carrier - The routing tree to be used. Additional to a
        string any pseudo-variable could be used as input.
      * domain - Name of the routing domain to be used. Additional
@@ -820,9 +780,8 @@ hash_source, dstavp)
        to_user.
      * dstavp - Name of the AVP where to store the rewritten host.
        This parameter is optional.
-     __________________________________________________________
 
-1.4.4. cr_next_domain(carrier, domain, prefix_matching, host,
+1.4.4.  cr_next_domain(carrier, domain, prefix_matching, host,
 reply_code, flags, dstavp)
 
    This function searches for the longest match for the user given
@@ -837,7 +796,6 @@ reply_code, flags, dstavp)
    with prefix_matching containing a valid numerical only string.
 
    Meaning of the parameters is as follows:
-
      * carrier - The routing tree to be used. Additional to a
        string any pseudo-variable could be used as input.
      * domain - Name of the routing domain to be used. Additional
@@ -857,7 +815,6 @@ reply_code, flags, dstavp)
        could be used as input.
      * dstavp - Name of the AVP where to store the next routing
        domain.
-     __________________________________________________________
 
 1.5. MI Commands
 
@@ -866,7 +823,6 @@ reply_code, flags, dstavp)
    passed to MI interface. Each option except host and new host
    can be wildcarded by * (but only * and not things like "-d
    prox*").
-     __________________________________________________________
 
 1.5.1. cr_reload_routes
 
@@ -879,18 +835,15 @@ reply_code, flags, dstavp)
    ids used in the script could differ from the one used
    internally from the server. Modifying of already existing
    domains is no problem.
-     __________________________________________________________
 
 1.5.2. cr_dump_routes
 
    This command prints the route rules on the command line.
-     __________________________________________________________
 
 1.5.3. cr_replace_host
 
    This command can replace the rewrite_host of a route rule, it
    is only usable in file mode. Following options are possible:
-
      * -d - the domain containing the host
      * -p - the prefix containing the host
      * -h - the host to be replaced
@@ -898,18 +851,16 @@ reply_code, flags, dstavp)
 
    Use the "null" prefix to specify an empty prefix.
 
-   Example 1-36. cr_replace_host usage
+   Example 1.36. cr_replace_host usage
 ...
 openserctl fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2"
 ...
-     __________________________________________________________
 
 1.5.4. cr_deactivate_host
 
    This command deactivates the specified host, i.e. it sets its
    status to 0. It is only usable in file mode. Following options
    are possible:
-
      * -d - the domain containing the host
      * -p - the prefix containing the host
      * -h - the host to be deactivated
@@ -922,35 +873,31 @@ openserctl fifo cr_replace_host "-d proxy -p 49 -h proxy1 -t proxy2"
 
    Use the "null" prefix to specify an empty prefix.
 
-   Example 1-37. cr_deactivate_host usage
+   Example 1.37. cr_deactivate_host usage
 ...
 openserctl fifo cr_deactivate_host "-d proxy -p 49 -h proxy1"
 ...
-     __________________________________________________________
 
 1.5.5. cr_activate_host
 
    This command activates the specified host, i.e. it sets its
    status to 1. It is only usable in file mode. Following options
    are possible:
-
      * -d - the domain containing the host
      * -p - the prefix containing the host
      * -h - the host to be activated
 
    Use the "null" prefix to specify an empty prefix.
 
-   Example 1-38. cr_activate_host usage
+   Example 1.38. cr_activate_host usage
 ...
 openserctl fifo cr_activate_host "-d proxy -p 49 -h proxy1"
 ...
-     __________________________________________________________
 
 1.5.6. cr_add_host
 
    This command adds a route rule, it is only usable in file mode.
    Following options are possible:
-
      * -d - the domain containing the host
      * -p - the prefix containing the host
      * -h - the host to be added
@@ -962,18 +909,16 @@ openserctl fifo cr_activate_host "-d proxy -p 49 -h proxy1"
 
    Use the "null" prefix to specify an empty prefix.
 
-   Example 1-39. cr_add_host usage
+   Example 1.39. cr_add_host usage
 ...
 openserctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
 ...
-     __________________________________________________________
 
 1.5.7. cr_delete_host
 
    This command delete the specified hosts or rules, i.e. remove
    them from the route tree. It is only usable in file mode.
    Following options are possible:
-
      * -d - the domain containing the host
      * -p - the prefix containing the host
      * -h - the host to be added
@@ -985,15 +930,14 @@ openserctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
 
    Use the "null" prefix to specify an empty prefix.
 
-   Example 1-40. cr_delete_host usage
+   Example 1.40. cr_delete_host usage
 ...
 openserctl fifo cr_delete_host "-d proxy -p 49 -h proxy1 -w 0.25"
 ...
-     __________________________________________________________
 
 1.6. Examples
 
-   Example 1-41. Configuration example - Routing to default tree
+   Example 1.41. Configuration example - Routing to default tree
 ...
 route {
         # route calls based on hash over callid
@@ -1027,7 +971,7 @@ failure_route[2] {
 }
 
 
-   Example 1-42. Configuration example - Routing to user tree
+   Example 1.42. Configuration example - Routing to user tree
 ...
 route[1] {
         cr_user_carrier("$fU", "$fd", "$avp(s:carrier)");
@@ -1067,7 +1011,7 @@ failure_route[1] {
 }
 ...
 
-   Example 1-43. Configuration example - module configuration
+   Example 1.43. Configuration example - module configuration
 
    The following config file specifies within the default carrier
    two domains, each with an prefix that contains two hosts. It is
@@ -1124,9 +1068,8 @@ domain register {
    }
 }
 ...
-     __________________________________________________________
 
-1.7. Installation & Running
+1.7. Installation and Running
 
 1.7.1. Database setup
 
@@ -1145,7 +1088,7 @@ domain register {
    For a minimal configuration either use the config file given
    above, or insert some data into the tables of the module.
 
-   Example 1-44. Example database content - carrierroute table
+   Example 1.44. Example database content - carrierroute table
 ...
 +----+---------+--------+-------------+------+-------+---------------+
 | id | carrier | domain |scan_prefix | prob | strip | rewrite_host   |
@@ -1178,7 +1121,7 @@ domain register {
    section. The usage of strings for the domains is also possible,
    for example at carrier 3.
 
-   Example 1-45. Example database content - simple
+   Example 1.45. Example database content - simple
    carrierfailureroute table
 ...
 +----+---------+--------+---------------+------------+-------------+
@@ -1200,7 +1143,7 @@ domain register {
    corresponding entry in the carrierroute table, otherwise the
    module will not load the routing data.
 
-   Example 1-46. Example database content - more complex
+   Example 1.46. Example database content - more complex
    carrierfailureroute table
 ...
 +----+---------+-----------+------------+--------+-----+-------------+
@@ -1227,7 +1170,7 @@ domain register {
    holds domain entries for this routing rules. Not all table
    colums are show here for brevity.
 
-   Example 1-47. Example database content - route_tree table
+   Example 1.47. Example database content - route_tree table
 ...
 +----+----------+
 | id | carrier  |
@@ -1246,9 +1189,42 @@ domain register {
    that you specified as modul parameter) to choose the actual
    carrier for the users.
 
-   Example 1-48. Necessary extensions for the user table
+   Example 1.48. Necessary extensions for the user table
 
    Suggested changes:
 ...
 ALTER TABLE subscriber ADD cr_preferred_carrier int(10) default NULL;
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/carrierroute/doc/carrierroute.sgml → modules_k/carrierroute/doc/carrierroute.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "carrierroute_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "carrierroute_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general OpenSER documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -18,17 +20,17 @@
 		<author>
 		<firstname>Jonas</firstname>
 		<surname>Appel</surname>
-		<affiliation><orgname>1&1 Internet AG</orgname></affiliation>
+		<affiliation><orgname>1&amp;1 Internet AG</orgname></affiliation>
 		</author>
 		<author>
 		<firstname>Hardy</firstname>
 		<surname>Kahl</surname>
-		<affiliation><orgname>1&1 Internet AG</orgname></affiliation>
+		<affiliation><orgname>1&amp;1 Internet AG</orgname></affiliation>
 		</author>
 		<author>
 		<firstname>Henning</firstname>
 		<surname>Westerholt</surname>
-		<affiliation><orgname>1&1 Internet AG</orgname></affiliation>
+		<affiliation><orgname>1&amp;1 Internet AG</orgname></affiliation>
 		<address>
 			<email>[email protected]</email>
 		</address>
@@ -45,12 +47,12 @@
 	</authorgroup>
 	<copyright>
 		<year>2007</year>
-		<holder>1&1 Internet AG</holder>
+		<holder>1&amp;1 Internet AG</holder>
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3794 $</revnumber>
+		<date>$Date: 2008-02-28 19:22:36 +0200 (Thu, 28 Feb 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/carrierroute/doc/carrierroute_user.sgml → modules_k/carrierroute/doc/carrierroute_admin.xml

@@ -1230,6 +1230,7 @@ openserctl fifo cr_activate_host "-d proxy -p 49 -h proxy1"
 		</listitem>
 		<listitem>
 		    <para><emphasis>-s</emphasis> - an optional strip value</para>
+		</listitem>
 	    </itemizedlist>
 		<para>Use the "null" prefix to specify an empty prefix.</para>
 	    <example>
@@ -1273,6 +1274,7 @@ openserctl fifo cr_add_host "-d proxy -p 49 -h proxy1 -w 0.25"
 		</listitem>
 		<listitem>
 		    <para><emphasis>-s</emphasis> - an optional strip value</para>
+		</listitem>
 	    </itemizedlist>
 	    <para>Use the "null" prefix to specify an empty prefix.</para>
 	    <example>
@@ -1433,7 +1435,7 @@ domain register {
     </section>
 
     <section>
-	<title>Installation & Running</title>
+	<title>Installation and Running</title>
 	<section>
 		<title>Database setup</title>
 		<para>

modules_k/cfgutils/README

@@ -3,6 +3,7 @@ cfgutils Module
 Henning Westerholt
 
    1und1 Internet AG
+   <[email protected]>
 
 Carsten Bock
 
@@ -14,9 +15,13 @@ Elena-Ramona Modroiu
 
    Copyright © 2007, 2008 1und1 Internet AG, BASIS AudioNet GmbH,
    Elena-Ramona Modroiu
+   Revision History
+   Revision $Revision: 3839 $ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -52,27 +57,29 @@ Elena-Ramona Modroiu
               1.6.2. $time(name)
               1.6.3. $shv(name)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. initial_probability parameter usage
-   1-2. hash_file parameter usage
-   1-3. shvset parameter usage
-   1-4. rand_event() usage
-   1-5. rand_set_prob() usage
-   1-6. rand_reset_prob() usage
-   1-7. rand_get_prob() usage
-   1-8. sleep usage
-   1-9. usleep usage
-   1-10. rand_set_prob usage
-   1-11. rand_reset_prob usage
-   1-12. rand_get_prob usage
-   1-13. check_config_hash usage
-   1-14. get_config_hash usage
-   1-15. shv_set usage
-   1-16. shv_get usage
-   1-17. RANDOM pseudo-variable usage
-   1-18. time(name) pseudo-variable usage
-   1-19. shv(name) pseudo-variable usage
-     __________________________________________________________
+
+   1.1. initial_probability parameter usage
+   1.2. hash_file parameter usage
+   1.3. shvset parameter usage
+   1.4. rand_event() usage
+   1.5. rand_set_prob() usage
+   1.6. rand_reset_prob() usage
+   1.7. rand_get_prob() usage
+   1.8. sleep usage
+   1.9. usleep usage
+   1.10. rand_set_prob usage
+   1.11. rand_reset_prob usage
+   1.12. rand_get_prob usage
+   1.13. check_config_hash usage
+   1.14. get_config_hash usage
+   1.15. shv_set usage
+   1.16. shv_get usage
+   1.17. RANDOM pseudo-variable usage
+   1.18. time(name) pseudo-variable usage
+   1.19. shv(name) pseudo-variable usage
 
 Chapter 1. User's Guide
 
@@ -117,15 +124,12 @@ Chapter 1. User's Guide
    modifications of this file after the server start. This
    functions are available as the FIFO commands
    "check_config_hash" and "get_config_hash".
-     __________________________________________________________
 
 1.2. Dependencies
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * none
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -135,10 +139,10 @@ Chapter 1. User's Guide
 
    Default value is "10".
 
-   Example 1-1. initial_probability parameter usage
+   Example 1.1. initial_probability parameter usage
 
 modparam("cfgutils", "initial_probability", "15");
-     __________________________________________________________
+
 
 1.3.2. hash_file (string)
 
@@ -148,10 +152,10 @@ modparam("cfgutils", "initial_probability", "15");
    The default value is equal the config file that is used from
    the server, for example "/etc/openser/openser.cfg".
 
-   Example 1-2. hash_file parameter usage
+   Example 1.2. hash_file parameter usage
 
 modparam("cfgutils", "hash_file", "/etc/openser/openser.cfg");
-     __________________________________________________________
+
 
 1.3.3. shvset (string)
 
@@ -160,7 +164,6 @@ modparam("cfgutils", "hash_file", "/etc/openser/openser.cfg");
 
    The value of the parameter has the format: _name_ '=' _type_
    ':' _value_
-
      * _name_: shared variable name
      * _type_: type of the value
           + "i": integer value
@@ -169,12 +172,11 @@ modparam("cfgutils", "hash_file", "/etc/openser/openser.cfg");
 
    Default value is "NULL".
 
-   Example 1-3. shvset parameter usage
+   Example 1.3. shvset parameter usage
 ...
 modparam("cfgutils", "shvset", "debug=i:1")
 modparam("cfgutils", "shvset", "pstngw=s:sip:10.10.10.10")
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -183,7 +185,7 @@ modparam("cfgutils", "shvset", "pstngw=s:sip:10.10.10.10")
    Return true or false, depending on a random value and a
    probability value.
 
-   Example 1-4. rand_event() usage
+   Example 1.4. rand_event() usage
 ...
 if (rand_event()) {
   append_to_reply("Retry-After: 120\n");
@@ -192,7 +194,6 @@ if (rand_event()) {
 };
 # normal message processing follows
 ...
-     __________________________________________________________
 
 1.4.2. rand_set_prob(probabiltiy)
 
@@ -200,65 +201,59 @@ if (rand_event()) {
 
    "probability" can have a value from the range 0..99.
 
-   Example 1-5. rand_set_prob() usage
+   Example 1.5. rand_set_prob() usage
 ...
 rand_set_prob("4");
 ...
-     __________________________________________________________
 
 1.4.3. rand_reset_prob()
 
    Reset the probability back to the inital value.
 
-   Example 1-6. rand_reset_prob() usage
+   Example 1.6. rand_reset_prob() usage
 ...
 rand_reset_prob();
 ...
-     __________________________________________________________
 
 1.4.4. rand_get_prob()
 
    Return the current probability setting, e.g. for logging
    purposes.
 
-   Example 1-7. rand_get_prob() usage
+   Example 1.7. rand_get_prob() usage
 ...
 rand_get_prob();
-     __________________________________________________________
 
-1.4.5. sleep(time)
+
+1.4.5.  sleep(time)
 
    Waits "time" seconds.
 
    Meaning of the parameters is as follows:
-
      * time - Time to wait in seconds.
 
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, BRANCH_ROUTE.
 
-   Example 1-8. sleep usage
+   Example 1.8. sleep usage
 ...
 sleep("1");
 ...
-     __________________________________________________________
 
-1.4.6. usleep(time)
+1.4.6.  usleep(time)
 
    Waits "time" milli-seconds.
 
    Meaning of the parameters is as follows:
-
      * time - Time to wait in milli-seconds.
 
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
    FAILURE_ROUTE, BRANCH_ROUTE.
 
-   Example 1-9. usleep usage
+   Example 1.9. usleep usage
 ...
 usleep("500");
 ...
-     __________________________________________________________
 
 1.5. MI Commands
 
@@ -269,11 +264,10 @@ usleep("500");
 
    The parameter value must be a number from 0 to 99.
 
-   Example 1-10. rand_set_prob usage
+   Example 1.10. rand_set_prob usage
 ...
 $ openserctl fifo rand_set_prob 10
 ...
-     __________________________________________________________
 
 1.5.2. rand_reset_prob
 
@@ -281,11 +275,10 @@ $ openserctl fifo rand_set_prob 10
 
    This command don't need a parameter.
 
-   Example 1-11. rand_reset_prob usage
+   Example 1.11.  rand_reset_prob usage
 ...
 $ openserctl fifo rand_reset_prob
 ...
-     __________________________________________________________
 
 1.5.3. rand_get_prob
 
@@ -293,12 +286,11 @@ $ openserctl fifo rand_reset_prob
 
    The function return the actual probability value.
 
-   Example 1-12. rand_get_prob usage
+   Example 1.12. rand_get_prob usage
 ...
 $ openserctl fifo get_prob
 The actual probability is 50 percent.
 ...
-     __________________________________________________________
 
 1.5.4. check_config_hash
 
@@ -309,12 +301,11 @@ The actual probability is 50 percent.
    400 if there are not identical and 500 on errors. Additional a
    short text message is printed.
 
-   Example 1-13. check_config_hash usage
+   Example 1.13. check_config_hash usage
 ...
 $ openserctl fifo check_config_hash
 The actual config file hash is identical to the stored one.
 ...
-     __________________________________________________________
 
 1.5.5. get_config_hash
 
@@ -322,19 +313,17 @@ The actual config file hash is identical to the stored one.
 
    The function returns 200 OK and the hash value.
 
-   Example 1-14. get_config_hash usage
+   Example 1.14. get_config_hash usage
 ...
 $ openserctl fifo get_config_hash
 1580a37104eb4de69ab9f31ce8d6e3e0
 ...
-     __________________________________________________________
 
 1.5.6. shv_set
 
    Set the value of a shared variable ($shv(name)).
 
    Parameters:
-
      * _name_: shared variable name
      * _type_: type of the value
           + "int": integer value
@@ -348,18 +337,16 @@ $ openserctl fifo get_config_hash
                 _value_
                 _empty_line_
 
-   Example 1-15. shv_set usage
+   Example 1.15. shv_set usage
 ...
 $ openserctl fifo shv_set debug int 0
 ...
-     __________________________________________________________
 
 1.5.7. shv_get
 
    Get the value of a shared variable ($shv(name)).
 
    Parameters:
-
      * _name_: shared variable name. If this parameter is missing,
        all shared variables are returned.
 
@@ -368,12 +355,11 @@ $ openserctl fifo shv_set debug int 0
                 _name_
                 _empty_line_
 
-   Example 1-16. shv_get usage
+   Example 1.16. shv_get usage
 ...
 $ openserctl fifo shv_get debug
 $ openserctl fifo shv_get
 ...
-     __________________________________________________________
 
 1.6. Exported pseudo-variables
 
@@ -381,7 +367,7 @@ $ openserctl fifo shv_get
 
    Returns a random value from the [0 - 2^31) range.
 
-   Example 1-17. RANDOM pseudo-variable usage
+   Example 1.17. RANDOM pseudo-variable usage
 ...
 if (get_random()) {
   $avp(i:10) = ($RANDOM / 16777216); # 2^24
@@ -394,14 +380,12 @@ if (get_random()) {
 };
 # normal message processing follows
 
-     __________________________________________________________
 
 1.6.2. $time(name)
 
    The PV provides access to broken-down time attributes.
 
    The "name" can be:
-
      * sec - return seconds (int 0-59)
      * min - return minutes (int 0-59)
      * hour - return hours (int 0-23)
@@ -413,13 +397,12 @@ if (get_random()) {
      * isdst - return daylight saving time status (int, 0 - DST
        off, >0 DST on)
 
-   Example 1-18. time(name) pseudo-variable usage
+   Example 1.18. time(name) pseudo-variable usage
 ...
 if ($time(year) == 2008) {
         xlog("request: $rm from $fu to $ru in year 2008\n");
 }
 ...
-     __________________________________________________________
 
 1.6.3. $shv(name)
 
@@ -430,7 +413,7 @@ if ($time(year) == 2008) {
    variable. The module exports a set of MI functions to get/set
    the value of shared variables.
 
-   Example 1-19. shv(name) pseudo-variable usage
+   Example 1.19. shv(name) pseudo-variable usage
 ...
 modparam("cfgutils", "shvset", "debug=i:1")
 ...
@@ -438,3 +421,36 @@ if ($shv(debug) == 1) {
         xlog("request: $rm from $fu to $ru\n");
 }
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/cfgutils/doc/cfgutils.sgml → modules_k/cfgutils/doc/cfgutils.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "cfgutils_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "cfgutils_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -45,8 +47,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/cfgutils/doc/cfgutils_user.sgml → modules_k/cfgutils/doc/cfgutils_admin.xml

@@ -441,7 +441,7 @@ $ openserctl fifo shv_get
 ...
 if (get_random()) {
   $avp(i:10) = ($RANDOM / 16777216); # 2^24
-  if ($avp(i:10) < 10) {
+  if ($avp(i:10) &lt; 10) {
      $avp(i:10) = 10;
   }
   append_to_reply("Retry-After: $avp(i:10)\n");

modules_k/cpl-c/README

@@ -9,9 +9,13 @@ Edited by
 Bogdan-Andrei Iancu
 
    Copyright © 2003 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -51,31 +55,33 @@ Bogdan-Andrei Iancu
               1.5.2. REMOVE_CPL
               1.5.3. GET_CPL
 
-        1.6. Installation & Running
+        1.6. Installation and Running
 
               1.6.1. Database setup
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set db_url parameter
-   1-2. Set db_table parameter
-   1-3. Set username_column parameter
-   1-4. Set domain_column parameter
-   1-5. Set cpl_xml_column parameter
-   1-6. Set cpl_bin_column parameter
-   1-7. Set cpl_dtd_file parameter
-   1-8. Set log_dir parameter
-   1-9. Set proxy_recurse parameter
-   1-10. Set proxy_route parameter
-   1-11. Set case_sensitive parameter
-   1-12. Set realm_prefix parameter
-   1-13. Set timer_avp parameter
-   1-14. Set lookup_domain parameter
-   1-15. Set lookup_append_branches parameter
-   1-16. Set use_domain parameter
-   1-17. cpl_run_script usage
-   1-18. cpl_process_register usage
-   1-19. cpl_process_register_norpl usage
-     __________________________________________________________
+
+   1.1. Set db_url parameter
+   1.2. Set db_table parameter
+   1.3. Set username_column parameter
+   1.4. Set domain_column parameter
+   1.5. Set cpl_xml_column parameter
+   1.6. Set cpl_bin_column parameter
+   1.7. Set cpl_dtd_file parameter
+   1.8. Set log_dir parameter
+   1.9. Set proxy_recurse parameter
+   1.10. Set proxy_route parameter
+   1.11. Set case_sensitive parameter
+   1.12. Set realm_prefix parameter
+   1.13. Set timer_avp parameter
+   1.14. Set lookup_domain parameter
+   1.15. Set lookup_append_branches parameter
+   1.16. Set use_domain parameter
+   1.17. cpl_run_script usage
+   1.18. cpl_process_register usage
+   1.19. cpl_process_register_norpl usage
 
 Chapter 1. User's Guide
 
@@ -84,14 +90,12 @@ Chapter 1. User's Guide
    cpl-c modules implements a CPL (Call Processing Language)
    interpreter. Support for uploading/downloading/removing scripts
    via SIP REGISTER method is present.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * any DB module- a DB module for interfacing the DB
        operations (modules like mysql, postgres, dbtext, etc)
      * TM (Transaction) module- used for proxying/forking requests
@@ -101,17 +105,14 @@ Chapter 1. User's Guide
      * USRLOC (User Location) module - used for implementing
        lookup("registration") tag (adding into location set of the
        users' contact)
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * libxml2 and libxml2-devel - on some SO, these to packages
        are merged into libxml2. This library contains an engine
        for XML parsing, DTD validation and DOM manipulation.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -124,11 +125,10 @@ Chapter 1. User's Guide
 
    Default value is "mysql://openser:openserrw@localhost/openser".
 
-   Example 1-1. Set db_url parameter
+   Example 1.1. Set db_url parameter
 ...
 modparam("cpl-c","db_url","dbdriver://username:password@dbhost/dbname")
 ...
-     __________________________________________________________
 
 1.3.2. db_table (string)
 
@@ -139,11 +139,10 @@ modparam("cpl-c","db_url","dbdriver://username:password@dbhost/dbname")
 
    Default value is "cpl".
 
-   Example 1-2. Set db_table parameter
+   Example 1.2. Set db_table parameter
 ...
 modparam("cpl-c","cpl_table","cpl")
 ...
-     __________________________________________________________
 
 1.3.3. username_column (string)
 
@@ -151,11 +150,10 @@ modparam("cpl-c","cpl_table","cpl")
 
    Default value is "username".
 
-   Example 1-3. Set username_column parameter
+   Example 1.3. Set username_column parameter
 ...
 modparam("cpl-c","username_column","username")
 ...
-     __________________________________________________________
 
 1.3.4. domain_column (string)
 
@@ -163,11 +161,10 @@ modparam("cpl-c","username_column","username")
 
    Default value is "domain".
 
-   Example 1-4. Set domain_column parameter
+   Example 1.4. Set domain_column parameter
 ...
 modparam("cpl-c","domain_column","domain")
 ...
-     __________________________________________________________
 
 1.3.5. cpl_xml_column (string)
 
@@ -176,11 +173,10 @@ modparam("cpl-c","domain_column","domain")
 
    Default value is "cpl_xml".
 
-   Example 1-5. Set cpl_xml_column parameter
+   Example 1.5. Set cpl_xml_column parameter
 ...
 modparam("cpl-c","cpl_xml_column","cpl_xml")
 ...
-     __________________________________________________________
 
 1.3.6. cpl_bin_column (string)
 
@@ -189,11 +185,10 @@ modparam("cpl-c","cpl_xml_column","cpl_xml")
 
    Default value is "cpl_bin".
 
-   Example 1-6. Set cpl_bin_column parameter
+   Example 1.6. Set cpl_bin_column parameter
 ...
 modparam("cpl-c","cpl_bin_column","cpl_bin")
 ...
-     __________________________________________________________
 
 1.3.7. cpl_dtd_file (string)
 
@@ -204,11 +199,10 @@ modparam("cpl-c","cpl_bin_column","cpl_bin")
 
    This parameter is MANDATORY!
 
-   Example 1-7. Set cpl_dtd_file parameter
+   Example 1.7. Set cpl_dtd_file parameter
 ...
 modparam("cpl-c","cpl_dtd_file","/etc/openser/cpl-06.dtd")
 ...
-     __________________________________________________________
 
 1.3.8. log_dir (string)
 
@@ -219,11 +213,10 @@ modparam("cpl-c","cpl_dtd_file","/etc/openser/cpl-06.dtd")
    If this parameter is absent, the logging will be disabled
    without generating error on execution.
 
-   Example 1-8. Set log_dir parameter
+   Example 1.8. Set log_dir parameter
 ...
 modparam("cpl-c","log_dir","/var/log/openser/cpl")
 ...
-     __________________________________________________________
 
 1.3.9. proxy_recurse (int)
 
@@ -236,11 +229,10 @@ modparam("cpl-c","log_dir","/var/log/openser/cpl")
 
    Default value of this parameter is 0.
 
-   Example 1-9. Set proxy_recurse parameter
+   Example 1.9. Set proxy_recurse parameter
 ...
 modparam("cpl-c","proxy_recurse",2)
 ...
-     __________________________________________________________
 
 1.3.10. proxy_route (int)
 
@@ -250,11 +242,10 @@ modparam("cpl-c","proxy_recurse",2)
 
    Default value of this parameter is 0 (none).
 
-   Example 1-10. Set proxy_route parameter
+   Example 1.10. Set proxy_route parameter
 ...
 modparam("cpl-c","proxy_route",1)
 ...
-     __________________________________________________________
 
 1.3.11. case_sensitive (int)
 
@@ -264,11 +255,10 @@ modparam("cpl-c","proxy_route",1)
 
    Default value of this parameter is 0.
 
-   Example 1-11. Set case_sensitive parameter
+   Example 1.11. Set case_sensitive parameter
 ...
 modparam("cpl-c","case_sensitive",1)
 ...
-     __________________________________________________________
 
 1.3.12. realm_prefix (string)
 
@@ -277,11 +267,10 @@ modparam("cpl-c","case_sensitive",1)
 
    Default value of this parameter is empty string.
 
-   Example 1-12. Set realm_prefix parameter
+   Example 1.12. Set realm_prefix parameter
 ...
 modparam("cpl-c","realm_prefix","sip.")
 ...
-     __________________________________________________________
 
 1.3.13. timer_avp (string)
 
@@ -294,11 +283,10 @@ modparam("cpl-c","realm_prefix","sip.")
 
    Default value of this parameter is NULL.
 
-   Example 1-13. Set timer_avp parameter
+   Example 1.13. Set timer_avp parameter
 ...
 modparam("cpl-c","timer_avp","$avp(i:14)")
 ...
-     __________________________________________________________
 
 1.3.14. lookup_domain (string)
 
@@ -311,11 +299,10 @@ modparam("cpl-c","timer_avp","$avp(i:14)")
 
    Default value of this parameter is NULL.
 
-   Example 1-14. Set lookup_domain parameter
+   Example 1.14. Set lookup_domain parameter
 ...
 modparam("cpl-c","lookup_domain","location")
 ...
-     __________________________________________________________
 
 1.3.15. lookup_append_branches (int)
 
@@ -326,11 +313,10 @@ modparam("cpl-c","lookup_domain","location")
 
    Default value of this parameter is 0.
 
-   Example 1-15. Set lookup_append_branches parameter
+   Example 1.15. Set lookup_append_branches parameter
 ...
 modparam("cpl-c","lookup_append_branches",1)
 ...
-     __________________________________________________________
 
 1.3.16. use_domain (integer)
 
@@ -339,15 +325,14 @@ modparam("cpl-c","lookup_append_branches",1)
 
    Default value is "0 (disabled)".
 
-   Example 1-16. Set use_domain parameter
+   Example 1.16. Set use_domain parameter
 ...
 modparam("cpl-c","use_domain",1)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. cpl_run_script(type,mode)
+1.4.1.  cpl_run_script(type,mode)
 
    Starts the execution of the CPL script. The user name is
    fetched from new_uri or requested uri or from To header -in
@@ -367,7 +352,6 @@ modparam("cpl-c","use_domain",1)
    (this can be done from script).
 
    Meaning of the parameters is as follows:
-
      * type - which part of the script should be run; set it to
        "incoming" for having the incoming part of script executed
        (when an INVITE is received) or to "outgoing" for running
@@ -402,13 +386,12 @@ modparam("cpl-c","use_domain",1)
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-17. cpl_run_script usage
+   Example 1.17. cpl_run_script usage
 ...
 cpl_run_script("incoming","force_stateful");
 ...
-     __________________________________________________________
 
-1.4.2. cpl_process_register()
+1.4.2.  cpl_process_register()
 
    This function MUST be called only for REGISTER requests. It
    checks if the current REGISTER request is related or not with
@@ -431,15 +414,14 @@ cpl_run_script("incoming","force_stateful");
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-18. cpl_process_register usage
+   Example 1.18. cpl_process_register usage
 ...
 if (method=="REGISTER") {
     cpl_process_register();
 }
 ...
-     __________________________________________________________
 
-1.4.3. cpl_process_register_norpl()
+1.4.3.  cpl_process_register_norpl()
 
    Same as "cpl_process_register" without internally generating
    the reply. All information (script) is appended to the reply
@@ -450,7 +432,7 @@ if (method=="REGISTER") {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-19. cpl_process_register_norpl usage
+   Example 1.19. cpl_process_register_norpl usage
 ...
 if (method=="REGISTER") {
     cpl_process_register();
@@ -458,11 +440,10 @@ if (method=="REGISTER") {
     save("location");
 }
 ...
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
-1.5.1. LOAD_CPL
+1.5.1.  LOAD_CPL
 
    For the given user, loads the XML cpl file, compiles it into
    binary format and stores both format into database.
@@ -470,7 +451,6 @@ if (method=="REGISTER") {
    Name: LOAD_CPL
 
    Parameters:
-
      * username : name of the user
      * cpl_filename: file name
 
@@ -479,9 +459,8 @@ if (method=="REGISTER") {
                  username
                  cpl_filename
                  _empty_line_
-     __________________________________________________________
 
-1.5.2. REMOVE_CPL
+1.5.2.  REMOVE_CPL
 
    For the given user, removes the entire database record (XML cpl
    and binary cpl); user with empty cpl scripts are not accepted.
@@ -489,32 +468,28 @@ if (method=="REGISTER") {
    Name: REMOVE_CPL
 
    Parameters:
-
      * username : name of the user
 
    MI FIFO Command format:
                  :REMOVE_CPL:_reply_fifo_file_
                  username
                  _empty_line_
-     __________________________________________________________
 
-1.5.3. GET_CPL
+1.5.3.  GET_CPL
 
    For the given user, returns the CPL script in XML format.
 
    Name: GET_CPL
 
    Parameters:
-
      * username : name of the user
 
    MI FIFO Command format:
                  :GET_CPL:_reply_fifo_file_
                  username
                  _empty_line_
-     __________________________________________________________
 
-1.6. Installation & Running
+1.6. Installation and Running
 
 1.6.1. Database setup
 
@@ -529,3 +504,36 @@ if (method=="REGISTER") {
    can also find the complete database documentation on the
    project webpage,
    http://www.openser.org/docs/db-tables/openser-db-devel.html.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/cpl-c/doc/cpl-c.sgml → modules_k/cpl-c/doc/cpl-c.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "cpl-c_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "cpl-c_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -37,8 +39,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-			<revnumber>$Revision$</revnumber>
-			<date>$Date$</date>
+			<revnumber>$Revision: 3839 $</revnumber>
+			<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/cpl-c/doc/cpl-c_user.sgml → modules_k/cpl-c/doc/cpl-c_admin.xml

@@ -467,7 +467,7 @@ modparam("cpl-c","use_domain",1)
 				<itemizedlist>
 				<listitem>
 					<para>
-					<emphasis>IS_STATELESS<emphasis> - the current INVITE has 
+					<emphasis>IS_STATELESS</emphasis> - the current INVITE has 
 					no transaction created yet. All replies (redirection or 
 					deny) will be done is a stateless way. The execution will 
 					switch to stateful only when proxy is done. So, if the 
@@ -476,7 +476,7 @@ modparam("cpl-c","use_domain",1)
 				</listitem>
 				<listitem>
 					<para>
-					<emphasis>IS_STATEFUL<emphasis> - the current INVITE has 
+					<emphasis>IS_STATEFUL</emphasis> - the current INVITE has 
 					already a transaction associated. All signaling operations
 					(replies or proxy) will be done in stateful way.So, if
 					the function returns, will be in stateful mode.
@@ -484,7 +484,7 @@ modparam("cpl-c","use_domain",1)
 				</listitem>
 				<listitem>
 					<para>
-					<emphasis>FORCE_STATEFUL<emphasis> - the current INVITE 
+					<emphasis>FORCE_STATEFUL</emphasis> - the current INVITE 
 					has no transaction created yet. All signaling operations
 					will be done is a stateful way (on signaling, the
 					transaction will be created from within the interpreter).
@@ -586,7 +586,7 @@ if (method=="REGISTER") {
     save("location");
 }
 ...
-</programlisting >
+</programlisting>
 			</example>
 		</section>
 	</section>
@@ -672,7 +672,7 @@ if (method=="REGISTER") {
 	</section>
 
 	<section>
-		<title>Installation & Running</title>
+		<title>Installation and Running</title>
 		<section>
 			<title>Database setup</title>
 			<para>

modules_k/db_berkeley/README

@@ -9,9 +9,13 @@ Edited by
 Will Quan
 
    Copyright © 2007 Cisco Systems
+   Revision History
+   Revision $Revision: 846 $ $Date: 2006-05-22 09:15:40 -0500
+                             (Mon, 22 May 2006) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -41,18 +45,20 @@ Will Quan
         1.13. DB Recovery : bdb_recover
         1.14. Known Limitations
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set auto_reload parameter
-   1-2. Set log_enable parameter
-   1-3. Set journal_roll_interval parameter
-   1-4. METADATA_COLUMNS
-   1-5. contents of version table
-   1-6. METADATA_COLUMNS
-   1-7. METADATA_KEYS
-   1-8. METADATA_LOGFLAGS
-   1-9. openserdbctl
-   1-10. bdb_recover usage
-     __________________________________________________________
+
+   1.1. Set auto_reload parameter
+   1.2. Set log_enable parameter
+   1.3. Set journal_roll_interval parameter
+   1.4. METADATA_COLUMNS
+   1.5. contents of version table
+   1.6. METADATA_COLUMNS
+   1.7. METADATA_KEYS
+   1.8. METADATA_LOGFLAGS
+   1.9. openserdbctl
+   1.10. bdb_recover usage
 
 Chapter 1. User's Guide
 
@@ -60,24 +66,19 @@ Chapter 1. User's Guide
 
    This is a module which integrates the Berkeley DB into OpenSER.
    It implements the DB API defined in OpenSER.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * Berkeley Berkeley DB 4.6 - an embedded database.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -90,11 +91,10 @@ Chapter 1. User's Guide
 
    Default value is 0 (1 - on / 0 - off).
 
-   Example 1-1. Set auto_reload parameter
+   Example 1.1. Set auto_reload parameter
 ...
 modparam("db_berkeley", "auto_reload", 1)
 ...
-     __________________________________________________________
 
 1.3.2. log_enable (integer)
 
@@ -111,11 +111,10 @@ modparam("db_berkeley", "auto_reload", 1)
 
    Default value is 0 (1 - on / 0 - off).
 
-   Example 1-2. Set log_enable parameter
+   Example 1.2. Set log_enable parameter
 ...
 modparam("db_berkeley", "log_enable", 1)
 ...
-     __________________________________________________________
 
 1.3.3. journal_roll_interval (integer seconds)
 
@@ -125,16 +124,14 @@ modparam("db_berkeley", "log_enable", 1)
 
    Default value is 0 (off).
 
-   Example 1-3. Set journal_roll_interval parameter
+   Example 1.3. Set journal_roll_interval parameter
 ...
 modparam("db_berkeley", "journal_roll_interval", 3600)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
    No function exported to be used from configuration file.
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
@@ -153,7 +150,6 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
    table provide the tablename as the arguement (eg subscriber);
    to reload all tables provide the db_path to the db files. The
    path can be found in openserctlrc DB_PATH variable.
-     __________________________________________________________
 
 1.6. Installation and Running
 
@@ -170,7 +166,6 @@ modparam("db_berkeley", "journal_roll_interval", 3600)
    Because the module dependes on an external library, the
    db_berkeley module is not compiled and installed by default.
    You can use one of the next options.
-
      * edit the "Makefile" and remove "db_berkeley" from
        "excluded_modules" list. Then follow the standard procedure
        to install OpenSER: "make all; make install".
@@ -252,7 +247,6 @@ by default none is loaded
    (w.o domain) in order to find a result to that particular
    subscriber query. The main point is 'use_domain' can not be
    changed once the db_berkeley is setup.
-     __________________________________________________________
 
 1.7. Database Schema and Metadata
 
@@ -269,7 +263,7 @@ by default none is loaded
    record delimiter within the Berkeley DB implementation and must
    not be present in any DB field.
 
-   Example 1-4. METADATA_COLUMNS
+   Example 1.4. METADATA_COLUMNS
 METADATA_COLUMNS
 table_name(str) table_version(int)
 METADATA_KEY
@@ -291,7 +285,7 @@ METADATA_KEY
    the 'db_berkeley.sh dump version' command. It shows contents of
    table 'version' in plain text.
 
-   Example 1-5. contents of version table
+   Example 1.5. contents of version table
 VERSION=3
 format=print
 type=hash
@@ -341,7 +335,6 @@ HEADER=END
  usr_preferences|
  usr_preferences|2
 DATA=END
-     __________________________________________________________
 
 1.8. METADATA_COLUMNS (required)
 
@@ -349,21 +342,19 @@ DATA=END
    Each is space delimited. Here is an example of the data taken
    from table subscriber :
 
-   Example 1-6. METADATA_COLUMNS
+   Example 1.6. METADATA_COLUMNS
 METADATA_COLUMNS
 username(str) domain(str) password(str) ha1(str) ha1b(str) first_name(st
 r) last_name(str) email_address(str) datetime_created(datetime) timezone
 (str) rpid(str)
 
    Related (hardcoded) limitations:
-
      * maximum of 32 columns per table.
      * maximum tablename size is 64.
      * maximum data length is 2048
 
    Currently supporting these five types: str, datetime, int,
    double, string.
-     __________________________________________________________
 
 1.9. METADATA_KEYS (required)
 
@@ -372,14 +363,13 @@ r) last_name(str) email_address(str) datetime_created(datetime) timezone
    is an example taken from table subscriber that brings up a good
    point:
 
-   Example 1-7. METADATA_KEYS
+   Example 1.7. METADATA_KEYS
  METADATA_KEY
  0 1
 
    The point is that both the username and domain name are require
    as the key to this record. Thus, usrloc modparam use_domain = 1
    must be set for this to work.
-     __________________________________________________________
 
 1.10. METADATA_READONLY (optional)
 
@@ -388,7 +378,6 @@ r) last_name(str) email_address(str) datetime_created(datetime) timezone
    as read-write (loads metadata) and then if this is set=1, it
    will close and reopen as read only (ro). I found this useful
    because readonly has impacts on the internal db locking etc.
-     __________________________________________________________
 
 1.11. METADATA_LOGFLAGS (optional)
 
@@ -397,7 +386,7 @@ r) last_name(str) email_address(str) datetime_created(datetime) timezone
    value is taken as 0. Here are the masks so far (taken from
    bdb_lib.h):
 
-   Example 1-8. METADATA_LOGFLAGS
+   Example 1.8. METADATA_LOGFLAGS
 #define JLOG_NONE 0
 #define JLOG_INSERT 1
 #define JLOG_DELETE 2
@@ -408,7 +397,6 @@ r) last_name(str) email_address(str) datetime_created(datetime) timezone
    This means that if you want to journal INSERTS to local file
    and syslog the value should be set to 1+16=17. Or if you do not
    want to journal at all, set this to 0.
-     __________________________________________________________
 
 1.12. DB Maintaince Script : openserdbctl
 
@@ -417,7 +405,7 @@ r) last_name(str) email_address(str) datetime_created(datetime) timezone
    correctly in openserctlrc. Note Unsupported commands are-
    backup, restore, migrate, copy, serweb.
 
-   Example 1-9. openserdbctl
+   Example 1.9. openserdbctl
 usage: openserdbctl create
        openserdbctl presence
        openserdbctl extra
@@ -433,7 +421,6 @@ b.new -> db)
 tance of db; output DB_PATH/db.new)
        openserdbctl bdb newappend db datafile (appends data to a new ins
 tance of db; output DB_PATH/db.new)
-     __________________________________________________________
 
 1.13. DB Recovery : bdb_recover
 
@@ -459,7 +446,7 @@ tance of db; output DB_PATH/db.new)
    The following illustrates the four operations available to the
    administrator.
 
-   Example 1-10. bdb_recover usage
+   Example 1.10. bdb_recover usage
 usage: ./bdb_recover -s schemadir [-h home] [-c tablename]
         This will create a brand new DB file with metadata.
 
@@ -487,7 +474,6 @@ possible
 
    Important note- A corrupted DB file must be moved out of the
    way before bdb_recover is executed.
-     __________________________________________________________
 
 1.14. Known Limitations
 
@@ -495,3 +481,36 @@ possible
    sequence) mechanism. Consequently, this version does not
    support surragate keys in dbschema. These are the id columns in
    the tables.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/db_berkeley/doc/db_berkeley.sgml → modules_k/db_berkeley/doc/db_berkeley.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "db_berkeley_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_berkeley_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>

modules_k/db_flatstore/README

@@ -9,9 +9,13 @@ Edited by
 Jan Janak
 
    Copyright © 2004, 2005 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -33,10 +37,11 @@ Jan Janak
               1.5.1. flat_rotate
 
    2. Developer's Guide
+   3. Frequently Asked Questions
 
    List of Examples
-   1-1. Set "flush" parameter
-     __________________________________________________________
+
+   1.1. Set "flush" parameter
 
 Chapter 1. User's Guide
 
@@ -86,7 +91,6 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
    the complete data for a table you can simply concatenate the
    contents of files with the same table name but different
    process id.
-     __________________________________________________________
 
 1.1.1. Rotating Log Files
 
@@ -96,7 +100,6 @@ modparam("acc", "db_url", "flatstore:/var/log/acc")
    rotation itself has to be done by another application (such as
    logrotate). Follow these steps to rotate files generated by
    flatstore module:
-
      * Rename the files that you want to rotate:
 cd /var/log/acc
 mv acc_1.log acc_1.log.20050605
@@ -116,24 +119,19 @@ openserctl fifo flat_rotate
        write. It is normal that the files will be not created
        immediately if there is no traffic on the proxy server.
      * Move the renamed files somewhere else and process them.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -143,20 +141,18 @@ openserctl fifo flat_rotate
 
    Default value is 1.
 
-   Example 1-1. Set "flush" parameter
+   Example 1.1. Set "flush" parameter
 ...
 modparam("db_flatstore", "flush", 0)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
    There are no function exported to routing script.
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
-1.5.1. flat_rotate
+1.5.1.  flat_rotate
 
    It changes the name of the files where it is written.
 
@@ -167,8 +163,40 @@ modparam("db_flatstore", "flush", 0)
    MI FIFO Command Format:
                 :flat_rotate:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
    The module implements the DB API.
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/db_flatstore/doc/db_flatstore.sgml → modules_k/db_flatstore/doc/db_flatstore.xml

@@ -1,12 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "db_flatstore_user.sgml">
-<!ENTITY devel SYSTEM "db_flatstore_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_flatstore_admin.xml">
+<!ENTITY devel SYSTEM "db_flatstore_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -39,8 +41,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/db_mysql/README

@@ -2,16 +2,18 @@ mysql Module
 
 Daniel-Constantin Mierla
 
-   voice-system.ro
-
 Edited by
 
 Daniel-Constantin Mierla
 
    Copyright © 2006 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -29,11 +31,13 @@ Daniel-Constantin Mierla
         1.4. Exported Functions
         1.5. Installation
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set ping_interval parameter
-   1-2. Set timeout_interval parameter
-   1-3. Set auto_reconnect parameter
-     __________________________________________________________
+
+   1.1. Set ping_interval parameter
+   1.2. Set timeout_interval parameter
+   1.3. Set auto_reconnect parameter
 
 Chapter 1. User's Guide
 
@@ -41,25 +45,20 @@ Chapter 1. User's Guide
 
    This is a module which provides MySQL connectivity for OpenSER.
    It implements the DB API defined in OpenSER.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * libmysqlclient-dev - the development libraries of
        mysql-client.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -70,11 +69,10 @@ Chapter 1. User's Guide
 
    Default value is 300 (5 min).
 
-   Example 1-1. Set ping_interval parameter
+   Example 1.1. Set ping_interval parameter
 ...
 modparam("db_mysql", "ping_interval", 600)
 ...
-     __________________________________________________________
 
 1.3.2. timeout_interval (integer)
 
@@ -89,11 +87,10 @@ modparam("db_mysql", "ping_interval", 600)
 
    Default value is 2 (6 sec).
 
-   Example 1-2. Set timeout_interval parameter
+   Example 1.2. Set timeout_interval parameter
 ...
 modparam("db_mysql", "timeout_interval", 2)
 ...
-     __________________________________________________________
 
 1.3.3. auto_reconnect (integer)
 
@@ -102,26 +99,56 @@ modparam("db_mysql", "timeout_interval", 2)
 
    Default value is 1 (1 - on / 0 - off).
 
-   Example 1-3. Set auto_reconnect parameter
+   Example 1.3. Set auto_reconnect parameter
 ...
 modparam("auto_reconnect", "auto_reconnect", 0)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
    No function exported to be used from configuration file.
-     __________________________________________________________
 
 1.5. Installation
 
    Because it dependes on an external library, the mysql module is
    not compiled and installed by default. You can use one of the
    next options.
-
      * - edit the "Makefile" and remove "db_mysql" from
        "excluded_modules" list. Then follow the standard procedure
        to install OpenSER: "make all; make install".
      * - from command line use: 'make all
        include_modules="db_mysql"; make install
        include_modules="db_mysql"'.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/db_mysql/doc/db_mysql.sgml → modules_k/db_mysql/doc/db_mysql.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "db_mysql_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_mysql_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -18,19 +20,15 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
 		<address>
-		<email>[email protected]</email>
-		<otheraddr>
-		<ulink url="http://www.voice-system.ro">http://www.voice-system.ro</ulink>
-		</otheraddr>
+		<email>[email protected]</email>
 		</address>
 	    </author>
 	    <editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
 		<address>
-		    <email>[email protected]</email>
+		    <email>[email protected]</email>
 		</address>
 	    </editor>
 	</authorgroup>
@@ -40,8 +38,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/db_postgres/README

@@ -9,9 +9,13 @@ Edited by
 Greg Fausak
 
    Copyright © 2003 Greg Fausak
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -22,45 +26,72 @@ Greg Fausak
 
         1.3. Exported Parameters
         1.4. Exported Functions
-        1.5. Installation & Running
-     __________________________________________________________
+        1.5. Installation and Running
+
+   2. Frequently Asked Questions
 
 Chapter 1. User's Guide
 
 1.1. Overview
 
    Module description
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * PostgreSQL library - e.g., libpq5.
      * PostgreSQL devel library - to compile the module (e.g.,
        libpq-dev).
-     __________________________________________________________
 
 1.3. Exported Parameters
 
    NONE
-     __________________________________________________________
 
 1.4. Exported Functions
 
    NONE
-     __________________________________________________________
 
-1.5. Installation & Running
+1.5. Installation and Running
 
    Notes about installation and running.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/db_postgres/doc/db_postgres.sgml → modules_k/db_postgres/doc/db_postgres.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "db_postgres_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_postgres_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -37,8 +39,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/db_postgres/doc/db_postgres_user.sgml → modules_k/db_postgres/doc/db_postgres_admin.xml

@@ -59,7 +59,7 @@
 		</para>
 	</section>
 	<section>
-	<title>Installation & Running</title>
+	<title>Installation and Running</title>
 	<para>Notes about installation and running.</para>
 	</section>
 </chapter>

modules_k/db_text/README

@@ -2,16 +2,18 @@ DBTEXT Module
 
 Daniel-Constantin Mierla
 
-   voice-system.ro
-
 Edited by
 
 Daniel-Constantin Mierla
 
    Copyright © 2003, 2004 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -30,23 +32,24 @@ Daniel-Constantin Mierla
               1.3.1. db_mode (integer)
 
         1.4. Exported Functions
-        1.5. Installation & Running
+        1.5. Installation and Running
 
               1.5.1. Using dbtext with basic OpenSER configuration
 
    2. Developer's Guide
+   3. Frequently Asked Questions
 
    List of Examples
-   1-1. Sample of a dbtext table
-   1-2. Minimal OpenSER location dbtext table definition
-   1-3. Minimal OpenSER subscriber dbtext table example
-   1-4. Set db_mode parameter
-   1-5. Load the dbtext module
-   1-6. Definition of 'subscriber' table (one line)
-   1-7. Definition of 'location' and 'aliases' tables (one line)
-   1-8. Definition of 'version' table and sample records
-   1-9. Configuration file
-     __________________________________________________________
+
+   1.1. Sample of a dbtext table
+   1.2. Minimal OpenSER location dbtext table definition
+   1.3. Minimal OpenSER subscriber dbtext table example
+   1.4. Set db_mode parameter
+   1.5. Load the dbtext module
+   1.6. Definition of 'subscriber' table (one line)
+   1.7. Definition of 'location' and 'aliases' tables (one line)
+   1.8. Definition of 'version' table and sample records
+   1.9. Configuration file
 
 Chapter 1. User's Guide
 
@@ -72,12 +75,10 @@ Chapter 1. User's Guide
    write back to hard drive after changes. In this mode, the
    module checks if the corresponding file on disk has changed,
    and reloads it. The write on disk happens at openser shut down.
-     __________________________________________________________
 
 1.1.1. Design of dbtext engine
 
    The dbtext database system architecture:
-
      * a database is represented by a directory in the local file
        system. NOTE: when you use dbtext in OpenSER, the database
        URL for modules must be the path to the directory where the
@@ -89,13 +90,11 @@ Chapter 1. User's Guide
        directory.
      * a table is represented by a text file inside database
        directory.
-     __________________________________________________________
 
 1.1.2. Internal format of a dbtext table
 
    First line is the definition of the columns. Each column must
    be declared as follows:
-
      * the name of column must not include white spaces.
      * the format of a column definition is: name(type,attr).
      * between two column definitions must be a white space, e.g.,
@@ -120,7 +119,7 @@ Chapter 1. User's Guide
        "\t", ":".
      * 0 -- the zero value must be escaped too.
 
-   Example 1-1. Sample of a dbtext table
+   Example 1.1. Sample of a dbtext table
 ...
 id(int,auto) name(str) flag(double) desc(str,null)
 1:nick:0.34:a\tgood\: friend
@@ -128,17 +127,16 @@ id(int,auto) name(str) flag(double) desc(str,null)
 3:bob:2.50:
 ...
 
-   Example 1-2. Minimal OpenSER location dbtext table definition
+   Example 1.2. Minimal OpenSER location dbtext table definition
 ...
 username(str) contact(str) expires(int) q(double) callid(str) cseq(int)
 ...
 
-   Example 1-3. Minimal OpenSER subscriber dbtext table example
+   Example 1.3. Minimal OpenSER subscriber dbtext table example
 ...
 username(str) password(str) ha1(str) domain(str) ha1b(str)
 suser:supasswd:xxx:alpha.org:xxx
 ...
-     __________________________________________________________
 
 1.1.3. Existing limitations
 
@@ -146,29 +144,23 @@ suser:supasswd:xxx:alpha.org:xxx
    default values. All such values specified in the database
    template are ignored. So its advisable to specify all data for
    a column at insertion operations.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER modules
 
    The next modules must be loaded before this module:
-
      * none.
-     __________________________________________________________
 
 1.2.2. External libraries or applications
 
    The next libraries or applications must be installed before
    running OpenSER with this module:
-
      * none.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
    None.
-     __________________________________________________________
 
 1.3.1. db_mode (integer)
 
@@ -180,18 +172,16 @@ suser:supasswd:xxx:alpha.org:xxx
 
    Default value is "0".
 
-   Example 1-4. Set db_mode parameter
+   Example 1.4. Set db_mode parameter
 ...
 modparam("db_text", "db_mode", 1)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
    None.
-     __________________________________________________________
 
-1.5. Installation & Running
+1.5. Installation and Running
 
    Compile the module and load it instead of mysql or other DB
    modules.
@@ -204,14 +194,13 @@ modparam("db_text", "db_mode", 1)
    database path. So, either you provide an absolute path to
    database directory or a relative one to "CFG_DIR" directory.
 
-   Example 1-5. Load the dbtext module
+   Example 1.5. Load the dbtext module
 ...
 loadmodule "/path/to/openser/modules/db_text.so"
 ...
 modparam("module_name", "database_URL", "text:///path/to/dbtext/database
 ")
 ...
-     __________________________________________________________
 
 1.5.1. Using dbtext with basic OpenSER configuration
 
@@ -225,7 +214,7 @@ modparam("module_name", "database_URL", "text:///path/to/dbtext/database
    configuration file, the table files must be placed in the
    '/tmp/serdb' directory.
 
-   Example 1-6. Definition of 'subscriber' table (one line)
+   Example 1.6. Definition of 'subscriber' table (one line)
 ...
 username(str) domain(str) password(str) first_name(str) last_name(str) p
 hone(str) email_address(str) datetime_created(int) datetime_modified(int
@@ -234,7 +223,7 @@ r) ha1b(str) perms(str) allow_find(str) timezone(str,null) rpid(str,null
 )
 ...
 
-   Example 1-7. Definition of 'location' and 'aliases' tables (one
+   Example 1.7. Definition of 'location' and 'aliases' tables (one
    line)
 ...
 username(str) domain(str,null) contact(str,null) received(str) expires(i
@@ -242,7 +231,7 @@ nt,null) q(double,null) callid(str,null) cseq(int,null) last_modified(st
 r) flags(int) user_agent(str) socket(str)
 ...
 
-   Example 1-8. Definition of 'version' table and sample records
+   Example 1.8. Definition of 'version' table and sample records
 ...
 table_name(str) table_version(int)
 subscriber:3
@@ -250,7 +239,7 @@ location:6
 aliases:6
 ...
 
-   Example 1-9. Configuration file
+   Example 1.9. Configuration file
 ...
 #
 # $Id$
@@ -394,9 +383,41 @@ route[1]
 
 
 ...
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
    Once you have the module loaded, you can use the API specified
    by OpenSER DB interface.
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/db_text/doc/db_text.sgml → modules_k/db_text/doc/db_text.xml

@@ -1,15 +1,15 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "db_text_user.sgml">
-<!ENTITY devel SYSTEM "db_text_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_text_admin.xml">
+<!ENTITY devel SYSTEM "db_text_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!ENTITY dbtextsercfg SYSTEM "db_text.cfg">
 
-<!ENTITY developeremail "[email protected]">
-
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -22,16 +22,15 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
 		<address>
-		<email>&developeremail;</email>
+		<email>[email protected]</email>
 		</address>
 	    </author>
 	    <editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
 		<address>
-		<email>&developeremail;</email>
+		<email>[email protected]</email>
 		</address>
 	    </editor>
 	</authorgroup>
@@ -42,8 +41,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/db_text/doc/db_text_user.sgml → modules_k/db_text/doc/db_text_admin.xml

@@ -264,7 +264,7 @@ modparam("db_text", "db_mode", 1)
 	   	</para>
 	</section>
 	<section>
-		<title>Installation & Running</title>
+		<title>Installation and Running</title>
 		<para>
 		Compile the module and load it instead of mysql or other DB modules.
 		</para>

modules_k/db_unixodbc/README

@@ -9,9 +9,13 @@ Edited by
 Marco Lorrai
 
    Copyright © 2005, 2006 Marco Lorrai
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -27,18 +31,19 @@ Marco Lorrai
               1.3.3. use_escape_common (int)
 
         1.4. Exported Functions
-        1.5. Installation & Running
+        1.5. Installation and Running
 
               1.5.1. Installing
-              1.5.2. Configuring & Running
+              1.5.2. Configuring and Running
 
    2. Developer's Guide
+   3. Frequently Asked Questions
 
    List of Examples
-   1-1. Set the "ping_interval" parameter
-   1-2. Set the "auto_reconnect" parameter
-   1-3. Set the "use_escape_common" parameter
-     __________________________________________________________
+
+   1.1. Set the "ping_interval" parameter
+   1.2. Set the "auto_reconnect" parameter
+   1.3. Set the "use_escape_common" parameter
 
 Chapter 1. User's Guide
 
@@ -53,24 +58,19 @@ Chapter 1. User's Guide
 
    To see what DB engines can be used via unixodbc, look at
    http://www.unixodbc.org/drivers.html.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -80,11 +80,10 @@ Chapter 1. User's Guide
 
    Default value is "300" seconds.
 
-   Example 1-1. Set the "ping_interval" parameter
+   Example 1.1. Set the "ping_interval" parameter
 ...
 modparam("db_unixodbc", "ping_interval", 600)
 ...
-     __________________________________________________________
 
 1.3.2. auto_reconnect (int)
 
@@ -92,11 +91,10 @@ modparam("db_unixodbc", "ping_interval", 600)
 
    Default value is "1", this means it is enabled.
 
-   Example 1-2. Set the "auto_reconnect" parameter
+   Example 1.2. Set the "auto_reconnect" parameter
 ...
 modparam("db_unixodbc", "auto_reconnect", 0)
 ...
-     __________________________________________________________
 
 1.3.3. use_escape_common (int)
 
@@ -111,18 +109,16 @@ modparam("db_unixodbc", "auto_reconnect", 0)
 
    Default value is "0" (0 = disabled; 1 = enabled).
 
-   Example 1-3. Set the "use_escape_common" parameter
+   Example 1.3. Set the "use_escape_common" parameter
 ...
 modparam("db_unixodbc", "use_escape_common", 1)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
    NONE
-     __________________________________________________________
 
-1.5. Installation & Running
+1.5. Installation and Running
 
 1.5.1. Installing
 
@@ -130,9 +126,8 @@ modparam("db_unixodbc", "use_escape_common", 1)
    program that implements the odbc standard, such iodbc), your
    database, and the right connector. Set the DSN in the odbc.ini
    file and the connector drivers in the odbcinst.ini file.
-     __________________________________________________________
 
-1.5.2. Configuring & Running
+1.5.2. Configuring and Running
 
    In the openser.conf file, add the line:
 ....
@@ -163,9 +158,41 @@ shell>safe_mysqld --user=mysql --socket=/var/lib/mysql/mysql.sock
 
    The connector search the socket in /var/lib/mysql/mysql.sock
    and not in /tmp/mysql.sock
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
    The module implements the OpenSER DB API, in order to be used
    by other modules.
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/db_unixodbc/doc/db_unixodbc.sgml → modules_k/db_unixodbc/doc/db_unixodbc.xml

@@ -1,12 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "db_unixodbc_user.sgml">
-<!ENTITY devel SYSTEM "db_unixodbc_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "db_unixodbc_admin.xml">
+<!ENTITY devel SYSTEM "db_unixodbc_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -39,8 +41,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/db_unixodbc/doc/db_unixodbc_user.sgml → modules_k/db_unixodbc/doc/db_unixodbc_admin.xml

@@ -132,7 +132,7 @@ modparam("db_unixodbc", "use_escape_common", 1)
 	</section>
 
 	<section>
-	<title>Installation & Running</title>
+	<title>Installation and Running</title>
 
 	<section>
 	<title>Installing</title>
@@ -145,7 +145,7 @@ modparam("db_unixodbc", "use_escape_common", 1)
 	</section>
 
 	<section>
-	<title>Configuring & Running</title>
+	<title>Configuring and Running</title>
 	<para>
 	In the openser.conf file, add the line:
 	</para>

modules_k/dialog/README

@@ -9,9 +9,13 @@ Edited by
 Bogdan-Andrei Iancu
 
    Copyright © 2006 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2006-04-14 14:00:10 +0300
+                             (Fri, 14 Apr 2006) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -83,37 +87,37 @@ Bogdan-Andrei Iancu
    3. Frequently Asked Questions
 
    List of Examples
-   1-1. Set enable_stats parameter
-   1-2. Set hash_size parameter
-   1-3. Set rr_param parameter
-   1-4. Set dlg_flag parameter
-   1-5. Set timeout_avp parameter
-   1-6. Set default_timeout parameter
-   1-7. Set dlf_extra_hdrs parameter
-   1-8. Set dlg_match_mode parameter
-   1-9. Set db_url parameter
-   1-10. Set db_mode parameter
-   1-11. Set db_update_period parameter
-   1-12. Set table_name parameter
-   1-13. Set callid_column parameter
-   1-14. Set from_uri_column parameter
-   1-15. Set from_tag_column parameter
-   1-16. Set to_uri_column parameter
-   1-17. Set to_tag_column parameter
-   1-18. Set caller_cseq_column parameter
-   1-19. Set callee_cseq_column parameter
-   1-20. Set caller_route_column parameter
-   1-21. Set to_route_column parameter
-   1-22. Set caller_contact_column parameter
-   1-23. Set callee_contact_column parameter
-   1-24. Set caller_sock_column parameter
-   1-25. Set callee_sock_column parameter
-   1-26. Set h_id_column parameter
-   1-27. Set h_entry_column parameter
-   1-28. Set state_column parameter
-   1-29. Set start_time_column parameter
-   1-30. Set timeout_column parameter
-     __________________________________________________________
+
+   1.1. Set enable_stats parameter
+   1.2. Set hash_size parameter
+   1.3. Set rr_param parameter
+   1.4. Set dlg_flag parameter
+   1.5. Set timeout_avp parameter
+   1.6. Set default_timeout parameter
+   1.7. Set dlf_extra_hdrs parameter
+   1.8. Set dlg_match_mode parameter
+   1.9. Set db_url parameter
+   1.10. Set db_mode parameter
+   1.11. Set db_update_period parameter
+   1.12. Set table_name parameter
+   1.13. Set callid_column parameter
+   1.14. Set from_uri_column parameter
+   1.15. Set from_tag_column parameter
+   1.16. Set to_uri_column parameter
+   1.17. Set to_tag_column parameter
+   1.18. Set caller_cseq_column parameter
+   1.19. Set callee_cseq_column parameter
+   1.20. Set caller_route_column parameter
+   1.21. Set to_route_column parameter
+   1.22. Set caller_contact_column parameter
+   1.23. Set callee_contact_column parameter
+   1.24. Set caller_sock_column parameter
+   1.25. Set callee_sock_column parameter
+   1.26. Set h_id_column parameter
+   1.27. Set h_entry_column parameter
+   1.28. Set state_column parameter
+   1.29. Set start_time_column parameter
+   1.30. Set timeout_column parameter
 
 Chapter 1. User's Guide
 
@@ -128,38 +132,33 @@ Chapter 1. User's Guide
    The module, via an internal API, also provide the foundation to
    build on top of it more complex dialog-based functionalities
    via other OpenSER modules.
-     __________________________________________________________
 
 1.2. How it works
 
    To create the dialog associated to an initial request, the flag
-   "dlg_flag" (Section 1.4.4) must be set before creating the
-   corresponding transaction.
+   "dlg_flag" (Section 1.4.4, "dlg_flag (integer)") must be set
+   before creating the corresponding transaction.
 
    The dialog is automatically destroyed when a "BYE" is received.
    In case of no "BYE", the dialog lifetime is controlled via the
-   default timeout (see "default_timeout" - Section 1.4.6) and
-   custom timeout (see "timeout_avp" - Section 1.4.5). The dialog
-   timeout is reset each time a sequential request passes.
-     __________________________________________________________
+   default timeout (see "default_timeout" - Section 1.4.6,
+   "default_timeout (integer)") and custom timeout (see
+   "timeout_avp" - Section 1.4.5, "timeout_avp (string)"). The
+   dialog timeout is reset each time a sequential request passes.
 
 1.3. Dependencies
 
 1.3.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * TM - Transaction module
      * RR - Record-Route module
-     __________________________________________________________
 
 1.3.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.4. Exported Parameters
 
@@ -172,11 +171,10 @@ Chapter 1. User's Guide
 
    Default value is "1 (enabled)".
 
-   Example 1-1. Set enable_stats parameter
+   Example 1.1. Set enable_stats parameter
 ...
 modparam("dialog", "enable_stats", 0)
 ...
-     __________________________________________________________
 
 1.4.2. hash_size (integer)
 
@@ -192,11 +190,10 @@ modparam("dialog", "enable_stats", 0)
 
    Default value is "4096".
 
-   Example 1-2. Set hash_size parameter
+   Example 1.2. Set hash_size parameter
 ...
 modparam("dialog", "hash_size", 1024)
 ...
-     __________________________________________________________
 
 1.4.3. rr_param (string)
 
@@ -206,11 +203,10 @@ modparam("dialog", "hash_size", 1024)
 
    Default value is "did".
 
-   Example 1-3. Set rr_param parameter
+   Example 1.3. Set rr_param parameter
 ...
 modparam("dialog", "rr_param", "xyz")
 ...
-     __________________________________________________________
 
 1.4.4. dlg_flag (integer)
 
@@ -219,11 +215,10 @@ modparam("dialog", "rr_param", "xyz")
 
    Default value is "none".
 
-   Example 1-4. Set dlg_flag parameter
+   Example 1.4. Set dlg_flag parameter
 ...
 modparam("dialog", "dlg_flag", 4)
 ...
-     __________________________________________________________
 
 1.4.5. timeout_avp (string)
 
@@ -233,11 +228,10 @@ modparam("dialog", "dlg_flag", 4)
 
    Default value is "none".
 
-   Example 1-5. Set timeout_avp parameter
+   Example 1.5. Set timeout_avp parameter
 ...
 modparam("dialog", "timeout_avp", "$avp(i:10)")
 ...
-     __________________________________________________________
 
 1.4.6. default_timeout (integer)
 
@@ -246,11 +240,10 @@ modparam("dialog", "timeout_avp", "$avp(i:10)")
 
    Default value is "43200 (12 hours)".
 
-   Example 1-6. Set default_timeout parameter
+   Example 1.6. Set default_timeout parameter
 ...
 modparam("dialog", "default_timeout", 21600)
 ...
-     __________________________________________________________
 
 1.4.7. dlg_extra_hdrs (string)
 
@@ -260,11 +253,10 @@ modparam("dialog", "default_timeout", 21600)
 
    Default value is "NULL".
 
-   Example 1-7. Set dlf_extra_hdrs parameter
+   Example 1.7. Set dlf_extra_hdrs parameter
 ...
 modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
 ...
-     __________________________________________________________
 
 1.4.8. dlg_match_mode (integer)
 
@@ -274,7 +266,6 @@ modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
    matching based on SIP elements (as in RFC3261).
 
    The supported modes are:
-
      * 0 - DID_ONLY - the match is done exclusivly based on DID;
      * 1 - DID_FALLBACK - the match is first tried based on DID
        and if not present, it will fallback to SIP matching;
@@ -283,11 +274,10 @@ modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
 
    Default value is "0 (DID_ONLY)".
 
-   Example 1-8. Set dlg_match_mode parameter
+   Example 1.8. Set dlg_match_mode parameter
 ...
 modparam("dialog", "dlg_match_mode", 1)
 ...
-     __________________________________________________________
 
 1.4.9. db_url (string)
 
@@ -296,12 +286,11 @@ modparam("dialog", "dlg_match_mode", 1)
 
    Default value is "mysql://openser:openserrw@localhost/openser".
 
-   Example 1-9. Set db_url parameter
+   Example 1.9. Set db_url parameter
 ...
 modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname
 ")
 ...
-     __________________________________________________________
 
 1.4.10. db_mode (integer)
 
@@ -309,7 +298,6 @@ modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname
    memory.
 
    The supported modes are:
-
      * 0 - NO_DB - the memory content is not flushed into DB;
      * 1 - REALTIME - any dialog information changes will be
        reflected into the database immediatly.
@@ -318,11 +306,10 @@ modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname
 
    Default value is "0".
 
-   Example 1-10. Set db_mode parameter
+   Example 1.10. Set db_mode parameter
 ...
 modparam("dialog", "db_mode", 1)
 ...
-     __________________________________________________________
 
 1.4.11. db_update_period (integer)
 
@@ -333,11 +320,10 @@ modparam("dialog", "db_mode", 1)
 
    Default value is "60".
 
-   Example 1-11. Set db_update_period parameter
+   Example 1.11. Set db_update_period parameter
 ...
 modparam("dialog", "db_update_period", "120")
 ...
-     __________________________________________________________
 
 1.4.12. table_name (string)
 
@@ -346,11 +332,10 @@ modparam("dialog", "db_update_period", "120")
 
    Default value is "dialog".
 
-   Example 1-12. Set table_name parameter
+   Example 1.12. Set table_name parameter
 ...
 modparam("dialog", "table_name", "my_dialog")
 ...
-     __________________________________________________________
 
 1.4.13. callid_column (string)
 
@@ -358,11 +343,10 @@ modparam("dialog", "table_name", "my_dialog")
 
    Default value is "callid".
 
-   Example 1-13. Set callid_column parameter
+   Example 1.13. Set callid_column parameter
 ...
 modparam("dialog", "callid_column", "callid_c_name")
 ...
-     __________________________________________________________
 
 1.4.14. from_uri_column (string)
 
@@ -371,11 +355,10 @@ modparam("dialog", "callid_column", "callid_c_name")
 
    Default value is "from_uri".
 
-   Example 1-14. Set from_uri_column parameter
+   Example 1.14. Set from_uri_column parameter
 ...
 modparam("dialog", "from_uri_column", "from_uri_c_name")
 ...
-     __________________________________________________________
 
 1.4.15. from_tag_column (string)
 
@@ -384,11 +367,10 @@ modparam("dialog", "from_uri_column", "from_uri_c_name")
 
    Default value is "from_tag".
 
-   Example 1-15. Set from_tag_column parameter
+   Example 1.15. Set from_tag_column parameter
 ...
 modparam("dialog", "from_tag_column", "from_tag_c_name")
 ...
-     __________________________________________________________
 
 1.4.16. to_uri_column (string)
 
@@ -397,11 +379,10 @@ modparam("dialog", "from_tag_column", "from_tag_c_name")
 
    Default value is "to_uri".
 
-   Example 1-16. Set to_uri_column parameter
+   Example 1.16. Set to_uri_column parameter
 ...
 modparam("dialog", "to_uri_column", "to_uri_c_name")
 ...
-     __________________________________________________________
 
 1.4.17. to_tag_column (string)
 
@@ -410,11 +391,10 @@ modparam("dialog", "to_uri_column", "to_uri_c_name")
 
    Default value is "to_tag".
 
-   Example 1-17. Set to_tag_column parameter
+   Example 1.17. Set to_tag_column parameter
 ...
 modparam("dialog", "to_tag_column", "to_tag_c_name")
 ...
-     __________________________________________________________
 
 1.4.18. caller_cseq_column (string)
 
@@ -423,11 +403,10 @@ modparam("dialog", "to_tag_column", "to_tag_c_name")
 
    Default value is "caller_cseq".
 
-   Example 1-18. Set caller_cseq_column parameter
+   Example 1.18. Set caller_cseq_column parameter
 ...
 modparam("dialog", "caller_cseq_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.19. callee_cseq_column (string)
 
@@ -436,11 +415,10 @@ modparam("dialog", "caller_cseq_column", "column_name")
 
    Default value is "callee_cseq".
 
-   Example 1-19. Set callee_cseq_column parameter
+   Example 1.19. Set callee_cseq_column parameter
 ...
 modparam("dialog", "callee_cseq_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.20. caller_route_column (string)
 
@@ -449,11 +427,10 @@ modparam("dialog", "callee_cseq_column", "column_name")
 
    Default value is "caller_route_set".
 
-   Example 1-20. Set caller_route_column parameter
+   Example 1.20. Set caller_route_column parameter
 ...
 modparam("dialog", "caller_route_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.21. callee_route_column (string)
 
@@ -462,11 +439,10 @@ modparam("dialog", "caller_route_column", "column_name")
 
    Default value is "callee_route_set".
 
-   Example 1-21. Set to_route_column parameter
+   Example 1.21. Set to_route_column parameter
 ...
 modparam("dialog", "to_route_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.22. caller_contact_column (string)
 
@@ -475,11 +451,10 @@ modparam("dialog", "to_route_column", "column_name")
 
    Default value is "from_contact".
 
-   Example 1-22. Set caller_contact_column parameter
+   Example 1.22. Set caller_contact_column parameter
 ...
 modparam("dialog", "caller_contact_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.23. callee_contact_column (string)
 
@@ -488,11 +463,10 @@ modparam("dialog", "caller_contact_column", "column_name")
 
    Default value is "callee_contact".
 
-   Example 1-23. Set callee_contact_column parameter
+   Example 1.23. Set callee_contact_column parameter
 ...
 modparam("dialog", "callee_contact_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.24. caller_sock_column (string)
 
@@ -501,11 +475,10 @@ modparam("dialog", "callee_contact_column", "column_name")
 
    Default value is "caller_sock".
 
-   Example 1-24. Set caller_sock_column parameter
+   Example 1.24. Set caller_sock_column parameter
 ...
 modparam("dialog", "caller_sock_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.25. callee_sock_column (string)
 
@@ -514,11 +487,10 @@ modparam("dialog", "caller_sock_column", "column_name")
 
    Default value is "callee_contact".
 
-   Example 1-25. Set callee_sock_column parameter
+   Example 1.25. Set callee_sock_column parameter
 ...
 modparam("dialog", "callee_sock_column", "column_name")
 ...
-     __________________________________________________________
 
 1.4.26. h_id_column (string)
 
@@ -527,11 +499,10 @@ modparam("dialog", "callee_sock_column", "column_name")
 
    Default value is "hash_id".
 
-   Example 1-26. Set h_id_column parameter
+   Example 1.26. Set h_id_column parameter
 ...
 modparam("dialog", "h_id_column", "hash_id_c_name")
 ...
-     __________________________________________________________
 
 1.4.27. h_entry_column (string)
 
@@ -540,11 +511,10 @@ modparam("dialog", "h_id_column", "hash_id_c_name")
 
    Default value is "hash_entry".
 
-   Example 1-27. Set h_entry_column parameter
+   Example 1.27. Set h_entry_column parameter
 ...
 modparam("dialog", "h_entry_column", "h_entry_c_name")
 ...
-     __________________________________________________________
 
 1.4.28. state_column (string)
 
@@ -553,11 +523,10 @@ modparam("dialog", "h_entry_column", "h_entry_c_name")
 
    Default value is "state".
 
-   Example 1-28. Set state_column parameter
+   Example 1.28. Set state_column parameter
 ...
 modparam("dialog", "state_column", "state_c_name")
 ...
-     __________________________________________________________
 
 1.4.29. start_time_column (string)
 
@@ -566,11 +535,10 @@ modparam("dialog", "state_column", "state_c_name")
 
    Default value is "start_time".
 
-   Example 1-29. Set start_time_column parameter
+   Example 1.29. Set start_time_column parameter
 ...
 modparam("dialog", "start_time_column", "start_time_c_name")
 ...
-     __________________________________________________________
 
 1.4.30. timeout_column (string)
 
@@ -579,16 +547,14 @@ modparam("dialog", "start_time_column", "start_time_c_name")
 
    Default value is "timeout".
 
-   Example 1-30. Set timeout_column parameter
+   Example 1.30. Set timeout_column parameter
 ...
 modparam("dialog", "timeout_column", "timeout_c_name")
 ...
-     __________________________________________________________
 
 1.5. Exported Functions
 
    There are no exported functions that could be used in scripts.
-     __________________________________________________________
 
 1.6. Exported statistics
 
@@ -596,28 +562,23 @@ modparam("dialog", "timeout_column", "timeout_c_name")
 
    Returns the number of current active dialogs (may be confirmed
    or not).
-     __________________________________________________________
 
 1.6.2. early_dialogs
 
    Returns the number of early dialogs.
-     __________________________________________________________
 
 1.6.3. processed_dialogs
 
    Returns the total number of processed dialogs (terminated,
    expired or active) from the startup.
-     __________________________________________________________
 
 1.6.4. expired_dialogs
 
    Returns the total number of expired dialogs from the startup.
-     __________________________________________________________
 
 1.6.5. failed_dialogs
 
    Returns the number of failed dialogs.
-     __________________________________________________________
 
 1.7. Exported MI Functions
 
@@ -632,7 +593,6 @@ modparam("dialog", "timeout_column", "timeout_c_name")
    MI FIFO Command Format:
                 :dlg_list:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
 1.7.2. dlg_end_dlg
 
@@ -641,7 +601,6 @@ modparam("dialog", "timeout_column", "timeout_c_name")
    Name: dlg_end_dlg
 
    Parameters:
-
      * h_entry - hash entry of the dialog in the internal dialog
        table
      * h_id - hash id of the dialog on the hash entry
@@ -656,7 +615,6 @@ modparam("dialog", "timeout_column", "timeout_c_name")
                 342
                 56
                 _empty_line_
-     __________________________________________________________
 
 1.8. Exported pseudo-variables
 
@@ -664,7 +622,6 @@ modparam("dialog", "timeout_column", "timeout_c_name")
 
    Returns the number of current active dialogs (may be confirmed
    or not).
-     __________________________________________________________
 
 1.8.2. $DLG_status
 
@@ -673,12 +630,10 @@ modparam("dialog", "timeout_column", "timeout_c_name")
    sequential requests, after doing loose_route().
 
    Value may be:
-
      * NULL - Dialog not found.
      * 3 - Confirmed by a final reply but no ACK received yet.
      * 4 - Confirmed by a final reply and ACK received.
      * 5 - Dialog ended.
-     __________________________________________________________
 
 1.8.3. $DLG_lifetime
 
@@ -689,18 +644,16 @@ modparam("dialog", "timeout_column", "timeout_c_name")
    loose_route().
 
    NULL will be returned if there is no dialog for the request.
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
 2.1. Available Functions
 
-2.1.1. register_dlgcb (dialog, type, cb, param)
+2.1.1.  register_dlgcb (dialog, type, cb, param)
 
    Register a new callback to the dialog.
 
    Meaning of the parameters is as follows:
-
      * struct dlg_cell* dlg - dialog to register callback to. If
        maybe NULL only for DLG_CREATED callback type, which is not
        a per dialog type.
@@ -724,43 +677,44 @@ Chapter 2. Developer's Guide
        sip_msg* msg, void** param);"
      * void *param - parameter to be passed to the callback
        function.
-     __________________________________________________________
 
 Chapter 3. Frequently Asked Questions
 
-   3.1. What happend with "use_tight_match" parameter?
-   3.2. Where can I find more about OpenSER?
-   3.3. Where can I post a question about this module?
-   3.4. How can I report a bug?
+   3.1.
+
+       What happend with "use_tight_match" parameter?
+
+       The parameter was removed with version 1.3 as the option of
+       tight matching became mandatory and not configurable. Now, the
+       tight matching is done all the time (when using DID matching).
 
-   3.1. What happend with "use_tight_match" parameter?
+   3.2.
 
-   The parameter was removed with version 1.3 as the option of
-   tight matching became mandatory and not configurable. Now, the
-   tight matching is done all the time (when using DID matching).
+       Where can I find more about OpenSER?
 
-   3.2. Where can I find more about OpenSER?
+       Take a look at http://openser.org/.
 
-   Take a look at http://openser.org/.
+   3.3.
 
-   3.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:
+       First at all check if your question was already answered on one
+       of our mailing lists:
+         * User Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
 
-     * User Mailing List -
-       http://openser.org/cgi-bin/mailman/listinfo/users
-     * Developer Mailing List -
-       http://openser.org/cgi-bin/mailman/listinfo/devel
+       E-mails regarding any stable OpenSER release should be sent to
+       <[email protected]> and e-mails regarding development versions
+       should be sent to <[email protected]>.
 
-   E-mails regarding any stable OpenSER 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]>.
+   3.4.
 
-   3.4. How can I report a bug?
+       How can I report a bug?
 
-   Please follow the guidelines provided at:
-   http://sourceforge.net/tracker/?group_id=139143.
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/dialog/doc/dialog.sgml → modules_k/dialog/doc/dialog.xml

@@ -1,12 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "dialog_user.sgml">
-<!ENTITY devel SYSTEM "dialog_devel.sgml">
-<!ENTITY faq SYSTEM "dialog_faq.sgml">
+<!ENTITY user SYSTEM "dialog_admin.xml">
+<!ENTITY devel SYSTEM "dialog_devel.xml">
+<!ENTITY faq SYSTEM "dialog_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -38,8 +40,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 806 $</revnumber>
+		<date>$Date: 2006-04-14 14:00:10 +0300 (Fri, 14 Apr 2006) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/dialog/doc/dialog_user.sgml → modules_k/dialog/doc/dialog_admin.xml

@@ -23,15 +23,15 @@
 	<title>How it works</title>
 	<para>
 	To create the dialog associated to an initial request, the flag 
-	<quote>dlg_flag</quote> (<xref linkend="dlg-flag-id">) must be set before
+	<quote>dlg_flag</quote> (<xref linkend="dlg-flag-id"/>) must be set before
 	creating the corresponding transaction.
 	</para>
 	<para>
 	The dialog is automatically destroyed when a <quote>BYE</quote> is 
 	received. In case of no <quote>BYE</quote>, the dialog lifetime is 
 	controlled via the default timeout (see <quote>default_timeout</quote>
-	 - <xref linkend="default-timeout-id">) and custom timeout (see 
-	 <quote>timeout_avp</quote> - <xref linkend="timeout-avp-id">). The 
+	- <xref linkend="default-timeout-id"/>) and custom timeout (see 
+	<quote>timeout_avp</quote> - <xref linkend="timeout-avp-id"/>). The 
 	dialog timeout is reset each time a sequential request passes.
 	</para>
 	</section>
@@ -290,7 +290,7 @@ modparam("dialog", "dlg_match_mode", 1)
 		<title>Set <varname>db_url</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
-modparam("dialog", "db_url", "&exampledb")
+modparam("dialog", "db_url", "&exampledb;")
 ...
 </programlisting>
 		</example>

modules_k/dispatcher/README

@@ -2,20 +2,26 @@ DISPATCHER Module
 
 Daniel-Constantin Mierla
 
-   voice-system.ro
-
 Edited by
 
 Daniel-Constantin Mierla
 
+Edited by
+
 Carsten Bock
 
+   BASIS AudioNet GmbH
+
    Copyright © 2004 FhG FOKUS
 
    Copyright © 2005 Voice-System.RO
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -69,28 +75,28 @@ Carsten Bock
    2. Frequently Asked Questions
 
    List of Examples
-   1-1. Set the "list_file" parameter
-   1-2. Set "db_url" parameter
-   1-3. Set "table_name" parameter
-   1-4. Set "setid_col" parameter
-   1-5. Set "destination_col" parameter
-   1-6. Set "flags_col" parameter
-   1-7. Set the "force_dst" parameter
-   1-8. Set the "flags" parameter
-   1-9. Set the "use_default" parameter
-   1-10. Set the "dst_avp" parameter
-   1-11. Set the "grp_avp" parameter
-   1-12. Set the "cnt_avp" parameter
-   1-13. Use $avp(i:273) for hashing:
-   1-14. Use combination of PVs for hashing:
-   1-15. Set the "ds_ping_method" parameter
-   1-16. Set the "ds_ping_from" parameter
-   1-17. Set the "ds_ping_interval" parameter
-   1-18. Set the "ds_probing_threshhold" parameter
-   1-19. ds_select_dst usage
-   1-20. dispatcher list file
-   1-21. OpenSER config script - sample dispatcher usage
-     __________________________________________________________
+
+   1.1. Set the "list_file" parameter
+   1.2. Set "db_url" parameter
+   1.3. Set "table_name" parameter
+   1.4. Set "setid_col" parameter
+   1.5. Set "destination_col" parameter
+   1.6. Set "flags_col" parameter
+   1.7. Set the "force_dst" parameter
+   1.8. Set the "flags" parameter
+   1.9. Set the "use_default" parameter
+   1.10. Set the "dst_avp" parameter
+   1.11. Set the "grp_avp" parameter
+   1.12. Set the "cnt_avp" parameter
+   1.13. Use $avp(i:273) for hashing:
+   1.14. Use combination of PVs for hashing:
+   1.15. Set the "ds_ping_method" parameter
+   1.16. Set the "ds_ping_from" parameter
+   1.17. Set the "ds_ping_interval" parameter
+   1.18. Set the "ds_probing_threshhold" parameter
+   1.19. ds_select_dst usage
+   1.20. dispatcher list file
+   1.21. OpenSER config script - sample dispatcher usage
 
 Chapter 1. User's Guide
 
@@ -103,24 +109,19 @@ Chapter 1. User's Guide
 
    The module can be used as a stateless load balancer, having no
    guarantee of fair distribution.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER modules
 
    The following modules must be loaded before this module:
-
      * TM - only if active recovery of failed hosts is required.
-     __________________________________________________________
 
 1.2.2. External libraries or applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module:
-
      * none.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -131,11 +132,10 @@ Chapter 1. User's Guide
    Default value is "/etc/openser/dispatcher.list" or
    "/usr/local/etc/openser/dispatcher.list".
 
-   Example 1-1. Set the "list_file" parameter
+   Example 1.1. Set the "list_file" parameter
 ...
 modparam("dispatcher", "list_file", "/var/run/openser/dispatcher.list")
 ...
-     __________________________________________________________
 
 1.3.2. db_url (string)
 
@@ -144,12 +144,11 @@ modparam("dispatcher", "list_file", "/var/run/openser/dispatcher.list")
 
    Default value is "NULL" (disable DB support).
 
-   Example 1-2. Set "db_url" parameter
+   Example 1.2. Set "db_url" parameter
 ...
 modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database
 ")
 ...
-     __________________________________________________________
 
 1.3.3. table_name (string)
 
@@ -158,11 +157,10 @@ modparam("dispatcher", "db_url", "mysql://user:passwb@localhost/database
 
    Default value is "dispatcher".
 
-   Example 1-3. Set "table_name" parameter
+   Example 1.3. Set "table_name" parameter
 ...
 modparam("dispatcher", "table_name", "my_dispatcher")
 ...
-     __________________________________________________________
 
 1.3.4. setid_col (string)
 
@@ -171,11 +169,10 @@ modparam("dispatcher", "table_name", "my_dispatcher")
 
    Default value is "setid".
 
-   Example 1-4. Set "setid_col" parameter
+   Example 1.4. Set "setid_col" parameter
 ...
 modparam("dispatcher", "setid_col", "groupid")
 ...
-     __________________________________________________________
 
 1.3.5. destination_col (string)
 
@@ -184,11 +181,10 @@ modparam("dispatcher", "setid_col", "groupid")
 
    Default value is "destination".
 
-   Example 1-5. Set "destination_col" parameter
+   Example 1.5. Set "destination_col" parameter
 ...
 modparam("dispatcher", "destination_col", "uri")
 ...
-     __________________________________________________________
 
 1.3.6. flags_col (string)
 
@@ -197,11 +193,10 @@ modparam("dispatcher", "destination_col", "uri")
 
    Default value is "flags".
 
-   Example 1-6. Set "flags_col" parameter
+   Example 1.6. Set "flags_col" parameter
 ...
 modparam("dispatcher", "flags_col", "dstflags")
 ...
-     __________________________________________________________
 
 1.3.7. force_dst (int)
 
@@ -210,11 +205,10 @@ modparam("dispatcher", "flags_col", "dstflags")
 
    Default value is "0".
 
-   Example 1-7. Set the "force_dst" parameter
+   Example 1.7. Set the "force_dst" parameter
 ...
 modparam("dispatcher", "force_dst", 1)
 ...
-     __________________________________________________________
 
 1.3.8. flags (int)
 
@@ -232,11 +226,10 @@ modparam("dispatcher", "force_dst", 1)
 
    Default value is "0".
 
-   Example 1-8. Set the "flags" parameter
+   Example 1.8. Set the "flags" parameter
  ...
  modparam("dispatcher", "flags", 3)
  ...
-     __________________________________________________________
 
 1.3.9. use_default (int)
 
@@ -247,11 +240,10 @@ modparam("dispatcher", "force_dst", 1)
 
    Default value is "0".
 
-   Example 1-9. Set the "use_default" parameter
+   Example 1.9. Set the "use_default" parameter
  ...
  modparam("dispatcher", "use_default", 1)
  ...
-     __________________________________________________________
 
 1.3.10. dst_avp (str)
 
@@ -263,76 +255,72 @@ modparam("dispatcher", "force_dst", 1)
    destination set will be added in the avp list to be able to
    implement serial forking.
 
-   Note
+Note
 
-        You must set this parameter if you want do do load balancing
-        fail over.
+   You must set this parameter if you want do do load balancing
+   fail over.
 
    Default value is "null" - don't add AVPs.
 
-   Example 1-10. Set the "dst_avp" parameter
+   Example 1.10. Set the "dst_avp" parameter
  ...
  modparam("dispatcher", "dst_avp", "$avp(i:271)")
  ...
-     __________________________________________________________
 
 1.3.11. grp_avp (str)
 
    The name of the avp storing the group id of the destination
    set. Good to have it for later usage or checks.
 
-   Note
+Note
 
-        You must set this parameter if you want do do load balancing
-        fail over.
+   You must set this parameter if you want do do load balancing
+   fail over.
 
    Default value is "null" - don't add AVP.
 
-   Example 1-11. Set the "grp_avp" parameter
+   Example 1.11. Set the "grp_avp" parameter
  ...
  modparam("dispatcher", "grp_avp", "$avp(i:272)")
  ...
-     __________________________________________________________
 
 1.3.12. cnt_avp (str)
 
    The name of the avp storing the number of destination addresses
    kept in dst_avp avps.
 
-   Note
+Note
 
-        You must set this parameter if you want do do load balancing
-        fail over.
+   You must set this parameter if you want do do load balancing
+   fail over.
 
    Default value is "null" - don't add AVP.
 
-   Example 1-12. Set the "cnt_avp" parameter
+   Example 1.12. Set the "cnt_avp" parameter
  ...
  modparam("dispatcher", "cnt_avp", "$avp(i:273)")
  ...
-     __________________________________________________________
 
 1.3.13. hash_pvar (str)
 
    String with PVs used for the hashing algorithm 7.
 
-   Note
+Note
 
-        You must set this parameter if you want do hashing over custom
-        message parts.
+   You must set this parameter if you want do hashing over custom
+   message parts.
 
    Default value is "null" - disabled.
 
-   Example 1-13. Use $avp(i:273) for hashing:
+   Example 1.13. Use $avp(i:273) for hashing:
  ...
  modparam("dispatcher", "hash_pvar", "$avp(i:273)")
  ...
 
-   Example 1-14. Use combination of PVs for hashing:
+   Example 1.14. Use combination of PVs for hashing:
  ...
  modparam("dispatcher", "hash_pvar", "hash the $fU@$ci")
  ...
-     __________________________________________________________
 
 1.3.14. ds_ping_method (string)
 
@@ -342,11 +330,10 @@ modparam("dispatcher", "force_dst", 1)
 
    Default value is "OPTIONS".
 
-   Example 1-15. Set the "ds_ping_method" parameter
+   Example 1.15. Set the "ds_ping_method" parameter
  ...
  modparam("dispatcher", "ds_ping_method", "INFO")
  ...
-     __________________________________________________________
 
 1.3.15. ds_ping_from (string)
 
@@ -357,11 +344,10 @@ modparam("dispatcher", "force_dst", 1)
 
    Default value is "sip:dispatcher@localhost".
 
-   Example 1-16. Set the "ds_ping_from" parameter
+   Example 1.16. Set the "ds_ping_from" parameter
  ...
  modparam("dispatcher", "ds_ping_from", "sip:[email protected]")
  ...
-     __________________________________________________________
 
 1.3.16. ds_ping_interval (int)
 
@@ -372,11 +358,10 @@ modparam("dispatcher", "force_dst", 1)
 
    Default value is "10".
 
-   Example 1-17. Set the "ds_ping_interval" parameter
+   Example 1.17. Set the "ds_ping_interval" parameter
  ...
  modparam("dispatcher", "ds_ping_interval", 30)
  ...
-     __________________________________________________________
 
 1.3.17. ds_probing_threshhold (int)
 
@@ -387,20 +372,18 @@ modparam("dispatcher", "force_dst", 1)
 
    Default value is "3".
 
-   Example 1-18. Set the "ds_probing_threshhold" parameter
+   Example 1.18. Set the "ds_probing_threshhold" parameter
  ...
  modparam("dispatcher", "ds_probing_threshhold", 10)
  ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. ds_select_dst(set, alg)
+1.4.1.  ds_select_dst(set, alg)
 
    The method selects a destination from addresses set.
 
    Meaning of the parameters is as follows:
-
      * set - the id of the set from where to pick up destination
        address. It is the first column in destination list file.
      * alg - the algorithm used to select the destination address.
@@ -425,13 +408,12 @@ modparam("dispatcher", "force_dst", 1)
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-19. ds_select_dst usage
+   Example 1.19. ds_select_dst usage
 ...
 ds_select_dst("1", "0");
 ...
-     __________________________________________________________
 
-1.4.2. ds_select_domain(set, alg)
+1.4.2.  ds_select_domain(set, alg)
 
    The method selects a destination from addresses set and
    rewrites the host and port from R-URI. The parameters have same
@@ -443,25 +425,22 @@ ds_select_dst("1", "0");
    forking to all possible destinations.
 
    This function can be used from REQUEST_ROUTE.
-     __________________________________________________________
 
-1.4.3. ds_next_dst()
+1.4.3.  ds_next_dst()
 
    Takes the next destination address from the AVPs with id
    'dst_avp_id' and sets the dst_uri (outbound proxy address).
 
    This function can be used from FAILURE_ROUTE.
-     __________________________________________________________
 
-1.4.4. ds_next_domain()
+1.4.4.  ds_next_domain()
 
    Takes the next destination address from the AVPs with id
    'dst_avp_id' and sets the domain part of the request uri.
 
    This function can be used from FAILURE_ROUTE.
-     __________________________________________________________
 
-1.4.5. ds_mark_dst()
+1.4.5.  ds_mark_dst()
 
    Mark the last used address from destination set as inactive, in
    order to be ingnored in the future. In this way it can be
@@ -470,9 +449,8 @@ ds_select_dst("1", "0");
    'ds_select_dst' and 'ds_select_domain'.
 
    This function can be used from FAILURE_ROUTE.
-     __________________________________________________________
 
-1.4.6. ds_mark_dst("s")
+1.4.6.  ds_mark_dst("s")
 
    Mark the last used address from destination set as inactive
    ("i"/"I"/"0"), active ("a"/"A"/"1") or probing ("p"/"P"/"2").
@@ -482,7 +460,6 @@ ds_select_dst("1", "0");
    'ds_select_domain'.
 
    possible parameters:
-
      * "i", "I" or "0" - the last destination should be set to
        inactive and will be ignored in future requests.
      * "a", "A" or "1" - the last destination should be set to
@@ -493,18 +470,16 @@ ds_select_dst("1", "0");
        probing.
 
    This function can be used from FAILURE_ROUTE.
-     __________________________________________________________
 
-1.4.7. ds_is_from_list()
+1.4.7.  ds_is_from_list()
 
    This function returns true, if the current request comes from a
    host from the dispatcher-list; otherwise false.
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
-     __________________________________________________________
 
-1.4.8. ds_is_from_list("group")
+1.4.8.  ds_is_from_list("group")
 
    This function returns true, if the current request comes from a
    host in the given group of the dispatcher-list; otherwise
@@ -512,11 +487,10 @@ ds_select_dst("1", "0");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE and ONREPLY_ROUTE.
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
-1.5.1. ds_set_state
+1.5.1.  ds_set_state
 
    Sets the status for a destination address (can be use to mark
    the destination as active or inactive).
@@ -524,7 +498,6 @@ ds_select_dst("1", "0");
    Name: ds_set_state
 
    Parameters:
-
      * _state_ : state of the destination address
           + "a": active
           + "i": inactive
@@ -538,9 +511,8 @@ ds_select_dst("1", "0");
                 _group_
                 _address_
                 _empty_line_
-     __________________________________________________________
 
-1.5.2. ds_list
+1.5.2.  ds_list
 
    It lists the groups and included destinations.
 
@@ -551,9 +523,8 @@ ds_select_dst("1", "0");
    MI FIFO Command Format:
                 :ds_list:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
-1.5.3. ds_reload
+1.5.3.  ds_reload
 
    It reloads the groups and included destinations.
 
@@ -563,7 +534,6 @@ ds_select_dst("1", "0");
 
    MI DATAGRAM Command Format:
                 ":ds_reload:\n."
-     __________________________________________________________
 
 1.6. Installation and Running
 
@@ -577,7 +547,7 @@ ds_select_dst("1", "0");
    address must be a valid SIP URI. Empty lines or lines starting
    with "#" are ignored.
 
-   Example 1-20. dispatcher list file
+   Example 1.20. dispatcher list file
 ...
 # $Id$
 # dispatcher destination sets
@@ -596,13 +566,12 @@ ds_select_dst("1", "0");
 1 sip:127.0.0.1:7074
 
 ...
-     __________________________________________________________
 
 1.6.2. OpenSER config file
 
    Next picture displays a sample usage of dispatcher.
 
-   Example 1-21. OpenSER config script - sample dispatcher usage
+   Example 1.21. OpenSER config script - sample dispatcher usage
 ...
 # $Id$
 # sample config file for dispatcher module
@@ -648,51 +617,53 @@ route{
 }
 
 ...
-     __________________________________________________________
 
 Chapter 2. Frequently Asked Questions
 
-   2.1. Does dispatcher provide a fair distribution?
-   2.2. Is dispatcher dialog stateful?
-   2.3. Where can I find more about OpenSER?
-   2.4. Where can I post a question about this module?
-   2.5. How can I report a bug?
+   2.1.
+
+       Does dispatcher provide a fair distribution?
+
+       There is no guarantee of that. You should do some measurements
+       to decide what distribution algorithm fits better in your
+       environment.
+
+   2.2.
 
-   2.1. Does dispatcher provide a fair distribution?
+       Is dispatcher dialog stateful?
 
-   There is no guarantee of that. You should do some measurements
-   to decide what distribution algorithm fits better in your
-   environment.
+       No. Dispatcher is stateless, although some distribution
+       algorithms are designed to select same destination for
+       subsequent requests of the same dialog (e.g., hashing the
+       call-id).
 
-   2.2. Is dispatcher dialog stateful?
+   2.3.
 
-   No. Dispatcher is stateless, although some distribution
-   algorithms are designed to select same destination for
-   subsequent requests of the same dialog (e.g., hashing the
-   call-id).
+       Where can I find more about OpenSER?
 
-   2.3. Where can I find more about OpenSER?
+       Take a look at http://openser.org/.
 
-   Take a look at http://openser.org/.
+   2.4.
 
-   2.4. 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:
+       First at all check if your question was already answered on one
+       of our mailing lists:
+         * User Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
 
-     * User Mailing List -
-       http://openser.org/cgi-bin/mailman/listinfo/users
-     * Developer Mailing List -
-       http://openser.org/cgi-bin/mailman/listinfo/devel
+       E-mails regarding any stable version should be sent to
+       <[email protected]> and e-mail regarding development versions
+       or CVS snapshots should be send to <[email protected]>.
 
-   E-mails regarding any stable version should be sent to
-   <[email protected]> and e-mail regarding development versions
-   or CVS snapshots should be send 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.5.
 
-   2.5. How can I report a bug?
+       How can I report a bug?
 
-   Please follow the guidelines provided at:
-   http://sourceforge.net/tracker/?group_id=139143
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143

modules_k/dispatcher/doc/dispatcher.sgml → modules_k/dispatcher/doc/dispatcher.xml

@@ -1,13 +1,15 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "dispatcher_user.sgml">
-<!ENTITY faq SYSTEM "dispatcher_faq.sgml">
+<!ENTITY user SYSTEM "dispatcher_admin.xml">
+<!ENTITY faq SYSTEM "dispatcher_faq.xml">
 
 <!ENTITY dispatcherlist SYSTEM "dispatcher.list">
 <!ENTITY dispatchercfg SYSTEM "dispatcher.cfg">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -20,16 +22,15 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<affiliation><orgname>&voicesystem;</orgname></affiliation>
 		<address>
-		<email>[email protected]</email>
+		<email>[email protected]</email>
 		</address>
 	    </author>
 	    <editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
 		<address>
-		<email>[email protected]</email>
+		<email>[email protected]</email>
 		</address>
 	    </editor>
             <editor>
@@ -51,8 +52,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/diversion/README

@@ -9,9 +9,13 @@ Edited by
 Jan Janak
 
    Copyright © 2004 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -31,11 +35,12 @@ Jan Janak
         1.5. Diversion Example
 
    2. Developer's Guide
+   3. Frequently Asked Questions
 
    List of Examples
-   1-1. suffix usage
-   1-2. add_diversion usage
-     __________________________________________________________
+
+   1.1. suffix usage
+   1.2. add_diversion usage
 
 Chapter 1. User's Guide
 
@@ -48,26 +53,22 @@ Chapter 1. User's Guide
    the call to the PSTN gateway and this is what the diversion
    extensions can be used for.
 
-   Warning
+Warning
 
-           The draft-levy-sip-diversion-08 is expired!! See IETF I-D
-           tracker.
-     __________________________________________________________
+   The draft-levy-sip-diversion-08 is expired!! See IETF I-D
+   tracker.
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    None.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -79,9 +80,8 @@ Chapter 1. User's Guide
 
    Default value is "" (empty string).
 
-   Example 1-1. suffix usage
+   Example 1.1. suffix usage
 modparam("diversion", "suffix", ";privacy=full")
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -94,17 +94,15 @@ modparam("diversion", "suffix", ";privacy=full")
    proxy server) Request-URI will be used as the Diversion URI.
 
    Meaning of the parameters is as follows:
-
      * reason - The reason string to be added as the reason
        parameter
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-2. add_diversion usage
+   Example 1.2. add_diversion usage
 ...
 add_diversion("user-busy");
 ...
-     __________________________________________________________
 
 1.5. Diversion Example
 
@@ -133,7 +131,6 @@ CSeq: 3 INVITE
 Diversion: <sip:[email protected]>;reason=user-busy
 Contact: <sip:[email protected]>
 Content-Length: 0
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
@@ -174,3 +171,36 @@ static inline int add_diversion_helper(struct sip_msg* msg, str* s)
     }
 ...
 }
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/diversion/doc/diversion.sgml → modules_k/diversion/doc/diversion.xml

@@ -1,12 +1,14 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "diversion_user.sgml">
-<!ENTITY devel SYSTEM "diversion_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "diversion_admin.xml">
+<!ENTITY devel SYSTEM "diversion_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -38,8 +40,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/domain/README

@@ -2,14 +2,22 @@ Domain Module
 
 Juha Heinanen
 
+   <[email protected]>
+
 Edited by
 
 Juha Heinanen
 
+   <[email protected]>
+
    Copyright © 2002-2008 Juha Heinanen
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -40,15 +48,17 @@ Juha Heinanen
 
               2.1.1. is_domain_local(domain)
 
+   3. Frequently Asked Questions
+
    List of Examples
-   1-1. Setting db_url parameter
-   1-2. db_mode example
-   1-3. Setting domain_table parameter
-   1-4. Setting domain_col parameter
-   1-5. is_from_local usage
-   1-6. is_uri_host_local usage
-   1-7. is_domain_local usage
-     __________________________________________________________
+
+   1.1. Setting db_url parameter
+   1.2. db_mode example
+   1.3. Setting domain_table parameter
+   1.4. Setting domain_col parameter
+   1.5. is_from_local usage
+   1.6. is_uri_host_local usage
+   1.7. is_domain_local usage
 
 Chapter 1. User's Guide
 
@@ -71,15 +81,12 @@ Chapter 1. User's Guide
    Caching is implemented using a hash table. The size of the hash
    table is given by HASH_SIZE constant defined in domain_mod.h.
    Its "factory default" value is 128.
-     __________________________________________________________
 
 1.2. Dependencies
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * database -- Any database module
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -90,9 +97,8 @@ Chapter 1. User's Guide
    Default value is
    "mysql://openserro:openserro@localhost/openser"
 
-   Example 1-1. Setting db_url parameter
+   Example 1.1. Setting db_url parameter
 modparam("domain", "db_url", "mysql://ser:pass@db_host/ser")
-     __________________________________________________________
 
 1.3.2. db_mode (integer)
 
@@ -100,9 +106,8 @@ modparam("domain", "db_url", "mysql://ser:pass@db_host/ser")
 
    Default value is 0 (non-caching).
 
-   Example 1-2. db_mode example
+   Example 1.2. db_mode example
 modparam("domain", "db_mode", 1)   # Use caching
-     __________________________________________________________
 
 1.3.3. domain_table (string)
 
@@ -112,9 +117,8 @@ modparam("domain", "db_mode", 1)   # Use caching
 
    Default value is "domain".
 
-   Example 1-3. Setting domain_table parameter
+   Example 1.3. Setting domain_table parameter
 modparam("domain", "domain_table", "new_name")
-     __________________________________________________________
 
 1.3.4. domain_col (string)
 
@@ -122,9 +126,8 @@ modparam("domain", "domain_table", "new_name")
 
    Default value is "domain".
 
-   Example 1-4. Setting domain_col parameter
+   Example 1.4. Setting domain_col parameter
 modparam("domain", "domain_col", "domain_name")
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -135,13 +138,12 @@ modparam("domain", "domain_col", "domain_name")
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-5. is_from_local usage
+   Example 1.5. is_from_local usage
 ...
 if (is_from_local()) {
         ...
 };
 ...
-     __________________________________________________________
 
 1.4.2. is_uri_host_local()
 
@@ -155,13 +157,12 @@ if (is_from_local()) {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
 
-   Example 1-6. is_uri_host_local usage
+   Example 1.6. is_uri_host_local usage
 ...
 if (is_uri_host_local()) {
         ...
 };
 ...
-     __________________________________________________________
 
 1.4.3. is_domain_local(pseudo_variable)
 
@@ -173,14 +174,13 @@ if (is_uri_host_local()) {
    them and also extends them by allowing the domain to be taken
    from any of the above mentioned sources. The following
    equivalences exist:
-
      * is_domain_local("$rd") is same as is_uri_host_local()
      * is_domain_local("$fd") is same as is_from_local()
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
 
-   Example 1-7. is_domain_local usage
+   Example 1.7. is_domain_local usage
 ...
 if (is_domain_local("$rd")) {
         ...
@@ -198,7 +198,6 @@ if (is_domain_local("$avp(s:some_avp)")) {
         ...
 };
 ...
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
@@ -214,7 +213,6 @@ if (is_domain_local("$avp(s:some_avp)")) {
    MI FIFO Command Format:
                 :domain_reload:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
 1.5.2. domain_dump
 
@@ -228,7 +226,6 @@ if (is_domain_local("$avp(s:some_avp)")) {
    MI FIFO Command Format:
                 :domain_dump:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
 1.6. Known Limitations
 
@@ -236,19 +233,50 @@ if (is_domain_local("$avp(s:some_avp)")) {
    process uses a table, which is reloaded at the same time twice
    through FIFO, the second reload will delete the original table
    still in use by the process.
-     __________________________________________________________
 
 Chapter 2. Developer's Guide
 
    The module provides is_domain_local API function for use by
    other OpenSER modules.
-     __________________________________________________________
 
 2.1. Available Functions
 
-2.1.1. is_domain_local(domain)
+2.1.1.  is_domain_local(domain)
 
    Checks if domain given in str* parameter is local.
 
    The function returns 1 if domain is local and -1 if domain is
    not local or if an error occurred.
+
+Chapter 3. Frequently Asked Questions
+
+   3.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   3.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   3.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/domain/doc/domain.sgml → modules_k/domain/doc/domain.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "domain_user.sgml">
-<!ENTITY devel SYSTEM "domain_devel.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "domain_admin.xml">
+<!ENTITY devel SYSTEM "domain_devel.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -31,8 +33,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/domainpolicy/README

@@ -2,19 +2,33 @@ Domain Policy Module
 
 Otmar Lendl
 
+   <[email protected]>
+
 Klaus Darilion
 
+   <[email protected]>
+
 Edited by
 
 Otmar Lendl
 
+   <[email protected]>
+
+Edited by
+
 Klaus Darilion
 
+   <[email protected]>
+
    Copyright © 2002, 2003, 2006 Juha Heinanen, Otmar Lendl, Klaus
    Darilion
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -48,22 +62,24 @@ Klaus Darilion
 
         1.7. Known Limitations
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Setting db_url parameter
-   1-2. Setting dp_table parameter
-   1-3. Setting dp_col_rule parameter
-   1-4. Setting dp_col_rule parameter
-   1-5. Setting dp_col_att parameter
-   1-6. Setting dp_col_val parameter
-   1-7. Setting port_override_avp parameter
-   1-8. Setting transport_override_avp parameter
-   1-9. Setting domain_replacement_avp parameter
-   1-10. Setting domain_prefix_avp parameter
-   1-11. Setting domain_suffix_avp parameter
-   1-12. Setting send_socket_avp parameter
-   1-13. dp_can_connect usage
-   1-14. dp_apply_policy usage
-     __________________________________________________________
+
+   1.1. Setting db_url parameter
+   1.2. Setting dp_table parameter
+   1.3. Setting dp_col_rule parameter
+   1.4. Setting dp_col_rule parameter
+   1.5. Setting dp_col_att parameter
+   1.6. Setting dp_col_val parameter
+   1.7. Setting port_override_avp parameter
+   1.8. Setting transport_override_avp parameter
+   1.9. Setting domain_replacement_avp parameter
+   1.10. Setting domain_prefix_avp parameter
+   1.11. Setting domain_suffix_avp parameter
+   1.12. Setting send_socket_avp parameter
+   1.13. dp_can_connect usage
+   1.14. dp_apply_policy usage
 
 Chapter 1. User's Guide
 
@@ -80,15 +96,12 @@ Chapter 1. User's Guide
    draft-lendl-domain-policy-ddds-02.
 
    This module requires a database. No caching is implemented.
-     __________________________________________________________
 
 1.2. Dependencies
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * database -- Any database module
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -99,10 +112,9 @@ Chapter 1. User's Guide
    Default value is
    "mysql://openserro:openserro@localhost/openser"
 
-   Example 1-1. Setting db_url parameter
+   Example 1.1. Setting db_url parameter
 modparam("domainpolicy", "db_url", "postgresql://openserro:pass@db_host/
 openser")
-     __________________________________________________________
 
 1.3.2. dp_table (string)
 
@@ -110,9 +122,8 @@ openser")
 
    Default value is "domainpolicy".
 
-   Example 1-2. Setting dp_table parameter
+   Example 1.2. Setting dp_table parameter
 modparam("domainpolicy", "dp_table", "supportedpolicies")
-     __________________________________________________________
 
 1.3.3. dp_col_rule (string)
 
@@ -121,9 +132,8 @@ modparam("domainpolicy", "dp_table", "supportedpolicies")
 
    Default value is "rule".
 
-   Example 1-3. Setting dp_col_rule parameter
+   Example 1.3. Setting dp_col_rule parameter
 modparam("domainpolicy", "dp_col_rule", "rules")
-     __________________________________________________________
 
 1.3.4. dp_col_type (string)
 
@@ -134,9 +144,8 @@ modparam("domainpolicy", "dp_col_rule", "rules")
 
    Default value is "type".
 
-   Example 1-4. Setting dp_col_rule parameter
+   Example 1.4. Setting dp_col_rule parameter
 modparam("domainpolicy", "dp_col_type", "type")
-     __________________________________________________________
 
 1.3.5. dp_col_att (string)
 
@@ -146,9 +155,8 @@ modparam("domainpolicy", "dp_col_type", "type")
 
    Default value is "att".
 
-   Example 1-5. Setting dp_col_att parameter
+   Example 1.5. Setting dp_col_att parameter
 modparam("domainpolicy", "dp_col_att", "attribute")
-     __________________________________________________________
 
 1.3.6. dp_col_val (string)
 
@@ -157,9 +165,8 @@ modparam("domainpolicy", "dp_col_att", "attribute")
 
    Default value is "val".
 
-   Example 1-6. Setting dp_col_val parameter
+   Example 1.6. Setting dp_col_val parameter
 modparam("domainpolicy", "dp_col_val", "values")
-     __________________________________________________________
 
 1.3.7. port_override_avp (string)
 
@@ -168,10 +175,9 @@ modparam("domainpolicy", "dp_col_val", "values")
 
    Default value is "portoverride".
 
-   Example 1-7. Setting port_override_avp parameter
+   Example 1.7. Setting port_override_avp parameter
 # string named AVP
 modparam("domainpolicy", "port_override_avp", "portoverride")
-     __________________________________________________________
 
 1.3.8. transport_override_avp (string)
 
@@ -179,10 +185,9 @@ modparam("domainpolicy", "port_override_avp", "portoverride")
 
    Default value is "transportoverride".
 
-   Example 1-8. Setting transport_override_avp parameter
+   Example 1.8. Setting transport_override_avp parameter
 # string named AVP
 modparam("domainpolicy", "transport_override_avp", "transportoverride")
-     __________________________________________________________
 
 1.3.9. domain_replacement_avp (string)
 
@@ -190,10 +195,9 @@ modparam("domainpolicy", "transport_override_avp", "transportoverride")
 
    Default value is "domainreplacement".
 
-   Example 1-9. Setting domain_replacement_avp parameter
+   Example 1.9. Setting domain_replacement_avp parameter
 # string named AVP
 modparam("domainpolicy", "domain_replacement_avp", "domainreplacement")
-     __________________________________________________________
 
 1.3.10. domain_prefix_avp (string)
 
@@ -201,10 +205,9 @@ modparam("domainpolicy", "domain_replacement_avp", "domainreplacement")
 
    Default value is "domainprefix".
 
-   Example 1-10. Setting domain_prefix_avp parameter
+   Example 1.10. Setting domain_prefix_avp parameter
 # string named AVP
 modparam("domainpolicy", "domain_prefix_avp", "domainprefix")
-     __________________________________________________________
 
 1.3.11. domain_suffix_avp (string)
 
@@ -212,10 +215,9 @@ modparam("domainpolicy", "domain_prefix_avp", "domainprefix")
 
    Default value is "domainsuffix".
 
-   Example 1-11. Setting domain_suffix_avp parameter
+   Example 1.11. Setting domain_suffix_avp parameter
 # string named AVP
 modparam("domainpolicy", "domain_suffix_avp", "domainsuffix")
-     __________________________________________________________
 
 1.3.12. send_socket_avp (string)
 
@@ -227,10 +229,9 @@ modparam("domainpolicy", "domain_suffix_avp", "domainsuffix")
 
    Default value is "sendsocket".
 
-   Example 1-12. Setting send_socket_avp parameter
+   Example 1.12. Setting send_socket_avp parameter
 # string named AVP
 modparam("domainpolicy", "send_socket_avp", "sendsocket")
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -282,7 +283,6 @@ modparam("domainpolicy", "send_socket_avp", "sendsocket")
    Thus, the AVP's value is always string based.
 
    dp_can_connect returns:
-
      * -2: on errors during the evaluation. (DNS, DB, ...)
      * -1: D2P+SIP records were found, but the policy is not
        fullfillable.
@@ -292,7 +292,7 @@ modparam("domainpolicy", "send_socket_avp", "sendsocket")
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-13. dp_can_connect usage
+   Example 1.13. dp_can_connect usage
 ...
 dp_can_connect();
 switch(retcode) {
@@ -316,7 +316,6 @@ switch(retcode) {
                 break;
 }
 ...
-     __________________________________________________________
 
 1.4.2. dp_apply_policy()
 
@@ -331,7 +330,6 @@ switch(retcode) {
 
    Setting the following AVPs in dp_can_connect() (or by any other
    means) cause the following actions in dp_apply_policy():
-
      * port_override_avp: If this AVP is set, the port in the
        destination URI is set to this port. Setting an override
        port disables NAPTR and SRV lookups according to RFC 3263.
@@ -370,22 +368,19 @@ switch(retcode) {
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-14. dp_apply_policy usage
+   Example 1.14. dp_apply_policy usage
 ...
 if (dp_apply_policy()) {
         t_relay();
 }
 ...
-     __________________________________________________________
 
 1.5. FIFO Commands
-     __________________________________________________________
 
 1.6. Usage Scenarios
 
    This section describes how this module can be use to implement
    selective VoIP peerings.
-     __________________________________________________________
 
 1.6.1. TLS Based Federation
 
@@ -403,7 +398,6 @@ if (dp_apply_policy()) {
    fabrics. All this can be achieved by the following
    configuration for a participating VoIP operation called
    example.com:
-
      * Incoming SIP configuration
        Calls from other members are expected to use TLS and
        authenticate using a client-CERT. To implement this, we
@@ -437,8 +431,6 @@ tls_client_domain["tlsfed"] {
  tls_verify_server = 1
 }
 
-     __________________________________________________________
-
 1.6.2. SIP Hub based Federation
 
    This example shows how a peering fabric based on a central SIP
@@ -453,7 +445,6 @@ tls_client_domain["tlsfed"] {
    firewalling). All this can be achieved by the following
    configuration for a participating VoIP operation called
    example.com:
-
      * DNS configuration
        The destination network announces its membership in this
        federation.
@@ -475,7 +466,6 @@ mysql> select * from domainpolicy;
 | 1  | http://HUBFED.org/ | fed  | domainreplacement | sip.HUBFED.org |
 +----+--------------------+------+-------------------+----------------+
 
-     __________________________________________________________
 
 1.6.3. Walled Garden Federation
 
@@ -496,7 +486,6 @@ mysql> select * from domainpolicy;
    lookup.
 
    Here is the configuration for example.com:
-
      * DNS configuration
        The destination network announces its membership in this
        federation.
@@ -522,6 +511,38 @@ mysql> select * from domainpolicy;
 | 1  | http://l3fed.org/ | fed  | domainprefix | l3fed |
 +----+-------------------+------+--------------+-------+
 
-     __________________________________________________________
 
 1.7. Known Limitations
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/domainpolicy/doc/domainpolicy.sgml → modules_k/domainpolicy/doc/domainpolicy.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "domainpolicy_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "domainpolicy_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -42,8 +44,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/domainpolicy/doc/domainpolicy_user.sgml → modules_k/domainpolicy/doc/domainpolicy_admin.xml

@@ -535,16 +535,10 @@ tls_client_domain["tlsfed"] {
 }
 		</programlisting>
 		</listitem>
-
-
-	<para>
-	&nbsp;
-	</para>
-
+	</itemizedlist>
 
 	</section>
 
-
 	<section>
 	<title>SIP Hub based Federation</title>
 	<para>

modules_k/enum/README

@@ -2,12 +2,20 @@ Enum Module
 
 Juha Heinanen
 
+   <[email protected]>
+
 Otmar Lendl
 
+   <[email protected]>
+
    Copyright © 2002, 2003 Juha Heinanen
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -27,18 +35,20 @@ Otmar Lendl
               1.4.3. i_enum_query(["suffix"[,"service"]])
               1.4.4. is_from_user_enum()
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Setting domain_suffix module parameter
-   1-2. Setting tel_uri_params module parameter
-   1-3. Setting i_enum_suffix module parameter
-   1-4. Setting brachlabel module parameter
-   1-5. Zone file example
-   1-6. Zone file example
-   1-7. Setting the bl_algorithm module parameter
-   1-8. enum_query usage
-   1-9. enum_fquery usage
-   1-10. is_from_user_enum usage
-     __________________________________________________________
+
+   1.1. Setting domain_suffix module parameter
+   1.2. Setting tel_uri_params module parameter
+   1.3. Setting i_enum_suffix module parameter
+   1.4. Setting brachlabel module parameter
+   1.5. Zone file example
+   1.6. Zone file example
+   1.7. Setting the bl_algorithm module parameter
+   1.8. enum_query usage
+   1.9. enum_fquery usage
+   1.10. is_from_user_enum usage
 
 Chapter 1. User's Guide
 
@@ -105,15 +115,12 @@ Chapter 1. User's Guide
    Enum module also implements is_from_user_enum function. This
    function does an enum lookup on the from user and returns true
    if found, false otherwise.
-     __________________________________________________________
 
 1.2. Dependencies
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * No dependencies.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -125,26 +132,24 @@ Chapter 1. User's Guide
 
    Default value is "e164.arpa."
 
-   Example 1-1. Setting domain_suffix module parameter
+   Example 1.1. Setting domain_suffix module parameter
 modparam("enum", "domain_suffix", "e1234.arpa.")
-     __________________________________________________________
 
 1.3.2. tel_uri_params (string)
 
    A string whose contents is appended to each new tel URI in the
    request as tel URI parameters.
 
-   Note
+Note
 
-        Currently OpenSER does not support tel URIs. This means that at
-        present tel_uri_params is appended as URI parameters to every
-        URI.
+   Currently OpenSER does not support tel URIs. This means that at
+   present tel_uri_params is appended as URI parameters to every
+   URI.
 
    Default value is ""
 
-   Example 1-2. Setting tel_uri_params module parameter
+   Example 1.2. Setting tel_uri_params module parameter
 modparam("enum", "tel_uri_params", ";npdi")
-     __________________________________________________________
 
 1.3.3. i_enum_suffix (string)
 
@@ -153,9 +158,8 @@ modparam("enum", "tel_uri_params", ";npdi")
 
    Default value is "e164.arpa."
 
-   Example 1-3. Setting i_enum_suffix module parameter
+   Example 1.3. Setting i_enum_suffix module parameter
 modparam("enum", "i_enum_suffix", "e1234.arpa.")
-     __________________________________________________________
 
 1.3.4. branchlabel (string)
 
@@ -164,9 +168,8 @@ modparam("enum", "i_enum_suffix", "e1234.arpa.")
 
    Default value is ""i""
 
-   Example 1-4. Setting brachlabel module parameter
+   Example 1.4. Setting brachlabel module parameter
 modparam("enum", "branchlabel", "i")
-     __________________________________________________________
 
 1.3.5. bl_algorithm (string)
 
@@ -182,7 +185,7 @@ modparam("enum", "branchlabel", "i")
    [branchlabel].[reverse-country-code].[i_enum_suffix] to
    indicate after how many digits the label should in inserted.
 
-   Example 1-5. Zone file example
+   Example 1.5. Zone file example
 i.1.e164.arpa.                     IN TXT   "4"
 9.9.9.8.7.6.5.i.4.3.2.1.e164.arpa. IN NAPTR "naptr content for  +1 234 5
 678 999"
@@ -196,7 +199,7 @@ i.1.e164.arpa.                     IN TXT   "4"
    allocated yet. This version of the code uses 65300. See
    resolve.h.
 
-   Example 1-6. Zone file example
+   Example 1.6. Zone file example
 i.1.e164.arpa.     TYPE65300  \# 14 (
                               04    ; position
                               01 69 ; separator
@@ -208,26 +211,24 @@ pa
 
    Default value is "cc"
 
-   Example 1-7. Setting the bl_algorithm module parameter
+   Example 1.7. Setting the bl_algorithm module parameter
 modparam("enum", "bl_algorithm", "txt")
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. enum_query(["suffix"[,"service"]])
+1.4.1.  enum_query(["suffix"[,"service"]])
 
    The function performs an enum query and rewrites the
-   Request-URI with the result of the query. See Section 1.1> for
-   more information.
+   Request-URI with the result of the query. See Section 1.1,
+   "Overview" for more information.
 
    Meaning of the parameters is as follows:
-
      * suffix - Suffix to be appended to the domain name.
      * service - Service string to be used in the service field.
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-8. enum_query usage
+   Example 1.8. enum_query usage
 ...
 # search for "e2u+sip" in freenum.org
 enum_query("freenum.org.");
@@ -248,22 +249,20 @@ enum_query("e164.arpa.","voice");
 # or use instead
 enum_query("e164.arpa.","+sip+voice:sip");
 ...
-     __________________________________________________________
 
-1.4.2. enum_fquery(["suffix"[,"service"]])
+1.4.2.  enum_fquery(["suffix"[,"service"]])
 
    The function performs an enum query on the user part of the
    From: tag and rewrites the Request-URI with the result of the
-   query. See Section 1.1> for more information.
+   query. See Section 1.1, "Overview" for more information.
 
    Meaning of the parameters is as follows:
-
      * suffix - Suffix to be appended to the domain name.
      * service - Service string to be used in the service field.
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-9. enum_fquery usage
+   Example 1.9. enum_fquery usage
 ...
 # search for "e2u+sip" in freenum.org
 enum_fquery("freenum.org.");
@@ -284,9 +283,8 @@ enum_fquery("e164.arpa.","voice");
 # or use instead
 enum_fquery("e164.arpa.","+sip+voice:sip");
 ...
-     __________________________________________________________
 
-1.4.3. i_enum_query(["suffix"[,"service"]])
+1.4.3.  i_enum_query(["suffix"[,"service"]])
 
    The function performs an enum query and rewrites the
    Request-URI with the result of the query. This the
@@ -297,7 +295,6 @@ enum_fquery("e164.arpa.","+sip+voice:sip");
    See
    ftp://ftp.rfc-editor.org/in-notes/internet-drafts/draft-haberle
    r-carrier-enum-01.txt for the rationale behind this function.
-     __________________________________________________________
 
 1.4.4. is_from_user_enum()
 
@@ -306,9 +303,42 @@ enum_fquery("e164.arpa.","+sip+voice:sip");
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-10. is_from_user_enum usage
+   Example 1.10. is_from_user_enum usage
 ...
 if (is_from_user_enum()) {
         ....
 };
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/enum/doc/enum.sgml → modules_k/enum/doc/enum.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "enum_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "enum_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -31,8 +33,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/exec/README

@@ -9,9 +9,13 @@ Edited by
 Jan Janak
 
    Copyright © 2003 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -33,13 +37,15 @@ Jan Janak
 
         1.5. Known Issues
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set "setvars" parameter
-   1-2. Set "time_to_kill" parameter
-   1-3. exec_dset usage
-   1-4. exec_msg usage
-   1-5. exec_avp usage
-     __________________________________________________________
+
+   1.1. Set "setvars" parameter
+   1.2. Set "time_to_kill" parameter
+   1.3. exec_dset usage
+   1.4. exec_msg usage
+   1.5. exec_avp usage
 
 Chapter 1. User's Guide
 
@@ -50,7 +56,6 @@ Chapter 1. User's Guide
    command string is passed to shell using "popen" command.
    OpenSER passes additionally lot of information about request in
    environment variables:
-
      * SIP_HF_<hf_name> contains value of each header field in
        request. If a header field occurred multiple times, values
        are concatenated and comma-separated. <hf_name> is in
@@ -67,24 +72,19 @@ Chapter 1. User's Guide
        original).
      * SIP_USER is userpart of current request URI.
      * SIP_OUSER is userpart of original request URI.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * No dependencies on other OpenSER modules.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -95,35 +95,32 @@ Chapter 1. User's Guide
 
    Default value is 1.
 
-   Example 1-1. Set "setvars" parameter
+   Example 1.1. Set "setvars" parameter
 ...
 modparam("exec", "setvars", 1)
 ...
-     __________________________________________________________
 
-1.3.2. time_to_kill (integer)
+1.3.2.  time_to_kill (integer)
 
    Specifies the longest time a program is allowed to execute. If
    the time is exceeded, the program is killed.
 
    Default value is 0.
 
-   Example 1-2. Set "time_to_kill" parameter
+   Example 1.2. Set "time_to_kill" parameter
 ...
 modparam("exec", "time_to_kill", 20)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. exec_dset(command)
+1.4.1.  exec_dset(command)
 
    Executes an external command. Current URI is passed to the
    command as parameter. Output of the command is considered URI
    set (separated by lines).
 
    Meaning of the parameters is as follows:
-
      * command - Command to be executed. It can include pseudo-
        variabes;
 
@@ -133,14 +130,13 @@ modparam("exec", "time_to_kill", 20)
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-3. exec_dset usage
+   Example 1.3. exec_dset usage
 ...
 exec_dset("echo TEST > /tmp/test.txt");
 exec_dset("echo TEST > /tmp/$rU.txt");
 ...
-     __________________________________________________________
 
-1.4.2. exec_msg(command)
+1.4.2.  exec_msg(command)
 
    Executes an external command. The whole message is passed to it
    in input, no command-line parameters are added, output of the
@@ -150,7 +146,6 @@ exec_dset("echo TEST > /tmp/$rU.txt");
    for information on usage.
 
    Meaning of the parameters is as follows:
-
      * command - Command to be executed. It can include
        pseudo-variables.
 
@@ -160,21 +155,19 @@ exec_dset("echo TEST > /tmp/$rU.txt");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-4. exec_msg usage
+   Example 1.4. exec_msg usage
 ...
 exec_dset("echo TEST > /tmp/test.txt");
 exec_dset("echo TEST > /tmp/$rU.txt");
 ...
-     __________________________________________________________
 
-1.4.3. exec_avp(command [, avplist])
+1.4.3.  exec_avp(command [, avplist])
 
    Executes an external command. Each line from output of the
    command is saved in an AVP from 'avplist'. If 'avplist' is
    missing, the AVP are named 1, 2, 3, ...
 
    Meaning of the parameters is as follows:
-
      * command - Command to be executed. It can include pseudo-
        variabes;
      * avplist - comma separated list with AVP names to store the
@@ -186,12 +179,11 @@ exec_dset("echo TEST > /tmp/$rU.txt");
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1-5. exec_avp usage
+   Example 1.5. exec_avp usage
 ...
 exec_avp("echo TEST");
 exec_avp("echo TEST", "$avp(s:test)");
 ...
-     __________________________________________________________
 
 1.5. Known Issues
 
@@ -199,3 +191,36 @@ exec_avp("echo TEST", "$avp(s:test)");
    stop blocking SIP server. (There is kill.c but it is not used
    along with the current mechanisms based on popen. Besides that
    kill.c is ugly).
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/exec/doc/exec.sgml → modules_k/exec/doc/exec.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "exec_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "exec_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -37,8 +39,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/gflags/README

@@ -2,14 +2,22 @@ gflags Module
 
 Jiri Kuthan
 
+   <[email protected]>
+
 Edited by
 
 Daniel-Constantin Mierla
 
+   <[email protected]>
+
    Copyright © 2004 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -31,16 +39,18 @@ Daniel-Constantin Mierla
               1.5.3. is_gflag
               1.5.4. get_gflags
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. initial parameter usage
-   1-2. set_gflag() usage
-   1-3. reset_gflag() usage
-   1-4. is_gflag() usage
-   1-5. set_gflag usage
-   1-6. reset_gflag usage
-   1-7. is_gflag usage
-   1-8. get_gflags usage
-     __________________________________________________________
+
+   1.1. initial parameter usage
+   1.2. set_gflag() usage
+   1.3. reset_gflag() usage
+   1.4. is_gflag() usage
+   1.5. set_gflag usage
+   1.6. reset_gflag usage
+   1.7. is_gflag usage
+   1.8. get_gflags usage
 
 Chapter 1. User's Guide
 
@@ -62,15 +72,12 @@ Chapter 1. User's Guide
    The module exports external commands that can be used to change
    the global flags via Management Interface. The MI commands are:
    "set_gflag", "reset_gflag" and "is_gflag".
-     __________________________________________________________
 
 1.2. Dependencies
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * none
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -80,9 +87,8 @@ Chapter 1. User's Guide
 
    Default value is "0".
 
-   Example 1-1. initial parameter usage
+   Example 1.1. initial parameter usage
 modparam("gflags", "initial", 15)
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -95,11 +101,10 @@ modparam("gflags", "initial", 15)
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE and BRANCH_ROUTE.
 
-   Example 1-2. set_gflag() usage
+   Example 1.2. set_gflag() usage
 ...
 set_gflag("4");
 ...
-     __________________________________________________________
 
 1.4.2. reset_gflag(flag)
 
@@ -108,11 +113,10 @@ set_gflag("4");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE and BRANCH_ROUTE.
 
-   Example 1-3. reset_gflag() usage
+   Example 1.3. reset_gflag() usage
 ...
 reset_gflag("4");
 ...
-     __________________________________________________________
 
 1.4.3. is_gflag(flag)
 
@@ -121,7 +125,7 @@ reset_gflag("4");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE and BRANCH_ROUTE.
 
-   Example 1-4. is_gflag() usage
+   Example 1.4. is_gflag() usage
 ...
 if(is_gflag("4"))
 {
@@ -130,7 +134,6 @@ if(is_gflag("4"))
         log("global flag 4 is not set\n");
 };
 ...
-     __________________________________________________________
 
 1.5. MI Commands
 
@@ -139,7 +142,6 @@ if(is_gflag("4"))
    flags. It is not possible to specify directly the flag position
    that should be changed as in the functions available in the
    routing script.
-     __________________________________________________________
 
 1.5.1. set_gflag
 
@@ -147,12 +149,11 @@ if(is_gflag("4"))
 
    The parameter value must be a number in decimal or hexa format
 
-   Example 1-5. set_gflag usage
+   Example 1.5. set_gflag usage
 ...
 $ openserctl fifo set_gflag 1
 $ openserctl fifo set_gflag 0x3
 ...
-     __________________________________________________________
 
 1.5.2. reset_gflag
 
@@ -160,12 +161,11 @@ $ openserctl fifo set_gflag 0x3
 
    The parameter value must be a number in decimal or hexa format
 
-   Example 1-6. reset_gflag usage
+   Example 1.6.  reset_gflag usage
 ...
 $ openserctl fifo reset_gflag 1
 $ openserctl fifo reset_gflag 0x3
 ...
-     __________________________________________________________
 
 1.5.3. is_gflag
 
@@ -174,7 +174,7 @@ $ openserctl fifo reset_gflag 0x3
    The function returns TRUE if all the flags from the set are set
    and FALSE if at least one is not set.
 
-   Example 1-7. is_gflag usage
+   Example 1.7. is_gflag usage
 ...
 $ openserctl fifo set_gflag 1024
 $ openserctl fifo is_gflag 1024
@@ -191,16 +191,48 @@ FALSE
 $ openserctl fifo is_gflag 16
 TRUE
 ...
-     __________________________________________________________
 
 1.5.4. get_gflags
 
    Return the bitmap with all flags. The function gets no
    parameters and returns the bitmap in hexa and decimal format.
 
-   Example 1-8. get_gflags usage
+   Example 1.8.  get_gflags usage
 ...
 $ openserctl fifo get_gflags
 0x3039
 12345
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/gflags/doc/gflags.sgml → modules_k/gflags/doc/gflags.xml

@@ -1,10 +1,12 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "gflags_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "gflags_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -21,7 +23,7 @@
 		<editor>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
-		<email>[email protected]</email>
+		<email>[email protected]</email>
 		</editor>
 	</authorgroup>
 	<copyright>
@@ -30,8 +32,8 @@
 	</copyright>
 	<revhistory>
 		<revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 		</revision>
 	</revhistory>
 	</bookinfo>

modules_k/group/README

@@ -9,9 +9,13 @@ Edited by
 Jan Janak
 
    Copyright © 2003 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -42,20 +46,22 @@ Jan Janak
               1.4.1. is_user_in(URI, group)
               1.4.2. get_user_group(URI, AVP)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set db_url parameter
-   1-2. Set table parameter
-   1-3. Set user_column parameter
-   1-4. Set domain_column parameter
-   1-5. Set group_column parameter
-   1-6. Set use_domain parameter
-   1-7. Set re_table parameter
-   1-8. Set reg_exp_column parameter
-   1-9. Set re_gid_column parameter
-   1-10. Set multiple_gid parameter
-   1-11. is_user_in usage
-   1-12. get_user_group usage
-     __________________________________________________________
+
+   1.1. Set db_url parameter
+   1.2. Set table parameter
+   1.3. Set user_column parameter
+   1.4. Set domain_column parameter
+   1.5. Set group_column parameter
+   1.6. Set use_domain parameter
+   1.7. Set re_table parameter
+   1.8. Set reg_exp_column parameter
+   1.9. Set re_gid_column parameter
+   1.10. Set multiple_gid parameter
+   1.11. is_user_in usage
+   1.12. get_user_group usage
 
 Chapter 1. User's Guide
 
@@ -63,7 +69,6 @@ Chapter 1. User's Guide
 
    This module provides functionalities for different methods of
    group membership checking.
-     __________________________________________________________
 
 1.1.1. Strict membership checking
 
@@ -73,7 +78,6 @@ Chapter 1. User's Guide
 
    There is no DB caching support, each check involving a DB
    query.
-     __________________________________________________________
 
 1.1.2. Regular Expression based checking
 
@@ -85,24 +89,19 @@ Chapter 1. User's Guide
    Due performance reasons (regular expression evaluation), DB
    cache support is available: the table content is loaded into
    memory at startup and all regular expressions are compiled.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * A database module, like mysql, postgres or dbtext
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -113,11 +112,10 @@ Chapter 1. User's Guide
    Default value is
    "mysql://openserro:openserro@localhost/openser".
 
-   Example 1-1. Set db_url parameter
+   Example 1.1. Set db_url parameter
 ...
 modparam("group", "db_url", "mysql://username:password@dbhost/openser")
 ...
-     __________________________________________________________
 
 1.3.2. table (string)
 
@@ -126,11 +124,10 @@ modparam("group", "db_url", "mysql://username:password@dbhost/openser")
 
    Default value is "grp".
 
-   Example 1-2. Set table parameter
+   Example 1.2. Set table parameter
 ...
 modparam("group", "table", "grp_table")
 ...
-     __________________________________________________________
 
 1.3.3. user_column (string)
 
@@ -138,11 +135,10 @@ modparam("group", "table", "grp_table")
 
    Default value is "username".
 
-   Example 1-3. Set user_column parameter
+   Example 1.3. Set user_column parameter
 ...
 modparam("group", "user_column", "user")
 ...
-     __________________________________________________________
 
 1.3.4. domain_column (string)
 
@@ -150,11 +146,10 @@ modparam("group", "user_column", "user")
 
    Default value is "domain".
 
-   Example 1-4. Set domain_column parameter
+   Example 1.4. Set domain_column parameter
 ...
 modparam("group", "domain_column", "realm")
 ...
-     __________________________________________________________
 
 1.3.5. group_column (string)
 
@@ -162,11 +157,10 @@ modparam("group", "domain_column", "realm")
 
    Default value is "grp".
 
-   Example 1-5. Set group_column parameter
+   Example 1.5. Set group_column parameter
 ...
 modparam("group", "group_column", "grp")
 ...
-     __________________________________________________________
 
 1.3.6. use_domain (integer)
 
@@ -176,11 +170,10 @@ modparam("group", "group_column", "grp")
 
    Default value is 0 (no).
 
-   Example 1-6. Set use_domain parameter
+   Example 1.6. Set use_domain parameter
 ...
 modparam("group", "use_domain", 1)
 ...
-     __________________________________________________________
 
 1.3.7. re_table (string)
 
@@ -190,11 +183,10 @@ modparam("group", "use_domain", 1)
 
    Default value is "NULL".
 
-   Example 1-7. Set re_table parameter
+   Example 1.7. Set re_table parameter
 ...
 modparam("group", "re_table", "re_grp")
 ...
-     __________________________________________________________
 
 1.3.8. re_exp_column (string)
 
@@ -203,11 +195,10 @@ modparam("group", "re_table", "re_grp")
 
    Default value is "reg_exp".
 
-   Example 1-8. Set reg_exp_column parameter
+   Example 1.8. Set reg_exp_column parameter
 ...
 modparam("group", "reg_exp_column", "re")
 ...
-     __________________________________________________________
 
 1.3.9. re_gid_column (string)
 
@@ -215,11 +206,10 @@ modparam("group", "reg_exp_column", "re")
 
    Default value is "group_id".
 
-   Example 1-9. Set re_gid_column parameter
+   Example 1.9. Set re_gid_column parameter
 ...
 modparam("group", "re_gid_column", "grp_id")
 ...
-     __________________________________________________________
 
 1.3.10. multiple_gid (integer)
 
@@ -229,22 +219,20 @@ modparam("group", "re_gid_column", "grp_id")
 
    Default value is "1".
 
-   Example 1-10. Set multiple_gid parameter
+   Example 1.10. Set multiple_gid parameter
 ...
 modparam("group", "multiple_gid", 0)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. is_user_in(URI, group)
+1.4.1.  is_user_in(URI, group)
 
    This function is to be used for script group membership. The
    function returns true if username in the given URI is member of
    the given group and false if not.
 
    Meaning of the parameters is as follows:
-
      * URI - URI whose username and optionally domain to be used,
        this can be one of:
           + Request-URI - Use Request-URI username and
@@ -258,15 +246,14 @@ modparam("group", "multiple_gid", 0)
 
    This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
 
-   Example 1-11. is_user_in usage
+   Example 1.11. is_user_in usage
 ...
 if (is_user_in("Request-URI", "ld")) {
         ...
 };
 ...
-     __________________________________________________________
 
-1.4.2. get_user_group(URI, AVP)
+1.4.2.  get_user_group(URI, AVP)
 
    This function is to be used for regular expression based group
    membership. The function returns true if username in the given
@@ -274,7 +261,6 @@ if (is_user_in("Request-URI", "ld")) {
    as AVPs.
 
    Meaning of the parameters is as follows:
-
      * URI - URI to be matched against the regular expressions:
           + Request-URI - Use Request-URI
           + To - Use To URI.
@@ -288,10 +274,43 @@ if (is_user_in("Request-URI", "ld")) {
 
    This function can be used from REQUEST_ROUTE and FAILURE_ROUTE.
 
-   Example 1-12. get_user_group usage
+   Example 1.12. get_user_group usage
 ...
 if (get_user_group("Request-URI", "$avp(i:10)")) {
     xgdb("User $ru belongs to $(avp(i:10)[*]) group(s)\n");
     ....
 };
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/group/doc/group.sgml → modules_k/group/doc/group.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "group_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "group_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -37,8 +39,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/group_radius/README

@@ -13,9 +13,13 @@ Edited by
 Jan Janak
 
    Copyright © 2003 FhG FOKUS
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -33,11 +37,13 @@ Jan Janak
 
               1.4.1. radius_is_user_in(URI, group)
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set radius_config parameter
-   1-2. Set use_domain parameter
-   1-3. radius_is_user_in usage
-     __________________________________________________________
+
+   1.1. Set radius_config parameter
+   1.2. Set use_domain parameter
+   1.3. radius_is_user_in usage
 
 Chapter 1. User's Guide
 
@@ -47,7 +53,6 @@ Chapter 1. User's Guide
    checking over radius. There is a database table that contains
    list of users and groups they belong to. The table is used by
    functions of this module.
-     __________________________________________________________
 
 1.2. Dependencies
 
@@ -55,19 +60,15 @@ Chapter 1. User's Guide
 
    The module depends on the following modules (in the other words
    the listed modules must be loaded before this module):
-
      * none
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before compilling OpenSER with this module loaded:
-
      * radiusclient-ng 0.5.0 or higher -- library and development
        files. See
        http://developer.berlios.de/projects/radiusclient-ng/.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -79,11 +80,10 @@ Chapter 1. User's Guide
    Default value is
    "/usr/local/etc/radiusclient-ng/radiusclient.conf".
 
-   Example 1-1. Set radius_config parameter
+   Example 1.1. Set radius_config parameter
 ...
 modparam("group_radius", "radius_config", "/etc/radiusclient.conf")
 ...
-     __________________________________________________________
 
 1.3.2. use_domain (integer)
 
@@ -92,21 +92,19 @@ modparam("group_radius", "radius_config", "/etc/radiusclient.conf")
 
    Default value is 0 (no).
 
-   Example 1-2. Set use_domain parameter
+   Example 1.2. Set use_domain parameter
 ...
 modparam("group_radius", "use_domain", 1)
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. radius_is_user_in(URI, group)
+1.4.1.  radius_is_user_in(URI, group)
 
    The function returns true if username in the given URI is
    member of the given group and false if not.
 
    Meaning of the parameters is as follows:
-
      * URI - URI whose username and optionally domain to be used,
        this can be one of:
           + Request-URI - Use Request-URI username and
@@ -118,9 +116,42 @@ modparam("group_radius", "use_domain", 1)
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-3. radius_is_user_in usage
+   Example 1.3. radius_is_user_in usage
 ...
 if (radius_is_user_in("Request-URI", "ld")) {
         ...
 };
 ...
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/group_radius/doc/group_radius.sgml → modules_k/group_radius/doc/group_radius.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "group_radius_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "group_radius_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -45,8 +47,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
     </bookinfo>

modules_k/group_radius/doc/group_radius_user.sgml → modules_k/group_radius/doc/group_radius_admin.xml

@@ -33,6 +33,7 @@
 			<para>
 			The following libraries or applications must be installed 
 			before compilling &ser; with this module loaded:
+			</para>
 			<itemizedlist>
 				<listitem>
 				<para><emphasis>radiusclient-ng</emphasis> 0.5.0 or higher -- 

modules_k/h350/README

@@ -3,11 +3,15 @@ H350 Module
 Christian Schlatter
 
    University of North Carolina
+   <[email protected]>
 
    Copyright © 2007 University of North Carolina
+   Revision History
+   Revision 0.1 05-17-2007
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -34,22 +38,23 @@ Christian Schlatter
               1.4.3. h350_result_call_preferences(avp_name_prefix)
               1.4.4. h350_result_service_level(avp_name_prefix)
 
+   2. Frequently Asked Questions
    Resources
 
    List of Examples
-   1-1. Example H.350 commObject storing SIP account data
-   1-2. ldap_session parameter usage
-   1-3. base_dn parameter usage
-   1-4. search_scope parameter usage
-   1-5. Example Usage
-   1-6. Example Usage
-   1-7. Example H.350 callPreferenceURI simple call forwarding
+
+   1.1. Example H.350 commObject storing SIP account data
+   1.2. ldap_session parameter usage
+   1.3. base_dn parameter usage
+   1.4. search_scope parameter usage
+   1.5. Example Usage
+   1.6. Example Usage
+   1.7. Example H.350 callPreferenceURI simple call forwarding
           rules
 
-   1-8. Example Usage
-   1-9. Example SIPIdentityServiceLevel values and resulting AVPs
-   1-10. Example Usage
-     __________________________________________________________
+   1.8. Example Usage
+   1.9. Example SIPIdentityServiceLevel values and resulting AVPs
+   1.10. Example Usage
 
 Chapter 1. User's Guide
 
@@ -80,14 +85,13 @@ Chapter 1. User's Guide
    allows a script writer to implement H.350 based SIP digest
    authentication, call forwarding, SIP URI alias to AOR
    rewriting, and service level parsing.
-     __________________________________________________________
 
 1.1.1. Example H.350 commObject LDAP Entry
 
    The following example shows a typical H.350 commObject LDAP
    entry storing SIP account data.
 
-   Example 1-1. Example H.350 commObject storing SIP account data
+   Example 1.1. Example H.350 commObject storing SIP account data
 Attribute Name                Attribute Value(s)
 --------------                -----------------
 
@@ -133,7 +137,6 @@ objectClass                   top
                               commObject
                               SIPIdentity
                               callPreferenceURIObject
-     __________________________________________________________
 
 1.2. Dependencies
 
@@ -141,18 +144,14 @@ objectClass                   top
 
    The module depends on the following modules (the listed modules
    must be loaded before this module):
-
      * LDAP
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * OpenLDAP library (libldap), libldap header files
        (libldap-dev) are needed for compilation
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -163,9 +162,8 @@ objectClass                   top
 
    Default value: ""
 
-   Example 1-2. ldap_session parameter usage
+   Example 1.2. ldap_session parameter usage
 modparam("h350", "ldap_session", "h350");
-     __________________________________________________________
 
 1.3.2. base_dn (string)
 
@@ -175,9 +173,8 @@ modparam("h350", "ldap_session", "h350");
 
    Default value: ""
 
-   Example 1-3. base_dn parameter usage
+   Example 1.3. base_dn parameter usage
 modparam("h350", "base_dn", "ou=h350,dc=example,dc=com");
-     __________________________________________________________
 
 1.3.3. search_scope (string)
 
@@ -186,9 +183,8 @@ modparam("h350", "base_dn", "ou=h350,dc=example,dc=com");
 
    Default value: "one"
 
-   Example 1-4. search_scope parameter usage
+   Example 1.4. search_scope parameter usage
 modparam("h350", "search_scope", "sub");
-     __________________________________________________________
 
 1.4. Exported Functions
 
@@ -233,7 +229,7 @@ modparam("h350", "search_scope", "sub");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE, and ONREPLY_ROUTE.
 
-   Example 1-5. Example Usage
+   Example 1.5. Example Usage
 #
 # H.350 lookup for callee
 #
@@ -253,7 +249,6 @@ if (!h350_sipuri_lookup("sip:$rU@$rd"))
 }
 
 # now h350_result* or ldap_result* functions can be used
-     __________________________________________________________
 
 1.4.2. h350_auth_lookup(auth_username,
 "username_avp_spec/pwd_avp_spec")
@@ -307,7 +302,7 @@ if (!h350_sipuri_lookup("sip:$rU@$rd"))
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE, and ONREPLY_ROUTE.
 
-   Example 1-6. Example Usage
+   Example 1.6. Example Usage
 # -- auth params --
 modparam("auth", "username_spec", "$avp(s:auth_user)")
 modparam("auth", "password_spec", "$avp(s:auth_pwd)")
@@ -393,7 +388,6 @@ route[1]
     xlog("L_INFO", "$rm request successfully authenticated");
     return(1);
 }
-     __________________________________________________________
 
 1.4.3. h350_result_call_preferences(avp_name_prefix)
 
@@ -416,8 +410,9 @@ route[1]
    is a string indicating the time in milliseconds after which the
    call forwarding should occur.
 
-   Example 1-7. Example H.350 callPreferenceURI simple call
+   Example 1.7. Example H.350 callPreferenceURI simple call
    forwarding rules
+
 # Example 1:
 # forward to sip:[email protected] on no answer after 15 seconds:
 
@@ -499,7 +494,7 @@ AVP value = argument / 1000
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE, and ONREPLY_ROUTE.
 
-   Example 1-8. Example Usage
+   Example 1.8. Example Usage
 #
 # H.350 lookup for callee
 #
@@ -542,7 +537,6 @@ if (is_avp_set("$avp(s:callee_pref_u)"))
     t_relay();
     exit;
 }
-     __________________________________________________________
 
 1.4.4. h350_result_service_level(avp_name_prefix)
 
@@ -559,7 +553,7 @@ if (is_avp_set("$avp(s:callee_pref_u)"))
    SIPIdentityServiceLevel attribute value, and an integer value
    of 1.
 
-   Example 1-9. Example SIPIdentityServiceLevel values and
+   Example 1.9. Example SIPIdentityServiceLevel values and
    resulting AVPs
 SIPIdentityServiceLevel: longdistance
 SIPIdentityServiceLevel: international
@@ -601,7 +595,7 @@ $avp("s:sl_900") = 1
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE, and ONREPLY_ROUTE.
 
-   Example 1-10. Example Usage
+   Example 1.10. Example Usage
 #
 # H.350 SIP digest authentication for caller
 #
@@ -630,21 +624,53 @@ else {
     sl_send_reply("403", "Forbidden");
 }
 exit;
-     __________________________________________________________
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.
 
 Resources
 
    [H.350] Directory Services Architecture for Multimedia
-   Conferencing, August 2003, ITU-T.
+   Conferencing. August 2003. ITU-T.
 
-   [H.350.4] Directory services architecture for SIP, August 2003,
+   [H.350.4] Directory services architecture for SIP. August 2003.
    ITU-T.
 
    [H.350.6] Directory services architecture for call forwarding
-   and preferences, March 2004, ITU-T.
+   and preferences. March 2004. ITU-T.
 
-   [ViDe-H.350-Cookbook] ViDe H.350 Cookbook, 2005, ViDe.
+   [ViDe-H.350-Cookbook] ViDe H.350 Cookbook. 2005. ViDe.
 
    [RFC4510] Lightweight Directory Access Protocol (LDAP):
-   Technical Specification Road Map, June 2006, Internet
+   Technical Specification Road Map. June 2006. Internet
    Engineering Task Force.

modules_k/h350/doc/h350.sgml → modules_k/h350/doc/h350.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
-<!ENTITY user SYSTEM "h350_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
-<!ENTITY biblio SYSTEM "h350_biblio.sgml">
+<!ENTITY user SYSTEM "h350_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
+<!ENTITY biblio SYSTEM "h350_biblio.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>

modules_k/h350/doc/h350_user.sgml → modules_k/h350/doc/h350_admin.xml

@@ -5,11 +5,11 @@
         <title>Overview</title>
 
         <para>
-            The OpenSER H350 module enables an OpenSER SIP proxy server to access SIP account data stored in an LDAP <xref linkend="RFC4510" > directory containing H.350 <xref linkend="H350" > <emphasis>commObjects</emphasis>. ITU-T Recommendation H.350 standardizes LDAP object classes to store Real-Time Communication (RTC) account data. In particular, <emphasis>H.350.4</emphasis> <xref linkend="H350-4" > defines an object class called <emphasis>sipIdentity</emphasis> that includes attribute specifications for SIP account data like SIP URI, SIP digest username/password, or service level. This allows to store SIP account data in a vendor neutral way and lets different entities, like SIP proxies, provisioning, or billing applications, access the data in a standardized format.  
+			The OpenSER H350 module enables an OpenSER SIP proxy server to access SIP account data stored in an LDAP <xref linkend="RFC4510"/> directory containing H.350 <xref linkend="H350"/> <emphasis>commObjects</emphasis>. ITU-T Recommendation H.350 standardizes LDAP object classes to store Real-Time Communication (RTC) account data. In particular, <emphasis>H.350.4</emphasis> <xref linkend="H350-4"/> defines an object class called <emphasis>sipIdentity</emphasis> that includes attribute specifications for SIP account data like SIP URI, SIP digest username/password, or service level. This allows to store SIP account data in a vendor neutral way and lets different entities, like SIP proxies, provisioning, or billing applications, access the data in a standardized format.  
         </para>
         
         <para>
-            The <emphasis>ViDe H.350 Cookbook</emphasis> <xref linkend="vide-H350-cookbook">  is a good reference for deploying an H.350 directory. Besides general information on H.350, LDAP, and related standards, this document explains how to set up an H.350/LDAP directory and discusses different deployment scenarios.    
+			The <emphasis>ViDe H.350 Cookbook</emphasis> <xref linkend="vide-H350-cookbook"/>  is a good reference for deploying an H.350 directory. Besides general information on H.350, LDAP, and related standards, this document explains how to set up an H.350/LDAP directory and discusses different deployment scenarios.    
         </para>
         
         <para>
@@ -478,7 +478,7 @@ route[1]
         <title>h350_result_call_preferences(avp_name_prefix)</title>
         
         <para>
-            This function parses the callPreferenceURI attribute of an H.350 commObject, which must have been fetched through <emphasis>h350_*_lookup</emphasis> or <emphasis>ldap_search</emphasis>. callPreferenceURI is a multi-valued attribute that stores call preference rules like e.g. forward-on-busy or forward-unconditionally. <emphasis>Directory services architecture for call forwarding and preferences</emphasis> <xref linkend="H350-6" > defines a format for simple call forwarding rules:
+			This function parses the callPreferenceURI attribute of an H.350 commObject, which must have been fetched through <emphasis>h350_*_lookup</emphasis> or <emphasis>ldap_search</emphasis>. callPreferenceURI is a multi-valued attribute that stores call preference rules like e.g. forward-on-busy or forward-unconditionally. <emphasis>Directory services architecture for call forwarding and preferences</emphasis> <xref linkend="H350-6"/> defines a format for simple call forwarding rules:
         </para>
         
         <blockquote>
@@ -639,7 +639,7 @@ AVP value = argument / 1000
 # store H.350 call preferences in AVP
 #
 
-if (!h350_result_call_preferences("callee_pref_") && ($retcode == -1))
+if (!h350_result_call_preferences("callee_pref_") &amp;&amp; ($retcode == -1))
 {
     sl_send_reply("500", "Internal server error");
     exit;
@@ -679,7 +679,7 @@ if (is_avp_set("$avp(s:callee_pref_u)"))
         <title>h350_result_service_level(avp_name_prefix)</title>
         
         <para>
-            <emphasis>Directory services architecture for SIP</emphasis> <xref linkend="H350-4" > defines a multi-valued LDAP attribute named SIPIdentityServiceLevel, which can be used to store SIP account service level values in an LDAP directory. This function parses the SIPIdentityServiceLevel attribute and stores all service level values as AVPs for later retrieval in the OpenSER routing script. The function accesses the H.350 commObject fetched by a call to <emphasis>h350_*_lookup</emphasis> or <emphasis>ldap_search</emphasis>. 
+			<emphasis>Directory services architecture for SIP</emphasis> <xref linkend="H350-4"/> defines a multi-valued LDAP attribute named SIPIdentityServiceLevel, which can be used to store SIP account service level values in an LDAP directory. This function parses the SIPIdentityServiceLevel attribute and stores all service level values as AVPs for later retrieval in the OpenSER routing script. The function accesses the H.350 commObject fetched by a call to <emphasis>h350_*_lookup</emphasis> or <emphasis>ldap_search</emphasis>. 
         </para>
         
         <para>
@@ -789,7 +789,7 @@ $avp("s:sl_900") = 1
 # store caller's service level as AVP
 #
 
-if (!h350_result_service_level("caller_sl_") && ($retcode == -1))
+if (!h350_result_service_level("caller_sl_") &amp;&amp; ($retcode == -1))
 {
     sl_send_reply("500", "Internal server error");
     exit;

modules_k/imc/README

@@ -13,9 +13,13 @@ Edited by
 Anca-Maria Vamanu
 
    Copyright © 2006 voice-system.ro
+   Revision History
+   Revision $Revision$ $Date: 2008-03-04 15:15:47 +0200
+                              (Tue, 04 Mar 2008) $
      __________________________________________________________
 
    Table of Contents
+
    1. User's Guide
 
         1.1. Overview
@@ -49,16 +53,18 @@ Anca-Maria Vamanu
         1.7. IMC Commands
         1.8. Installation
 
+   2. Frequently Asked Questions
+
    List of Examples
-   1-1. Set db_url parameter
-   1-2. Set rooms_table parameter
-   1-3. Set members_table parameter
-   1-4. Set hash_size parameter
-   1-5. Set imc_cmd_start_char parameter
-   1-6. Set outbound_proxy parameter
-   1-7. Usage of imc_manager() function
-   1-8. List of commands
-     __________________________________________________________
+
+   1.1. Set db_url parameter
+   1.2. Set rooms_table parameter
+   1.3. Set members_table parameter
+   1.4. Set hash_size parameter
+   1.5. Set imc_cmd_start_char parameter
+   1.6. Set outbound_proxy parameter
+   1.7. Usage of imc_manager() function
+   1.8. List of commands
 
 Chapter 1. User's Guide
 
@@ -78,25 +84,20 @@ Chapter 1. User's Guide
    interpreter of the IMC commands are embeded in the module, from
    configuration poin of view, there is only one function which
    has to be executed for both messages and commands.
-     __________________________________________________________
 
 1.2. Dependencies
 
 1.2.1. OpenSER Modules
 
    The following modules must be loaded before this module:
-
      * mysql.
      * tm.
-     __________________________________________________________
 
 1.2.2. External Libraries or Applications
 
    The following libraries or applications must be installed
    before running OpenSER with this module loaded:
-
      * None.
-     __________________________________________________________
 
 1.3. Exported Parameters
 
@@ -107,11 +108,10 @@ Chapter 1. User's Guide
    The default value is
    "mysql://openser:openserrw@localhost/openser".
 
-   Example 1-1. Set db_url parameter
+   Example 1.1. Set db_url parameter
 ...
 modparam("imc", "db_url", "dbdriver://username:password@dbhost/dbname")
 ...
-     __________________________________________________________
 
 1.3.2. rooms_table (str)
 
@@ -119,11 +119,10 @@ modparam("imc", "db_url", "dbdriver://username:password@dbhost/dbname")
 
    The default value is "imc_rooms".
 
-   Example 1-2. Set rooms_table parameter
+   Example 1.2. Set rooms_table parameter
 ...
 modparam("imc", "rooms_table", "rooms")
 ...
-     __________________________________________________________
 
 1.3.3. members_table (str)
 
@@ -131,11 +130,10 @@ modparam("imc", "rooms_table", "rooms")
 
    The default value is "imc_members".
 
-   Example 1-3. Set members_table parameter
+   Example 1.3. Set members_table parameter
 ...
 modparam("imc", "rooms_table", "members")
 ...
-     __________________________________________________________
 
 1.3.4. hash_size (integer)
 
@@ -144,11 +142,10 @@ modparam("imc", "rooms_table", "members")
 
    The default value is 4 (resultimg in hash size 16).
 
-   Example 1-4. Set hash_size parameter
+   Example 1.4. Set hash_size parameter
 ...
 modparam("imc", "hash_size", 8)
 ...
-     __________________________________________________________
 
 1.3.5. imc_cmd_start_char (str)
 
@@ -157,11 +154,10 @@ modparam("imc", "hash_size", 8)
 
    The default value is "#".
 
-   Example 1-5. Set imc_cmd_start_char parameter
+   Example 1.5. Set imc_cmd_start_char parameter
 ...
 modparam("imc", "imc_cmd_start_char", "#")
 ...
-     __________________________________________________________
 
 1.3.6. outbound_proxy (str)
 
@@ -173,15 +169,14 @@ modparam("imc", "imc_cmd_start_char", "#")
 
    Default value is NULL.
 
-   Example 1-6. Set outbound_proxy parameter
+   Example 1.6. Set outbound_proxy parameter
 ...
 modparam("imc", "outbound_proxy", "sip:openser.org;transport=tcp")
 ...
-     __________________________________________________________
 
 1.4. Exported Functions
 
-1.4.1. imc_manager()
+1.4.1.  imc_manager()
 
    Handles Message method.It detects if the body of the message is
    a conference command.If so it executes it, otherwise it sends
@@ -189,7 +184,7 @@ modparam("imc", "outbound_proxy", "sip:openser.org;transport=tcp")
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1-7. Usage of imc_manager() function
+   Example 1.7. Usage of imc_manager() function
 ...
 # the rooms will be named chat-xyz to avoid overlapping
 # with usernames
@@ -197,11 +192,10 @@ if(is_method("MESSAGE)
         && (uri=~ "sip:chat-[0-9]+@" || (uri=~ "sip:chat-manager@")
     imc_manager();
 ...
-     __________________________________________________________
 
 1.5. Exported MI Functions
 
-1.5.1. imc_list_rooms
+1.5.1.  imc_list_rooms
 
    Lists of the IM Conferencing rooms.
 
@@ -212,30 +206,26 @@ if(is_method("MESSAGE)
    MI FIFO Command Format:
                 :imc_list_rooms:_reply_fifo_file_
                 _empty_line_
-     __________________________________________________________
 
-1.5.2. imc_list_members
+1.5.2.  imc_list_members
 
    Listing of the members in IM Conferencing rooms.
 
    Name: imc_list_members
 
    Parameters:
-
      * _room_ : the room for which you want to list the members
 
    MI FIFO Command Format:
                 :imc_list_members:_reply_fifo_file_
                 _room_
                 _empty_line_
-     __________________________________________________________
 
 1.6. Exported Statistics
 
-1.6.1. active_rooms
+1.6.1.  active_rooms
 
    Number of active IM Conferencing rooms.
-     __________________________________________________________
 
 1.7. IMC Commands
 
@@ -246,7 +236,7 @@ if(is_method("MESSAGE)
    Next picture presents the list of commands and their
    parameters.
 
-   Example 1-8. List of commands
+   Example 1.8. List of commands
 ...
 
 1.create
@@ -314,7 +304,6 @@ if(is_method("MESSAGE)
   -list members in a room
 
 ...
-     __________________________________________________________
 
 1.8. Installation
 
@@ -326,3 +315,36 @@ if(is_method("MESSAGE)
    openser/scripts folder as template. You can also find the
    complete database documentation on the project webpage,
    http://www.openser.org/docs/db-tables/openser-db-devel.html.
+
+Chapter 2. Frequently Asked Questions
+
+   2.1.
+
+       Where can I find more about OpenSER?
+
+       Take a look at http://openser.org/.
+
+   2.2.
+
+       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://openser.org/cgi-bin/mailman/listinfo/users
+         * Developer Mailing List -
+           http://openser.org/cgi-bin/mailman/listinfo/devel
+
+       E-mails regarding any stable OpenSER 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]>.
+
+   2.3.
+
+       How can I report a bug?
+
+       Please follow the guidelines provided at:
+       http://sourceforge.net/tracker/?group_id=139143.

modules_k/imc/doc/imc.sgml → modules_k/imc/doc/imc.xml

@@ -1,11 +1,13 @@
-<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook V4.2//EN" [
+<?xml version="1.0" encoding='ISO-8859-1'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
 
 
-<!ENTITY user SYSTEM "imc_user.sgml">
-<!ENTITY faq SYSTEM "../../../doc/module_faq.sgml">
+<!ENTITY user SYSTEM "imc_admin.xml">
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
 
 <!-- Include general documentation entities -->
-<!ENTITY % docentities SYSTEM "../../../doc/entities.sgml">
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
 %docentities;
 
 ]>
@@ -29,6 +31,9 @@
 	    <author>
 		<firstname>Daniel-Constantin</firstname>
 		<surname>Mierla</surname>
+		<address>
+		    <email>[email protected]</email>
+		</address>
 	    </author>
 	    <author>
 		<firstname>Stefan</firstname>
@@ -48,8 +53,8 @@
 	</copyright>
 	<revhistory>
 	    <revision>
-		<revnumber>$Revision$</revnumber>
-		<date>$Date$</date>
+		<revnumber>$Revision: 3839 $</revnumber>
+		<date>$Date: 2008-03-04 15:15:47 +0200 (Tue, 04 Mar 2008) $</date>
 	    </revision>
 	</revhistory>
   </bookinfo>

modules_k/imc/doc/imc_user.sgml → modules_k/imc/doc/imc_admin.xml

@@ -204,7 +204,7 @@ modparam("imc", "outbound_proxy", "sip:openser.org;transport=tcp")
 # the rooms will be named chat-xyz to avoid overlapping
 # with usernames
 if(is_method("MESSAGE)
-        && (uri=~ "sip:chat-[0-9]+@" || (uri=~ "sip:chat-manager@")
+        && (uri=~ "sip:chat-[0-9]+@" || (uri=~ "sip:chat-manager@")
     imc_manager();
 ...
 </programlisting>
@@ -228,6 +228,7 @@ if(is_method("MESSAGE)
 
         <para>
 		MI FIFO Command Format:
+		</para>
         <programlisting  format="linespecific">
 		:imc_list_rooms:_reply_fifo_file_
 		_empty_line_
@@ -251,6 +252,7 @@ if(is_method("MESSAGE)
 
         <para>
 		MI FIFO Command Format:
+		</para>
         <programlisting  format="linespecific">
 		:imc_list_members:_reply_fifo_file_
 		_room_