From bd18974ef8773cdd0af9a043b01004d6422d9e07 Mon Sep 17 00:00:00 2001 From: fyodor Date: Wed, 29 Oct 2008 01:25:10 +0000 Subject: [PATCH] rename the nse-library sect1 from 'Lua Extensions' to 'NSE Libraries' (more descriptive and better matches 'NSE Scripts' section). Also moved the Scripts section before Libraries. Emphasized the name libraries more than modules. Renamed nmap-scripts-list ID to nmap-scripts, which required moving the former nmap-scripts to nmap-script-format. --- docs/scripting.xml | 41 +++++++++++++++++++++-------------------- 1 file changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/scripting.xml b/docs/scripting.xml index 66c319eec..4950d4ad7 100644 --- a/docs/scripting.xml +++ b/docs/scripting.xml @@ -561,7 +561,7 @@ $ nmap -sC --script-args user=foo,pass=bar,anonFTP={pass=ftp@foobar.com} - + Script Format NSE scripts consist of six descriptive fields along with either a port or host rule defining when the script should be executed and an action block containing the actual script instructions. Values can be assigned to these fields just as you would assign any other Lua variables. Their names must be lowercase as shown here. @@ -762,24 +762,8 @@ action refer to . - - Nmap Scripting Engine (NSE)list of modules - Lua Extensions - In addition to the significant built-in capabilities of - Lua, we have written or integrated several extensions to make - NSE scripts more powerful and convenient to write. These - modules are compiled and installed along with - Nmap. They have their own directory, nselib, which - is installed in the configured datadir. Scripts need only - - require - the default modules in order to use them. - - &nse-modules; - - - + Nmap Scripting Engine (NSE)list of scripts NSE Scripts @@ -799,6 +783,23 @@ action refer to . &nse-scripts; + + Nmap Scripting Engine (NSE)list of modules + NSE Libraries + In addition to the significant built-in capabilities of + Lua, we have written or integrated many extension libraries which make + script writing more powerful and convenient. These libraries (sometimes called modules) are compiled and installed along with + Nmap. They have their own directory, nselib, which + is installed in the configured datadir. Scripts need only + + require + the default libraries in order to use them. + + + &nse-modules; + + + Nmap API nmap NSE module @@ -1466,7 +1467,7 @@ try(socket:send(result)) overcome with NSE. - The anatomy of a script is described in . + The anatomy of a script is described in . In this section we will show how the described structure is utilized. @@ -1765,7 +1766,7 @@ local localip, localport = try(client_service:get_info()) opposed to functions and modules. Some information that might be put in an @-tag in a comment should go in one of the special script variables instead. (Script variables are described in - .) Specifically, the script's + .) Specifically, the script's description should be in the description variable rather than in a documentation comment, and the information that would go in @author and