regenerate man pages with latest Docbook XSL stylesheets and updated build process (which now generates ncat man pages too)

This commit is contained in:
fyodor 2008-10-15 10:39:51 +00:00
parent 8bd71aaf43
commit 5c6c5959e3
2 changed files with 1598 additions and 1190 deletions

File diff suppressed because it is too large Load diff

View file

@ -1,110 +1,268 @@
.\" Title: zenmap
.\" Author:
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\" Date: 09/12/2008
.\" Manual:
.\" Source:
.\" Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\" Date: 10/15/2008
.\" Manual: Zenmap Reference Guide
.\" Source: Zenmap
.\" Language: English
.\"
.TH "ZENMAP" "1" "09/12/2008" "" ""
.TH "ZENMAP" "1" "10/15/2008" "Zenmap" "Zenmap Reference Guide"
.\" -----------------------------------------------------------------
.\" * (re)Define some macros
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" toupper - uppercase a string (locale-aware)
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de toupper
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
\\$*
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH-xref - format a cross-reference to an SH section
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de SH-xref
.ie n \{\
.\}
.toupper \\$*
.el \{\
\\$*
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH - level-one heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SH
.\" put an extra blank line of space above the head in non-TTY output
.if t \{\
.sp 1
.\}
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[an-margin]u
.ti 0
.HTML-TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\." make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1u)
.ie n \{\
.\" if n (TTY output), use uppercase
.toupper \\$*
.\}
.el \{\
.nr an-break-flag 0
.\" if not n (not TTY), use normal case (not uppercase)
\\$1
.in \\n[an-margin]u
.ti 0
.\" if not n (not TTY), put a border/line under subheading
.sp -.6
\l'\n(.lu'
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SS - level-two heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SS
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[IN]u
.ti \\n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\n[PS-SS]u
\." make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1u)
.if \\n[.$] \&\\$*
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BB/BE - put background/screen (filled box) around block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BB
.if t \{\
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
.\}
..
.de EB
.if t \{\
.if "\\$2"adjust-for-leading-newline" \{\
.sp -1
.\}
.br
.di
.in
.ll
.gcolor
.nr BW \\n(.lu-\\n(.i
.nr BH \\n(dn+.5v
.ne \\n(BHu+.5v
.ie "\\$2"adjust-for-leading-newline" \{\
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.el \{\
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BM/EM - put colored marker in margin next to block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BM
.if t \{\
.br
.ll -2n
.gcolor red
.di BX
.\}
..
.de EM
.if t \{\
.br
.di
.ll
.gcolor
.nr BH \\n(dn
.ne \\n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
.\}
..
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
zenmap - Graphical Nmap frontend and results viewer
.SH "SYNOPSIS"
.HP 7
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "Name"
zenmap \- Graphical Nmap frontend and results viewer
.SH "Synopsis"
.fam C
.HP \w'\fBzenmap\fR\ 'u
\fBzenmap\fR [\fIoptions\fR] [\fIresults\ file\fR]
.SH "DESCRIPTION"
.fam
.SH "Description"
.PP
Zenmap is a multi\-platform graphical Nmap frontend and results viewer\. Zenmap aims to make Nmap easy for beginners to use while giving experienced Nmap users advanced features\. Frequently used scans can be saved as profiles to make them easy to run repeatedly\. A command creator allows interactive creation of Nmap command lines\. Scan results can be saved and viewed later\. Saved scan results can be compared with one another to see how they differ\. The results of recent scans are stored in a searchable database\.
Zenmap is a multi\-platform graphical Nmap frontend and results viewer\&. Zenmap aims to make Nmap easy for beginners to use while giving experienced Nmap users advanced features\&. Frequently used scans can be saved as profiles to make them easy to run repeatedly\&. A command creator allows interactive creation of Nmap command lines\&. Scan results can be saved and viewed later\&. Saved scan results can be compared with one another to see how they differ\&. The results of recent scans are stored in a searchable database\&.
.PP
This man page only describes the few Zenmap command\-line options and some critical notes\. A much more detailed Zenmap User\'s Guide is available at
\fI\%http://nmap.org/book/zenmap.html\fR\. Other documentation and information is available from the Zenmap web page at
\fI\%http://nmap.org/zenmap/\fR\.
.SH "OPTIONS SUMMARY"
This man page only describes the few Zenmap command\-line options and some critical notes\&. A much more detailed Zenmap User\'s Guide is available at
\m[blue]\fB\%http://nmap.org/book/zenmap.html\fR\m[]\&. Other documentation and information is available from the Zenmap web page at
\m[blue]\fB\%http://nmap.org/zenmap/\fR\m[]\&.
.SH "Options Summary"
.PP
\fB\-f\fR, \fB\-\-file \fR\fB\fIresults file\fR\fR
.RS 4
Open the given results file for viewing\. The results file may be an Nmap XML output file (\fI\.xml\fR, as produced by
\fBnmap \-oX\fR) or a Umit scan results file (\fI\.usr\fR)\. This option may be given more than once\.
Open the given results file for viewing\&. The results file may be an Nmap XML output file (\FC\&.xml\F[], as produced by
\fBnmap \-oX\fR) or a Umit scan results file (\FC\&.usr\F[])\&. This option may be given more than once\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Show a help message and exit\.
Show a help message and exit\&.
.RE
.PP
\fB\-n\fR, \fB\-\-nmap \fR\fB\fINmap command line\fR\fR
.RS 4
Run the given Nmap command within the Zenmap interface\. After
Run the given Nmap command within the Zenmap interface\&. After
\fB\-n\fR
or
\fB\-\-nmap\fR, every remaining command line argument is read as the command line to execute\. This means that
\fB\-\-nmap\fR, every remaining command line argument is read as the command line to execute\&. This means that
\fB\-n\fR
or
\fB\-\-nmap\fR
must be given last, after any other options\. Note that the command line must include the
must be given last, after any other options\&. Note that the command line must include the
\fBnmap\fR
executable name:
\fBzenmap \-n nmap \-sS target\fR\.
\fBzenmap \-n nmap \-sS target\fR\&.
.RE
.PP
\fB\-p\fR, \fB\-\-profile \fR\fB\fIprofile\fR\fR
.RS 4
Start with the given profile selected\. The profile name is just a string:
"Regular scan"\. If combined with
\fB\-t\fR, begin a scan with the given profile against the specified target\.
Start with the given profile selected\&. The profile name is just a string:
\FC"Regular scan"\F[]\&. If combined with
\fB\-t\fR, begin a scan with the given profile against the specified target\&.
.RE
.PP
\fB\-t\fR, \fB\-\-target \fR\fB\fItarget\fR\fR
.RS 4
Start with the given target\. If combined with
\fB\-p\fR, begin a scan with the given profile against the specified target\.
Start with the given target\&. If combined with
\fB\-p\fR, begin a scan with the given profile against the specified target\&.
.RE
.PP
\fB\-v\fR, \fB\-\-verbose\fR
.RS 4
Increase verbosity (of Zenmap, not Nmap)\. This option may be given multiple times to get even more verbosity\.
Increase verbosity (of Zenmap, not Nmap)\&. This option may be given multiple times to get even more verbosity\&.
.RE
.PP
Any other arguments are taken to be the names of results files to open\.
.SH "ENVIRONMENT VARIABLES"
Any other arguments are taken to be the names of results files to open\&.
.SH "Environment Variables"
.PP
\fBZENMAP_DEVELOPMENT\fR
.RS 4
Set
\fBZENMAP_DEVELOPMENT\fR
to disable automatic crash reporting\.
to disable automatic crash reporting\&.
.RE
.SH "BUGS"
.SH "Bugs"
.PP
Like their authors, Nmap and Zenmap aren\(cqt perfect\. But you can help make them better by sending bug reports or even writing patches\. If Nmap or Zenmap doesn\(cqt behave the way you expect, first upgrade to the latest version available from
\fI\%http://nmap.org\fR\. If the problem persists, do some research to determine whether it has already been discovered and addressed\. Try Googling the error message or browsing the
Like their authors, Nmap and Zenmap aren\(cqt perfect\&. But you can help make them better by sending bug reports or even writing patches\&. If Nmap or Zenmap doesn\(cqt behave the way you expect, first upgrade to the latest version available from
\m[blue]\fB\%http://nmap.org\fR\m[]\&. If the problem persists, do some research to determine whether it has already been discovered and addressed\&. Try Googling the error message or browsing the
nmap\-dev
archives at
\fI\%http://seclists.org/\fR\. Read this full manual page as well\. If nothing comes of this, mail a bug report to
<nmap\-dev@insecure\.org>\. Please include everything you have learned about the problem, as well as what version of Zenmap you are running and what operating system version it is running on\. Problem reports and Zenmap usage questions sent to nmap\-dev@insecure\.org are far more likely to be answered than those sent to Fyodor directly\.
\m[blue]\fB\%http://seclists.org/\fR\m[]\&. Read this full manual page as well\&. If nothing comes of this, mail a bug report to
\FCnmap\-dev@insecure\&.org\F[]\&. Please include everything you have learned about the problem, as well as what version of Zenmap you are running and what operating system version it is running on\&. Problem reports and Zenmap usage questions sent to nmap\-dev@insecure\&.org are far more likely to be answered than those sent to Fyodor directly\&.
.PP
Code patches to fix bugs are even better than bug reports\. Basic instructions for creating patch files with your changes are available at
\fI\%http://nmap.org/data/HACKING\fR\. Patches may be sent to
Code patches to fix bugs are even better than bug reports\&. Basic instructions for creating patch files with your changes are available at
\m[blue]\fB\%http://nmap.org/data/HACKING\fR\m[]\&. Patches may be sent to
nmap\-dev
(recommended) or to Fyodor directly\.
.SH "HISTORY"
(recommended) or to Fyodor directly\&.
.SH "History"
.PP
Zenmap was originally derived from Umit, an Nmap GUI created during the Google\-sponsored Nmap Summer of Code in 2005 and 2006\. The primary author of Umit was Adriano Monteiro Marques\. When Umit was modified and integrated into Nmap in 2007, it was renamed Zenmap\.
.SH "AUTHORS"
Zenmap was originally derived from Umit, an Nmap GUI created during the Google\-sponsored Nmap Summer of Code in 2005 and 2006\&. The primary author of Umit was Adriano Monteiro Marques\&. When Umit was modified and integrated into Nmap in 2007, it was renamed Zenmap\&.
.SH "Authors"
.SS "Nmap"
.PP
Fyodor
<fyodor@insecure\.org>
(\fI\%http://insecure.org\fR)
\FCfyodor@insecure\&.org\F[]
(\m[blue]\fB\%http://insecure.org\fR\m[])
.PP
Hundreds of people have made valuable contributions to Nmap over the years\. These are detailed in the
\fICHANGELOG\fR
Hundreds of people have made valuable contributions to Nmap over the years\&. These are detailed in the
\FCCHANGELOG\F[]
file which is distributed with Nmap and also available from
\fI\%http://nmap.org/changelog.html\fR\.
\m[blue]\fB\%http://nmap.org/changelog.html\fR\m[]\&.
.SS "Umit"
.PP
Zenmap is derived from the Umit Nmap frontend, which was started by Adriano Monteiro Marques as an Nmap/Google Summer of Code project (<py\.adriano@gmail\.com>,
\fI\%http://www.umitproject.org\fR)\.
Zenmap is derived from the Umit Nmap frontend, which was started by Adriano Monteiro Marques as an Nmap/Google Summer of Code project (\FCpy\&.adriano@gmail\&.com\F[],
\m[blue]\fB\%http://www.umitproject.org\fR\m[])\&.