modules: readme files regenerated - avpops ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Fri, 28 Jul 2017 08:16:22 +0000 (10:16 +0200)
committerKamailio Dev <kamailio.dev@kamailio.org>
Fri, 28 Jul 2017 08:16:22 +0000 (10:16 +0200)
src/modules/avpops/README
src/modules/kex/README
src/modules/pv/README
src/modules/rtpproxy/README
src/modules/xlog/README

index 27ea1cb..c5db16a 100644 (file)
@@ -599,7 +599,7 @@ avp_copy("$avp(old)","$avp(new)/gd");
    Prints the formatted string 'format' in the AVP 'dest'. The 'format'
    parameter can include any pseudo-variable defined in Kamailio. The list
    with all pseudo-variables in Kamailio can be found at:
-   http://kamailio.org/dokuwiki/.
+   https://www.kamailio.org/wiki/
 
    Meaning of the parameters is as follows:
      * dest - in which AVP should be stored the result. Parameter syntax
index f005f7e..15961df 100644 (file)
@@ -55,17 +55,33 @@ Ovidiu Sas
 
         4. RPC Commands
 
-              4.1. core.arg
-              4.2. core.kill
-              4.3. core.pwd
-              4.4. core.uptime
-              4.5. version
-              4.6. system.listMethods
-              4.7. pkg.stats
-              4.8. stats.get_statistics
-              4.9. stats.reset_statistics
-              4.10. stats.clear_statistics
-              4.11. mod.stats module_name/all pkg/shm/all
+              4.1. core.aliases_list
+              4.2. core.arg
+              4.3. core.echo
+              4.4. core.flags
+              4.5. core.info
+              4.6. core.kill
+              4.7. core.printi
+              4.8. core.prints
+              4.9. core.ps
+              4.10. core.psx
+              4.11. core.pwd
+              4.12. core.shmem
+              4.13. core.sockets_list
+              4.14. core.tcp_info
+              4.15. core.tcp_list
+              4.16. core.tcp_options
+              4.17. core.udp4_raw_info
+              4.18. core.uptime
+              4.19. core.version
+              4.20. pkg.stats
+              4.21. stats.get_statistics
+              4.22. stats.reset_statistics
+              4.23. stats.clear_statistics
+              4.24. system.listMethods
+              4.25. system.methodHelp
+              4.26. system.methodSignature
+              4.27. mod.stats module_name/all pkg/shm/all
 
    List of Examples
 
@@ -112,23 +128,39 @@ Chapter 1. Admin Guide
 
    4. RPC Commands
 
-        4.1. core.arg
-        4.2. core.kill
-        4.3. core.pwd
-        4.4. core.uptime
-        4.5. version
-        4.6. system.listMethods
-        4.7. pkg.stats
-        4.8. stats.get_statistics
-        4.9. stats.reset_statistics
-        4.10. stats.clear_statistics
-        4.11. mod.stats module_name/all pkg/shm/all
+        4.1. core.aliases_list
+        4.2. core.arg
+        4.3. core.echo
+        4.4. core.flags
+        4.5. core.info
+        4.6. core.kill
+        4.7. core.printi
+        4.8. core.prints
+        4.9. core.ps
+        4.10. core.psx
+        4.11. core.pwd
+        4.12. core.shmem
+        4.13. core.sockets_list
+        4.14. core.tcp_info
+        4.15. core.tcp_list
+        4.16. core.tcp_options
+        4.17. core.udp4_raw_info
+        4.18. core.uptime
+        4.19. core.version
+        4.20. pkg.stats
+        4.21. stats.get_statistics
+        4.22. stats.reset_statistics
+        4.23. stats.clear_statistics
+        4.24. system.listMethods
+        4.25. system.methodHelp
+        4.26. system.methodSignature
+        4.27. mod.stats module_name/all pkg/shm/all
 
 1. Overview
 
    This module collects extensions from Kamailio core.
 
-   Kamailio Core CookBook is available at: http://kamailio.org/dokuwiki/
+   Kamailio Core Cookbook is available at: https://www.kamailio.org/wiki/
 
 2. Dependencies
 
@@ -391,19 +423,39 @@ resetdebug();
 
 4. RPC Commands
 
-   4.1. core.arg
-   4.2. core.kill
-   4.3. core.pwd
-   4.4. core.uptime
-   4.5. version
-   4.6. system.listMethods
-   4.7. pkg.stats
-   4.8. stats.get_statistics
-   4.9. stats.reset_statistics
-   4.10. stats.clear_statistics
-   4.11. mod.stats module_name/all pkg/shm/all
-
-4.1.  core.arg
+   4.1. core.aliases_list
+   4.2. core.arg
+   4.3. core.echo
+   4.4. core.flags
+   4.5. core.info
+   4.6. core.kill
+   4.7. core.printi
+   4.8. core.prints
+   4.9. core.ps
+   4.10. core.psx
+   4.11. core.pwd
+   4.12. core.shmem
+   4.13. core.sockets_list
+   4.14. core.tcp_info
+   4.15. core.tcp_list
+   4.16. core.tcp_options
+   4.17. core.udp4_raw_info
+   4.18. core.uptime
+   4.19. core.version
+   4.20. pkg.stats
+   4.21. stats.get_statistics
+   4.22. stats.reset_statistics
+   4.23. stats.clear_statistics
+   4.24. system.listMethods
+   4.25. system.methodHelp
+   4.26. system.methodSignature
+   4.27. mod.stats module_name/all pkg/shm/all
+
+4.1.  core.aliases_list
+
+   Returns the list of local SIP server host aliases.
+
+4.2.  core.arg
 
    Print command line arguments.
 
