Browse code

sipcapture Update to README xml files (section IDs)

Olle E. Johansson authored on 03/04/2013 18:53:49
Showing 2 changed files
... ...
@@ -66,7 +66,7 @@ Alexandr Dubovikov
66 66
    1.8. Set raw_ipip_capture_on parameter
67 67
    1.9. Set raw_moni_capture_on parameter
68 68
    1.10. Set raw_socket_listen parameter
69
-   1.11. Set raw_socket_listen parameter
69
+   1.11. Set raw_interface parameter
70 70
    1.12. Set raw_sock_children parameter
71 71
    1.13. Set promiscous_on parameter
72 72
    1.14. Set raw_moni_bpf_on parameter
... ...
@@ -301,7 +301,7 @@ modparam("sipcapture", "raw_socket_listen", "10.0.0.1:5060")
301 301
 
302 302
    Default value is "".
303 303
 
304
-   Example 1.11. Set raw_socket_listen parameter
304
+   Example 1.11. Set raw_interface parameter
305 305
 ...
306 306
 modparam("sipcapture", "raw_interface", "eth0")
307 307
 ...
... ...
@@ -359,7 +359,7 @@ modparam("sipcapture", "capture_node", "homer03")
359 359
 
360 360
    4.1. sip_capture
361 361
 
362
-4.1.  sip_capture
362
+4.1. sip_capture
363 363
 
364 364
    Name: sip_capture
365 365
 
... ...
@@ -381,7 +381,7 @@ modparam("sipcapture", "capture_node", "homer03")
381 381
 
382 382
    5.1. sipcapture.status param
383 383
 
384
-5.1.  sipcapture.status param
384
+5.1. sipcapture.status param
385 385
 
386 386
    Name: sipcapture.status
387 387
 
... ...
@@ -82,7 +82,7 @@
82 82
 	</section>
83 83
 	<section>
84 84
 	<title>Parameters</title>
85
-	<section>
85
+	<section id="sipcapture.p.db_url">
86 86
 		<title><varname>db_url</varname> (str)</title>
87 87
 		<para>
88 88
 		Database URL.
... ...
@@ -101,7 +101,7 @@ modparam("sipcapture", "db_url", "mysql://user:passwd@host/dbname")
101 101
 </programlisting>
102 102
 		</example>
103 103
 	</section>
104
-	<section>
104
+	<section id="sipcapture.p.table_name">
105 105
 		<title><varname>table_name</varname> (str)</title>
106 106
 		<para>
107 107
 		Name of the table's name used to store the SIP messages. Can contain multiple tables, separated by "|".
... ...
@@ -122,7 +122,7 @@ modparam("sipcapture", "table_name", "homer_capture1|homer_capture2");
122 122
 </programlisting>
123 123
 		</example>
124 124
 	</section>
125
-	<section>
125
+	<section id="sipcapture.p.mt_mode">
126 126
 		<title><varname>mt_mode</varname> (str)</title>
127 127
 		<para>
128 128
 		Name of the mode used for storing data in multiple tables. Modes can be "rand" (random), "round_robin" (use a round_robin algorithm) or "hash" (use hashing to determine the table to store). These modes are only triggered if there is more than one table specified in table_name parameter, separated by "|". 
... ...
@@ -141,7 +141,7 @@ modparam("sipcapture", "mt_mode", "hash")
141 141
 </programlisting>
142 142
 		</example>
143 143
 	</section>
144
-	<section>
144
+	<section id="sipcapture.p.hash_source">
145 145
 		<title><varname>hash_source</varname> (str)</title>
146 146
 		<para>
147 147
 		The field of the SIP message used for hashing, when mt_mode is set to "hash". The value can be "call_id", "to_user" or "from_user".
... ...
@@ -160,7 +160,7 @@ modparam("sipcapture", "hash_source", "to_user")
160 160
 </programlisting>
161 161
 		</example>
162 162
 	</section>
163
-        <section>
163
+	<section id="sipcapture.p.db_insert_mode">
164 164
                 <title><varname>db_insert_mode</varname> (integer)</title>
165 165
                 <para>
166 166
                 If set to 1, use INSERT DELAYED to store sip message into capture table
... ...
@@ -177,7 +177,7 @@ modparam("sipcapture", "db_insert_mode", 1)
177 177
 </programlisting>
178 178
                 </example>
179 179
         </section>
180
-	<section>
180
+	<section id="sipcapture.p.capture_on">
181 181
 		<title><varname>capture_on</varname> (integer)</title>
182 182
 		<para>
183 183
 		Parameter to enable/disable capture globaly (on(1)/off(0))
... ...
@@ -196,7 +196,7 @@ modparam("sipcapture", "capture_on", 1)
196 196
 </programlisting>
197 197
 		</example>
198 198
 	</section>
199
-        <section>
199
+	<section id="sipcapture.p.hep_capture_on">
200 200
                 <title><varname>hep_capture_on</varname> (integer)</title>
201 201
                 <para>
202 202
                 Parameter to enable/disable capture of HEP (on(1)/off(0))
