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 | ||
21 | Basically you use rsync just like rcp, but rsync has many additional options. | |
22 | ||
23 | Here is a brief description of available options: | |
24 | ||
82306bf6 | 25 | Options: |
c627d613 AT |
26 | -v, --verbose increase verbosity |
27 | -c, --checksum always checksum | |
28 | -a, --archive archive mode (same as -rlptDog) | |
29 | -r, --recursive recurse into directories | |
e92338c8 | 30 | -R, --relative use relative path names |
c627d613 AT |
31 | -b, --backup make backups (default ~ extension) |
32 | -u, --update update only (don't overwrite newer files) | |
33 | -l, --links preserve soft links | |
82306bf6 | 34 | -L, --copy-links treat soft links like regular files |
dc5ddbcc | 35 | -H, --hard-links preserve hard links |
c627d613 AT |
36 | -p, --perms preserve permissions |
37 | -o, --owner preserve owner (root only) | |
38 | -g, --group preserve group | |
39 | -D, --devices preserve devices (root only) | |
40 | -t, --times preserve times | |
dc5ddbcc | 41 | -S, --sparse handle sparse files efficiently |
c627d613 | 42 | -n, --dry-run show what would have been transferred |
82306bf6 | 43 | -W, --whole-file copy whole files, no incremental checks |
c627d613 AT |
44 | -x, --one-file-system don't cross filesystem boundaries |
45 | -B, --block-size SIZE checksum blocking size | |
46 | -e, --rsh COMMAND specify rsh replacement | |
47 | --rsync-path PATH specify path to rsync on the remote machine | |
48 | -C, --cvs-exclude auto ignore files in the same way CVS does | |
49 | --delete delete files that don't exist on the sending side | |
8a24eece AT |
50 | --force force deletion of directories even if not empty |
51 | --numeric-ids don't map uid/gid values by user/group name | |
52 | --timeout TIME set IO timeout in seconds | |
c627d613 | 53 | -I, --ignore-times don't exclude files that match length and time |
8a24eece | 54 | -T --temp-dir DIR create temporary files in directory DIR |
d89322c4 | 55 | -z, --compress compress file data |
c627d613 AT |
56 | --exclude FILE exclude file FILE |
57 | --exclude-from FILE exclude files listed in FILE | |
58 | --suffix SUFFIX override backup suffix | |
59 | --version print version number | |
60 | ||
61 | ||
c627d613 AT |
62 | SETUP |
63 | ----- | |
64 | ||
65 | Rsync uses rsh or ssh for communication. It does not need to be setuid | |
66 | and requires no special privilages for installation. It does not | |
67 | require a inetd entry or a daemon. You must, however, have a working | |
d89322c4 AT |
68 | rsh or ssh system. Using ssh is recommended for its security |
69 | features. | |
c627d613 AT |
70 | |
71 | To install rsync, first run the "configure" script. This will create a | |
72 | Makefile and config.h appropriate for your system. Then type | |
73 | "make". | |
74 | ||
debb4505 AT |
75 | Note that on some systems you will have to force configure not to use |
76 | gcc because gcc may not support some features (such as 64 bit file | |
77 | offsets) that your system may support. Set the environment variable CC | |
78 | to the name of your native compiler before running configure in this | |
79 | case. | |
80 | ||
c627d613 AT |
81 | Once built put a copy of rsync in your search path on the local and |
82 | remote systems (or use "make install"). That's it! | |
83 | ||
84 | ||
432b0fbd AT |
85 | MAILING LIST |
86 | ------------ | |
87 | ||
88 | There is a mailing list for the discussion of rsync and its | |
89 | applications. It is open to anyone to join. I will announce new | |
90 | versions on this list. | |
91 | ||
92 | To join the mailing list send mail to listproc@samba.anu.edu.au with | |
93 | no subject and a body of "subscribe rsync Your Name". | |
94 | ||
95 | To send mail to everyone on the list send it to rsync@samba.anu.edu.au | |
96 | ||
97 | ||
e92338c8 AT |
98 | BUG REPORTS |
99 | ----------- | |
100 | ||
101 | If you have web access then please look at | |
8a24eece | 102 | http://samba.anu.edu.au/rsync/ |
e92338c8 AT |
103 | |
104 | This will give you access to the bug tracking system used by the | |
105 | developers of rsync and will allow you to look at other bug reports or | |
106 | submit a new bug report. | |
107 | ||
108 | If you don't have web access then mail bug reports to | |
109 | rsync-bugs@samba.anu.edu.au or (if you think it will be of interest to | |
110 | lots of people) send it to rsync@samba.anu.edu.au | |
111 | ||
112 | ||
527cea66 AT |
113 | CVS TREE |
114 | -------- | |
115 | ||
116 | If you want to get the very latest version of rsync direct from the | |
117 | source code repository then you can use anonymous cvs. You will need a | |
118 | recent version of cvs then use the following commands: | |
119 | ||
120 | cvs -d :pserver:cvs@samba.anu.edu.au:/cvsroot login | |
121 | Password: cvs | |
122 | ||
123 | cvs -d :pserver:cvs@samba.anu.edu.au:/cvsroot co rsync | |
124 | ||
125 | Look at the cvs documentation for more details. | |
126 | ||
127 | ||
c627d613 AT |
128 | COPYRIGHT |
129 | --------- | |
130 | ||
131 | Rsync was written by Andrew Tridgell and Paul Mackerras, and is | |
8a24eece | 132 | available under the Gnu Public License. |
c627d613 | 133 | |
8a24eece | 134 | tridge@samba.anu.edu.au |
c627d613 AT |
135 | paulus@cs.anu.edu.au |
136 | ||
137 | ||
138 | AVAILABILITY | |
139 | ------------ | |
140 | ||
141 | The main ftp site for rsync is ftp://samba.anu.edu.au/pub/rsync | |
1482e93a | 142 | |
773f2bd4 | 143 | Mirrors are available at: |
1482e93a | 144 | |
773f2bd4 AT |
145 | ftp://sunsite.auc.dk/pub/unix/rsync |
146 | ftp://ftp.sunet.se/pub/unix/admin/rsync | |
f0e5517f | 147 | ftp://ftp.fu-berlin.de/pub/unix/network/rsync/ |