-------------------------------------------------------
Welcome!

This is the documentation file for wiNmap, a portscan
tool for windows(tm) platforms with an nmap-like UI.

If you are familiar with nmap, you should have no 
trouble using winmap, as the parameters and output
are designed to be at least vaguely similar.


Background:
~~~~~~~~~~~
This project was started in March 2000 by the author
Olle Segerdahl <olle@defcom.com>.
It's intent was to create a portscanning tool which
was slim and usable, using only raw sockets (ie. no
device drivers needed) and with an nmap-like user 
interface. It was also intended to increase the 
authors knowledge about winsock on Windows 2000(tm).

Features:
~~~~~~~~~
Winmap features TCP port scanning using connect() and
(on windows 2000 (tm) or later) ordinary "half-open"
SYN scan. It also features optional ICMP pinging of
targets as well as a ping scan. UDP portscanning
capabilities are available on all windows platforms.
As many tuning parameters as possible are changeable
by the user via command line options.

Limitations:
~~~~~~~~~~~~
SYN scan is only available on windows 2000 (tm) and
later versions of windows(tm). This is due to the
limitations of the standard winsock2 code in releases
prior to w2k. People using third-party windows socket
providers may or may not have these limitations.
SYN scan requires administrative or system priviledges.
Host specification using comma separated lists and/or
dash separated ranges is only available on the fourth
quad in the IP address. This means you can only scan
a maximum of one "C-class" range in each invocation.

Files:
~~~~~~
The distribution contains the following files:
winmap.c:		The main program source file.
net.c:		All network scanning functions.
winmap.h:		The program header file.
winmap.exe:		A compiled binary, ready to use.
Win32-Prj/*:	MSVC project files.
getopt.c:		Getopt source file from GNU C lib. 
getopt.h:		Getopt header file.
netinet/*:		TCPIP header files ripped from BSD.
WindowsNT.reg:	Registry update for NT/win2k.
Windows9X.reg:	Registry update for 95/98.
COPYING:		A copy of the GNU GPL v2.
CHANGELOG:		A brief version history.
FAQ:			The FAQ in a textfile. READ THIS!
README:		This file.

License:
~~~~~~~~
Winmap is distributed under the GNU General Public
License, a copy of which resides in the COPYING
file in the distribution. Any legal questions 
regarding this license are probably best answered by
the Free Software Foundation (fsf.org or gnu.org).
It uses some of the standard BSD netinet headers, so:
This product includes software developed by the 
University of California, Berkeley and its contributors.
;)

Portability:
~~~~~~~~~~~~
Winmap was written with the intent to use Windows(tm)
specific functions only where absolutely nescessary
so portablility problems are hopefully limited to
the slightly Windows(tm) specific socket functions.
The rest of the non-socket specific code should port 
pretty easily to any UN*X-like C environment. 
(Why anybody would want to is beyond me, though.)

Bugs:
~~~~~
Bug reports are appreciated, and best directed to this
e-mail address: olle@defcom.com
