modules: readme files regenerated - app_jsdt ...

kamailio · Jan 10, 2017 · 57a81bb · 57a81bb
1 parent af29828
commit 57a81bb
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 51 deletions.
diff --git a/src/modules/app_jsdt/README b/src/modules/app_jsdt/README
@@ -10,7 +10,7 @@ Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
-   Copyright � 2017 Daniel-Constantin Mierla (asipto.com)
+   Copyright © 2017 Daniel-Constantin Mierla (asipto.com)
      __________________________________________________________________
 
    Table of Contents
@@ -34,7 +34,7 @@ Daniel-Constantin Mierla
               4.3. jsdt_run(function, params)
               4.4. jsdt_runstring(script)
 
-        5. Exported RPC Commands
+        5. RPC Commands
 
               5.1. app_jsrt.reload
 
@@ -69,7 +69,7 @@ Chapter 1. Admin Guide
         4.3. jsdt_run(function, params)
         4.4. jsdt_runstring(script)
 
-   5. Exported RPC Commands
+   5. RPC Commands
 
         5.1. app_jsrt.reload
 
@@ -124,7 +124,7 @@ Chapter 1. Admin Guide
    script at runtime. If you use it for KEMI configuration, then it has to
    include the requited functions.
 
-   Default value is "null".
+   Default value is “null”.
 
    Example 1.1. Set load parameter
 ...
@@ -138,7 +138,7 @@ modparam("app_jsdt", "load", "/usr/local/etc/kamailio/js/myscript.js")
    4.3. jsdt_run(function, params)
    4.4. jsdt_runstring(script)
 
-4.1. jsdt_dofile(path)
+4.1.  jsdt_dofile(path)
 
    Execute the JS script stored in 'path'. The parameter can be a string
    with pseudo-variables evaluated at runtime.
@@ -148,7 +148,7 @@ modparam("app_jsdt", "load", "/usr/local/etc/kamailio/js/myscript.js")
 jsdt_dofile("/usr/local/etc/kamailio/js/myscript.js");
 ...
 
-4.2. jsdt_dostring(script)
+4.2.  jsdt_dostring(script)
 
    Execute the Lua script stored in parameter. The parameter can be a
    string with pseudo-variables.
@@ -161,7 +161,7 @@ if(!jsdt_dostring('KSR.dbg("test message\n")'))
 }
 ...
 
-4.3. jsdt_run(function, params)
+4.3.  jsdt_run(function, params)
 
    Execute the JS function 'func' giving params as parameters. There can
    be up to 3 string parameters. The function must exist in the script
@@ -178,7 +178,7 @@ if(!jsdt_run("js_append_fu_to_reply"))
 jsdt_run("js_funcx", "$rU", "2");
 ...
 
-4.4. jsdt_runstring(script)
+4.4.  jsdt_runstring(script)
 
    Execute the JS script stored in parameter. The parameter can be a
    string with pseudo-variables. The script is executed in JS context
@@ -192,11 +192,11 @@ if(!jsdt_runstring('KSR.dbg("Hello World from $fU\n")'))
 }
 ...
 
-5. Exported RPC Commands
+5. RPC Commands
 
    5.1. app_jsrt.reload
 
-5.1. app_jsrt.reload
+5.1.  app_jsrt.reload
 
    Marks the need to reload the js script. The actual reload is done by
    every working process when the next call to jsrt_run() function or KEMI

diff --git a/src/modules/app_lua/README b/src/modules/app_lua/README
@@ -36,7 +36,7 @@ Daniel-Constantin Mierla
               4.3. lua_run(function, params)
               4.4. lua_runstring(script)
 
-        5. Exported RPC Commands
+        5. RPC Commands
 
               5.1. app_lua.list
               5.2. app_lua.reload
@@ -76,7 +76,7 @@ Chapter 1. Admin Guide
         4.3. lua_run(function, params)
         4.4. lua_runstring(script)
 
-   5. Exported RPC Commands
+   5. RPC Commands
 
         5.1. app_lua.list
         5.2. app_lua.reload
@@ -254,7 +254,7 @@ if(!lua_runstring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
 }
 ...
 
-5. Exported RPC Commands
+5. RPC Commands
 
    5.1. app_lua.list
    5.2. app_lua.reload

diff --git a/src/modules/htable/README b/src/modules/htable/README
@@ -67,7 +67,7 @@ Ovidiu Sas
               4.9. sht_iterator_next(iname)
 
         5. Exported pseudo-variables
-        6. Exported RPC Commands
+        6. RPC Commands
 
               6.1. htable.get htable key
               6.2. htable.delete htable key
