From 9ef53907149a591ec9302a929d0fa319f348b8d9 Mon Sep 17 00:00:00 2001 From: David Dykstra Date: Wed, 10 Feb 1999 19:33:05 +0000 Subject: [PATCH] Changed Usage in the rsync --help message to indicate how there can be multiple SRCs. Also moved the --suffix option to show up right after --backup and included the default backup suffix and block size along with their corresponding options rather than at the end. Copied the new help message to rsync.yo and README and used the Usage also in the SYNOPSIS section at the top of rsync.yo rather than the different one that used "path" instead of SRC and DEST. That last change was inspired by a suggestion from Michael Bleyer in PR #1523. --- README | 18 ++++++++++++------ options.c | 17 +++++++++-------- rsync.yo | 41 ++++++++++++++++++++++------------------- 3 files changed, 43 insertions(+), 33 deletions(-) diff --git a/README b/README index 3d26e703..5dac7ce2 100644 --- a/README +++ b/README @@ -22,20 +22,25 @@ 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 @@ -50,7 +55,7 @@ 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 @@ -67,7 +72,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,9 +79,11 @@ 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 ----- diff --git a/options.c b/options.c index 99356177..ed01a673 100644 --- a/options.c +++ b/options.c @@ -83,12 +83,15 @@ void usage(int F) rprintf(F,"rsync is a file transfer program capable of efficient remote update\nvia a fast differencing algorithm.\n\n"); - rprintf(F,"Usage: rsync [OPTION]... SRC [USER@]HOST:DEST\n"); + rprintf(F,"Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST\n"); rprintf(F," or rsync [OPTION]... [USER@]HOST:SRC DEST\n"); - rprintf(F," or rsync [OPTION]... SRC DEST\n"); + rprintf(F," or rsync [OPTION]... SRC [SRC]... DEST\n"); rprintf(F," or rsync [OPTION]... [USER@]HOST::SRC [DEST]\n"); - rprintf(F," or rsync [OPTION]... SRC [USER@]HOST::DEST\n"); + rprintf(F," or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST\n"); rprintf(F," or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]\n"); + rprintf(F,"SRC on single-colon remote HOST will be expanded by remote shell\n"); + rprintf(F,"SRC on server remote HOST may contain shell wildcards or multiple\n"); + rprintf(F," sources separated by space as long as they have same top-level\n"); rprintf(F,"\nOptions\n"); rprintf(F," -v, --verbose increase verbosity\n"); rprintf(F," -q, --quiet decrease verbosity\n"); @@ -96,7 +99,8 @@ void usage(int F) rprintf(F," -a, --archive archive mode\n"); rprintf(F," -r, --recursive recurse into directories\n"); rprintf(F," -R, --relative use relative path names\n"); - rprintf(F," -b, --backup make backups (default ~ extension)\n"); + rprintf(F," -b, --backup make backups (default %s suffix)\n",BACKUP_SUFFIX); + rprintf(F," --suffix=SUFFIX override backup suffix\n"); rprintf(F," -u, --update update only (don't overwrite newer files)\n"); rprintf(F," -l, --links preserve soft links\n"); rprintf(F," -L, --copy-links treat soft links like regular files\n"); @@ -111,7 +115,7 @@ void usage(int F) rprintf(F," -n, --dry-run show what would have been transferred\n"); rprintf(F," -W, --whole-file copy whole files, no incremental checks\n"); rprintf(F," -x, --one-file-system don't cross filesystem boundaries\n"); - rprintf(F," -B, --block-size=SIZE checksum blocking size\n"); + rprintf(F," -B, --block-size=SIZE checksum blocking size (default %d)\n",BLOCK_SIZE); rprintf(F," -e, --rsh=COMMAND specify rsh replacement\n"); rprintf(F," --rsync-path=PATH specify path to rsync on the remote machine\n"); rprintf(F," -C, --cvs-exclude auto ignore files in the same way CVS does\n"); @@ -128,7 +132,6 @@ void usage(int F) rprintf(F," --exclude-from=FILE exclude patterns listed in FILE\n"); rprintf(F," --include=PATTERN don't exclude files matching PATTERN\n"); rprintf(F," --include-from=FILE don't exclude patterns listed in FILE\n"); - rprintf(F," --suffix=SUFFIX override backup suffix\n"); rprintf(F," --version print version number\n"); rprintf(F," --daemon run as a rsync daemon\n"); rprintf(F," --config=FILE specify alternate rsyncd.conf file\n"); @@ -140,8 +143,6 @@ void usage(int F) rprintf(F," -h, --help show this help screen\n"); rprintf(F,"\n"); - rprintf(F,"the backup suffix defaults to %s\n",BACKUP_SUFFIX); - rprintf(F,"the block size defaults to %d\n",BLOCK_SIZE); rprintf(F,"\nPlease see the rsync(1) and rsyncd.conf(5) man pages for full documentation\n"); rprintf(F,"See http://rsync.samba.org/ for updates and bug reports\n"); diff --git a/rsync.yo b/rsync.yo index 90599d79..d33052ff 100644 --- a/rsync.yo +++ b/rsync.yo @@ -1,19 +1,19 @@ mailto(rsync-bugs@samba.org) -manpage(rsync)(1)(9 Feb 1999)()() +manpage(rsync)(1)(10 Feb 1999)()() manpagename(rsync)(faster, flexible replacement for rcp) manpagesynopsis() -rsync [options] [user@]host:path path +rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST -rsync [options] path [user@]host:path +rsync [OPTION]... [USER@]HOST:SRC DEST -rsync [options] path path +rsync [OPTION]... SRC [SRC]... DEST -rsync [options] [user@]host::module[/path] path +rsync [OPTION]... [USER@]HOST::SRC [DEST] -rsync [options] path [user@]host::module[/path] +rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST -rsync [options] rsync://[user@]host[:port]/module/path path +rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST] manpagedescription() @@ -211,12 +211,15 @@ Here is a short summary of the options available in rsync. Please refer to the detailed description below for a complete description. verb( -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 @@ -225,7 +228,8 @@ Options -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 @@ -240,7 +244,7 @@ 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 @@ -254,18 +258,17 @@ Options --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 files listed in FILE + --exclude-from=FILE exclude patterns listed in FILE --include=PATTERN don't exclude files matching PATTERN - --include-from=FILE don't exclude files listed in FILE - --suffix=SUFFIX override backup suffix + --include-from=FILE don't exclude patterns listed in FILE --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 - --password-file=FILE get password from FILE --log-format=FORMAT log file transfers using specified format + --password-file=FILE get password from FILE -h, --help show this help screen ) @@ -332,6 +335,9 @@ dit(bf(-b, --backup)) With this option preexisting destination files are renamed with a ~ extension as each file is transferred. You can control the backup suffix using the --suffix option. +dit(bf(--suffix SUFFIX)) This option allows you to override the default +backup suffix used with the -b option. The default is a ~. + dit(bf(-u, --update)) This forces rsync to skip any files for which the destination file already exists and has a date later than the source file. @@ -495,9 +501,6 @@ files listed in the CVSIGNORE environment variable (space delimited). Finally in each directory any files listed in the .cvsignore file in that directory are added to the list. -dit(bf(--suffix SUFFIX)) This option allows you to override the default -backup suffix used with the -b option. The default is a ~. - dit(bf(--csum-length LENGTH)) By default the primary checksum used in rsync is a very strong 16 byte MD4 checksum. In most cases you will find that a truncated version of this checksum is quite efficient, and -- 2.34.1