head	1.27;
access;
symbols
	SHIELA_1_1_7:1.27
	SHIELA_1_1_6:1.26
	SHIELA_1_1_5:1.26
	SHIELA_1_1_4:1.24
	SHIELA_1_1_3:1.23
	SHIELA_1_1_2:1.23
	SHIELA_1_1_1:1.23
	SHIELA_1_1_0:1.23
	SHIELA_1_0_4:1.20
	SHIELA_1_0_3:1.18
	SHIELA_1_0_2:1.15
	SHIELA_1_0_1:1.13
	SHIELA_1_0_0:1.12
	SHIELA_0_9_2:1.5
	SHIELA_0_9_1:1.2
	SHIELA_0_9_0:1.1.1.1
	vendor:1.1.1;
locks; strict;
comment	@# @;


1.27
date	2006.07.20.08.17.11;	author rse;	state Exp;
branches;
next	1.26;
commitid	aQSB5U4vj5FkFzFr;

1.26
date	2005.01.12.20.46.13;	author rse;	state Exp;
branches;
next	1.25;

1.25
date	2005.01.12.20.42.46;	author rse;	state Exp;
branches;
next	1.24;

1.24
date	2004.07.02.19.19.33;	author rse;	state Exp;
branches;
next	1.23;

1.23
date	2004.05.06.19.45.39;	author rse;	state Exp;
branches;
next	1.22;

1.22
date	2004.05.05.13.18.47;	author rse;	state Exp;
branches;
next	1.21;

1.21
date	2004.05.05.13.11.43;	author rse;	state Exp;
branches;
next	1.20;

1.20
date	2002.12.23.14.46.15;	author rse;	state Exp;
branches;
next	1.19;

1.19
date	2002.12.23.14.45.16;	author rse;	state Exp;
branches;
next	1.18;

1.18
date	2002.12.23.13.10.56;	author rse;	state Exp;
branches;
next	1.17;

1.17
date	2002.12.23.12.08.35;	author rse;	state Exp;
branches;
next	1.16;

1.16
date	2002.12.23.12.00.07;	author rse;	state Exp;
branches;
next	1.15;

1.15
date	2002.12.23.09.13.41;	author rse;	state Exp;
branches;
next	1.14;

1.14
date	2002.12.23.09.05.47;	author rse;	state Exp;
branches;
next	1.13;

1.13
date	2002.12.23.08.50.34;	author rse;	state Exp;
branches;
next	1.12;

1.12
date	2002.12.22.17.37.28;	author rse;	state Exp;
branches;
next	1.11;

1.11
date	2002.12.22.15.01.17;	author rse;	state Exp;
branches;
next	1.10;

1.10
date	2002.12.22.11.10.42;	author rse;	state Exp;
branches;
next	1.9;

1.9
date	2002.12.21.11.02.01;	author rse;	state Exp;
branches;
next	1.8;

1.8
date	2002.12.21.11.00.17;	author rse;	state Exp;
branches;
next	1.7;

1.7
date	2002.12.21.09.42.57;	author rse;	state Exp;
branches;
next	1.6;

1.6
date	2002.12.21.09.20.27;	author rse;	state Exp;
branches;
next	1.5;

1.5
date	2002.08.19.19.10.38;	author rse;	state Exp;
branches;
next	1.4;

1.4
date	2001.12.31.15.00.31;	author rse;	state Exp;
branches;
next	1.3;

1.3
date	2001.05.04.13.25.18;	author rse;	state Exp;
branches;
next	1.2;

1.2
date	2001.02.10.16.40.26;	author rse;	state Exp;
branches;
next	1.1;

1.1
date	2000.06.18.14.30.49;	author rse;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2000.06.18.14.30.49;	author rse;	state Exp;
branches;
next	;


desc
@@


1.27
log
@Adjust copyright messages for new year 2006 and upgrade build environment.
@
text
@##
##  OSSP shiela - CVS Access Control and Logging Facility
##  Copyright (c) 2000-2006 Ralf S. Engelschall <rse@@engelschall.com>
##  Copyright (c) 2000-2006 The OSSP Project <http://www.ossp.org/>
##
##  This file is part of OSSP shiela, an access control and logging
##  facility for Concurrent Versions System (CVS) repositories
##  which can be found at http://www.ossp.org/pkg/tool/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: install manual page (syntax: POD)
##

=pod

=head1 NAME

B<shiela-install> - OSSP shiela installation utility

=head1 VERSION

B<OSSP shiela>

=head1 DESCRIPTION

B<OSSP 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<OSSP shiela> itself. This B<shiela-install> program is a
small utility intended to help in adding B<OSSP shiela> to an existing CVS
repository for testing or production purposes.

=head1 INSTALLATION: MANUALLY

B<OSSP 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.>

