README
1File::RsyncP
2============
3
4Version 0.76, released 14 Sep 2020.
5
6File::RsyncP is a perl implementation of an Rsync client. It is
7compatible with Rsync 2.x (protocol versions up to 28). It can send
8or receive files, either by running rsync on the remote machine, or
9connecting to an rsyncd deamon on the remote machine.
10
11What use is File::RsyncP? The main purpose is that File::RsyncP
12seperates all file system I/O into a seperate module, which can
13be replaced by any module of your own design. This allows rsync
14interfaces to non-filesystem data types (eg: databases) to be
15developed with relative ease.
16
17File::RsyncP was initially written to provide an Rsync interface
18for BackupPC, L<http://backuppc.sourceforge.net>. See BackupPC
19for programming examples.
20
21File::RsyncP does not yet provide a command-line interface that
22mimics native Rsync. Instead it provides an API that makes it
23possible to write simple scripts that talk to rsync or rsyncd.
24
25The File::RsyncP::FileIO module contains the default file system access
26functions. File::RsyncP::FileIO may be subclassed or replaced by a
27custom module to provide access to non-filesystem data types.
28
29INSTALLATION
30
31To install this module type the following:
32
33 perl Makefile.PL
34 make
35 make test
36 make install
37
38COPYRIGHT AND LICENCE
39
40Non-rsync code is copyright (C) 2002-2015 Craig Barratt
41<cbarratt@users.sourceforge.net>
42
43Rsync is Copyright (C) 1996-2001 by Andrew Tridgell, 1996 by Paul
44Mackerras, 2001-2002 by Martin Pool, and 2003-2009 by Wayne Davison,
45and others.
46
47MD4 Message-Digest Algorithm is Copyright (C) 1990-2, RSA Data
48Security, Inc. All rights reserved.
49
50This program is free software: you can redistribute it and/or modify
51it under the terms of the GNU General Public License as published by
52the Free Software Foundation, either version 3 of the License, or
53(at your option) any later version.
54
55This program is distributed in the hope that it will be useful,
56but WITHOUT ANY WARRANTY; without even the implied warranty of
57MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
58GNU General Public License for more details.
59
60You should have received a copy of the GNU General Public License
61along with this program. If not, see <http://www.gnu.org/licenses/>.
62