Module: sip-router
Branch: master
Commit: a2d6730df7210084310d01c20b4ba2f3bcb883fb
URL:    
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=a2d6730df7210084310d01c20b4ba2f3bcb883fb

Author: Daniel-Constantin Mierla <[email protected]>
Committer: Daniel-Constantin Mierla <[email protected]>
Date:   Wed Dec 22 13:07:33 2010 +0100

kex: updated pkg.stats documentation

---

 modules_k/kex/README            |   15 +++++++++++----
 modules_k/kex/doc/kex_admin.xml |   31 +++++++++++++++++++++++++++----
 2 files changed, 38 insertions(+), 8 deletions(-)

diff --git a/modules_k/kex/README b/modules_k/kex/README
index c04cdb2..f81977a 100644
--- a/modules_k/kex/README
+++ b/modules_k/kex/README
@@ -438,11 +438,18 @@ if(is_myself("$fu")) {
 
 5.1.  pkg.stats
 
-   Print private memory (pkg) usage statistics per process. It can take an
-   optinal parameter that specifies the pid of process to print statistics
-   for. If pid parameter is not give, it prints statistics for all
+   Print private memory (pkg) usage statistics per process. It can take
+   optinally a filter to print statistics only for a specific process or
+   set of processes. If no filter is given, it prints statistics for all
    processes.
 
+   The filter can be:
+     * pid value - print statistics for specific process pid.
+     * rank value - print statistics for specific process rank.
+     * index value - print statistics for specific index in process table.
+
    Examples:
                 sercmd pkg.stats
-                sercmd pkg.stats 1234
+                sercmd pkg.stats pid 1234
+                sercmd pkg.stats rank 1
+                sercmd pkg.stats index 10
diff --git a/modules_k/kex/doc/kex_admin.xml b/modules_k/kex/doc/kex_admin.xml
index da61349..6c65586 100644
--- a/modules_k/kex/doc/kex_admin.xml
+++ b/modules_k/kex/doc/kex_admin.xml
@@ -535,16 +535,39 @@ if(is_myself("$fu")) {
                </title>
                <para>
                        Print private memory (pkg) usage statistics per 
process. It
-                       can take an optinal parameter that specifies the pid of 
process
-                       to print statistics for. If pid parameter is not give, 
it prints
-                       statistics for all processes.
+                       can take optinally a filter to print statistics only 
for a
+                       specific process or set of processes. If no filter is 
given,
+                       it prints statistics for all processes.
                </para>
+               <para>The filter can be:</para>
+               <itemizedlist>
+               <listitem>
+                       <para>
+                               <emphasis>pid value</emphasis> - print 
statistics for
+                               specific process pid.
+                       </para>
+               </listitem>
+               <listitem>
+                       <para>
+                               <emphasis>rank value</emphasis> - print 
statistics for
+                               specific process rank.
+                       </para>
+               </listitem>
+               <listitem>
+                       <para>
+                               <emphasis>index value</emphasis> - print 
statistics for
+                               specific index in process table.
+                       </para>
+               </listitem>
+               </itemizedlist>
                <para>
                Examples:
                </para>
         <programlisting  format="linespecific">
                sercmd pkg.stats
-               sercmd pkg.stats 1234
+               sercmd pkg.stats pid 1234
+               sercmd pkg.stats rank 1
+               sercmd pkg.stats index 10
                </programlisting>
     </section>
     </section>


_______________________________________________
sr-dev mailing list
[email protected]
http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev

Reply via email to