make sure that you are using CVS version 1.12.6 or higher. Older
versions are no longer supported due to the new I<xxxx>C<info> hooking
(C<UseNewInfoFmtStrings=yes>) which is a mandatory configuration for
B<OSSP shiela>.

=item B<2.>

checkout a working copy of the C<CVSROOT> module from your repository.

=item B<3.>

make sure the file C<$CVSROOT/CVSROOT/config>
contains the directive ``C<UseNewInfoFmtStrings=yes>''.

=item B<4.>

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<5.>

add to C<$CVSROOT/CVSROOT/rcsinfo> (the hook for providing log
messages): ``C<ALL $CVSROOT/CVSROOT/shiela.msg>''.

=item B<6.>

add to C<$CVSROOT/CVSROOT/taginfo> (the hook for checking tag
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=taginfo %t %o %p %{sv}>''.

=item B<7.>

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 a CVS version with RSE patches applied (see
below). 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<OSSP shiela> (because then this hook does not exists at
all).

=item B<8.>

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 a CVS version with RSE patches applied (see
below). 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<OSSP shiela> (because then this hook does not exists at
all).

=item B<9.>

add to C<$CVSROOT/CVSROOT/commitinfo> (the hook for checking commit
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=commitinfo %r/%p %s>''.

=item B<10.>

add to C<$CVSROOT/CVSROOT/verifymsg> (the hook for post-processing log
messages): ``C<DEFAULT $CVSROOT/CVSROOT/shiela --hook=verifymsg %l>''.

=item B<11.>

add to C<$CVSROOT/CVSROOT/loginfo> (the hook for performing logging):
``C<ALL $CVSROOT/CVSROOT/shiela --hook=loginfo %p %{sVvto}>''.
This requires that you use a CVS version with RSE patches
applied (see below). If you use a stock CVS version, use ``C<ALL
$CVSROOT/CVSROOT/shiela --hook=loginfo %p %{sVv}>'' instead and live with
the fact that B<OSSP shiela>'s run-time efficiency is slightly decreased
and branch recognition might be less correct (because B<OSSP shiela> has
to determine details the hard way which CVS already would know easily).

=item B<12.>

edit C<$CVSROOT/CVSROOT/shiela.cfg> to fit your repository and
project situation. For details, see the description under
B<CONFIGURATION> in shiela(1).

=item B<13.>

finally commit all modifications at once.

=back

=head1 INSTALLATION: AUTOMATICALLY

For convenience 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 convenience 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 CVS INTERNAL PROCESSING

The administrative files in C<$CVSROOT/CVSROOT/> are consulted by CVS
internally in dependency of the used F<cvs> command. For your reference,
here are the processing steps CVS performs and into which B<OSSP shiela>
hooks into:

=over 1

=item On "C<cvs checkout>":

 1. CVSROOT/config       (general configuration)
 2. CVSROOT/modules      (determine module names)
 3. CVSROOT/cvswrappers  (file handling)
 4. CVSROOT/history      (logging of the commit step)

=item On "C<cvs commit>":

 1. CVSROOT/config       (general configuration)
 2. CVSROOT/modules      (determine module names)
 3. CVSROOT/commitinfo   (access control)
 4. CVSROOT/rcsinfo      (log message template)
 5. CVSROOT/editinfo     (run the log message editor)
 6. CVSROOT/verifymsg    (evaluate/adjust log message after editing)
 7. CVSROOT/cvswrappers  (file handling)
 8. CVSROOT/loginfo      (extra logging after commit)
 9. CVSROOT/history      (logging of the commit step)

=item On "C<cvs import>":

 1. CVSROOT/config       (general configuration)
 2. CVSROOT/modules      (determine module names)
 3. CVSROOT/importinfo   (access control)
 4. CVSROOT/rcsinfo      (log message template)
 5. CVSROOT/editinfo     (run the log message editor)
 6. CVSROOT/verifymsg    (evaluate/adjust log message after editing)
 7. CVSROOT/cvswrappers  (file handling)
 8. CVSROOT/loginfo      (extra logging after commit)
 9. CVSROOT/history      (logging of the commit step)

=item On "C<cvs tag>" (CVS with RSE patches only):

 1. CVSROOT/config       (general configuration)
 2. CVSROOT/modules      (determine module names)
 3. CVSROOT/taginfo      (access control and tag evaluation)
 4. CVSROOT/history      (logging of the tag step)

=item On "C<cvs admin>" (CVS with RSE patches only):

 1. CVSROOT/config       (general configuration)
 2. CVSROOT/modules      (determine module names)
 3. CVSROOT/admininfo    (access control)
 4. CVSROOT/history      (logging of the admin step)

=back

=head1 CVS WITH RSE PATCHES APPLIED

The stock CVS vendor version you can find on http://www.cvshome.org/.
Although B<OSSP shiela> works fine with just this version, it
unfortunately lacks some important features which make B<OSSP shiela>'s
processing less strong. For instance, the stock CVS does not allow
B<OSSP shiela> to apply access control to the "C<cvs tag>" and "C<cvs
admin>" commands. Hence Ralf S. Engelschall extended CVS with those
features (and more) and maintains a patch set in the "cvs" package of
his B<OpenPKG> project (http://www.openpkg.org/). You can find the latest
patch set under http://cvs.openpkg.org/openpkg-src/cvs/cvs.patches.rse

=head1 SEE ALSO

cvs(1), shiela(1).

=head1 AUTHOR

 Ralf S. Engelschall
 rse@@engelschall.com
 www.engelschall.com

=cut

@


1.26
log
@Adjust copyright messages for new year 2005.
@
text
@d3 2
a4 2
##  Copyright (c) 2000-2005 Ralf S. Engelschall <rse@@engelschall.com>
##  Copyright (c) 2000-2005 The OSSP Project <http://www.ossp.org/>
@


1.25
log
@1. Fix internal error handling by replacing "|| die" with "or die"
constructs because the different binding priority of "||" and "or"
leaded to wrong results.

2. Fix shiela-install.pod's description of --loginfo hook for the
non-RSE-patches situation: the %p construct has to be used there, too.
@
text
@d3 2
a4 2
##  Copyright (c) 2000-2004 Ralf S. Engelschall <rse@@engelschall.com>
##  Copyright (c) 2000-2004 The OSSP Project <http://www.ossp.org/>
@


1.24
log
@Document in install-shiela.pod and install-shiela.sh that
CVS version 1.12.6 or higher is required.
@
text
@d124 1
a124 1
$CVSROOT/CVSROOT/shiela --hook=loginfo %{sVv}>'' instead and live with
@


1.23
log
@flush the whole bunch of my fixes and cleanups
@
text
@d56 7
d65 6
a70 1
=item B<2.>
d78 1
a78 1
=item B<3.>
d83 1
a83 1
=item B<4.>
d88 1
a88 1
=item B<5.>
d98 1
a98 1
=item B<6.>
d108 1
a108 1
=item B<7.>
d113 1
a113 1
=item B<8.>
d118 1
a118 1
=item B<9.>
d129 1
a129 1
=item B<10.>
d135 1
a135 1
=item B<11.>
@


1.22
log
@remove trailing whitespaces
@
text
@d74 1
a74 1
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=taginfo>''.
d99 1
a99 1
operations): ``C<ALL $CVSROOT/CVSROOT/shiela --hook=commitinfo>''.
d104 1
a104 1
messages): ``C<DEFAULT $CVSROOT/CVSROOT/shiela --hook=verifymsg>''.
d109 1
a109 1
``C<ALL $CVSROOT/CVSROOT/shiela --hook=loginfo %{sVvto}>''.
d208 1
a208 1
his B<OpenPKG> project (http://www.ossp.org/). You can find the latest
@


1.21
log
@Bump year in copyright messages for 2003 and 2004
@
text
@d36 1
a36 1
B<OSSP shiela> 
@


1.20
log
@bump to version 1.0.4 for release
@
text
@d3 2
a4 2
##  Copyright (c) 2000-2002 Ralf S. Engelschall <rse@@engelschall.com>
##  Copyright (c) 2000-2002 The OSSP Project <http://www.ossp.org/>
@


1.19
log
@bump to version 1.0.4 for release
@
text
@d36 1
a36 1
B<OSSP shiela> 1.0.4 (23-Dec-2002)
@


1.18
log
@bump to version 1.0.3 for release
@
text
@d36 1
a36 1
B<OSSP shiela> 1.0.3 (23-Dec-2002)
@


1.17
log
@mention the details about the CVS version with RSE patches applied
@
text
@d36 1
a36 1
B<OSSP shiela> 1.0.2 (23-Dec-2002)
@


1.16
log
@more documentation
@
text
@d80 5
a84 4
assumes that you are using a CVS version with RSE patches applied. 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<OSSP shiela> (because then this hook does not exists at all).
d90 5
a94 4
requires that you are using a CVS version with RSE patches applied. 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<OSSP shiela> (because then this hook does not exists at all).
d109 7
a115 7
``C<ALL $CVSROOT/CVSROOT/shiela --hook=loginfo %{sVvto}>''. This
requires that you use a CVS version with RSE patches applied. If you use
a stock CVS version, use ``C<ALL $CVSROOT/CVSROOT/shiela --hook=loginfo
%{sVv}>'' instead and live with the fact that B<OSSP shiela>'s run-time
efficiency is slightly decreased and branch recognition might be less
correct (because B<OSSP shiela> has to determine details the hard way
which CVS already would know easily).
d183 1
a183 1
=item On "C<cvs tag>":
d190 1
a190 1
=item On "C<cvs admin>":
d199 12
d213 1
a213 1
shiela(1).
@


1.15
log
@bump to version 1.0.2 for release
@
text
@d80 4
a83 4
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<OSSP shiela> (because then
this hook does not exists at all).
d89 4
a92 4
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<OSSP shiela> (because then
this hook does not exists at all).
d108 6
a113 6
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<OSSP shiela>'s run-time efficiency is
slightly decreased and branch recognition might be less correct (because
B<OSSP shiela> has to determine details the hard way which CVS already would
know easily).
d140 56
@


1.14
log
@Fixed typos in manual pages.
@
text
@d36 1
a36 1
B<OSSP shiela> 1.0.1 (22-Dec-2002)
@


1.13
log
@flush pending changes
@
text
@d96 1
a96 1
add to C<$CVSROOT/CVSROOT/commitinfo> (the hool for checking commit
d129 1
a129 1
For convinience reasons one can alternatively use the interactive
d134 1
a134 1
For convinience reasons (while testing) one can also override the
@


1.12
log
@bump for release
@
text
@d36 1
a36 1
B<OSSP shiela> 1.0.0 (22-Dec-2002)
@


1.11
log
@cleanup version stuff
@
text
@d36 1
a36 1
B<OSSP shiela> 0.9.3 (22-Dec-2002)
@


1.10
log
@remove trailing whitespaces
@
text
@d36 1
a36 1
B<OSSP shiela> 0.9.3 (21-Dec-2002)
@


1.9
log
@reference the config section correctly
@
text
@d11 2
a12 2
##  modify it under the terms of the GNU General Public  License 
##  as published by the Free Software Foundation; either version 
d20 1
a20 1
##  You should have received a copy of the GNU General Public License 
d28 1
a28 1
=pod 
d132 1
a132 1
Just run C<shiela-install> and answer the questions. 
@


1.8
log
@Finally really use the "Environment" configuration section to find
"cvs" and "sendmail" directly and add a "Program" sub-command to it
for easier extension of the "Environment" section in the future.

Additionally, replace more "Shiela" occurrences with "OSSP shiela".
@
text
@d118 2
a119 2
project situation. For details, see the description below under
B<CONFIGURATION>.
@


1.7
log
@Consistently switch to the "OSSP shiela" branding.
@
text
@d32 1
a32 1
B<shiela-install> - Shiela installation utility
d36 1
a36 1
B<OSSP Shiela> 0.9.3 (21-Dec-2002)
d40 1
a40 1
B<Shiela> is an access control and logging facility for use with
d42 2
a43 2
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
d48 1
a48 1
B<Shiela> can be installed and activated in a CVS repository either
d82 1
a82 1
import>' commands cannot be access controlled by B<Shiela> (because then
d91 1
a91 1
admin>' commands cannot be access controlled by B<Shiela> (because then
d110 1
a110 1
instead and live with the fact that B<Shiela>'s run-time efficiency is
d112 1
a112 1
B<Shiela> has to determine details the hard way which CVS already would
@


1.6
log
@Fix the "invalid file specification `<absolute path>' for access
control" issue by using Cwd::realpath to resolve the absolute path
instead of calling `pwd`.

Additionally, bump version.
@
text
@d2 1
a2 1
##  Shiela - CVS Access Control and Logging Facility
d4 1
d6 3
a8 3
##  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/.
d25 1
a25 1
##  shiela-install.pod: Shiela install manual page (syntax: POD)
@


1.5
log
@Switched to the OSSP devtool build environment
and upgraded to GNU shtool 1.6.1 and GNU autoconf 2.53.
@
text
@d35 1
a35 1
B<OSSP Shiela> 0.9.2 (19-Aug-2002)
@


1.4
log
@bump copyright years
@
text
@d35 1
a35 1
B<OSSP Shiela> 0.9.2 (05-May-2001)
@


1.3
log
@Update for Shtool 1.5.3 and new version
@
text
@d3 1
a3 1
##  Copyright (c) 2000 Ralf S. Engelschall <rse@@engelschall.com>
@


1.2
log
@   *) Upgraded to GNU shtool 1.5.2-pre.
      [Ralf S. Engelschall]

   *) Added --with-perl=PATH and --with-cvs=PATH Autoconf options
      to allow one to force the use of particular programs.
      [Ralf S. Engelschall]

   *) Added $(DESTDIR) support for "make install".
      [Ralf S. Engelschall]
@
text
@d35 1
a35 1
B<OSSP Shiela> 0.9.1 (27-Jun-2000)
@


1.1
log
@Initial revision
@
text
@d35 1
a35 1
B<OSSP Shiela> 0.9.0 (18-Jun-2000)
@


1.1.1.1
log
@Import of OSSP Shiela

@
text
@@