[SR-Dev] git:janakj/mysql: - modules documentation migrated from sgml to xml docbook format

Module: sip-router Branch: janakj/mysql Commit: 949364089c4b64ed6221bc20854491b1e89f80b7 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=9493640… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Mar 7 18:19:45 2008 +0000 - 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/db_mysql/km_README | 65 ++++++++++++++------ .../km_doc/{db_mysql.sgml => db_mysql.xml} | 22 +++---- .../{db_mysql_user.sgml => db_mysql_admin.xml} | 0 3 files changed, 56 insertions(+), 31 deletions(-) diff --git a/modules/db_mysql/km_README b/modules/db_mysql/km_README index 69101ff..cae7ce3 100644 --- a/modules/db_mysql/km_README +++ b/modules/db_mysql/km_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 + &lt;users(a)openser.org&gt; and e-mails regarding development versions + should be sent to &lt;devel(a)openser.org&gt;rg>. + + If you want to keep the mail private, send it to + &lt;team(a)openser.org&gt;rg>. + + 2.3. + + How can I report a bug? + + Please follow the guidelines provided at: + http://sourceforge.net/tracker/?group_id=139143. diff --git a/modules/db_mysql/km_doc/db_mysql.sgml b/modules/db_mysql/km_doc/db_mysql.xml similarity index 56% rename from modules/db_mysql/km_doc/db_mysql.sgml rename to modules/db_mysql/km_doc/db_mysql.xml index 509e408..eb12501 100644 --- a/modules/db_mysql/km_doc/db_mysql.sgml +++ b/modules/db_mysql/km_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> - &lt;email&gt;daniel(a)voice-system.ro&lt;/email&gt; - <otheraddr> - <ulink url="http://www.voice-system.ro">http://www.voice-system.ro</ulink> - </otheraddr> + &lt;email&gt;miconda(a)gmail.com&lt;/email&gt; </address> </author> <editor> <firstname>Daniel-Constantin</firstname> <surname>Mierla</surname> <address> - &lt;email&gt;danile(a)voice-system.ro&lt;/email&gt; + &lt;email&gt;miconda(a)gmail.com&lt;/email&gt; </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> diff --git a/modules/db_mysql/km_doc/db_mysql_user.sgml b/modules/db_mysql/km_doc/db_mysql_admin.xml similarity index 100% rename from modules/db_mysql/km_doc/db_mysql_user.sgml rename to modules/db_mysql/km_doc/db_mysql_admin.xml