-$Header$
-
-This is the beta test version of Moira (version 2.0). See the
-document doc/install for building and installation instructions.
-Contents of this distribution:
-
-backup: source to smsbackup & smsrestore. Depends on files in ~/db
-
-bin: `make install' will put binaries here that are only used on the
- sms server machine, not needed on clients. This should be a
- duplicate of /u1/sms/bin on the sms machine.
-
-clients: contains subdirs with source to each of the client programs
-
-db: Database code: scripts and programs to create a database
-
-dbck: database consistency checker
-
-dcm: the Data Control Manager
-
-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.
-
-et: Sources to com_err stuff. This is a private copy so that the
- com_err() routine supports printf style arguments.
-
-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.
-
-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.
-
-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.
-
-lib: Random libraries, including an improved version of malloc which does
- "scribble checking" to verify that you aren't trashing your address
- space. This dir includes soft-links to files in other dirs.
-
-man: man pages for SMS programs
-
-reg_svr: the daemon to handle the back end of user registration
-
-regtape: a program to read the tape from the registrar's office
-
-rpc: The code for the RPC mechanism: libsms.a is built here.
-
-server: smsd & libsmsglue.a come from here.
-
-ss: sources to libss.a, the line parser used by smstest.
-
-test: smstest
-
-update: Routines for performing updates to servers (including its own
- GDB-based RPC).
+README file for building Moira (R)
+
+This is the root directory of MIT Athena's Moira service management
+system source code.
+
+Here are the steps for building the Moira source.
+
+1. If you want to build in the directory with the sources, run
+ ./configure
+ in that directory. If you want to build in another directory, run
+ /path/to/moira/sources/configure
+ from that directory. Note that for this to work you will need to
+ be using a "make" program that supports VPATH.
+
+ Some options you might want to use:
+ --with-com_err=PREFIX (defaults to util/et)
+ --with-krb4=PREFIX (required)
+ --with-hesiod=PREFIX
+ --with-zephyr=PREFIX
+ --with-oracle=PREFIX (defaults to $ORACLE_HOME, if present)
+ --with-afs=PREFIX (defaults to /usr/afsws, if present)
+ --with-readline=PREFIX
+
+ (When building Moira on Athena, you should use the Athena source
+ tree config.site file, either by doing
+ setenv CONFIG_SITE /mit/source/packs/build/config.site
+ before running configure, or by using the Athena build system
+ script /mit/source/packs/build/do.sh.)
+
+2. cd to include. Read through moira_site.h adjusting the paths to
+ what you want on your system. Also change the #define of
+ MOIRA_SERVER to be the name of the server you are planning on
+ using. (Note that this is only used if hesiod lookup fails.)
+
+3. After configuring, run "make" to build everything. The server-side
+ programs will be built if Oracle was found by configure.
+
+4. Run "make install". You may want to check that programs
+ are installed where you want. Then add the appropriate
+ directories to your PATH environment variable.
+
+* Moira and Hesiod are registered trademarks of the Massachusetts
+Institute of Technology (MIT). Kerberos, and Zephyr are trademarks of
+MIT. No commercial use of these trademarks may be made without prior
+written permission from MIT.