@@ -153,7 +153,7 @@ Chapter 1. Admin Guide
         4.9. sht_iterator_next(iname)
 
    5. Exported pseudo-variables
-   6. Exported RPC Commands
+   6. RPC Commands
 
         6.1. htable.get htable key
         6.2. htable.delete htable key
@@ -801,7 +801,7 @@ sht_iterator_end("i1");
    Exported pseudo-variables are documented at
    http://www.kamailio.org/wiki/.
 
-6. Exported RPC Commands
+6. RPC Commands
 
    6.1. htable.get htable key
    6.2. htable.delete htable key

diff --git a/src/modules/ims_dialog/README b/src/modules/ims_dialog/README
@@ -104,7 +104,7 @@ Richard Good
               8.6. profile_list_dlgs
               8.7. dlg_bridge
 
-        9. Exported RPC Functions
+        9. RPC Commands
 
               9.1. dlg.list
               9.2. dlg.list_ctx
@@ -229,7 +229,7 @@ Chapter 1. Admin Guide
         8.6. profile_list_dlgs
         8.7. dlg_bridge
 
-   9. Exported RPC Functions
+   9. RPC Commands
 
         9.1. dlg.list
         9.2. dlg.list_ctx
@@ -832,7 +832,7 @@ if(dlg_get("abcdef", "123", "456"))
    This function is currently not supported by the ims_dialog module. To
    be incorporated in the future.
 
-9. Exported RPC Functions
+9. RPC Commands
 
    9.1. dlg.list
    9.2. dlg.list_ctx

diff --git a/src/modules/lcr/README b/src/modules/lcr/README
@@ -81,7 +81,7 @@ Juha Heinanen
               4.7. to_gw(lcr_id[, ip_addr, proto])
               4.8. to_any_gw([ip_addr, proto])
 
-        5. Exported RPC Commands
+        5. RPC Commands
 
               5.1. lcr.reload
               5.2. lcr.dump_gws
@@ -218,7 +218,7 @@ Chapter 1. Admin Guide
         4.7. to_gw(lcr_id[, ip_addr, proto])
         4.8. to_any_gw([ip_addr, proto])
 
-   5. Exported RPC Commands
+   5. RPC Commands
 
         5.1. lcr.reload
         5.2. lcr.dump_gws
@@ -1127,7 +1127,7 @@ if (to_any_gw("192.55.66.2", 1)) {
 };
 ...
 
-5. Exported RPC Commands
+5. RPC Commands
 
    5.1. lcr.reload
    5.2. lcr.dump_gws

diff --git a/src/modules/malloc_test/README b/src/modules/malloc_test/README
@@ -21,7 +21,7 @@ Andrei Pelinescu-Onciul
               3.1. mt_mem_alloc(size)
               3.2. mt_mem_free()
 
-        4. malloc_test RPC Functions
+        4. RPC Commands
 
               4.1. mt.mem_alloc size [unit]
               4.2. mt.mem_free [size] [unit]
@@ -65,7 +65,7 @@ Chapter 1. Admin Guide
         3.1. mt_mem_alloc(size)
         3.2. mt_mem_free()
 
-   4. malloc_test RPC Functions
+   4. RPC Commands
 
         4.1. mt.mem_alloc size [unit]
         4.2. mt.mem_free [size] [unit]
@@ -142,7 +142,7 @@ Note
 mem_free();
 ...
 
-4. malloc_test RPC Functions
+4. RPC Commands
 
    4.1. mt.mem_alloc size [unit]
    4.2. mt.mem_free [size] [unit]

diff --git a/src/modules/ratelimit/README b/src/modules/ratelimit/README
@@ -53,7 +53,7 @@ Hendrik Scholz
               6.1. rl_check([pvar])
               6.2. rl_check_pipe([pipe_no])
 
-        7. Exported RPC Functions
+        7. RPC Commands
 
               7.1. rl.stats
               7.2. rl.set_pipe
@@ -105,7 +105,7 @@ Chapter 1. Admin Guide
         6.1. rl_check([pvar])
         6.2. rl_check_pipe([pipe_no])
 
-   7. Exported RPC Functions
+   7. RPC Commands
 
         7.1. rl.stats
         7.2. rl.set_pipe
@@ -407,7 +407,7 @@ modparam("ratelimit", "pipe", "4:NETWORK:10000")
         };
 ...
 
-7. Exported RPC Functions
+7. RPC Commands
 
    7.1. rl.stats
    7.2. rl.set_pipe

diff --git a/src/modules/tsilo/README b/src/modules/tsilo/README
@@ -34,7 +34,7 @@ Federico Cabiddu
               4.2. ts_append(domain, ruri)
               4.3. ts_append_to(tindex, tlabel, domain, [uri])
 
