PenTest/nmap
1
0
Fork 0
mirror of https://github.com/nmap/nmap.git synced 2025-12-31 03:49:01 +00:00
Code Issues Projects Releases Wiki Activity

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.

Browse Source
This commit is contained in:
fyodor
2008-10-29 01:25:10 +00:00
parent f28c28af10
commit bd18974ef8
1 changed files with 21 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/scripting.xml
View File

@@ -561,7 +561,7 @@ $ nmap -sC --script-args user=foo,pass=bar,anonFTP={pass=ftp@foobar.com}
</para>
</sect2>
</sect1>
<sect1 id="nse-scripts">
<sect1 id="nse-script-format">
<title>Script Format</title>
<para>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.</para>
@@ -762,24 +762,8 @@ action refer to <xref linkend="nse-tutorial-action"/>.
</para>
</sect2>
</sect1>
<sect1 id="nse-library">
<indexterm><primary>Nmap Scripting Engine (NSE)</primary><secondary>list of modules</secondary></indexterm>
<title>Lua Extensions</title>
<para>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
<emphasis>modules</emphasis> are compiled and installed along with
Nmap. They have their own directory, <filename>nselib</filename>, which
is installed in the configured datadir. Scripts need only
<ulink url="http://www.lua.org/manual/5.1/manual.html#pdf-require">
<literal>require</literal>
</ulink> the default modules in order to use them.
</para>
&nse-modules;
</sect1>
<sect1 id="nse-scripts-list">
<sect1 id="nse-scripts">
<indexterm><primary>Nmap Scripting Engine (NSE)</primary><secondary>list of scripts</secondary></indexterm>
<title>NSE Scripts</title>
@@ -799,6 +783,23 @@ action refer to <xref linkend="nse-tutorial-action"/>.
&nse-scripts;
</sect1>
<sect1 id="nse-library">
<indexterm><primary>Nmap Scripting Engine (NSE)</primary><secondary>list of modules</secondary></indexterm>
<title>NSE Libraries</title>
<para>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, <filename>nselib</filename>, which
is installed in the configured datadir. Scripts need only
<ulink url="http://www.lua.org/manual/5.1/manual.html#pdf-require">
<literal>require</literal>
</ulink> the default libraries in order to use them.
</para>
&nse-modules;
</sect1>
<sect1 id="nse-api">
<title>Nmap API</title>
<indexterm class="startofrange" id="nse-nmap-indexterm"><primary><varname>nmap</varname> NSE module</primary></indexterm>
@@ -1466,7 +1467,7 @@ try(socket:send(result))
overcome with NSE. </para>
<para>
The anatomy of a script is described in <xref linkend="nse-scripts"/>.
The anatomy of a script is described in <xref linkend="nse-script-format"/>.
In this section we will show how the described structure is utilized.
</para>
@@ -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 <literal>@</literal>-tag in a comment should go in one of the
special script variables instead. (Script variables are described in
<xref linkend="nse-scripts"/>.) Specifically, the script's
<xref linkend="nse-script-format"/>.) Specifically, the script's
description should be in the <varname>description</varname> variable
rather than in a documentation comment, and the information that
would go in <literal>@author</literal> and