README

   1 $Header$
   2
   3 This is the beta test version of Moira (version 2.0).  See the
   4 document doc/install for building and installation instructions.
   5 Contents of this distribution:
   6
   7 backup: source to smsbackup & smsrestore.  Depends on files in ~/db
   8
   9 bin: `make install' will put binaries here that are only used on the
  10         sms server machine, not needed on clients.  This should be a
  11         duplicate of /u1/sms/bin on the sms machine.
  12
  13 clients: contains subdirs with source to each of the client programs
  14
  15 db: Database code: scripts and programs to create a database
  16
  17 dbck: database consistency checker
  18
  19 dcm: the Data Control Manager
  20
  21 doc: Documentation.  There are a few smaller documents in this
  22         directory.  the tech_plan subdirectory contains the most
  23         detailed document on the design and operation of moira.
  24
  25 et: Sources to com_err stuff.  This is a private copy so that the
  26         com_err() routine supports printf style arguments.
  27
  28 gdb: Noah Mendelsohn's GDB library (which forms the core of our RPC
  29         mechanism)  This is a private copy because the startup
  30         negotiation is different.  This directory also contains
  31         documentation on the GDB library.
  32
  33 gen: server config file generators.  These are the programs that
  34         extract info from the database.  The shell scripts that
  35         install the files are also here.
  36
  37 include: include files.  Has soft links to header files in other dirs.
  38         Reference include/foo.h as <foo.h>, and add a -I../include in
  39         your Makefiles.
  40
  41 lib: Random libraries, including an improved version of malloc which does
  42         "scribble checking" to verify that you aren't trashing your address
  43         space.  This dir includes soft-links to files in other dirs.
  44
  45 man: man pages for SMS programs
  46
  47 reg_svr: the daemon to handle the back end of user registration
  48
  49 regtape: a program to read the tape from the registrar's office
  50
  51 rpc: The code for the RPC mechanism: libsms.a is built here.
  52
  53 server: smsd & libsmsglue.a come from here.
  54
  55 ss: sources to libss.a, the line parser used by smstest.
  56
  57 test: smstest
  58
  59 update: Routines for performing updates to servers (including its own
  60         GDB-based RPC).