Commit | Line | Data |
---|---|---|
c627d613 AT |
1 | WHAT IS RSYNC? |
2 | -------------- | |
3 | ||
4 | rsync is a replacement for rcp that has many more features. | |
5 | ||
10ce5fbf | 6 | rsync uses the "rsync algorithm" which provides a very fast method for |
c627d613 AT |
7 | bringing remote files into sync. It does this by sending just the |
8 | differences in the files across the link, without requiring that both | |
9 | sets of files are present at one of the ends of the link beforehand. | |
10 | At first glance this may seem impossible because the calculation of | |
11 | diffs between two files normally requires local access to both | |
12 | files. | |
13 | ||
14 | A technical report describing the rsync algorithm is included with | |
c6e7fcb4 | 15 | this package. |
c627d613 AT |
16 | |
17 | ||
18 | USAGE | |
19 | ----- | |
20 | ||
bf2daeaf MP |
21 | Basically you use rsync just like rcp, but rsync has many additional |
22 | options. To get a complete list of supported options type | |
c627d613 | 23 | |
bf2daeaf MP |
24 | rsync --help |
25 | ||
26 | and see the manual for more information. | |
c627d613 | 27 | |
9ef53907 | 28 | |
c627d613 AT |
29 | SETUP |
30 | ----- | |
31 | ||
1514ad2a | 32 | Rsync normally uses ssh or rsh for communication. It does not need to |
eeb1568f | 33 | be setuid and requires no special privileges for installation. You |
1514ad2a | 34 | must, however, have a working ssh or rsh system. Using ssh is |
eeb1568f MP |
35 | recommended for its security features. |
36 | ||
37 | Alternatively, rsync can run in `daemon' mode, listening on a socket. | |
38 | This is generally used for public file distribution, although | |
39 | authentication and access control are available. | |
c627d613 AT |
40 | |
41 | To install rsync, first run the "configure" script. This will create a | |
42 | Makefile and config.h appropriate for your system. Then type | |
43 | "make". | |
44 | ||
debb4505 AT |
45 | Note that on some systems you will have to force configure not to use |
46 | gcc because gcc may not support some features (such as 64 bit file | |
47 | offsets) that your system may support. Set the environment variable CC | |
48 | to the name of your native compiler before running configure in this | |
49 | case. | |
50 | ||
c627d613 AT |
51 | Once built put a copy of rsync in your search path on the local and |
52 | remote systems (or use "make install"). That's it! | |
53 | ||
e095b568 AT |
54 | RSYNC SERVERS |
55 | ------------- | |
56 | ||
57 | rsync can also talk to "rsync servers" which can provide anonymous or | |
ed06894a | 58 | authenticated rsync. See the rsyncd.conf(5) man page for details on how |
e095b568 AT |
59 | to setup a rsync server. See the rsync(1) man page for info on how to |
60 | connect to a rsync server. | |
61 | ||
c627d613 | 62 | |
432b0fbd AT |
63 | MAILING LIST |
64 | ------------ | |
65 | ||
66 | There is a mailing list for the discussion of rsync and its | |
67 | applications. It is open to anyone to join. I will announce new | |
68 | versions on this list. | |
69 | ||
d153974e | 70 | To join the mailing list see the web page at http://lists.samba.org/ |
432b0fbd | 71 | |
9e3c856a | 72 | To send mail to everyone on the list send it to rsync@samba.org |
432b0fbd AT |
73 | |
74 | ||
e92338c8 AT |
75 | BUG REPORTS |
76 | ----------- | |
77 | ||
78 | If you have web access then please look at | |
e92338c8 | 79 | |
1a216662 | 80 | http://rsync.samba.org/ |
bf2daeaf MP |
81 | |
82 | That page contains links to the current bug list, and information on | |
83 | how to report a bug well. You might also like to try searching the | |
84 | internet for the error message you've received, or looking in the | |
85 | mailing list archives at | |
86 | ||
87 | http://mail-archive.com/rsync@lists.samba.org/ | |
88 | ||
1a216662 WD |
89 | To send a bug report, follow the instructions on the bug-tracking |
90 | page of the web site. | |
e92338c8 AT |
91 | |
92 | ||
527cea66 AT |
93 | CVS TREE |
94 | -------- | |
95 | ||
96 | If you want to get the very latest version of rsync direct from the | |
97 | source code repository then you can use anonymous cvs. You will need a | |
98 | recent version of cvs then use the following commands: | |
99 | ||
eeb1568f | 100 | cvs -d :pserver:cvs@pserver.samba.org:/cvsroot login |
527cea66 AT |
101 | Password: cvs |
102 | ||
eeb1568f | 103 | cvs -d :pserver:cvs@pserver.samba.org:/cvsroot co rsync |
527cea66 | 104 | |
eeb1568f MP |
105 | Look at the cvs documentation, or http://samba.org/cvs.html, for more |
106 | details. | |
527cea66 AT |
107 | |
108 | ||
c627d613 AT |
109 | COPYRIGHT |
110 | --------- | |
111 | ||
9e696bd4 MP |
112 | rsync was originally written by Andrew Tridgell and has been improved |
113 | by many developers around the world. rsync may be used, modified and | |
114 | redistributed only under the terms of the GNU General Public License, | |
115 | found in the file COPYING in this distribution, or at | |
c627d613 | 116 | |
9e696bd4 | 117 | http://www.fsf.org/licenses/gpl.html |
c627d613 AT |
118 | |
119 | ||
120 | AVAILABILITY | |
121 | ------------ | |
122 | ||
9e3c856a AT |
123 | The main web site for rsync is http://rsync.samba.org/ |
124 | The main ftp site is ftp://rsync.samba.org/pub/rsync/ | |
125 | This is also available as rsync://rsync.samba.org/rsyncftp/ |