Browse code

modules_k/*: moved k modules in directory modules/

Daniel-Constantin Mierla authored on 20/01/2013 11:57:52
Showing 1 changed files
1 1
deleted file mode 100644
... ...
@@ -1,160 +0,0 @@
1
-<?xml version="1.0" encoding='ISO-8859-1'?>
2
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
-"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
-
5
-<!-- Include general documentation entities -->
6
-<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
7
-%docentities;
8
-
9
-]>
10
-<!-- Module User's Guide -->
11
-
12
-<chapter>
13
-
14
-	<title>User's Guide</title>
15
-
16
-	<section>
17
-	<title>Overview</title>
18
-	<para>
19
-		This is a module which provides Oracle connectivity for &kamailio;.
20
-		It implements the DB API defined in &kamailio;. If you want to use
21
-		the nathelper module, or any other modules that calls the
22
-		get_all_ucontacts API export from usrloc, then you need to set
23
-		the <emphasis>DORACLE_USRLOC</emphasis> define in the Makefile.defs
24
-		file before compilation.
25
-	</para>
26
-	</section>
27
-
28
-	<section>
29
-	<title>Dependencies</title>
30
-	<section>
31
-		<title>&kamailio; Modules</title>
32
-		<para>
33
-		The following modules must be loaded before this module:
34
-			<itemizedlist>
35
-			<listitem>
36
-			<para>
37
-				<emphasis>No dependencies on other &kamailio; modules</emphasis>.
38
-			</para>
39
-			</listitem>
40
-			</itemizedlist>
41
-		</para>
42
-	</section>
43
-	<section>
44
-		<title>External Libraries or Applications</title>
45
-		<para>
46
-		The following libraries or applications must be installed before running
47
-		&kamailio; with this module loaded:
48
-			<itemizedlist>
49
-			<listitem>
50
-			<para>
51
-				<emphasis>instantclient-sdk-10.2.0.3</emphasis> - the development headers and libraries of OCI.
52
-			</para>
53
-			</listitem>
54
-			</itemizedlist>
55
-		</para>
56
-	</section>
57
-	</section>
58
-	<section>
59
-	<title>Parameters</title>
60
-	<section>
61
-		<title><varname>timeout</varname> (fixedpoint)</title>
62
-		<para>
63
-		Timeout value for any operation with BD.
64
-		</para>
65
-		<para>
66
-		Possible values is from 0.1 to 10.0 seconds.
67
-		</para>
68
-		<para>
69
-		<emphasis>
70
-			Default value is 3.0 (3 second).
71
-		</emphasis>
72
-		</para>
73
-		<para>
74
-		If value of timeout parameter set to 0, module use synchronous
75
-		mode (without timeout).
76
-		</para>
77
-		<example>
78
-		<title>Set <varname>timeout</varname> parameter</title>
79
-		<programlisting format="linespecific">
80
-...
81
-modparam("db_oracle", "timeout", 1.5)
82
-...
83
-</programlisting>
84
-		</example>
85
-		<example>
86
-		<title>Disable asynchronous mode</title>
87
-		<programlisting format="linespecific">
88
-...
89
-modparam("db_oracle", "timeout", 0)
90
-...
91
-</programlisting>
92
-		</example>
93
-	</section>
94
-		<section>
95
-		<title><varname>reconnect</varname> (fixedpoint)</title>
96
-		<para>
97
-		Timeout value for connect (create session) operation.
98
-		</para>
99
-		<para>
100
-		Possible values is from 0.1 to 10.0 seconds.
101
-		</para>
102
-		<para>
103
-		<emphasis>
104
-			Default value is 0.2 (200 milliseconds).
105
-		</emphasis>
106
-		</para>
107
-		<example>
108
-		<title>Set <varname>reconnect</varname> parameter</title>
109
-		<programlisting format="linespecific">
110
-...
111
-modparam("db_oracle", "reconnect", 0.5)
112
-...
113
-</programlisting>
114
-		</example>
115
-	</section>
116
-	</section>
117
-	<section>
118
-	<title>Functions</title>
119
-		<para>
120
-		No function exported to be used from configuration file.
121
-		</para>
122
-	</section>
123
-	<section>
124
-	<title>Installation</title>
125
-		<para>
126
-		Because it dependes on an external library, the oracle module is not
127
-		compiled and installed by default. You can use one of the next options.
128
-		</para>
129
-		<itemizedlist>
130
-			<listitem>
131
-			<para>
132
-			- edit the "Makefile" and remove "db_oracle" from "excluded_modules"
133
-			list. Then follow the standard procedure to install &kamailio;:
134
-			"make all; make install".
135
-			</para>
136
-			</listitem>
137
-			<listitem>
138
-			<para>
139
-			- from command line use: 'make all include_modules="db_oracle";
140
-			make install include_modules="db_oracle"'.
141
-			</para>
142
-			</listitem>
143
-		</itemizedlist>
144
-	</section>
145
-	<section>
146
-	<title>Utility openser_orasel</title>
147
-		<para>
148
-		For working with &ctltool; script, should be able to print the 'query' 
149
-		results to the terminal in a user-readable form. The standard command-line 
150
-		Oracle client (sqlplus) is not quite suitable for this, as it cannot align 
151
-		row width to real (received) data's (it always prints a cell width as 
152
-		described in the db scheme). This problem has been solved by inclusion the 
153
-		utility openser_orasel, which formats printing approximately in the same 
154
-		way as the 'mysql' client utility. In addition, this utility known about 
155
-		the "agreements and types" in DB that are used in &kamailio; for the work 
156
-		with Oracle and formats printing taking these into account.
157
-		</para>
158
-	</section>
159
-</chapter>
160
-
Browse code

docbook: consitent titles of main section

- updated various forms of titles to: Functions, Modules, MI Commands

Daniel-Constantin Mierla authored on 02/10/2011 08:42:27
Showing 1 changed files
... ...
@@ -56,7 +56,7 @@
56 56
 	</section>
57 57
 	</section>
58 58
 	<section>
59
-	<title>Exported Parameters</title>
59
+	<title>Parameters</title>
60 60
 	<section>
61 61
 		<title><varname>timeout</varname> (fixedpoint)</title>
62 62
 		<para>
... ...
@@ -115,7 +115,7 @@ modparam("db_oracle", "reconnect", 0.5)
115 115
 	</section>
116 116
 	</section>
117 117
 	<section>
118
-	<title>Exported Functions</title>
118
+	<title>Functions</title>
119 119
 		<para>
120 120
 		No function exported to be used from configuration file.
121 121
 		</para>
Browse code

doc: Removed hardoded kamctl value and replaced it with an XML entity

This will allow for faster documentation changes regarding the ser-kamailio ctl tools unification proposal

Marius Zbihlei authored on 22/04/2010 10:19:58
Showing 1 changed files
... ...
@@ -145,7 +145,7 @@ modparam("db_oracle", "reconnect", 0.5)
145 145
 	<section>
146 146
 	<title>Utility openser_orasel</title>
147 147
 		<para>
148
-		For working with kamctl script, should be able to print the 'query' 
148
+		For working with &ctltool; script, should be able to print the 'query' 
149 149
 		results to the terminal in a user-readable form. The standard command-line 
150 150
 		Oracle client (sqlplus) is not quite suitable for this, as it cannot align 
151 151
 		row width to real (received) data's (it always prints a cell width as 
Browse code

Massively changing "Kamailio" to &kamailio;

oej authored on 18/10/2009 23:34:00
Showing 1 changed files
... ...
@@ -16,8 +16,8 @@
16 16
 	<section>
17 17
 	<title>Overview</title>
18 18
 	<para>
19
-		This is a module which provides Oracle connectivity for Kamailio.
20
-		It implements the DB API defined in Kamailio. If you want to use
19
+		This is a module which provides Oracle connectivity for &kamailio;.
20
+		It implements the DB API defined in &kamailio;. If you want to use
21 21
 		the nathelper module, or any other modules that calls the
22 22
 		get_all_ucontacts API export from usrloc, then you need to set
23 23
 		the <emphasis>DORACLE_USRLOC</emphasis> define in the Makefile.defs
... ...
@@ -152,7 +152,7 @@ modparam("db_oracle", "reconnect", 0.5)
152 152
 		described in the db scheme). This problem has been solved by inclusion the 
153 153
 		utility openser_orasel, which formats printing approximately in the same 
154 154
 		way as the 'mysql' client utility. In addition, this utility known about 
155
-		the "agreements and types" in DB that are used in Kamailio for the work 
155
+		the "agreements and types" in DB that are used in &kamailio; for the work 
156 156
 		with Oracle and formats printing taking these into account.
157 157
 		</para>
158 158
 	</section>
Browse code

Updating docbook sources for the new processing system.

All files now use xi:include to include external files, this mechanism
replaces the entity based inclusion mechanism. It is no longer necessary
to define a new SGML entity to include an external file. External XML
files can be included with:
<xi:include href="filename.xml"/>

External data files (i.e. files that should not be parsed by the XML
parser) can be included with:
<xi:include href="cfg_file.txt" parse="text"/>

The toplevel element of all docbook documents that use the inclusion
mechanism described above must have the following attribute:
xmlns:xi="http://www.w3.org/2001/XIinclude"

XML files included with XInclude must be complete, that means we need to
add the XML header and DOCTYPE to all documents that did not have such
header before (typically docbook files included into other docbook
files).

And finally, all files include the merged entity file in
docbok/entities.xml, this file contains SGML entities from both SER and
kamailio.

Jan Janak authored on 24/04/2009 01:18:58
Showing 1 changed files
... ...
@@ -1,3 +1,12 @@
1
+<?xml version="1.0" encoding='ISO-8859-1'?>
2
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
+
5
+<!-- Include general documentation entities -->
6
+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">
7
+%docentities;
8
+
9
+]>
1 10
 <!-- Module User's Guide -->
2 11
 
3 12
 <chapter>
Browse code

- renaming: changed entities in documentation

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

Klaus Darilion authored on 06/08/2008 10:08:33
Showing 1 changed files
... ...
@@ -19,13 +19,13 @@
19 19
 	<section>
20 20
 	<title>Dependencies</title>
21 21
 	<section>
22
-		<title>&openser; Modules</title>
22
+		<title>&kamailio; Modules</title>
23 23
 		<para>
24 24
 		The following modules must be loaded before this module:
25 25
 			<itemizedlist>
26 26
 			<listitem>
27 27
 			<para>
28
-				<emphasis>No dependencies on other &openser; modules</emphasis>.
28
+				<emphasis>No dependencies on other &kamailio; modules</emphasis>.
29 29
 			</para>
30 30
 			</listitem>
31 31
 			</itemizedlist>
... ...
@@ -35,7 +35,7 @@
35 35
 		<title>External Libraries or Applications</title>
36 36
 		<para>
37 37
 		The following libraries or applications must be installed before running
38
-		&openser; with this module loaded:
38
+		&kamailio; with this module loaded:
39 39
 			<itemizedlist>
40 40
 			<listitem>
41 41
 			<para>
... ...
@@ -121,7 +121,7 @@ modparam("db_oracle", "reconnect", 0.5)
121 121
 			<listitem>
122 122
 			<para>
123 123
 			- edit the "Makefile" and remove "db_oracle" from "excluded_modules"
124
-			list. Then follow the standard procedure to install &openser;:
124
+			list. Then follow the standard procedure to install &kamailio;:
125 125
 			"make all; make install".
126 126
 			</para>
127 127
 			</listitem>
Browse code

- renaming: openser -> kamailio

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

Klaus Darilion authored on 06/08/2008 08:20:30
Showing 1 changed files
... ...
@@ -7,8 +7,8 @@
7 7
 	<section>
8 8
 	<title>Overview</title>
9 9
 	<para>
10
-		This is a module which provides Oracle connectivity for OpenSER.
11
-		It implements the DB API defined in OpenSER. If you want to use
10
+		This is a module which provides Oracle connectivity for Kamailio.
11
+		It implements the DB API defined in Kamailio. If you want to use
12 12
 		the nathelper module, or any other modules that calls the
13 13
 		get_all_ucontacts API export from usrloc, then you need to set
14 14
 		the <emphasis>DORACLE_USRLOC</emphasis> define in the Makefile.defs
... ...
@@ -143,7 +143,7 @@ modparam("db_oracle", "reconnect", 0.5)
143 143
 		described in the db scheme). This problem has been solved by inclusion the 
144 144
 		utility openser_orasel, which formats printing approximately in the same 
145 145
 		way as the 'mysql' client utility. In addition, this utility known about 
146
-		the "agreements and types" in DB that are used in OpenSER for the work 
146
+		the "agreements and types" in DB that are used in Kamailio for the work 
147 147
 		with Oracle and formats printing taking these into account.
148 148
 		</para>
149 149
 	</section>
Browse code

- renaming scripts part 1

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

Klaus Darilion authored on 05/08/2008 15:29:23
Showing 1 changed files
... ...
@@ -136,7 +136,7 @@ modparam("db_oracle", "reconnect", 0.5)
136 136
 	<section>
137 137
 	<title>Utility openser_orasel</title>
138 138
 		<para>
139
-		For working with openserctl script, should be able to print the 'query' 
139
+		For working with kamctl script, should be able to print the 'query' 
140 140
 		results to the terminal in a user-readable form. The standard command-line 
141 141
 		Oracle client (sqlplus) is not quite suitable for this, as it cannot align 
142 142
 		row width to real (received) data's (it always prints a cell width as 
Browse code

- add a new define 'ORACLE_USRLOC' as short term fix before the code freeze - in 1.5 this will be removed again and fixed by introduction of some new DB API functions, as discussed on the devel list

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

Henning Westerholt authored on 02/06/2008 10:51:04
Showing 1 changed files
... ...
@@ -8,7 +8,11 @@
8 8
 	<title>Overview</title>
9 9
 	<para>
10 10
 		This is a module which provides Oracle connectivity for OpenSER.
11
-		It implements the DB API defined in OpenSER.
11
+		It implements the DB API defined in OpenSER. If you want to use
12
+		the nathelper module, or any other modules that calls the
13
+		get_all_ucontacts API export from usrloc, then you need to set
14
+		the <emphasis>DORACLE_USRLOC</emphasis> define in the Makefile.defs
15
+		file before compilation.
12 16
 	</para>
13 17
 	</section>
14 18
 
Browse code

- fix entities for db_oracle documentation

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

Henning Westerholt authored on 24/04/2008 10:29:31
Showing 1 changed files
... ...
@@ -15,13 +15,13 @@
15 15
 	<section>
16 16
 	<title>Dependencies</title>
17 17
 	<section>
18
-		<title>&ser; Modules</title>
18
+		<title>&openser; Modules</title>
19 19
 		<para>
20 20
 		The following modules must be loaded before this module:
21 21
 			<itemizedlist>
22 22
 			<listitem>
23 23
 			<para>
24
-				<emphasis>No dependencies on other &ser; modules</emphasis>.
24
+				<emphasis>No dependencies on other &openser; modules</emphasis>.
25 25
 			</para>
26 26
 			</listitem>
27 27
 			</itemizedlist>
... ...
@@ -31,7 +31,7 @@
31 31
 		<title>External Libraries or Applications</title>
32 32
 		<para>
33 33
 		The following libraries or applications must be installed before running
34
-		&ser; with this module loaded:
34
+		&openser; with this module loaded:
35 35
 			<itemizedlist>
36 36
 			<listitem>
37 37
 			<para>
... ...
@@ -117,7 +117,7 @@ modparam("db_oracle", "reconnect", 0.5)
117 117
 			<listitem>
118 118
 			<para>
119 119
 			- edit the "Makefile" and remove "db_oracle" from "excluded_modules"
120
-			list. Then follow the standard procedure to install &ser;:
120
+			list. Then follow the standard procedure to install &openser;:
121 121
 			"make all; make install".
122 122
 			</para>
123 123
 			</listitem>
Browse code

Add db_oracle module and toolses for it

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

Iouri Kharon authored on 09/04/2008 15:46:09
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,147 @@
1
+<!-- Module User's Guide -->
2
+
3
+<chapter>
4
+
5
+	<title>User's Guide</title>
6
+
7
+	<section>
8
+	<title>Overview</title>
9
+	<para>
10
+		This is a module which provides Oracle connectivity for OpenSER.
11
+		It implements the DB API defined in OpenSER.
12
+	</para>
13
+	</section>
14
+
15
+	<section>
16
+	<title>Dependencies</title>
17
+	<section>
18
+		<title>&ser; Modules</title>
19
+		<para>
20
+		The following modules must be loaded before this module:
21
+			<itemizedlist>
22
+			<listitem>
23
+			<para>
24
+				<emphasis>No dependencies on other &ser; modules</emphasis>.
25
+			</para>
26
+			</listitem>
27
+			</itemizedlist>
28
+		</para>
29
+	</section>
30
+	<section>
31
+		<title>External Libraries or Applications</title>
32
+		<para>
33
+		The following libraries or applications must be installed before running
34
+		&ser; with this module loaded:
35
+			<itemizedlist>
36
+			<listitem>
37
+			<para>
38
+				<emphasis>instantclient-sdk-10.2.0.3</emphasis> - the development headers and libraries of OCI.
39
+			</para>
40
+			</listitem>
41
+			</itemizedlist>
42
+		</para>
43
+	</section>
44
+	</section>
45
+	<section>
46
+	<title>Exported Parameters</title>
47
+	<section>
48
+		<title><varname>timeout</varname> (fixedpoint)</title>
49
+		<para>
50
+		Timeout value for any operation with BD.
51
+		</para>
52
+		<para>
53
+		Possible values is from 0.1 to 10.0 seconds.
54
+		</para>
55
+		<para>
56
+		<emphasis>
57
+			Default value is 3.0 (3 second).
58
+		</emphasis>
59
+		</para>
60
+		<para>
61
+		If value of timeout parameter set to 0, module use synchronous
62
+		mode (without timeout).
63
+		</para>
64
+		<example>
65
+		<title>Set <varname>timeout</varname> parameter</title>
66
+		<programlisting format="linespecific">
67
+...
68
+modparam("db_oracle", "timeout", 1.5)
69
+...
70
+</programlisting>
71
+		</example>
72
+		<example>
73
+		<title>Disable asynchronous mode</title>
74
+		<programlisting format="linespecific">
75
+...
76
+modparam("db_oracle", "timeout", 0)
77
+...
78
+</programlisting>
79
+		</example>
80
+	</section>
81
+		<section>
82
+		<title><varname>reconnect</varname> (fixedpoint)</title>
83
+		<para>
84
+		Timeout value for connect (create session) operation.
85
+		</para>
86
+		<para>
87
+		Possible values is from 0.1 to 10.0 seconds.
88
+		</para>
89
+		<para>
90
+		<emphasis>
91
+			Default value is 0.2 (200 milliseconds).
92
+		</emphasis>
93
+		</para>
94
+		<example>
95
+		<title>Set <varname>reconnect</varname> parameter</title>
96
+		<programlisting format="linespecific">
97
+...
98
+modparam("db_oracle", "reconnect", 0.5)
99
+...
100
+</programlisting>
101
+		</example>
102
+	</section>
103
+	</section>
104
+	<section>
105
+	<title>Exported Functions</title>
106
+		<para>
107
+		No function exported to be used from configuration file.
108
+		</para>
109
+	</section>
110
+	<section>
111
+	<title>Installation</title>
112
+		<para>
113
+		Because it dependes on an external library, the oracle module is not
114
+		compiled and installed by default. You can use one of the next options.
115
+		</para>
116
+		<itemizedlist>
117
+			<listitem>
118
+			<para>
119
+			- edit the "Makefile" and remove "db_oracle" from "excluded_modules"
120
+			list. Then follow the standard procedure to install &ser;:
121
+			"make all; make install".
122
+			</para>
123
+			</listitem>
124
+			<listitem>
125
+			<para>
126
+			- from command line use: 'make all include_modules="db_oracle";
127
+			make install include_modules="db_oracle"'.
128
+			</para>
129
+			</listitem>
130
+		</itemizedlist>
131
+	</section>
132
+	<section>
133
+	<title>Utility openser_orasel</title>
134
+		<para>
135
+		For working with openserctl script, should be able to print the 'query' 
136
+		results to the terminal in a user-readable form. The standard command-line 
137
+		Oracle client (sqlplus) is not quite suitable for this, as it cannot align 
138
+		row width to real (received) data's (it always prints a cell width as 
139
+		described in the db scheme). This problem has been solved by inclusion the 
140
+		utility openser_orasel, which formats printing approximately in the same 
141
+		way as the 'mysql' client utility. In addition, this utility known about 
142
+		the "agreements and types" in DB that are used in OpenSER for the work 
143
+		with Oracle and formats printing taking these into account.
144
+		</para>
145
+	</section>
146
+</chapter>
147
+