README

   1 WHAT IS RSYNC?
   2 --------------
   3
   4 rsync is a replacement for rcp that has many more features.
   5
   6 rsync 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 Options:
  26 -v, --verbose            increase verbosity
  27 -c, --checksum           always checksum
  28 -a, --archive            archive mode (same as -rlptDog)
  29 -r, --recursive          recurse into directories
  30 -R, --relative           use relative path names
  31 -b, --backup             make backups (default ~ extension)
  32 -u, --update             update only (don't overwrite newer files)
  33 -l, --links              preserve soft links
  34 -L, --copy-links         treat soft links like regular files
  35 -H, --hard-links         preserve hard links
  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
  41 -S, --sparse             handle sparse files efficiently
  42 -n, --dry-run            show what would have been transferred
  43 -W, --whole-file         copy whole files, no incremental checks
  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
  50 -I, --ignore-times       don't exclude files that match length and time
  51 -z, --compress           compress file data
  52     --exclude FILE       exclude file FILE
  53     --exclude-from FILE  exclude files listed in FILE
  54     --suffix SUFFIX      override backup suffix
  55     --version            print version number
  56
  57
  58 SETUP
  59 -----
  60
  61 Rsync uses rsh or ssh for communication. It does not need to be setuid
  62 and requires no special privilages for installation. It does not
  63 require a inetd entry or a daemon. You must, however, have a working
  64 rsh or ssh system. Using ssh is recommended for its security
  65 features.
  66
  67 To install rsync, first run the "configure" script. This will create a
  68 Makefile and config.h appropriate for your system. Then type
  69 "make".
  70
  71 Once built put a copy of rsync in your search path on the local and
  72 remote systems (or use "make install"). That's it!
  73
  74
  75 MAILING LIST
  76 ------------
  77
  78 There is a mailing list for the discussion of rsync and its
  79 applications. It is open to anyone to join. I will announce new
  80 versions on this list.
  81
  82 To join the mailing list send mail to listproc@samba.anu.edu.au with
  83 no subject and a body of "subscribe rsync Your Name".
  84
  85 To send mail to everyone on the list send it to rsync@samba.anu.edu.au
  86
  87
  88 BUG REPORTS
  89 -----------
  90
  91 If you have web access then please look at
  92 http://samba.anu.edu.au/cgi-bin/rsync
  93
  94 This will give you access to the bug tracking system used by the
  95 developers of rsync and will allow you to look at other bug reports or
  96 submit a new bug report.
  97
  98 If you don't have web access then mail bug reports to
  99 rsync-bugs@samba.anu.edu.au or (if you think it will be of interest to
 100 lots of people) send it to rsync@samba.anu.edu.au
 101
 102
 103 CVS TREE
 104 --------
 105
 106 If you want to get the very latest version of rsync direct from the
 107 source code repository then you can use anonymous cvs. You will need a
 108 recent version of cvs then use the following commands:
 109
 110         cvs -d :pserver:cvs@samba.anu.edu.au:/cvsroot login
 111         Password: cvs
 112
 113         cvs -d :pserver:cvs@samba.anu.edu.au:/cvsroot co rsync
 114
 115 Look at the cvs documentation for more details.
 116
 117
 118 COPYRIGHT
 119 ---------
 120
 121 Rsync was written by Andrew Tridgell and Paul Mackerras, and is
 122 available under the GPL.
 123
 124 Andrew.Tridgell@anu.edu.au
 125 paulus@cs.anu.edu.au
 126
 127
 128 AVAILABILITY
 129 ------------
 130
 131 The main ftp site for rsync is ftp://samba.anu.edu.au/pub/rsync
 132
 133 Mirrors are available at:
 134
 135 ftp://sunsite.auc.dk/pub/unix/rsync
 136 ftp://ftp.sunet.se/pub/unix/admin/rsync