TCB::System - System Database for the TCB Group
===============================================

TCB::System is a DBIx::Frame object written to track TCB system
administration-related information, such as equipment, software licenses,
port maps, etc.  It is the parent class to several other packages that use
the same database.  

On its own, TCB::System is a fairly incomplete package; it comes with
TCB::System::Misc, which offers a few miscellaneous tables, but depends on
other packages to do the rest of the job:

  TCB::Equipment 	  Equipment and Software
  TCB::Loan 		  Equipment Loans
  TCB::Help		  Help Database
  TCB::SysLoads 	  System Loads and Supercomputers
  TCB::System::Obsolete   Obsolete Tables

Prerequisites
=============

You must have the following modules installed:

  DBIx::Frame		v1.05

You will also need a running database (mysql is the only one tested), and 
permission to either use the existing contents or create new ones.

Installation Notes
==================

Installing this software is easy:

  perl Makefile.pl
  make
  make test
  make install

Creating the database is a bit trickier - you'll need a running mysql
database, and permission to create the tables necessary.  Once you've got
that, log into the database server and run:

  system_create.pl -b DATABASE -u USER -p PASSWORD -ca 

You'll probably want to look at the script first, and read the
installation instructions for new databases from the DBIx::Frame
installation manual.  Also, this won't actually populate any database
unless you also load 

Documentation
=============

All of the documentation is in the manual pages - 'man TCB::System' after
installation, or 'pod2text TCB/System.pm | less' right now.  'perldoc
TCB::System' probably also works.

Web Page
========

http://www.ks.uiuc.edu/Development/MDTools/tcb-system/

                            - Tim Skirvin (tskirvin@ks.uiuc.edu)
-- 
   Theoretical and Computational    http://www.ks.uiuc.edu/~tskirvin/
Biophysics, Beckman Institute, UIUC    Senior Systems Administrator
