[Openvas-commits] r1354 - trunk/openvas-compendium

scm-commit@wald.intevation.org scm-commit at wald.intevation.org
Wed Sep 17 08:55:50 CEST 2008


Author: mwiegand
Date: 2008-09-17 08:55:50 +0200 (Wed, 17 Sep 2008)
New Revision: 1354

Modified:
   trunk/openvas-compendium/ChangeLog
   trunk/openvas-compendium/openvas-compendium.tex
Log:
* openvas-compendium.tex: Make use of verbatim environment more
consistent in OTP documentation.


Modified: trunk/openvas-compendium/ChangeLog
===================================================================
--- trunk/openvas-compendium/ChangeLog	2008-09-17 02:23:15 UTC (rev 1353)
+++ trunk/openvas-compendium/ChangeLog	2008-09-17 06:55:50 UTC (rev 1354)
@@ -1,3 +1,8 @@
+2008-09-17  Michael Wiegand <michael.wiegand at intevation.de>
+
+	* openvas-compendium.tex: Make use of verbatim environment more
+	consistent in OTP documentation.
+
 2008-09-16  Michael Wiegand <michael.wiegand at intevation.de>
 
 	* openvas-compendium.tex: Adapted OTP documentation from specification.

Modified: trunk/openvas-compendium/openvas-compendium.tex
===================================================================
--- trunk/openvas-compendium/openvas-compendium.tex	2008-09-17 02:23:15 UTC (rev 1353)
+++ trunk/openvas-compendium/openvas-compendium.tex	2008-09-17 06:55:50 UTC (rev 1354)
@@ -3909,10 +3909,10 @@
 \xname{general-aspects-of-otp}
 \section{General Aspects of OTP}
 
-The OpenVAS Transfer Protocol is text-based, human readable and
-line-oriented. Each line consists of fields separated by `` <|> ''. The first
-fields indicates whether it is a command send by client or by server (``CLIENT''
-vs. ``SERVER'').
+The OpenVAS Transfer Protocol is text-based, human readable and line-oriented.
+Each line consists of fields separated by ``\verb+ <|> +''. The first fields
+indicates whether it is a command send by client or by server (``\verb|CLIENT|''
+vs. ``\verb|SERVER|'').
 
 \xname{otp-initialization-and-features}
 \section{Protocol Initialization and Protocol Features}
@@ -3939,7 +3939,7 @@
 
 \paragraph{Description:}
 This command corresponds to the plugin preferences type "file". It follows
-the command PREFERENCES to upload the specified files from client to
+the command \verb|PREFERENCES| to upload the specified files from client to
 server.
 
 \paragraph{Syntax:}
@@ -3967,11 +3967,11 @@
 This command can be used by the client in case the protocol feature
 "md5\_caching" was selected by the client.
 
-It usually follows the PLUGINS\_MD5 commands of the server in case the server
-side md5sum is not equal to the md5sum of the client side cached NVTs.
-Alternatively, the client can use the command SEND\_PLUGINS\_MD5.
+It usually follows the \verb|PLUGINS_MD5| commands of the server in case the
+server side md5sum is not equal to the md5sum of the client side cached NVTs.
+Alternatively, the client can use the command \verb|SEND_PLUGINS_MD5|.
 
-The server will answer with command PLUGIN\_LIST.
+The server will answer with command \verb|PLUGIN_LIST|.
 
 \paragraph{Syntax:}
 
@@ -3984,8 +3984,8 @@
 
 \paragraph{Description:}
 In case of problems the server sends an error message with this command. In case
-of unrecoverable problems, the server will then close connection with BYE
-command.
+of unrecoverable problems, the server will then close connection with
+the \verb|BYE| command.
 
 \paragraph{Syntax:}
 
@@ -4013,10 +4013,11 @@
 
 \paragraph{Description:}
 This command can be used by the client in case the protocol feature
-"md5\_caching" was selected by the client. It usually follows the PLUGINS\_MD5
-commands of the server in case the server side md5sum is equal to the md5sum of
-the client side cached NVTs. The server will answer with command PREFERENCES and
-communication will continue as it would have been without md5\_caching feature.
+"md5\_caching" was selected by the client. It usually follows the
+\verb|PLUGINS_MD5| commands of the server in case the server side md5sum is
+equal to the md5sum of the client side cached NVTs. The server will answer with
+command \verb|PREFERENCES| and communication will continue as it would have been
+without md5\_caching feature.
 
 \paragraph{Syntax:}
 
@@ -4088,8 +4089,8 @@
 "length" is the number of bytes of "hosts". In case this does not match, the
 server will close connection.
 
-Before the client sends LONG\_ATTACK, the commands PREFERENCES and RULES should
-be applied.
+Before the client sends \verb|LONG_ATTACK|, the commands \verb|PREFERENCES| and
+\verb|RULES| should be applied.
 
 \paragraph{Syntax:}
 
@@ -4146,7 +4147,7 @@
 \subsection{PLUGINS\_DEPENDENCIES}
 
 \paragraph{Description:}
-The PLUGINS\_DEPENDENCIES messages are send after the RULES messages.
+The \verb|PLUGINS_DEPENDENCIES| message is send after the \verb|RULES| messages.
 
 \paragraph{Syntax:}
 
@@ -4165,11 +4166,11 @@
 Attention: This command occurs in two ways.
 
 \begin{enumerate}
