[moira.git] / README

$Header$

This is SMS version 2.0.  See the file INSTALLATION in this directory
for instructions on building and installing SMS.  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

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.

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

regtest: a sample of what the homedirectory for "register" should look like

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).
Commit	Line	Data
bc4d8d41	1	$Header$
	2
	3	This is SMS version 2.0. See the file INSTALLATION in this directory
	4	for instructions on building and installing SMS. Contents of this
	5	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
	22
	23	et: Sources to com_err stuff. This is a private copy so that the
	24	com_err() routine supports printf style arguments.
	25
	26	gdb: Noah Mendelsohn's GDB library (which forms the core of our RPC
	27	mechanism) This is a private copy because the startup
	28	negotiation is different.
	29
	30	gen: server config file generators. These are the programs that
	31	extract info from the database. The shell scripts that
	32	install the files are also here.
	33
	34	include: include files. Has soft links to header files in other dirs.
	35	Reference include/foo.h as <foo.h>, and add a -I../include in
	36	your Makefiles.
	37
	38	lib: Random libraries, including an improved version of malloc which does
	39	"scribble checking" to verify that you aren't trashing your address
	40	space. This dir includes soft-links to files in other dirs.
	41
	42	man: man pages for SMS programs
	43
	44	reg_svr: the daemon to handle the back end of user registration
	45
	46	regtape: a program to read the tape from the registrar's office
	47
	48	regtest: a sample of what the homedirectory for "register" should look like
	49
	50	rpc: The code for the RPC mechanism: libsms.a is built here.
	51
	52	server: smsd & libsmsglue.a come from here.
	53
	54	ss: sources to libss.a, the line parser used by smstest.
	55
	56	test: smstest
	57
	58	update: Routines for performing updates to servers (including its own
	59	GDB-based RPC).