[Openvas-commits] r3331 - trunk/doc/website

[scm-commit@wald.intevation.org]

Author: mattm
Date: 2009-05-11 20:47:37 +0200 (Mon, 11 May 2009)
New Revision: 3331

Modified:
   trunk/doc/website/openvas-cr-28.htm4
Log:
Add HELP command.

Modified: trunk/doc/website/openvas-cr-28.htm4
===================================================================
--- trunk/doc/website/openvas-cr-28.htm4	2009-05-11 18:24:31 UTC (rev 3330)
+++ trunk/doc/website/openvas-cr-28.htm4	2009-05-11 18:47:37 UTC (rev 3331)
@@ -1243,9 +1243,64 @@
 </get_version_response>
 </pre>
 
+<h4>help</h4>
+
+<p>
+The help command requests a human-readable description of the available OMP
+commands.  The manager will reply with a response code indicating success
+and a textual description of all commands.
+</p>
+
+<p>
+Command elements:
+<ul>
+  <li>(n/a)
+</ul>
+</p>
+
+<h5>Example:</h5>
+
+<p>
+<b>C:</b>
+</p>
+
+<pre>
+&lt;help/&gt;
+</pre>
+
+<p>
+<b>M:</b>
+</p>
+
+<pre>
+&lt;help_response status="200"&gt;
+    ABORT_TASK             Abort a running task.
+    AUTHENTICATE           Authenticate with the manager.
+    CREATE_TASK            Create a new task.
+    DELETE_REPORT          Delete an existing report.
+    DELETE_TASK            Delete an existing task.
+    GET_CERTIFICATES       Get all available certificates.
+    GET_DEPENDENCIES       Get dependencies for all available NVTs.
+    GET_NVT_ALL            Get IDs and names of all available NVTs.
+    GET_NVT_FEED_CHECKSUM  Get checksum for entire NVT collection.
+    GET_NVT_DETAILS        Get all details for all available NVTs.
+    GET_PREFERENCES        Get preferences for all available NVTs.
+    GET_REPORT             Get a report identified by its unique ID.
+    GET_RULES              Get the rules for the authenticated user.
+    GET_STATUS             Get task status information.
+    GET_VERSION            Get the OpenVAS Manager Protocol version.
+    HELP                   Get this help text.
+    MODIFY_REPORT          Modify an existing report.
+    MODIFY_TASK            Update an existing task.
+    START_TASK             Manually start an existing task.
+&lt;/help_response&gt;
+</pre>
+
 <h3>History</h3>
 
 <ul>
+<li> 2009-05-11 Matthew Mundell &lt;mmundell at intevation.de&gt;:<br>
+     Added HELP command.</li>
 <li> 2009-02-04 Michael Wiegand &lt;michael.wiegand at intevation.de&gt;:<br>
      Made command names more consistent.</li>
 <li> 2009-01-29 Michael Wiegand &lt;michael.wiegand at intevation.de&gt;:<br>