1WHAT IS RSYNC?
4Rsync is a fast and extraordinarily versatile file copying tool for
5both remote and local files.
7Rsync uses a delta-transfer algorithm which provides a very fast method
8for bringing remote files into sync. It does this by sending just the
9differences in the files across the link, without requiring that both
10sets of files are present at one of the ends of the link beforehand. At
11first glance this may seem impossible because the calculation of diffs
12between two files normally requires local access to both files.
14A technical report describing the rsync algorithm is included with this
21Basically you use rsync just like scp, but rsync has many additional
22options. To get a complete list of supported options type:
24 rsync --help
26See the manpage for more detailed information.
32Rsync normally uses ssh or rsh for communication with remote systems.
33It does not need to be setuid and requires no special privileges for
34installation. You must, however, have a working ssh or rsh system.
35Using ssh is recommended for its security features.
37Alternatively, rsync can run in `daemon' mode, listening on a socket.
38This is generally used for public file distribution, although
39authentication and access control are available.
41To install rsync, first run the "configure" script. This will create a
42Makefile and config.h appropriate for your system. Then type "make".
44Note that on some systems you will have to force configure not to use
45gcc because gcc may not support some features (such as 64 bit file
46offsets) that your system may support. Set the environment variable CC
47to the name of your native compiler before running configure in this
50Once built put a copy of rsync in your search path on the local and
51remote systems (or use "make install"). That's it!
57Rsync can also talk to "rsync daemons" which can provide anonymous or
58authenticated rsync. See the rsyncd.conf(5) man page for details on how
59to setup an rsync daemon. See the rsync(1) man page for info on how to
60connect to an rsync daemon.
66The main rsync web site is here:
70You'll find a FAQ list, downloads, resources, HTML versions of the
77There is a mailing list for the discussion of rsync and its applications
78that is open to anyone to join. New releases are announced on this
79list, and there is also an announcement-only mailing list for those that
80want official announcements. See the mailing-list page for full
89To visit this web page for full the details on bug reporting:
93That page contains links to the current bug list, and information on how
94to report a bug well. You might also like to try searching the Internet
95for the error message you've received, or looking in the mailing list
100To send a bug report, follow the instructions on the bug-tracking
101page of the web site.
103Alternately, email your bug report to email@example.com .
109If you want to get the very latest version of rsync direct from the
110source code repository then you can use git:
112 git clone git://git.samba.org/rsync.git
114See the download page for full details on all the ways to grab the
115source, including nightly tar files, web-browsing of the git repository,
124Rsync was originally written by Andrew Tridgell and is currently
125maintained by Wayne Davison. It has been improved by many developers
126from around the world.
128Rsync may be used, modified and redistributed only under the terms of
129the GNU General Public License, found in the file COPYING in this
130distribution, or at:
138The main web site for rsync is http://rsync.samba.org/
139The main ftp site is ftp://rsync.samba.org/pub/rsync/
140This is also available as rsync://rsync.samba.org/rsyncftp/