1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-06 12:41:29 +00:00

Fix nsedoc issues (missing ---, mostly)

Originally committed by dmiller but recommitted by david after recovery
from backup.
This commit is contained in:
david
2013-04-12 17:29:16 +00:00
parent 797689c920
commit 201a5130a2
14 changed files with 21 additions and 18 deletions

View File

@@ -10,6 +10,7 @@ Listens for the LAN sync information broadcasts that the Dropbox.com client broa
If the <code>newtargets</code> script argument is given, all discovered Dropbox clients will be added to the Nmap target list rather than just listed in the output. If the <code>newtargets</code> script argument is given, all discovered Dropbox clients will be added to the Nmap target list rather than just listed in the output.
]] ]]
---
-- @usage -- @usage
-- nmap --script=broadcast-dropbox-listener -- nmap --script=broadcast-dropbox-listener
-- nmap --script=broadcast-dropbox-listener --script-args=newtargets -Pn -- nmap --script=broadcast-dropbox-listener --script-args=newtargets -Pn

View File

@@ -15,7 +15,7 @@ This works by sending a PIM Hello message to the PIM multicast address
224.0.0.13 and listening for Hello messages from other routers. 224.0.0.13 and listening for Hello messages from other routers.
]] ]]
-- ---
-- @args broadcast-pim-discovery.timeout Time to wait for responses in seconds. -- @args broadcast-pim-discovery.timeout Time to wait for responses in seconds.
-- Defaults to <code>5s</code>. -- Defaults to <code>5s</code>.
-- --

View File

@@ -53,7 +53,7 @@ PROXY) or to a specific service name. ]]
-- --
-- @args dns-blacklist.ip string containing the IP to check only needed if -- @args dns-blacklist.ip string containing the IP to check only needed if
-- running the script as a prerule. -- running the script as a prerule.
--
-- @args dns-blacklist.mode string containing either "short" or "long" -- @args dns-blacklist.mode string containing either "short" or "long"
-- long mode can sometimes provide additional information to why an IP -- long mode can sometimes provide additional information to why an IP
-- has been blacklisted. (default: long) -- has been blacklisted. (default: long)

View File

@@ -20,6 +20,9 @@ categories = {"discovery", "safe"}
-- | Successfully added the record "nmap-test.cqure.net" -- | Successfully added the record "nmap-test.cqure.net"
-- |_ Successfully deleted the record "nmap-test.cqure.net" -- |_ Successfully deleted the record "nmap-test.cqure.net"
-- --
-- @args dns-update.hostname the name of the host to add to the zone
-- @args dns-update.ip the ip address of the host to add to the zone
--
-- --
-- Examples -- Examples
@@ -36,9 +39,6 @@ categories = {"discovery", "safe"}
-- * dns.update( "cqure.net", { host=host, port=port, dtype="MX", data="", ttl=0 } ) -- * dns.update( "cqure.net", { host=host, port=port, dtype="MX", data="", ttl=0 } )
-- * dns.update( "_ldap._tcp.cqure.net", { host=host, port=port, dtype="SRV", data="", ttl=0 } ) -- * dns.update( "_ldap._tcp.cqure.net", { host=host, port=port, dtype="SRV", data="", ttl=0 } )
-- --
-- @args dns-update.hostname the name of the host to add to the zone
-- @args dns-update.ip the ip address of the host to add to the zone
--
-- Version 0.2 -- Version 0.2

View File

@@ -12,6 +12,7 @@ possible, including language/framework, remotes, last commit
message, and repository description. message, and repository description.
]] ]]
---
-- @output -- @output
-- PORT STATE SERVICE REASON -- PORT STATE SERVICE REASON
-- 80/tcp open http syn-ack -- 80/tcp open http syn-ack

View File

@@ -27,8 +27,7 @@ discovered.
-- | + sales@example.com -- | + sales@example.com
-- | + sales@example.com -- | + sales@example.com
-- |__ + sales@example.com -- |__ + sales@example.com
--
-- @args http-grep.match the string to match in urls and page contents -- @args http-grep.match the string to match in urls and page contents
-- @args http-grep.maxdepth the maximum amount of directories beneath -- @args http-grep.maxdepth the maximum amount of directories beneath
-- the initial url to spider. A negative value disables the limit. -- the initial url to spider. A negative value disables the limit.

View File

