From 6631bfd6087fb84524e0609a0c14cb20af080bdf Mon Sep 17 00:00:00 2001 From: david Date: Sun, 13 Jul 2008 21:05:32 +0000 Subject: [PATCH] Judiciously add quotes around certain index terms, because , , and don't survive into the index. --- docs/refguide.xml | 6 ++-- docs/scripting.xml | 85 +++++++++++++++++++++++----------------------- 2 files changed, 46 insertions(+), 45 deletions(-) diff --git a/docs/refguide.xml b/docs/refguide.xml index 542a7210d..539993031 100644 --- a/docs/refguide.xml +++ b/docs/refguide.xml @@ -51,7 +51,7 @@ The output from Nmap is a list of scanned targets, with supplemental information on each depending on the options used. Key among that information is the interesting ports - table.portsinteresting + table.ports“interesting” That table lists the port number and protocol, service name, and state. The state is either open, filtered, @@ -3970,7 +3970,7 @@ overwhelming requests. Specify to only see version available from . If the problem persists, do some research to determine whether it has already been - discovered and addressed. Try searching for the error message on our search page at or at Google. Also try + discovered and addressed. Try searching for the error message on our search page at or at Google. Also try browsing the nmap-dev archives at .nmap-dev mailing list Read this full manual page as @@ -3982,7 +3982,7 @@ overwhelming requests. Specify to only see nmap-dev@insecure.org are far more likely to be answered than those sent to Fyodor directly. If you subscribe to the nmap-dev list before posting, your message will bypass moderation and get - through more quickly. Subscribe at . + through more quickly. Subscribe at . Code patches to fix bugs are even better than bug reports. Basic instructions for creating patch files with your changes are diff --git a/docs/scripting.xml b/docs/scripting.xml index 62ccb9fbb..9e5427d8e 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -213,7 +213,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - safe script category + “safe” script category @@ -232,7 +232,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - intrusive script category + “intrusive” script category @@ -247,7 +247,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - malware script category + “malware” script category @@ -258,8 +258,8 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - version script category - version detectionversion script category + “version” script category + version detection“version” script category @@ -275,7 +275,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - discovery script category + “discovery” script category @@ -287,7 +287,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - vuln script category + “vuln” script category @@ -298,7 +298,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - auth script category + “auth” script category @@ -309,7 +309,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 0.907 seconds - default script category + “default” script category @@ -492,7 +492,7 @@ categories. . A version scan executes the scripts in the - version category.version script category + version category.“version” script category The scripts in this category are slightly different than other scripts. Their output blends in with the version scan and they do not produce any @@ -538,7 +538,7 @@ categories. <literal>id</literal> Field - id script variable + “id” script variable The script's id field is displayed in the Nmap output table if the script produces any output. It should be unique so users @@ -551,7 +551,7 @@ categories. <literal>description</literal> Field - description script variable + “description” script variable The description describes what the script is testing for and any critical notes the user must be aware of. A good @@ -565,7 +565,7 @@ categories. <literal>author</literal> Field - author script variable + “author” script variable The author field contains the script authors name and contact information. If you are worried about spam, you might want to omit or obscure your email address, or give your home page URL instead. This optional field is not used by NSE, but is important for giving script authors due credit or blame. @@ -573,7 +573,7 @@ categories. <literal>license</literal> Field - license script variable + “license” script variable copyrightof scripts Nmap is a community project and we welcome all sorts of @@ -597,7 +597,7 @@ that. <literal>runlevel</literal> Field - runlevel script variable + “runlevel” script variable run level of scripts This optional field determines script execution order. When @@ -619,9 +619,9 @@ that. Port and Host Rules - portrule script variable - hostrule script variable - rules in NSEportrule and hostrule + “portrule” script variable + “hostrule” script variable + rules in NSE“portrule” and “hostrule” There are two types of rules: host rules @@ -643,7 +643,7 @@ that. . Action - action script variable + “action” script variable The action is the heart of an NSE script. It contains all of @@ -1915,7 +1915,7 @@ if(s) code_to_be_done_on_match end Lua interpreter. Users need easy access to the information Nmap has learned about the target hosts. This data is passed as arguments to the NSE - action method.action script variable + action method.“action” script variable The arguments, host and port, are Lua tables which contain information on the target against which the script is @@ -3202,7 +3202,8 @@ try(socket:send(result)) the ID is printed before the script's results in Nmap output. -id script variable +“Service Owner” script +“id” script variable id = "Service Owner" @@ -3211,7 +3212,7 @@ id = "Service Owner" The description field should contain a sentence or two describing what the script does. If anything about the script results might confuse or mislead users, and you can't eliminate the issue by improving the script or results text, it should be documented in the description string. -description script variable +“description” script variable description = "Opens a connection to the scanned port, opens a connection to \ port 113, queries the owner of the service on the scanned port and prints it." @@ -3234,7 +3235,7 @@ port 113, queries the owner of the service on the scanned port and prints it." script in two categories: -categories script variable +“categories” script variable categories = {"safe", "intrusive"} @@ -3266,7 +3267,7 @@ categories = {"safe", "intrusive"} the action. -portrule script variable +“portrule” script variable portrule = function(host, port) local ident_port = { number=113, protocol="tcp" } @@ -3344,7 +3345,7 @@ local localip, localport = client_service:get_info() - action script variable + “action” script variable action = function(host, port) local owner = "" @@ -3422,17 +3423,17 @@ end description = "Demonstration of a version detection NSE script. It checks \ and reports the version of a remote web server. For real life purposes it is \ -better to use Nmap version detection (-sV)."description script variable -author = "Diman Todorov <diman.todorov@gmail.at>"Todorov, Dimanauthor script variable -license = "Same as Nmap--See http://nmap.org/book/man-legal.html"license script variable +better to use Nmap version detection (-sV)."“description” script variable +author = "Diman Todorov <diman.todorov@gmail.at>"Todorov, Diman“author” script variable +license = "Same as Nmap--See http://nmap.org/book/man-legal.html"“license” script variable -id = "HTTP version"id script variable +id = "HTTP version"“id” script variable -categories = {"version"}categories script variable +categories = {"version"}“categories” script variable -runlevel = 1.0runlevel script variable +runlevel = 1.0“runlevel” script variable -portrule = function(host, port)portrule script variable +portrule = function(host, port)“portrule” script variable if (port.number == 80 or port.service == "http" ) and port.protocol == "tcp" @@ -3443,7 +3444,7 @@ portrule = function(host, port)portrule s end end -action = function(host, port)action script variable +action = function(host, port)“action” script variable local query = "GET / HTTP/2.1\r\n" query = query .. "Accept: */*\r\n" query = query .. "Accept-Language: en\r\n" @@ -3523,7 +3524,7 @@ Nmap finished: 1 IP address (1 host up) scanned in 9.317 seconds Finger-Test Script - Finger Results script + “Finger Results” script The finger script (finger.nse) is a perfect example of how short typical NSE scripts are. @@ -3533,13 +3534,13 @@ Nmap finished: 1 IP address (1 host up) scanned in 9.317 seconds printed in Nmap's output. A detailed description of what the script actually does should go in the description field. -id="Finger Results"id script variable +id="Finger Results"“id” script variable -description="attempts to get a list of usernames via the finger service"description script variable +description="attempts to get a list of usernames via the finger service"“description” script variable -author = "Eddie Bell <ejlbell@gmail.com>"Bell, Eddieauthor script variable +author = "Eddie Bell <ejlbell@gmail.com>"Bell, Eddie“author” script variable -license = "Same as Nmap--See http://nmap.org/book/man-legal.html"license script variable +license = "Same as Nmap--See http://nmap.org/book/man-legal.html"“license” script variable The categories field is a table @@ -3565,9 +3566,9 @@ on a non-standard port) or still run against at least the port we expect it, should the version detection information not be available. -portrule = shortport.port_or_service(79, "finger")portrule script variable +portrule = shortport.port_or_service(79, "finger")“portrule” script variable -action = function(host, port)action script variable +action = function(host, port)“action” script variable local socket = nmap.new_socket() local results = "" local status = true @@ -3751,8 +3752,8 @@ also get stored inside the registry. Matching of Scripts to Targets After the initialization is finished the - hostruleshostrule script variable - and portrulesportrule script variable + hostrules“hostrule” script variable + and portrules“portrule” script variable are evaluated for each host in the current target group. At this check a list is built which contains the combinations of scripts and the hosts they will run against.