Browse code

pike: docs - section for pike.list rpc command

(cherry picked from commit 720e929a87c6d3ee29c316ca63886c7142320f43)
(cherry picked from commit c783f19708bfd1d8c2334f739c8960b2de5f4fb3)

Daniel-Constantin Mierla authored on 11/08/2020 09:11:35
Showing 1 changed files
... ...
@@ -1,6 +1,12 @@
1 1
 <?xml version="1.0" encoding="UTF-8"?>
2
-<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
3
-   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
2
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3
+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4
+
5
+<!-- Include general documentation entities -->
6
+<!ENTITY % docentities SYSTEM "../../../../doc/docbook/entities.xml">
7
+%docentities;
8
+
9
+]>
4 10
 
5 11
 <chapter id="pike.rpc" xmlns:xi="http://www.w3.org/2001/XInclude">
6 12
 
... ...
@@ -20,7 +26,7 @@
20 26
 			Some IPs could be marked as HOT depending on theirs request rates.
21 27
 		</simpara>
22 28
 		<simpara>
23
-			pike.top command takes one string parameter which specifies what kind of nodes you are interested in. Possible values
29
+			pike.top command can take one string parameter which specifies what kind of nodes you are interested in. Possible values
24 30
 			are HOT or ALL. If no argument is given, it behaves as HOT was used.
25 31
 		</simpara>
26 32
 		<simpara>
... ...
@@ -29,5 +35,23 @@
29 35
 		<simpara>
30 36
 			Output of this command is a simple dump of ip_tree nodes marked as ip-leafs.
31 37
 		</simpara>
38
+		<example>
39
+		<title>Using <varname>pike.top</varname></title>
40
+		<programlisting format="linespecific">
41
+...
42
+&kamcli; rpc pike.top ALL
43
+...
44
+</programlisting>
45
+		</example>
46
+
32 47
 	</section>
48
+	<section id="pike.list">
49
+		<title>
50
+			<function>pike.list</function>
51
+		</title>
52
+		<para>
53
+			Alias for "pike.top" command.
54
+		</para>
55
+	</section>
56
+
33 57
 </chapter>