- \item This command replaces PLUGIN\_LIST command in case the protocol feature
-"md5\_caching" was selected by the client. "md5sum" is the MD5 sum over all
-NVTs.
- \item This command follows the SEND\_PLUGINS\_MD5 command of the client and
-delivers the md5sums for each NVT.
+ \item This command replaces \verb|PLUGIN_LIST| command in case the protocol
+feature "md5\_caching" was selected by the client. "md5sum" is the MD5 sum over
+all NVTs.
+ \item This command follows the \verb|SEND_PLUGINS_MD5| command of the client
+and delivers the md5sums for each NVT.
 \end{enumerate}
 
 \paragraph{Syntax:}
@@ -4201,7 +4202,7 @@
 CLIENT <|> PLUGIN_INFO <|> oid <|> CLIENT
 \end{verbatim}
 
-The server answers with this line (analogous to PLUGIN\_LIST command):
+The server answers with this line (analogous to \verb|PLUGIN_LIST| command):
 
 \begin{verbatim}
 oid <|> name <|> category <|> copyright <|> description <|> summary <|>
@@ -4218,9 +4219,11 @@
 With this command the server sends detailed information about the available
 NVTs.
 
-The server will send PREFERENCES and RULES right after this command.
+The server will send \verb|PREFERENCES| and \verb|RULES| right after this
+command.
 
-The client might request individual NVT information via PLUGIN\_INFO command.
+The client might request individual NVT information via \verb|PLUGIN_INFO|
+command.
 
 \paragraph{Syntax:}
 
@@ -4253,7 +4256,7 @@
 With this command the values for the preferences are
 communicated. The server uses the commands to inform
 about defaults, the client uses the command to send
-the user selections. The server answers with PREFERENCES\_ERROR.
+the user selections. The server answers with \verb|PREFERENCES_ERROR|.
 
 Note that besides some general preferences, the syntax definition
 describes also per-NVT preferences and its special way of applying these.
@@ -4262,8 +4265,9 @@
 
 \begin{description}
  \item [ntp\_save\_sessions] If set to "yes", the server will support
-server-side saving of scan sessions and these commands will be available
-SESSIONS\_LIST, SESSION\_DELETE and SESSION\_RESTORE.
+server-side saving of scan sessions and the following commands will be
+available: \verb|SESSIONS_LIST|, \verb|SESSION_DELETE| and
+\verb|SESSION_RESTORE|.
  \item [save\_session] If set to yes, the server will save the scan as a
 session.
  \item [save\_empty\_sessions] Only considered if save\_session is set to "yes".
@@ -4300,11 +4304,11 @@
 Only sent by CLIENT:
 \begin{description}
  \item [plugin\_set] empty means all NVTs
- \item [ntp\_opt\_show\_end] Tell server to send FINISHED messages
+ \item [ntp\_opt\_show\_end] Tell server to send \verb|FINISHED| messages
  \item [ntp\_keep\_communication\_alive] Tell server to keep the connection even
 after a scan was finished.
- \item [ntp\_short\_status] Tell server send shorter STATUS message in order to
-save bandwidth.
+ \item [ntp\_short\_status] Tell server send shorter \verb|STATUS| message in
+order to save bandwidth.
 \end{description}
 
 \paragraph{Syntax:}
@@ -4353,7 +4357,7 @@
 SERVER and only the user-selected option name when sent by CLIENT
  \item [file] value is "<none>" when sent by SERVER and a file path when sent by
 CLIENT. The client has to submit the file under the very same path name using
-the command ATTACHED\_FILE.
+the command \verb|ATTACHED_FILE|.
 \end{description}
 
 \xname{otp-preferences_errors}
@@ -4361,7 +4365,7 @@
 
 \paragraph{Description:}
 With this command the server reports problems with the parameters set by the
-client. It follows immediately the PREFERENCES command of the client.
+client. It follows immediately the \verb|PREFERENCES| command of the client.
 
 Each "pref\_name" occuring in this list was not accepted by the server. The
 server will apply "default\_value" instead.
@@ -4414,11 +4418,11 @@
 This command can be used by the client in case the protocol feature
 "md5\_caching" was selected by the client.
 
-It usually follows the PLUGINS\_MD5 commands of the server in case the server
-side md5sum is not equal to the md5sum of the client side cached NVTs.
-Alternatively, the client can use the command COMPLETE\_LIST.
+It usually follows the \verb|PLUGINS_MD5| commands of the server in case the
+server side md5sum is not equal to the md5sum of the client side cached NVTs.
+Alternatively, the client can use the command \verb|COMPLETE_LIST|.
 
-The server will answer with command PLUGINS\_MD5.
+The server will answer with command \verb|PLUGINS_MD5|.
 
 \paragraph{Syntax:}
 
@@ -4456,7 +4460,7 @@
 \paragraph{Description:}
 With this command the client deletes the session identified with "session\_name"
 from the server-side storage. The server will not answer in case of success,
-else it will answer with an ERROR command.
+else it will answer with an \verb|ERROR| command.
 
 \paragraph{Syntax:}
 
@@ -4470,7 +4474,7 @@
 
 \paragraph{Description:}
 With this command the client tells the server to pick up again the session
-identified with "session\_name". The server will act as if a LONG\_ATTACK
+identified with "session\_name". The server will act as if a \verb|LONG_ATTACK|
 command has issued and will send all results that were collected so far for this
 session immediately (and naturally rapidly) and then continue the scan where it
 stopped.
@@ -4530,7 +4534,7 @@
 \subsection{TIME}
 
 \paragraph{Description:}
-The TIME messages are sent by the server to inform about the duration of
+The \verb|TIME| messages are sent by the server to inform about the duration of
 scanning a host and of the whole scan.
 
 \paragraph{Syntax:}



More information about the Openvas-commits mailing list