README
1#
2# $Id: README,v 1.6 2007/04/08 09:14:13 nick Exp $
3#
4
5DESCRIPTION
6-----------
7
8This is Rcs::Agent, version 1.04, an object oriented RCS perl library, used
9for creating and manipulating RCS archives within perl programs.
10
11Rcs::Agent is copyright (C) 2001 - 2007 Network Ability Ltd. All rights
12reserved. This software may be redistributed under the terms of the license
13included in this software distribution. Please see the file "LICENSE" for
14further details.
15
16
17PREREQUISITES
18-------------
19
20A Unix or Unix-look-alike. Rcs::Agent will almost certainly not run under
21non-unixy systems.
22
23The following perl modules are also needed for Rcs::Agent to run properly:
24
25String::ShellQuote-1.00
26File::Temp
27
28These (and many other) useful packages are available from your local CPAN
29archive, or http://www.perl.com/. File::Temp is included with the base
30distribution of perl 5.7 and above, so if you're running this version or
31anything more recent, there's no need to install this module.
32
33
34INSTALLATION
35------------
36
37tar -xvzf Rcs::Agent-1.XX.tar.gz
38cd Rcs::Agent-1.XX
39perl Makefile.PL
40make
41make install
42
43BUGS & SECURITY
44---------------
45
46Rcs::Agent is coded carefully with security in mind. Like all code,
47however, there is a possibility that bugs or security problems have slipped
48through the net. If you find a problem with the code, please email us at
49rcs-agent /at/ netability.ie, detailing the problem, and providing a patch
50if possible.
51
52In particular, we recommend that all developers use the 'tmpdir' parameter
53when creating new objects to ensure that RCS does not use /tmp for its
54temporary files. Please see the man page for more details on this.
55
56
57CONTRIBUTORS
58------------
59
60Nick Hilliard - nick /at/ netability.ie
61
62
63CONTACT INFORMATION
64-------------------
65
66Rcs::Agent is written by Network Ability Ltd, a Dublin, Ireland-based
67company specialising in ISP consultancy and contracting services. Among
68many other things, we write perl code to suit all occasions. Please contact
69us at <info /at/ netability.ie> with your requirements.
70
71