[Cvsshell-devel] CVS: cvsshell README,NONE,1.1

[Stefan H. <ste...@us...>]

Update of /cvsroot/cvsshell/cvsshell
In directory usw-pr-cvs1:/tmp/cvs-serv27585

Added Files:
	README 
Log Message:
initial checkin


--- NEW FILE: README ---

About
-----

CvsShell is a console-based cvs client. It provides convenient access
to the cvs commands through a shell-like user interface.


Requirements
------------

CVsShell is written in Python (http://www.python.org) so it runs on
every platform python is available. You need Python 2.1 or higher
installed on you system.

You also need to install CVS (http://www.cvshome.org) before using
CvsShell.


Installation
------------

Unpack the downloaded files and step into the directory cvsshell-X.X
that is created. Invoke the installation script by typing 
`python install.py'.

On windows, you can also invoke the script by double-clicking the icon
of the file install py

The rest of the installation process should be rather self-explanatory.


Usage
-----

Help is always available by typing `help'. You can get help on a
specific command by typing `help <name-of-command>'. If you are not
familiar with CVS, you should first read the CVS-manual
(http://www.cvshome.org/docs/manual/). The configuration file of
CvsShell is ~/.cvsshellrc.

A session with CvsShell looks like this:

stefan@kunz:~/cvsshell$ cvsshell
CvsShell 0.1
Copyright 2002 Stefan Heimann (ma...@st...).
This software is released under the GPL.
{a} ~/cvsshell [:ext:ste...@cv...sshe...ceforge.net:/cvsroot/cvsshell]
$ 

This is the startup screen. The second line from bottom is called the
info-line. It contains information about

* Options that are activated or deactivated. This is done with the letters enclosed in
  curly brackets on the left. A lowercase letter signalize that the option currently
  is actived, a uppercase letter signalize that the option has been deactived. 
  Options:
  - a: automatic update of the cvsroot variable  
* The current working directory
* The current cvsroot.

I mostly start my sessions by running `update' to get new and updated files from the server:

$ update
Root Directory: /home/stefan/cvsshell
:
  0 ? README
someDir:
  1 M foo
  2 P bar
{a} ~/cvsshell [:ext:ste...@cv...sshe...ceforge.net:/cvsroot/cvsshell]
$ 

This produces a listing that contains information about the files in
your sandbox.  The first column maps every file to a ID to make it
easily accessible by just typing the ID and not a long filename. The
second column displays the status of the file. For more information on
this status characters have a look at the manual page of cvs (`man
cvs'). I have added the following status messages:

* OK - the file is in sync with the repository
* D  - the file has been successfully removed from the repository and the 
       sandbox.

As you can see in the exampla above, the file README is unknown to the
repository, the file someDir/foo has been locally modified and the
file someDir/bar has been patched.

To add the file README to the repository, do the following:



License
------