*** empty log message ***
[rsync.git] / README
1 WHAT IS RSYNC?
2 --------------
3
4 rsync is a replacement for rcp that has many more features.
5
6 rsyns uses the "rsync algorithm" which provides a very fast method for
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
15 this package. 
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
25 -v, --verbose            increase verbosity
26 -c, --checksum           always checksum
27 -a, --archive            archive mode (same as -rlptDog)
28 -r, --recursive          recurse into directories
29 -b, --backup             make backups (default ~ extension)
30 -u, --update             update only (don't overwrite newer files)
31 -l, --links              preserve soft links
32 -H, --hard-links         preserve hard links
33 -p, --perms              preserve permissions
34 -o, --owner              preserve owner (root only)
35 -g, --group              preserve group
36 -D, --devices            preserve devices (root only)
37 -t, --times              preserve times
38 -S, --sparse             handle sparse files efficiently
39 -n, --dry-run            show what would have been transferred
40 -x, --one-file-system    don't cross filesystem boundaries
41 -B, --block-size SIZE    checksum blocking size
42 -e, --rsh COMMAND        specify rsh replacement
43     --rsync-path PATH    specify path to rsync on the remote machine
44 -C, --cvs-exclude        auto ignore files in the same way CVS does
45     --delete             delete files that don't exist on the sending side
46 -I, --ignore-times       don't exclude files that match length and time
47     --exclude FILE       exclude file FILE
48     --exclude-from FILE  exclude files listed in FILE
49     --suffix SUFFIX      override backup suffix
50     --csum-length LENGTH set the checksum length
51     --version            print version number
52
53
54 SETUP
55 -----
56
57 Rsync uses rsh or ssh for communication. It does not need to be setuid
58 and requires no special privilages for installation. It does not
59 require a inetd entry or a daemon. You must, however, have a working
60 rsh or ssh system. Using ssh is recommended for its security and
61 compression features.
62
63 To install rsync, first run the "configure" script. This will create a
64 Makefile and config.h appropriate for your system. Then type
65 "make". 
66
67 Once built put a copy of rsync in your search path on the local and
68 remote systems (or use "make install"). That's it!
69
70
71 COPYRIGHT
72 ---------
73
74 Rsync was written by Andrew Tridgell and Paul Mackerras, and is
75 available under the GPL.
76
77 Andrew.Tridgell@anu.edu.au
78 paulus@cs.anu.edu.au
79
80
81 AVAILABILITY
82 ------------
83
84 The main ftp site for rsync is ftp://samba.anu.edu.au/pub/rsync