... ...
@@ -215,7 +215,7 @@ modparam("sipcapture", "hep_capture_on", 1)
215 215
 </programlisting>
216 216
                 </example>
217 217
         </section>
218
-        <section>
218
+	<section id="sipcapture.p.raw_ipip_capture_on">
219 219
                 <title><varname>raw_ipip_capture_on</varname> (integer)</title>
220 220
                 <para>
221 221
                 Parameter to enable/disable IPIP capturing (on(1)/off(0))
... ...
@@ -234,7 +234,7 @@ modparam("sipcapture", "raw_ipip_capture_on", 1)
234 234
 </programlisting>
235 235
                 </example>
236 236
         </section>
237
-        <section>
237
+	<section id="sipcapture.p.raw_moni_capture_on">
238 238
                 <title><varname>raw_moni_capture_on</varname> (integer)</title>
239 239
                 <para>
240 240
                 Parameter to enable/disable monitoring/mirroring port capturing (on(1)/off(0))
... ...
@@ -255,7 +255,7 @@ modparam("sipcapture", "raw_moni_capture_on", 1)
255 255
 		</programlisting>
256 256
                 </example>
257 257
         </section>
258
-	<section>
258
+	<section id="sipcapture.p.raw_socket_listen">
259 259
                 <title><varname>raw_socket_listen</varname> (string)</title>
260 260
                 <para>
261 261
                 Parameter indicate an listen IP address of RAW socket for IPIP capturing. 
... ...
@@ -290,7 +290,7 @@ modparam("sipcapture", "raw_socket_listen", "10.0.0.1:5060")
290 290
 </programlisting>
291 291
                 </example>
292 292
         </section>
293
-       <section>
293
+	<section id="sipcapture.p.raw_interface">
294 294
                 <title><varname>raw_interface</varname> (string)</title>
295 295
 		<para>
296 296
 		Name of the interface to bind on the raw socket.
... ...
@@ -301,7 +301,7 @@ modparam("sipcapture", "raw_socket_listen", "10.0.0.1:5060")
301 301
                 </emphasis>
302 302
                 </para>
303 303
                 <example>
304
-                <title>Set <varname>raw_socket_listen</varname> parameter</title>
304
+                <title>Set <varname>raw_interface</varname> parameter</title>
305 305
                 <programlisting format="linespecific">
306 306
 ...
307 307
 modparam("sipcapture", "raw_interface", "eth0")
... ...
@@ -309,7 +309,7 @@ modparam("sipcapture", "raw_interface", "eth0")
309 309
 </programlisting>
310 310
                 </example>
311 311
         </section>
312
-        <section>
312
+	<section id="sipcapture.p.raw_sock_children">
313 313
                 <title><varname>raw_sock_children</varname> (integer)</title>
314 314
                 <para>
315 315
 		Parameter define how many children that must be created to listen the raw socket.
... ...
@@ -328,7 +328,7 @@ modparam("sipcapture", "raw_sock_children", 6)
328 328
 </programlisting>
329 329
                 </example>
330 330
         </section>
331
-        <section>
331
+	<section id="sipcapture.p.promiscuous_on">
332 332
                 <title><varname>promiscuous_on</varname> (integer)</title>
333 333
                 <para>
334 334
                 Parameter to enable/disable promiscuous mode on the raw socket.
... ...
@@ -348,7 +348,7 @@ modparam("sipcapture", "promiscuous_on", 1)
348 348
 </programlisting>
349 349
                 </example>
350 350
         </section>
351
-        <section>
351
+	<section id="sipcapture.p.raw_moni_bpf_on">
352 352
                 <title><varname>raw_moni_bpf_on</varname> (integer)</title>
353 353
                 <para>
354 354
                 Activate Linux Socket Filter (LSF based on BPF) on the mirroring interface. 
... ...
@@ -369,7 +369,7 @@ modparam("sipcapture", "raw_moni_bpf_on", 1)
369 369
 </programlisting>
370 370
                 </example>
371 371
         </section>        
372
-	<section>
372
+	<section id="sipcapture.p.capture_node">
373 373
 		<title><varname>capture_node</varname> (str)</title>
374 374
 		<para>
375 375
 		Name of the capture node.
... ...
@@ -391,7 +391,7 @@ modparam("sipcapture", "capture_node", "homer03")
391 391
 </section>	
392 392
     <section>
393 393
 	<title>MI Commands</title>
394
-	<section>
394
+	<section id="sipcapture.m.sip_capture">
395 395
 		<title>
396 396
 		<function moreinfo="none">sip_capture</function>
397 397
 		</title>
... ...
@@ -428,7 +428,7 @@ modparam("sipcapture", "capture_node", "homer03")
428 428
 	</section><!-- MI commands -->
429 429
     	<section>
430 430
 	<title>RPC Commands</title>
431
-	<section>
431
+	<section id="sipcapture.r.sipcapture.status">
432 432
 		<title>
433 433
 		<function moreinfo="none">sipcapture.status param</function>
434 434
 		</title>