untermud/DOC/
untermud/DOC/U/
untermud/DOC/U/U-examples/
untermud/DOC/internals/
untermud/DOC/wizard/
untermud/MISC/
untermud/MISC/dbchk/
untermud/RWHO/
untermud/RWHO/rwhod/
	[-1 TH]:
		If you already know your way around Unter, take a look
		at the CHANGES file for details about latest mods.


	FIRST:
		Read the copyright. If you have a problem with it, delete
		all these files. Thank you.


	SECOND:
		If you are vaguely familiar with Untermud:
			Read the wizard's guide "necronomicon" in DOC/wizard
		otherwise:
			Read the users documentation in DOC/user first.


	THIRD:
		Read the notes on bugreports and what to do if you have a
		problem with UnterMUD. DOC/BUGREPORT is the file.


	FOURTH:
		Read and edit config.h, after saving a copy to refer to.
		Save a copy of config.h across releases, and as long as
		config.h hasn't changed much they you don't need to worry
		about reconfiguring.


	FIFTH:
		Consider typing "make".
		If you have makedepend, try typing "make depend" first.


	SIXTH:
		If you didn't get an executable named "mud", go back to
		the SECOND step. If you did, bravo, you're almost done.
		Read the file DOC/wizard/howtostart again, if you haven't
		already.


	SEVENTH:
		Have fun.

--------------ROADMAP: These are the files in this distribution-------------

CMD		- source for game commands
		(not worth listing them all)
		(see 'cmd.c' - the master command table)


DOC		- notes on how things work, etc.
DOC/README	- meta doc
DOC/internals	- internals, developers notes
DOC/misc	- misc doc
DOC/user	- user doc
DOC/wizard	- how to be a wizard


DB		- database specific routines
DB/Makefile	- makefile for db lib
DB/README	- notes on db code
DB/bigrams.c	- generate bigram statistics if you're bored
DB/comp.c	- compress an OIF file
DB/config	- sample boot configuration file
DB/startup	- sample startup configuration file
DB/dbmchunk.c	- dbm/ndbm chunk file management code
DB/dbmconf.c	- dbm/ndbm chunk file configuration code
DB/dumpdb.c	- database dumper utility program
DB/expr.c	- database expression evaluator
DB/gdbmchunk.c	- GNUdbm chunk file management code
DB/gdbmconf.c	- GNUdbm chunk file configuration code
DB/hashconf.c	- hash directory database configuration code
DB/hashdir.c	- hash directory database management code
DB/loaddb.c	- database loader utility
DB/minimal_db.oif	- minimal start-up DB in OIF format
DB/oif.c	- object interchange storage/sizing routines


RWHO
RWHO/Makefile	- makefile for rwho server and clients
RWHO/README	- minimal docs on rwho server
RWHO/clilib.c	- client side calls to rwho server (not UnterMUD specific!)
RWHO/muds.dat	- sample rwho server configuration file
RWHO/mudwho.c	- client to query rwho server
RWHO/mwhod.c	- rwho server source
RWHO/updat.c	- UnterMUD callouts to rwho server


MISC
MISC/OIFextract.c	- Russ Smith's TinyMUD->OIF conversion tool
MISC/dbchk.c		- Chris Siebenmann's database checker


/* VMS port courtesy of Andrew Molitor */
VMS/makecmd.vms		- build script for command libraries
VMS/makedb.vms		- build script for db code
VMS/makemud.vms		- build script for mud
VMS/makerwho.vms	- build script for rwho code
VMS/net_vms.c		- network layer
VMS/vms.readme		- installation docs
VMS/vms_dbm.c		- dbm clone built on RMS
VMS/vms_dbm.h		- interface for dbm clone built on RMS
VMS/vms_load.c		- database loader for RMS database
VMS/xmit_vms.c		- object transmission routines

U/Makefile		- Makefile for interpreter
U/README		- interpreter notes
U/b_*.c			- builtin interpreter commands
U/bltin.c		- builtin command table
U/u.h			- interpreter definitions
U/u_util.c		- misc. interpreter code
U/uinterp.y		- interpreter yacc grammar


Makefile	- general makefile
README		- recursion!
activ.c		- code that handles activating ofails and whatnot
alloc.c		- memory allocator and deferred memory freeing code
bool.c		- Molly's boolean evaluator from hell
cache.c		- object storage cache functions
cmd.c		- master game command table (source for commands is in CMD)
cmd.h		- interface for game commands
config.h	- system dependency file (READ THIS FILE!)
cron.c		- callouts to cronological execution code
do_go.c		- code implementing player movement
do_home.c	- code implementing object teleportation
do_look.c	- generic (sort of) look-at-thing function
errors.c	- error table
list.c		- list manipulation commands
login.c		- login/password checking, welcome messages, goodbye massages
look.h		- flags for generic look-at-thing function
match.c		- matching code
match.h		- matching code interface file
misc.c		- low level miscellaneous functions (error logging, etc)
misc2.c		- high level miscellaneous functions
mud.c		- main program entry point
mud.h		- main game configuration file and interfaces
net.c		- bsd socket tcp/ip network layer (default option)
obj.c		- low-level object manipulation code
rot.c		- portable trivial encryption routines
run.c		- command executor code
sbuf.c		- stretchy buffer library code
sbuf.h		- interface for stretchy buffer library
sym.c		- global macro table management code
sym.h		- global macro table interface
trans.c		- object transaction code
trans.h		- transaction manager interface
util.c		- somewhat higher level object/list manipulation commands
vars.c		- declarations of variable/type names and text, variable tables
vars.h		- forward declarations of variable/type names
version.c	- revision level
xact.c		- transaction basic routines
xact.h		- transaction interface
xmit.c		- object transmission routines

Parts of files that have any kind of system specific or questionable
routines will be marked with a comment WARNING that you can grep for.

This code would be lint-free, mostly, except where the standards creeps have
gone and made it nearly impossible to write portable code anymore.