1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-14 11:49:01 +00:00
Commit Graph

12 Commits

Author SHA1 Message Date
david
5f166e19ec Don't use empty parentheses when referring to functions by name in NSE
documentation.
2008-11-07 22:49:49 +00:00
david
854b3460b5 Fix an inaccuracy in the documentation for the nmap.receive_lines and
nmap.receive_bytes functions. It claimed that if you don't get all the
lines/bytes you request before a timeout, then a "TIMEOUT" error happens. In
reality you get back data as long as at least one byte was received before the
timeout. From nsock_readlines:

/* Read up to nlines lines (terminated with \n, which of course
   inclues \r\n), or until EOF, or until the timeout, whichever comes
   first.  Note that NSE_STATUS_SUCCESS will be returned in the case
   of EOF or tiemout if at least 1 char has been read.  Also note that
   you may get more than 'nlines' back -- we just stop once "at least"
   'nlines' is read */
2008-11-04 22:39:07 +00:00
david
d0e545b49c Proofread and update documentation of nmap, openssl, packet, and pcre. 2008-10-24 19:08:27 +00:00
david
3ee17ecb5c Fix NSEDoc error messages, except for some "documenting undefined parameter"
that happen when one function is defined to be another by assignment.
2008-10-24 17:05:40 +00:00
david
a2ca60092c Remove module and object prefixes from function names in .luadoc files, as
suggested by jah in http://seclists.org/nmap-dev/2008/q4/0232.html. This makes
@see cross-references to functions in these files work from other modules.
2008-10-24 15:57:11 +00:00
david
114e1420bb Proofread and update documentation format in base64, bin, bit, comm, datafiles,
and dns.
2008-10-24 03:56:55 +00:00
david
7e15f259a4 Standardize the @copyright fields of NSE modules; change "See nmaps COPYING for
license" to "Same as Nmap--See http://nmap.org/book/man-legal.html" like
scripts commonly use. I added the field to some modules I know to be under the
Nmap license: bin, datafiles, dns, nmap, unpwdb. I left alone bin, bit, pcre,
and url, which come from outside sources.
2008-10-24 00:44:22 +00:00
david
20137202d9 Change nmap.luadoc to use Unix line endings. 2008-10-21 22:35:10 +00:00
david
06b661f2ef Fix the documentation for nmap.new_try, because it was incorrect. The result of
nmap.new_try is not a function accepting another function, it is a function
taking a variable number of arguments, assumed to be the return value of some
function. In other words, the returned try function is not responsible for
running other functions, it only sees their return values.
2008-10-16 22:21:08 +00:00
david
3ff15bf16d Document the socket, pcap, and dnet functions in nselib/nmap.luadoc. 2008-10-16 20:33:23 +00:00
david
77374fb284 Merge and format documentation for functions in nselib/nmap.luadoc. A lot of
functions are missing, notable the socket methods. I'll add those next.
2008-10-16 17:28:12 +00:00
batrick
05c7d791cd Added nmap luadoc documentation file. 2008-08-16 00:28:28 +00:00