@@ -16,6 +16,10 @@ the target to retrieve a web page from www.google.com.
--- ---
-- @args proxy.url Url that will be requested to the proxy -- @args proxy.url Url that will be requested to the proxy
-- @args proxy.pattern Pattern that will be searched inside the request results -- @args proxy.pattern Pattern that will be searched inside the request results
--
-- @usage
-- nmap --script http-open-proxy.nse \
-- --script-args proxy.url=<url>,proxy.pattern=<pattern>
-- @output -- @output
-- Interesting ports on scanme.nmap.org (64.13.134.52): -- Interesting ports on scanme.nmap.org (64.13.134.52):
-- PORT STATE SERVICE -- PORT STATE SERVICE
@@ -35,10 +39,6 @@ the target to retrieve a web page from www.google.com.
-- * Included url and pattern arguments -- * Included url and pattern arguments
-- * Script now checks for http response status code, when url is used -- * Script now checks for http response status code, when url is used
-- * If google is used, script checks for Server: gws -- * If google is used, script checks for Server: gws
--
-- @usage
-- nmap --script http-open-proxy.nse \
-- --script-args proxy.url=<url>,proxy.pattern=<pattern>
author = "Arturo 'Buanzo' Busleiman" author = "Arturo 'Buanzo' Busleiman"
license = "Same as Nmap--See http://nmap.org/book/man-legal.html" license = "Same as Nmap--See http://nmap.org/book/man-legal.html"

View File

@@ -16,7 +16,6 @@ Other interesting files:
-- @usage nmap -p80 --script http-tplink-dir-traversal.nse <target> -- @usage nmap -p80 --script http-tplink-dir-traversal.nse <target>
-- @usage nmap -p80 -Pn -n --script http-tplink-dir-traversal.nse <target> -- @usage nmap -p80 -Pn -n --script http-tplink-dir-traversal.nse <target>
-- @usage nmap -p80 --script http-tplink-dir-traversal.nse --script-args rfile=/etc/topology.conf -d -n -Pn <target> -- @usage nmap -p80 --script http-tplink-dir-traversal.nse --script-args rfile=/etc/topology.conf -d -n -Pn <target>
-- --
-- @output -- @output
-- PORT STATE SERVICE REASON -- PORT STATE SERVICE REASON

View File

@@ -82,9 +82,9 @@ local llmnrSend = function(query, mcast, mport)
end end
-- Listens for llmnr responses -- Listens for llmnr responses
-- @interface Network interface to listen on. -- @param interface Network interface to listen on.
-- @timeout Maximum time to listen. -- @param timeout Maximum time to listen.
-- @result table to put responses into. -- @param result table to put responses into.
local llmnrListen = function(interface, timeout, result) local llmnrListen = function(interface, timeout, result)
local condvar = nmap.condvar(result) local condvar = nmap.condvar(result)
local start = nmap.clock_ms() local start = nmap.clock_ms()

View File

@@ -20,7 +20,7 @@ or dcedump tool from SPIKE fuzzer.
-- @output -- @output
-- PORT STATE SERVICE REASON -- PORT STATE SERVICE REASON
-- 445/tcp open microsoft-ds syn-ack -- 445/tcp open microsoft-ds syn-ack
--
-- Host script results: -- Host script results:
-- | msrpc-enum: -- | msrpc-enum:
-- | -- |
@@ -37,7 +37,7 @@ or dcedump tool from SPIKE fuzzer.
-- | annotation: DHCP Client LRPC Endpoint -- | annotation: DHCP Client LRPC Endpoint
-- | tcp_port: 49153 -- | tcp_port: 49153
-- | -- |
-- <snip> -- <snip>
-- | -- |
-- | uuid: 12345678-1234-abcd-ef00-0123456789ab -- | uuid: 12345678-1234-abcd-ef00-0123456789ab
-- | annotation: IPSec Policy agent endpoint -- | annotation: IPSec Policy agent endpoint

View File

@@ -21,7 +21,7 @@ information about interface addresses, used protocols and error codes.
This is similar to the mtrace utility provided in Cisco IOS. This is similar to the mtrace utility provided in Cisco IOS.
]] ]]
-- ---
--@args mtrace.fromip Source address from which to traceroute. --@args mtrace.fromip Source address from which to traceroute.
-- --
--@args mtrace.toip Destination address to which to traceroute. --@args mtrace.toip Destination address to which to traceroute.

View File

@@ -31,6 +31,7 @@ the server.
See http://mumble.sourceforge.net/Protocol. See http://mumble.sourceforge.net/Protocol.
]] ]]
---
-- @output -- @output
-- PORT STATE SERVICE VERSION -- PORT STATE SERVICE VERSION
-- 64740/tcp open murmur Murmur 1.2.4 (control port; users: 35; max. users: 100; bandwidth: 72000 b/s) -- 64740/tcp open murmur Murmur 1.2.4 (control port; users: 35; max. users: 100; bandwidth: 72000 b/s)

View File

@@ -21,6 +21,7 @@ hasn't exported program) means that we have sent the incorrect program number.
Any other accept state is an incorrect behaviour. Any other accept state is an incorrect behaviour.
]] ]]
---
-- @args rpc-grind.threads Number of grinding threads. Defaults to <code>4</code> -- @args rpc-grind.threads Number of grinding threads. Defaults to <code>4</code>
-- --
-- @usage -- @usage

View File

@@ -31,6 +31,7 @@ Original reversing of the protocol was done by Luigi Auriemma
(http://aluigi.altervista.org/papers.htm#ventrilo). (http://aluigi.altervista.org/papers.htm#ventrilo).
]] ]]
---
-- @usage -- @usage
-- nmap -sV <target> -- nmap -sV <target>
-- @usage -- @usage