diff --git a/docs/nmap-update.1 b/docs/nmap-update.1 new file mode 100644 index 000000000..095e9efa6 --- /dev/null +++ b/docs/nmap-update.1 @@ -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 +.\" 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\&. diff --git a/docs/nmap-update.xml b/docs/nmap-update.xml new file mode 100644 index 000000000..5f7654091 --- /dev/null +++ b/docs/nmap-update.xml @@ -0,0 +1,98 @@ + + + nmap-update + 1 + nmap-update + nmap-update Reference Guide + + + nmap-update + Updater for Nmap's architecture-independent files + + + + nmap-update + + options + + + channel + + + + + Description + + 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. + + + + Updates are distributed in the form of channels, 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. + + + + The program works by updating from a remote Subversion repository. To supply + authentication credentials, create a configuration file: + + /home/user/.nmap/nmap-config.conf + on non-Windows systems, or + C:\Users\user\AppData\Roaming\nmap\nmap-config.conf + on Windows. + + The contents of the file should be: + +username = username +password = password + + Alternatively, you can cache your credentials more securely if you have the + svn command-line program installed. Run the command + svn ls https://svn.nmap.org/updates, enter your + credentials, and agree to cache them when asked. + + + + + Options Summary + + + + + + Install to directory. + Normally installation goes to a suitable place under your home + directory: + .nmap/updates/channel + on Unix and + AppData\Roaming\nmap\updates\channel + on Windows. This option can be used by root to install updates + system-wide. + + + + + + + + Show a help message and exit. + + + + + + Any other arguments are taken to be the names of channels to load from. The + channels are tried in order until one is successful. + + + + +