							version 1.4
NAME
	qstat - Get statistics from Quake servers

SYNOPSIS
	qstat [-H] [-u] [-nf] [-r retries] [-i interval] [-f file]
		host[:port] ...

DESCRIPTION
	Qstat shows if the listed hosts are running a Quake server.
	The hosts are either down, non-responsive, or running a
	server.  For hosts running a server, the server name, map name,
	and current number of players are displayed.

	The host may be specified as an IP address or a hostname.

	One line will be displayed for each argument.  The first
	component of the line will be the argument given on the
	command-line.  This can be used as a key to match input
	arguments to server status.

	Some reasonable sources of Quake server hosts are
	http://citrix.progress.com/servers.html and
	http://www.stomped.com/servers.html.  If you know of other
	servers, let me know!

OPTIONS
	-f	Read hosts from the given file.  If file is '-',
		then read from stdin.  Multiple -f flags may be
		used.  The file should contain host names or IP
		addresses separated by white-space (tabs, new-lines,
		spaces, etc).
		
	-H	Resolve IP addresses to host names.  Use with caution
		as many Quake servers do not have registered host
		names.  Qstat may take up to a minute to timeout
		on each unregistered IP address.  The duration of
		the timeout is controlled by your platform.  Names
		are resolved before attempting to contact any hosts.

	-u	Only display hosts that are running a Quake server.

	-nf	Only display servers that are not full.

	-i	Interval in seconds between retries.  Specify as a
		floating point number.  Default interval is 0.5 seconds.

	-r	Number of retries.  Qstat will send this many packets
		to a host before considering it non-responsive.  Default
		is 3 retries.

NOTES
	Qstat sends packets to each host and waits for return packets.
	After some interval, another packet is sent to each host which
	has not yet responded.  This is done several times before the
	host is considered non-responsive.  Qstat can wait for responses
	from up to 20 hosts at a time.  For host lists longer than
	that, qstat checks more hosts as results are determined.

	The number of available file descriptors limits the number of
	simultaneous responses that can be checked.  Qstat reuses file
	descriptors so it can never run out.  The macro MAXFD in
	qstat.c determines how many file descriptors will be
	simultaneously opened.  Raise or lower this value as needed.  The
	default is 20 file descriptors.

	Operating systems which translate ICMP Bad Port
	(ICMP_PORT_UNREACHABLE) into a ECONNREFUSED will display some
	hosts as DOWN.  These hosts are up and connected to the
	network, but there is no program on the port.  Solaris 2.5 and
	Irix 5.3 correctly support ICMP_PORT_UNREACHABLE, but Solaris
	2.4 does not.  See page 442 of "Unix Network Programming" by
	Richard Stevens for a description of this ICMP behavior.

	Operating systems without correct ICMP behavior will just
	report hosts without Quake servers as non-responsive.
	Windows NT and Windows 95 don't seem to support this ICMP.

	For hosts with multiple IP addresses, qstat will only send
	packets to the first address returned from the name service.

PORTABILITY
	Qstat has been compiled and tested on Solaris 2.4 and 2.5,
	Irix 5.3, Windows NT, Windows 95, and Linux 2.0.

WINDOWS
	The Windows version of qstat (qstat.exe) runs on Windows 95
	and Windows NT.  On Windows 95, short-cuts can be used to
	set the arguments to qstat.  On Windows NT create a batch
	file similar to the supplied qstat.bat.

VERSION
	This is qstat version 1.4.  It works with qtest1 and
	Quake shareware versions 0.9x and 1.0 from id Software.

AUTHOR
	Steve Jankowski
	steve@activesw.com
	http://www.activesw.com/people/steve/qstat.html

COPYRIGHT
	Permission granted to use for any purpose you desire as long as
	you maintain the file prolog in the source code and you derive
	no monetary benefit from use of the source or resulting program.

