[sr-dev] git:master:720e929a: pike: docs - section for pike.list rpc command

Module: kamailio Branch: master Commit: 720e929a87c6d3ee29c316ca63886c7142320f43 URL: https://github.com/kamailio/kamailio/commit/720e929a87c6d3ee29c316ca63886c7… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2020-08-11T11:11:35+02:00 pike: docs - section for pike.list rpc command --- Modified: src/modules/pike/doc/pike_rpc.xml --- Diff: https://github.com/kamailio/kamailio/commit/720e929a87c6d3ee29c316ca63886c7… Patch: https://github.com/kamailio/kamailio/commit/720e929a87c6d3ee29c316ca63886c7… --- diff --git a/src/modules/pike/doc/pike_rpc.xml b/src/modules/pike/doc/pike_rpc.xml index 2ae3eff4e1..95f25cd044 100644 --- a/src/modules/pike/doc/pike_rpc.xml +++ b/src/modules/pike/doc/pike_rpc.xml @@ -1,6 +1,12 @@ <?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" +"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ + +<!-- Include general documentation entities --> +<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml"> +%docentities; + +]> <chapter id="pike.rpc" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -20,7 +26,7 @@ Some IPs could be marked as HOT depending on theirs request rates. </simpara> <simpara> - pike.top command takes one string parameter which specifies what kind of nodes you are interested in. Possible values + pike.top command can take one string parameter which specifies what kind of nodes you are interested in. Possible values are HOT or ALL. If no argument is given, it behaves as HOT was used. </simpara> <simpara> @@ -29,5 +35,23 @@ <simpara> Output of this command is a simple dump of ip_tree nodes marked as ip-leafs. </simpara> + <example> + <title>Using <varname>pike.top</varname></title> + <programlisting format="linespecific"> +... +&kamcli; rpc pike.top ALL +... +</programlisting> + </example> + </section> + <section id="pike.list"> + <title> + <function>pike.list</function> + </title> + <para> + Alias for "pike.top" command. + </para> + </section> + </chapter>