ossp-pkg/shiela/shiela-install.pod
1.1.1.1
##
## Shiela - CVS Access Control and Logging Facility
## Copyright (c) 2000 Ralf S. Engelschall <rse@engelschall.com>
##
## This file is part of Shiela, an access control and logging
## facility for Concurrent Versions System (CVS) repositories
## which can be found at http://www.ossp.org/pkg/shiela/.
##
## This program is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License
## as published by the Free Software Foundation; either version
## 2.0 of the License, or (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this file; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
## USA, or contact Ralf S. Engelschall <rse@engelschall.com>.
##
## shiela-install.pod: Shiela install manual page (syntax: POD)
##
=pod
=head1 NAME
B<shiela-install> - Shiela installation utility
=head1 VERSION
B<OSSP Shiela> 0.9.0 (18-Jun-2000)
=head1 DESCRIPTION
B<Shiela> is an access control and logging facility for use with
the I<Concurrent Versions System> (CVS). Read shiela(1) for more
details about B<Shiela> itself. This B<shiela-install> program is a
small utility intended to help in adding B<Shiela> to an existing CVS
repository for testing or production purposes.
=head1 INSTALLATION: MANUALLY
B<Shiela> can be installed and activated in a CVS repository either
manually or via the B<shiela-install> program. The manual steps would
be:
=over 4
=item B<1.>
checkout a working copy of the C<CVSROOT> module from your repository.
=item B<2.>
create the files C<$CVSROOT/CVSROOT/shiela>,
C<$CVSROOT/CVSROOT/shiela.cfg> and C<$CVSROOT/CVSROOT/shiela.msg>
in this directory and list these three files in
C<$CVSROOT/CVSROOT/checkoutlist> (so CVS automatically checks them
out).
=item B<3.>
add to C<$CVSROOT/CVSROOT/rcsinfo> (the hook for providing log
messages): ``C<ALL $CVSROOT/CVSROOT/shiela.msg>''.
=item B<4.>
add to C<$CVSROOT/CVSROOT/taginfo> (the hook for checking tag
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=taginfo>''.
=item B<5.>
add to C<$CVSROOT/CVSROOT/importinfo> (the hook for checking import
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=importinfo>''. This
assumes that you are using the OSSP CVS version. If you use a stock CVS
version, you have to skip this step and live with the fact that `C<cvs
import>' commands cannot be access controlled by B<Shiela> (because then
this hook does not exists at all).
=item B<6.>
add to C<$CVSROOT/CVSROOT/admininfo> (the hook for checking admin
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=admininfo>''. This
requires that you are using the OSSP CVS version. If you use a stock CVS
version, you have to skip this step and life with the fact that `C<cvs
admin>' commands cannot be access controlled by B<Shiela> (because then
this hook does not exists at all).
=item B<7.>
add to C<$CVSROOT/CVSROOT/commitinfo> (the hool for checking commit
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=commitinfo>''.
=item B<8.>
add to C<$CVSROOT/CVSROOT/verifymsg> (the hook for post-processing log
messages): ``C<DEFAULT $CVSROOT/CVSROOT/shiela --hook=verifymsg>''.
=item B<9.>
add to C<$CVSROOT/CVSROOT/loginfo> (the hook for performing logging):
``C<ALL $CVSROOT/CVSROOT/shiela --hook=loginfo %{sVvto}>''. This
requires that you use the OSSP CVS version. If you use a stock CVS
version, use ``C<ALL $CVSROOT/CVSROOT/shiela --hook=loginfo %{sVv}>''
instead and live with the fact that B<Shiela>'s run-time efficiency is
slightly decreased and branch recognition might be less correct (because
B<Shiela> has to determine details the hard way which CVS already would
know easily).
=item B<10.>
edit C<$CVSROOT/CVSROOT/shiela.cfg> to fit your repository and
project situation. For details, see the description below under
B<CONFIGURATION>.
=item B<11.>
finally commit all modifications at once.
=back
=head1 INSTALLATION: AUTOMATICALLY
For convinience reasons one can alternatively use the interactive
B<shiela-install> utility, which perform the above steps automatically
and especially creates initial C<shiela.cfg> and C<shiela.msg> files.
Just run C<shiela-install> and answer the questions.
For convinience reasons (while testing) one can also override the
default value of a question by using C<variable=value> on the
B<shiela-install> command line. For instance, ``C<shiela-install
repos_path=/tmp/cvs>'' sets the default path for the question about the
CVS repository to C</tmp/cvs>. Additionally one can specify C<batch=yes>
which runs B<shiela-install> non-interactively.
=head1 SEE ALSO
shiela(1).
=head1 AUTHOR
Ralf S. Engelschall
rse@engelschall.com
www.engelschall.com
=cut
