--- projects/cms/documentation/papers/cvs-1.txt	2000/10/25 18:17:22	1.1
+++ projects/cms/documentation/papers/cvs-1.txt	2000/11/02 00:34:41	1.3
@@ -1,8 +1,20 @@
 Using CVS (part 1)
 ==================
 
-tdb1, 18/10/2000
+Contents
+--------
+ - Overview
+ - CVS Repository Structure
+ - Setting up CVS on Raptor
+ - Setting up CVS on a Public PC (with WinCVS)
+ - Setting up CVS from off campus
+ - How to use CVS
+ 
+ - See "Using CVS (part 2)" for information on binaries, 
+   branching, tagging and keywords.
 
+   tdb1, 18/10/2000
+
 Overview
 --------
 CVS means "Concurrent Versioning System" and is used to keep
@@ -52,7 +64,9 @@ ROOT
   documentation
     minutes
     misc
+    papers
     plan
+    presentation
     specification
     user
   experimental
@@ -74,8 +88,8 @@ ROOT
 
 We may need to expand that a bit, but it's a start.
 
-Using CVS on Raptor
--------------------
+Setting up CVS on Raptor
+------------------------
 Setting up CVS on raptor to use our "repository" takes a bit
 of effort. This is because the cs-sysadmin guys have been
 setting up CVS to run from marble, but it's not ready yet.
@@ -102,9 +116,8 @@ not to add certain files, but I think we've got enough
 to be able to do that ourselves... but by all means leave
 that line out if you feel happier.
 
-
-Using CVS on a Public PC (with WinCVS)
---------------------------------------
+Setting up CVS on a Public PC (with WinCVS)
+-------------------------------------------
 WinCVS is (obviously) a Windows frontend to CVS. The command
 line thing is far easier to use if you're doing stuff
 directly on raptor (or any other unix box), but under
@@ -135,10 +148,11 @@ of the View menu.
 
 Finally, it might be possible to get it working with SSH
 straight onto raptor, but I'm not sure of the exact process,
-and even if it'll work.
+and even if it'll work. I may add this as an errata in part2 
+of this documentation.
 
-Using CVS from off campus
--------------------------
+Setting up CVS from off campus
+------------------------------
 Using CVS from off campus is much trickier. We have no
 "proper" CVS facilities on raptor for remote access (it can
 run a server specifically for this task). However, as the
@@ -146,6 +160,23 @@ command line CVS will make use of SSH we can connect t
 the firewall. This is fine if you have a Unix box at home,
 but I'm not sure (again) if this will work from Windows.
 
+From any Unix box (that has SSH and CVS installed) you just 
+need to setup the following environment variables. These are 
+best put in a file such as .cshrc (for the csh shell).
+
+CVS_RSH =
+     ssh
+CVSROOT =
+     :ext:user@raptor.ukc.ac.uk:/usr/local/proj/co600_10/cvs
+
+Every shell has it's own way of setting up environment 
+variables, for example csh using the setenv command. Consult 
+the man pages for more details.
+
+With this done you can use the command line facilities as 
+usual, and you will be prompted for your raptor password 
+each time a connection is made.
+
 How to use CVS
 --------------
 There are three main CVS operations that you'll use on a
@@ -154,6 +185,9 @@ smaller commands such as add, delete, and export. I'll
 describe them, then give an example. This all assumes you've
 setup the CVSROOT environment variable as described above.
 
+These commands are for the command line version of CVS, but 
+the ideas can be applied to any version, including WinCVS.
+
 A full list of commands can be found by typing;
 
 cvs --help-commands
@@ -276,3 +310,12 @@ gzip -v9 source.tar
 
 That's just about it for basic CVS. I'll probably produce
 another document on tagging at some point in the future.
+
+About
+-----
+This document was written by Tim Bishop [tdb1@ukc.ac.uk] for 
+use by the team working on a 3rd year Computer Science 
+project called "i-scream". More details can be found on the 
+project website;
+
+http://www.i-scream.org.uk
\ No newline at end of file