@@ -416,7 +468,20 @@ resetdebug();
 kamcmd core.arg
 ...
 
-4.2.  core.kill
+4.3.  core.echo
+
+   Returns back its parameters.
+
+4.4.  core.flags
+
+   Returns the compile flags.
+
+4.5.  core.info
+
+   Verbose info, including version number, compile flags, compiler,
+   repository, hash
+
+4.6.  core.kill
 
    Kill the application.
 
@@ -429,7 +494,23 @@ kamcmd core.arg
 kamcmd core.kill
 ...
 
-4.3.  core.pwd
+4.7.  core.printi
+
+   Returns the integers given as parameters.
+
+4.8.  core.prints
+
+   Returns the strings given as parameters.
+
+4.9.  core.ps
+
+   Returns the description of running processes.
+
+4.10.  core.psx
+
+   Returns the detailed description of running processes.
+
+4.11.  core.pwd
 
    Print working directory.
 
@@ -442,7 +523,34 @@ kamcmd core.kill
 kamcmd core.pwd
 ...
 
-4.4.  core.uptime
+4.12.  core.shmem
+
+   Returns shared memory info. It has an optional parameter that specifies
+   the measuring unit: b - bytes (default), k or kb, m or mb, g or gb.
+   Note: when using something different from bytes, the value is
+   truncated.
+
+4.13.  core.sockets_list
+
+   Returns the list of local SIP server listen sockets.
+
+4.14.  core.tcp_info
+
+   Returns TCP related info.
+
+4.15.  core.tcp_list
+
+   Returns TCP connections details.
+
+4.16.  core.tcp_options
+
+   Returns active TCP options.
+
+4.17.  core.udp4_raw_info
+
+   Returns udp4_raw mode related info.
+
+4.18.  core.uptime
 
    Print uptime.
 
@@ -455,7 +563,7 @@ kamcmd core.pwd
 kamcmd core.uptime
 ...
 
-4.5.  version
+4.19.  core.version
 
    Print version information.
 
@@ -468,20 +576,7 @@ kamcmd core.uptime
 kamcmd core.version
 ...
 
-4.6.  system.listMethods
-
-   Print list of available RPC commands.
-
-   Name: system.listMethods
-
-   Parameters: none.
-
-   RPC Command Format:
-...
-kamcmd system.listMethods
-...
-
-4.7.  pkg.stats
+4.20.  pkg.stats
 
    Print private memory (pkg) usage statistics per process. It can take
    optinally a filter to print statistics only for a specific process or
@@ -499,7 +594,7 @@ kamcmd system.listMethods
                 kamcmd pkg.stats rank 1
                 kamcmd pkg.stats index 10
 
-4.8.  stats.get_statistics
+4.21.  stats.get_statistics
 
    Print the list of available internal statistics.
 
@@ -514,7 +609,7 @@ kamcmd system.listMethods
                 kamcmd stats.get_statistics unsupported_methods
                 kamcmd stats.get_statistics shmem: fwd_requests fwd_replies
 
-4.9.  stats.reset_statistics
+4.22.  stats.reset_statistics
 
    Reset internal statistics.
 
@@ -526,7 +621,7 @@ kamcmd system.listMethods
                 kamcmd stats.reset_statistics unsupported_methods
                 kamcmd stats.reset_statistics shmem: fwd_requests fwd_replies
 
-4.10.  stats.clear_statistics
+4.23.  stats.clear_statistics
 
    Return statistics and reset their value in one command.
 
@@ -538,7 +633,28 @@ kamcmd system.listMethods
                 kamcmd stats.reset_statistics unsupported_methods
                 kamcmd stats.reset_statistics shmem: fwd_requests fwd_replies
 
-4.11.  mod.stats module_name/all pkg/shm/all
+4.24.  system.listMethods
+
+   Print list of available RPC commands.
+
+   Name: system.listMethods
+
+   Parameters: none.
+
+   RPC Command Format:
+...
+kamcmd system.listMethods
+...
+
+4.25.  system.methodHelp
+
+   Print the help string for given method.
+
+4.26.  system.methodSignature
+
+   Returns signature of given method.
+
+4.27.  mod.stats module_name/all pkg/shm/all
 
    Print private(pkg) or shared(shm) memory currently allocated a given
    module or by all modules.
index 9c082b8..28550a1 100644 (file)
@@ -116,8 +116,8 @@ Chapter 1. Admin Guide
 1. Overview
 
    This module collects the core pseudo-variables that can be used in
-   configuration file. They are listed in Dokuwiki:
-   http://www.kamailio.org/wiki/, in Pseudo-Variables section
+   configuration file. They are listed in wiki:
+   https://www.kamailio.org/wiki/ in Pseudo-Variables section
 
 2. Dependencies
 
index 038f2f5..3c2c389 100644 (file)
@@ -609,9 +609,7 @@ onreply_route[2]
             to rtpproxy. See flag '1' for its meaning.
           + b - append branch specific variable to Call-ID when sending
             command to rtpproxy. See rtpproxy_offer() for details.
-            <listitem>
-            </listitem>
-            t - do not include To tag to “delete” command to rtpproxy thus
+          + t - do not include To tag to “delete” command to rtpproxy thus
             causing full call to be deleted. Useful for deleting unused
             rtpproxy call when 200 OK is received on a branch, where
             rtpproxy is not needed.
index 16361de..08422c3 100644 (file)
@@ -129,7 +129,7 @@ Chapter 1. Admin Guide
        %{[$avp_alias[index]}
 
    The full list of available pseudo-variables in Kamailio is available
-   at: http://kamailio.org/wiki/
+   at: https://www.kamailio.org/wiki/
 
 3. Dependencies