Avoid negotiating a "none" choice by default
[rsync.git] / NEWS.md
blob92ba0406d48beb5a2c960755b981e24cb42b1b8d
1 <a name="3.2.2"></a>
3 # NEWS for rsync 3.2.2 (UNRELEASED)
5 Protocol: 31 (unchanged)
7 ## Changes since 3.2.1:
9 ### BUG FIXES:
11  - Fix installing rsync-ssl script from an alternate build dir.
13  - Apple requires the asm function name to begin with an underscore.
15  - Avoid a test failure in the daemon test when --atimes is disabled.
17 ### ENHANCEMENTS:
19  - Allow the server side to restrict checksum & compression choices via
20    the environment variables.
22  - Simplify how the negotiation environment variables apply to older rsync
23    versions.
25  - Improved the man page a bit more.
27 ------------------------------------------------------------------------------
28 <a name="3.2.1"></a>
30 # NEWS for rsync 3.2.1 (22 Jun 2020)
32 Protocol: 31 (unchanged)
34 ## Changes since 3.2.0:
36 ### BUG FIXES:
38  - Fixed a potential build issue with the MD5 assembly-language code by
39    removing some non-portable directives.
41  - Use the preprocessor with the asm file to ensure that if the code is
42    unneeded, it doesn't get built.
44  - Avoid the stack getting set to executable when including the asm code.
46  - Some improvements in the SIMD configure testing to try to avoid build
47    issues, such as avoiding a clang++ core dump when `-g` is combined with
48    `-O2`.  Note that clang++ is quite buggy in this area, and it does still
49    crash for some folks, so just use `--disable-simd` if you need to avoid
50    their buggy compiler (since the configure test is apparently not finding
51    all the compilers that will to crash and burn).
53  - Fix an issue in the md2man script when building from an external dir.
55  - Disable `--atimes` on macOS (it apparently just ignores the atime change).
57 ### ENHANCEMENTS:
59  - The use of `--backup-dir=STR` now implies `--backup`.
61  - Added `--zl=NUM` as a short-hand for `--compress-level=NUM`.
63  - Added `--early-input=FILE` option that allows the client to send some
64    data to a daemon's (optional) "early exec" script on its stdin.
66  - Mention atimes in the capabilities list that `--version` outputs.
68  - Mention either "default protect-args" or "optional protect-args" in the
69    `--version` capabilities depending on how rsync was configured.
71  - Some info on optimizations is now elided from the `--version` capabilities
72    since they aren't really user-facing capabilities.  You can still see the
73    info (plus the status of a couple extra optimizations) by repeating the
74    `--version` option (e.g. `-VV`).
76  - Updated various URLs to be https instead of http.
78  - Some documentation improvements.
80 ### PACKAGING RELATED:
82  - If you had to use `--disable-simd` for 3.2.0, you might want to try removing
83    that and see if it will succeed or auto-disable.  Some buggy clang++
84    compilers are still not auto disabled, though.
86  - The MD5 asm code is now under its own configure flag (not shared with the
87    SIMD setting), so if you have any issues compiling it, re-run configure with
88    `--disable-asm`.
90  - Merged the OLDNEWS.md file into NEWS.md.
92 ------------------------------------------------------------------------------
93 <a name="3.2.0"></a>
95 # NEWS for rsync 3.2.0 (19 Jun 2020)
97 Protocol: 31 (unchanged)
99 ## Changes since 3.1.3:
101 ### BUG FIXES:
103  - Avoid a potential out-of-bounds read in daemon mode if argc can be made to
104    become 0.
106  - Fix the default list of skip-compress files for non-daemon transfers.
108  - Fix xattr filter rules losing an 'x' attribute in a non-local transfer.
110  - Avoid an error when a check for a potential fuzzy file happens to reference
111    a directory.
113  - Make the atomic-rsync helper script have a more consistent error-exit.
115  - Make sure that a signal handler's use of exit_cleanup() calls `_exit()`
116    instead of exit().
118  - Various zlib fixes, including security fixes for CVE-2016-9843,
119    CVE-2016-9842, CVE-2016-9841, and CVE-2016-9840.
121  - Fixed an issue with `--remove-source-files` not removing a source symlink
122    when combined with `--copy-links`.
124  - Fixed a bug where the daemon would fail to write early fatal error messages
125    to the client, such as refused or unknown command-line options.
127  - Fixed the block-size validation logic when dealing with older protocols.
129  - Some rrsync fixes and enhancements to handle the latest options.
131  - Fixed a problem with the `--link-dest`|`--copy-dest` code when `--xattrs`
132    was specified along with multiple alternate-destination directories (it
133    could possibly choose a bad file match while trying to find a better xattr
134    match).
136  - Fixed a couple bugs in the handling of files with the `--sparse` option.
138  - Fixed a bug in the writing of the batch.sh file (w/`--write-batch`) when the
139    source & destination args were not last on the command-line.
141  - Avoid a hang when an overabundance of messages clogs up all the I/O buffers.
143  - Fixed a mismatch in the RSYNC_PID values put into the environment of
144    `pre-xfer exec` and a `post-xfer exec`.
146  - Fixed a crash in the `--iconv` code.
148  - Fixed a rare crash in the popt_unalias() code.
150 ### ENHANCEMENTS:
152  - Various checksum enhancements, including the optional use of openssl's MD4 &
153    MD5 checksum algorithms, some x86-64 optimizations for the rolling checksum,
154    some x86-64 optimizations for the (non-openssl) MD5 checksum, the addition
155    of xxhash checksum support, and a negotiation heuristic that ensures that it
156    is easier to add new checksum algorithms in the future.  The environment
157    variable `RSYNC_CHECKSUM_LIST` can be used to customize the preference order
158    of the negotiation, or use `--checksum-choice` (`--cc`) to force a choice.
160  - Various compression enhancements, including the addition of zstd and lz4
161    compression algorithms and a negotiation heuristic that picks the best
162    compression option supported by both sides.  The environment variable
163    `RSYNC_COMPRESS_LIST` can be used to customize the preference order of the
164    negotiation, or use `--compress-choice` (`--zc`) to force a choice.
166  - Added a `--debug=NSTR` option that outputs details of the new negotiation
167    strings (for checksums and compression).  The first level just outputs the
168    result of each negotiation on the client, level 2 outputs the values of the
169    strings that were sent to and received from the server, and level 3 outputs
170    all those values on the server side too (when the server was given the debug
171    option).
173  - The `--debug=OPTS` command-line option is no longer auto-forwarded to the
174    remote rsync which allows for the client and server to have different levels
175    of debug specified. This also allows for newer debug options to be
176    specified, such as using `--debug=NSTR` to see the negotiated hash result,
177    without having the command fail if the server version is too old to handle
178    that debug item. Use `-M--debug=OPTS` to send the options to the remote side.
180  - Added the `--atimes` option based on the long-standing patch (just with some
181    fixes that the patch has been needing).
183  - Added `--open-noatime` option to open files using `O_NOATIME`.
185  - Added the `--write-devices` option based on the long-standing patch.
187  - Added openssl & preliminary gnutls support to the rsync-ssl script, which is
188    now installed by default.  This was unified with the old stunnel-rsync
189    helper script to simplify packaging.  Note that the script accepts the use
190    of `--type=gnutls` for gnutls testing, but does not look for gnutls-cli on
191    the path yet.  The use of `--type=gnutls` will not work right until
192    gnutls-cli no longer drops data.
194  - Rsync was enhanced to set the `RSYNC_PORT` environment variable when running
195    a daemon-over-rsh script. Its value is the user-specified port number (set
196    via `--port` or an rsync:// URL) or 0 if the user didn't override the port.
198  - Added the `proxy protocol` daemon parameter that allows your rsyncd to know
199    the real remote IP when it is setup behind a proxy.
201  - Added negated matching to the daemon's `refuse options` setting by using
202    match strings that start with a `!` (such as `!compress*`).  This lets you
203    refuse all options except for a particular approved list, for example.  It
204    also lets rsync refuse certain options by default (such as `write-devices`)
205    while allowing the config to override that, as desired.
207  - Added the `early exec` daemon parameter that runs a script before the
208    transfer parameters are known, allowing some early setup based on module
209    name.
211  - Added status output in response to a signal (via both SIGINFO & SIGVTALRM).
213  - Added `--copy-as=USER` option to give some extra security to root-run rsync
214    commands into/from untrusted directories (such as backups and restores).
216  - When resuming the transfer of a file in the `--partial-dir`, rsync will now
217    update that partial file in-place instead of creating yet another tmp file
218    copy.  This requires both sender & receiver to be at least v3.2.0.
220  - Added support for `RSYNC_SHELL` & `RSYNC_NO_XFER_EXEC` environment variables
221    that affect the early, pre-xfer, and post-xfer exec rsync daemon parameters.
223  - Optimize the `--fuzzy --fuzzy` heuristic to avoid the fuzzy directory scan
224    until all other basis-file options are exhausted (such as `--link-dest`).
226  - Have the daemon log include the normal-exit sent/received stats when the
227    transfer exited with an error when possible (i.e. if it is the sender).
229  - The daemon now locks its pid file (when configured to use one) so that it
230    will not fail to start when the file exists but no daemon is running.
232  - Various man page improvements, including some html representations (that
233    aren't installed by default).
235  - Made `-V` the short option for `--version` and improved its information.
237  - Pass the `-4` or `-6` option to the ssh command, making it easier to type
238    than `--rsh='ssh -4'` (or the `-6` equivalent).
240  - Added example config for rsyncd SSL proxy configs to rsyncd.conf.
242  - More errors messages now mention if the error is coming from the sender or
243    the receiver.
245 ### PACKAGING RELATED:
247  - Add installed binary: /usr/bin/rsync-ssl
249  - Add installed man page: /usr/man/man1/rsync-ssl.1
251  - Tweak auxiliary doc file names, such as: README.md, INSTALL.md, & NEWS.md.
253  - The rsync-ssl script wants to run openssl or stunnel4, so consider adding a
254    dependency for one of those options (though it's probably fine to just let
255    it complain about being unable to find the program and let the user decide
256    if they want to install one or the other).
258  - If you packaged rsync + rsync-ssl + rsync-ssl-daemon as separate packages,
259    the rsync-ssl package is now gone (rsync-ssl should be considered to be
260    mainstream now that Samba requires SSL for its rsync daemon).
262  - Add _build_ dependency for liblz4-dev, libxxhash-dev, libzstd-dev, and
263    libssl-dev.  These development libraries will give rsync extra compression
264    algorithms, extra checksum algorithms, and allow use of openssl's crypto
265    lib for (potentially) faster MD4/MD5 checksums.
267  - Add _build_ dependency for g++ or clang++ on x86_64 systems to enable the
268    SIMD checksum optimizations.
270  - Add _build_ dependency for _either_ python3-cmarkcfm or python3-commonmark
271    to allow for patching of man pages or building a git release.  This is not
272    required for a release-tar build, since it comes with pre-built man pages.
273    Note that cmarkcfm is faster than commonmark, but they generate the same
274    data.  The commonmark dependency is easiest to install since it's native
275    python, and can even be installed via `pip3 install --user commonmark` if
276    you want to just install it for the build user.
278  - Remove yodl _build_ dependency (if it was even listed before).
280 ### DEVELOPER RELATED:
282  - Silenced some annoying warnings about major() & minor() by improving an
283    autoconf include-file check.
285  - Converted the man pages from yodl to markdown. They are now processed via a
286    simple python3 script using the cmarkgfm **or** commonmark library.  This
287    should make it easier to package rsync, since yodl has gotten obscure.
289  - Improved some configure checks to work better with strict C99 compilers.
291  - Some perl building/packaging scripts were recoded into awk and python3.
293  - Some defines in byteorder.h were changed into static inline functions that
294    will help to ensure that the args don't get evaluated multiple times on
295    "careful alignment" hosts.
297  - Some code typos were fixed (as pointed out by a Fossies run).
299 ------------------------------------------------------------------------------
300 <a name="3.1.3"></a>
302 # NEWS for rsync 3.1.3 (28 Jan 2018)
304 Protocol: 31 (unchanged)
306 ## Changes since 3.1.2:
308 ### SECURITY FIXES:
310  - Fixed a buffer overrun in the protocol's handling of xattr names and ensure
311    that the received name is null terminated.
313  - Fix an issue with `--protect-args` where the user could specify the arg in the
314    protected-arg list and short-circuit some of the arg-sanitizing code.
316 ### BUG FIXES:
318  - Don't output about a new backup dir without appropriate info verbosity.
320  - Fixed some issues with the sort functions in support/rsyncstats script.
322  - Added a way to specify daemon config lists (e.g. users, groups, etc) that
323    contain spaces (see `auth users` in the latest rsyncd.conf manpage).
325  - If a backup fails (e.g. full disk) rsync exits with an error.
327  - Fixed a problem with a doubled `--fuzzy` option combined with `--link-dest`.
329  - Avoid invalid output in the summary if either the start or end time had an
330    error.
332  - We don't allow a popt alias to affect the `--daemon` or `--server` options.
334  - Fix daemon exclude code to disallow attribute changes in addition to
335    disallowing transfers.
337  - Don't force nanoseconds to match if a non-transferred, non-checksummed file
338    only passed the quick-check w/o comparing nanosecods.
340 ### ENHANCEMENTS:
342  - Added the ability for rsync to compare nanosecond times in its file-check
343    comparisons, and added support nanosecond times on Mac OS X.
345  - Added a short-option (`-@`) for `--modify-window`.
347  - Added the `--checksum-choice=NAME[,NAME]` option to choose the checksum
348    algorithms.
350  - Added hashing of xattr names (with using `-X`) to improve the handling of
351    files with large numbers of xattrs.
353  - Added a way to filter xattr names using include/exclude/filter rules (see
354    the `--xattrs` option in the manpage for details).
356  - Added `daemon chroot|uid|gid` to the daemon config (in addition to the old
357    chroot|uid|gid settings that affect the daemon's transfer process).
359  - Added `syslog tag` to the daemon configuration.
361  - Some manpage improvements.
363 ### DEVELOPER RELATED:
365  - Tweak the `make` output when yodl isn't around to create the man pages.
367  - Changed an obsolete autoconf compile macro.
369  - Support newer yodl versions when converting man pages.
371 ------------------------------------------------------------------------------
372 <a name="3.1.2"></a>
374 # NEWS for rsync 3.1.2 (21 Dec 2015)
376 Protocol: 31 (unchanged)
378 ## Changes since 3.1.1:
380 ### SECURITY FIXES:
382  - Make sure that all transferred files use only path names from inside the
383    transfer. This makes it impossible for a malicious sender to try to make the
384    receiver use an unsafe destination path for a transferred file, such as a
385    just-sent symlink.
387 ### BUG FIXES:
389  - Change the checksum seed order in the per-block checksums. This prevents
390    someone from trying to create checksum blocks that match in sum but not
391    content.
393  - Fixed a with the per-dir filter files (using `-FF`) that could trigger an
394    assert failure.
396  - Only skip `set_modtime()` on a transferred file if the time is exactly
397    right.
399  - Don't create an empty backup dir for a transferred file that doesn't exist
400    yet.
402  - Fixed a bug where `--link-dest` and `--xattrs` could cause rsync to exit if
403    a filename had a matching dir of the same name in the alt-dest area.
405  - Allow more than 32 group IDs per user in the daemon's gid=LIST config.
407  - Fix the logging of %b & %c via `--log-file` (daemon logging was already
408    correct, as was `--out-format='%b/%c'`).
410  - Fix erroneous acceptance of `--info=5` & `--debug=5` (an empty flag name is
411    not valid).
413 ### ENHANCEMENTS:
415  - Added `(DRY RUN)` info to the `--debug=exit` output line.
417  - Use usleep() for our msleep() function if it is available.
419  - Added a few extra long-option names to rrsync script, which will make
420    BackupPC happier.
422  - Made configure choose to use linux xattrs on netbsd (rather than not
423    supporting xattrs).
425  - Added `-wo` (write-only) option to rrsync support script.
427  - Misc. manpage tweaks.
429 ### DEVELOPER RELATED:
431  - Fixed a bug with the Makefile's use of `INSTALL_STRIP`.
433  - Improve a test in the suite that could get an erroneous timestamp error.
435  - Tweaks for newer versions of git in the packaging tools.
437  - Improved the m4 generation rules and some autoconf idioms.
439 ------------------------------------------------------------------------------
440 <a name="3.1.1"></a>
442 # NEWS for rsync 3.1.1 (22 Jun 2014)
444 Protocol: 31 (unchanged)
446 ## Changes since 3.1.0:
448 ### BUG FIXES:
450  - If the receiver gets bogus filenames from the sender (an unexpected leading
451    slash or a `..` infix dir), exit with an error. This prevents a malicious
452    sender from trying to inject filenames that would affect an area outside the
453    destination directories.
455  - Fixed a failure to remove the partial-transfer temp file when interrupted
456    (and rsync is not saving the partial files).
458  - Changed the chown/group/xattr-set order to avoid losing some security-
459    related xattr info (that would get cleared by a chown).
461  - Fixed a bug in the xattr-finding code that could make a non-root-run
462    receiver not able to find some xattr numbers.
464  - Fixed a bug in the early daemon protocol where a timeout failed to be
465    honored (e.g. if the remote side fails to send us the initial protocol
466    greeting).
468  - Fixed unintended inclusion of commas in file numbers in the daemon log.
470  - We once again send the 'f' sub-flag (of `-e`) to the server side so it knows
471    that we can handle incremental-recursion directory errors properly in older
472    protocols.
474  - Fixed an issue with too-aggressive keep-alive messages causing a problem for
475    older rsync versions early in the transfer.
477  - Fixed an incorrect message about backup-directory-creation when using
478    `--dry-run` and the backup dir is not an absolute path.
480  - Fixed a bug where a failed deletion and/or a failed sender-side removal
481    would not affect the exit code.
483  - Fixed a bug that caused a failure when combining `--delete-missing-args`
484    with `--xattrs` and/or `--acls`.
486  - Fixed a strange `dir_depth` assertion error that was caused by empty-dir
487    removals and/or duplicate files in the transfer.
489  - Fixed a problem with `--info=progress2`'s output stats where rsync would
490    only update the stats at the end of each file's transfer. It now uses the
491    data that is flowing for the current file, making the stats more accurate
492    and less jumpy.
494  - Fixed an itemize bug that affected the combo of `--link-dest`, `-X`, and
495    `-n`.
497  - Fixed a problem with delete messages not appearing in the log file when the
498    user didn't use `--verbose`.
500  - Improve chunked xattr reading for OS X.
502  - Removed an attempted hard-link xattr optimization that was causing a
503    transfer failure. This removal is flagged in the compatibility code, so if a
504    better fix can be discovered, we have a way to flip it on again.
506  - Fixed a bug when the receiver is not configured to be able to hard link
507    symlimks/devices/special-file items but the sender sent some of these items
508    flagged as hard-linked.
510  - We now generate a better error if the buffer overflows in `do_mknod()`.
512  - Fixed a problem reading more than 16 ACLs on some OSes.
514  - Fixed the reading of the secrets file to avoid an infinite wait when the
515    username is missing.
517  - Fixed a parsing problem in the `--usermap`/`--groupmap` options when using
518    MIN-MAX numbers.
520  - Switched Cygwin back to using socketpair `pipes` to try to speed it up.
522  - Added knowledge of a few new options to rrsync.
524 ### ENHANCEMENTS:
526  - Tweaked the temp-file naming when `--temp-dir=DIR` is used: the temp-file
527    names will not get a '.' prepended.
529  - Added support for a new-compression idiom that does not compress all the
530    matching data in a transfer. This can help rsync to use less cpu when a
531    transfer has a lot of matching data, and also makes rsync compatible with a
532    non-bundled zlib. See the `--new-compress` and `--old-compress` options in
533    the manpage.
535  - Added the support/rsync-no-vanished wrapper script.
537  - Made configure more prominently mention when we failed to find yodl (in case
538    the user wants to be able to generate manpages from `*.yo` files).
540  - Have manpage mention how a daemon's max-verbosity setting affects info and
541    debug options. Also added more clarification on backslash removals for
542    excludes that contain wildcards.
544  - Have configure check if for the attr lib (for getxattr) for those systems
545    that need to link against it explicitly.
547  - Change the early dir-creation logic to only use that idiom in an
548    inc-recursive copy that is preserving directory times. e.g. using
549    `--omit-dir-times` will avoid these early directories being created.
551  - Fix a bug in `cmp_time()` that would return a wrong result if the 2 times
552    differed by an amount greater than what a `time_t` can hold.
554 ### DEVELOPER RELATED:
556  - We now include an example systemd file (in packaging/systemd).
558  - Tweaked configure to make sure that any intended use of the included popt
559    and/or zlib code is put early in the CFLAGS.
561 ------------------------------------------------------------------------------
562 <a name="3.1.0"></a>
564 # NEWS for rsync 3.1.0 (28 Sep 2013)
566 Protocol: 31 (changed)
568 ## Changes since 3.0.9:
570 ### OUTPUT CHANGES:
572  - Output numbers in 3-digit groups by default (e.g. 1,234,567). See the
573    `--human-readable` option for a way to turn it off. See also the daemon's
574    `log format` parameter and related command-line options (including
575    `--out-format`) for a modifier that can be used to request digit-grouping or
576    human-readable output in log escapes. (Note that log output is unchanged by
577    default.)
579  - The `--list-only` option is now affected by the `--human-readable` setting.
580    It will display digit groupings by default, and unit suffixes if higher
581    levels of readability are requested. Also, the column width for the size
582    output has increased from 11 to 14 characters when human readability is
583    enabled. Use `--no-h` to get the old-style output and column size.
585  - The output of the `--progress` option has changed: the string `xfer` was
586    shortened to `xfr`, and the string `to-check` was shortened to `to-chk`,
587    both designed to make room for the (by default) wider display of file size
588    numbers without making the total line-length longer. Also, when incremental
589    recursion is enabled, the string `ir-chk` will be used instead of `to-chk`
590    up until the incremental-recursion scan is done, letting you know that the
591    value to check and the total value will still be increasing as new files are
592    found.
594  - Enhanced the `--stats` output: 1) to mention how many files were created
595    (protocol >= 28), 2) to mention how many files were deleted (a new line for
596    protocol 31, but only output when `--delete` is in effect), and 3) to follow
597    the file-count, created-count, and deleted-count with a subcount list that
598    shows the counts by type. The wording of the transferred count has also
599    changed so that it is clearer that it is only a count of regular files.
601 ### BUG FIXES:
603  - Fixed a bug in the iconv code when EINVAL or EILSEQ is returned with a full
604    output buffer.
606  - Fixed some rare bugs in `--iconv` processing that might cause a multibyte
607    character to get translated incorrectly.
609  - Fixed a bogus `vanished file` error if some files were specified with `./`
610    prefixes and others were not.
612  - Fixed a bug in `--sparse` where an extra gap could get inserted after a
613    partial write.
615  - Changed the way `--progress` overwrites its prior output in order to make it
616    nearly impossible for the progress to get overwritten by an error.
618  - Improved the propagation of abnormal-exit error messages. This should help
619    the client side to receive errors from the server when it is exiting
620    abnormally, and should also avoid dying with an `connection unexpectedly
621    closed` exit when the closed connection is really expected.
623  - The sender now checks each file it plans to remove to ensure that it hasn't
624    changed from the first stat's info. This helps to avoid losing file data
625    when the user is not using the option in a safe manner.
627  - Fixed a data-duplication bug in the compress option that made compression
628    less efficient. This improves protocol 31 onward, while behaving in a
629    compatible (buggy) manner with older rsync protocols.
631  - When creating a temp-file, rsync is now a bit smarter about it dot-char
632    choices, which can fix a problem on OS X with names that start with `..`.
634  - Rsync now sets a cleanup flag for `--inplace` and `--append` transfers that
635    will flush the write buffer if the transfer aborts. This ensures that more
636    received data gets written out to the disk on an aborted transfer (which is
637    quite helpful on a slow, flaky connection).
639  - The reads that `map_ptr()` now does are aligned on 1K boundaries. This helps
640    some filesystems and/or files that don't like unaligned reads.
642  - Fix an issue in the msleep() function if time jumps backwards.
644  - Fix daemon-server module-name splitting bug where an arg would get split
645    even if `--protect-args` was used.
647 ### ENHANCEMENTS:
649  - Added the `--remote-option=OPT` (`-M OPT`) command-line option that is
650    useful for things like sending a remote `--log-file=FILE` or `--fake-super`
651    option.
653  - Added the `--info=FLAGS` and `--debug=FLAGS` options to allow finer-grained
654    control over what is output. Added an extra type of `--progress` output
655    using `--info=progress2`.
657  - The `--msgs2stderr` option can help with debugging rsync by allowing the
658    debug messages to get output to stderr rather than travel via the socket
659    protocol.
661  - Added the `--delete-missing-args` and `--ignore-missing-args` options to
662    either delete or ignore user-specified files on the receiver that are
663    missing on the sender (normally the absence of user-specified files
664    generates an error).
666  - Added a `T` (terabyte) category to the `--human-readable` size suffixes.
668  - Added the `--usermap`/`--groupmap`/`--chown` options for manipulating file
669    ownership during the copy.
671  - Added the `%C` escape to the log-output handling, which will output the MD5
672    checksum of any transferred file, or all files if `--checksum` was specified
673    (when protocol 30 or above is in effect).
675  - Added the `reverse lookup` parameter to the rsync daemon config file to
676    allow reverse-DNS lookups to be disabled.
678  - Added a forward-DNS lookup for the daemon's hosts allow/deny config. Can be
679    disabled via `forward lookup` parameter (defaults to enabled).
681  - Added a way for more than one group to be specified in the daemon's config
682    file, including a way to specify that you want all of the specified user's
683    groups without having to name them. Also changed the daemon to complain
684    about an inability to set explicitly-specified uid/gid values, even when not
685    run by a super-user.
687  - The daemon now tries to send the user the error messages from the pre-xfer
688    exec script when it fails.
690  - Improved the use of alt-dest options into an existing hierarchy of files: If
691    a match is found in an alt-dir, it takes precedence over an existing file.
692    (We'll need to wait for a future version before attribute-changes on
693    otherwise unchanged files are safe when using an existing hierarchy.)
695  - Added per-user authorization options and group-authorization support to the
696    daemon's `auth users` parameter.
698  - Added a way to reference environment variables in a daemon's config file
699    (using %VAR% references).
701  - When replacing a non-dir with a symlink/hard-link/device/special-file, the
702    update should now be done in an atomic manner.
704  - Avoid re-sending xattr info for hard-linked files w/the same xattrs
705    (protocol 31).
707  - The backup code was improved to use better logic maintaining the backup
708    directory hierarchy. Also, when a file is being backed up, rsync tries to
709    hard-link it into place so that the upcoming replacement of the destination
710    file will be atomic (for the normal, non-inplace logic).
712  - Added the ability to synchronize nano-second modified times.
714  - Added a few more default suffixes for the `dont compress` settings.
716  - Added the checking of the `RSYNC_PROTECT_ARGS` environment variable to allow
717    the default for the `--protect-args` command-line option to be overridden.
719  - Added the `--preallocate` command-line option.
721  - Allow `--password-file=-` to read the password from stdin (filename `-`).
723  - Rsync now comes packaged with an rsync-ssl helper script that can be used to
724    contact a remote rsync daemon using a piped-stunnel command.  It also
725    includes an stunnel config file to run the server side to support ssl daemon
726    connections. See the packaging/lsb/rsync.spec file for one way to package
727    the resulting files. (Suggestions for how to make this even easier to
728    install & use are welcomed.)
730  - Improved the speed of some `--inplace` updates when there are lots of
731    identical checksum blocks that end up being unusable.
733  - Added the `--outbuf=N|L|B` option for choosing the output buffering.
735  - Repeating the `--fuzzy` option now causes the code to look for fuzzy matches
736    inside alt-dest directories too.
738  - The `--chmod` option now supports numeric modes, e.g. `--chmod=644,D755`
740  - Added some Solaris xattr code.
742  - Made an rsync daemon (the listening process) exit with a 0 status when it
743    was signaled to die. This helps launchd.
745  - Improved the `RSYNC_*` environment variables for the pre-xfer exec script:
746    when a daemon is sent multiple request args, they are now joined into a
747    single return value (separated by spaces) so that the `RSYNC_REQUEST`
748    environment variable is accurate for any `pre-xfer exec`. The values in
749    `RSYNC_ARG#` vars are no longer truncated at the `.` arg (prior to the
750    request dirs/files), so that all the requested values are also listed
751    (separately) in `RSYNC_ARG#` variables.
753 ### EXTRAS:
755  - Added an `instant-rsyncd` script to the support directory, which makes it
756    easy to configure a simple rsync daemon in the current directory.
758  - Added the `mapfrom` and `mapto` scripts to the support directory, which
759    makes it easier to do user/group mapping in a local transfer based on
760    passwd/group files from another machine.
762  - There's a new, improved version of the lsh script in the support dir: it's
763    written in perl and supports `-u` without resorting to using sudo (when run
764    as root). The old shell version is now named lsh.sh.
766  - There is a helper script named rsync-slash-strip in the support directory
767    for anyone that wants to change the way rsync handles args with trailing
768    slashes. (e.g. arg/ would get stripped to arg while arg/. would turn into
769    arg/).
771 ### INTERNAL:
773  - The I/O code was rewritten to be simpler and do bigger buffered reads over
774    the socket. The I/O between the receiver and the generator was changed to be
775    standard multiplexed-I/O (like that over the socket).
777  - The sender tries to use any dead time while the generator is looking for
778    files to transfer in order to do sender-side directory scanning in a more
779    parallel manner.
781  - A daemon can now inform a client about a daemon-configured timeout value so
782    that the client can assist in the keep-alive activity (protocol 31).
784  - The filter code received some refactoring to make it more extendible, to
785    read better, and do better sanity checking.
787  - Really big numbers are now output using our own big-num routine rather than
788    casting them to a double and using a %.0f conversion.
790  - The `pool_alloc` library has received some minor improvements in alignment
791    handling.
793  - Added `init_stat_x()` function to avoid duplication of acl/xattr init code.
795  - The included zlib was upgraded from 1.2.3 to 1.2.8.
797  - Rsync can now be compiled to use an unmodified zlib library instead of the
798    tweaked one that is included with rsync. This will eventually become the
799    default, at which point we'll start the countdown to removing the included
800    zlib. Until then, feel free to configure using:
802    ./configure `--with-included-zlib=no`
804 ### DEVELOPER RELATED:
806  - Added more conditional debug output.
808  - Fixed some build issues for android and minix.
810 ------------------------------------------------------------------------------
811 <a name="3.0.9"></a>
813 # NEWS for rsync 3.0.9 (23 Sep 2011)
815 Protocol: 30 (unchanged)
817 ## Changes since 3.0.8:
819 ### BUG FIXES:
821  - Fix a crash bug in checksum scanning when `--inplace` is used.
823  - Fix a hang if a hard-linked file cannot be opened by the sender (e.g.  if it
824    has no read permission).
826  - Fix preservation of a symlink's system xattrs (e.g. selinux) on Linux.
828  - Fix a memory leak in the xattr code.
830  - Fixed a bug with `--delete-excluded` when a filter merge file has a rule
831    that specifies a receiver-only side restriction.
833  - Fix a bug with the modifying of unwritable directories.
835  - Fix `--fake-super`'s interaction with `--link-dest` same-file comparisons.
837  - Fix the updating of the `curr_dir` buffer to avoid a duplicate slash.
839  - Fix the directory permissions on an implied dot-dir when using `--relative`
840    (e.g. /outside/path/././send/path).
842  - Fixed some too-long sleeping instances when using `--bwlimit`.
844  - Fixed when symlink ownership difference-checking gets compiled into
845    `unchanged_attrs()`.
847  - Improved the socket-error reporting when multiple protocols fail.
849  - Fixed a case where a socket error could reference just-freed memory.
851  - Failing to use a password file that was specified on the command-line is now
852    a fatal error.
854  - Fix the non-root updating of directories that don't have the read and/or
855    execute permission.
857  - Make daemon-excluded file errors more error-like.
859  - Fix a compilation issue on older C compilers (due to a misplaced var
860    declaration).
862  - Make configure avoid finding socketpair on cygwin.
864  - Avoid trying to reference `SO_BROADCAST` if the OS doesn't support it.
866  - Fix some issues with the post-processing of the man pages.
868  - Fixed the user home-dir handling in the support/lsh script.
870  - Some minor manpage improvements.
872 ------------------------------------------------------------------------------
873 <a name="3.0.8"></a>
875 # NEWS for rsync 3.0.8 (26 Mar 2011)
877 Protocol: 30 (unchanged)
879 ## Changes since 3.0.7:
881 ### BUG FIXES:
883  - Fixed two buffer-overflow issues: one where a directory path that is exactly
884    MAXPATHLEN was not handled correctly, and one handling a `--backup-dir` that
885    is extra extra large.
887  - Fixed a data-corruption issue when preserving hard-links without preserving
888    file ownership, and doing deletions either before or during the transfer
889    (CVE-2011-1097). This fixes some assert errors in the hard-linking code, and
890    some potential failed checksums (via `-c`) that should have matched.
892  - Fixed a potential crash when an rsync daemon has a filter/exclude list and
893    the transfer is using ACLs or xattrs.
895  - Fixed a hang if a really large file is being processed by an rsync that
896    can't handle 64-bit numbers. Rsync will now complain about the file being
897    too big and skip it.
899  - For devices and special files, we now avoid gathering useless ACL and/or
900    xattr information for files that aren't being copied. (The un-copied files
901    are still put into the file list, but there's no need to gather data that is
902    not going to be used.) This ensures that if the user uses `--no-D`, that
903    rsync can't possibly complain about being unable to gather extended
904    information from special files that are in the file list (but not in the
905    transfer).
907  - Properly handle requesting remote filenames that start with a dash. This
908    avoids a potential error where a filename could be interpreted as a (usually
909    invalid) option.
911  - Fixed a bug in the comparing of upper-case letters in file suffixes for
912    `--skip-compress`.
914  - If an rsync daemon has a module configured without a path setting, rsync
915    will now disallow access to that module.
917  - If the destination arg is an empty string, it will be treated as a reference
918    to the current directory (as 2.x used to do).
920  - If rsync was compiled with a newer time-setting function (such as lutimes),
921    rsync will fall-back to an older function (such as utimes) on a system where
922    the newer function is not around. This helps to make the rsync binary more
923    portable in mixed-OS-release situations.
925  - Fixed a batch-file writing bug that would not write out the full set of
926    compatibility flags that the transfer was using. This fixes a potential
927    protocol problem for a batch file that contains a sender-side I/O error: it
928    would have been sent in a way that the batch-reader wasn't expecting.
930  - Some improvements to the hard-linking code to ensure that device-number
931    hashing is working right, and to supply more information if the hard-link
932    code fails.
934  - The `--inplace` code was improved to not search for an impossible checksum
935    position. The quadruple-verbose chunk[N] message will now mention when an
936    inplace chunk was handled by a seek rather than a read+write.
938  - Improved ACL mask handling, e.g. for Solaris.
940  - Fixed a bug that prevented `--numeric-ids` from disabling the translation of
941    user/group IDs for ACLs.
943  - Fixed an issue where an xattr and/or ACL transfer that used an alt-dest
944    option (e.g. `--link-dest`) could output an error trying to itemize the
945    changes against the alt-dest directory's xattr/ACL info but was instead
946    trying to access the not-yet-existing new destination directory.
948  - Improved xattr system-error messages to mention the full path to the file.
950  - The `--link-dest` checking for identical symlinks now avoids considering
951    attribute differences that cannot be changed on the receiver.
953  - Avoid trying to read/write xattrs on certain file types for certain OSes.
954    Improved configure to set `NO_SYMLINK_XATTRS`, `NO_DEVICE_XATTRS`, and/or
955    `NO_SPECIAL_XATTRS` defines in config.h.
957  - Improved the unsafe-symlink errors messages.
959  - Fixed a bug setting xattrs on new files that aren't user writable.
961  - Avoid re-setting xattrs on a hard-linked file w/the same xattrs.
963  - Fixed a bug with `--fake-super` when copying files and dirs that aren't user
964    writable.
966  - Fixed a bug where a sparse file could have its last sparse block turned into
967    a real block when rsync sets the file size (requires ftruncate).
969  - If a temp-file name is too long, rsync now avoids truncating the name in the
970    middle of adjacent high-bit characters. This prevents a potential filename
971    error if the filesystem doesn't allow a name to contain an invalid
972    multi-byte sequence.
974  - If a muli-protocol socket connection fails (i.e., when contacting a daemon),
975    we now report all the failures, not just the last one. This avoids losing a
976    relevant error (e.g. an IPv4 connection-refused error) that happened before
977    the final error (e.g. an IPv6 protocol-not-supported error).
979  - Generate a transfer error if we try to call chown with a `-1` for a uid or a
980    gid (which is not settable).
982  - Fixed the working of `--force` when used with `--one-file-system`.
984  - Fix the popt arg parsing so that an option that doesn't take an arg will
985    reject an attempt to supply one (can configure `--with-included-popt` if
986    your system's popt library doesn't yet have this fix).
988  - A couple minor option tweaks to the support/rrsync script, and also some
989    regex changes that make vim highlighting happier.
991  - Fixed some issues in the support/mnt-excl script.
993  - Various manpage improvements.
995 ### ENHANCEMENTS:
997  - Added `.hg/` to the default cvs excludes (see `-C` & `--cvs-exclude`).
999 ### DEVELOPER RELATED:
1001  - Use lchmod() whenever it is available (not just on symlinks).
1003  - A couple fixes to the `socketpair_tcp()` routine.
1005  - Updated the helper scripts in the packaging subdirectory.
1007  - Renamed configure.in to configure.ac.
1009  - Fixed configure's checking for iconv routines for newer OS X versions.
1011  - Fixed the testsuite/xattrs.test script on OS X.
1013 ------------------------------------------------------------------------------
1014 <a name="3.0.7"></a>
1016 # NEWS for rsync 3.0.7 (31 Dec 2009)
1018 Protocol: 30 (unchanged)
1020 ## Changes since 3.0.6:
1022 ### BUG FIXES:
1024  - Fixed a bogus free when using `--xattrs` with `--backup`.
1026  - Avoid an error when `--dry-run` was trying to stat a prior hard-link file
1027    that hasn't really been created.
1029  - Fixed a problem with `--compress` (`-z`) where the receiving side could
1030    return the error "inflate (token) returned -5".
1032  - Fixed a bug where `--delete-during` could delete in a directory before it
1033    noticed that the sending side sent an I/O error for that directory (both
1034    sides of the transfer must be at least 3.0.7).
1036  - Improved `--skip-compress`'s error handling of bad character-sets and got
1037    rid of a lingering debug fprintf().
1039  - Fixed the daemon's conveyance of `io_error` value from the sender.
1041  - An rsync daemon use seteuid() (when available) if it used setuid().
1043  - Get the permissions right on a `--fake-super` transferred directory that
1044    needs more owner permissions to emulate root behavior.
1046  - An absolute-path filter rule (i.e. with a '/' modifier) no longer loses its
1047    modifier when sending the filter rules to the remote rsync.
1049  - Improved the "--delete does not work without -r or -d" message.
1051  - Improved rsync's handling of `--timeout` to avoid a weird timeout case where
1052    the sender could timeout even though it has recently written data to the
1053    socket (but hasn't read data recently, due to the writing).
1055  - Some misc manpage improvements.
1057  - Fixed the chmod-temp-dir testsuite on a system without /var/tmp.
1059  - Make sure that a timeout specified in the daemon's config is used as a
1060    maximum timeout value when the user also specifies a timeout.
1062  - Improved the error-exit reporting when rsync gets an error trying to cleanup
1063    after an error: the initial error is reported.
1065  - Improved configure's detection of IPv6 for solaris and cygwin.
1067  - The AIX sysacls routines will now return ENOSYS if ENOTSUP is missing.
1069  - Made our (only used if missing) getaddrinfo() routine use `inet_pton()`
1070    (which we also provide) instead of `inet_aton()`.
1072  - The exit-related debug messages now mention the program's role so it is
1073    clear who output what message.
1075 ### DEVELOPER RELATED:
1077  - Got rid of type-punned compiler warnings output by newer gcc versions.
1079  - The Makefile now ensures that proto.h will be rebuilt if config.h changes.
1081  - The testsuite no longer uses `id -u`, so it works better on solaris.
1083 ------------------------------------------------------------------------------
1084 <a name="3.0.6"></a>
1086 # NEWS for rsync 3.0.6 (8 May 2009)
1088 Protocol: 30 (unchanged)
1090 ## Changes since 3.0.5:
1092 ### BUG FIXES:
1094  - Fixed a `--read-batch` hang when rsync is reading a batch file that was
1095    created from an incremental-recursion transfer.
1097  - Fixed the daemon's socket code to handle the simultaneous arrival of
1098    multiple connections.
1100  - Fix `--safe-links`/`--copy-unsafe-links` to properly handle symlinks that
1101    have consecutive slashes in the value.
1103  - Fixed the parsing of an `[IPv6_LITERAL_ADDR]` when a USER@ is prefixed.
1105  - The sender now skips a (bogus) symlink that has a 0-length value, which
1106    avoids a transfer error in the receiver.
1108  - Fixed a case where the sender could die with a tag-0 error if there was an
1109    I/O during the sending of the file list.
1111  - Fixed the rrsync script to avoid a server-side problem when `-e` is at the
1112    start of the short options.
1114  - Fixed a problem where a vanished directory could turn into an exit code 23
1115    instead of the proper exit code 24.
1117  - Fixed the `--iconv` conversion of symlinks when doing a local copy.
1119  - Fixed a problem where `--one-file-system` was not stopping deletions on the
1120    receiving side when a mount-point directory did not match a directory in the
1121    transfer.
1123  - Fixed the dropping of an ACL mask when no named ACL values were present.
1125  - Fixed an ACL/xattr corruption issue where the `--backup` option could cause
1126    rsync to associate the wrong ACL/xattr information with received files.
1128  - Fixed the use of `--xattrs` with `--only-write-batch`.
1130  - Fixed the use of `--dry-run` with `--read-batch`.
1132  - Fixed configure's erroneous use of target.
1134  - Fixed configure's `--disable-debug` option.
1136  - Fixed a run-time issue for systems that can't find `iconv_open()` by adding
1137    the `--disable-iconv-open` configure option.
1139  - Complain and die if the user tries to combine `--remove-source-files` (or
1140    the deprecated `--remove-sent-files`) with `--read-batch`.
1142  - Fixed an failure transferring special files from Solaris to Linux.
1144 ------------------------------------------------------------------------------
1145 <a name="3.0.5"></a>
1147 # NEWS for rsync 3.0.5 (28 Dec 2008)
1149 Protocol: 30 (unchanged)
1151 ## Changes since 3.0.4:
1153 ### BUG FIXES:
1155  - Initialize xattr data in a couple spots in the hlink code, which avoids a
1156    crash when the xattr pointer's memory happens to start out non-zero.  Also
1157    fixed the itemizing of an alt-dest file's xattrs when hard-linking.
1159  - Don't send a bogus `-` option to an older server if there were no short
1160    options specified.
1162  - Fixed skipping of unneeded updates in a batch file when incremental
1163    recursion is active. Added a test for this. Made batch-mode handle `redo`
1164    files properly (and without hanging).
1166  - Fix the %P logfile escape when the daemon logs from inside a chroot.
1168  - Fixed the use of `-s` (`--protect-args`) when used with a remote source or
1169    destination that had an empty path (e.g. `host:`). Also fixed a problem when
1170    `-s` was used when accessing a daemon via a remote-shell.
1172  - Fixed the use of a dot-dir path (e.g. foo/./bar) inside a `--files-from`
1173    file when the root of the transfer isn't the current directory.
1175  - Fixed a bug with `-K --delete` removing symlinks to directories when
1176    incremental recursion is active.
1178  - Fixed a hard to trigger hang when using `--remove-source-files`.
1180  - Got rid of an annoying delay when accessing a daemon via a remote-shell.
1182  - Properly ignore (superfluous) source args on a `--read-batch` command.
1184  - Improved the manpage's description of the `*` wildcard to remove the
1185    confusing `non-empty` qualifier.
1187  - Fixed reverse lookups in the compatibility-library version of getnameinfo().
1189  - Fixed a bug when using `--sparse` on a sparse file that has over 2GB of
1190    consecutive sparse data.
1192  - Avoid a hang when using at least 3 `--verbose` options on a transfer with a
1193    client sender (which includes local copying).
1195  - Fixed a problem with `--delete-delay` reporting an error when it was ready
1196    to remove a directory that was now gone.
1198  - Got rid of a bunch of `warn_unused_result` compiler warnings.
1200  - If an ftruncate() on a received file fails, it now causes a partial-
1201    transfer warning.
1203  - Allow a path with a leading `//` to be preserved (CYGWIN only).
1205 ### ENHANCEMENTS:
1207  - Made the support/atomic-rsync script able to perform a fully atomic update
1208    of the copied hierarchy when the destination is setup using a particular
1209    symlink idiom.
1211 ------------------------------------------------------------------------------
1212 <a name="3.0.4"></a>
1214 # NEWS for rsync 3.0.4 (6 Sep 2008)
1216 Protocol: 30 (unchanged)
1218 ## Changes since 3.0.3:
1220 ### BUG FIXES:
1222  - Fixed a bug in the hard-linking code where it would sometimes try to
1223    allocate 0 bytes of memory (which fails on some OSes, such as AIX).
1225  - Fixed the hard-linking of files from a device that has a device number of 0
1226    (which seems to be a common device number on NetBSD).
1228  - Fixed the handling of a `--partial-dir` that cannot be created. This
1229    particularly impacts the `--delay-updates` option (since the files cannot be
1230    delayed without a partial-dir), and was potentially destructive if the
1231    `--remove-source-files` was also specified.
1233  - Fixed a couple issues in the `--fake-super` handling of xattrs when the
1234    destination files have root-level attributes (e.g. selinux values) that a
1235    non-root copy can't affect.
1237  - Improved the keep-alive check in the generator to fire consistently in
1238    incremental-recursion mode when `--timeout` is enabled.
1240  - The `--iconv` option now converts the content of a symlink too, instead of
1241    leaving it in the wrong character-set (requires 3.0.4 on both sides of the
1242    transfer).
1244  - When using `--iconv`, if a filename fails to convert on the receiving side,
1245    this no longer makes deletions in the root-dir of the transfer fail silently
1246    (the user now gets a warning about deletions being disabled due to IO error
1247    as long as `--ignore-errors` was not specified).
1249  - When using `--iconv`, if a server-side receiver can't convert a filename,
1250    the error message sent back to the client no longer mangles the name with
1251    the wrong charset conversion.
1253  - Fixed a potential alignment issue in the IRIX ACL code when allocating the
1254    initial `struct acl` object. Also, cast mallocs to avoid warnings.
1256  - Changed some errors that were going to stdout to go to stderr.
1258  - Made `human_num()` and `human_dnum()` able to output a negative number
1259    (rather than outputting a cryptic string of punctuation).
1261 ### ENHANCEMENTS:
1263  - Rsync will avoid sending an `-e` option to the server if an older protocol
1264    is requested (and thus the option would not be useful). This lets the user
1265    specify the `--protocol=29` option to access an overly-restrictive server
1266    that is rejecting the protocol-30 use of `-e` to the server.
1268  - Improved the message output for an `RERR_PARTIAL` exit.
1270 ### DEVELOPER RELATED:
1272  - The Makefile will not halt for just a timestamp change on the Makefile or
1273    the configure files, only for actual changes in content.
1275  - Changed some commands in the testsuite's xattrs.test that called `rsync`
1276    instead of `$RSYNC`.
1278  - Enhanced the release scripts to be able to handle a branch release and to do
1279    even more consistency checks on the files.
1281 ------------------------------------------------------------------------------
1282 <a name="3.0.3"></a>
1284 # NEWS for rsync 3.0.3 (29 Jun 2008)
1286 Protocol: 30 (unchanged)
1288 ## Changes since 3.0.2:
1290 ### BUG FIXES:
1292  - Fixed a wildcard matching problem in the daemon when a module has `use
1293    chroot` enabled.
1295  - Fixed a crash bug in the hard-link code.
1297  - Fixed the sending of xattr directory information when the code finds a
1298    `--link-dest` or `--copy-dest` directory with unchanged xattrs -- the
1299    destination directory now gets these unchanged xattrs properly applied.
1301  - Fixed an xattr-sending glitch that could cause an `Internal abbrev` error.
1303  - Fixed the combination of `--xattrs` and `--backup`.
1305  - The generator no longer allows a '.' dir to be excluded by a daemon- exclude
1306    rule.
1308  - Fixed deletion handling when copying a single, empty directory (with no
1309    files) to a differently named, non-existent directory.
1311  - Fixed the conversion of spaces into dashes in the %M log escape.
1313  - Fixed several places in the code that were not returning the right errno
1314    when a function failed.
1316  - Fixed the backing up of a device or special file into a backup dir.
1318  - Moved the setting of the socket options prior to the connect().
1320  - If rsync exits in the middle of a `--progress` output, it now outputs a
1321    newline to help prevent the progress line from being overwritten.
1323  - Fixed a problem with how a destination path with a trailing slash or a
1324    trailing dot-dir was compared against the daemon excludes.
1326  - Fixed the sending of large (size > 16GB) files when talking to an older
1327    rsync (protocols < 30): we now use a compatible block size limit.
1329  - If a file's length is so huge that we overflow a checksum buffer count (i.e.
1330    several hundred TB), warn the user and avoid sending an invalid checksum
1331    struct over the wire.
1333  - If a source arg is excluded, `--relative` no longer adds the excluded arg's
1334    implied dirs to the transfer. This fix also made the exclude check happen in
1335    the better place in the sending code.
1337  - Use the `overflow_exit()` function for overflows, not `out_of_memory()`.
1339  - Improved the code to better handle a system that has only 32-bit file
1340    offsets.
1342 ### ENHANCEMENTS:
1344  - The rsyncd.conf manpage now consistently refers to the parameters in the
1345    daemon config file as `parameters`.
1347  - The description of the `--inplace` option was improved.
1349 ### EXTRAS:
1351  - Added a new script in the support directory, deny-rsync, which allows an
1352    admin to (temporarily) replace the rsync command with a script that sends an
1353    error message to the remote client via the rsync protocol.
1355 ### DEVELOPER RELATED:
1357  - Fixed a testcase failure if the tests are run as root and made some
1358    compatibility improvements.
1360  - Improved the daemon tests, including checking module comments, the listing
1361    of files, and the ensuring that daemon excludes can't affect a dot-dir arg.
1363  - Improved some build rules for those that build in a separate directory from
1364    the source, including better install rules for the man pages, and the fixing
1365    of a proto.h-tstamp rule that could make the binaries get rebuild without
1366    cause.
1368  - Improved the testsuite to work around a problem with some utilities (e.g. cp
1369    -p & touch -r) rounding sub-second timestamps.
1371  - Ensure that the early patches don't cause any generated-file hunks to
1372    bleed-over into patches that follow.
1374 ------------------------------------------------------------------------------
1375 <a name="3.0.2"></a>
1377 # NEWS for rsync 3.0.2 (8 Apr 2008)
1379 Protocol: 30 (unchanged)
1381 ## Changes since 3.0.1:
1383 ### BUG FIXES:
1385  - Fixed a potential buffer overflow in the xattr code.
1387 ### ENHANCEMENTS:
1389  - None.
1391 ### DEVELOPER RELATED:
1393  - The RPM spec file was improved to install more useful files.
1395  - A few developer-oriented scripts were moved from the support dir to the
1396    packaging dir.
1398 ------------------------------------------------------------------------------
1399 <a name="3.0.1"></a>
1401 # NEWS for rsync 3.0.1 (3 Apr 2008)
1403 Protocol: 30 (unchanged)
1405 ## Changes since 3.0.0:
1407 ### NOTABLE CHANGES IN BEHAVIOR:
1409  - Added the 'c'-flag to the itemizing of non-regular files so that the
1410    itemized output doesn't get hidden if there were no attribute changes, and
1411    also so that the itemizing of a `--copy-links` run will distinguish between
1412    copying an identical non-regular file and the creation of a revised version
1413    with a new value (e.g. a changed symlink referent, a new device number,
1414    etc.).
1416 ### BUG FIXES:
1418  - Fixed a crash bug when a single-use rsync daemon (via remote shell) was run
1419    without specifying a `--config=FILE` option.
1421  - Fixed a crash when backing up a directory that has a default ACL.
1423  - Fixed a bug in the handling of xattr values that could cause rsync to not
1424    think that a file's extended attributes are up-to-date.
1426  - Fixed the working of `--fake-super` with `--link-dest` and `--xattrs`.
1428  - Fixed a hang when combining `--dry-run` with `--remove-source-files`.
1430  - Fixed a bug with `--iconv`'s handling of files that cannot be converted: a
1431    failed name can no longer cause a transfer failure.
1433  - Fixed the building of the rounding.h file on systems that need custom
1434    CPPFLAGS to be used. Also improved the error reporting if the building of
1435    rounding.h fails.
1437  - Fixed the use of the `--protect-args` (`-s`) option when talking to a
1438    daemon.
1440  - Fixed the `--ignore-existing` option's protection of files on the receiver
1441    that are non-regular files on the sender (e.g. if a symlink or a dir on the
1442    sender is trying to replace a file on the receiver). The reverse protection
1443    (protecting a dir/symlink/device from being replaced by a file) was already
1444    working.
1446  - Fixed an assert failure if `--hard-links` is combined with an option that
1447    can skip a file in a set of hard-linked files (i.e. `--ignore-existing`,
1448    `--append`, etc.), without skipping all the files in the set.
1450  - Avoid setting the modify time on a directory that already has the right
1451    modify time set. This avoids tweaking the dir's ctime.
1453  - Improved the daemon-exclude handling to do a better job of applying the
1454    exclude rules to path entries. It also sends the user an error just as if
1455    the files were actually missing (instead of silently ignoring the user's
1456    args), and avoids sending the user the filter-action messages for these
1457    non-user-initiated rules.
1459  - Fixed some glitches with the dry-run code's missing-directory handling,
1460    including a problem when combined with `--fuzzy`.
1462  - Fixed some glitches with the skipped-directory handling.
1464  - Fixed the 'T'-flag itemizing of symlinks when `--time` isn't preserved.
1466  - Fixed a glitch in the itemizing of permissions with the `-E` option.
1468  - The `--append` option's restricting of transfers to those that add data no
1469    longer prevents the updating of non-content changes to otherwise up-to- date
1470    files (i.e. those with the same content but differing permissions,
1471    ownership, xattrs, etc.).
1473  - Don't allow `--fake-super` to be specified with `-XX` (double `--xattrs`)
1474    because the options conflict. If a daemon has `fake super` enabled, it
1475    automatically downgrades a `-XX` request to `-X`.
1477  - Fixed a couple bugs in the parsing of daemon-config excludes that could make
1478    a floating exclude rule get treated as matching an absolute path.
1480  - A daemon doesn't try to auto-refuse the `iconv` option if iconv-support
1481    wasn't compiled in to the daemon (avoiding a warning in the logs).
1483  - Fixed the inclusion of per-dir merge files from implied dirs.
1485  - Fixed the support/rrsync script to work with the latest options that rsync
1486    sends (including its flag-specifying use of `-e` to the server).
1488 ### ENHANCEMENTS:
1490  - Added the `--old-dirs` (`--old-d`) option to make it easier for a user to
1491    ask for file-listings with older rsync versions (this is easier than having
1492    to type `-r --exclude='/*/*'` manually).
1494  - When getting an error while asking an older rsync daemon for a file listing,
1495    rsync will try to notice if the error is a rejection of the `--dirs` (`-d`)
1496    option and let the user know how to work around the issue.
1498  - Added a few more `--no-OPTION` overrides.
1500  - Improved the documentation of the `--append` option.
1502  - Improved the documentation of the filter/exclude/include daemon parameters.
1504 ### INTERNAL:
1506  - Fixed a couple minor bugs in the included popt library (ones which I sent to
1507    the official popt project for inclusion in the 1.14 release).
1509  - Fixed a stat() call that should have been `do_stat()` so that the proper
1510    normal/64-bit stat() function gets called. (Was in an area that should not
1511    have caused problems, though.)
1513  - Changed the file-glob code to do a directory scan without using the `glob`
1514    and `glob.h`. This lets us do the globbing with less memory churn, and also
1515    avoid adding daemon-excluded items to the returned args.
1517 ### DEVELOPER RELATED:
1519  - The configure script tries to get the user's compiler to not warn about
1520    unused function parameters if the build is not including one or more of the
1521    ACL/xattrs/iconv features.
1523  - The configure script now has better checks for figuring out if the included
1524    popt code should be used or not.
1526  - Fixed two testsuite glitches: avoid a failure if someone's `cd` command
1527    outputs the current directory when cd-ing to a relative path, and made the
1528    itemized test query how rsync was built to determine if it should expect
1529    hard-linked symlinks or not.
1531  - Updated the testsuite to verify that various bug fixes remain fixed.
1533  - The RPM spec file was updated to have: (1) comments for how to use the
1534    rsync-patch tar file, and (2) an /etc/xinetd.d/rsync file.
1536  - Updated the build scripts to work with a revised FTP directory structure.
1538 ------------------------------------------------------------------------------
1539 <a name="3.0.0"></a>
1541 # NEWS for rsync 3.0.0 (1 Mar 2008)
1543 Protocol: 30 (changed)
1545 ## Changes since 2.6.9:
1547 ### NOTABLE CHANGES IN BEHAVIOR:
1549  - The handling of implied directories when using `--relative` has changed to
1550    send them as directories (e.g. no implied dir is ever sent as a symlink).
1551    This avoids unexpected behavior and should not adversely affect most people.
1552    If you're one of those rare individuals who relied upon having an implied
1553    dir be duplicated as a symlink, you should specify the transfer of the
1554    symlink and the transfer of the referent directory as separate args. (See
1555    also `--keep-dirlinks` and `--no-implied-dirs`.) Also, exclude rules no
1556    longer have a partial effect on implied dirs.
1558  - Requesting a remote file-listing without specifying `-r` (`--recursive`) now
1559    sends the `-d` (`--dirs`) option to the remote rsync rather than sending
1560    `-r` along with an extra exclude of `/*/*`. If the remote rsync does not
1561    understand the `-d` option (i.e. it is 2.6.3 or older), you will need to
1562    either turn off `-d` (`--no-d`), or specify `-r --exclude='/*/*'` manually.
1564  - In `--dry-run` mode, the last line of the verbose summary text is output
1565    with a "(DRY RUN)" suffix to help remind you that no updates were made.
1566    Similarly, `--only-write-batch` outputs `(BATCH ONLY)`.
1568  - A writable rsync daemon with `use chroot` disabled now defaults to a
1569    symlink-munging behavior designed to make symlinks safer while also allowing
1570    absolute symlinks to be stored and retrieved. This also has the effect of
1571    making symlinks unusable while they're in the daemon's hierarchy. See the
1572    daemon's `munge symlinks` parameter for details.
1574  - Starting up an extra copy of an rsync daemon will not clobber the pidfile
1575    for the running daemon -- if the pidfile exists, the new daemon will exit
1576    with an error. This means that your wrapper script that starts the rsync
1577    daemon should be made to handle lock-breaking (if you want any automatic
1578    breaking of locks to be done).
1580 ### BUG FIXES:
1582  - A daemon with `use chroot = no` and excluded items listed in the daemon
1583    config file now properly checks an absolute-path arg specified for these
1584    options: `--compare-dest`, `--link-dest`, `--copy-dest`, `--partial-dir`,
1585    `--backup-dir`, `--temp-dir`, and `--files-from`.
1587  - A daemon can now be told to disable all user- and group-name translation on
1588    a per-module basis. This avoids a potential problem with a writable daemon
1589    module that has `use chroot` enabled -- if precautions weren't taken, a user
1590    could try to add a missing library and get rsync to use it. This makes rsync
1591    safer by default, and more configurable when id- translation is not desired.
1592    See the daemon's `numeric ids` parameter for full details.
1594  - A chroot daemon can now indicate which part of its path should affect the
1595    chroot call, and which part should become an inside-chroot path for the
1596    module. This allows you to have outside-the-transfer paths (such as for
1597    libraries) even when you enable chroot protection. The idiom used in the
1598    rsyncd.conf file is: `path = /chroot/dirs/./dirs/inside`
1600  - If a file's data arrived successfully on the receiving side but the rename
1601    of the temporary file to the destination file failed AND the
1602    `--remove-source-files` (or the deprecated `--remove-sent-files`) option was
1603    specified, rsync no longer erroneously removes the associated source file.
1605  - Fixed the output of `-ii` when combined with one of the `--*-dest` options:
1606    it now itemizes all the items, not just the changed ones.
1608  - Made the output of all file types consistent when using a `--*-dest` option.
1609    Prior versions would output too many creation events for matching items.
1611  - The code that waits for a child pid now handles being interrupted by a
1612    signal. This fixes a problem with the pre-xfer exec function not being able
1613    to get the exit status from the script.
1615  - A negated filter rule (i.e. with a '!' modifier) no longer loses the
1616    negation when sending the filter rules to the remote rsync.
1618  - Fixed a problem with the `--out-format` (aka `--log-format`) option %f: it
1619    no longer outputs superfluous directory info for a non-daemon rsync.
1621  - Fixed a problem with `-vv` (double `--verbose`) and `--stats` when `pushing`
1622    files (which includes local copies). Version 2.6.9 would complete the copy,
1623    but exit with an error when the receiver output its memory stats.
1625  - If `--password-file` is used on a non-daemon transfer, rsync now complains
1626    and exits. This should help users figure out that they can't use this option
1627    to control a remote shell's password prompt.
1629  - Make sure that directory permissions of a newly-created destination
1630    directory are handled right when `--perms` is left off.
1632  - The itemized output of a newly-created destination directory is now output
1633    as a creation event, not a change event.
1635  - Improved `--hard-link` so that more corner cases are handled correctly when
1636    combined with options such as `--link-dest` and/or `--ignore-existing`.
1638  - The `--append` option no longer updates a file that has the same size.
1640  - Fixed a bug when combining `--backup` and `--backup-dir` with `--inplace`:
1641    any missing backup directories are now created.
1643  - Fixed a bug when using `--backup` and `--inplace` with `--whole-file` or
1644    `--read-batch`: backup files are actually created now.
1646  - The daemon pidfile is checked and created sooner in the startup sequence.
1648  - If a daemon module's `path` value is not an absolute pathname, the code now
1649    makes it absolute internally (making it work properly).
1651  - Ensure that a temporary file always has owner-write permission while we are
1652    writing to it. This avoids problems with some network filesystems when
1653    transferring read-only files.
1655  - Any errors output about password-file reading no longer cause an error at
1656    the end of the run about a partial transfer.
1658  - The `--read-batch` option for protocol 30 now ensures that several more
1659    options are set correctly for the current batch file: `--iconv`, `--acls`,
1660    `--xattrs`, `--inplace`, `--append`, and `--append-verify`.
1662  - Using `--only-write-batch` to a daemon receiver now works properly (older
1663    versions would update some files while writing the batch).
1665  - Avoid outputting a "file has vanished" message when the file is a broken
1666    symlink and `--copy-unsafe-links` or `--copy-dirlinks` is used (the code
1667    already handled this for `--copy-links`).
1669  - Fixed the combination of `--only-write-batch` and `--dry-run`.
1671  - Fixed rsync's ability to remove files that are not writable by the file's
1672    owner when rsync is running as the same user.
1674  - When transferring large files, the sender's hashtable of checksums is kept
1675    at a more reasonable state of fullness (no more than 80% full) so that the
1676    scanning of the hashtable will not bog down as the number of blocks
1677    increases.
1679 ### ENHANCEMENTS:
1681  - A new incremental-recursion algorithm is now used when rsync is talking to
1682    another 3.x version. This starts the transfer going more quickly (before all
1683    the files have been found), and requires much less memory.  See the
1684    `--recursive` option in the manpage for some restrictions.
1686  - Lowered memory use in the non-incremental-recursion algorithm for typical
1687    option values (usually saving from 21-29 bytes per file).
1689  - The default `--delete` algorithm is now `--delete-during` when talking to a
1690    3.x rsync. This is a faster scan than using `--delete-before` (which is the
1691    default when talking to older rsync versions), and is compatible with the
1692    new incremental recursion mode.
1694  - Rsync now allows multiple remote-source args to be specified rather than
1695    having to rely on a special space-splitting side-effect of the remote-
1696    shell. Additional remote args must specify the same host or an empty one
1697    (e.g. empty: `:file1` or `::module/file2`). For example, this means that
1698    local use of brace expansion now works: `rsync -av host:dir/{f1,f2} .`
1700  - Added the `--protect-args` (`-s`) option, that tells rsync to send most of
1701    the command-line args at the start of the transfer rather than as args to
1702    the remote-shell command. This protects them from space-splitting, and only
1703    interprets basic wildcard special shell characters (`*?[`).
1705  - Added the `--delete-delay` option, which is a more efficient way to delete
1706    files at the end of the transfer without needing a separate delete pass.
1708  - Added the `--acls` (`-A`) option to preserve Access Control Lists. This is
1709    an improved version of the prior patch that was available, and it even
1710    supports OS X ACLs. If you need to have backward compatibility with old,
1711    ACL-patched versions of rsync, apply the acls.diff file from the patches
1712    dir.
1714  - Added the `--xattrs` (`-X`) option to preserve extended attributes. This is
1715    an improved version of the prior patch that was available, and it even
1716    supports OS X xattrs (which includes their resource fork data). If you need
1717    to have backward compatibility with old, xattr-patched versions of rsync,
1718    apply the xattrs.diff file from the patches dir.
1720  - Added the `--fake-super` option that allows a non-super user to preserve all
1721    attributes of a file by using a special extended-attribute idiom.  It even
1722    supports the storing of foreign ACL data on your backup server.  There is
1723    also an analogous `fake super` parameter for an rsync daemon.
1725  - Added the `--iconv` option, which allows rsync to convert filenames from one
1726    character-set to another during the transfer. The default is to make this
1727    feature available as long as your system has `iconv_open()`.  If compilation
1728    fails, specify `--disable-iconv` to configure, and then rebuild. If you want
1729    rsync to perform character-set conversions by default, you can specify
1730    `--enable-iconv=CONVERT_STRING` with the default value for the `--iconv`
1731    option that you wish to use. For example, `--enable-iconv=.` is a good
1732    choice. See the rsync manpage for an explanation of the `--iconv` option's
1733    settings.
1735  - A new daemon config parameter, `charset`, lets you control the character-
1736    set that is used during an `--iconv` transfer to/from a daemon module. You
1737    can also set your daemon to refuse `no-iconv` if you want to force the
1738    client to use an `--iconv` transfer (requiring an rsync 3.x client).
1740  - Added the `--skip-compress=LIST` option to override the default list of file
1741    suffixes that will not be compressed when using `--compress` (`-z`).
1743  - The daemon's default for `dont compress` was extended to include: `*.7z`
1744    `*.mp[34]` `*.mov` `*.avi` `*.ogg` `*.jpg` `*.jpeg` and the name-matching routine was also
1745    optimized to run more quickly.
1747  - The `--max-delete` option now outputs a warning if it skipped any file
1748    deletions, including a count of how many deletions were skipped. (Older
1749    versions just silently stopped deleting things.)
1751  - You may specify `--max-delete=0` to a 3.0.0 client to request that it warn
1752    about extraneous files without deleting anything. If you're not sure what
1753    version the client is, you can use the less-obvious `--max-delete=-1`, as
1754    both old and new versions will treat that as the same request (though older
1755    versions don't warn).
1757  - The `--hard-link` option now uses less memory on both the sending and
1758    receiving side for all protocol versions. For protocol 30, the use of a
1759    hashtable on the sending side allows us to more efficiently convey to the
1760    receiver what files are linked together. This reduces the amount of data
1761    sent over the socket by a considerable margin (rather than adding more
1762    data), and limits the in-memory storage of the device+inode information to
1763    just the sending side for the new protocol 30, or to the receiving side when
1764    speaking an older protocol (note that older rsync versions kept the
1765    device+inode information on both sides).
1767  - The filter rules now support a perishable (`p`) modifier that marks rules
1768    that should not have an effect in a directory that is being deleted. e.g.
1769    `-f '-p .svn/'` would only affect `live` .svn directories.
1771  - Rsync checks all the alternate-destination args for validity (e.g.
1772    `--link-dest`). This lets the user know when they specified a directory that
1773    does not exist.
1775  - If we get an ENOSYS error setting the time on a symlink, we don't complain
1776    about it anymore (for those systems that even support the setting of the
1777    modify-time on a symlink).
1779  - Protocol 30 now uses MD5 checksums instead of MD4.
1781  - Changed the `--append` option to not checksum the existing data in the
1782    destination file, which speeds up file appending.
1784  - Added the `--append-verify` option, which works like the older `--append`
1785    option (verifying the existing data in the destination file). For
1786    compatibility with older rsync versions, any use of `--append` that is
1787    talking protocol 29 or older will revert to the `--append-verify` method.
1789  - Added the `--contimeout=SECONDS` option that lets the user specify a
1790    connection timeout for rsync daemon access.
1792  - Documented and extended the support for the `RSYNC_CONNECT_PROG` variable
1793    that can be used to enhance the client side of a daemon connection.
1795  - Improved the dashes and double-quotes in the nroff manpage output.
1797  - Rsync now supports a lot more `--no-OPTION` override options.
1799 ### INTERNAL:
1801  - The file-list sorting algorithm now uses a sort that keeps any same- named
1802    items in the same order as they were specified. This allows rsync to always
1803    ensure that the first of the duplicates is the one that will be included in
1804    the copy. The new sort is also faster than the glibc version of qsort() and
1805    mergesort().
1807  - Rsync now supports the transfer of 64-bit timestamps (`time_t` values).
1809  - Made the file-deletion code use a little less stack when recursing through a
1810    directory hierarchy of extraneous files.
1812  - Fixed a build problem with older (2.x) versions of gcc.
1814  - Added some isType() functions that make dealing with signed characters
1815    easier without forcing variables via casts.
1817  - Changed strcat/strcpy/sprintf function calls to use safer versions.
1819  - Upgraded the included popt version to 1.10.2 and improved its use of
1820    string-handling functions.
1822  - Added missing prototypes for compatibility functions from the lib dir.
1824  - Configure determines if iconv() has a const arg, allowing us to avoid a
1825    compiler warning.
1827  - Made the sending of some numbers more efficient for protocol 30.
1829  - Make sure that a daemon process doesn't mind if the client was weird and
1830    omitted the `--server` option.
1832  - There are more internal logging categories available in protocol 30 than the
1833    age-old FINFO and FERROR, including `FERROR_XFER` and FWARN. These new
1834    categories allow some errors and warnings to go to stderr without causing an
1835    erroneous end-of-run warning about some files not being able to be
1836    transferred.
1838  - Improved the use of `const` on pointers.
1840  - Improved J.W.'s `pool_alloc` routines to add a way of incrementally freeing
1841    older sections of a pool's memory.
1843  - The getaddrinfo.c compatibility code in the `lib` dir was replaced with some
1844    new code (derived from samba, derived from PostgreSQL) that has a better
1845    license than the old code.
1847 ### DEVELOPER RELATED:
1849  - Rsync is now licensed under the GPLv3 or later.
1851  - Rsync is now being maintained in a `git` repository instead of CVS (though
1852    the old CVS repository still exists for historical access).  Several
1853    maintenance scripts were updated to work with git.
1855  - Generated files are no longer committed into the source repository. The
1856    autoconf and autoheader commands are now automatically run during the normal
1857    use of `configure` and `make`. The latest dev versions of all generated
1858    files can also be copied from the samba.org web site (see the prepare-source
1859    script's fetch option).
1861  - The `patches` directory of diff files is now built from branches in the
1862    rsync git repository (branch patch/FOO creates file patches/FOO.diff).  This
1863    directory is now distributed in a separate separate tar file named
1864    rsync-patches-VERSION.tar.gz instead of the main rsync-VERSION.tar.gz.
1866  - The proto.h file is now built using a simple perl script rather than a
1867    complex awk script, which proved to be more widely compatible.
1869  - When running the tests, we now put our per-test temp dirs into a sub-
1870    directory named testtmp (which is created, if missing). This allows someone
1871    to symlink the testtmp directory to another filesystem (which is useful if
1872    the build dir's filesystem does not support ACLs and xattrs, but another
1873    filesystem does).
1875  - Rsync now has a way of handling protocol-version changes during the
1876    development of a new protocol version. This causes any out-of-sync versions
1877    to speak an older protocol rather than fail in a cryptic manner.  This
1878    addition makes it safer to deploy a pre-release version that may interact
1879    with the public. This new exchange of sub-version info does not interfere
1880    with the `{MIN,MAX}_PROTOCOL_VERSION` checking algorithm (which does not
1881    have enough range to allow the main protocol number to be incremented for
1882    every minor tweak in that happens during development).
1884  - The csprotocol.txt file was updated to mention the daemon protocol change in
1885    the 3.0.0 release.
1887 ------------------------------------------------------------------------------
1888 <a name="2.6.9"></a>
1890 # NEWS for rsync 2.6.9 (6 Nov 2006)
1892 Protocol: 29 (unchanged)
1894 ## Changes since 2.6.8:
1896 ### BUG FIXES:
1898  - If rsync is interrupted via a handled signal (such as SIGINT), it will once
1899    again clean-up its temp file from the destination dir.
1901  - Fixed an overzealous sanitizing bug in the handling of the `--link-dest`,
1902    `--copy-dest`, and `--compare-dest` options to a daemon without chroot: if
1903    the copy's destination dir is deeper than the top of the module's path,
1904    these options now accept a safe number of parent-dir (../) references (since
1905    these options are relative to the destination dir). The old code incorrectly
1906    chopped off all `../` prefixes for these options, no matter how deep the
1907    destination directory was in the module's hierarchy.
1909  - Fixed a bug where a deferred info/error/log message could get sent directly
1910    to the sender instead of being handled by rwrite() in the generator. This
1911    fixes an `unexpected tag 3` fatal error, and should also fix a potential
1912    problem where a deferred info/error message from the receiver might bypass
1913    the log file and get sent only to the client process. (These problems could
1914    only affect an rsync daemon that was receiving files.)
1916  - Fixed a bug when `--inplace` was combined with a `--*-dest` option and we
1917    update a file's data using an alternate basis file. The code now notices
1918    that it needs to copy the matching data from the basis file instead of
1919    (wrongly) assuming that it was already present in the file.
1921  - Fixed a bug where using `--dry-run` with a `--*-dest` option with a path
1922    relative to a directory that does not yet exist: the affected option gets
1923    its proper path value so that the output of the dry-run is right.
1925  - Fixed a bug in the %f logfile escape when receiving files: the destination
1926    path is now included in the output (e.g. you can now tell when a user
1927    specifies a subdir inside a module).
1929  - If the receiving side fails to create a directory, it will now skip trying
1930    to update everything that is inside that directory.
1932  - If `--link-dest` is specified with `--checksum` but without `--times`, rsync
1933    will now allow a hard-link to be created to a matching link-dest file even
1934    when the file's modify-time doesn't match the server's file.
1936  - The daemon now calls more timezone-using functions prior to doing a chroot.
1937    This should help some C libraries to generate proper timestamps from inside
1938    a chrooted daemon (and to not try to access /etc/timezone over and over
1939    again).
1941  - Fixed a bug in the handling of an absolute `--partial-dir=ABS_PATH` option:
1942    it now deletes an alternate basis file from the partial-dir that was used to
1943    successfully update a destination file.
1945  - Fixed a bug in the handling of `--delete-excluded` when using a per-dir
1946    merge file: the merge file is now honored on the receiving side, and only
1947    its unqualified include/exclude commands are ignored (just as is done for
1948    global include/excludes).
1950  - Fixed a recent bug where `--delete` was not working when transferring from
1951    the root (/) of the filesystem with `--relative` enabled.
1953  - Fixed a recent bug where an `--exclude='*'` could affect the root (/) of the
1954    filesystem with `--relative` enabled.
1956  - When `--inplace` creates a file, it is now created with owner read/write
1957    permissions (0600) instead of no permissions at all. This avoids a problem
1958    continuing a transfer that was interrupted (since `--inplace` will not
1959    update a file that has no write permissions).
1961  - If either `--remove-source-files` or `--remove-sent-files` is enabled and we
1962    are unable to remove the source file, rsync now outputs an error.
1964  - Fixed a bug in the daemon's `incoming chmod` rule: newly-created directories
1965    no longer get the 'F' (file) rules applied to them.
1967  - Fixed an infinite loop bug when a filter rule was rejected due to being
1968    overly long.
1970  - When the server receives a `--partial-dir` option from the client, it no
1971    longer runs the client-side code that adds an assumed filter rule (since the
1972    client will be sending us the rules in the usual manner, and they may have
1973    chosen to override the auto-added rule).
1975 ### ENHANCEMENTS:
1977  - Added the `--log-file=FILE` and `--log-file-format=FORMAT` options. These
1978    can be used to tell any rsync to output what it is doing to a log file.
1979    They work with a client rsync, a non-daemon server rsync (see the man page
1980    for instructions), and also allows the overriding of rsyncd.conf settings
1981    when starting a daemon.
1983  - The `--log-format` option was renamed to be `--out-format` to avoid
1984    confusing it with affecting the log-file output. (The old option remains as
1985    an alias for the new to preserve backward compatibility.)
1987  - Made `log file` and `syslog facility` settable on a per-module basis in the
1988    daemon's config file.
1990  - Added the `--remove-source-files` option as a replacement for the (now
1991    deprecated) `--remove-sent-files` option. This new option removes all
1992    non-dirs from the source directories, even if the file was already
1993    up-to-date. This fixes a problem where interrupting an rsync that was using
1994    `--remove-sent-files` and restarting it could leave behind a file that the
1995    earlier rsync synchronized, but didn't get to remove.  (The deprecated
1996    `--remove-sent-files` is still understood for now, and still behaves in the
1997    same way as before.)
1999  - Added the option `--no-motd` to suppress the message-of-the-day output from
2000    a daemon when doing a copy. (See the manpage for a caveat.)
2002  - Added a new environment variable to the pre-/post-xfer exec commands (in the
2003    daemon's config file): `RSYNC_PID`. This value will be the same in both the
2004    pre- and post-xfer commands, so it can be used as a unique ID if the
2005    pre-xfer command wants to cache some arg/request info for the post-xfer
2006    command.
2008 ### INTERNAL:
2010  - Did a code audit using IBM's code-checker program and made several changes,
2011    including: replacing most of the strcpy() and sprintf() calls with
2012    strlcpy(), snprintf(), and memcpy(), adding a 0-value to an enum that had
2013    been intermingling a literal 0 with the defined enum values, silencing some
2014    uninitialized memory checks, marking some functions with a `noreturn`
2015    attribute, and changing an `if` that could never succeed on some platforms
2016    into a pre-processor directive that conditionally compiles the code.
2018  - Fixed a potential bug in `f_name_cmp()` when both the args are a top-level
2019    `.` dir (which doesn't happen in normal operations).
2021  - Changed `exit_cleanup()` so that it can never return instead of exit.  The
2022    old code might return if it found the `exit_cleanup()` function was being
2023    called recursively. The new code is segmented so that any recursive calls
2024    move on to the next step of the exit-processing.
2026  - The macro WIFEXITED(stat) will now be defined if the OS didn't already
2027    define it.
2029 ### DEVELOPER RELATED:
2031  - The acls.diff and xattrs.diff patches have received a bunch of work to make
2032    them much closer to being acceptable in the main distribution.  The xattrs
2033    patch also has some preliminary Mac OS X and FreeBSD compatibility code that
2034    various system types to exchange extended file-attributes.
2036  - A new diff in the patches dir, fake-root.diff, allows rsync to maintain a
2037    backup hierarchy with full owner, group, and device info without actually
2038    running as root. It does this using a special extended attribute, so it
2039    depends on xattrs.diff (which depends on acls.diff).
2041  - The rsync.yo and rsyncd.conf.yo files have been updated to work better with
2042    the latest yodl 2.x releases.
2044  - Updated config.guess and config.sub to their 2006-07-02 versions.
2046  - Updated various files to include the latest FSF address and to have
2047    consistent opening comments.
2049 ------------------------------------------------------------------------------
2050 <a name="2.6.8"></a>
2052 # NEWS for rsync 2.6.8 (22 Apr 2006)
2054 Protocol: 29 (unchanged)
2056 ## Changes since 2.6.7:
2058 ### BUG FIXES:
2060  - Fixed a bug in the exclude code where an anchored exclude without any
2061    wildcards fails to match an absolute source arg, but only when `--relative`
2062    is in effect.
2064  - Improved the I/O code for the generator to fix a potential hang when the
2065    receiver gets an EOF on the socket but the generator's select() call never
2066    indicates that the socket is writable for it to be notified about the EOF.
2067    (This can happen when using stunnel).
2069  - Fixed a problem with the file-reading code where a failed read (such as that
2070    caused by a bad sector) would not advance the file's read-position beyond
2071    the failed read's data.
2073  - Fixed a logging bug where the `log file` directive was not being honored in
2074    a single-use daemon (one spawned by a remote-shell connection or by init).
2076  - If rsync cannot honor the `--delete` option, we output an error and exit
2077    instead of silently ignoring the option.
2079  - Fixed a bug in the `--link-dest` code that prevented special files (such as
2080    fifos) from being linked.
2082  - The ability to hard-link symlinks and special files is now determined at
2083    configure time instead of at runtime. This fixes a bug with `--link-dest`
2084    creating a hard-link to a symlink's referent on a BSD system.
2086 ### ENHANCEMENTS:
2088  - In daemon mode, if rsync fails to bind to the requested port, the error(s)
2089    returned by socket() and/or bind() are now logged.
2091  - When we output a fatal error, we now output the version of rsync in the
2092    message.
2094  - Improved the documentation for the `--owner` and `--group` options.
2096  - The rsyncstats script in `support` has an improved line-parsing regex that
2097    is easier to read and also makes it to parse syslog-generated lines.
2099  - A new script in `support`: file-attr-restore, can be used to restore the
2100    attributes of a file-set (the permissions, ownership, and group info) taken
2101    from the cached output of a `find ARG... -ls` command.
2103 ### DEVELOPER RELATED:
2105  - Removed the unused function `write_int_named()`, the unused variable
2106    `io_read_phase`, and the rarely used variable `io_write_phase`. This also
2107    elides the confusing 'phase "unknown"' part of one error message.
2109  - Removed two unused configure checks and two related (also unused)
2110    compatibility functions.
2112  - The xattrs.diff patch received a security fix that prevents a potential
2113    buffer overflow in the `receive_xattr()` code.
2115  - The acls.diff patch has been improved quite a bit, with more to come.
2117  - A new patch was added: log-file.diff. This contains an early version of a
2118    future option, `--log-file=FILE`, that will allow any rsync to log its
2119    actions to a file (something that only a daemon supports at present).
2121 ------------------------------------------------------------------------------
2122 <a name="2.6.7"></a>
2124 # NEWS for rsync 2.6.7 (11 Mar 2006)
2126 Protocol: 29 (unchanged)
2128 ## Changes since 2.6.6:
2130 ### OUTPUT CHANGES:
2132  - The letter 'D' in the itemized output was being used for both devices
2133    (character or block) as well as other special files (such as fifos and named
2134    sockets). This has changed to separate non-device special files under the
2135    'S' designation (e.g. `cS+++++++ path/fifo`). See also the `--specials`
2136    option, below.
2138  - The way rsync escapes unreadable characters has changed. First, rsync now
2139    has support for recognizing valid multibyte character sequences in your
2140    current locale, allowing it to escape fewer characters than before for a
2141    locale such as UTF-8. Second, it now uses an escape idiom of `\#123`, which
2142    is the literal string `\#` followed by exactly 3 octal digits. Rsync no
2143    longer doubles a backslash character in a filename (e.g. it used to output
2144    `foo\\bar` when copying `foo\bar`) -- now it only escapes a backslash that
2145    is followed by a hash-sign and 3 digits (0-9) (e.g. it will output
2146    `foo\#134#789` when copying `foo\#789`). See also the `--8-bit-output`
2147    (`-8`) option, mentioned below.
2149    Script writers: the local rsync is the one that outputs escaped names, so if
2150    you need to support unescaping of filenames for older rsyncs, I'd suggest
2151    that you parse the output of `rsync --version` and only use the old
2152    unescaping rules for 2.6.5 and 2.6.6.
2154 ### BUG FIXES:
2156  - Fixed a really old bug that caused `--checksum` (`-c`) to checksum all the
2157    files encountered during the delete scan (ouch).
2159  - Fixed a potential hang in a remote generator: when the receiver gets a
2160    read-error on the socket, it now signals the generator about this so that
2161    the generator does not try to send any of the terminating error messages to
2162    the client (avoiding a potential hang in some setups).
2164  - Made hard-links work with symlinks and devices again.
2166  - If the sender gets an early EOF reading a source file, we propagate this
2167    error to the receiver so that it can discard the file and try requesting it
2168    again (which is the existing behavior for other kinds of read errors).
2170  - If a device-file/special-file changes permissions, rsync now updates the
2171    permissions without recreating the file.
2173  - If the user specifies a remote-host for both the source and destination, we
2174    now output a syntax error rather than trying to open the destination
2175    hostspec as a filename.
2177  - When `--inplace` creates a new destination file, rsync now creates it with
2178    permissions 0600 instead of 0000 -- this makes restarting possible when the
2179    transfer gets interrupted in the middle of sending a new file.
2181  - Reject the combination of `--inplace` and `--sparse` since the sparse-output
2182    algorithm doesn't work when overwriting existing data.
2184  - Fixed the directory name in the error that is output when `pop_dir()` fails.
2186  - Really fixed the parsing of a `!` entry in .cvsignore files this time.
2188  - If the generator gets a stat() error on a file, output it (this used to
2189    require at least `-vv` for the error to be seen).
2191  - If waitpid() fails or the child rsync didn't exit cleanly, we now handle the
2192    exit status properly and generate a better error.
2194  - Fixed some glitches in the double-verbose output when using `--copy-dest`,
2195    `--link-dest`, or `--compare-dest`. Also improved how the verbose output
2196    handles hard-links (within the transfer) that had an up-to-date alternate
2197    `dest` file, and copied files (via `--copy-dest`).
2199  - Fixed the matching of the dont-compress items (e.g. `*.gz`) against files
2200    that have a path component containing a slash.
2202  - If the code reading a filter/exclude file gets an EINTR error, rsync now
2203    clears the error flag on the file handle so it can keep on reading.
2205  - If `--relative` is active, the sending side cleans up trailing `/` or `/.`
2206    suffixes to avoid triggering a bug in older rsync versions. Also, we now
2207    reject a `..` dir if it would be sent as a relative dir.
2209  - If a non-directory is in the way of a directory and rsync is run with
2210    `--dry-run` and `--delete`, rsync no longer complains about not being able
2211    to opendir() the not-yet present directory.
2213  - When `--list-only` is used and a non-existent local destination dir was also
2214    specified as a destination, rsync no longer generates a warning about being
2215    unable to create the missing directory.
2217  - Fixed some problems with `--relative --no-implied-dirs` when the destination
2218    directory did not yet exist: we can now create a symlink or device when it
2219    is the first thing in the missing dir, and `--fuzzy` no longer complains
2220    about being unable to open the missing dir.
2222  - Fixed a bug where the `--copy-links` option would not affect implied
2223    directories without `--copy-unsafe-links` (see `--relative`).
2225  - Got rid of the need for `--force` to be used in some circumstances with
2226    `--delete-after` (making it consistent with
2227    `--delete-before`/`--delete-during`).
2229  - Rsync now ignores the SIGXFSZ signal, just in case your OS sends this when a
2230    file is too large (rsync handles the write error).
2232  - Fixed a bug in the Proxy-Authorization header's base64-encoded value: it was
2233    not properly padded with trailing '=' chars. This only affects a user that
2234    need to use a password-authenticated proxy for an outgoing daemon-rsync
2235    connection.
2237  - If we're transferring an empty directory to a new name, rsync no longer
2238    forces `S_IWUSR` if it wasn't already set, nor does it accidentally leave it
2239    set.
2241  - Fixed a bug in the debug output (`-vvvvv`) that could mention the wrong
2242    checksum for the current file offset.
2244  - Rsync no longer allows a single directory to be copied over a non- directory
2245    destination arg.
2247 ### ENHANCEMENTS:
2249  - Added the `--append` option that makes rsync append data onto files that are
2250    longer on the source than the destination (this includes new files).
2252  - Added the `--min-size=SIZE` option to exclude small files from the transfer.
2254  - Added the `--compress-level` option to allow you to set how aggressive
2255    rsync's compression should be (this option implies `--compress`).
2257  - Enhanced the parsing of the SIZE value for `--min-size` and `--max-size` to
2258    allow easy entry of multiples of 1000 (instead of just multiples of 1024)
2259    and off-by-one values too (e.g. `--max-size=8mb-1`).
2261  - Added the `--8-bit-output` (`-8`) option, which tells rsync to avoid
2262    escaping high-bit characters that it thinks are unreadable in the current
2263    locale.
2265  - The new option `--human-readable` (`-h`) changes the output of `--progress`,
2266    `--stats`, and the end-of-run summary to be easier to read. If repeated, the
2267    units become powers of 1024 instead of powers of 1000. (The old meaning of
2268    `-h`, as a shorthand for `--help`, still works as long as you just use it on
2269    its own, as in `rsync -h`.)
2271  - If lutimes() and/or lchmod() are around, use them to allow the preservation
2272    of attributes on symlinks.
2274  - The `--link-dest` option now affects symlinks and devices (when possible).
2276  - Added two config items to the rsyncd.conf parsing: `pre-xfer exec` and
2277    `post-xfer exec`. These allow a command to be specified on a per-module
2278    basis that will be run before and/or after a daemon-mode transfer. (See the
2279    man page for a list of the environment variables that are set with
2280    information about the transfer.)
2282  - When using the `--relative` option, you can now insert a dot dir in the
2283    source path to indicate where the replication of the source dirs should
2284    start. For example, if you specify a source path of
2285    rsync://host/module/foo/bar/./baz/dir with `-R`, rsync will now only
2286    replicate the `baz/dir` part of the source path (note: a trailing dot dir is
2287    unaffected unless it also has a trailing slash).
2289  - Added some new `--no-FOO` options that make it easier to override unwanted
2290    implied or default options. For example, `-a --no-o` (aka `--archive
2291    --no-owner`) can be used to turn off the preservation of file ownership that
2292    is implied by `-a`.
2294  - Added the `--chmod=MODE` option that allows the destination permissions to
2295    be changed from the source permissions. E.g. `--chmod=g+w,o-rwx`
2297  - Added the `incoming chmod` and `outgoing chmod` daemon options that allow a
2298    module to specify what permissions changes should be applied to all files
2299    copied to and from the daemon.
2301  - Allow the `--temp-dir` option to be specified when starting a daemon, which
2302    sets the default temporary directory for incoming files.
2304  - If `--delete` is combined with `--dirs` without `--recursive`, rsync will
2305    now delete in any directory whose content is being synchronized.
2307  - If `--backup` is combined with `--delete` without `--backup-dir` (and
2308    without `--delete-excluded`), we add a `protect` filter-rule to ensure that
2309    files with the backup suffix are not deleted.
2311  - The file-count stats that are output by `--progress` were improved to better
2312    indicate what the numbers mean. For instance, the output: `(xfer#5,
2313    to-check=8383/9999)` indicates that this was the fifth file to be
2314    transferred, and we still need to check 8383 more files out of a total of
2315    9999.
2317  - The include/exclude code now allows a `dir/***` directive (with 3 trailing
2318    stars) to match both the dir itself as well as all the content below the dir
2319    (`dir/**` would not match the dir).
2321  - Added the `--prune-empty-dirs` (`-m`) option that makes the receiving rsync
2322    discard empty chains of directories from the file-list. This makes it easier
2323    to selectively copy files from a source hierarchy and end up with just the
2324    directories needed to hold the resulting files.
2326  - If the `--itemize-changes` (`-i`) option is repeated, rsync now includes
2327    unchanged files in the itemized output (similar to `-vv`, but without all
2328    the other verbose messages that can get in the way). Of course, the client
2329    must be version 2.6.7 for this to work, but the remote rsync only needs to
2330    be 2.6.7 if you're pushing files.
2332  - Added the `--specials` option to tell rsync to copy non-device special files
2333    (which rsync now attempts even as a normal user). The `--devices` option now
2334    requests the copying of just devices (character and block).  The `-D` option
2335    still requests both (e.g. `--devices` and `--specials`), `-a` still implies
2336    `-D`, and non-root users still get a silent downgrade that omits device
2337    copying.
2339  - Added the `--super` option to make the receiver always attempt super-user
2340    activities. This is useful for systems that allow things such as devices to
2341    be created or ownership to be set without being UID 0, and is also useful
2342    for someone who wants to ensure that errors will be output if the receiving
2343    rsync isn't being run as root.
2345  - Added the `--sockopts` option for those few who want to customize the TCP
2346    options used to contact a daemon rsync.
2348  - Added a way for the `--temp-dir` option to be combined with a partial-dir
2349    setting that lets rsync avoid non-atomic updates (for those times when
2350    `--temp-dir` is not being used because space is tight).
2352  - A new support script, files-to-excludes, will transform a list of files into
2353    a set of include/exclude directives that will copy those files.
2355  - A new option, `--executability` (`-E`) can be used to preserve just the
2356    execute bit on files, for those times when using the `--perms` option is not
2357    desired.
2359  - The daemon now logs each connection and also each module-list request that
2360    it receives.
2362  - New log-format options: %M (modtime), %U (uid), %G (gid), and %B (permission
2363    bits, e.g. `rwxr-xrwt`).
2365  - The `--dry-run` option no longer forces the enabling of `--verbose`.
2367  - The `--remove-sent-files` option now does a better job of incrementally
2368    removing the sent files on the sending side (older versions tended to clump
2369    up all the removals at the end).
2371  - A daemon now supersedes its minimal SIGCHLD handler with the standard
2372    PID-remembering version after forking. This ensures that the generator can
2373    get the child-exit status from the receiver.
2375  - Use of the `--bwlimit` option no longer interferes with the remote rsync
2376    sending error messages about invalid/refused options.
2378  - Rsync no longer returns a usage error when used with one local source arg
2379    and no destination: this now implies the `--list-only` option, just like the
2380    comparable situation with a remote source arg.
2382  - Added the `--copy-dirlinks` option, a more limited version of
2383    `--copy-links`.
2385  - Various documentation improvements, including: a better synopsis, some
2386    improved examples, a better discussion of the presence and absence of
2387    `--perms` (including how it interacts with the new `--executability` and
2388    `--chmod` options), an extended discussion of `--temp-dir`, an improved
2389    discussion of `--partial-dir`, a better description of rsync's pattern
2390    matching characters, an improved `--no-implied-dirs` section, and the
2391    documenting of what the `--stats` option outputs.
2393  - Various new and updated diffs in the patches dir, including: acls.diff,
2394    xattrs.diff, atimes.diff, detect-renamed.diff, and slp.diff.
2396 ### INTERNAL:
2398  - We now use sigaction() and sigprocmask() if possible, and fall back on
2399    signal() if not. Using sigprocmask() ensures that rsync enables all the
2400    signals that it needs, just in case it was started in a masked state.
2402  - Some buffer sizes were expanded a bit, particularly on systems where
2403    MAXPATHLEN is overly small (e.g. cygwin).
2405  - If `io_printf()` tries to format more data than fits in the buffer, exit
2406    with an error instead of transmitting a truncated buffer.
2408  - If a `va_copy` macro is defined, lib/snprintf.c will use it when defining
2409    the `VA_COPY` macro.
2411  - Reduced the amount of stack memory needed for each level of directory
2412    recursion by nearly MAXPATHLEN bytes.
2414  - The wildmatch function was extended to allow an array of strings to be
2415    supplied as the string to match. This allows the exclude code to do less
2416    string copying.
2418  - Got rid of the `safe_fname()` function (and all the myriad calls) and
2419    replaced it with a new function in the log.c code that filters all the
2420    output going to the terminal.
2422  - Unified the `f_name()` and the `f_name_to()` functions.
2424  - Improved the hash-table code the sender uses to handle checksums to make it
2425    use slightly less memory and run just a little faster.
2427 ### DEVELOPER RELATED:
2429  - The diffs in the patches dir now require `patch -p1 <DIFF` instead of the
2430    previous `-p0`. Also, the version included in the release tar now affect
2431    generated files (e.g. configure, rsync.1, proto.h, etc.), so it is no longer
2432    necessary to run autoconf and/or yodl unless you're applying a patch that
2433    was checked out from CVS.
2435  - Several diffs in the patches dir now use the proper `--enable-FOO` configure
2436    option instead of `--with-FOO` to turn on the inclusion of the newly patched
2437    feature.
2439  - There is a new script, `prepare-source` than can be used to update the
2440    various generated files (proto.h, configure, etc.) even before configure has
2441    created the Makefile (this is mainly useful when patching the source with a
2442    patch that doesn't affect generated files).
2444  - The testsuite now sets HOME so that it won't be affected by a file such as
2445    ~/.popt.
2447 ------------------------------------------------------------------------------
2448 <a name="2.6.6"></a>
2450 # NEWS for rsync 2.6.6 (28 Jul 2005)
2452 Protocol: 29 (unchanged)
2454 ## Changes since 2.6.5:
2456 ### SECURITY FIXES:
2458  - The zlib code was upgraded to version 1.2.3 in order to make it more secure.
2459    While the widely-publicized security problem in zlib 1.2.2 did not affect
2460    rsync, another security problem surfaced that affects rsync's zlib 1.1.4.
2462 ### BUG FIXES:
2464  - The setting of `flist->high` in `clean_flist()` was wrong for an empty list.
2465    This could cause `flist_find()` to crash in certain rare circumstances (e.g.
2466    if just the right directory setup was around when `--fuzzy` was combined
2467    with `--link-dest`).
2469  - The outputting of hard-linked files when verbosity was > 1 was not right:
2470    (1) Without `-i` it would output the name of each hard-linked file as though
2471    it had been changed; it now outputs a `is hard linked` message for the file.
2472    (2) With `-i` it would output all dots for the unchanged attributes of a
2473    hard-link; it now changes those dots to spaces, as is done for other totally
2474    unchanged items.
2476  - When backing up a changed symlink or device, get rid of any old backup item
2477    so that we don't get an `already exists` error.
2479  - A couple places that were comparing a local and a remote modification- time
2480    were not honoring the `--modify-window` option.
2482  - Fixed a bug where the 'p' (permissions) itemized-changes flag might get set
2483    too often (if some non-significant mode bits differed).
2485  - Fixed a really old, minor bug that could cause rsync to warn about being
2486    unable to mkdir() a path that ends in `/.` because it just created the
2487    directory (required `--relative`, `--no-implied-dirs`, a source path that
2488    ended in either a trailing slash or a trailing `/.`, and a non-existing
2489    destination dir to tickle the bug in a recent version).
2491 ### ENHANCEMENTS:
2493  - Made the `max verbosity` setting in the rsyncd.conf file settable on a
2494    per-module basis (which now matches the documentation).
2496  - The support/rrsync script has been upgraded to verify the args of options
2497    that take args (instead of rejecting any such options). The script was also
2498    changed to try to be more secure and to fix a problem in the parsing of a
2499    pull operation that has multiple sources.
2501  - Improved the documentation that explains the difference between a normal
2502    daemon transfer and a daemon-over remote-shell transfer.
2504  - Some of the diffs supplied in the patches dir were fixed and/or improved.
2506 ### BUILD CHANGES:
2508  - Made configure define `NOBODY_USER` (currently hard-wired to `nobody`) and
2509    `NOBODY_GROUP` (set to either `nobody` or `nogroup` depending on what we
2510    find in the /etc/group file).
2512  - Added a test to the test suite, itemized.test, that tests the output of `-i`
2513    (log-format w/%i) and some double-verbose messages.
2515 ------------------------------------------------------------------------------
2516 <a name="2.6.5"></a>
2518 # NEWS for rsync 2.6.5 (1 Jun 2005)
2520 Protocol: 29 (unchanged)
2522 ## Changes since 2.6.4:
2524 ### OUTPUT CHANGES:
2526  - Non-printable chars in filenames are now output using backslash- escaped
2527    characters rather than '?'s. Any non-printable character is output using 3
2528    digits of octal (e.g. `\n` -> `\012`), and a backslash is now output as
2529    `\\`. Rsync also uses your locale setting, which can make it treat fewer
2530    high-bit characters as non-printable.
2532  - If rsync received an empty file-list when pulling files, it would output a
2533    `nothing to do` message and exit with a 0 (success) exit status, even if the
2534    remote rsync returned an error (it did not do this under the same conditions
2535    when pushing files). This was changed to make the pulling behavior the same
2536    as the pushing behavior: we now do the normal end-of-run outputting
2537    (depending on options) and exit with the appropriate exit status.
2539 ### BUG FIXES:
2541  - A crash bug was fixed when a daemon had its `path` set to `/`, did not have
2542    chroot enabled, and used some anchored excludes in the rsyncd.conf file.
2544  - Fixed a bug in the transfer of a single file when `-H` is specified (rsync
2545    would either infinite loop or perhaps crash).
2547  - Fixed a case where the generator might try (and fail) to tweak the
2548    write-permissions of a read-only directory in list-only mode (this only
2549    caused an annoying warning message).
2551  - If `--compare-dest` or `--link-dest` uses a locally-copied file as the basis
2552    for an updated version, log this better when `--verbose` or `-i` is in
2553    effect.
2555  - Fixed the accidental disabling of `--backup` during the `--delete-after`
2556    processing.
2558  - Restored the ability to use the `--address` option in client mode (in
2559    addition to its use in daemon mode).
2561  - Make sure that some temporary progress information from the delete
2562    processing does not get left on the screen when it is followed by a newline.
2564  - When `--existing` skips a directory with extra verbosity, refer to it as a
2565    `directory`, not a `file`.
2567  - When transferring a single file to a different-named file, any generator
2568    messages that are source-file related no longer refer to the file by the
2569    destination filename.
2571  - Fixed a bug where hard-linking a group of files might fail if the generator
2572    hasn't created a needed destination directory yet.
2574  - Fixed a bug where a hard-linked group of files that is newly-linked to a
2575    file in a `--link-dest` dir doesn't link the files from the rest of the
2576    cluster.
2578  - When deleting files with the `--one-file-system` (`-x`) option set, rsync no
2579    longer tries to remove files from inside a mount-point on the receiving
2580    side. Also, we don't complain about being unable to remove the mount-point
2581    dir.
2583  - Fixed a compatibility problem when using `--cvs-ignore` (`-C`) and sending
2584    files to an older rsync without using `--delete`.
2586  - Make sure that a `- !` or `+ !` include/exclude pattern does not trigger the
2587    list-clearing action that is reserved for `!`.
2589  - Avoid a timeout in the generator when the sender/receiver aren't handling
2590    the generator's checksum output quickly enough.
2592  - Fixed the omission of some directories in the delete processing when
2593    `--relative` (`-R`) was combined with a source path that had a trailing
2594    slash.
2596  - Fixed a case where rsync would erroneously delete some files and then
2597    re-transfer them when the options `--relative` (`-R`) and `--recursive`
2598    (`-r`) were both enabled (along with `--delete`) and a source path had a
2599    trailing slash.
2601  - Make sure that `--max-size` doesn't affect a device or a symlink.
2603  - Make sure that a system with a really small MAXPATHLEN does not cause the
2604    buffers in `readfd_unbuffered()` to be too small to receive normal messages.
2605    (This mainly affected Cygwin.)
2607  - If a source pathname ends with a filename of `..`, treat it as if `../` had
2608    been specified (so that we don't copy files to the parent dir of the
2609    destination).
2611  - If `--delete` is combined with a file-listing rsync command (i.e. no
2612    transfer is happening), avoid outputting a warning that we couldn't delete
2613    anything.
2615  - If `--stats` is specified with `--delete-after`, ensure that all the
2616    `deleting` messages are output before the statistics.
2618  - Improved one `if` in the deletion code that was only checking errno for
2619    ENOTEMPTY when it should have also been checking for EEXIST (for
2620    compatibility with OS variations).
2622 ### ENHANCEMENTS:
2624  - Added the `--only-write-batch=FILE` option that may be used (instead of
2625    `--write-batch=FILE`) to create a batch file without doing any actual
2626    updating of the destination. This allows you to divert all the file-updating
2627    data away from a slow data link (as long as you are pushing the data to the
2628    remote server when creating the batch).
2630  - When the generator is taking a long time to fill up its output buffer (e.g.
2631    if the transferred files are few, small, or missing), it now periodically
2632    flushes the output buffer so that the sender/receiver can get started on the
2633    files sooner rather than later.
2635  - Improved the keep-alive code to handle a long silence between the sender and
2636    the receiver that can occur when the sender is receiving the checksum data
2637    for a large file.
2639  - Improved the auth-errors that are logged by the daemon to include some
2640    information on why the authorization failed: wrong user, password mismatch,
2641    etc. (The client-visible message is unchanged!)
2643  - Improved the client's handling of an `@ERROR` from a daemon so that it does
2644    not complain about an unexpectedly closed socket (since we really did expect
2645    the socket to close).
2647  - If the daemon can't open the log-file specified in rsyncd.conf, fall back to
2648    using syslog and log an appropriate warning. This is better than what was
2649    typically a totally silent (and fatal) failure (since a daemon is not
2650    usually run with the `--no-detach` option that was necessary to see the
2651    error on stderr).
2653  - The man pages now consistently refer to an rsync daemon as a `daemon`
2654    instead of a `server` (to distinguish it from the server process in a
2655    non-daemon transfer).
2657  - Made a small change to the rrsync script (restricted rsync -- in the support
2658    dir) to make a read-only server reject all `--remove-*` options when sending
2659    files (to future-proof it against the possibility of other similar options
2660    being added at some point).
2662 ### INTERNAL:
2664  - Rsync now calls `setlocale(LC_CTYPE, "")`. This enables isprint() to better
2665    discern which filename characters need to be escaped in messages (which
2666    should result in fewer escaped characters in some locales).
2668  - Improved the naming of the log-file open/reopen/close functions.
2670  - Removed some protocol-compatibility code that was only needed to help
2671    someone running a pre-release of 2.6.4.
2673 ### BUILD CHANGES:
2675  - Added configure option `--disable-locale` to disable any use of setlocale()
2676    in the binary.
2678  - Fixed a bug in the `SUPPORT{,_HARD}_LINKS` #defines which prevented rsync
2679    from being built without symlink or hard-link support.
2681  - Only #define `HAVE_REMSH` if it is going to be set to 1.
2683  - Configure now disables the use of mkstemp() under HP-UX (since they refuse
2684    to fix its broken handling of large files).
2686  - Configure now explicitly checks for the lseek64() function so that the code
2687    can use `HAVE_LSEEK64` instead of inferring lseek64()'s presence based on
2688    the presence of the `off64_t` type.
2690  - Configure no longer mentions the change in the default remote-shell (from
2691    rsh to ssh) that occurred for the 2.6.0 release.
2693  - Some minor enhancements to the test scripts.
2695  - Added a few new `*.diff` files to the patches dir, including a patch that
2696    enables the optional copying of extended attributes.
2698 ------------------------------------------------------------------------------
2699 <a name="2.6.4"></a>
2701 # NEWS for rsync 2.6.4 (30 March 2005)
2703 Protocol: 29 (changed)
2705 ## Changes since 2.6.3:
2707 ### OUTPUT CHANGES:
2709  - When rsync deletes a directory and outputs a verbose message about it, it
2710    now appends a trailing slash to the name instead of (only sometimes)
2711    outputting a preceding "directory " string.
2713  - The `--stats` output will contain file-list time-statistics if both sides
2714    are 2.6.4, or if the local side is 2.6.4 and the files are being pushed
2715    (since the stats come from the sending side).  (Requires protocol 29 for a
2716    pull.)
2718  - The `%o` (operation) log-format escape now has a third value (besides `send`
2719    and `recv`): `del.` (with trailing dot to make it 4 chars).  This changes
2720    the way deletions are logged in the daemon's log file.
2722  - When the `--log-format` option is combined with `--verbose`, rsync now
2723    avoids outputting the name of the file twice in most circumstances.  As long
2724    as the `--log-format` item does not refer to any post-transfer items (such
2725    as %b or %c), the `--log-format` message is output prior to the transfer, so
2726    `--verbose` is now the equivalent of a `--log-format` of '%n%L' (which
2727    outputs the name and any link info). If the log output must occur after the
2728    transfer to be complete, the only time the name is also output prior to the
2729    transfer is when `--progress` was specified (so that the name will precede
2730    the progress stats, and the full `--log-format` output will come after).
2732  - Non-printable characters in filenames are replaced with a '?' to avoid
2733    corrupting the screen or generating empty lines in the output.
2735 ### BUG FIXES:
2737  - Restore the list-clearing behavior of `!` in a .cvsignore file (2.6.3 was
2738    only treating it as a special token in an rsync include/exclude file).
2740  - The combination of `--verbose` and `--dry-run` now mentions the full list of
2741    changes that would be output without `--dry-run`.
2743  - Avoid a mkdir warning when removing a directory in the destination that
2744    already exists in the `--backup-dir`.
2746  - An OS that has a binary mode for its files (such as cygwin) needed
2747    `setmode(fd, O_BINARY)` called on the temp-file we opened with mkstemp().
2748    (Fix derived from cygwin's 2.6.3 rsync package.)
2750  - Fixed a potential hang when verbosity is high, the client side is the
2751    sender, and the file-list is large.
2753  - Fixed a potential protocol-corrupting bug where the generator could merge a
2754    message from the receiver into the middle of a multiplexed packet of data if
2755    only part of that data had been written out to the socket when the message
2756    from the generator arrived.
2758  - We now check if the OS doesn't support using mknod() for creating FIFOs and
2759    sockets, and compile-in some compatibility code using mkfifo() and socket()
2760    when necessary.
2762  - Fixed an off-by-one error in the handling of `--max-delete=N`. Also, if the
2763    `--max-delete` limit is exceeded during a run, we now output a warning about
2764    this at the end of the run and exit with a new error code (25).
2766  - One place in the code wasn't checking if fork() failed.
2768  - The `ignore nonreadable` daemon parameter used to erroneously affect
2769    readable symlinks that pointed to a non-existent file.
2771  - If the OS does not have lchown() and a chown() of a symlink will affect the
2772    referent of a symlink (as it should), we no longer try to set the user and
2773    group of a symlink.
2775  - The generator now properly runs the hard-link loop and the dir-time
2776    rewriting loop after we're sure that the redo phase is complete.
2778  - When `--backup` was specified with `--partial-dir=DIR`, where DIR is a
2779    relative path, the backup code was erroneously trying to backup a file that
2780    was put into the partial-dir.
2782  - If a file gets resent in a single transfer and the `--backup` option is
2783    enabled along with `--inplace`, rsync no longer performs a duplicate backup
2784    (it used to overwrite the first backup with the failed file).
2786  - One call to `flush_write_file()` was not being checked for an error.
2788  - The `--no-relative` option was not being sent from the client to a server
2789    sender.
2791  - If an rsync daemon specified `dont compress = ...` for a file and the client
2792    tried to specify `--compress`, the libz code was not handling a compression
2793    level of 0 properly. This could cause a transfer failure if the block-size
2794    for a file was large enough (e.g. rsync might have exited with an error for
2795    large files).
2797  - Fixed a bug that would sometimes surface when using `--compress` and sending
2798    a file with a block-size larger than 64K (either manually specified, or
2799    computed due to the file being really large). Prior versions of rsync would
2800    sometimes fail to decompress the data properly, and thus the transferred
2801    file would fail its verification.
2803  - If a daemon can't open the specified log file (i.e. syslog is not being
2804    used), die without crashing. We also output an error about the failure on
2805    stderr (which will only be seen if `--no-detach` was specified) and exit
2806    with a new error code (6).
2808  - A local transfer no longer duplicates all its include/exclude options (since
2809    the forked process already has a copy of the exclude list, there's no need
2810    to send them a set of duplicates).
2812  - The output of the items that are being updated by the generator (dirs,
2813    symlinks, devices) is now intermingled in the proper order with the output
2814    from the items that the receiver is updating (regular files) when pulling.
2815    This misordering was particularly bad when `--progress` was specified.
2816    (Requires protocol 29.)
2818  - When `--timeout` is specified, lulls that occur in the transfer while the
2819    generator is doing work that does not generate socket traffic (looking for
2820    changed files, deleting files, doing directory-time touch-ups, etc.) will
2821    cause a new keep-alive packet to be sent that should keep the transfer going
2822    as long as the generator continues to make progress. (Requires protocol 29.)
2824  - The stat size of a device is not added to the total file size of the items
2825    in the transfer (the size might be undefined on some OSes).
2827  - Fixed a problem with refused-option messages sometimes not making it back to
2828    the client side when a remote `--files-from` was in effect and the daemon
2829    was the receiver.
2831  - The `--compare-dest` option was not updating a file that differed in (the
2832    preserved) attributes from the version in the compare-dest DIR.
2834  - When rsync is copying files into a write-protected directory, fixed the
2835    change-report output for the directory so that we don't report an identical
2836    directory as changed.
2838 ### ENHANCEMENTS:
2840  - Rsync now supports popt's option aliases, which means that you can use
2841    /etc/popt and/or ~/.popt to create your own option aliases.
2843  - Added the `--delete-during` (`--del`) option which will delete files from
2844    the receiving side incrementally as each directory in the transfer is being
2845    processed. This makes it more efficient than the default,
2846    before-the-transfer behavior, which is now also available as
2847    `--delete-before` (and is still the default `--delete-WHEN` option that will
2848    be chosen if `--delete` or `--delete-excluded` is specified without a
2849    `--delete-WHEN` choice). All the `--del*` options infer `--delete`, so an
2850    rsync daemon that refuses `delete` will still refuse to allow any
2851    file-deleting options (including the new `--remove-sent-files` option).
2853  - All the `--delete-WHEN` options are now more memory efficient: Previously an
2854    duplicate set of file-list objects was created on the receiving side for the
2855    entire destination hierarchy. The new algorithm only creates one directory
2856    of objects at a time (for files inside the transfer).
2858  - Added the `--copy-dest` option, which works like `--link-dest` except that
2859    it locally copies identical files instead of hard-linking them.
2861  - Added support for specifying multiple `--compare-dest`, `--copy-dest`, or
2862    `--link-dest` options, but only of a single type. (Promoted from the patches
2863    dir and enhanced.) (Requires protocol 29.)
2865  - Added the `--max-size` option. (Promoted from the patches dir.)
2867  - The daemon-mode options are now separated from the normal rsync options so
2868    that they can't be mixed together. This makes it impossible to start a
2869    daemon that has improper default option values (which could cause problems
2870    when a client connects, such as hanging or crashing).
2872  - The `--bwlimit` option may now be used in combination with `--daemon` to
2873    specify both a default value for the daemon side and a value that cannot be
2874    exceeded by a user-specified `--bwlimit` option.
2876  - Added the `port` parameter to the rsyncd.conf file. (Promoted from the
2877    patches dir.) Also added `address`. The command-line options take precedence
2878    over a config-file option, as expected.
2880  - In `_exit_cleanup()`: when we are exiting with a partially-received file, we
2881    now flush any data in the write-cache before closing the partial file.
2883  - The `--inplace` support was enhanced to work with `--compare-dest`,
2884    `--link-dest`, and (the new) `--copy-dest` options. (Requires protocol 29.)
2886  - Added the `--dirs` (`-d`) option for an easier way to copy directories
2887    without recursion. Any directories that are encountered are created on the
2888    destination. Specifying a directory with a trailing slash copies its
2889    immediate contents to the destination.
2891  - The `--files-from` option now implies `--dirs` (`-d`).
2893  - Added the `--list-only` option, which is mainly a way for the client to put
2894    the server into listing mode without needing to resort to any internal
2895    option kluges (e.g. the age-old use of `-r --exclude='/*/*'` for a
2896    non-recursive listing). This option is used automatically (behind the
2897    scenes) when a modern rsync speaks to a modern daemon, but may also be
2898    specified manually if you want to force the use of the `--list-only` option
2899    over a remote-shell connection.
2901  - Added the `--omit-dir-times` (`-O`) option, which will avoid updating the
2902    modified time for directories when `--times` was specified. This option will
2903    avoid an extra pass through the file-list at the end of the transfer (to
2904    tweak all the directory times), which may provide an appreciable speedup for
2905    a really large transfer. (Promoted from the patches dir.)
2907  - Added the `--filter` (`-f`) option and its helper option, `-F`. Filter rules
2908    are an extension to the existing include/exclude handling that also supports
2909    nested filter files as well as per-directory filter files (like .cvsignore,
2910    but with full filter-rule parsing).  This new option was chosen in order to
2911    ensure that all existing include/exclude processing remained 100% compatible
2912    with older versions. Protocol 29 is needed for full filter-rule support, but
2913    backward-compatible rules work with earlier protocol versions.  (Promoted
2914    from the patches dir and enhanced.)
2916  - Added the `--delay-updates` option that puts all updated files into a
2917    temporary directory (by default `.~tmp~`, but settable via the
2918    `--partial-dir=DIR` option) until the end of the transfer. This makes the
2919    updates a little more atomic for a large transfer.
2921  - If rsync is put into the background, any output from `--progress` is
2922    reduced.
2924  - Documented the `max verbosity` setting for rsyncd.conf. (This setting was
2925    added a couple releases ago, but left undocumented.)
2927  - The sender and the generator now double-check the file-list index they are
2928    given, and refuse to try to do a file transfer on a non-file index (since
2929    that would indicate that something had gone very wrong).
2931  - Added the `--itemize-changes` (`-i`) option, which is a way to output a more
2932    detailed list of what files changed and in what way. The effect is the same
2933    as specifying a `--log-format` of `%i %n%L` (see both the rsync and
2934    rsyncd.conf manpages). Works with `--dry-run` too.
2936  - Added the `--fuzzy` (`-y`) option, which attempts to find a basis file for a
2937    file that is being created from scratch. The current algorithm only looks in
2938    the destination directory for the created file, but it does attempt to find
2939    a match based on size/mod-time (in case the file was renamed with no other
2940    changes) as well as based on a fuzzy name-matching algorithm. This option
2941    requires protocol 29 because it needs the new file-sorting order. (Promoted
2942    from patches dir and enhanced.) (Requires protocol 29.)
2944  - Added the `--remove-sent-files` option, which lets you move files between
2945    systems.
2947  - The hostname in HOST:PATH or HOST::PATH may now be an IPv6 literal enclosed
2948    in '[' and ']' (e.g. `[::1]`). (We already allowed IPv6 literals in the
2949    rsync://HOST:PORT/PATH format.)
2951  - When rsync recurses to build the file list, it no longer keeps open one or
2952    more directory handles from the dir's parent dirs.
2954  - When building under windows, the default for `--daemon` is now to avoid
2955    detaching, requiring the new `--detach` option to force rsync to detach.
2957  - The `--dry-run` option can now be combined with either `--write-batch` or
2958    `--read-batch`, allowing you to run a do-nothing test command to see what
2959    would happen without `--dry-run`.
2961  - The daemon's `read only` config item now sets an internal `read_only`
2962    variable that makes extra sure that no write/delete calls on the read-only
2963    side can succeed.
2965  - The log-format % escapes can now have a numeric field width in between the %
2966    and the escape letter (e.g. `%-40n %08p`).
2968  - Improved the option descriptions in the `--help` text.
2970 ### SUPPORT FILES:
2972  - Added atomic-rsync to the support dir: a perl script that will transfer some
2973    files using rsync, and then move the updated files into place all at once at
2974    the end of the transfer. Only works when pulling, and uses `--link-dest` and
2975    a parallel hierarchy of files to effect its update.
2977  - Added mnt-excl to the support dir: a perl script that takes the /proc/mounts
2978    file and translates it into a set of excludes that will exclude all mount
2979    points (even mapped mounts to the same disk). The excludes are made relative
2980    to the specified source dir and properly anchored.
2982  - Added savetransfer.c to the support dir: a C program that can make a copy of
2983    all the data that flows over the wire. This lets you test for data
2984    corruption (by saving the data on both the sending side and the receiving
2985    side) and provides one way to debug a protocol error.
2987  - Added rrsync to the support dir: this is an updated version of Joe Smith's
2988    restricted rsync perl script. This helps to ensure that only certain rsync
2989    commands can be run by an ssh invocation.
2991 ### INTERNAL:
2993  - Added better checking of the checksum-header values that come over the
2994    socket.
2996  - Merged a variety of file-deleting functions into a single function so that
2997    it is easier to maintain.
2999  - Improved the type of some variables (particularly blocksize vars) for
3000    consistency and proper size.
3002  - Got rid of the uint64 type (which we didn't need).
3004  - Use a slightly more compatible set of core #include directives.
3006  - Defined int32 in a way that ensures that the build dies if we can't find a
3007    variable with at least 32 bits.
3009 ### PROTOCOL DIFFERENCES FOR VERSION 29:
3011  - A 16-bit flag-word is transmitted after every file-list index. This
3012    indicates what is changing between the sender and the receiver. The
3013    generator now transmits an index and a flag-word to indicate when dirs and
3014    symlinks have changed (instead of producing a message), which makes the
3015    outputting of the information more consistent and less prone to screen
3016    corruption (because the local receiver/sender is now outputting all the
3017    file-change info messages).
3019  - If a file is being hard-linked, the `ITEM_XNAME_FOLLOWS` bit is enabled in
3020    the flag-word and the name of the file that was linked immediately follows
3021    in vstring format (see below).
3023  - If a file is being transferred with an alternate-basis file, the
3024    `ITEM_BASIS_TYPE_FOLLOWS` bit is enabled in the flag-word and a single byte
3025    follows, indicating what type of basis file was chosen. If that indicates
3026    that a fuzzy-match was selected, the `ITEM_XNAME_FOLLOWS` bit is set in the
3027    flag-word and the name of the match in vstring format follows the basis
3028    byte. A vstring is a variable length string that has its size written prior
3029    to the string, and no terminating null.  If the string is from 1-127 bytes,
3030    the length is a single byte. If it is from 128-32767 bytes, the length is
3031    written as ((len >> 8) | 0x80) followed by (len % 0x100).
3033  - The sending of exclude names is done using filter-rule syntax. This means
3034    that all names have a prefixed rule indicator, even excludes (which used to
3035    be sent as a bare pattern, when possible). The `-C` option will include the
3036    per-dir .cvsignore merge file in the list of filter rules so it is
3037    positioned correctly (unlike in some older transfer scenarios).
3039  - Rsync sorts the filename list in a different way: it sorts the subdir names
3040    after the non-subdir names for each dir's contents, and it always puts a
3041    dir's contents immediately after the dir's name in the list. (Previously an
3042    item named `foo.txt` would sort in between directory `foo/` and `foo/bar`.)
3044  - When talking to a protocol 29 rsync daemon, a list-only request is able to
3045    note this before the options are sent over the wire and the new
3046    `--list-only` option is included in the options.
3048  - When the `--stats` bytes are sent over the wire (or stored in a batch), they
3049    now include two elapsed-time values: one for how long it took to build the
3050    file-list, and one for how long it took to send it over the wire (each
3051    expressed in thousandths of a second).
3053  - When `--delete-excluded` is specified with some filter rules (AKA excludes),
3054    a client sender will now initiate a send of the rules to the receiver (older
3055    protocols used to omit the sending of excludes in this situation since there
3056    were no receiver-specific rules that survived `--delete-excluded` back
3057    then). Note that, as with all the filter-list sending, only items that are
3058    significant to the other side will actually be sent over the wire, so the
3059    filter-rule list that is sent in this scenario is often empty.
3061  - An index equal to the file-list count is sent as a keep-alive packet from
3062    the generator to the sender, which then forwards it on to the receiver. This
3063    normally invalid index is only a valid keep-alive packet if the 16-bit
3064    flag-word that follows it contains a single bit (`ITEM_IS_NEW`, which is
3065    normally an illegal flag to appear alone).
3067  - A protocol-29 batch file includes a bit for the setting of the `--dirs`
3068    option and for the setting of the `--compress` option. Also, the shell
3069    script created by `--write-batch` will use the `--filter` option instead of
3070    `--exclude-from` to capture any filter rules.
3072 ### BUILD CHANGES:
3074  - Handle an operating system that use mkdev() in place of makedev().
3076  - Improved configure to better handle cross-compiling.
3078 ------------------------------------------------------------------------------
3079 <a name="2.6.3"></a>
3081 # NEWS for rsync 2.6.3 (30 Sep 2004)
3083 Protocol: 28 (unchanged)
3085 ## Changes since 2.6.2:
3087 ### SECURITY FIXES:
3089  - A bug in the `sanitize_path` routine (which affects a non-chrooted rsync
3090    daemon) could allow a user to craft a pathname that would get transformed
3091    into an absolute path for certain options (but not for file-transfer names).
3092    If you're running an rsync daemon with chroot disabled, **please upgrade**,
3093    ESPECIALLY if the user privs you run rsync under is anything above `nobody`.
3095    OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
3097  - Please note that the 2-line footer (output when verbose) now uses the term
3098    `sent` instead of `wrote` and `received` instead of `read`. If you are not
3099    parsing the numeric values out of this footer, a script would be better off
3100    using the empty line prior to the footer as the indicator that the verbose
3101    output is over.
3103  - The output from the `--stats` option was similarly affected to change
3104    `written` to `sent` and `read` to `received`.
3106  - Rsync ensures that a filename that contains a newline gets mentioned with
3107    each newline transformed into a question mark (which prevents a filename
3108    from causing an empty line to be output).
3110  - The `backed up ...` message that is output when at least 2 `--verbose`
3111    options are specified is now the same both with and without the
3112    `--backup-dir` option.
3114 ### BUG FIXES:
3116  - Fixed a crash bug that might appear when `--delete` was used and multiple
3117    source directories were specified.
3119  - Fixed a 32-bit truncation of the file length when generating the checksums.
3121  - The `--backup` code no longer attempts to create some directories over and
3122    over again (generating warnings along the way).
3124  - Fixed a bug in the reading of the secrets file (by the daemon) and the
3125    password file (by the client): the files no longer need to be terminated by
3126    a newline for their content to be read in.
3128  - If a file has a read error on the sending side or the reconstructed data
3129    doesn't match the expected checksum (perhaps due to the basis file changing
3130    during the transfer), the receiver will no longer retain the resulting file
3131    unless the `--partial` option was specified.  (Note: for the read-error
3132    detection to work, neither side can be older than 2.6.3 -- older receivers
3133    will always retain the file, and older senders don't tell the receiver that
3134    the file had a read error.)
3136  - If a file gets resent in a single transfer and the `--backup` option is
3137    enabled, rsync no longer performs a duplicate backup (it used to overwrite
3138    the original file in the backup area).
3140  - Files specified in the daemon's `exclude` or `exclude from` config items are
3141    now excluded from being uploaded (assuming that the module allows uploading
3142    at all) in addition to the old download exclusion.
3144  - Got rid of a potential hang in the receiver when near the end of a phase.
3146  - When using `--backup` without a `--backup-dir`, rsync no longer preserves
3147    the modify time on directories. This avoids confusing NFS.
3149  - When `--copy-links` (`-L`) is specified, we now output a separate error for
3150    a symlink that has no referent instead of claiming that a file `vanished`.
3152  - The `--copy-links` (`-L`) option no longer has the side-effect of telling
3153    the receiving side to follow symlinks. See the `--keep-dirlinks` option
3154    (mentioned below) for a way to specify that behavior.
3156  - Error messages from the daemon server's option-parsing (such as refused
3157    options) are now successfully transferred back to the client (the server
3158    used to fail to send the message because the socket wasn't in the right
3159    state for the message to get through).
3161  - Most transfer errors that occur during a daemon transfer are now returned to
3162    the user in addition to being logged (some messages are intended to be
3163    daemon-only and are not affected by this).
3165  - Fixed a bug in the daemon authentication code when using one of the
3166    batch-processing options.
3168  - We try to work around some buggy IPv6 implementations that fail to implement
3169    `IPV6_V6ONLY`. This should fix the `address in use` error that some daemons
3170    get when running on an OS with a buggy IPv6 implementation. Also, if the new
3171    code gets this error, we might suggest that the user specify `--ipv4` or
3172    `--ipv6` (if we think it will help).
3174  - When the remote rsync dies, make a better effort to recover any error
3175    messages it may have sent before dying (the local rsync used to just die
3176    with a socket-write error).
3178  - When using `--delete` and a `--backup-dir` that contains files that are
3179    hard-linked to their destination equivalents, rsync now makes sure that
3180    removed files really get removed (avoids a really weird rename() behavior).
3182  - Avoid a bogus run-time complaint about a lack of 64-bit integers when the
3183    int64 type is defined as an `off_t` and it actually has 64-bits.
3185  - Added a configure check for open64() without mkstemp64() so that we can
3186    avoid using mkstemp() when such a combination is encountered.  This bypasses
3187    a problem writing out large temp files on OSes such as AIX and HP-UX.
3189  - Fixed an age-old crash problem with `--read-batch` on a local copy (rsync
3190    was improperly assuming `--whole-file` for the local copy).
3192  - When `--dry-run` (`-n`) is used and the destination directory does not
3193    exist, rsync now produces a correct report of files that would be sent
3194    instead of dying with a chdir() error.
3196  - Fixed a bug that could cause a slow-to-connect rsync daemon to die with an
3197    error instead of waiting for the connection to finish.
3199  - Fixed an ssh interaction that could cause output to be lost when the user
3200    chose to combine the output of rsync's stdout and stderr (e.g.  using the
3201    `2>&1`).
3203  - Fixed an option-parsing bug when `--files-from` got passed to a daemon.
3205 ### ENHANCEMENTS:
3207  - Added the `--partial-dir=DIR` option that lets you specify where to
3208    (temporarily) put a partially transferred file (instead of over- writing the
3209    destination file). E.g. `--partial-dir=.rsync-partial` Also added support
3210    for the `RSYNC_PARTIAL_DIR` environment variable that, when found,
3211    transforms a regular `--partial` option (such as the convenient `-P` option)
3212    into one that also specifies a directory.
3214  - Added `--keep-dirlinks` (`-K`), which allows you to symlink a directory onto
3215    another partition on the receiving side and have rsync treat it as matching
3216    a normal directory from the sender.
3218  - Added the `--inplace` option that tells rsync to write each destination file
3219    without using a temporary file. The matching of existing data in the
3220    destination file can be severely limited by this, but there are also cases
3221    where this is more efficient (such as appending data).  Use only when needed
3222    (see the man page for more details).
3224  - Added the `write only` option for the daemon's config file.
3226  - Added long-option names for `-4` and `-6` (namely `--ipv4` and `--ipv6`) and
3227    documented all these options in the man page.
3229  - Improved the handling of the `--bwlimit` option so that it's less bursty,
3230    more accurate, and works properly over a larger range of values.
3232  - The rsync daemon-over-ssh code now looks for `SSH_CONNECTION` and
3233    `SSH2_CLIENT` in addition to `SSH_CLIENT` to figure out the IP address.
3235  - Added the `--checksum-seed=N` option for advanced users.
3237  - Batch writing/reading has a brand-new implementation that is simpler, fixes
3238    a few weird problems with the old code (such as no longer sprinkling the
3239    batch files into different dirs or even onto different systems), and is much
3240    less intrusive into the code (making it easier to maintain for the future).
3241    The new code generates just one data file instead of three, which makes it
3242    possible to read the batch on stdin via a remote shell. Also, the old
3243    requirement of forcing the same fixed checksum-seed for all batch processing
3244    has been removed.
3246  - If an rsync daemon has a module set with `list = no` (which hides its
3247    presence in the list of available modules), a user that fails to
3248    authenticate gets the same `unknown module` error that they would get if the
3249    module were actually unknown (while still logging the real error to the
3250    daemon's log file). This prevents fishing for module names.
3252  - The daemon's `refuse options` config item now allows you to match option
3253    names using wildcards and/or the single-letter option names.
3255  - Each transferred file now gets its permissions and modified-time updated
3256    before the temp-file gets moved into place. Previously, the finished file
3257    would have a very brief window where its permissions disallowed all group
3258    and world access.
3260  - Added the ability to parse a literal IPv6 address in an `rsync:` URL (e.g.
3261    rsync://[2001:638:500:101::21]:873/module/dir).
3263  - The daemon's wildcard expanding code can now handle more than 1000 filenames
3264    (it's now limited by memory instead of having a hard-wired limit).
3266 ### INTERNAL:
3268  - Some cleanup in the exclude code has saved some per-exclude memory and made
3269    the code easier to maintain.
3271  - Improved the argv-overflow checking for a remote command that has a lot of
3272    args.
3274  - Use rsyserr() in the various places that were still calling rprintf() with
3275    strerror() as an arg.
3277  - If an rsync daemon is listening on multiple sockets (to handle both IPv4 and
3278    IPv6 to a single port), we now close all the unneeded file handles after we
3279    accept a connection (we used to close just one of them).
3281  - Optimized the handling of larger block sizes (rsync used to slow to a crawl
3282    if the block size got too large).
3284  - Optimized away a loop in `hash_search()`.
3286  - Some improvements to the `sanitize_path()` and `clean_fname()` functions
3287    makes them more efficient and produce better results (while still being
3288    compatible with the file-name cleaning that gets done on both sides when
3289    sending the file-list).
3291  - Got rid of `alloc_sanitize_path()` after adding a destination-buffer arg to
3292    `sanitize_path()` made it possible to put all the former's functionality
3293    into the latter.
3295  - The file-list that is output when at least 4 verbose options are specified
3296    reports the uid value on the sender even when rsync is not running as root
3297    (since we might be sending to a root receiver).
3299 ### BUILD CHANGES:
3301  - Added a `gen` target to rebuild most of the generated files, including
3302    configure, config.h.in, the man pages, and proto.h.
3304  - If `make proto` doesn't find some changes in the prototypes, the proto.h
3305    file is left untouched (its time-stamp used to always be updated).
3307  - The variable `$STRIP` (that is optionally set by the install-strip target's
3308    rule) was changed to `$INSTALL_STRIP` because some systems have `$STRIP`
3309    already set in the environment.
3311  - Fixed a build problem when `SUPPORT_HARD_LINKS` isn't defined.
3313  - When cross-compiling, the gettimeofday() function is now assumed to be a
3314    modern version that takes two-args (since we can't test it).
3316 ### DEVELOPER RELATED:
3318  - The scripts in the testsuite dir were cleaned up a bit and a few new tests
3319    added.
3321  - Some new diffs were added to the patches dir, and some accepted ones were
3322    removed.
3324 ------------------------------------------------------------------------------
3325 <a name="2.6.2"></a>
3327 # NEWS for rsync 2.6.2 (30 Apr 2004)
3329 Protocol: 28 (unchanged)
3331 ## Changes since 2.6.1:
3333 ### BUG FIXES:
3335  - Fixed a major bug in the sorting of the filenames when `--relative` is used
3336    for some sources (just sources such as `/` and `/*` were affected). This fix
3337    ensures that we ask for the right file-list item when requesting changes
3338    from the sender.
3340  - Rsync now checks the return value of the close() function to better report
3341    disk-full problems on an NFS file system.
3343  - Restored the old daemon-server behavior of logging error messages rather
3344    than returning them to the user. (A better long-term fix will be sought in
3345    the future.)
3347  - An obscure uninitialized-variable bug was fixed in the uid/gid code. (This
3348    bug probably had no ill effects.)
3350 ### BUILD CHANGES:
3352  - Got rid of the configure check for sys/sysctl.h (it wasn't used and was
3353    causing a problem on some systems). Also improved the
3354    broken-largefile-locking test to try to avoid failure due to an NFS
3355    build-dir.
3357  - Fixed a compile problem on systems that don't define `AI_NUMERICHOST`.
3359  - Fixed a compile problem in the popt source for compilers that don't support
3360    `__attribute__`.
3362 ### DEVELOPER RELATED:
3364  - Improved the testsuite's `merge` test to work on OSF1.
3366  - Two new diffs were added to the patches dir.
3368 ------------------------------------------------------------------------------
3369 <a name="2.6.1"></a>
3371 # NEWS for rsync 2.6.1 (26 Apr 2004)
3373 Protocol: 28 (changed)
3375 ## Changes since 2.6.0:
3377 ### SECURITY FIXES:
3379  - Paths sent to an rsync daemon are more thoroughly sanitized when chroot is
3380    not used. If you're running a non-read-only rsync daemon with chroot
3381    disabled, **please upgrade**, ESPECIALLY if the user privs you run rsync
3382    under is anything above `nobody`.
3384 ### ENHANCEMENTS:
3386  - Lower memory use, more optimal transfer of data over the socket, and lower
3387    CPU usage (see the INTERNAL section for details).
3389  - The `RSYNC_PROXY` environment variable can now contain a `USER:PASS@` prefix
3390    before the `HOST:PORT` information.  (Bardur Arantsson)
3392  - The `--progress` output now mentions how far along in the transfer we are,
3393    including both a count of files transferred and a percentage of the total
3394    file-count that we've processed. It also shows better
3395    current-rate-of-transfer and remaining-transfer-time values.
3397  - Documentation changes now attempt to describe some often mis- understood
3398    features more clearly.
3400 ### BUG FIXES:
3402  - When `-x` (`--one-file-system`) is combined with `-L` (`--copy-links`) or
3403    `--copy-unsafe-links,` no symlinked files are skipped, even if the referent
3404    file is on a different filesystem.
3406  - The `--link-dest` code now works properly for a non-root user when (1) the
3407    UIDs of the source and destination differ and `-o` was specified, or (2)
3408    when the group of the source can't be used on the destination and `-g` was
3409    specified.
3411  - Fixed a bug in the handling of `-H` (hard-links) that might cause the
3412    expanded PATH/NAME value of the current item to get overwritten (due to an
3413    expanded-name caching bug).
3415  - We now reset the `new data has been sent` flag at the start of each file we
3416    send. This makes sure that an interrupted transfer with the `--partial`
3417    option set doesn't keep a shorter temp file than the current basis file when
3418    no new data has been transferred over the wire for that file.
3420  - Fixed a byte-order problem in `--batch-mode` on big-endian machines.  (Jay
3421    Fenlason)
3423  - When using `--cvs-exclude`, the exclude items we get from a per-directory's
3424    .cvsignore file once again only affect that one directory (not all following
3425    directories too). The items are also now properly word-split and parsed
3426    without any +/- prefix parsing.
3428  - When specifying the USER@HOST: prefix for a file, the USER part can now
3429    contain an '@', if needed (i.e. the last '@' is used to find the HOST, not
3430    the first).
3432  - Fixed some bugs in the handling of group IDs for non-root users: (1) It
3433    properly handles a group that the sender didn't have a name for (it would
3434    previously skip changing the group on any files in that group). (2) If
3435    `--numeric-ids` is used, rsync no longer attempts to set groups that the
3436    user doesn't have the permission to set.
3438  - Fixed the `refuse options` setting in the rsyncd.conf file.
3440  - Improved the `-x` (`--one-file-system`) flag's handling of any mount- point
3441    directories we encounter. It is both more optimal (in that it no longer does
3442    a useless scan of the contents of the mount- point dirs) and also fixes a
3443    bug where a remapped mount of the original filesystem could get discovered
3444    in a subdir we should be ignoring.
3446  - Rsync no longer discards a double-slash at the start of a filename when
3447    trying to open the file. It also no longer constructs names that start with
3448    a double slash (unless the user supplied them).
3450  - Path-specifying options to a daemon should now work the same with or without
3451    chroot turned on. Previously, such a option (such as `--link-dest`) would
3452    get its absolute path munged into a relative one if chroot was not on,
3453    making that setting fairly useless.  Rsync now transforms the path into one
3454    that is based on the module's base dir when chroot is not enabled.
3456  - Fixed a compatibility problem interacting with older rsync versions that
3457    might send us an empty `--suffix` value without telling us that
3458    `--backup-dir` was specified.
3460  - The `hosts allow` option for a daemon-over-remote-shell process now has
3461    improved support for IPv6 addresses and a fix for systems that have a length
3462    field in their socket structs.
3464  - Fixed the ability to request an empty backup `--suffix` when sending files
3465    to an rsync daemon.
3467  - Fixed an option-parsing bug when `--files-from` was sent to a server sender.
3469 ### INTERNAL:
3471  - Most of the I/O is now buffered, which results in a pretty large speedup
3472    when running under MS Windows. (Craig Barratt)
3474  - Optimizations to the name-handling/comparing code have made some significant
3475    reductions in user-CPU time for large file sets.
3477  - Some cleanup of the variable types make the code more consistent.
3479  - Reduced memory requirements of hard link preservation.  (J.W. Schultz)
3481  - Implemented a new algorithm for hard-link handling that speeds up the code
3482    significantly. (J.W. Schultz and Wayne Davison)
3484  - The `--hard-link` option now uses the first existing file in the group of
3485    linked files as the basis for the transfer. This prevents the sub-optimal
3486    transfer of a file's data when a new hardlink is added on the sending side
3487    and it sorts alphabetically earlier in the list than the files that are
3488    already present on the receiving side.
3490  - Dropped support for protocol versions less than 20 (2.3.0 released 15 Mar
3491    1999) and activated warnings for protocols less than 25 (2.5.0 released 23
3492    Aug 2001). (Wayne Davison and J.W. Schultz, severally)
3494  - More optimal data transmission for `--hard-links` (protocol 28).
3496  - More optimal data transmission for `--checksum` (protocol 28).
3498  - Less memory is used when `--checksum` is specified.
3500  - Less memory is used in the file list (a per-file savings).
3502  - The generator is now better about not modifying the file list during the
3503    transfer in order to avoid a copy-on-write memory bifurcation (on systems
3504    where fork() uses shared memory).  Previously, rsync's shared memory would
3505    slowly become unshared, resulting in real memory usage nearly doubling on
3506    the receiving side by the end of the transfer. Now, as long as permissions
3507    are being preserved, the shared memory should remain that way for the entire
3508    transfer.
3510  - Changed hardlink info and `file_struct` + strings to use allocation pools.
3511    This reduces memory use for large file-sets and permits freeing memory to
3512    the OS. (J.W. Schultz)
3514  - The 2 pipes used between the receiver and generator processes (which are
3515    forked on the same machine) were reduced to 1 pipe and the protocol improved
3516    so that (1) it is now impossible to have the `redo` pipe fill up and hang
3517    rsync, and (2) trailing messages from the receiver don't get lost on their
3518    way through the generator over to the sender (which mainly affected
3519    hard-link messages and verbose `--stats` output).
3521  - Improved the internal uid/gid code to be more portable and a little more
3522    optimized.
3524  - The device numbers sent when using `--devices` are now sent as separate
3525    major/minor values with 32-bit accuracy (protocol 28).  Previously, the
3526    copied devices were sent as a single 32-bit number. This will make
3527    inter-operation of 64-bit binaries more compatible with their 32-bit
3528    brethren (with both ends of the connection are using protocol 28). Note that
3529    optimizations in the binary protocol for sending the device numbers often
3530    results in fewer bytes being used than before, even though more precision is
3531    now available.
3533  - Some cleanup of the exclude/include structures and its code made things
3534    clearer (internally), simpler, and more efficient.
3536  - The reading & writing of the file-list in batch-mode is now handled by the
3537    same code that sends & receives the list over the wire. This makes it much
3538    easier to maintain. (Note that the batch code is still considered to be
3539    experimental.)
3541 ### BUILD CHANGES:
3543  - The configure script now accepts `--with-rsyncd-conf=PATH` to override the
3544    default value of the /etc/rsyncd.conf file.
3546  - Fixed configure bug when running `./configure --disable-ipv6`.
3548  - Fixed compilation problem on Tru64 Unix (having to do with `sockaddr.sa_len`
3549    and `sockaddr.sin_len`).
3551 ### DEVELOPER RELATED:
3553  - Fixed `make test` bug when build dir is not the source dir.
3555  - Added a couple extra diffs in the `patches` dir, removed the ones that got
3556    applied, and rebuilt the rest.
3558 ------------------------------------------------------------------------------
3559 <a name="2.6.0"></a>
3561 # NEWS for rsync 2.6.0 (1 Jan 2004)
3563 Protocol: 27 (changed)
3565 ## Changes since 2.5.7:
3567 ### ENHANCEMENTS:
3569  - `ssh` is now the default remote shell for rsync. If you want to change this,
3570    configure like this: `./configure --with-rsh=rsh`.
3572  - Added `--files-from`, `--no-relative`, `--no-implied-dirs`, and `--from0`.
3573    Note that `--from0` affects the line-ending character for all the files read
3574    by the `--*-from` options. (Wayne Davison)
3576  - Length of csum2 is now per-file starting with protocol version
3577    27. (J.W. Schultz)
3579  - Per-file dynamic block size is now sqrt(file length). The per-file checksum
3580    size is determined according to an algorithm provided by Donovan Baarda
3581    which reduces the probability of rsync algorithm corrupting data and falling
3582    back using the whole md4 checksums. (J.W. Schultz, Donovan Baarda)
3584  - The `--stats` option no longer includes the (debug) malloc summary unless
3585    the verbose option was specified at least twice.
3587  - Added a new error/warning code for when files vanish from the sending side.
3588    Made vanished source files not interfere with the file-deletion pass when
3589    `--delete-after` was specified.
3591  - Various trailing-info sections are now preceded by a newline.
3593 ### BUG FIXES:
3595  - Fixed several exclude/include matching bugs when using wild-cards.  This has
3596    a several user-visible effects, all of which make the matching more
3597    consistent and intuitive. This should hopefully not cause anyone problems
3598    since it makes the matching work more like what people are expecting. (Wayne
3599    Davison)
3601  - A pattern with a `**` no longer causes a `*` to match slashes.  For example,
3602    with `/*/foo/**`, `foo` must be 2 levels deep.  [If your string has BOTH `*`
3603    and `**` wildcards, changing the `*` wildcards to `**` will provide the old
3604    behavior in all versions.]
3606  - `**/foo` now matches at the base of the transfer (like /foo does). [Use
3607    `/**/foo` to get the old behavior in all versions.]
3609  - A non-anchored wildcard term floats to match beyond the base of the
3610    transfer. E.g. `CVS/R*` matches at the end of the path, just like the
3611    non-wildcard term `CVS/Root` does. [Use `/CVS/R*` to get the old behavior in
3612    all versions.]
3614  - Including a `**` in the match term causes it to be matched against the
3615    entire path, not just the name portion, even if there aren't any interior
3616    slashes in the term. E.g. `foo**bar` would exclude `/path/foo-bar` (just
3617    like before) as well as `/foo-path/baz-bar` (unlike before). [Use `foo*bar`
3618    to get the old behavior in all versions.]
3620  - The exclude list specified in the daemon's config file is now properly
3621    applied to the pulled items no matter how deep the user's file-args are in
3622    the source tree. (Wayne Davison)
3624  - For protocol version >= 27, `mdfour_tail()` is called when the block size
3625    (including `checksum_seed`) is a multiple of 64.  Previously it was not
3626    called, giving the wrong MD4 checksum.  (Craig Barratt)
3628  - For protocol version >= 27, a 64 bit bit counter is used in mdfour.c as
3629    required by the RFC. Previously only a 32 bit bit counter was used, causing
3630    incorrect MD4 file checksums for file sizes >= 512MB - 4. (Craig Barratt)
3632  - Fixed a crash bug when interacting with older rsync versions and multiple
3633    files of the same name are destined for the same dir.  (Wayne Davison)
3635  - Keep tmp names from overflowing MAXPATHLEN.
3637  - Make `--link-dest` honor the absence of `-p`, `-o`, and `-g`.
3639  - Made rsync treat a trailing slash in the destination in a more consistent
3640    manner.
3642  - Fixed file I/O error detection. (John Van Essen)
3644  - Fixed bogus `malformed address {hostname}` message in rsyncd log when
3645    checking IP address against hostnames from `hosts allow` and `hosts deny`
3646    parameters in config file.
3648  - Print heap statistics when verbose >= 2 instead of when >= 1.
3650  - Fixed a compression (`-z`) bug when syncing a mostly-matching file that
3651    contains already-compressed data. (Yasuoka Masahiko and Wayne Davison)
3653  - Fixed a bug in the `--backup` code that could cause deleted files to not get
3654    backed up.
3656  - When the backup code makes new directories, create them with mode 0700
3657    instead of 0755 (since the directory permissions in the backup tree are not
3658    yet copied from the main tree).
3660  - Call setgroups() in a more portable manner.
3662  - Improved file-related error messages to better indicate exactly what
3663    pathname failed. (Wayne Davison)
3665  - Fixed some bugs in the handling of `--delete` and `--exclude` when using the
3666    `--relative` (`-R`) option. (Wayne Davison)
3668  - Fixed bug that prevented regular files from replacing special files and
3669    caused a directory in `--link-dest` or `--compare-dest` to block the
3670    creation of a file with the same path. A directory still cannot be replaced
3671    by a regular file unless `--delete` specified. (J.W. Schultz)
3673  - Detect and report when open or opendir succeed but read and readdir fail
3674    caused by network filesystem issues and truncated files. (David Norwood,
3675    Michael Brown, J.W. Schultz)
3677  - Added a fix that should give ssh time to restore the tty settings if the
3678    user presses Ctrl-C at an ssh password prompt.
3680 ### INTERNAL:
3682  - Eliminated vestigial support for old versions that we stopped supporting.
3683    (J.W. Schultz)
3685  - Simplified some of the option-parsing code. (Wayne Davison)
3687  - Some cleanup made to the exclude code, as well as some new defines added to
3688    enhance readability. (Wayne Davison)
3690  - Changed the protocol-version code so that it can interact at a lower
3691    protocol level than the maximum supported by both sides.  Added an
3692    undocumented option, `--protocol=N`, to force the value we advertise to the
3693    other side (primarily for testing purposes).  (Wayne Davison)
3695 ------------------------------------------------------------------------------
3696 <a name="2.5.7"></a>
3698 # NEWS for rsync 2.5.7 (4 Dec 2003)
3700 Protocol: 26 (unchanged)
3702 ## Changes since 2.5.6:
3704 ### SECURITY FIXES:
3706  - Fix buffer handling bugs. (Andrew Tridgell, Martin Pool, Paul Russell,
3707    Andrea Barisani)
3709 ------------------------------------------------------------------------------
3710 <a name="2.5.6"></a>
3712 # NEWS for rsync 2.5.6, aka "the dwd-between-jobs release" (26 Jan 2003)
3714 Protocol: 26 (unchanged)
3716 ## Changes since 2.5.5:
3718 ### ENHANCEMENTS:
3720  - The `--delete-after` option now implies `--delete`. (Wayne Davison)
3722  - The `--suffix` option can now be used with `--backup-dir`. (Michael
3723    Zimmerman)
3725  - Combining `::` syntax with the `--rsh`/`-e` option now uses the specified
3726    remote-shell as a transport to talk to a (newly-spawned) server-daemon. This
3727    allows someone to use daemon features, such as modules, over a secure
3728    protocol, such as ssh. (JD Paul)
3730  - The rsync:// syntax for daemon connections is now accepted in the
3731    destination field.
3733  - If the file name given to `--include-from` or `--exclude-from` is `-`, rsync
3734    will read from standard input. (J.W. Schultz)
3736  - New option `--link-dest` which is like `--compare-dest` except that
3737    unchanged files are hard-linked in to the destination directory.  (J.W.
3738    Schultz)
3740  - Don't report an error if an excluded file disappears during an rsync run.
3741    (Eugene Chupriyanov and Bo Kersey)
3743  - Added .svn to `--cvs-exclude` list to support subversion. (Jon Middleton)
3745  - Properly support IPv6 addresses in the rsyncd.conf `hosts allow` and `hosts
3746    deny` fields. (Hideaki Yoshifuji)
3748  - Changed exclude file handling to permit DOS or MAC style line terminations.
3749    (J.W. Schultz)
3751  - Ignore errors from chmod when `-p`/`-a`/`--preserve-perms` is not set.
3752    (Dave Dykstra)
3754 ### BUG FIXES:
3756  - Fix `forward name lookup failed` errors on AIX 4.3.3. (John L. Allen, Martin
3757    Pool)
3759  - Generate each file's rolling-checksum data as we send it, not in a separate
3760    (memory-eating) pass before hand. This prevents timeout errors on really
3761    large files. (Stefan Nehlsen)
3763  - Fix compilation on Tru64. (Albert Chin, Zoong Pham)
3765  - Better handling of some client-server errors. (Martin Pool)
3767  - Fixed a crash that would occur when sending a list of files that contains a
3768    duplicate name (if it sorts to the end of the file list) and using
3769    `--delete`. (Wayne Davison)
3771  - Fixed the file-name duplicate-removal code when dealing with multiple dups
3772    in a row. (Wayne Davison)
3774  - Fixed a bug that caused rsync to lose the exit status of its child processes
3775    and sometimes return an exit code of 0 instead of showing an error. (David
3776    R. Staples, Dave Dykstra)
3778  - Fixed bug in `--copy-unsafe-links` that caused it to be completely broken.
3779    (Dave Dykstra)
3781  - Prevent infinite recursion in cleanup code under certain circumstances.
3782    (Sviatoslav Sviridov and Marc Espie)
3784  - Fixed a bug that prevented rsync from creating intervening directories when
3785    `--relative-paths`/`-R` is set. (Craig Barratt)
3787  - Prevent `Connection reset by peer` messages from Cygwin. (Randy O'Meara)
3789 ### INTERNAL:
3791  - Many code cleanups and improved internal documentation. (Martin Pool, Nelson
3792    Beebe)
3794  - Portability fixes. (Dave Dykstra and Wayne Davison)
3796  - More test cases. (Martin Pool)
3798  - Some test-case fixes. (Brian Poole, Wayne Davison)
3800  - Updated included popt to the latest vendor drop, version 1.6.4.  (Jos
3801    Backus)
3803  - Updated config.guess and config.sub to latest versions; this means rsync
3804    should build on more platforms. (Paul Green)
3806 ------------------------------------------------------------------------------
3807 <a name="2.5.5"></a>
3809 # NEWS for rsync 2.5.5, aka Snowy River (2 Apr 2002)
3811 Protocol: 26 (unchanged)
3813 ## Changes since 2.5.4:
3815 ### ENHANCEMENTS:
3817  - With `--progress`, when a transfer is complete show the time taken;
3818    otherwise show expected time to complete. (Cameron Simpson)
3820  - Make `make install-strip` works properly, and `make install` accepts a
3821    DESTDIR variable for help in building binary packages.  (Peter
3822    Breitenlohner, Greg Louis)
3824  - If configured with `--enable-maintainer-mode`, then on receipt of a fatal
3825    signal rsync will try to open an xterm running gdb, similarly to Samba's
3826    `panic action` or GNOME's bug-buddy.  (Martin Pool)
3828 ### BUG FIXES:
3830  - Fix situation where failure to fork (e.g. because out of process slots)
3831    would cause rsync to kill all processes owned by the current user. Yes,
3832    really! (Paul Haas, Martin Pool)
3834  - Fix test suite on Solaris. (Jos Backus, Martin Pool)
3836  - Fix minor memory leak in socket code. (Dave Dykstra, Martin Pool.)
3838  - Fix `--whole-file` problem that caused it to be the default even for remote
3839    connections. (Martin Pool, Frank Schulz)
3841  - Work around bug in Mac OS X mkdir(2), which cannot handle trailing slashes.
3842    <http://www.opensource.apple.com/bugs/X/BSD%20Kernel/2734739.html> (Martin
3843    Pool)
3845  - Improved network error handling. (Greg A. Woods)
3847 ------------------------------------------------------------------------------
3848 <a name="2.5.4"></a>
3850 # NEWS for rsync 2.5.4, aka "Imitation lizard skin" (13 Mar 2002)
3852 Protocol: 26 (unchanged)
3854 ## Changes since 2.5.3:
3856 ### BUG FIXES:
3858  - Additional fix for zlib double-free bug. (Martin Pool, Andrew Tridgell) (CVE
3859    CAN-2002-0059)
3861 ### ENHANCEMENTS:
3863  - Merge in changes from zlib 1.1.3 to zlib 1.1.4. (Jos Backus) (Note that
3864    rsync still uses a custom version of zlib; you can not just link against a
3865    system library. See zlib/README.rsync)
3867  - Additional test cases for `--compress`. (Martin Pool)
3869 ------------------------------------------------------------------------------
3870 <a name="2.5.3"></a>
3872 # NEWS for rsync 2.5.3, aka "Happy 26" (11 Mar 2002)
3874 Protocol: 26 (unchanged)
3876 ## Changes since 2.5.2:
3878 ### SECURITY FIXES:
3880  - Make sure that supplementary groups are removed from a server
3881    process after changing uid and gid. (Ethan Benson) (Debian bug
3882    #132272, CVE CAN-2002-0080)
3884 ### BUG FIXES:
3886  - Fix zlib double-free bug. (Owen Taylor, Mark J Cox) (CVE CAN-2002-0059)
3888  - Fixed problem that in many cases caused the error message unexpected read
3889    size of 0 in `map_ptr` and resulted in the wrong data being copied.
3891  - Fixed compilation errors on some systems caused by the use of `unsigned
3892    int64` in rsync.h.
3894  - Fixed problem on systems such as Sunos4 that do not support realloc on a
3895    NULL pointer; error was 'out of memory in "flist_expand"'.
3897  - Fix for rsync server processes hanging around after the client unexpectedly
3898    disconnects. (Colin Walters) (Debian bug #128632)
3900  - Cope with BSD systems on which mkdir() will not accept a trailing slash.
3902 ### ENHANCEMENTS:
3904  - Merge in changes from zlib 1.1.2 to zlib 1.1.3. (Note that rsync still uses
3905    a custom version of zlib; you can not just link against a system library.
3906    See zlib/README.rsync)
3908  - Command to initiate connections is only shown with `-vv`, rather than `-v`
3909    as in 2.5.2. Output from plain `-v` is more similar to what was historically
3910    used so as not to break scripts that try to parse the output.
3912  - Added `--no-whole-file` and `--no-blocking-io` options (Dave Dykstra)
3914  - Made the `--write-batch` and `--read-batch` options actually work and added
3915    documentation in the man page (Jos Backus)
3917  - If the daemon is unable to fork a child to accept a connection, print an
3918    error message. (Colin Walters)
3920 ------------------------------------------------------------------------------
3921 <a name="2.5.2"></a>
3923 # NEWS for rsync 2.5.2 (26 Jan 2002)
3925 Protocol: 26 (changed)
3927 ## Changes since 2.5.1:
3929 ### SECURITY FIXES:
3931  - Signedness security patch from Sebastian Krahmer <krahmer@suse.de> -- in
3932    some cases we were not sufficiently careful about reading integers from the
3933    network.
3935 ### BUG FIXES:
3937  - Fix possible string mangling in log files.
3939  - Fix for setting local address of outgoing sockets.
3941  - Better handling of hardlinks and devices on platforms with 64-bit `dev_t` or
3942    `ino_t`.
3944  - Name resolution on machines supporting IPv6 is improved.
3946  - Fix for device nodes. (dann frazier) (Debian #129135)
3948 ### ENHANCEMENTS:
3950  - With `-v`, rsync now shows the command used to initiate an ssh/rsh
3951    connection.
3953  - `--statistics` now shows memory heap usage on platforms that support
3954    mallinfo().
3956  - "The Ted T'so school of program optimization": make progress visible and
3957    people will think it's faster. (With `--progress`, rsync will show you how
3958    many files it has seen as it builds the `file_list`, giving some indication
3959    that it has not hung.)
3961  - Improvements to batch mode support. This is still experimental but testing
3962    would be welcome. (Jos Backus)
3964  - New `--ignore-existing` option, patch previously distributed with Vipul's
3965    Razor. (Debian #124286)
3967 ------------------------------------------------------------------------------
3968 <a name="2.5.1"></a>
3970 # NEWS for rsync 2.5.1 (3 Jan 2002)
3972 Protocol: 25 (unchanged)
3974 ## Changes since 2.5.0:
3976 ### BUG FIXES:
3978  - Fix for segfault in `--daemon` mode configuration parser. (Paul Mackerras)
3980  - Correct `string<->address` parsing for both IPv4 and 6.  (YOSHIFUJI Hideaki,
3981    SUMIKAWA Munechika and Jun-ichiro `itojun` Hagino)
3983  - Various fixes for IPv6 support. (Dave Dykstra)
3985  - rsync.1 typo fix. (Matt Kraai)
3987  - Test suite typo fixes. (Tom Schmidt)
3989  - rsync.1 grammar and clarity improvements. (Edward Welbourne)
3991  - Correction to ./configure tests for `inet_ntop`. (Jeff Garzik)
3993 ### ENHANCEMENTS:
3995  - `--progress` and `-P` now show estimated data transfer rate (in a multiple
3996    of bytes/s) and estimated time to completion. (Rik Faith)
3998  - `--no-detach` option, required to run as a W32 service and also useful when
3999    running on Unix under daemontools, AIX's SRC, or a debugger. (Max Bowsher,
4000    Jos Backus)
4002  - Clearer error messages for some conditions.
4004 ------------------------------------------------------------------------------
4005 <a name="2.5.0"></a>
4007 # NEWS for rsync 2.5.0 (30 Nov 2001)
4009 Protocol: 25 (changed)
4011 ## Changes since 2.4.6:
4013 ### ANNOUNCEMENTS:
4015  - Martin Pool <mbp@samba.org> is now a co-maintainer.
4017 ### NEW FEATURES:
4019  - Support for LSB-compliant packaging <http://www.linuxbase.org/>
4021  - Shell wildcards are allowed in `auth users` lines.
4023  - Merged UNC rsync+ patch to support creation of standalone patch sets. By
4024    Bert J. Dempsey and Debra Weiss, updated by Jos Backus.
4025    <http://www.ils.unc.edu/i2dsi/unc_rsync+.html>
4027  - IPv6 support based on a patch from KAME.net, on systems including modern
4028    versions of Linux, Solaris, and HP-UX. Also includes IPv6 compatibility
4029    functions for old OSs by the Internet Software Consortium, Paul Vixie, the
4030    OpenSSH portability project, and OpenBSD.
4032 ### ENHANCEMENTS:
4034  - Include/exclude cluestick: with `-vv`, print out whether files are included
4035    or excluded and why.
4037  - Many error messages have more friendly explanations and more details.
4039  - Manual page improvements plus scanty protocol documentation.
4041  - When running as `--daemon` in the background and using a `log file`
4042    rsyncd.conf directive, close the log file every time it is open when going
4043    to sleep on the socket. This allows the log file to get cleaned out by
4044    another process.
4046  - Change to using libpopt rather than getopt for processing options. This
4047    makes the code cleaner and the behaviour more consistent across platforms.
4048    popt is included and built if not installed on the platform.
4050  - More details in `--version`, including note about whether 64-bit files,
4051    symlinks and hardlinks are supported.
4053  - MD4 code may use less CPU cycles.
4055  - Use mkstemp on systems where it is secure. If we use mktemp, explain that we
4056    do it in a secure way.
4058  - `--whole-file` is the default when source and target are on the local
4059    machine.
4061 ### BUG FIXES:
4063  - Fix for various bugs causing rsync to hang.
4065  - Attempt to fix Large File Summit support on AIX.
4067  - Attempt to fix error handling lockup bug.
4069  - Give a non-0 exit code if **any** of the files we have been asked to
4070    transfer fail to transfer.
4072  - For log messages containing ridiculously long strings that might overflow a
4073    buffer rsync no longer aborts, but rather prints an ellipsis at the end of
4074    the string. (Patch from Ed Santiago.)
4076 ### PLATFORMS:
4078  - Improved support for UNICOS (tested on Cray T3E and Cray SV1)
4080  - autoconf2.52 (or later) is now required to rebuild the autoconf scripts. It
4081    is not required to simply build rsync.
4083  - Platforms thought to work in this release:
4085    - Cray SV1 UNICOS 10.0.0.8 cc
4086    - Debian Linux 2.2 UltraSparc gcc
4087    - Debian Linux testing/unstable ARM gcc
4088    - FreeBSD 3.3-RELEASE i386 cc
4089    - FreeBSD 4.1.1-RELEASE i386 cc
4090    - FreeBSD 4.3-STABLE i386 cc
4091    - HP PA-RISC HP-UX 10.20 gcc
4092    - HP PA-RISC HP-UX 11.11 cc
4093    - IRIX 6.5 MIPS cc
4094    - IRIX 6.5 MIPS gcc
4095    - Mac OS X PPC (--disable-ipv6) cc
4096    - NetBSD 1.5 i386 gcc
4097    - NetBSD Current i386 cc
4098    - OpenBSD 2.5 Sparc gcc
4099    - OpenBSD 2.9 i386 cc
4100    - OpenBSD Current i386 cc
4101    - RedHat 6.2 i386 gcc
4102    - RedHat 6.2 i386 insure++
4103    - RedHat 7.0 i386 gcc
4104    - RedHat 7.1 i386 (Kernel 2.4.10) gcc
4105    - Slackware 8.0 i686 (Kernel 2.4.10)
4106    - Solaris 8 UltraSparc cc
4107    - Solaris 8 UltraSparc gcc
4108    - Solaris 8 i386 gcc
4109    - SuSE 7.1 i386 gcc2.95.2
4110    - SuSE 7.1 ppc gcc2.95.2
4111    - i386-pc-sco3.2v5.0.5 cc
4112    - i386-pc-sco3.2v5.0.5 gcc
4113    - powerpc-ibm-aix4.3.3.0 cc
4114    - i686-unknown-sysv5UnixWare7.1.0 gcc
4115    - i686-unknown-sysv5UnixWare7.1.0 cc
4117 ### TESTING:
4119  - The existing test.sh script by Phil Hands has been merged into a
4120    test framework that works from both `make check` and the Samba
4121    build farm.
4123 ------------------------------------------------------------------------------
4125 ## Partial Protocol History
4127 | RELEASE DATE | VER.   | DATE OF COMMIT\* | PROTOCOL    |
4128 |--------------|--------|------------------|-------------|
4129 | 22 Jun 2020  | 3.2.1  |                  | 31          |
4130 | 19 Jun 2020  | 3.2.0  |                  | 31          |
4131 | 28 Jan 2018  | 3.1.3  |                  | 31          |
4132 | 21 Dec 2015  | 3.1.2  |                  | 31          |
4133 | 22 Jun 2014  | 3.1.1  |                  | 31          |
4134 | 28 Sep 2013  | 3.1.0  | 31 Aug 2008      | 31          |
4135 | 23 Sep 2011  | 3.0.9  |                  | 30          |
4136 | 26 Mar 2011  | 3.0.8  |                  | 30          |
4137 | 31 Dec 2009  | 3.0.7  |                  | 30          |
4138 | 08 May 2009  | 3.0.6  |                  | 30          |
4139 | 28 Dec 2008  | 3.0.5  |                  | 30          |
4140 | 06 Sep 2008  | 3.0.4  |                  | 30          |
4141 | 29 Jun 2008  | 3.0.3  |                  | 30          |
4142 | 08 Apr 2008  | 3.0.2  |                  | 30          |
4143 | 03 Apr 2008  | 3.0.1  |                  | 30          |
4144 | 01 Mar 2008  | 3.0.0  | 11 Nov 2006      | 30          |
4145 | 06 Nov 2006  | 2.6.9  |                  | 29          |
4146 | 22 Apr 2006  | 2.6.8  |                  | 29          |
4147 | 11 Mar 2006  | 2.6.7  |                  | 29          |
4148 | 28 Jul 2005  | 2.6.6  |                  | 29          |
4149 | 01 Jun 2005  | 2.6.5  |                  | 29          |
4150 | 30 Mar 2005  | 2.6.4  | 17 Jan 2005      | 29          |
4151 | 30 Sep 2004  | 2.6.3  |                  | 28          |
4152 | 30 Apr 2004  | 2.6.2  |                  | 28          |
4153 | 26 Apr 2004  | 2.6.1  | 08 Jan 2004      | 28          |
4154 | 01 Jan 2004  | 2.6.0  | 10 Apr 2003      | 27 (MAX=40) |
4155 | 04 Dec 2003  | 2.5.7  |                  | 26          |
4156 | 26 Jan 2003  | 2.5.6  |                  | 26          |
4157 | 02 Apr 2002  | 2.5.5  |                  | 26          |
4158 | 13 Mar 2002  | 2.5.4  |                  | 26          |
4159 | 11 Mar 2002  | 2.5.3  |                  | 26          |
4160 | 26 Jan 2002  | 2.5.2  | 11 Jan 2002      | 26          |
4161 | 03 Jan 2002  | 2.5.1  |                  | 25          |
4162 | 30 Nov 2001  | 2.5.0  | 23 Aug 2001      | 25          |
4163 | 06 Sep 2000  | 2.4.6  |                  | 24          |
4164 | 19 Aug 2000  | 2.4.5  |                  | 24          |
4165 | 29 Jul 2000  | 2.4.4  |                  | 24          |
4166 | 09 Apr 2000  | 2.4.3  |                  | 24          |
4167 | 30 Mar 2000  | 2.4.2  |                  | 24          |
4168 | 30 Jan 2000  | 2.4.1  | 29 Jan 2000      | 24          |
4169 | 29 Jan 2000  | 2.4.0  | 28 Jan 2000      | 23          |
4170 | 25 Jan 2000  | 2.3.3  | 23 Jan 2000      | 22          |
4171 | 08 Nov 1999  | 2.3.2  | 26 Jun 1999      | 21          |
4172 | 06 Apr 1999  | 2.3.1  |                  | 20          |
4173 | 15 Mar 1999  | 2.3.0  | 15 Mar 1999      | 20          |
4174 | 25 Nov 1998  | 2.2.1  |                  | 19          |
4175 | 03 Nov 1998  | 2.2.0  |                  | 19          |
4176 | 09 Sep 1998  | 2.1.1  |                  | 19          |
4177 | 20 Jul 1998  | 2.1.0  |                  | 19          |
4178 | 17 Jul 1998  | 2.0.19 |                  | 19          |
4179 | 18 Jun 1998  | 2.0.17 |                  | 19          |
4180 | 01 Jun 1998  | 2.0.16 |                  | 19          |
4181 | 27 May 1998  | 2.0.13 | 27 May 1998      | 19          |
4182 | 26 May 1998  | 2.0.12 |                  | 18          |
4183 | 22 May 1998  | 2.0.11 |                  | 18          |
4184 | 18 May 1998  | 2.0.9  | 18 May 1998      | 18          |
4185 | 17 May 1998  | 2.0.8  |                  | 17          |
4186 | 15 May 1998  | 2.0.1  |                  | 17          |
4187 | 14 May 1998  | 2.0.0  |                  | 17          |
4188 | 17 Apr 1998  | 1.7.4  |                  | 17          |
4189 | 13 Apr 1998  | 1.7.3  |                  | 17          |
4190 | 05 Apr 1998  | 1.7.2  |                  | 17          |
4191 | 26 Mar 1998  | 1.7.1  |                  | 17          |
4192 | 26 Mar 1998  | 1.7.0  | 26 Mar 1998      | 17 (MAX=30) |
4193 | 13 Jan 1998  | 1.6.9  | 13 Jan 1998      | 15 (MAX=20) |
4195 \* DATE OF COMMIT is the date the protocol change was committed to version
4196 control.