| 1 |
WHAT IS RSYNC-BPC? |
| 2 |
------------------ |
| 3 |
|
| 4 |
Rsync-bpc is a customized version of rsync that is used as part of |
| 5 |
BackupPC, an open source backup system. |
| 6 |
|
| 7 |
The main change to rsync is adding a shim layer (in the subdirectory |
| 8 |
backuppc, and in bpc_sysCalls.c) that emulates the system calls for |
| 9 |
accessing the file system so that rsync can directly read/write files |
| 10 |
in BackupPC's format. |
| 11 |
|
| 12 |
Rsync-bpc is fully line-compatible with vanilla rsync, so it can talk |
| 13 |
to rsync servers and clients. |
| 14 |
|
| 15 |
Rsync-bpc serves no purpose outside of BackupPC. |
| 16 |
|
| 17 |
WHAT IS RSYNC? |
| 18 |
-------------- |
| 19 |
|
| 20 |
Rsync is a fast and extraordinarily versatile file copying tool for |
| 21 |
both remote and local files. |
| 22 |
|
| 23 |
Rsync uses a delta-transfer algorithm which provides a very fast method |
| 24 |
for bringing remote files into sync. It does this by sending just the |
| 25 |
differences in the files across the link, without requiring that both |
| 26 |
sets of files are present at one of the ends of the link beforehand. At |
| 27 |
first glance this may seem impossible because the calculation of diffs |
| 28 |
between two files normally requires local access to both files. |
| 29 |
|
| 30 |
A technical report describing the rsync algorithm is included with this |
| 31 |
package. |
| 32 |
|
| 33 |
|
| 34 |
USAGE |
| 35 |
----- |
| 36 |
|
| 37 |
Basically you use rsync just like scp, but rsync has many additional |
| 38 |
options. To get a complete list of supported options type: |
| 39 |
|
| 40 |
rsync --help |
| 41 |
|
| 42 |
See the manpage for more detailed information. |
| 43 |
|
| 44 |
|
| 45 |
SETUP |
| 46 |
----- |
| 47 |
|
| 48 |
Rsync normally uses ssh or rsh for communication with remote systems. |
| 49 |
It does not need to be setuid and requires no special privileges for |
| 50 |
installation. You must, however, have a working ssh or rsh system. |
| 51 |
Using ssh is recommended for its security features. |
| 52 |
|
| 53 |
Alternatively, rsync can run in `daemon' mode, listening on a socket. |
| 54 |
This is generally used for public file distribution, although |
| 55 |
authentication and access control are available. |
| 56 |
|
| 57 |
To install rsync, first run the "configure" script. This will create a |
| 58 |
Makefile and config.h appropriate for your system. Then type "make". |
| 59 |
|
| 60 |
Note that on some systems you will have to force configure not to use |
| 61 |
gcc because gcc may not support some features (such as 64 bit file |
| 62 |
offsets) that your system may support. Set the environment variable CC |
| 63 |
to the name of your native compiler before running configure in this |
| 64 |
case. |
| 65 |
|
| 66 |
Once built put a copy of rsync in your search path on the local and |
| 67 |
remote systems (or use "make install"). That's it! |
| 68 |
|
| 69 |
|
| 70 |
RSYNC DAEMONS |
| 71 |
------------- |
| 72 |
|
| 73 |
Rsync can also talk to "rsync daemons" which can provide anonymous or |
| 74 |
authenticated rsync. See the rsyncd.conf(5) man page for details on how |
| 75 |
to setup an rsync daemon. See the rsync(1) man page for info on how to |
| 76 |
connect to an rsync daemon. |
| 77 |
|
| 78 |
|
| 79 |
WEB SITE |
| 80 |
-------- |
| 81 |
|
| 82 |
The main rsync web site is here: |
| 83 |
|
| 84 |
http://rsync.samba.org/ |
| 85 |
|
| 86 |
You'll find a FAQ list, downloads, resources, HTML versions of the |
| 87 |
manpages, etc. |
| 88 |
|
| 89 |
|
| 90 |
MAILING LISTS |
| 91 |
------------- |
| 92 |
|
| 93 |
There is a mailing list for the discussion of rsync and its applications |
| 94 |
that is open to anyone to join. New releases are announced on this |
| 95 |
list, and there is also an announcement-only mailing list for those that |
| 96 |
want official announcements. See the mailing-list page for full |
| 97 |
details: |
| 98 |
|
| 99 |
http://rsync.samba.org/lists.html |
| 100 |
|
| 101 |
|
| 102 |
BUG REPORTS |
| 103 |
----------- |
| 104 |
|
| 105 |
To visit this web page for full the details on bug reporting: |
| 106 |
|
| 107 |
http://rsync.samba.org/bugzilla.html |
| 108 |
|
| 109 |
That page contains links to the current bug list, and information on how |
| 110 |
to report a bug well. You might also like to try searching the Internet |
| 111 |
for the error message you've received, or looking in the mailing list |
| 112 |
archives at: |
| 113 |
|
| 114 |
http://mail-archive.com/[email protected]/ |
| 115 |
|
| 116 |
To send a bug report, follow the instructions on the bug-tracking |
| 117 |
page of the web site. |
| 118 |
|
| 119 |
Alternately, email your bug report to [email protected] . |
| 120 |
|
| 121 |
|
| 122 |
GIT REPOSITORY |
| 123 |
-------------- |
| 124 |
|
| 125 |
If you want to get the very latest version of rsync direct from the |
| 126 |
source code repository then you can use git: |
| 127 |
|
| 128 |
git clone git://git.samba.org/rsync.git |
| 129 |
|
| 130 |
See the download page for full details on all the ways to grab the |
| 131 |
source, including nightly tar files, web-browsing of the git repository, |
| 132 |
etc.: |
| 133 |
|
| 134 |
http://rsync.samba.org/download.html |
| 135 |
|
| 136 |
|
| 137 |
COPYRIGHT |
| 138 |
--------- |
| 139 |
|
| 140 |
Rsync was originally written by Andrew Tridgell and is currently |
| 141 |
maintained by Wayne Davison. It has been improved by many developers |
| 142 |
from around the world. |
| 143 |
|
| 144 |
Rsync may be used, modified and redistributed only under the terms of |
| 145 |
the GNU General Public License, found in the file COPYING in this |
| 146 |
distribution, or at: |
| 147 |
|
| 148 |
http://www.fsf.org/licenses/gpl.html |
| 149 |
|
| 150 |
|
| 151 |
AVAILABILITY |
| 152 |
------------ |
| 153 |
|
| 154 |
The main web site for rsync is http://rsync.samba.org/ |
| 155 |
The main ftp site is ftp://rsync.samba.org/pub/rsync/ |
| 156 |
This is also available as rsync://rsync.samba.org/rsyncftp/ |