Appendix B

Version Control Help File

####################################################################
## This is a help file for this software package.  The file 	  ##
## contains the command name and a brief description of what the  ##
## command does.  Along with the description the format of the    ##
## command is given with examples of how the command works.	  ##
####################################################################

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> check <==
#	This command reports the files that are currently being
#	edited.  If no arguments are given or just the '-u'
#	option then only the files being currently edited by the
#	requesting user will be displayed.  If the '-u' option
#	is used followed by a username then the command will
#	display own the files being edited by that user.
#
# 
#	The format for the command check is:
#		Format:		check [-u [username]
#		Example: 	check 
#		Example: 	check -u mehl

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> create <==
#	This command performs the proper configurization to the
#	database to allow the file being requested to be added
#	as a valid file under the control of this version control
#	software package.  The command will add the name to the
#	validfile file then it creates a temporary file that
#	will be version number 0.  It will also add the files
#	name to the counter file, which controls what version
#	the file is at.  The last task this file does is it
#	invokes the edit command using the specified file, which
#	means it automatically signs the file out to the user
#	that is requesting its creation. 
#
#	The format for the command create is:
# 	Format:		create  
# 	Example:	create toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> edit <==
#	This command signs out a copy of the specified file to
#	the user that is invoking the command.  This file is
#	then locked so now other user can get a writable-working
#	copy of the file.  In order for this file to be a
#	writable-working copy for anyone else the file has to
#	be signed back in by using the put command.  The copy 
#	that the user signs out will become the next version
#	the requested file.
#
#
#	The format for the command edit is:
# 	Format:		edit  
# 	Example:	edit toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> enter <==
#	This command is very similar to the create command,
#	however it does not automatically sign the file out.
#	It only creates the file, so it is ready for use. 
#	This command performs the proper configurization to the
#	database to allow the file being requested to be added
#	as a valid file under the control of this version control
#	software package.  The command will add the name to the
#	validfile file then it creates a temporary file that
#	will be version number 0.  It will also add the files
#	name to the counter file, which controls what version
#	the file is at.
#
#	The format for the command enter is:
#	Format:		enter 
#	Example:	enter toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> get <==
#	This command allows a user to receive a read-only copy
#	of the file specified.  If there is a '-r' option then
#	a old version of the specified file, which the user 
#	that is invoking the command, is retrieved.  This file is
#	a read-only copy of the file and not locked so other users
#	can get a copy of the file too. 
#
#
#	The format for the command get is:
# 	Format:		get  
# 	Example:	get toolkit.java
# 	Example:	get -r 3 toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> help <==
#	This command will display a help screen for the specified
#	file.  The command will also show the formant of the
#	command to be entered as well as an example(s) of the
#	command specified.
#
#
#	The format for the command help is:
#	Format:		help 
#	Example:	help create

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> info <==
#	This command reports the files that are currently being
#	edited.  For each file listed the current version number,
#	the user that signed the file out, and the time it was
#	signed out are listed with the corresponding files.  If no 
#	arguments are given or just the '-u' option then only 
#	the files being currently edited by the requesting user 
#	will be displayed.  If the '-u' option is used followed 
#	by a username then the command will display own the 
#	files being edited by that user.
#
#
#	The format for the command info is:
#	Format:		info 
#	Example:	info -u
#	Example:	info -u mehl

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> print <==
#	This command displays the entire history for the 
#	specified file.
#
#
#	The format for the command print is:
#	Format:		print 
#	Example:	print toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> put <==
#	This command signs in a copy of the specified file to
#	the user that is invoking the command.  This file
#	can only be sign in if the file has been signed out by
#	by the user trying to sign the file back in.  Only when
#	that condition is meet will file be unlocked so now 
#	other user can get a writable-working copy of the file.
#	The copy that the user signs in will become the next 
#	version for the specified file.
#
#
#	The format for the command put is:
# 	Format:		put 
# 	Example:	put toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> tell <==
#	This command reports the files that are currently being
#	edited.  If no arguments are given or just the '-u'
#	option then only the files being currently edited by the
#	requesting user will be displayed.  If the '-u' option
#	is used followed by a username then the command will
#	display own the files being edited by that user.
#
#
#	The format for the command tell is:
#		Format:		tell [-u [username]
#		Example: 	tell
#		Example: 	tell -u mehl

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> unget <==
#	This command allows a user to return a copy of the file
#	that was signed out by using the edit command without
#	summiting a new version to the database.  This file 
#	can only be sign in if the file has been signed out by
#	by the user trying to sign the file back in.  Which 
#	means it undoes a edit command.  The file is unlocked
#	so now other user can get a writable-working copy of 
#	the file.  The copy that the user signs in will NOT
#	become the next version for the file specified.
#
#
#	The format for the command unget is:
#	Format:		unget 
#	Example:	unget toolkit.java

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File

==> what <==
#	This command will report the current version number of
#	all files that exist under the control of this software
#	package.
#
#
#	The format for the command what is:
#	Format:		what 
#	Example:	what 

Top of File | Check | Create | Edit | Enter | Get |  Help | Info |
Print | Put | Tell | Unget | What | Botton of File


Villanova Univ. Seal Top of Paper | Previous Page | Next Page | Bottom of Paper

Written By Graham L. Mehl
Last Modified on April 23, 1996
© Villanova University
</