1
0
mirror of https://github.com/nmap/nmap.git synced 2026-02-12 08:26:33 +00:00

Normalize NSEDoc documentation of scripts.

I made every script follow a standard form: it starts with the id, followed by
the description. The description is contained in [[ ]] delimiters. The
description is in the global description variable, not in a LuaDoc comment.
Other LuaDoc information such as @args and @usage follows the description in a
comment.

The first paragraph of each description is a a short summary of what the script
does. More detailed information, if any, is given in following paragraphs.

I also improved some wording and formatting in a few cases.
This commit is contained in:
david
2008-10-14 20:52:50 +00:00
parent 1508da5acc
commit 8bd71aaf43
53 changed files with 634 additions and 573 deletions

View File

@@ -1,10 +1,8 @@
require "comm"
require "ipOps"
id = "RIPE query"
description = [[
Connects to the RIPE database, extracts and prints the role: entry for the IP.
\n
Connects to the RIPE database and displays the role: entry for the target's IP
address.
\n\n
This script uses an external database. Your IP address and the IP address of
the target will be sent to whois.ripe.net.
]]
@@ -13,6 +11,9 @@ license = "Same as Nmap--See http://nmap.org/book/man-legal.html"
categories = {"discovery", "external"}
require "comm"
require "ipOps"
hostrule = function(host, port)
return not ipOps.isPrivate(host.ip)
end