4 Rsync is a fast and extraordinarily versatile file copying tool for
5 both remote and local files.
7 Rsync uses a delta-transfer algorithm which provides a very fast method
8 for bringing remote files into sync. It does this by sending just the
9 differences in the files across the link, without requiring that both
10 sets of files are present at one of the ends of the link beforehand. At
11 first glance this may seem impossible because the calculation of diffs
12 between two files normally requires local access to both files.
14 A technical report describing the rsync algorithm is included with this
21 Basically you use rsync just like scp, but rsync has many additional
22 options. To get a complete list of supported options type:
26 See the manpage for more detailed information.
29 BUILDING AND INSTALLING
30 -----------------------
32 If you need to build rsync yourself, check out the [INSTALL][1] page for
33 information on what libraries and packages you can use to get the maximum
34 features in your build.
36 [1]: https://download.samba.org/pub/rsync/INSTALL
41 Rsync normally uses ssh or rsh for communication with remote systems.
42 It does not need to be setuid and requires no special privileges for
43 installation. You must, however, have a working ssh or rsh system.
44 Using ssh is recommended for its security features.
46 Alternatively, rsync can run in `daemon' mode, listening on a socket.
47 This is generally used for public file distribution, although
48 authentication and access control are available.
50 To install rsync, first run the "configure" script. This will create a
51 Makefile and config.h appropriate for your system. Then type "make".
53 Note that on some systems you will have to force configure not to use
54 gcc because gcc may not support some features (such as 64 bit file
55 offsets) that your system may support. Set the environment variable CC
56 to the name of your native compiler before running configure in this
59 Once built put a copy of rsync in your search path on the local and
60 remote systems (or use "make install"). That's it!
66 Rsync can also talk to "rsync daemons" which can provide anonymous or
67 authenticated rsync. See the rsyncd.conf(5) man page for details on how
68 to setup an rsync daemon. See the rsync(1) man page for info on how to
69 connect to an rsync daemon.
75 For more information, visit the [main rsync web site][2].
77 [2]: https://rsync.samba.org/
79 You'll find a FAQ list, downloads, resources, HTML versions of the
86 There is a mailing list for the discussion of rsync and its applications
87 that is open to anyone to join. New releases are announced on this
88 list, and there is also an announcement-only mailing list for those that
89 want official announcements. See the [mailing-list page][3] for full
92 [3]: https://rsync.samba.org/lists.html
98 The [bug-tracking web page][4] has full details on bug reporting.
100 [4]: https://rsync.samba.org/bug-tracking.html
102 That page contains links to the current bug list, and information on how to
103 do a good job when reporting a bug. You might also like to try searching
104 the Internet for the error message you've received, or looking in the
105 [mailing list archives][5].
107 [5]: https://mail-archive.com/rsync@lists.samba.org/
109 To send a bug report, follow the instructions on the bug-tracking
110 page of the web site.
112 Alternately, email your bug report to <rsync@lists.samba.org>.
118 If you want to get the very latest version of rsync direct from the
119 source code repository, then you will need to use git. The git repo
120 is hosted [on GitHub][6] and [on Samba's site][7].
122 [6]: https://github.com/WayneD/rsync
123 [7]: https://git.samba.org/?p=rsync.git;a=summary
125 See [the download page][8] for full details on all the ways to grab the
128 [8]: https://rsync.samba.org/download.html
134 Rsync was originally written by Andrew Tridgell and is currently
135 maintained by Wayne Davison. It has been improved by many developers
136 from around the world.
138 Rsync may be used, modified and redistributed only under the terms of
139 the GNU General Public License, found in the file [COPYING][9] in this
140 distribution, or at [the Free Software Foundation][10].
142 [9]: https://download.samba.org/pub/rsync/COPYING
143 [10]: https://www.fsf.org/licenses/gpl.html