Browse code

modules: readme files regenerated - debugger ...

Kamailio Dev authored on 02/01/2017 08:16:30
Showing 2 changed files
... ...
@@ -49,26 +49,19 @@ Daniel-Constantin Mierla
49 49
               4.2. dbg_pv_dump([mask] [, level])
50 50
               4.3. dbg_sip_msg([log_level], [facility])
51 51
 
52
-        5. Exported MI Functions
52
+        5. RPC Commands
53 53
 
54
-              5.1. set_dbg_mod_level mod_name level
55
-              5.2. set_dbg_mod_facility mod_name facility
56
-              5.3. get_dbg_mod_level mod_name
57
-              5.4. get_dbg_mod_facility mod_name
54
+              5.1. dbg.ls
55
+              5.2. dbg.trace
56
+              5.3. dbg.bp
57
+              5.4. dbg.mod_level
58
+              5.5. dbg.reset_msgid
59
+              5.6. dbg.set_mod_level
60
+              5.7. dbg.set_mod_facility
61
+              5.8. dbg.get_mod_level
62
+              5.9. dbg.get_mod_facility
58 63
 
59
-        6. Exported RPC Functions
60
-
61
-              6.1. dbg.ls
62
-              6.2. dbg.trace
63
-              6.3. dbg.bp
64
-              6.4. dbg.mod_level
65
-              6.5. dbg.reset_msgid
66
-              6.6. dbg.set_mod_level
67
-              6.7. dbg.set_mod_facility
68
-              6.8. dbg.get_mod_level
69
-              6.9. dbg.get_mod_facility
70
-
71
-        7. Usage
64
+        6. Usage
72 65
 
73 66
    List of Examples
74 67
 
... ...
@@ -92,10 +85,6 @@ Daniel-Constantin Mierla
92 85
    1.18. dbg_breakpoint usage
93 86
    1.19. dbg_pv_dump usage
94 87
    1.20. dbg_sip_msg usage
95
-   1.21. set_dbg_mod_level usage
96
-   1.22. set_dbg_mod_facility usage
97
-   1.23. get_dbg_mod_level usage
98
-   1.24. get_dbg_mod_facility usage
99 88
 
100 89
 Chapter 1. Admin Guide
101 90
 
... ...
@@ -133,26 +122,19 @@ Chapter 1. Admin Guide
133 122
         4.2. dbg_pv_dump([mask] [, level])
134 123
         4.3. dbg_sip_msg([log_level], [facility])
135 124
 
136
-   5. Exported MI Functions
137
-
138
-        5.1. set_dbg_mod_level mod_name level
139
-        5.2. set_dbg_mod_facility mod_name facility
140
-        5.3. get_dbg_mod_level mod_name
141
-        5.4. get_dbg_mod_facility mod_name
142
-
143
-   6. Exported RPC Functions
125
+   5. RPC Commands
144 126
 
145
-        6.1. dbg.ls
146
-        6.2. dbg.trace
147
-        6.3. dbg.bp
148
-        6.4. dbg.mod_level
149
-        6.5. dbg.reset_msgid
150
-        6.6. dbg.set_mod_level
151
-        6.7. dbg.set_mod_facility
152
-        6.8. dbg.get_mod_level
153
-        6.9. dbg.get_mod_facility
127
+        5.1. dbg.ls
128
+        5.2. dbg.trace
129
+        5.3. dbg.bp
130
+        5.4. dbg.mod_level
131
+        5.5. dbg.reset_msgid
132
+        5.6. dbg.set_mod_level
133
+        5.7. dbg.set_mod_facility
134
+        5.8. dbg.get_mod_level
135
+        5.9. dbg.get_mod_facility
154 136
 
155
-   7. Usage
137
+   6. Usage
156 138
 
157 139
 1. Overview
158 140
 
... ...
@@ -552,71 +534,19 @@ P-Hint: My hint
552 534
 ------------------------------- SIP body diffs --------------------------------
553 535
 -------------------------- END OF SIP message debug ---------------------------
554 536
 
