[sr-dev] git:master: kex Update README XML with section id's
Olle E. Johansson
oej at edvina.net
Wed Apr 3 20:22:34 CEST 2013
Module: sip-router
Branch: master
Commit: d7959e5e63130889b6b589096388eaa6b76216d1
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=d7959e5e63130889b6b589096388eaa6b76216d1
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Wed Apr 3 09:22:49 2013 +0200
kex Update README XML with section id's
---
modules/kex/README | 28 ++++++++++----------
modules/kex/doc/kex_admin.xml | 58 ++++++++++++++++++++--------------------
2 files changed, 43 insertions(+), 43 deletions(-)
diff --git a/modules/kex/README b/modules/kex/README
index 0a8f5ff..12acac6 100644
--- a/modules/kex/README
+++ b/modules/kex/README
@@ -60,10 +60,10 @@ Daniel-Constantin Mierla
List of Examples
1.1. setsflag usage
- 1.2. setsflag usage
+ 1.2. issflagset usage
1.3. resetsflag usage
1.4. setbflag usage
- 1.5. setbflag usage
+ 1.5. isbflagset usage
1.6. resetbflag usage
1.7. setdsturi usage
1.8. resetdsturi usage
@@ -183,7 +183,7 @@ setsflag("$var(flag)");
This function can be used from ANY_ROUTE.
- Example 1.2. setsflag usage
+ Example 1.2. issflagset usage
...
if(issflagset("1"))
{
@@ -240,7 +240,7 @@ setbflag("$var(flag)", "1");
This function can be used from ANY_ROUTE.
- Example 1.5. setbflag usage
+ Example 1.5. isbflagset usage
...
if(isbflagset("1"))
{
@@ -393,7 +393,7 @@ resetdebug();
4.8. reset_statistics
4.9. clear_statistics
-4.1. arg
+4.1. arg
Print command line arguments.
@@ -405,7 +405,7 @@ resetdebug();
:arg:_reply_fifo_file_
_empty_line_
-4.2. kill
+4.2. kill
Kill the application.
@@ -417,7 +417,7 @@ resetdebug();
:kill:_reply_fifo_file_
_empty_line_
-4.3. pwd
+4.3. pwd
Print working directory.
@@ -429,7 +429,7 @@ resetdebug();
:pwd:_reply_fifo_file_
_empty_line_
-4.4. uptime
+4.4. uptime
Print uptime.
@@ -441,7 +441,7 @@ resetdebug();
:uptime:_reply_fifo_file_
_empty_line_
-4.5. version
+4.5. version
Print version information.
@@ -453,7 +453,7 @@ resetdebug();
:version:_reply_fifo_file_
_empty_line_
-4.6. which
+4.6. which
Print list of available MI commands.
@@ -465,7 +465,7 @@ resetdebug();
:which:_reply_fifo_file_
_empty_line_
-4.7. get_statistics
+4.7. get_statistics
Print the list of available internal statistics.
@@ -481,7 +481,7 @@ resetdebug();
_statsid_
_empty_line_
-4.8. reset_statistics
+4.8. reset_statistics
Reset internal statistics.
@@ -494,7 +494,7 @@ resetdebug();
_statsid_
_empty_line_
-4.9. clear_statistics
+4.9. clear_statistics
Return statistics and reset their value in one command.
@@ -511,7 +511,7 @@ resetdebug();
5.1. pkg.stats
-5.1. pkg.stats
+5.1. 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
diff --git a/modules/kex/doc/kex_admin.xml b/modules/kex/doc/kex_admin.xml
index f3f020d..28f8b69 100644
--- a/modules/kex/doc/kex_admin.xml
+++ b/modules/kex/doc/kex_admin.xml
@@ -58,7 +58,7 @@
<section>
<title>Functions</title>
- <section>
+ <section id="kex.f.setsflag">
<title><function moreinfo="none">setsflag(flag)</function></title>
<para>
Set the script flag.
@@ -87,7 +87,7 @@ setsflag("$var(flag)");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.issflagset">
<title><function moreinfo="none">issflagset(flag)</function></title>
<para>
Return true of the script flag is set.
@@ -105,7 +105,7 @@ setsflag("$var(flag)");
This function can be used from ANY_ROUTE.
</para>
<example>
- <title><function>setsflag</function> usage</title>
+ <title><function>issflagset</function> usage</title>
<programlisting format="linespecific">
...
if(issflagset("1"))
@@ -116,7 +116,7 @@ if(issflagset("1"))
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.resetsflag">
<title><function moreinfo="none">resetsflag(flag)</function></title>
<para>
Reset the script flag.
@@ -142,7 +142,7 @@ resetsflag("1");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.setbflag">
<title><function moreinfo="none">setbflag(flag [, branch])</function></title>
<para>
Set the branch flag.
@@ -178,7 +178,7 @@ setbflag("$var(flag)", "1");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.isbflagset">
<title><function moreinfo="none">isbflagset(flag [, branch])</function></title>
<para>
Return true of the branch flag is set.
@@ -203,7 +203,7 @@ setbflag("$var(flag)", "1");
This function can be used from ANY_ROUTE.
</para>
<example>
- <title><function>setbflag</function> usage</title>
+ <title><function>isbflagset</function> usage</title>
<programlisting format="linespecific">
...
if(isbflagset("1"))
@@ -214,7 +214,7 @@ if(isbflagset("1"))
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.resetbflag">
<title><function moreinfo="none">resetbflag(flag [, branch])</function></title>
<para>
Reset the branch flag.
@@ -247,7 +247,7 @@ resetbflag("1");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.setdsturi">
<title><function moreinfo="none">setdsturi(uri)</function></title>
<para>
Set the destination address URI (outbound proxy address).
@@ -276,7 +276,7 @@ setdsturi("sip:10.0.0.10");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.resetdsturi">
<title><function moreinfo="none">resetdsturi()</function></title>
<para>
Reset the destination address URI (outbound proxy address).
@@ -293,7 +293,7 @@ resetdsturi();
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.isdsturiset">
<title><function moreinfo="none">isdsturiset()</function></title>
<para>
Check if the destination address URI (outbound proxy address)
@@ -314,7 +314,7 @@ if(isdsturiset())
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.pv_printf">
<title><function moreinfo="none">pv_printf(var, str)</function></title>
<para>
Evalues the str and sets the resulting value to variable var. For
@@ -348,7 +348,7 @@ pv_printf("$avp(x)", "From: $fU - To: $tU");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.is_myself">
<title><function moreinfo="none">is_myself(uri)</function></title>
<para>
Check if the parameter matches the 'myself' condition (i.e., is
@@ -378,7 +378,7 @@ if(is_myself("$fu")) {
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.setdebug">
<title><function moreinfo="none">setdebug(level)</function></title>
<para>
Set the debug log level per process.
@@ -407,7 +407,7 @@ setdebug("$var(level)");
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.resetdebug">
<title><function moreinfo="none">resetdebug()</function></title>
<para>
Reset the local debug log level back to the value of core parameter
@@ -425,7 +425,7 @@ resetdebug();
</programlisting>
</example>
</section>
- <section>
+ <section id="kex.f.km_append_branch">
<title><function moreinfo="none">km_append_branch([uri])</function></title>
<para>
This function was replaced by append_branch() from corex module, starting with
@@ -436,7 +436,7 @@ resetdebug();
<section>
<title>MI Commands</title>
- <section>
+ <section id="kex.m.arg">
<title>
<function moreinfo="none">arg</function>
</title>
@@ -454,8 +454,8 @@ resetdebug();
:arg:_reply_fifo_file_
_empty_line_
</programlisting>
- </section>
- <section>
+ </section>
+ <section id="kex.m.kill">
<title>
<function moreinfo="none">kill</function>
</title>
@@ -473,8 +473,8 @@ resetdebug();
:kill:_reply_fifo_file_
_empty_line_
</programlisting>
- </section>
- <section>
+ </section>
+ <section id="kex.m.pwd">
<title>
<function moreinfo="none">pwd</function>
</title>
@@ -492,8 +492,8 @@ resetdebug();
:pwd:_reply_fifo_file_
_empty_line_
</programlisting>
- </section>
- <section>
+ </section>
+ <section id="kex.m.uptime">
<title>
<function moreinfo="none">uptime</function>
</title>
@@ -512,7 +512,7 @@ resetdebug();
_empty_line_
</programlisting>
</section>
- <section>
+ <section id="kex.m.version">
<title>
<function moreinfo="none">version</function>
</title>
@@ -531,7 +531,7 @@ resetdebug();
_empty_line_
</programlisting>
</section>
- <section>
+ <section id="kex.m.which">
<title>
<function moreinfo="none">which</function>
</title>
@@ -550,7 +550,7 @@ resetdebug();
_empty_line_
</programlisting>
</section>
- <section>
+ <section id="kex.m.get_statistics">
<title>
<function moreinfo="none">get_statistics</function>
</title>
@@ -574,7 +574,7 @@ resetdebug();
_empty_line_
</programlisting>
</section>
- <section>
+ <section id="kex.m.reset_statistics">
<title>
<function moreinfo="none">reset_statistics</function>
</title>
@@ -595,7 +595,7 @@ resetdebug();
_empty_line_
</programlisting>
</section>
- <section>
+ <section id="kex.m.clear_statistics">
<title>
<function moreinfo="none">clear_statistics</function>
</title>
@@ -621,7 +621,7 @@ resetdebug();
<section>
<title>RPC Commands</title>
- <section>
+ <section id="kex.r.pkg.stats">
<title>
<function moreinfo="none">pkg.stats</function>
</title>
More information about the sr-dev
mailing list