Fixed a bug in the hard-linking of a group of fifos/devices in a

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index 2c88967..e7fd8fa 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -372,7 +372,7 @@ to the detailed description below for a complete description.  verb(
      --port=PORT             specify double-colon alternate port number
      --blocking-io           use blocking I/O for the remote shell
      --stats                 give some file-transfer stats
      --port=PORT             specify double-colon alternate port number
      --blocking-io           use blocking I/O for the remote shell
      --stats                 give some file-transfer stats

- -m, --human-readable        output numbers in a human-readable format
+ -h, --human-readable        output numbers in a human-readable format

      --si                    like human-readable, but use powers of 1000
      --progress              show progress during transfer
  -P                          same as --partial --progress
      --si                    like human-readable, but use powers of 1000
      --progress              show progress during transfer
  -P                          same as --partial --progress


@@ -389,7 +389,7 @@ to the detailed description below for a complete description.  verb(
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6
      --version               print version number
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6
      --version               print version number

- -h, --help                  show this help screen)
+     --help                  show this help screen)

 
 Rsync can also be run as a daemon, in which case the following options are
 accepted: verb(
 
 Rsync can also be run as a daemon, in which case the following options are
 accepted: verb(


@@ -402,7 +402,7 @@ accepted: verb(
  -v, --verbose               increase verbosity
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6
  -v, --verbose               increase verbosity
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6

- -h, --help                  show this help screen)
+     --help                  show this help screen)

 
 manpageoptions()
 
 
 manpageoptions()
 


@@ -413,8 +413,10 @@ The '=' for options that take a parameter is optional; whitespace
 can be used instead.
 
 startdit()
 can be used instead.
 
 startdit()

-dit(bf(-h, --help)) Print a short help page describing the options
-available in rsync.
+dit(bf(--help)) Print a short help page describing the options
+available in rsync and exit.  For backward-compatibility with older
+versions of rsync, the same help output can also be requested by using
+the bf(-h) option without any other args.

 
 dit(bf(--version)) print the rsync version number and exit.
 
 
 dit(bf(--version)) print the rsync version number and exit.
 


@@ -851,9 +853,18 @@ running rsync daemon on the remote host.  See the section "USING
 RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" above.
 
 Command-line arguments are permitted in COMMAND provided that COMMAND is
 RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" above.
 
 Command-line arguments are permitted in COMMAND provided that COMMAND is

-presented to rsync as a single argument.  For example:
+presented to rsync as a single argument.  You must use spaces (not tabs
+or other whitespace) to separate the command and args from each other,
+and you can use single- and/or double-quotes to preserve spaces in an
+argument (but not backslashes).  Note that doubling a single-quote
+inside a single-quoted string gives you a single-quote; likewise for
+double-quotes (though you need to pay attention to which quotes your
+shell is parsing and which quotes rsync is parsing).  Some examples:

 
 

-quote(tt(   -e "ssh -p 2234"))
+quote(
+tt(    -e 'ssh -p 2234')nl()
+tt(    -e 'ssh -o "ProxyCommand nohup ssh firewall nc -w1 %h %p"')nl()
+)

 
 (Note that ssh users can alternately customize site-specific connect
 options in their .ssh/config file.)
 
 (Note that ssh users can alternately customize site-specific connect
 options in their .ssh/config file.)


@@ -1229,7 +1240,7 @@ dit(bf(--stats)) This tells rsync to print a verbose set of statistics
 on the file transfer, allowing you to tell how effective the rsync
 algorithm is for your data.
 
 on the file transfer, allowing you to tell how effective the rsync
 algorithm is for your data.
 

-dit(bf(-m, --human-readable)) Output numbers in a more human-readable format.
+dit(bf(-h, --human-readable)) Output numbers in a more human-readable format.

 Large numbers may be output in larger units, with a K (1024), M (1024*1024),
 or G (1024*1024*1024) suffix.
 
 Large numbers may be output in larger units, with a K (1024), M (1024*1024),
 or G (1024*1024*1024) suffix.
 


@@ -1296,11 +1307,9 @@ updated file into a holding directory until the end of the
 transfer, at which time all the files are renamed into place in rapid
 succession.  This attempts to make the updating of the files a little more
 atomic.  By default the files are placed into a directory named ".~tmp~" in
 transfer, at which time all the files are renamed into place in rapid
 succession.  This attempts to make the updating of the files a little more
 atomic.  By default the files are placed into a directory named ".~tmp~" in

-each file's destination directory, but you can override this by specifying
-the bf(--partial-dir) option.  (Note that RSYNC_PARTIAL_DIR has no effect
-on this value, nor is bf(--partial-dir) considered to be implied for the
-purposes of the daemon-config's "refuse options" setting.)
-Conflicts with bf(--inplace).
+each file's destination directory, but if you've specified the
+bf(--partial-dir) option, that directory will be used instead.
+Conflicts with bf(--inplace) and bf(--append).

 
 This option uses more memory on the receiving side (one bit per file
 transferred) and also requires enough free disk space on the receiving
 
 This option uses more memory on the receiving side (one bit per file
 transferred) and also requires enough free disk space on the receiving