Browse code

kex: added module documentation

- added source XML files and generated README

Daniel-Constantin Mierla authored on 16/04/2009 20:08:04
Showing 3 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,130 @@
1
+KEx Module
2
+
3
+Daniel-Constantin Mierla
4
+
5
+   asipto.com
6
+   <miconda@gmail.com>
7
+
8
+Edited by
9
+
10
+Daniel-Constantin Mierla
11
+
12
+   <miconda@gmail.com>
13
+
14
+   Copyright � 2009 Daniel-Constantin Mierla
15
+     __________________________________________________________
16
+
17
+   Table of Contents
18
+
19
+   1. Admin Guide
20
+
21
+        1.1. Overview
22
+        1.2. Dependencies
23
+
24
+              1.2.1. Kamailio Modules
25
+              1.2.2. External Libraries or Applications
26
+
27
+        1.3. Exported MI Functions
28
+
29
+              1.3.1. arg
30
+              1.3.2. kill
31
+              1.3.3. pwd
32
+              1.3.4. uptime
33
+              1.3.5. version
34
+              1.3.6. which
35
+
36
+Chapter 1. Admin Guide
37
+
38
+1.1. Overview
39
+
40
+   This module collects extensions from Kamailio core.
41
+
42
+   Kamailio Core CookBook is available at:
43
+   http://kamailio.org/dokuwiki/
44
+
45
+1.2. Dependencies
46
+
47
+1.2.1. Kamailio Modules
48
+
49
+   The following modules must be loaded before this module:
50
+     * No dependencies on other Kamailio modules.
51
+
52
+1.2.2. External Libraries or Applications
53
+
54
+   The following libraries or applications must be installed
55
+   before running Kamailio with this module loaded:
56
+     * None.
57
+
58
+1.3. Exported MI Functions
59
+
60
+1.3.1.  arg
61
+
62
+   Print command line arguments.
63
+
64
+   Name: arg
65
+
66
+   Parameters: none.
67
+
68
+   MI FIFO Command Format:
69
+                :arg:_reply_fifo_file_
70
+                _empty_line_
71
+
72
+1.3.2.  kill
73
+
74
+   Kill the application.
75
+
76
+   Name: kill
77
+
78
+   Parameters: none.
79
+
80
+   MI FIFO Command Format:
81
+                :kill:_reply_fifo_file_
82
+                _empty_line_
83
+
84
+1.3.3.  pwd
85
+
86
+   Print working directory.
87
+
88
+   Name: pwd
89
+
90
+   Parameters: none.
91
+
92
+   MI FIFO Command Format:
93
+                :pwd:_reply_fifo_file_
94
+                _empty_line_
95
+
96
+1.3.4.  uptime
97
+
98
+   Print uptime.
99
+
100
+   Name: uptime
101
+
102
+   Parameters: none.
103
+
104
+   MI FIFO Command Format:
105
+                :uptime:_reply_fifo_file_
106
+                _empty_line_
107
+
108
+1.3.5.  version
109
+
110
+   Print version information.
111
+
112
+   Name: version
113
+
114
+   Parameters: none.
115
+
116
+   MI FIFO Command Format:
117
+                :version:_reply_fifo_file_
118
+                _empty_line_
119
+
120
+1.3.6.  which
121
+
122
+   Print list of available MI commands.
123
+
124
+   Name: which
125
+
126
+   Parameters: none.
127
+
128
+   MI FIFO Command Format:
129
+                :which:_reply_fifo_file_
130
+                _empty_line_
0 131
new file mode 100644
... ...
@@ -0,0 +1,47 @@
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
+
6
+<!ENTITY admin SYSTEM "kex_admin.xml">
7
+<!ENTITY faq SYSTEM "../../../doc/module_faq.xml">
8
+
9
+<!-- Include general documentation entities -->
10
+<!ENTITY % docentities SYSTEM "../../../doc/entities.xml">
11
+%docentities;
12
+
13
+]>
14
+
15
+<book>
16
+    <bookinfo>
17
+	<title>KEx Module</title>
18
+	<productname class="trade">&kamailioname;</productname>
19
+	<authorgroup>
20
+	    <author>
21
+		<firstname>Daniel-Constantin</firstname>
22
+		<surname>Mierla</surname>
23
+		<affiliation><orgname>asipto.com</orgname></affiliation>
24
+		<email>miconda@gmail.com</email>
25
+		<address>
26
+		<otheraddr>
27
+		<ulink url="http://www.asipto.com">http://www.asipto.com</ulink>
28
+		</otheraddr>
29
+		</address>
30
+	    </author>
31
+	    <editor>
32
+		<firstname>Daniel-Constantin</firstname>
33
+		<surname>Mierla</surname>
34
+		<email>miconda@gmail.com</email>
35
+	    </editor>
36
+	</authorgroup>
37
+	<copyright>
38
+	    <year>2009</year>
39
+	    <holder>Daniel-Constantin Mierla</holder>
40
+	</copyright>
41
+    </bookinfo>
42
+    <toc></toc>
43
+    
44
+    &admin;
45
+    &faq;
46
+    
47
+</book>
0 48
new file mode 100644
... ...
@@ -0,0 +1,169 @@
1
+<!-- Module User's Guide -->
2
+
3
+<chapter>
4
+	
5
+	<title>&adminguide;</title>
6
+	
7
+	<section>
8
+	<title>Overview</title>
9
+	<para>
10
+	This module collects extensions from Kamailio core.
11
+	</para>
12
+	<para>
13
+	Kamailio Core CookBook is available at:
14
+	<ulink url="http://kamailio.org/dokuwiki/">
15
+	http://kamailio.org/dokuwiki/</ulink>
16
+	</para>
17
+	</section>
18
+	
19
+	<section>
20
+	<title>Dependencies</title>
21
+	<section>
22
+		<title>&kamailio; Modules</title>
23
+		<para>
24
+		The following modules must be loaded before this module:
25
+			<itemizedlist>
26
+			<listitem>
27
+			<para>
28
+				<emphasis>No dependencies on other &kamailio; modules</emphasis>.
29
+			</para>
30
+			</listitem>
31
+			</itemizedlist>
32
+		</para>
33
+	</section>
34
+	<section>
35
+		<title>External Libraries or Applications</title>
36
+		<para>
37
+		The following libraries or applications must be installed before running
38
+		&kamailio; with this module loaded:
39
+			<itemizedlist>
40
+			<listitem>
41
+			<para>
42
+				<emphasis>None</emphasis>.
43
+			</para>
44
+			</listitem>
45
+			</itemizedlist>
46
+		</para>
47
+	</section>
48
+	</section>
49
+
50
+	<section>
51
+	<title>Exported MI Functions</title>
52
+	<section>
53
+		<title>
54
+		<function moreinfo="none">arg</function>
55
+		</title>
56
+		<para>
57
+		Print command line arguments.
58
+		</para>
59
+		<para>
60
+		Name: <emphasis>arg</emphasis>
61
+		</para>
62
+		<para>Parameters: <emphasis>none</emphasis>.</para>
63
+ 		<para>
64
+		MI FIFO Command Format:
65
+		</para>
66
+        <programlisting  format="linespecific">
67
+		:arg:_reply_fifo_file_
68
+		_empty_line_
69
+		</programlisting>
70
+    </section>
71
+	<section>
72
+		<title>
73
+		<function moreinfo="none">kill</function>
74
+		</title>
75
+		<para>
76
+		Kill the application.
77
+		</para>
78
+		<para>
79
+		Name: <emphasis>kill</emphasis>
80
+		</para>
81
+		<para>Parameters: <emphasis>none</emphasis>.</para>
82
+ 		<para>
83
+		MI FIFO Command Format:
84
+		</para>
85
+        <programlisting  format="linespecific">
86
+		:kill:_reply_fifo_file_
87
+		_empty_line_
88
+		</programlisting>
89
+    </section>
90
+	<section>
91
+		<title>
92
+		<function moreinfo="none">pwd</function>
93
+		</title>
94
+		<para>
95
+		Print working directory.
96
+		</para>
97
+		<para>
98
+		Name: <emphasis>pwd</emphasis>
99
+		</para>
100
+		<para>Parameters: <emphasis>none</emphasis>.</para>
101
+ 		<para>
102
+		MI FIFO Command Format:
103
+		</para>
104
+        <programlisting  format="linespecific">
105
+		:pwd:_reply_fifo_file_
106
+		_empty_line_
107
+		</programlisting>
108
+    </section>
109
+	<section>
110
+		<title>
111
+		<function moreinfo="none">uptime</function>
112
+		</title>
113
+		<para>
114
+		Print uptime.
115
+		</para>
116
+		<para>
117
+		Name: <emphasis>uptime</emphasis>
118
+		</para>
119
+		<para>Parameters: <emphasis>none</emphasis>.</para>
120
+ 		<para>
121
+		MI FIFO Command Format:
122
+		</para>
123
+        <programlisting  format="linespecific">
124
+		:uptime:_reply_fifo_file_
125
+		_empty_line_
126
+		</programlisting>
127
+    </section>
128
+	<section>
129
+		<title>
130
+		<function moreinfo="none">version</function>
131
+		</title>
132
+		<para>
133
+		Print version information.
134
+		</para>
135
+		<para>
136
+		Name: <emphasis>version</emphasis>
137
+		</para>
138
+		<para>Parameters: <emphasis>none</emphasis>.</para>
139
+ 		<para>
140
+		MI FIFO Command Format:
141
+		</para>
142
+        <programlisting  format="linespecific">
143
+		:version:_reply_fifo_file_
144
+		_empty_line_
145
+		</programlisting>
146
+    </section>
147
+	<section>
148
+		<title>
149
+		<function moreinfo="none">which</function>
150
+		</title>
151
+		<para>
152
+		Print list of available MI commands.
153
+		</para>
154
+		<para>
155
+		Name: <emphasis>which</emphasis>
156
+		</para>
157
+		<para>Parameters: <emphasis>none</emphasis>.</para>
158
+ 		<para>
159
+		MI FIFO Command Format:
160
+		</para>
161
+        <programlisting  format="linespecific">
162
+		:which:_reply_fifo_file_
163
+		_empty_line_
164
+		</programlisting>
165
+    </section>
166
+    </section>
167
+
168
+</chapter>
169
+