From 1317675fb3e71ea07cbcd6fb541234f0281909d8 Mon Sep 17 00:00:00 2001 From: kris Date: Fri, 19 Nov 2010 21:38:47 +0000 Subject: [PATCH] Document the status return value for nmap.resolve(). Patrik noticed the omission. --- nselib/nmap.luadoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/nselib/nmap.luadoc b/nselib/nmap.luadoc index e34ce041d..febf28758 100644 --- a/nselib/nmap.luadoc +++ b/nselib/nmap.luadoc @@ -47,8 +47,10 @@ function is_privileged() -- @param family Address family string (such as "inet") to specify the type -- of addresses returned -- @see address_family --- @return Table containing addresses resolved from the host name --- @usage local t = nmap.resolve("www.kame.net", nmap.address_family()) +-- @return Status (true or false) +-- @return Table containing addresses resolved from the host name if status +-- is true, or an error string if status is false +-- @usage local status, t = nmap.resolve("www.kame.net", nmap.address_family()) function resolve(host, family) --- Returns the address family Nmap is using.