X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/e92338c82deba1576d23f22e11d95b0b34432e08..794f2cbab329127272a3f0aca96098618144f5d2:/README diff --git a/README b/README index ddf17bb2..9007a25b 100644 --- a/README +++ b/README @@ -1,118 +1,140 @@ WHAT IS RSYNC? -------------- -rsync is a replacement for rcp that has many more features. +Rsync is a fast and extraordinarily versatile file copying tool for +both remote and local files. -rsync uses the "rsync algorithm" which provides a very fast method for -bringing remote files into sync. It does this by sending just the +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. +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. +A technical report describing the rsync algorithm is included with this +package. USAGE ----- -Basically you use rsync just like rcp, but rsync has many additional options. - -Here is a brief description of available options: - --v, --verbose increase verbosity --c, --checksum always checksum --a, --archive archive mode (same as -rlptDog) --r, --recursive recurse into directories --R, --relative use relative path names --b, --backup make backups (default ~ extension) --u, --update update only (don't overwrite newer files) --l, --links preserve soft links --H, --hard-links preserve hard links --p, --perms preserve permissions --o, --owner preserve owner (root only) --g, --group preserve group --D, --devices preserve devices (root only) --t, --times preserve times --S, --sparse handle sparse files efficiently --n, --dry-run show what would have been transferred --x, --one-file-system don't cross filesystem boundaries --B, --block-size SIZE checksum blocking size --e, --rsh COMMAND specify rsh replacement - --rsync-path PATH specify path to rsync on the remote machine --C, --cvs-exclude auto ignore files in the same way CVS does - --delete delete files that don't exist on the sending side --I, --ignore-times don't exclude files that match length and time --z, --compress compress file data - --exclude FILE exclude file FILE - --exclude-from FILE exclude files listed in FILE - --suffix SUFFIX override backup suffix - --version print version number +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 for more detailed information. SETUP ----- -Rsync uses rsh or ssh for communication. It does not need to be setuid -and requires no special privilages for installation. It does not -require a inetd entry or a daemon. You must, however, have a working -rsh or ssh system. Using ssh is recommended for its security -features. +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". -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! +remote systems (or use "make install"). That's it! -MAILING LIST ------------- +RSYNC DAEMONS +------------- + +Rsync can also talk to "rsync daemons" which can provide anonymous or +authenticated rsync. See the rsyncd.conf(5) man page for details on how +to setup an rsync daemon. See the rsync(1) man page for info on how to +connect to an rsync daemon. + -There is a mailing list for the discussion of rsync and its -applications. It is open to anyone to join. I will announce new -versions on this list. +WEB SITE +-------- -To join the mailing list send mail to listproc@samba.anu.edu.au with -no subject and a body of "subscribe rsync Your Name". +The main rsync web site is here: -To send mail to everyone on the list send it to rsync@samba.anu.edu.au + http://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 for full +details: + + http://rsync.samba.org/lists.html BUG REPORTS ----------- -If you have web access then please look at -http://samba.anu.edu.au/cgi-bin/rsync +To visit this web page for full the details on bug reporting: + + http://rsync.samba.org/bugzilla.html -This will give you access to the bug tracking system used by the -developers of rsync and will allow you to look at other bug reports or -submit a new bug report. +That page contains links to the current bug list, and information on how +to report a bug well. You might also like to try searching the Internet +for the error message you've received, or looking in the mailing list +archives at: -If you don't have web access then mail bug reports to -rsync-bugs@samba.anu.edu.au or (if you think it will be of interest to -lots of people) send it to rsync@samba.anu.edu.au + http://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 can use git: + + git clone git://git.samba.org/rsync.git + +See the download page for full details on all the ways to grab the +source, including nightly tar files, web-browsing of the git repository, +etc.: + + http://rsync.samba.org/download.html COPYRIGHT --------- -Rsync was written by Andrew Tridgell and Paul Mackerras, and is -available under the GPL. +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. -Andrew.Tridgell@anu.edu.au -paulus@cs.anu.edu.au +Rsync may be used, modified and redistributed only under the terms of +the GNU General Public License, found in the file COPYING in this +distribution, or at: + + http://www.fsf.org/licenses/gpl.html AVAILABILITY ------------ -The main ftp site for rsync is ftp://samba.anu.edu.au/pub/rsync - -Mirrors are available at: - -ftp://sunsite.auc.dk/pub/unix/rsync -ftp://ftp.sunet.se/pub/unix/admin/rsync +The main web site for rsync is http://rsync.samba.org/ +The main ftp site is ftp://rsync.samba.org/pub/rsync/ +This is also available as rsync://rsync.samba.org/rsyncftp/