$Header: /afs/athena.mit.edu/astaff/project/moiradev/RCS/README,v 1.6 93/11/09 16:02:39 jweiss Exp $

This is Moira* version 3.0.  See the document src/README for building
and installation instructions.  Join the moira@mit.edu mailing list by
sending a request to moira-request@mit.edu.  Please report bugs to
bug-moira@mit.edu.  Moira currently builds on a DECStation running
Ultrix 4.2A.  We suspect that it will be fairly easy to get the
clients to build on other platforms, but have not done so ourselves.

* Moira is a registered trademark of the Massachusetts Institute of
Technology (MIT).  No commercial use of this trademark may be made
without prior written permission from MIT.


Contents of this distribution:

README: this file.

doc: Documentation.  There are a few smaller documents in this
	directory.  the tech_plan subdirectory contains the most
	detailed document on the design and operation of Moira,
	although it is somewhat out of date.

patchlevel.h: Header file that defines the current version number

sample.tar.Z: A compressed tar file of a backup of a trivial Moira
	database.  Restoring this database and playing with it will
	give you an idea of how we use Moira at Athena.

src/backup: Aource to mrbackup & mrrestore.  Depends on files in src/db

src/bin: `make install' will put binaries here that are only used on
	the Moira server machine, not needed on clients.  This should
	be a duplicate of /u1/sms/bin on the Moira machine.

src/clients: Contains subdirs with source to each of the client
	programs

src/config: Contains imake configuration files

src/db: Database code: scripts and programs to create a database

src/dbck: Database consistency checker

src/dcm: The Data Control Manager

src/gdb: Noah Mendelsohn's GDB library (which forms the core of our
	RPC mechanism)  This is a private copy because the startup
	negotiation is different.  This directory also contains
	documentation on the GDB library.

src/gen: Server config file generators.  These are the programs that
	extract info from the database.  The shell scripts that
	install the files are also here.

src/include: Include files.  Has soft links to header files in other
	dirs.  Reference include/foo.h as <foo.h>, and add a
	-I../include in your Makefiles.

src/incremental: Incremental update programs. This directory does not
	exist in the public distribution, because our incremental
	source contains proprietary source that we are not allowed to
	distribute.

src/lib: The Moira library.  This includes code that manages the GDB
	layer for Moira.

src/man: Man pages for Moira programs

src/reg_svr: The daemon to handle the back end of user registration

src/regtape: A program to read the tape from the registrar's office

src/server: moirad & libmoiraglue.a come from here.

src/update: Routines for performing updates to servers (including its own
	GDB-based RPC).

src/util/et: Sources to com_err stuff.  This is a private copy so that
	the com_err() routine supports printf style arguments.

src/util/ss: Sources to libss.a, the line parser used by mrtest.