X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/dcc3a131d1bc8ce90517153edad9e5ffc99c6b64..b35d0d8e9ae9c5407c9f781b545f8a66b9caa9d0:/README diff --git a/README b/README index 3d26e703..c6c818e1 100644 --- a/README +++ b/README @@ -22,23 +22,29 @@ Basically you use rsync just like rcp, but rsync has many additional options. Here is a brief description of rsync usage: -Usage: rsync [OPTION]... SRC [USER@]HOST:DEST +Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST or rsync [OPTION]... [USER@]HOST:SRC DEST - or rsync [OPTION]... SRC DEST + or rsync [OPTION]... SRC [SRC]... DEST or rsync [OPTION]... [USER@]HOST::SRC [DEST] - or rsync [OPTION]... SRC [USER@]HOST::DEST + or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST] +SRC on single-colon remote HOST will be expanded by remote shell +SRC on server remote HOST may contain shell wildcards or multiple + sources separated by space as long as they have same top-level Options -v, --verbose increase verbosity + -q, --quiet decrease verbosity -c, --checksum always checksum -a, --archive archive mode -r, --recursive recurse into directories -R, --relative use relative path names - -b, --backup make backups (default ~ extension) + -b, --backup make backups (default ~ suffix) + --suffix=SUFFIX override backup suffix -u, --update update only (don't overwrite newer files) -l, --links preserve soft links -L, --copy-links treat soft links like regular files + --copy-unsafe-links copy links outside the source tree --safe-links ignore links outside the destination tree -H, --hard-links preserve hard links -p, --perms preserve permissions @@ -50,16 +56,18 @@ Options -n, --dry-run show what would have been transferred -W, --whole-file copy whole files, no incremental checks -x, --one-file-system don't cross filesystem boundaries - -B, --block-size=SIZE checksum blocking size + -B, --block-size=SIZE checksum blocking size (default 700) -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 + --delete-excluded also delete excluded files on the receiving side --partial keep partially transferred files --force force deletion of directories even if not empty --numeric-ids don't map uid/gid values by user/group name --timeout=TIME set IO timeout in seconds -I, --ignore-times don't exclude files that match length and time + --size-only only use file size when determining if a file should be transferred -T --temp-dir=DIR create temporary files in directory DIR --compare-dest=DIR also compare destination files relative to DIR -z, --compress compress file data @@ -67,7 +75,6 @@ Options --exclude-from=FILE exclude patterns listed in FILE --include=PATTERN don't exclude files matching PATTERN --include-from=FILE don't exclude patterns listed in FILE - --suffix=SUFFIX override backup suffix --version print version number --daemon run as a rsync daemon --config=FILE specify alternate rsyncd.conf file @@ -75,17 +82,22 @@ Options --stats give some file transfer stats --progress show progress during transfer --log-format=FORMAT log file transfers using specified format + --password-file=FILE get password from FILE -h, --help show this help screen + SETUP ----- -Rsync uses rsh or ssh for communication. It does not need to be setuid -and requires no special privileges 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 rsh or ssh for communication. It does not need to +be setuid and requires no special privileges for installation. You +must, however, have a working rsh or ssh 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 @@ -116,8 +128,7 @@ 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. -To join the mailing list send mail to listproc@samba.org with -no subject and a body of "subscribe rsync Your Name". +To join the mailing list see the web page at http://lists.samba.org/ To send mail to everyone on the list send it to rsync@samba.org @@ -132,9 +143,7 @@ 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. -If you don't have web access then mail bug reports to -rsync-bugs@samba.org or (if you think it will be of interest to lots -of people) send it to rsync@samba.org +If you don't have web access then mail bug reports to rsync@samba.org. CVS TREE @@ -144,22 +153,24 @@ If you want to get the very latest version of rsync direct from the source code repository then you can use anonymous cvs. You will need a recent version of cvs then use the following commands: - cvs -d :pserver:cvs@cvs.samba.org:/cvsroot login + cvs -d :pserver:cvs@pserver.samba.org:/cvsroot login Password: cvs - cvs -d :pserver:cvs@cvs.samba.org:/cvsroot co rsync + cvs -d :pserver:cvs@pserver.samba.org:/cvsroot co rsync -Look at the cvs documentation for more details. +Look at the cvs documentation, or http://samba.org/cvs.html, for more +details. COPYRIGHT --------- -Rsync was written by Andrew Tridgell and Paul Mackerras, and is -available under the Gnu Public License. +rsync was originally written by Andrew Tridgell and has been improved +by many developers 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 in this distribution, or at -tridge@samba.org -paulus@cs.anu.edu.au + http://www.fsf.org/licenses/gpl.html AVAILABILITY