README file for MaRS Maryland Routing Simulator Version 2.0
Released 1992/Oct

 * In return for the use of this software, we require only that
 * you cite University of Maryland, Computer Science Department
 * as the source of this software in any publication resulting
 * from its use. 

TO GET HELP
===========
Send e-mail to
	mars@cs.umd.edu
		to contact us
	mars-users@cs.umd.edu
		to discuss MaRS related topics
	mars-users-request@cs.umd.edu
		for additions/deletions/updates to the mailing list mars-users.

DOCUMENTATION 
============= 
The MaRS User and Programmer's Manuals in Postscript format can be found 
in the "doc" directory. An additional document describing XMotif interface
can also be found there.

There is also man page for mars (under "man" directory) which explains the
command line options.

FILES 
=====
Source code is in file
	MaRS-2.0.tar.Z
Documentation is in file
        MaRS-2-doc.tar.Z

INSTALLATION GUIDELINES
=======================
To install mars, do
	create directory MaRS
	cd MaRS 
	ftp file MaRS-2.0.tar.Z 
	uncompress MaRS-2.0.tar.Z
	tar -xfp MaRS-2.0.tar 
	edit the file make-install (read the comments in that file)
	make-install

which will make the required directories and executables.
You will find an executable image of MaRS as bin/mars

Note: Due to a possibly different installation, it may be necessary
      to change the path of the files included in "simx1.h".
      We are assuming X11 include files to be in /usr/include/X11,
      if this is not the case, please change the path accordingly.
      Afterwards run make-install again.

Note2: If the motif libraries and include files are not in a standard
       directory you need to edit the Makefile.XMotif makefile. See
       comments on this file.

To get documentation
	ftp file MaRS-2-doc.tar.Z
	uncompress MaRS-2-doc.tar.Z
	tar -xfp MaRS-2-doc.tar
This creates directory doc. 


How to run MaRS
===============
If you have used SimpleX or NoX makefiles, simply:
	bin/mars etc/example-net
If you have used XMotif interface
	xrdb -merge app-defaults/mars
	bin/mars etc/example-net
   or
	setenv XAPPLRESDIR <mars-directory>/app-defaults
	bin/mars etc/example-net


INTERFACES
==========
o   There are three interfaces, one on top of Xlib, one on top of X/Motif,
    and one just with the command line interface (no graphics). 
o   There are 3 makefiles one for each option: 
         Makefile.NoX Makefile.SimpleX Makefile.XMotif
o   In your system, you need to have
	X libraries to compile with SimpleX interface,
	X and Motif libraries to compile with XMotif interface.
o   If you do not have X windows at all, you should use NoX interface.
o   Please read make-install to see how to compile with the interface you
    would like.

MAJOR DIFFERENCES
=================
o  From version 1.1: various bug fixes. Thanks to all the people who
   reported bugs. 
o  The -record command line option should be followed by a file name. 
o  The performance monitor component now provides selected measures. The
   selected measures are only collected from application/transport
   connections which have the parameter "Selected" set.


PATCHES
=======
If there are patch files (e.g. patch-1) in this directory, 
you should apply them. How to apply a patch file is described in the
beginning of each such file.