xref: /rsync/
Name Date Size

..18-Aug.-20214 KiB

.cirrus.ymlH A D19-Mar.-2021733

.gitattributesH A D15-Jul.-202019

.github/workflows/H15-Jul.-20204 KiB

.gitignoreH A D01-Aug.-2020723

access.cH A D16-Feb.-20216.1 KiB

acls.cH A D26-Jun.-202029.8 KiB

authenticate.cH A D06-Jul.-20209.6 KiB

backup.cH A D13-Jun.-20209.1 KiB

batch.cH A D28-Jun.-20207.9 KiB

byteorder.hH A D25-May-20202.9 KiB

case_N.hH A D16-Apr.-20202.3 KiB

checksum.cH A D21-Jul.-202015.4 KiB

chmod.cH A D16-Apr.-20205.5 KiB

cleanup.cH A D13-Jul.-20207.6 KiB

clientname.cH A D08-Jul.-202013.4 KiB

clientserver.cH A D13-May-202138.8 KiB

cmdormsgH A D21-Jun.-2020166

compat.cH A D03-Sep.-202023.1 KiB

config.guessH A D17-Jun.-202047.7 KiB

config.subH A D17-Jun.-202030.9 KiB

configureH A D29-Jun.-2020665

configure.acH A D13-May-202146.5 KiB

connection.cH A D09-Apr.-20201.3 KiB

COPYINGH A D08-Jun.-202034.7 KiB

csprotocol.txtH A D17-Aug.-20173.1 KiB

daemon-parm.awkH A D04-Jul.-20202.8 KiB

daemon-parm.txtH A D17-Jul.-20201.6 KiB

define-from-md.awkH A D18-Jun.-2020820

delete.cH A D14-Jun.-20206.3 KiB

doc/H16-Apr.-20204 KiB

DoxyfileH A D17-Aug.-20177 KiB

errcode.hH A D16-Mar.-20192.8 KiB

exclude.cH A D03-Aug.-202040.1 KiB

fileio.cH A D26-Jun.-20208.1 KiB

flist.cH A D09-Jul.-202189.4 KiB

generator.cH A D09-Jul.-202166.4 KiB

getfsdev.cH A D14-Jun.-2020374

getgroups.cH A D28-Jun.-20201.5 KiB

hashtable.cH A D26-Jun.-202016.1 KiB

help-from-md.awkH A D18-Jun.-2020770

hlink.cH A D23-Sep.-202015.5 KiB

ifuncs.hH A D03-Aug.-20202.2 KiB

install-shH A D17-Aug.-20174.7 KiB

INSTALL.mdH A D26-Feb.-20219.3 KiB

inums.hH A D16-Mar.-20191.5 KiB

io.cH A D26-Feb.-202163.6 KiB

io.hH A D16-Mar.-20191.3 KiB

itypes.hH A D11-Jun.-20201.4 KiB

latest-year.hH A D09-Apr.-202027

lib/H16-Feb.-20214 KiB

loadparm.cH A D29-Sep.-202014.9 KiB

log.cH A D29-Sep.-202024.2 KiB

m4/H08-Apr.-20204 KiB

main.cH A D06-Jul.-202148.7 KiB

Makefile.inH A D09-Jul.-202111.7 KiB

match.cH A D26-Jun.-202012.3 KiB

maybe-make-manH A D09-Jun.-2020934

md2manH A D24-Jul.-202012.4 KiB

mkgitverH A D07-Sep.-2020280

mkproto.awkH A D03-Aug.-2020901

NEWS.mdH A D29-Sep.-2020184.2 KiB

options.cH A D23-Sep.-202090.6 KiB

packaging/H26-Feb.-20214 KiB

params.cH A D26-Jun.-202021.3 KiB

pipe.cH A D14-Jun.-20205.1 KiB

popt/H06-Jul.-20204 KiB

prepare-sourceH A D29-Jul.-20201.7 KiB

prepare-source.makH A D01-Aug.-2020231

progress.cH A D14-Jun.-20206.3 KiB

README.mdH A D16-Feb.-20214.4 KiB

receiver.cH A D06-Jul.-202127 KiB

rounding.cH A D19-Jun.-20201.2 KiB

rsync-sslH A D26-Aug.-20204.8 KiB

rsync-ssl.1.mdH A D21-Jun.-20204.1 KiB

rsync.1.mdH A D09-Jul.-2021201.1 KiB

rsync.cH A D09-Jul.-202123.3 KiB

rsync.hH A D09-Jul.-202141 KiB

rsync3.txtH A D22-Jun.-202014.3 KiB

rsyncd.conf.5.mdH A D17-Jul.-202057.4 KiB

rsyncsh.txtH A D17-Aug.-20171.3 KiB

runtests.shH A D22-Jul.-202010.6 KiB

SECURITY.mdH A D03-Sep.-2020313

sender.cH A D06-Jul.-202111.3 KiB

shconfig.inH A D17-Aug.-2017360

simd-checksum-x86_64.cppH A D22-Sep.-202023.4 KiB

socket.cH A D26-Jun.-202021.4 KiB

stunnel-rsyncd.conf.inH A D19-Apr.-20201,016

support/H10-Jul.-20214 KiB

syscall.cH A D09-Jul.-202115 KiB

