Browse Source

pike: docs - section for pike.list rpc command

Daniel-Constantin Mierla 5 years ago
parent
commit
720e929a87
1 changed files with 27 additions and 3 deletions
  1. 27 3
      src/modules/pike/doc/pike_rpc.xml

+ 27 - 3
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>