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

Add @xmloutput to docs/scripting.xml.

Browse Source
This commit is contained in:
david
2012-08-16 12:14:54 +00:00
parent 8206146d2a
commit 147a17d2b6
1 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/scripting.xml
View File

@@ -2771,8 +2771,8 @@ local localip, localport = try(client_service:get_info())
<literal>@copyright</literal> belong in the variables
<varname>author</varname> and <varname>license</varname> instead.
NSEDoc knows about these variables and will use them in preference
to fields in the comments. Scripts should also have an
<varname>@output</varname> tag showing sample output, as well as <varname>@args</varname> and <varname>@usage</varname> where appropriate.
to fields in the comments. Scripts should also have
<varname>@output</varname> and <varname>@xmloutput</varname> tags showing sample output, as well as <varname>@args</varname> and <varname>@usage</varname> where appropriate.
<xref linkend="nsedoc-script" xrefstyle="select: label nopage"/>
shows proper form for script-level documentation, using a
combination of documentation comments and NSE variables.
@@ -2939,6 +2939,19 @@ categories = {"discovery", "external", "safe"}
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>@xmloutput</option></term>
<listitem>
<para>
Shows what the script's
<xref linkend="nse-structured-output">structured output</xref>
looks like when written to XML. The XML sample should not include
the enclosing <literal>&lt;script&gt;</literal> and
<literal>&lt;/script&gt;</literal> tags and should be indented to
show hierarchy.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>@author</option></term>
<listitem>