From b083fb98e6e4242a6bfccc4f17ec9fb918e250d4 Mon Sep 17 00:00:00 2001
From: dmiller <dmiller@e0a8ed71-7df4-0310-8962-fdc924857419>
Date: Wed, 15 Jan 2014 20:11:39 +0000
Subject: [PATCH] Update comm library NSEdoc

Document some missing options to the functions, and adjust an error
message to use the correct option name.
---
 nselib/comm.lua | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/nselib/comm.lua b/nselib/comm.lua
index ea1f5821a..4a3c072aa 100644
--- a/nselib/comm.lua
+++ b/nselib/comm.lua
@@ -6,13 +6,14 @@
 -- exception handling via <code>nmap.new_try</code>.
 --
 -- These functions may be passed a table of options, but it's not required. The
--- keys for the options table are <code>"bytes"</code>, <code>"lines"</code>,
--- <code>"proto"</code>, and <code>"timeout"</code>. <code>"bytes"</code> sets
--- a minimum number of bytes to read. <code>"lines"</code> does the same for
--- lines. <code>"proto"</code> sets the protocol to communicate with,
--- defaulting to <code>"tcp"</code> if not provided. <code>"timeout"</code>
--- sets the socket timeout (see the socket function <code>set_timeout</code>
--- for details). 
+-- keys for the options table are:
+-- * <code>bytes</code> - minimum number of bytes to read.
+-- * <code>lines</code> - minimum number of lines to read.
+-- * <code>proto</code> - string, protocol to use. Default <code>"tcp"</code>
+-- * <code>timeout</code> - socket timeout in milliseconds. Default 8000
+-- * <code>connect_timeout</code> - override timeout for connection
+-- * <code>request_timeout</code> - override timeout for requests
+-- * <code>recv_before</code> - boolean, receive data before sending first payload
 --
 -- If both <code>"bytes"</code> and <code>"lines"</code> are provided,
 -- <code>"lines"</code> takes precedence. If neither are given, the functions
@@ -227,7 +228,7 @@ local function opencon(host, port, protocol, data, opts)
         status, response = sd:receive()
     else
         if not (opts and opts.recv_before) then
-            stdnse.print_debug("Using comm.tryssl without first data payload and recv_first." ..
+            stdnse.print_debug("Using comm.tryssl without either first data payload or opts.recv_before." ..
                          "\nImpossible to test the connection for the correct protocol!")
         end
         response = early_resp