diff options
Diffstat (limited to '')
| -rw-r--r-- | README.md | 144 |
1 files changed, 144 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a86c771 --- /dev/null +++ b/README.md @@ -0,0 +1,144 @@ +WHAT IS RSYNC? +-------------- + +Rsync is a fast and extraordinarily versatile file copying tool for +both remote and local files. + +Rsync uses a delta-transfer algorithm which provides a very fast method +for bringing remote files into sync. It does this by sending just the +differences in the files across the link, without requiring that both +sets of files are present at one of the ends of the link beforehand. At +first glance this may seem impossible because the calculation of diffs +between two files normally requires local access to both files. + +A technical report describing the rsync algorithm is included with this +package. + + +USAGE +----- + +Basically you use rsync just like scp, but rsync has many additional +options. To get a complete list of supported options type: + + rsync --help + +See the [manpage][0] for more detailed information. + +[0]: https://download.samba.org/pub/rsync/rsync.1 + +BUILDING AND INSTALLING +----------------------- + +If you need to build rsync yourself, check out the [INSTALL][1] page for +information on what libraries and packages you can use to get the maximum +features in your build. + +[1]: https://github.com/WayneD/rsync/blob/master/INSTALL.md + +SETUP +----- + +Rsync normally uses ssh or rsh for communication with remote systems. +It does not need to be setuid and requires no special privileges for +installation. You must, however, have a working ssh or rsh system. +Using ssh is recommended for its security features. + +Alternatively, rsync can run in `daemon' mode, listening on a socket. +This is generally used for public file distribution, although +authentication and access control are available. + +To install rsync, first run the "configure" script. This will create a +Makefile and config.h appropriate for your system. Then type "make". + +Note that on some systems you will have to force configure not to use +gcc because gcc may not support some features (such as 64 bit file +offsets) that your system may support. Set the environment variable CC +to the name of your native compiler before running configure in this +case. + +Once built put a copy of rsync in your search path on the local and +remote systems (or use "make install"). That's it! + + +RSYNC DAEMONS +------------- + +Rsync can also talk to "rsync daemons" which can provide anonymous or +authenticated rsync. See the rsyncd.conf(5) manpage for details on how +to setup an rsync daemon. See the rsync(1) manpage for info on how to +connect to an rsync daemon. + + +WEB SITE +-------- + +For more information, visit the [main rsync web site][2]. + +[2]: https://rsync.samba.org/ + +You'll find a FAQ list, downloads, resources, HTML versions of the +manpages, etc. + + +MAILING LISTS +------------- + +There is a mailing list for the discussion of rsync and its applications +that is open to anyone to join. New releases are announced on this +list, and there is also an announcement-only mailing list for those that +want official announcements. See the [mailing-list page][3] for full +details. + +[3]: https://rsync.samba.org/lists.html + + +BUG REPORTS +----------- + +The [bug-tracking web page][4] has full details on bug reporting. + +[4]: https://rsync.samba.org/bug-tracking.html + +That page contains links to the current bug list, and information on how to +do a good job when reporting a bug. You might also like to try searching +the Internet for the error message you've received, or looking in the +[mailing list archives][5]. + +[5]: https://mail-archive.com/rsync@lists.samba.org/ + +To send a bug report, follow the instructions on the bug-tracking +page of the web site. + +Alternately, email your bug report to <rsync@lists.samba.org>. + + +GIT REPOSITORY +-------------- + +If you want to get the very latest version of rsync direct from the +source code repository, then you will need to use git. The git repo +is hosted [on GitHub][6] and [on Samba's site][7]. + +[6]: https://github.com/WayneD/rsync +[7]: https://git.samba.org/?p=rsync.git;a=summary + +See [the download page][8] for full details on all the ways to grab the +source. + +[8]: https://rsync.samba.org/download.html + + +COPYRIGHT +--------- + +Rsync was originally written by Andrew Tridgell and is currently +maintained by Wayne Davison. It has been improved by many developers +from around the world. + +Rsync may be used, modified and redistributed only under the terms of +the GNU General Public License, found in the file [COPYING][9] in this +distribution, or at [the Free Software Foundation][10]. + +[9]: https://github.com/WayneD/rsync/blob/master/COPYING +[10]: https://www.fsf.org/licenses/gpl.html |