Spackle Installation

Last updated: Friday, 19 April 2024 11:05 00000

Installation Instructions

Below are the instructions that are included in the package itself.

-1. Status
----------

This project is still in the early alpha-test/development stage, so
although it is installable it may not entirely work properly.  This
note will go away (and an announcement will be made on the appropriate
mailing list) when things are actually working.  Right now it's mostly
a collection of files, not an actual package.  The ./configure and
Makefile are coming along, though, and hopefully we'll have something
soon.

0. Background
-------------

The Spackle files get installed in the target repository's CVSROOT
module.  However, installation is performed by adding them to a
checked-out copy of the module in a local working directory and then
committing the changes.  None of them have any effect on the local
system, only on the repository system, so assumptions made by and
prerequisites needed by the Spackle files apply only to the latter.

WARNING: BE SURE YOU HAVE A BACKUP OF YOUR CVSROOT MODULE.
         Once Spackle is installed, mistakes in the access
         control files can lock you out of the repository,
         preventing you from making repairs through CVS as
         you normally would.  In such a case, you will need
         to access the repository directly.

1. Prerequisites
----------------

o You need to have commit access to the repository's
  CVSROOT module
o You need to have the CVSROOT module checked out into
  a local working directory
o You need a version of the Perl interpreter installed
  on the repository system and know its path; versions
  later than 5.003 are preferred
o You need to have a sendmail command on the repository
  system and know its path

3. Building / Installation
--------------------------

To install the Spackle package with the default options:

    ./buildconf  # if working from a CVS checkout
    ./configure --with-cvsroot=
    make install

This will install the Spackle files in the CVSROOT working
directory specified; a commit will be required to complete
the installation.

Spackle depends on cvs, Perl, and sendmail, all on the repository
system.  When you run ./configure, it will by default use the
locations found on the configuring system, which may be different.
If Perl is installed in a different location on the repository
system than on the local one, you need to use the --with-perl
option to specify the location on the former:

    ./configure --with-cvsroot= --with-perl=/bin/perl

Likewise, use the --with-sendmail option to override the
location of the sendmail command on the repository system:

    ./configure --with-cvsroot= \
        --with-sendmail=/usr/ucb/sendmail

Similarly, if cvs isn't in the default PATH on the repository system,
you need to tell Spackle where it is with:

    ./configure --with-cvsroot= \
        --with-cvs=/usr/local/bin/cvs

Complete list of configuration options
--------------------------------------
All of the Spackle-specific configuration options are listed
here.  Each is marked as 'required' or 'optional'; that should
be self-explanatory.  Each is also labelled either 'negatable'
or 'non-negatable', which simply means that either the
--without-/--disable- syntax is permitted.. or
isn't.  Finally, if the option is implied or has a default
value that will be used if you don't override it, it's marked
as 'default.'  Clear enough? :-)

The main options are --enable-acls, --enable-logging, and
--enable-pserver.  Depending upon your combination of choices
some files may or may not be installed.  If you specify
--without-acls, for instance, none of the advanced access
control stuff will be installed.

--with-cvs=FILE
  Optional, negatable, default; identifies the location of the
  cvs command ON THE REPOSITORY SYSTEM.  If not specified, or
  negated, the command 'cvs' will be used and it must be found in
  the repository system's default PATH.

--with-cvsroot=DIR
  Required, non-negatable; identifies the working directory
  into which the repository's CVSROOT has been checked out.

--with-maintainer=USERNAME
  Optional, negatable; specifies the username which is initially
  granted access to the CVSROOT module.  Ignored if access
  control is not being installed (e.g., --without-acls).  However,
  is access control *is* being installed, omitting this may
  leave you locked out of your own repository!

--with-maintainer-email=EDDRESS
  Optional, negatable; specifies the email address which will be
  preloaded into the mailmap file and hard-coded into the logging
  script in an attempt to ensure that *someone* gets an email
  notification of repository changed.  Ignored if the logging
  function is not being installed (e.g., --without-logging).
  If omitted, the default is the value of the --with-maintainer
  option.  However, that may not be a valid email address on
  the server system, so beware.

--with-perl=FILE
  Optional, non-negatable, default; identifies the location of
  the Perl interpreter binary ON THE REPOSITORY SYSTEM.  If
  not specified, the default will be taken from the system
  where ./configure is being run -- which may be different
  from the repository system, so be careful!

--with-sendmail=FILE
  Optional, non-negatable, default; identifies the location
  of the sendmail binary ON THE REPOSITORY SYSTEM.  If not
  specified, the default will be taken from the system
  where ./configure is being run -- which may be different
  from the repository system, so be careful!

--enable-acls
  Optional, negatable, default; instructs configure to include
  access-control features.

--enable-commitlogs
  Optional, negatable; sub-feature of logging that
  causes all commit messages to be appended to a per-module file
  in a CVSROOT/ file.

--enable-logging
  Optional, negatable, default; instructs configure to include
  the logging and email features.

--enable-manpage
  Optional, negatable; causes 'make' to install the Spackle
  manpage on the local system (not the repository system!).
  The location of the man directory tree can be controlled
  with the standard --mandir=DIRECTORY option.

--enable-overwrite
  Optional, negatable; will cause Spackle-configured files to
  unconditionally replace versions already in the CVSROOT
  module.

--enable-passwd
  Optional, negatable; indicates that a blank CVSROOT/passwd
  file should be supplied and it should be included in
  checkouts of the CVSROOT module.
  ** WARNING: Allowing the passwd file to be checked out along
     with the other files in the CVSROOT may be considered a
     security compromise.  It is recommended that you only do
     this if you do not have direct access to the plaintext
     CVSROOT/passwd file on the repository system, and even
     then only with care.

--enable-readers
  Optional, negatable; indicates that a blank CVSROOT/readers
  file should be supplied and added to the checkoutlist.
  ** WARNING: See the warning under --enable-passwd.

--enable-writers
  Optional, negatable; indicates that a blank CVSROOT/writers
  file should be supplied and added to the checkoutlist.
  ** WARNING: See the warning under --enable-passwd.