smmuserv
--------

These are the sources to the smmuserv program which acts as the 
Quakeworld-style lookup program for internet SMMU servers. It
should compile under linux and possibly other unix-style systems
although linux is the only platform tried so far. Features include:

 * Support for connections from multiple clients
 * Administrative commands in server:
       - masskick (kick everyone off)
       - kill (shutdown server)
       - stats (server stats)
       - motd (message of the day)
 * HTML Stats page auto-created every 5 minutes

The main two functions are the 'add' and 'list' functions which the SMMU
client uses to register itself as a server and find a list of servers
respectively. Servers adding themselves have their ip's stored in a list
which is sent to other clients searching for games.

The server has a built-in help command which will list all the available
commands. Note though that you need to have a local connection to use the
control commands. To connect to the server, simply type from a terminal:

	telnet localhost 52638

cron
----
smmuserv stores a file smmuserv.pid which it uses to ensure that only one
copy is running at a time. If you try to run more than one you will get a
message telling you that more than one copy is probably running and advising 
you against it. You can get around this by running it with the -force switch.

Included in this distribution is a script named installcron which will add
smmuserv into the crontab. This way, if the server goes down for whatever
reason, it will soon be restarted automatically (within 10 minutes).

Settings
--------
smmuserv uses command line parameters to provide it with settings: but you
can create a file ~/.smmuservrc which simply contains a list of command
line parameters, eg:

	-logfile /home/simon/smmuserv-log
	-motd "fraggles server"
	-html /home/simon/public_html/index.htm

Running smmuserv with the -help switch should display a list of valid
command line parameters.

HTML
----
smmuserv can be set to automatically create an html page every 5 minutes
which displays status information about the server. The best way to use
this is to create a directory in your user directory called 'public_html'
and set smmuserv to place a file here called 'index.html'. The Apache
server which is included in most linux distributions can then be easily 
used to access the file. Set a command line in your ~/.smmuservrc file
which reads:

	-html [your user directory]/public_html/index.html

You should also copy the included image file 'smmuserv.png' into the
public_html directory for this to work properly. You should now be
able to access the page by typing the location into your web browser:

	http://[your ip]/~[your username]

License
-------
smmuserv is released under GPL version 2 or any later version.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Simon Howard
fraggle@alkali.org
