Update the README file to reflect current usage options.
authorDavid Dykstra <dwd@samba.org>
Tue, 24 Nov 1998 20:54:56 +0000 (20:54 +0000)
committerDavid Dykstra <dwd@samba.org>
Tue, 24 Nov 1998 20:54:56 +0000 (20:54 +0000)
README

diff --git a/README b/README
index e037f517dad7d3f3ce008dd1649f392ac8b19796..3d26e7030b889c9001a02ebc74b9c57c0931b8af 100644 (file)
--- a/README
+++ b/README
@@ -20,46 +20,62 @@ USAGE
 
 Basically you use rsync just like rcp, but rsync has many additional options.
 
-Here is a brief description of available options:
-
-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
--L, --copy-links         treat soft links like regular files
--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
--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
--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
-    --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
--T  --temp-dir DIR       create temporary files in directory DIR
--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
-    --daemon             run as a rsync daemon
-    --config FILE        specify alternate rsyncd.conf file
-    --port PORT          specify alternate rsyncd port number
+Here is a brief description of rsync usage:
+
+Usage: rsync [OPTION]... SRC [USER@]HOST:DEST
+  or   rsync [OPTION]... [USER@]HOST:SRC DEST
+  or   rsync [OPTION]... SRC DEST
+  or   rsync [OPTION]... [USER@]HOST::SRC [DEST]
+  or   rsync [OPTION]... SRC [USER@]HOST::DEST
+  or   rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
+
+Options
+ -v, --verbose               increase 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)
+ -u, --update                update only (don't overwrite newer files)
+ -l, --links                 preserve soft links
+ -L, --copy-links            treat soft links like regular files
+     --safe-links            ignore links outside the destination tree
+ -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
+ -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
+ -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
+     --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
+ -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
+     --exclude=PATTERN       exclude files matching PATTERN
+     --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
+     --port=PORT             specify alternate rsyncd port number
+     --stats                 give some file transfer stats
+     --progress              show progress during transfer
+     --log-format=FORMAT     log file transfers using specified format
+ -h, --help                  show this help screen
 
 
 SETUP