Added more local-network IPs to the "hosts allow" rsyncd config
[rsync/rsync.git] / rsync.yo
index fa404e5..7991332 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -219,6 +219,21 @@ environment variable RSYNC_PROXY to a hostname:port pair pointing to
 your web proxy.  Note that your web proxy's configuration must support
 proxy connections to port 873.
 
+You may also establish a daemon connection using a program as a proxy by
+setting the environment variable RSYNC_CONNECT_PROG to the commands you
+wish to run in place of making a direct socket connection.  The string may
+contain the escape "%H" to represent the hostname specified in the rsync
+command (so use "%%" if you need a single "%" in your string).  For
+example:
+
+verb(  export RSYNC_CONNECT_PROG='ssh proxyhost nc %H 873'
+  rsync -av targethost1::module/src/ /dest/
+  rsync -av rsync:://targethost2/module/src/ /dest/ )
+
+The command specifed above uses ssh to run nc (netcat) on a proxyhost,
+which forwards all data to port 873 (the rsync daemon) on the targethost
+(%H).
+
 manpagesection(USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION)
 
 It is sometimes useful to use various features of an rsync daemon (such as
@@ -318,6 +333,7 @@ to the detailed description below for a complete description.  verb(
  -u, --update                skip files that are newer on the receiver
      --inplace               update destination files in-place
      --append                append data onto shorter files
+     --append-verify         --append w/old data in file cheksum
  -d, --dirs                  transfer directories without recursing
  -l, --links                 copy symlinks as symlinks
  -L, --copy-links            transform symlink into referent file/dir
@@ -555,19 +571,21 @@ Beginning with rsync 3.0.0, the recursive algorithm used is now an
 incremental scan that uses much less memory than before and begins the
 transfer after the scanning of the first few directories have been
 completed.  This incremental scan only affects our recursion algorithm, and
-does not change a non-recursive transfer.
-It is also only possible when both ends of the
-transfer are at least version 3.0.0.
+does not change a non-recursive transfer.  It is also only possible when
+both ends of the transfer are at least version 3.0.0.
 
 Some options require rsync to know the full file list, so these options
 disable the incremental recursion mode.  These include: bf(--delete-before),
-bf(--delete-after), bf(--prune-empty-dirs), bf(--delay-updates), and bf(--hard-links).
+bf(--delete-after), bf(--prune-empty-dirs), and bf(--delay-updates).
 Because of this, the default delete mode when you specify bf(--delete) is now
 bf(--delete-during) when both ends of the connection are at least 3.0.0
 (use bf(--del) or bf(--delete-during) to request this improved deletion mode
 explicitly).  See also the bf(--delete-delay) option that is a better choice
 than using bf(--delete-after).
 
+Incremental recursion can be disabled using the bf(--no-inc-recursive)
+option or its shorter bf(--no-ir) alias.
+
 dit(bf(-R, --relative)) Use relative paths. This means that the full path
 names specified on the command line are sent to the server rather than
 just the last parts of the filenames. This is particularly useful when
@@ -701,13 +719,22 @@ receiving user.
 dit(bf(--append)) This causes rsync to update a file by appending data onto
 the end of the file, which presumes that the data that already exists on
 the receiving side is identical with the start of the file on the sending
-side.  If that is not true, the file will fail the checksum test, and the
-resend will do a normal bf(--inplace) update to correct the mismatched data.
-Only files on the receiving side that are shorter than the corresponding
-file on the sending side (as well as new files) are transferred.
-Implies bf(--inplace), but does not conflict with bf(--sparse) (though the
-bf(--sparse) option will be auto-disabled if a resend of the already-existing
-data is required).
+side.  Any files that are the same size or shorter on the receiving size
+are skipped.  Files that do not yet exist on the receiving side are also
+sent, since they are considered to have 0 length.  Implies bf(--inplace),
+but does not conflict with bf(--sparse) (since it is always extending a
+file's length).
+
+dit(bf(--append-verify)) This works just like the bf(--append) option, but
+the existing data on the receiving side is included in the full-file
+checksum verification step, which will cause a file to be resent if the
+final verification step fails (rsync uses a normal, non-appending
+bf(--inplace) transfer for the resend).
+
+Note: prior to rsync 3.0.0, the bf(--append) option worked like
+bf(--append-verify), so if you are interacting with an older rsync (or the
+transfer is using a protocol prior to 30), specifying either append option
+will initiate an bf(--append-verify) transfer.
 
 dit(bf(-d, --dirs)) Tell the sending side to include any directories that
 are encountered.  Unlike bf(--recursive), a directory's contents are not copied
@@ -775,6 +802,12 @@ as though they were separate files.
 Note that rsync can only detect hard links if both parts of the link
 are in the list of files being sent.
 
+If incremental recursion is active (see bf(--recursive)), rsync may transfer
+a missing hard-linked file before it finds that another link for the file
+exists elsewhere in the hierarchy.  This does not affect the accuracy of
+the transfer, just its efficiency.  One way to avoid this is to disable
+incremental recursion using the bf(--no-ir) option.
+
 dit(bf(-p, --perms)) This option causes the receiving rsync to set the
 destination permissions to be the same as the source permissions.  (See
 also the bf(--chmod) option for a way to modify what rsync considers to
@@ -1934,6 +1967,10 @@ when creating sockets.  This only affects sockets that rsync has direct
 control over, such as the outgoing socket when directly contacting an
 rsync daemon.  See also these options in the bf(--daemon) mode section.
 
+If rsync was complied without support for IPv6, the bf(--ipv6) option
+will have no effect.  The bf(--version) output will tell you if this
+is the case.
+
 dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer
 NUM.  This 4 byte checksum seed is included in each block and file
 MD4 checksum calculation.  By default the checksum seed is generated
@@ -2016,6 +2053,10 @@ versions of Linux to work around an IPv6 bug in the kernel (if you see
 an "address already in use" error when nothing else is using the port,
 try specifying bf(--ipv6) or bf(--ipv4) when starting the daemon).
 
+If rsync was complied without support for IPv6, the bf(--ipv6) option
+will have no effect.  The bf(--version) output will tell you if this
+is the case.
+
 dit(bf(-h, --help)) When specified after bf(--daemon), print a short help
 page describing the options available for starting an rsync daemon.
 enddit()
@@ -2719,7 +2760,7 @@ values
 
 see also the comments on the bf(--delete) option
 
-Please report bugs! See the website at
+Please report bugs! See the web site at
 url(http://rsync.samba.org/)(http://rsync.samba.org/)
 
 manpagesection(VERSION)