555
-5. Exported MI Functions
556
-
557
-   5.1. set_dbg_mod_level mod_name level
558
-   5.2. set_dbg_mod_facility mod_name facility
559
-   5.3. get_dbg_mod_level mod_name
560
-   5.4. get_dbg_mod_facility mod_name
561
-
562
-5.1. set_dbg_mod_level mod_name level
563
-
564
-   Set the module log level. If module does not exist in kamailio, the
565
-   entry in the level hashtable is still added for the bogus module.
566
-
567
-   Example 1.21. set_dbg_mod_level usage
568
-...
569
-$ kamctl fifo set_dbg_mod_level core 2
570
-$ kamctl fifo set_dbg_mod_level debugger 3
571
-...
572
-
573
-5.2. set_dbg_mod_facility mod_name facility
574
-
575
-   Set the mod_name log facility. If mod_name does not exist in kamailio,
576
-   the entry in the facility hashtable is still added for the bogus
577
-   mod_name.
578
-
579
-   Example 1.22. set_dbg_mod_facility usage
580
-...
581
-$ kamctl fifo set_dbg_mod_facility core LOG_LOCAL1
582
-$ kamctl fifo set_dbg_mod_facility debugger LOG_LOCAL0
583
-...
584
-
585
-5.3. get_dbg_mod_level mod_name
586
-
587
-   Get the mod_name log level. If mod_name does not exist in the level
588
-   hashtable, returns the config file value.
589
-
590
-   Example 1.23. get_dbg_mod_level usage
591
-...
592
-$ kamctl fifo get_dbg_mod_level core
593
-$ kamctl fifo get_dbg_mod_level debugger
594
-...
595
-
596
-5.4. get_dbg_mod_facility mod_name
597
-
598
-   Get the mod_name log facility. If mod_name does not exist in the
599
-   facility hashtable, returns the config file value.
600
-
601
-   Example 1.24. get_dbg_mod_facility usage
602
-...
603
-$ kamctl fifo get_dbg_mod_facility core
604
-$ kamctl fifo get_dbg_mod_facility debugger
605
-...
606
-
607
-6. Exported RPC Functions
537
+5. RPC Commands
608 538
 
609
-   6.1. dbg.ls
610
-   6.2. dbg.trace
611
-   6.3. dbg.bp
612
-   6.4. dbg.mod_level
613
-   6.5. dbg.reset_msgid
614
-   6.6. dbg.set_mod_level
615
-   6.7. dbg.set_mod_facility
616
-   6.8. dbg.get_mod_level
617
-   6.9. dbg.get_mod_facility
539
+   5.1. dbg.ls
540
+   5.2. dbg.trace
541
+   5.3. dbg.bp
542
+   5.4. dbg.mod_level
543
+   5.5. dbg.reset_msgid
544
+   5.6. dbg.set_mod_level
545
+   5.7. dbg.set_mod_facility
546
+   5.8. dbg.get_mod_level
547
+   5.9. dbg.get_mod_facility
618 548
 
619
-6.1.  dbg.ls
549
+5.1.  dbg.ls
620 550
 
621 551
    List Kamailio processes with info related to interactive debugging.
622 552
 
... ...
@@ -630,7 +560,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
630 560
                 dbg.ls
631 561
                 dbg.ls 1234
632 562
 
633
-6.2.  dbg.trace
563
+5.2.  dbg.trace
634 564
 
635 565
    Control config script running trace.
636 566
 
... ...
@@ -647,7 +577,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
647 577
                 dbg.trace off
648 578
                 dbg.trace on 1234
649 579
 
650
-6.3.  dbg.bp
580
+5.3.  dbg.bp
651 581
 
652 582
    Control breakpoints and config execution.
653 583
 
... ...
@@ -685,7 +615,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
685 615
                 dbg.bp eval 1234 $fu
686 616
                 dbg.bp move 1234
687 617
 
688
-6.4.  dbg.mod_level
618
+5.4.  dbg.mod_level
689 619
 
690 620
    Specify module log level.
691 621
 
... ...
@@ -699,7 +629,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
699 629
                 dbg.mod_level core 3
700 630
                 dbg.mod_level tm 3
