=============================================================================
PluSHS - Pluf Simple Hostname Scanner					v1.2
=============================================================================

Plushs is a network analisis tool, which allows a user to resolve the names 
of a single ip address or entire network of addresses to maintain a "map" of 
the names that comprise a certain network.

The System's Administrator commonly assigns host names that relate to the 
operating system installed or the function that it performs in a certain 
network; for instance:

C class network -> 202.72.112

	202.72.112.1 -> mail.foo.com
	202.72.112.2 -> cisco.foo.com
	202.72.112.3 -> www.foo.com
	202.72.112.4 -> user10.adsl.foo.com
	...

In this example it is possible to identify that one of hosts is a router 
Cisco and another one is a mail server so everybody can know the most 
important host of the network.


    Supported Platforms
[*]====================

Plushs has been tested in the following plataforms:

- OpenBSD 3.1 (intel) [ primary development platform ]
- FreeBSD 4.1 (intel)
- Linux 2.4.18 (intel)
- Solaris 2.7 (sparc)
- AIX 4.3.3 (powerpc)

If beams to work well this program in other systems I thank in advance to 
you.


    Download
[*]=========

The plushs primary download site is the following:

 http://plushs.sourceforge.net.

I want thank www.sourceforge.net for web space.


    Plugins
[*]========

see man page plushs(1).


    Examples
[*]=========

- Search the hostname of the following ip address:
	
  plushs 192.168.1.1

- Scan a whole C class network:
  
  plushs 192.168.1.1-255

- Scan a whole C class network and get alternate names for each ip ad-dress:
  
  plushs -a 192.168.1.1-255

- Search in the hostname the first occurrence of the string "cache". We
  use verbose mode:

  plushs -av -s cache 192.168.1.1-255

- Search in the hostname the first occurrence of the patterns extracted from
  file "pat_list" also we log the results into the file log:

  plushs -v -x pat_list -o log 192.168.1.1-255

- Scan an ip address or an ip addresses range extracted from file "ip_list" 
  and log results. We run plushs in daemon mode:
  
   plushs -va -D -l ip_list -o log

- Scan the following ip addresses range: 192.168.10-20.1-40. We want to run
  nmap when the pattern "server" is found also we won't use colour support:  

  plushs -va -c -s "server" -f "nmap%s-O%s%h" 192.168.10-20.1-40

- Scan the following ip addresses range: 192.168-169.1.1-100. We want to run
  traceroute whe the pattern "router" is found also we use plugins with pid 
  2, 3 and 6 (that you have been coded) and log results into the file
  "information":
   
  plushs -va -s "router" -f "traceroute%s%i" -P 2,3,6, -o information
  192.168-169.1.1-100


    Contributors
[*]=============

+ Alejandro Juarez <alex@openbsd.org.mx>: thx very much for this README in 
  english.

+ Thayne Forbes <thayne@xmission.com>: hopefully better english translation.

 
    Contact
[*]========

Please send your comments, suggestions and bugs to pluf@wanadoo.es 

-p.
