1
0
mirror of https://github.com/nmap/nmap.git synced 2025-12-09 14:11:29 +00:00
Commit Graph

131 Commits

Author SHA1 Message Date
david
00b8d455c3 Add missing <filename></filename> tags around a script name in scripting.xml. 2008-11-04 22:03:47 +00:00
david
8a6106529a Put a link to the online NSEDoc portal at the beginning of the list of
libraries in scripting.xml.
2008-11-04 05:13:27 +00:00
fyodor
8734956cf3 Did an audit throughout the book and changed a bunch of numbers 0-9 to write out zero through nine. I guess this is more consistant, but I'm not sure it is any better. Shrug. 2008-10-29 08:31:55 +00:00
fyodor
bd18974ef8 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. 2008-10-29 01:25:10 +00:00
david
2f627728a5 Fix a typo in scripting.xml: newsocket -> new_socket. 2008-10-27 21:26:35 +00:00
david
49843daf56 Update some code excerpts in docs/scripting.xml. Make small changes to
scripts/showOwner.nse for the purpose of better presentation. Remove the subtle
bug in the portrule example. We shouldn't put bad examples in print.
2008-10-27 17:52:50 +00:00
david
9ff7acfe0e Put empty parens after a few function names in scripting.xml; I think that's
the style we use.
2008-10-27 16:24:09 +00:00
david
0cba98422c Remove a space that was causing another spurious blank line in a programlisting. 2008-10-27 16:21:41 +00:00
david
3f678cee17 Move the section on NSEDoc of C modules from its own section to a paragraph in
the section where the examples of NSEDoc are shown. Reword some things. Mention
that @name as well as @class is needed to document tables.
2008-10-27 16:19:16 +00:00
david
6ecda0239c Improve idnexing in "Script Documentation Writing." 2008-10-27 15:45:41 +00:00
david
aac3a4e0ad Polish some markup in scripting.xml. Index ".luadoc". 2008-10-27 15:31:38 +00:00
david
f742c50008 Move some <programlisting> tags to the first column to avoid spurious blank
lines at the end. Expand tabs to spaces in the "Version Detection Using NSE"
example; otherwise tabs become single spaces in PDF output.
2008-10-27 15:21:33 +00:00
batrick
9d45c24835 Updated NSEDoc C module documentation. Merged David's paragraph on the topic
with mine.
2008-10-25 03:58:52 +00:00
david
879b33ad75 Replace showHTTPVersion.nse in scripting.xml with skype_v2-version.nse, a
better example of a version-detection script. I made a few small changes to the
script: shortening long lines and removing some non-functional ones. See
http://seclists.org/nmap-dev/2008/q4/0311.html.
2008-10-25 01:20:04 +00:00
david
99de55975c Add an introductory paragraph to the "NSE Scripts" section of scripting.xml
explaining that the docs are generated with NSEDoc and pointing to the online
documentation for the latest.
2008-10-24 22:11:02 +00:00
david
58389ab64b Remove a reference to running --script without any arguments. --script requires
an argument:
	# nmap target --script >/dev/null
	nmap: option `--script' requires an argument
You can use --script= but that's weird enough not to need to be mentioned.
2008-10-24 21:10:42 +00:00
batrick
09f1bae240 Added C module NSEDoc generation documentation. 2008-10-24 17:35:01 +00:00
david
1cf11d305c Update scripting.xml to document new NSE documentation markup. Include some
more examples. Note that using the special NSE documentation variables is
prefereable to using documentation comment tags in scripts.
2008-10-24 00:20:47 +00:00
david
8b08de8e65 Remove a reference to the deleted echoTest.nse script from the documentation.
Replace it with SSH-hostkey.nse, another "safe" category script.
2008-10-23 17:11:49 +00:00
david
837c1e95ca Make a few script documentation whitespace changes. 2008-10-20 23:45:33 +00:00
david
b80804c311 Take nse-modules and nse-scripts out of variablelist containers; they are
rendered more like sections now.
2008-10-20 18:56:57 +00:00
david
f6c4c7d653 Add containers for the auto-generated lists of NSE modules and scripts to
scripting.xml.
2008-10-18 01:36:31 +00:00
david
33fa3914d4 Mention that scripts matching a hostrule get only a host table, and script
matching a portrule get both a host and a port table. I didn't find that
documented anywhere else.
2008-10-16 23:09:18 +00:00
david
dfbbbf9e9a Write a short overview of connect-style I/O and include an example. Rewrite the
section on raw sockets in NSE.
2008-10-16 23:04:50 +00:00
david
06b661f2ef Fix the documentation for nmap.new_try, because it was incorrect. The result of
nmap.new_try is not a function accepting another function, it is a function
taking a variable number of arguments, assumed to be the return value of some
function. In other words, the returned try function is not responsible for
running other functions, it only sees their return values.
2008-10-16 22:21:08 +00:00
david
3ff15bf16d Document the socket, pcap, and dnet functions in nselib/nmap.luadoc. 2008-10-16 20:33:23 +00:00
david
77374fb284 Merge and format documentation for functions in nselib/nmap.luadoc. A lot of
functions are missing, notable the socket methods. I'll add those next.
2008-10-16 17:28:12 +00:00
david
2ab20dcd4b Remove a cross reference from scripting.xml that was broken since the module
documentation was removed.
2008-10-16 04:15:54 +00:00
david
c30776fec7 Add luadoc files for openssl and pcre. That finishes the modules in the section
"Lua Extensions", which is now just a stub.
2008-10-16 04:08:53 +00:00
david
99c30b1d1b Merge documetation for unpwdb, url, bit, tab, base64, and bin. 2008-10-16 03:18:03 +00:00
david
f58f559b81 Reformat and merge documentation for stdnse, shortport, strbuf, snmp, ssh1,
ssh2, smb, pop3, and msrpc.
2008-10-16 00:38:53 +00:00
david
12e34eb5b0 Reformat and merge documentation for some NSE modules: comm, datafiles, dns,
http, ipOps, listop, and match. This is mainly merging the best documentation
from the module source and scripting.xml into the module, with the aim of
making the source code the canonical source for module documentation.
2008-10-15 22:03:14 +00:00
david
9d6c638dbb Change some wording in scripting.xml. 2008-10-09 03:52:25 +00:00
david
9ed44c721b Proofread and index the scripting.xml documentation on the openssl NSE module. 2008-10-09 00:26:46 +00:00
david
367274bf35 Update the section on compiled NSE modules to refer to the openssl module
rather than the hash module.
2008-10-08 23:51:28 +00:00
sven
d8714befb1 merging nse_openssl branch 2008-10-08 22:21:41 +00:00
david
c91f49ab80 Canonicalize an indexterm in scripting.xml. 2008-10-07 14:22:27 +00:00
sven
565a5ee3ed o Enhanced the tohex() function in the NSE stdnse library to support strings
and added options to control the formatting. [Sven]
2008-10-03 19:55:58 +00:00
david
ebaf939f5f Make the http NSE module better handle different delimiters in the headers of
messages (and in the body when chunked encoding is used). The patch is from
jah.
2008-10-03 01:00:55 +00:00
fyodor
d14e9345b3 Update a bunch of Nmap scan examples (sometimes required rescanning and/or changing surrounding text 2008-09-30 07:29:03 +00:00
david
681296f2c8 Bring back the section on compiled NSE modules and turn it into a how-to for
static modules.
2008-09-13 00:26:00 +00:00
david
b491d82218 Document the external script category in docs/scripting.xml. 2008-09-09 17:01:12 +00:00
david
b3eddfe90a Remove the nselib-bin directory. Almost all references to it have been removed
too. The section in scripting.xml about creating C modules is gone. (But maybe
it should be replaced with a tutorial on making static modules?) The only
places where nselib-bin is still referenced are in mswin32/nsis/Nmap.nsi, where
it is still removed on uninstallation; and in mswin32/nmap.vcproj, from where I
don't have the resources now to remove it.
2008-09-05 05:32:06 +00:00
fyodor
9af38870d3 fix some typos found by Eric Krosnes 2008-09-03 20:14:23 +00:00
david
dacdf9409a Expand the sorting text to include all the letters of the index entry text when
using sortas in an index entry. Previously I had things like

<indexterm><primary sortas="nmap"><filename>.nmap</filename> filename extension</primary></indexterm>
<indexterm><primary sortas="nmap"><filename>.nmap</filename> directory</primary></indexterm>

which, because they have the same sort key, would result in one index entires
under either ".nmap filename extension" or ".nmap directory", with the page
numbers for both. Now I just spell out the full text: sortas="nmap filename
extension".
2008-08-30 00:15:09 +00:00
david
4cd828f92b Eliminate a spurious blank in scripting.xml caused by a line break inside an
emphasis element.
2008-08-29 22:15:25 +00:00
david
a37d7cf903 Fix a filename in scripting.xml (nselib-bin vs. nselib). 2008-08-25 23:58:19 +00:00
pgpickering
442288feb2 documented new binlib data types 2008-08-21 08:06:59 +00:00
david
b4c60f49e5 Canonicalize capitalization of protocol names. Generally we use capitalized forms in probes. When quoting from Nmap output we use whatever Nmap uses and enclose it in <literal> or similar tags. 2008-08-20 03:37:59 +00:00
fyodor
bc3dbbabc9 Apply nsedoc system details written by Patrick 2008-08-18 07:09:08 +00:00