Program A Documentation

Last Update:	Tue, Feb. 28, 2006 (1135 AM)

[[ Fill out this file (call it README) and include it in your electronic and
	hardcopy submissions.
]]

1.	Program Status

	[[ State explicitly if your program is deficient or bug free or not.
		List the features that you did not fully implement and
			their status (e.g., designed, buggy implementation).
		If not bug free, list the problem(s).
		If you have clear conjectures as to the causes of the problems,
			list them.
	   Summarize how your program deviates from the assignment (e.g.,
	   additional features).
	]]

2.	Overview

  2.1	How to Build Executables

	[[ Give instructions on how to build each executable if 'make'
	   doesn't compile all source code.
	]]

  2.2	Usage

	Standard Executables:

	[[ Indicate how your command-line syntax for executables differs from the
		specification (omissions, additions, variations).  Give atleast
		one simple example in each case if it is not obvious.
	]]

3.	Program Description

  3.1	Data Structures

	[[ Briefly sumarize (1-3 sentences per structure) the major data
	   structures/classes and how they are used to implement the features
	   of xssh.  Examples:
		o Table of non-environment variables:  STL map(char *, char*)
		  maps variable names to values (see xssh.c/VarTbl).
		o Table of non-environment variables:  The class defined in
		  SymTbl.h maps variable names to values.
	   You should be able to just extract from your mid-course submission.
	]]

  3.2	Control Flow

	[[ Briefly sumarize (atmost a few sentences) the control structure of
	   your program.  Example:
		o There is a main loop in ...:
			Initialize;
			while (there are commands) {
			  ... a few details ...
			}
	]]

  3.3	Extra Functionality

	[[ Summarize any extra commands and functionality that you added.
	   If none, just say "None".  Be brief but not cryptic.
	]]

4.	Program Testing

  4.1	Overview

	[[ What was your testing procedure and what major tests did you run?
		Why should I be confident that your program runs correctly?
		Explain what features are exercised and which are not.
	]]

  4.2	Simple Successful Test Result

	[[ Describe the result of a simple test run.  Include the output
		and explain why the output is correct.
	]]
		
  4.3	More Complicated Successful Test Result

	[[ Repeat 4.2 for your most involved working example.  Describe
		the example, provide output, and explain how the output
		demonstrates the program is working correctly.
	]]

Appendix A: Source Code Listing

	Table of Contents:  [[ Provide a list of the attached files ]]
	Listings:  [[ Attach the printouts in the order specified in the
		Table of Contents. ]]

Appendix B:

	[[ Put other details in additional appendices as needed.  Omit if none. ]]