-        5. Exported RPC Functions
+        5. RPC Commands
 
               5.1. ts.dump
               5.2. ts.lookup
@@ -76,7 +76,7 @@ Chapter 1. Admin Guide
         4.2. ts_append(domain, ruri)
         4.3. ts_append_to(tindex, tlabel, domain, [uri])
 
-   5. Exported RPC Functions
+   5. RPC Commands
 
         5.1. ts.dump
         5.2. ts.lookup
@@ -227,7 +227,7 @@ if (is_method("REGISTER")) {
 }
 ...
 
-5. Exported RPC Functions
+5. RPC Commands
 
    5.1. ts.dump
    5.2. ts.lookup

diff --git a/src/modules/uid_gflags/README b/src/modules/uid_gflags/README
@@ -23,7 +23,14 @@ Jiri Kuthan
               3.3. is_ugflag(flag_num)
 
         4. FIFO Interface
-        5. RPC Interface
+        5. RPC Commands
+
+              5.1. gflags.set
+              5.2. gflags.reset
+              5.3. gflags.is_set
+              5.4. gflags.flush
+              5.5. gflags.dump
+              5.6. global.reload
 
    List of Examples
 
@@ -46,7 +53,14 @@ Chapter 1. Admin Guide
         3.3. is_ugflag(flag_num)
 
    4. FIFO Interface
-   5. RPC Interface
+   5. RPC Commands
+
+        5.1. gflags.set
+        5.2. gflags.reset
+        5.3. gflags.is_set
+        5.4. gflags.flush
+        5.5. gflags.dump
+        5.6. global.reload
 
 1. Overview
 
@@ -125,21 +139,45 @@ reset_ugflag("2");
        return TRUE if the flag is set and FALSE if it is not set. The only
        parameter of this function is the number of the flag.
 
-5. RPC Interface
+5. RPC Commands
+
+   5.1. gflags.set
+   5.2. gflags.reset
+   5.3. gflags.is_set
+   5.4. gflags.flush
+   5.5. gflags.dump
+   5.6. global.reload
 
    The state of the global flags can be read and modified over the RPC
    interface. This module implements the following RPC interface commands:
-     * gflags.set - Set the value of a flag to 1. The function accepts one
-       parameter which is the number of the flag to be set.
-     * gflags.reset - Reset the value of a flag to 0. The function accepts
-       one parameter which is the number of the flag to be reset.
-     * gflags.is_set - Return the status of a flag. The FIFO function
-       would return TRUE if the flag is set and FALSE if it is not set.
-       The only parameter of this function is the number of the flag.
-     * gflags.flush - Flush the state of global flags into database.
-     * gflags.dump - Return the status of all flags. The value is TRUE if
-       the flag is set and FALSE if the flag is not set. The function has
-       no parameters.
-     * global.reload - Reload values from global_attrs DB table. This
-       function does not have any parameters. There is no return value on
-       success.
+
+5.1. gflags.set
+
+   gflags.set - Set the value of a flag to 1. The function accepts one
+   parameter which is the number of the flag to be set.
+
+5.2. gflags.reset
+
+   gflags.reset - Reset the value of a flag to 0. The function accepts one
+   parameter which is the number of the flag to be reset.
+
+5.3. gflags.is_set
+
+   gflags.is_set - Return the status of a flag. The FIFO function would
+   return TRUE if the flag is set and FALSE if it is not set. The only
+   parameter of this function is the number of the flag.
+
+5.4. gflags.flush
+
+   gflags.flush - Flush the state of global flags into database.
+
+5.5. gflags.dump
+
+   gflags.dump - Return the status of all flags. The value is TRUE if the
+   flag is set and FALSE if the flag is not set. The function has no
+   parameters.
+
+5.6. global.reload
+
+   global.reload - Reload values from global_attrs DB table. This function
+   does not have any parameters. There is no return value on success.
diff --git a/src/modules/xhttp_pi/README b/src/modules/xhttp_pi/README
@@ -41,7 +41,7 @@ Ovidiu Sas
 
               7.1. dispatch_xhttp_pi()
 
-        8. Exported RPC Functions
+        8. RPC Commands
 
               8.1. xhttp_pi.reload
 
@@ -80,7 +80,7 @@ Chapter 1. Admin Guide
 
         7.1. dispatch_xhttp_pi()
 
-   8. Exported RPC Functions
+   8. RPC Commands
 
         8.1. xhttp_pi.reload
 
@@ -310,7 +310,7 @@ event_route[xhttp:request] {
 }
 ...
 
-8. Exported RPC Functions
+8. RPC Commands
 
    8.1. xhttp_pi.reload