t_stub.cH A D07-Jul.-20202.5 KiB

t_unsafe.cH A D14-Jun.-20201.3 KiB

tech_report.texH A D17-Aug.-201714.3 KiB

testhelp/H17-Jun.-20204 KiB

testrun.cH A D17-Aug.-20171.4 KiB

testsuite/H06-Jul.-20214 KiB

tls.cH A D09-Jul.-20218 KiB

TODOH A D22-Jun.-202015.3 KiB

token.cH A D29-Sep.-202026.2 KiB

trimslash.cH A D26-Apr.-20201.2 KiB

uidlist.cH A D29-Sep.-202014 KiB

usage.cH A D21-Sep.-20206.3 KiB

util1.cH A D27-Jun.-202140.8 KiB

util2.cH A D03-Aug.-20203.5 KiB

version.hH A D03-Sep.-202033

wildtest.cH A D16-Mar.-20195.5 KiB

wildtest.txtH A D17-Aug.-20174.1 KiB

xattrs.cH A D29-Sep.-202031.7 KiB

zlib/H16-Mar.-20194 KiB

README.md

1WHAT IS RSYNC?
2--------------
3
4Rsync is a fast and extraordinarily versatile file copying tool for
5both remote and local files.
6
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.
13
14A technical report describing the rsync algorithm is included with this
15package.
16
17
18USAGE
19-----
20
21Basically you use rsync just like scp, but rsync has many additional
22options.  To get a complete list of supported options type:
23
24    rsync --help
25
26See the [manpage][0] for more detailed information.
27
28[0]: https://download.samba.org/pub/rsync/rsync.1
29
30BUILDING AND INSTALLING
31-----------------------
32
33If you need to build rsync yourself, check out the [INSTALL][1] page for
34information on what libraries and packages you can use to get the maximum
35features in your build.
36
37[1]: https://github.com/WayneD/rsync/blob/master/INSTALL.md
38
39SETUP
40-----
41
42Rsync normally uses ssh or rsh for communication with remote systems.
43It does not need to be setuid and requires no special privileges for
44installation.  You must, however, have a working ssh or rsh system.
45Using ssh is recommended for its security features.
46
47Alternatively, rsync can run in `daemon' mode, listening on a socket.
48This is generally used for public file distribution, although
49authentication and access control are available.
50
51To install rsync, first run the "configure" script.  This will create a
52Makefile and config.h appropriate for your system.  Then type "make".
53
54Note that on some systems you will have to force configure not to use
55gcc because gcc may not support some features (such as 64 bit file
56offsets) that your system may support.  Set the environment variable CC
57to the name of your native compiler before running configure in this
58case.
59
60Once built put a copy of rsync in your search path on the local and
61remote systems (or use "make install").  That's it!
62
63
64RSYNC DAEMONS
65-------------
66
67Rsync can also talk to "rsync daemons" which can provide anonymous or
68authenticated rsync.  See the rsyncd.conf(5) man page for details on how
69to setup an rsync daemon.  See the rsync(1) man page for info on how to
70connect to an rsync daemon.
71
72
73WEB SITE
74--------
75
76For more information, visit the [main rsync web site][2].
77
78[2]: https://rsync.samba.org/
79
80You'll find a FAQ list, downloads, resources, HTML versions of the
81manpages, etc.
82
83
84MAILING LISTS
85-------------
86
87There is a mailing list for the discussion of rsync and its applications
88that is open to anyone to join.  New releases are announced on this
89list, and there is also an announcement-only mailing list for those that
90want official announcements.  See the [mailing-list page][3] for full
91details.
92
93[3]: https://rsync.samba.org/lists.html
94
95
96BUG REPORTS
97-----------
98
99The [bug-tracking web page][4] has full details on bug reporting.
100
101[4]: https://rsync.samba.org/bug-tracking.html
102
103That page contains links to the current bug list, and information on how to
104do a good job when reporting a bug.  You might also like to try searching
105the Internet for the error message you've received, or looking in the
106[mailing list archives][5].
107
108[5]: https://mail-archive.com/rsync@lists.samba.org/
109
110To send a bug report, follow the instructions on the bug-tracking
111page of the web site.
112
113Alternately, email your bug report to <rsync@lists.samba.org>.
114
115
116GIT REPOSITORY
117--------------
118
119If you want to get the very latest version of rsync direct from the
120source code repository, then you will need to use git.  The git repo
121is hosted [on GitHub][6] and [on Samba's site][7].
122
123[6]: https://github.com/WayneD/rsync
124[7]: https://git.samba.org/?p=rsync.git;a=summary
125
126See [the download page][8] for full details on all the ways to grab the
127source.
128
129[8]: https://rsync.samba.org/download.html
130
131
132COPYRIGHT
133---------
134
135Rsync was originally written by Andrew Tridgell and is currently
136maintained by Wayne Davison.  It has been improved by many developers
137from around the world.
138
139Rsync may be used, modified and redistributed only under the terms of
140the GNU General Public License, found in the file [COPYING][9] in this
141distribution, or at [the Free Software Foundation][10].
142
143[9]: https://github.com/WayneD/rsync/blob/master/COPYING
144[10]: https://www.fsf.org/licenses/gpl.html
145