                               CLAM README
                               ===========

Introduction.
-------------
  Clam is a Unix(tm) shell that has many features of tcsh, sh and improvements
all its own. It was written as a programming project for a Computing Science
Honours year and has undergone further work since. The most notable features
of Clam are: command line editing; "real" aliases; aliases and builtins are on
the path; normal wildcard expansion in/output redirection etc. Please note,
Clam is not csh/tcsh but is original source code and differs in some ways from
those shells in the features it provides.

  Clam has been ported to a number of different UNIX environments including
4.xBSD, SysV, SunOS, Ultrix, and Minix. The terminfo routines for SysV hasn't
been written yet (as I have none to test it on) so Clam relies purely on
termcap features at this stage.

  Clam also allows clam-shell-scripts although flow control is not yet written.

Copyright Notice.
-----------------
            Clam is copyright (c) 1988 by Callum Gibson.

  Clam is provided free of charge. You may make copies of it and redistribute
it if you wish. You may not sell Clam source or binaries. You may alter Clam
for your own purposes but you may not redistribute altered copies of Clam or
part thereof. You must leave the copyright notice intact at the top of every
Clam source file. Finally, no warranty is provided with Clam.

Bug Fixes and Updates.
----------------------
  Please report any bugs you find to the custodian of the source:

	Warren Toomey
	email: wkt@csadfa.cs.adfa.oz.au
	snail: Dept. of Computing Science
	       Australian Defence Force Academy
	       Canberra. NSW. Australia. 2600.

or to the author:

	Callum Gibson
	snail: c\- 32 Robert St,
		Bellingen. NSW. Australia. 2454.

The limitation on bug-fix posting and redistribution is so that I have a
version control on Clam and so that there is a standard copy out in the real
world. This also gives me the chance to test the suggested change (or see if
it makes sense) or let me find it myself and save yourself the trouble!

  Clam was initially released in the newsgroup comp.os.minix in early 1989.
Further postings will be made to this group as revisions are made. No definite
plans have been made to post it to any other source group as yet.

Documentation.
--------------
  Clam documentation is provided in Clam.1. The manual is in nroff -man format.
The file Log.tex (if included) is the development log of Clam continued from
the original honours project log. If you really want, a copy of the thesis
in LaTeX can be emailed or sent to you on disk. The thesis does actually
explain a bit of the design philosophy and implementation aspects of Clam.

History.
--------
  Clam is the result of a Computing Science Honours year programming project
at the University of New England, Armidale, NSW, Australia. Further
development has since taken place (and will continue). Approximately 10 months
of work went into the original version of Clam from March to November in 1988.
In March 1989, work recommenced to remove the more elusive bugs and proceed
to add more features. This work culminated in the release of Clam 1.3.3 in
October, 1989 to the newsgroup comp.os.minix.

Clam was initially developed on a Pyramid 90x owned by the Department of Maths,
Stats and Comp. Sci. and was later ported to a SUN 3/50, Gould NP1, Vaxstation
(running Ultrix) and IBM-PC/Minix

Future.
-------
  Clam 1.4 is a maintenance release to increase portability, tidy up code and
to remove known bugs; this was done by Warren Toomey. It is intended to
merge this version with the changes that Callum Gibson is working on, and
to release this as Clam 1.5, at a date to be decided.
