CERBERUS/nmap
1
0
Fork 0
mirror of https://github.com/nmap/nmap.git synced 2026-08-03 22:29:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add a short section on --script-help to refguide.xml.

Browse source
This commit is contained in:
david 2011-01-28 18:06:08 +00:00
parent b53b5fced0
commit 1f6218599f
2 changed files with 34 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/nmap.1
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nmap
.\" Author: [see the "Author" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 01/21/2011
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
.\" Date: 01/28/2011
.\" Manual: Nmap Reference Guide
.\" Source: Nmap
.\" Language: English
.\"
.TH "NMAP" "1" "01/21/2011" "Nmap" "Nmap Reference Guide"
.TH "NMAP" "1" "01/28/2011" "Nmap" "Nmap Reference Guide"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
@ -1323,6 +1323,16 @@ pairs\&. Names and values may be strings not containing whitespace or the charac
The online NSE Documentation Portal at
\m[blue]\fB\%http://nmap.org/nsedoc/\fR\m[]
lists the arguments that each script accepts\&.
.PP
\fB\-\-script\-help \fR\fB\fIfilename\fR\fR\fB|\fR\fB\fIcategory\fR\fR\fB|\fR\fB\fIdirectory\fR\fR\fB|\fR\fB\fIexpression\fR\fR\fB|all\fR\fB[,\&.\&.\&.]\fR .\" --script-help
.RS 4
Shows help about scripts\&. For each script matching the given specification, Nmap prints the script name, its categories, and its description\&. The specifications are the same as those accepted by
\fB\-\-script\fR; so for example if you want help about the
ftp\-anon
script, you would run
\fBnmap \-\-script\-help ftp\-anon\fR\&. In addition to getting help for individual scripts, you can use this as a preview of what scripts will be run for a specification, for example with
\fBnmap \-\-script\-help default\fR\&.
.RE
.RE
.PP
\fB\-\-script\-trace\fR .\" --script-trace

21
docs/refguide.xml
View file

@ -2392,6 +2392,27 @@ lists the arguments that each script accepts.
</para>
</listitem>
<varlistentry>
<term>
<option>--script-help <replaceable>filename</replaceable>|<replaceable>category</replaceable>|<replaceable>directory</replaceable>|<replaceable>expression</replaceable>|all<optional>,...</optional></option>
<indexterm><primary><option>--script-help</option></primary></indexterm>
</term>
<listitem>
<para>
Shows help about scripts. For each script matching the given
specification, Nmap prints the script name, its categories, and its
description. The specifications are the same as those accepted by
<option>--script</option>; so for example if you want help about
the <literal>ftp-anon</literal> script, you would run
<command>nmap --script-help ftp-anon</command>. In addition to getting
help for individual scripts, you can use this as a preview of what
scripts will be run for a specification, for example with <command>nmap
--script-help default</command>.
</para>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry>
<term><option>--script-trace</option>