diff --git a/nselib/nmap.luadoc b/nselib/nmap.luadoc index ace9a2d15..b0f9b94fd 100644 --- a/nselib/nmap.luadoc +++ b/nselib/nmap.luadoc @@ -82,12 +82,11 @@ function resolve(host, family) -- @usage local family = nmap.address_family() function address_family() ---- Returns the interface name (dnet-style) that Nmap is using. +--- Returns the interface name provided via the -e option. -- -- For example in the pre-scanning ("prerule" scripts) phase --- if Nmap is run with the -e eth0, then "eth0" can be --- returned, however Nmap can return an other interface name since it --- can determine the best interface suited for the job. +-- if Nmap is run with the -e eth0, then "eth0" will be +-- returned. -- Other "hostrule" and "portrule" scripts -- should use the interface field of the host table: -- host.interface. @@ -96,7 +95,7 @@ function address_family() -- table, example: nmap.get_interface_info("eth0"). -- -- @return A string containing the interface name (dnet-style) on --- success, or a nil value on failures. +-- success, or a nil value if the -e option was not used. -- @usage local interface_name = nmap.get_interface() function get_interface() @@ -109,7 +108,7 @@ function get_interface() -- * device The interface name, can be an interface alias. -- * shortname A simple short name of the device. -- * netmask The netmask bits (CIDR) of the interface. --- * address The string representing the IP address assigned to the interface. +-- * address The string representing the first IP address (of the family nmap.address_family()) assigned to the interface. -- * link The string representing the hardware type of the interface. Possible values are: "ethernet", "loopback", "p2p" or "other". -- * mac MAC address (six-byte-long binary string) of the interface if the type of the interface is "ethernet", otherwise it is nil. -- * broadcast The string representing the broadcast address assigned to the interface if the interface type is "ethernet" and if the used address is IPv4, otherwise it is nil.