701 631
 
702
-6.5.  dbg.reset_msgid
632
+5.5.  dbg.reset_msgid
703 633
 
704 634
    Resets the message sequence ($mi). Internally there is no real change.
705 635
    This can be useful for unit test cases in order to be able to replicate
... ...
@@ -711,7 +641,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
711 641
    Examples of use with kamcmd:
712 642
                 dbg.reset_msgid
713 643
 
714
-6.6.  dbg.set_mod_level
644
+5.6.  dbg.set_mod_level
715 645
 
716 646
    Set the module log level. If module does not exist in kamailio, the
717 647
    entry in the level hashtable is still added for the bogus module.
... ...
@@ -721,7 +651,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
721 651
    Examples of use with kamcmd:
722 652
                         dbg.set_mod_level core 1
723 653
 
724
-6.7.  dbg.set_mod_facility
654
+5.7.  dbg.set_mod_facility
725 655
 
726 656
    Set the module log facility. If module does not exist in kamailio, the
727 657
    entry in the facility hashtable is still added for the bogus module.
... ...
@@ -731,7 +661,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
731 661
    Examples of use with kamcmd:
732 662
                         dbg.set_mod_facility core LOG_LOCAL1
733 663
 
734
-6.8.  dbg.get_mod_level
664
+5.8.  dbg.get_mod_level
735 665
 
736 666
    Get the module log level. If mod_name does not exist in the level
737 667
    hashtable, returns the config file value.
... ...
@@ -741,7 +671,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
741 671
    Examples of use with kamcmd:
742 672
                         dbg.get_mod_level core
743 673
 
744
-6.9.  dbg.get_mod_facility
674
+5.9.  dbg.get_mod_facility
745 675
 
746 676
    Get the module log facility. If mod_name does not exist in the facility
747 677
    hashtable, returns the config file value.
... ...
@@ -751,7 +681,7 @@ $ kamctl fifo get_dbg_mod_facility debugger
751 681
    Examples of use with kamcmd:
752 682
                         dbg.get_mod_facility core
753 683
 
754
-7. Usage
684
+6. Usage
755 685
 
756 686
    A common usage is to investigate the execution path for a specific SIP
757 687
    message. Just enable cfg running trace, send the message and watch the
... ...
@@ -38,9 +38,9 @@ IƱaki Baz Castillo
38 38
               4.1. pcre_match (string, pcre_regex)
39 39
               4.2. pcre_match_group (string [, group])
40 40
 
41
-        5. MI Commands
41
+        5. RPC Commands
42 42
 
43
-              5.1. regex_reload
43
+              5.1. regex.reload
44 44
 
45 45
         6. Installation and Running
46 46
 
... ...
@@ -88,9 +88,9 @@ Chapter 1. Admin Guide
88 88
         4.1. pcre_match (string, pcre_regex)
89 89
         4.2. pcre_match_group (string [, group])
90 90
 
91
-   5. MI Commands
91
+   5. RPC Commands
92 92
 
93
-        5.1. regex_reload
93
+        5.1. regex.reload
94 94
 
95 95
    6. Installation and Running
96 96
 
... ...
@@ -306,23 +306,24 @@ if (pcre_match_group("$ua", "$avp(i:10)")) {
306 306
 }
307 307
 ...
308 308
 
309
-5. MI Commands
309
+5. RPC Commands
310 310
 
311
-   5.1. regex_reload
311
+   5.1. regex.reload
312 312
 
313
-5.1.  regex_reload
313
+5.1.  regex.reload
314 314
 
315 315
    Causes regex module to re-read the content of the text file and
316 316
    re-compile the regular expressions. The number of groups in the file
317 317
    can be modified safely.
318 318
 
319
-   Name: regex_reload
319
+   Name: regex.reload
320 320
 
321 321
    Parameters: none
322 322
 
323
-   MI FIFO Command Format:
324
-:regex_reload:_reply_fifo_file_
325
-_empty_line_
323
+   RPC Command Example:
324
+...
325
+kamcmd regex.reload
326
+...
326 327
 
327 328
 6. Installation and Running
328 329