mirror of
https://github.com/nmap/nmap.git
synced 2026-02-13 17:06:34 +00:00
Quick man page for nmap-update.
This commit is contained in:
david
78
docs/nmap-update.1
Normal file
78
docs/nmap-update.1
Normal file
@@ -0,0 +1,78 @@
|
||||
'\" t
|
||||
.\" Title: nmap-update
|
||||
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
|
||||
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
|
||||
.\" Date: 12/20/2011
|
||||
.\" Manual: nmap-update Reference Guide
|
||||
.\" Source: nmap-update
|
||||
.\" Language: English
|
||||
.\"
|
||||
.TH "NMAP\-UPDATE" "1" "12/20/2011" "nmap\-update" "nmap\-update Reference Guide"
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * Define some portability stuff
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.\" http://bugs.debian.org/507673
|
||||
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
||||
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.ie \n(.g .ds Aq \(aq
|
||||
.el .ds Aq '
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * set default formatting
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" disable hyphenation
|
||||
.nh
|
||||
.\" disable justification (adjust text to left margin only)
|
||||
.ad l
|
||||
.\" -----------------------------------------------------------------
|
||||
.\" * MAIN CONTENT STARTS HERE *
|
||||
.\" -----------------------------------------------------------------
|
||||
.SH "NAME"
|
||||
nmap-update \- Updater for Nmap\*(Aqs architecture\-independent files
|
||||
.SH "SYNOPSIS"
|
||||
.HP \w'\fBnmap\-update\fR\ 'u
|
||||
\fBnmap\-update\fR [\fIoptions\fR] [\fIchannel\fR]
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
nmap\-update is an updater for Nmap\*(Aqs architecture\-independent files\&. It is used to keep up to date with changes and new scripts for the Nmap Scripting Engine\&.
|
||||
.PP
|
||||
Updates are distributed in the form of
|
||||
\(lqchannels\(rq, which are named directories that usually correspond to Nmap version numbers\&. When nmap\-update is installed, it will pull from the channel corresponding to the version of Nmap it was installed with, until Nmap and nmap\-update are upgraded as a whole\&.
|
||||
.PP
|
||||
The program works by updating from a remote Subversion repository\&. To supply authentication credentials, create a configuration file:
|
||||
.RS 4 /home/\fIuser\fR/\&.nmap/nmap\-config\&.conf on non\-Windows systems, or .RE .RS 4 C:\eUsers\e\fIuser\fR\eAppData\eRoaming\enmap\enmap\-config\&.conf on Windows\&. .RE
|
||||
The contents of the file should be:
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
username = \fIusername\fR
|
||||
password = \fIpassword\fR
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.sp
|
||||
Alternatively, you can cache your credentials more securely if you have the
|
||||
\fBsvn\fR
|
||||
command\-line program installed\&. Run the command
|
||||
\fBsvn ls https://svn\&.nmap\&.org/updates\fR, enter your credentials, and agree to cache them when asked\&.
|
||||
.SH "OPTIONS SUMMARY"
|
||||
.PP
|
||||
\fB\-d \fR\fB\fIdirectory\fR\fR
|
||||
.RS 4
|
||||
Install to
|
||||
\fIdirectory\fR\&. Normally installation goes to a suitable place under your home directory:
|
||||
\&.nmap/updates/\fIchannel\fR
|
||||
on Unix and
|
||||
AppData\eRoaming\enmap\eupdates\e\fIchannel\fR
|
||||
on Windows\&. This option can be used by root to install updates system\-wide\&.
|
||||
.RE
|
||||
.PP
|
||||
\fB\-h\fR, \fB\-\-help\fR
|
||||
.RS 4
|
||||
Show a help message and exit\&.
|
||||
.RE
|
||||
.PP
|
||||
Any other arguments are taken to be the names of channels to load from\&. The channels are tried in order until one is successful\&.
|
||||
98
docs/nmap-update.xml
Normal file
98
docs/nmap-update.xml
Normal file
@@ -0,0 +1,98 @@
|
||||
<refentry id='man-nmap-update'>
|
||||
<refmeta>
|
||||
<refentrytitle>nmap-update</refentrytitle>
|
||||
<manvolnum>1</manvolnum>
|
||||
<refmiscinfo class="source">nmap-update</refmiscinfo>
|
||||
<refmiscinfo class="manual">nmap-update Reference Guide</refmiscinfo>
|
||||
</refmeta>
|
||||
<refnamediv id='man-name'>
|
||||
<refname>nmap-update</refname>
|
||||
<refpurpose>Updater for Nmap's architecture-independent files</refpurpose>
|
||||
</refnamediv>
|
||||
<refsynopsisdiv id='man-synopsis'>
|
||||
<cmdsynopsis>
|
||||
<command>nmap-update</command>
|
||||
<arg choice='opt'>
|
||||
<replaceable>options</replaceable>
|
||||
</arg>
|
||||
<arg choice='opt' repeat='rep'>
|
||||
<replaceable>channel</replaceable>
|
||||
</arg>
|
||||
</cmdsynopsis>
|
||||
</refsynopsisdiv>
|
||||
<refsect1 id='man-description'>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
nmap-update is an updater for Nmap's architecture-independent files. It is
|
||||
used to keep up to date with changes and new scripts for the Nmap Scripting
|
||||
Engine.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Updates are distributed in the form of <quote>channels</quote>, which are
|
||||
named directories that usually correspond to Nmap version numbers. When
|
||||
nmap-update is installed, it will pull from the channel corresponding to the
|
||||
version of Nmap it was installed with, until Nmap and nmap-update are
|
||||
upgraded as a whole.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The program works by updating from a remote Subversion repository. To supply
|
||||
authentication credentials, create a configuration file:
|
||||
<simplelist>
|
||||
<member><filename>/home/<replaceable>user</replaceable>/.nmap/nmap-config.conf</filename>
|
||||
on non-Windows systems, or</member>
|
||||
<member><filename>C:\Users\<replaceable>user</replaceable>\AppData\Roaming\nmap\nmap-config.conf</filename>
|
||||
on Windows.</member>
|
||||
</simplelist>
|
||||
The contents of the file should be:
|
||||
<programlisting>
|
||||
username = <replaceable>username</replaceable>
|
||||
password = <replaceable>password</replaceable>
|
||||
</programlisting>
|
||||
Alternatively, you can cache your credentials more securely if you have the
|
||||
<command>svn</command> command-line program installed. Run the command
|
||||
<command>svn ls https://svn.nmap.org/updates</command>, enter your
|
||||
credentials, and agree to cache them when asked.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 id='man-briefoptions'>
|
||||
<title>Options Summary</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><option>-d <replaceable>directory</replaceable></option></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Install to <filename><replaceable>directory</replaceable></filename>.
|
||||
Normally installation goes to a suitable place under your home
|
||||
directory:
|
||||
<filename>.nmap/updates/<replaceable>channel</replaceable></filename>
|
||||
on Unix and
|
||||
<filename>AppData\Roaming\nmap\updates\<replaceable>channel</replaceable></filename>
|
||||
on Windows. This option can be used by root to install updates
|
||||
system-wide.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>-h</option></term>
|
||||
<term><option>--help</option></term>
|
||||
<listitem>
|
||||
<para>Show a help message and exit.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
|
||||
<para>
|
||||
Any other arguments are taken to be the names of channels to load from. The
|
||||
channels are tried in order until one is successful.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<!--
|
||||
<refsect1 id='man-legal'>
|
||||
&legal-notices;
|
||||
</refsect1>
|
||||
-->
|
||||
</refentry>
|
||||
Reference in New Issue
Block a user