mirror of
https://github.com/nmap/nmap.git
synced 2025-12-26 17:39:03 +00:00
remove trailing whitepace from *.luadoc
This commit is contained in:
@@ -2,9 +2,9 @@
|
||||
-- Pack and unpack binary data.
|
||||
--
|
||||
-- A problem script authors often face is the necessity of encoding values
|
||||
-- into binary data. For example after analyzing a protocol the starting
|
||||
-- into binary data. For example after analyzing a protocol the starting
|
||||
-- point to write a script could be a hex dump, which serves as a preamble
|
||||
-- to every sent packet. Although it is possible to work with the
|
||||
-- to every sent packet. Although it is possible to work with the
|
||||
-- functionality Lua provides, it's not very convenient. Therefore NSE includes
|
||||
-- Binlib, based on lpack (http://www.tecgraf.puc-rio.br/~lhf/ftp/lua/)
|
||||
-- by Luiz Henrique de Figueiredo.
|
||||
@@ -35,7 +35,7 @@
|
||||
-- * <code>></code> big endian modifier
|
||||
-- * <code>=</code> native endian modifier
|
||||
--
|
||||
-- Note that the endian operators work as modifiers to all the
|
||||
-- Note that the endian operators work as modifiers to all the
|
||||
-- characters following them in the format string.
|
||||
|
||||
module "bin"
|
||||
@@ -65,7 +65,7 @@ function pack(format, ...)
|
||||
-- like in <code>pack</code>, except if used with <code>A</code>,
|
||||
-- <code>B</code>, or <code>H</code>, in which cases the number tells
|
||||
-- <code>unpack</code> how many bytes to read. <code>unpack</code> stops if
|
||||
-- either the format string or the binary data string are exhausted.
|
||||
-- either the format string or the binary data string are exhausted.
|
||||
-- @param format Format string, used to unpack values out of data string.
|
||||
-- @param data String containing packed data.
|
||||
-- @param init Optional starting position within the string.
|
||||
|
||||
@@ -8,7 +8,7 @@ module "lfs"
|
||||
|
||||
--- Returns a directory iterator listing the contents of the given path
|
||||
-- Each time the iterator is called with dir_obj it returns a directory entry's
|
||||
-- name as a string, or nil if there are no more entries.
|
||||
-- name as a string, or nil if there are no more entries.
|
||||
--
|
||||
-- @param path string containing the directory to list
|
||||
-- @return iterator function returning the next file or nil when done
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
-- The <code>nmap</code> module is an interface with Nmap's internal functions
|
||||
-- and data structures. The API provides target host details such as port
|
||||
-- states and version detection results. It also offers an interface to the
|
||||
-- Nsock library for efficient network I/O.
|
||||
-- Nsock library for efficient network I/O.
|
||||
-- @copyright Same as Nmap--See http://nmap.org/book/man-legal.html
|
||||
|
||||
module "nmap"
|
||||
@@ -18,7 +18,7 @@ function debugging()
|
||||
|
||||
--- Determines whether Nmap was compiled with SSL support.
|
||||
--
|
||||
-- This can be used to avoid sending SSL probes when SSL is not available.
|
||||
-- This can be used to avoid sending SSL probes when SSL is not available.
|
||||
-- @return True if Nmap was compiled with SSL support, false otherwise.
|
||||
function have_ssl()
|
||||
|
||||
@@ -102,10 +102,10 @@ function get_interface()
|
||||
function get_interface_info(interface_name)
|
||||
|
||||
--- Lists network interfaces
|
||||
--
|
||||
--
|
||||
-- This script enumerates all network interfaces and returns a list of tables
|
||||
-- containing information about every interface.
|
||||
--
|
||||
-- containing information about every interface.
|
||||
--
|
||||
-- Keys of each table:
|
||||
-- * <code>device</code> The interface name, can be an interface alias.
|
||||
-- * <code>shortname</code> A simple short name of the device.
|
||||
@@ -116,17 +116,17 @@ function get_interface_info(interface_name)
|
||||
-- * <code>broadcast</code> The string representing the broadcast address assigned to the interface if the interface type is <code>"ethernet"</code> and if the used address is IPv4, otherwise it is <code>nil</code>.
|
||||
-- * <code>up</code> The state of the interface, possible values are <code>"up"</code> or <code>"down"</code>.
|
||||
-- * <code>mtu</code> The MTU size of the interface.
|
||||
--
|
||||
--
|
||||
-- @return Array of tables containing information about every discovered interface.
|
||||
-- @usage local interfaces, err = nmap.list_interfaces()
|
||||
function list_interfaces()
|
||||
|
||||
--- Returns the TTL (time to live) value selected by the --ttl option
|
||||
--
|
||||
-- If there is no value specified or if the value specified with the --ttl
|
||||
-- If there is no value specified or if the value specified with the --ttl
|
||||
-- option is out of the range 0 to 255 (inclusive) this function returns 64,
|
||||
-- which is the default TTL for an IP packet. This function would be most
|
||||
-- useful in crafting packets, which we want to comply with the selected
|
||||
-- which is the default TTL for an IP packet. This function would be most
|
||||
-- useful in crafting packets, which we want to comply with the selected
|
||||
-- Nmap TTL value.
|
||||
--
|
||||
-- @return A number containing the TTL value
|
||||
@@ -370,7 +370,7 @@ function condvar(object)
|
||||
-- @param handler User cleanup function (optional).
|
||||
-- @usage
|
||||
-- local result, socket, try, catch
|
||||
--
|
||||
--
|
||||
-- result = ""
|
||||
-- socket = nmap.new_socket()
|
||||
-- catch = function()
|
||||
@@ -520,7 +520,7 @@ function send(data)
|
||||
-- * <code>"CANCELLED"</code>: The operation was cancelled.
|
||||
-- * <code>"KILL"</code>: For example the script scan is aborted due to a faulty script.
|
||||
-- * <code>"EOF"</code>: An EOF was read (probably will not occur for a send operation).
|
||||
-- @param host The hostname or IP address to send to.
|
||||
-- @param host The hostname or IP address to send to.
|
||||
-- @param port The port number to send to.
|
||||
-- @param data The data to send.
|
||||
-- @return Status (true or false).
|
||||
|
||||
@@ -45,7 +45,7 @@ function bignum_clear_bit(bignum, position)
|
||||
--- Gets the state of the bit at <code>position</code> in <code>bignum</code>.
|
||||
-- @param bignum bignum to operate on.
|
||||
-- @param position Bit position.
|
||||
-- @return True if the selected bit is set, false otherwise.
|
||||
-- @return True if the selected bit is set, false otherwise.
|
||||
function bignum_is_bit_set(bignum, position)
|
||||
|
||||
--- Converts a binary-encoded string into a bignum.
|
||||
|
||||
Reference in New Issue
Block a user