1. Installation

This section describes the installation of pcl-cvs, the GNU Emacs CVS front-end. You should install not only the elisp files themselves, but also the on-line documentation so that your users will know how to use it. You can create typeset documentation from the file `pcl-cvs.texi' as well as an on-line info file. The following steps are also described in the file `INSTALL' in the source directory.

If you are running XEmacs 21.0 or later, pcl-cvs is available in pre-compiled package form. Please skip ahead to 1.4 Installing pcl-cvs for XEmacs..

1.1 Installation of the pcl-cvs program

1. Edit the file `Makefile' to reflect the situation at your site. The only things you have to change is the definition of lispdir and infodir. The elisp files will be copied to lispdir, and the info file to infodir.

2. This release of pcl-cvs requires parts of the Elib library, version 1.0 or later. Elib is available via anonymous ftp from prep.ai.mit.edu in `pub/gnu/elib-1.0.tar.gz', and from a lot of other sites that mirror prep. Get Elib, and install it, before proceeding.

3. Type `make install' in the source directory. This will byte-compile all `.el' files and copy both the `.el' and the `.elc' into the directory you specified in step 1. It will also copy the info files (and add a corresponding entry to the info-dir file if install-info can be found).

   If you don't want to install the `.el' files but only the `.elc' files (the byte-compiled files), you can type ``make install_elc'' instead of ``make install''.

   If you only want to create the compiled elisp files, but don't want to install them, you can type `make elcfiles' instead. This is what happens if you only type `make' without parameters.

4. Edit the file `site-start.el' in your emacs lisp directory (usually `/usr/local/share/emacs/site-lisp' or something similar) and enter the contents of the file `pcl-cvs-startup.el' into it. It contains a couple of auto-loads that facilitates the use of pcl-cvs. Alternatively, you can just use ``make install_startup''.

1.2 Installation of the on-line manual.

1. Create the info file `pcl-cvs' from `pcl-cvs.texi' by typing `make info'. If you don't have the program `makeinfo' you can get it by anonymous ftp from e.g. `ftp.gnu.ai.mit.edu' as `pub/gnu/texinfo-2.14.tar.Z' (there might be a newer version there when you read this), or you could use the pre-formatted info file `pcl-cvs.info' that is included in the distribution (type `cp pcl-cvs.info pcl-cvs').

2. Move the info file `pcl-cvs' to your standard info directory. This might be called something like `/usr/local/info'.

3. Edit the file `dir' in the info directory and enter one line to contain a pointer to the info file `pcl-cvs'. The line can, for instance, look like this:

   * Pcl-cvs: (pcl-cvs). An Emacs front-end to CVS.

1.3 How to make typeset documentation from pcl-cvs.texi

If you have TeX installed at your site, you can make a typeset manual from `pcl-cvs.texi'.

1. Run TeX by typing ``make pcl-cvs.dvi''. You will not get the indices unless you have the texindex program.

2. Convert the resulting device independent file `pcl-cvs.dvi' to a form which your printer can output and print it. If you have a postscript printer there is a program, dvi2ps, which does. There is also a program which comes together with TeX, dvips, which you can use.

1.4 Installing pcl-cvs for XEmacs.

If you are running XEmacs 21.0 or later, pcl-cvs is available in pre-compiled package form. Please refer to the XEmacs manual for instructions regarding package selection and installation. Currently, the pcl-cvs package also requires you to have installed the xemacs-base, elib, and dired packages.

Once you have installed these packages (manually or using the interactive installer), you should check the values of a couple pcl-cvs variables and override the default values in the `site-start.el' file if necessary. These variables are:

`cvs-program'

This is the name or full path of the `cvs' executable to be used by pcl-cvs. If `cvs' will be automatically found on the user's PATH, there is no need to change this. Otherwise, you should set this variable to the full path to your `cvs' program via

(setq cvs-program "/FULL/PATH/TO/cvs")

in the `site-start.el' file.

`cvs-diff-program'

This is the name or full path of the `diff' executable to be used by pcl-cvs. If `diff' will be automatically found on the user's PATH, there is no need to change this. Otherwise, you should set this variable to the full path to your `diff' program via

(setq cvs-diff-program "/FULL/PATH/TO/diff")

Note that there are some nasty bugs in the context diff variants of some vendor versions, such as the one in SunOS-4.

`cvs-bakprefix'

This should be set to the prefix that CVS prepends to files when `rcsmerge'ing. It is normally set to ".#".

Finally, if you have TeX, texinfo, and dvips installed at your site, you can make a typeset manual from `pcl-cvs.texi':

1. Run TeX by typing ``texi2dvi pcl-cvs.texi''. The file `pcl-cvs.texi' can be found in your XEmacs package hierarchy in the directory `man/pcl-cvs'. You will not get the indices unless you have the texindex program.

2. Convert the resulting device independent file `pcl-cvs.dvi' to a form which your printer can print. If you have a postscript printer you can use the program dvips.

This document was generated by XEmacs shared group account on December, 19 2009 using texi2html 1.65.