README.md

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