	RCS support for Vedit text editor
	---------------------------------

	V2.0  2003-05-20  Pauli Lindgren  (For Vedit 6.0+)

	http://koti.mbnet.fi/pkl/
	e-mail:  pauli.lindgren@mbnet.fi


This package provides support for RCS revision control system for Vedit.
This version requires Vedit 6.0 or later. Old version of the package is
available from my web page for older versions of Vedit.


Files included in the package:

  RCS.txt	- This file
  RCS_111.vtm	- File Close event macro, stores information for RCS_113.vtm.
  RCS_112.vtm	- File pre-open event macro (check-out).
  RCS_113.vtm	- File post-close event macro (check-in).
  RCS_cmd.vdm	- Perform RCS operations (Rlog, diff etc.)
  RCS_start.vdm - Loads the event macros (you may copy this into USTARTUP.VDM)
  Rdif_gto.vdm  - Jumps to file and line pointed by cursor in RCSdiff output window.
  RCSdiff.syn	- Syntax highlight file for Diff output.
  RCSdiff2.syn	- Alternate syntax highlight file for Diff output.
  Rlog.syn	- Syntax highlight file for Rlog output.

  In addition, C_user.mnu (included in the C-TOOLS package downloadable
  from my web site) is recommended, to make it easier to use the RCS functions.



INSTALLING RCS SUPPORT

1. Unzip the files in the User-mac directory in your Vedit home directory.
   You may move the .syn files into Vedit home directory for easier access,
   but that is not necessary.

2. Optionally, load an User menu that contains RCS support option.
   If you use projects (Vedit 6.1+), the menu will be saved with the project.
   Alternatively, you may edit your USTARTUP.VDM to load the menu.

3. If you want the automatic check-out/check-in to be active by default,
   copy the contents of RCS_start.vdm into your USTARTUP.VDM.
   (However, you can enable it any time using RCS_cmd.vdm.)



USING RCS SUPPORT

Enabling RCS support:

  To enable RCS support in your project, you must create sub-directory rcs
  in your work directory. If you have several workdirectories, an rcs sub-
  directory must exist on each workdirectory.

  Then select "RCS" in the C-User menu and select "Load" to load the event
  macro. After that, you can open files for editing.


Adding files to RCS database:

  To add file to RCS database, simply open the file and then close it.
  You are then prompted whether or not you want to add the file into
  RCS database.


Checking out a file:

  When you open a file for edit, it is automatically checked out from
  the RCS database.

  Note, however, that if the file is opened using a macro (e.g. Wild Search),
  the event macros may not be run and therefore check-out operation may not
  not performed. If this causes a problem, you may want to set #113 = 1
  (see "configuring the rcs package" below).


Checking in the files:

  When you close the file, check-in is performed automatically.
  You are prompted for description text, to describe the changes
  you have made to this file. (This description text will be displayed
  in the version list of Rlog command.)


RLOG - View list of versions of a file:

  On the RCS dialog box, click the button [Rlog].
  A window opens, diaplaying all the revisions logged in the RCS database.
  Close the window normally. Or, if you leave the window open, the next
  time you use Rlog, the same window is used.


DIFF - Compare two versions of a file:

  On the RCS dialog box, click the button [Diff].

  The dialog box has two input boxes for version numbers.
  Type the version numbers (e.g. 1.1 and 1.2) into these boxes to compare
  two versions. (The latest version number is displayed on top of the dialog
  box).
  
  If you enter just one version number (in either one of the input box),
  the workfile is compared against that version. (Note: RCS uses the
  workfile saved on the disk. If you have made changes in Vedit and you
  wish to include them, you must save the file).
  
  If you leave both of the input boxes empty, the workfile is compared
  against the last revision checked in to RCS database.

  The result of the compare is displayed in a window.
  Move cursor to the line of interest and press Ctrl-F11 to go to the
  corresponding location in the workfile (this calls the macro Rdif_gto.vdm).



	CONFIGURING THE RCS PACKAGE:

Using color syntax highlight

  To activate color syntax highlight for DIFF output:

    1. Execute RCS Diff (see above)
    2. When the Diff output is displayed, load the syntax file RCSdiff.syn
        ("Misc" -> "Load color syntax file")
    3. Select
        "Config" -> "File-open config" -> "Save filename specific config".
    4. Make sure "Enable file open config" is selected.

  To activate color syntax highlight for RLOG output:

    1. Execute RCS Rlog (see above)
    2. When the Rlogf output is displayed, load the syntax file Rlog.syn
    3. Select
        "Config" -> "File-open config" -> "Save filename specific config".
    4. Make sure "Enable file open config" is selected.


Check-in: the two operating modes

  The automatic check-in event macro RCS_113.VTM has two possible operating
  modes. Select the operating mode by editing the line where register #113
  is set in RCS_113.VTM.

  #113 = 0	- checked-in files are read-only.
  #113 = 1	- files are checked-in and then checked-out immediatelly, so
		  that the files are editable at any time.


Diff:

  You can configure whether or not the "ignore space changes" checkbox
  is initially ticked or not in the RCS Diff dialog box.
  Edit the line "#90 = 1" near the begining of file:
  
  #90 = 0	- checkbox is not ticked (spaces are significant)
  #90 = 1	- checkbox is ticked (space changes ignored)



	HISTORY:

V1.0	2000-11-07  - First release
V1.1	2001-04-11  - Window layout changed
V2.0	2003-05-20  - For Vedit 6.0+
		      New dialog box, configuration options, English version

