Init the checksum choices before the daemon auth.
[rsync.git] / NEWS.md
1 # NEWS for rsync 3.2.7 (20 Oct 2022)
2
3 ## Changes in this version:
4
5 ### BUG FIXES:
6
7 - Fixed the client-side validating of the remote sender's filtering behavior.
8
9 - More fixes for the "unrequested file-list name" name, including a copy of
10   "/" with `--relative` enabled and a copy with a lot of related paths with
11   `--relative` enabled (often derived from a `--files-from` list).
12
13 - When rsync gets an unpack error on an ACL, mention the filename.
14
15 - Avoid over-setting sanitize_paths when a daemon is serving "/" (even if
16   "use chroot" is false).
17
18 ### ENHANCEMENTS:
19
20 - Added negotiated daemon-auth support that allows a stronger checksum digest
21   to be used to validate a user's login to the daemon.  Added SHA512, SHA256,
22   and SHA1 digests to MD5 & MD4.  These new digests are at the highest priority
23   in the new daemon-auth negotiation list.
24
25 - Added support for the SHA1 digest in file checksums.  While this tends to be
26   overkill, it is available if someone really needs it.  This overly-long
27   checksum is at the lowest priority in the normal checksum negotiation list.
28   See [`--checksum-choice`](rsync.1#opt) (`--cc`) and the `RSYNC_CHECKSUM_LIST`
29   environment var for how to customize this.
30
31 - Improved the xattr hash table to use a 64-bit key without slowing down the
32   key's computation.  This should make extra sure that a hash collision doesn't
33   happen.
34
35 - If the `--version` option is repeated (e.g. `-VV`) then the information is
36   output in a (still readable) JSON format.  Client side only.
37
38 - The script `support/json-rsync-version` is available to get the JSON style
39   version output from any rsync.  The script accepts either text on stdin
40   **or** an arg that specifies an rsync executable to run with a doubled
41   `--version` option.  If the text we get isn't already in JSON format, it is
42   converted. Newer rsync versions will provide more complete json info than
43   older rsync versions. Various tweaks are made to keep the flag names
44   consistent across versions.
45
46 - The [`use chroot`](rsyncd.conf.5#) daemon parameter now defaults to "unset"
47   so that rsync can use chroot when it works and a sanitized copy when chroot
48   is not supported (e.g., for a non-root daemon).  Explicitly setting the
49   parameter to true or false (on or off) behaves the same way as before.
50
51 - The `--fuzzy` option was optimized a bit to try to cut down on the amount of
52   computations when considering a big pool of files. The simple heuristic from
53   Kenneth Finnegan resuled in about a 2x speedup.
54
55 - If rsync is forced to use protocol 29 or before (perhaps due to talking to an
56   rsync before 3.0.0), the modify time of a file is limited to 4-bytes.  Rsync
57   now interprets this value as an unsigned integer so that a current year past
58   2038 can continue to be represented. This does mean that years prior to 1970
59   cannot be represented in an older protocol, but this trade-off seems like the
60   right choice given that (1) 2038 is very rapidly approaching, and (2) newer
61   protocols support a much wider range of old and new dates.
62
63 - The rsync client now treats an empty destination arg as an error, just like
64   it does for an empty source arg. This doesn't affect a `host:` arg (which is
65   treated the same as `host:.`) since the arg is not completely empty.  The use
66   of [`--old-args`](rsync.1#opt) (including via `RSYNC_OLD_ARGS`) allows the
67   prior behavior of treating an empty destination arg as a ".".
68
69 ### PACKAGING RELATED:
70
71 - The checksum code now uses openssl's EVP methods, which gets rid of various
72   deprecation warnings and makes it easy to support more digest methods.  On
73   newer systems, the MD4 digest is marked as legacy in the openssl code, which
74   makes openssl refuse to support it via EVP.  You can choose to ignore this
75   and allow rsync's MD4 code to be used for older rsync connections (when
76   talking to an rsync prior to 3.0.0) or you can choose to configure rsync to
77   tell openssl to enable legacy algorithms (see below).
78
79 - A simple openssl config file is supplied that can be installed for rsync to
80   use.  If you install packaging/openssl-rsync.cnf to a public spot (such as
81   `/etc/ssl/openssl-rsync.cnf`) and then run configure with the option
82   `--with-openssl-conf=/path/name.cnf`, this will cause rsync to export the
83   configured path in the OPENSSL_CONF environment variable (when the variable
84   is not already set).  This will enable openssl's MD4 code for rsync to use.
85
86 - The packager may wish to include an explicit "use chroot = true" in the top
87   section of their supplied /etc/rsyncd.conf file if the daemon is being
88   installed to run as the root user (though rsync should behave the same even
89   with the value unset, a little extra paranoia doesn't hurt).
90
91 - I've noticed that some packagers haven't installed support/nameconvert for
92   users to use in their chrooted rsync configs.  Even if it is not installed
93   as an executable script (to avoid a python3 dependency) it would be good to
94   install it with the other rsync-related support scripts.
95
96 - It would be good to add support/json-rsync-version to the list of installed
97   support scripts.
98
99 ------------------------------------------------------------------------------
100
101 # NEWS for rsync 3.2.6 (9 Sep 2022)
102
103 ## Changes in this version:
104
105 ### BUG FIXES:
106
107 - More path-cleaning improvements in the file-list validation code to avoid
108   rejecting of valid args.
109
110 - A file-list validation fix for a [`--files-from`](rsync.1#opt) file that ends
111   without a line-terminating character.
112
113 - Added a safety check that prevents the sender from removing destination files
114   when a local copy using [`--remove-source-files`](rsync.1#opt) has some files
115   that are shared between the sending & receiving hierarchies, including the
116   case where the source dir & destination dir are identical.
117
118 - Fixed a bug in the internal MD4 checksum code that could cause the digest
119   to be sporadically incorrect (the openssl version was/is fine).
120
121 - A minor tweak to rrsync added "copy-devices" to the list of known args, but
122   left it disabled by default.
123
124 ### ENHANCEMENTS:
125
126 - Rename `--protect-args` to [`--secluded-args`](rsync.1#opt) to make it
127   clearer how it differs from the default backslash-escaped arg-protecting
128   behavior of rsync.  The old option names are still accepted.  The
129   environment-variable override did not change its name.
130
131 ### PACKAGING RELATED:
132
133 - The configure option `--with-protected-args` was renamed to
134   `--with-secluded-args`.  This option makes `--secluded-args` the default
135   rsync behavior instead of using backslash escaping for protecting args.
136
137 - The mkgitver script now makes sure that a `.git` dir/file is in the top-level
138   source dir before calling `git describe`. It also runs a basic check on the
139   version value. This should avoid using an unrelated git description for
140   rsync's version.
141
142 ### DEVELOPER RELATED:
143
144 - The configure script no longer sets the -pedantic-errors CFLAG (which it
145   used to try to do only for gcc).
146
147 - The name_num_obj struct was modified to allow its dynamic name_num_item list
148   to be initialized in a better way.
149
150 ------------------------------------------------------------------------------
151
152 # NEWS for rsync 3.2.5 (14 Aug 2022)
153
154 ## Changes in this version:
155
156 ### SECURITY FIXES:
157
158 - Added some file-list safety checking that helps to ensure that a rogue
159   sending rsync can't add unrequested top-level names and/or include recursive
160   names that should have been excluded by the sender.  These extra safety
161   checks only require the receiver rsync to be updated.  When dealing with an
162   untrusted sending host, it is safest to copy into a dedicated destination
163   directory for the remote content (i.e. don't copy into a destination
164   directory that contains files that aren't from the remote host unless you
165   trust the remote host). Fixes CVE-2022-29154.
166
167  - A fix for CVE-2022-37434 in the bundled zlib (buffer overflow issue).
168
169 ### BUG FIXES:
170
171 - Fixed the handling of filenames specified with backslash-quoted wildcards
172   when the default remote-arg-escaping is enabled.
173
174 - Fixed the configure check for signed char that was causing a host that
175   defaults to unsigned characters to generate bogus rolling checksums. This
176   made rsync send mostly literal data for a copy instead of finding matching
177   data in the receiver's basis file (for a file that contains high-bit
178   characters).
179
180 - Lots of manpage improvements, including an attempt to better describe how
181   include/exclude filters work.
182
183 - If rsync is compiled with an xxhash 0.8 library and then moved to a system
184   with a dynamically linked xxhash 0.7 library, we now detect this and disable
185   the XX3 hashes (since these routines didn't stabilize until 0.8).
186
187 ### ENHANCEMENTS:
188
189 - The [`--trust-sender`](rsync.1#opt) option was added as a way to bypass the
190   extra file-list safety checking (should that be required).
191
192 ### PACKAGING RELATED:
193
194 - A note to those wanting to patch older rsync versions: the changes in this
195   release requires the quoted argument change from 3.2.4. Then, you'll want
196   every single code change from 3.2.5 since there is no fluff in this release.
197
198 - The build date that goes into the manpages is now based on the developer's
199   release date, not on the build's local-timezone interpretation of the date.
200
201 ### DEVELOPER RELATED:
202
203 - Configure now defaults GETGROUPS_T to gid_t when cross compiling.
204
205 - Configure now looks for the bsd/string.h include file in order to fix the
206   build on a host that has strlcpy() in the main libc but not defined in the
207   main string.h file.
208
209 ------------------------------------------------------------------------------
210
211 # NEWS for rsync 3.2.4 (15 Apr 2022)
212
213 ## Changes in this version:
214
215 ### BEHAVIOR CHANGES:
216
217  - A new form of arg protection was added that works similarly to the older
218    `--protect-args` ([`-s`](rsync.1#opt)) option but in a way that avoids
219    breaking things like rrsync (the restricted rsync script): rsync now uses
220    backslash escaping for sending "shell-active" characters to the remote
221    shell. This includes spaces, so fetching a remote file via a simple quoted
222    filename value now works by default without any extra quoting:
223
224    ```shell
225        rsync -aiv host:'a simple file.pdf' .
226    ```
227
228    Wildcards are not escaped in filename args, but they are escaped in options
229    like the [`--suffix`](rsync.1#opt) and [`--usermap`](rsync.1#opt) values.
230    If your rsync script depends on the old arg-splitting behavior, either run
231    it with the [`--old-args`](rsync.1#opt) option or `export RSYNC_OLD_ARGS=1`
232    in the script's environment.  See also the [ADVANCED USAGE](rsync.1#)
233    section of rsync's manpage for how to use a more modern arg style.
234
235  - A long-standing bug was preventing rsync from figuring out the current
236    locale's decimal point character, which made rsync always output numbers
237    using the "C" locale.  Since this is now fixed in 3.2.4, a script that
238    parses rsync's decimal numbers (e.g. from the verbose footer) may want to
239    setup the environment in a way that the output continues to be in the C
240    locale.  For instance, one of the following should work fine:
241
242    ```shell
243        export LC_ALL=C.UTF-8
244    ```
245
246    or if iconv translations are needed:
247
248    ```shell
249        if [ "${LC_ALL:-}" ]; then
250            export LANG="$LC_ALL"
251            export LC_CTYPE="$LC_ALL"
252            unset LC_ALL
253        fi
254        export LC_NUMERIC=C.UTF-8
255    ```
256
257 ### SECURITY FIXES:
258
259  - A fix for CVE-2018-25032 in the bundled zlib (memory corruption issue).
260
261 ### BUG FIXES:
262
263  - Fixed a bug with [`--inplace`](rsync.1#opt) + [`--sparse`](rsync.1#opt) (and
264    a lack of [`--whole-file`](rsync.1#opt)) where the destination file could
265    get reconstructed with bogus data.  Since the bug can also be avoided by
266    using (the seemingly redundant) [`--no-W`](rsync.1#opt) on the receiving
267    side, the latest rsync will now send `--no-W` to a remote receiver when this
268    option combination occurs.  If your client rsync is not new enough to do
269    this for you (or if you're just paranoid), you can manually specify `--no-W
270    -M--no-W` (when not using [`--whole-file`](rsync.1#opt)) to make sure the
271    bug is avoided.
272
273  - Fixed a bug with [`--mkpath`](rsync.1#opt) if a single-file copy specifies
274    an existing destination dir with a non-existing destination filename.
275
276  - Fixed `--update -vv` to output "is uptodate" instead of "is newer" messages
277    for files that are being skipped due to an identical modify time.  (This was
278    a new output quirk in 3.2.3.)
279
280  - When doing an append transfer, the sending side's file must not get shorter
281    or it is skipped. Fixes a crash that could occur when the size changes to 0
282    in the middle of the send negotiations.
283
284  - When dealing with special files (see [`--specials`](rsync.1#opt)) in an
285    alt-dest hierarchy, rsync now checks the non-permission mode bits to ensure
286    that the 2 special files are really the same before hard-linking them
287    together.
288
289  - Fixed a bug where [`--delay-updates`](rsync.1#opt) with stale partial data
290    could cause a file to fail to update.
291
292  - Fixed a few places that would output an INFO message with
293    [`--info=NAME`](rsync.1#opt) that should only have been output given
294    [`--verbose`](rsync.1#opt) or [`--itemize-changes`](rsync.1#opt).
295
296  - Avoid a weird failure if you run a local copy with a (useless)
297    [`--rsh`](rsync.1#opt) option that contains a `V` in the command.
298
299  - Fixed a long-standing compression bug where the compression level of the
300    first file transferred affected the level for all future files.  Also, the
301    per-file compression skipping has apparently never worked, so it is now
302    documented as being ineffective.
303
304  - Fixed a truncate error when a `--write-devices` copy wrote a file onto a
305    device that was shorter than the device.
306
307  - Made `--write-devices` support both `--checksum` and `--no-whole-file` when
308    copying to a device.
309
310  - Improved how the [`--stop-at`](rsync.1#opt), [`--stop-after`](rsync.1#opt),
311    and (the deprecated) [`--time-limit`](rsync.1#opt) options check to see if
312    the allowed time is over, which should make rsync exit more consistently.
313
314  - Tweak --progress to display "`??:??:??`" when the time-remaining value is so
315    large as to be meaningless.
316
317  - Silence some chmod warnings about symlinks when it looks like we have a
318    function to set their permissions but they can't really be set.
319
320  - Fixed a potential issue in git-set-file-times when handling commits with
321    high-bit characters in the description & when handling a description that
322    might mimic the git raw-commit deliniators.  (See the support dir.)
323
324  - The bundled systemd/rsync.service file now includes `Restart=on-failure`.
325
326 ### ENHANCEMENTS:
327
328  - Use openssl's `-verify_hostname` option in the rsync-ssl script.
329
330  - Added extra info to the "FILENAME exists" output of
331    [`--ignore-existing`](rsync.1#opt) when [`--info=skip2`](rsync.1#opt) is
332    used.  The skip message becomes "FILENAME exists (INFO)" where the INFO is
333    one of "type change", "sum change" (requires [`--checksum`](rsync.1#opt)),
334    "file change" (based on the quick check), "attr change", or "uptodate".
335    Prior versions only supported `--info=skip1`.
336
337  - Added the [`--fsync`](rsync.1#opt) option (promoted from the patches repo).
338
339  - Added the [`--copy-devices`](rsync.1#opt) option.  Compared to the
340    historical version from the rsync-patches repo, this version: properly
341    handles `--checksum`; fixes a truncation bug when doing an `--inplace` copy
342    onto a longer file; fixes several bugs in the `--itemize` output; and only
343    the sending side needs the enhanced rsync for the copy to work.
344
345  - Reduced memory usage for an incremental transfer that has a bunch of small
346    directories.
347
348  - The rsync daemon can now handle a client address with an implied "%scope"
349    suffix.
350
351  - Added support for [`--atimes`](rsync.1#opt) on macOS and fixed a bug where
352    it wouldn't work without [`--times`](rsync.1#opt).
353
354  - Rsync can now update the xattrs on a read-only file when your user can
355    temporarily add user-write permission to the file. (It always worked for a
356    root transfer.)
357
358  - Rsync can now work around an [`--inplace`](rsync.1#opt) update of a file
359    that is being refused due to the Linux fs.protected_regular sysctl setting.
360
361  - When [`--chown`](rsync.1#opt), [`--usermap`](rsync.1#opt), or
362    [`--groupmap`](rsync.1#opt) is specified, rsync now makes sure that the
363    appropriate [`--owner`](rsync.1#opt) and/or [`--group`](rsync.1#opt) options
364    are enabled.
365
366  - Added the [`--info=NONREG`](rsync.1#opt) setting to control if rsync should
367    warn about non-regular files in the transfer.  This is enabled by default
368    (keeping the behavior the same as before), so specifying `--info=nonreg0`
369    can be used to turn the warnings off.
370
371  - An optional asm optimization for the rolling checksum from Shark64. Enable
372    it with `./configure --enable-roll-asm`.
373
374  - Using `--debug=FILTER` now outputs a caution message if a filter rule
375    has trailing whitespace.
376
377  - Transformed rrsync into a python script with improvements:
378    - Security has been beefed up.
379    - The known rsync options were updated to include recent additions.
380    - Make rrsync reject [`--copy-links`](rsync.1#opt) (`-L`),
381      [`--copy-dirlinks`](rsync.1#opt) (`-k`), &
382      [`--keep-dirlinks`](rsync.1#opt) (`-K`) by default to make it harder to
383      exploit any out-of-subdir symlinks.
384    - A new rrsync option of [`-munge`](rrsync.1#opt) tells rrsync to always
385      enable rsync's [`--munge-links`](rsync.1#opt) option on the server side.
386    - A new rrsync option of [`-no-lock`](rrsync.1#opt) disables a new
387      single-use locking idiom that is the default when [`-ro`](rrsync.1#opt) is
388      not used (useful with [`-munge`](rrsync.1#opt)).
389    - A new rrsync option of [`-no-del`](rrsync.1#opt) disables all `--remove*`
390      and `--delete*` rsync options on the server side.
391    - The log format has been tweaked slightly to add seconds to the timestamp
392      and to output the command executed as a tuple (making the args clearer).
393    - An rrsync.1 manpage was added (in the support dir with rrsync).
394
395  - Added options to the lsh script to facilitate rrsync testing. (See the
396    support dir.)
397
398  - Transformed the atomic-rsync script into a python script and added the
399    ability to ignore one or more non-zero exit codes.  By default, it now
400    ignores code 24, the file-vanished exit code. (See the support dir.)
401
402  - Transformed the munge-symlinks script into python. (See the support dir.)
403
404  - Improved the rsync-no-vanished script to not join stdout & stderr together.
405    (See the support dir.)
406
407  - Work around a glibc bug where lchmod() breaks in a chroot w/o /proc mounted.
408
409  - Try to support a client that sent a remote rsync a wacko stderr file handle
410    (such as an older File::RsyncP perl library used by BackupPC).
411
412  - Lots of manpage improvements, including better HTML versions.
413
414 ### PACKAGING RELATED:
415
416  - Give configure the `--with-rrsync` option if you want `make install` to
417    install the (now python3) rrsync script and its new manpage.
418
419  - If the rrsync script is installed, its package should be changed to depend
420    on python3 and the (suggested but not mandatory) python3 braceexpand lib.
421
422  - When creating a package from a non-release version (w/o a git checkout), the
423    packager can elect to create git-version.h and define RSYNC_GITVER to the
424    string they want `--version` to output.  (The file is still auto-generated
425    using the output of `git describe` when building inside a non-shallow git
426    checkout, though.)
427
428  - Renamed configure's `--enable-simd` option to `--enable-roll-simd` and added
429    the option `--enable-roll-asm` to use the new asm version of the code.  Both
430    are x86_64/amd64 only.
431
432  - Renamed configure's `--enable-asm` option to `--enable-md5-asm` to avoid
433    confusion with the asm option for the rolling checksum.  It is also honored
434    even when openssl crypto is in use.  This allows: normal MD4 & MD5, normal
435    MD4 + asm MD5, openssl MD4 & MD5, or openssl MD4 + asm MD5 depending on the
436    configure options selected.
437
438  - Made SIMD & asm configure checks default to "no" on non-Linux hosts due to
439    various reports of problems on NetBSD & macOS hosts.  These were also
440    tweaked to allow enabling the feature on a host_cpu of amd64 (was only
441    allowed on x86_64 before).
442
443  - Fixed configure to not fail at the SIMD check when cross-compiling.
444
445  - Improved the IPv6 determination in configure.
446
447  - Compile the C files with `-pedantic-errors` (when possible) so that we will
448    get warned if a static initialization overflows in the future (among other
449    things).
450
451  - When linking with an external zlib, rsync renames its `read_buf()` function
452    to `read_buf_()` to avoid a symbol clash on an unpatched zlib.
453
454  - Added a SECURITY.md file.
455
456 ### DEVELOPER RELATED:
457
458  - Made it easier to write rsync tests that diff the output while also checking
459    the status code, and used the idiom to improve the existing tests. (See the
460    `checkdiff` and `checkdiff2` idioms in the `testsuite/*.test` files.
461
462  - The packaging scripts & related python lib got some minor enhancements.
463
464 ### INTERNAL
465
466  - Use setenv() instead of putenv() when it is available.
467
468  - Improve the logic in compat.c so that we don't need to try to remember to
469    sprinkle `!local_server` exceptions throughout the protocol logic.
470
471  - One more C99 Flexible Array improvement (started in the last release) and
472    make use of the C99 `%zd` format string when printing size_t values (when
473    possible).
474
475  - Use mallinfo2() instead of mallinfo(), when available.
476
477 ------------------------------------------------------------------------------
478
479 # NEWS for rsync 3.2.3 (6 Aug 2020)
480
481 ## Changes in this version:
482
483 ### BUG FIXES:
484
485  - Fixed a bug in the xattr code that was freeing the wrong object when trying
486    to cleanup the xattr list.
487
488  - Fixed a bug in the xattr code that was not leaving room for the "rsync."
489    prefix in some instances where it needed to be added.
490
491  - Restored the ability to use [`--bwlimit=0`](rsync.1#opt) to specify no
492    bandwidth limit.  (It was accidentally broken in 3.2.2.)
493
494  - Fixed a bug when combining [`--delete-missing-args`](rsync.1#opt) with
495    [`--no-implied-dirs`](rsync.1#opt) & [`-R`](rsync.1#opt) where rsync might
496    create the destination path of a missing arg.  The code also avoids some
497    superfluous warnings for nested paths of removed args.
498
499  - Fixed an issue where hard-linked devices could cause the rdev_major value to
500    get out of sync between the sender and the receiver, which could cause a
501    device to get created with the wrong major value in its major,minor pair.
502
503  - Rsync now complains about a missing [`--temp-dir`](rsync.1#opt) before
504    starting any file transfers.
505
506  - A completely empty source arg is now a fatal error.  This doesn't change
507    the handling of implied dot-dir args such as "localhost:" and such.
508
509 ### ENHANCEMENTS:
510
511  - Allow [`--max-alloc=0`](rsync.1#opt) to specify no limit to the alloc sanity
512    check.
513
514  - Allow [`--block-size=SIZE`](rsync.1#opt) to specify the size using units
515    (e.g. "100K").
516
517  - The name of the id-0 user & group are now sent to the receiver along with
518    the other user/group names in the transfer (instead of assuming that both
519    sides have the same id-0 names).
520
521  - Added the [`--stop-after`](rsync.1#opt) and [`--stop-at`](rsync.1#opt)
522    options (with a [`--time-limit`](rsync.1#opt) alias for `--stop-after`).
523    This is an enhanced version of the time-limit patch from the patches repo.
524
525  - Added the [`name converter`](rsyncd.conf.5#opt) daemon parameter to make it
526    easier to convert user & group names inside a chrooted daemon module.  This
527    is based on the nameconverter patch with some improvements, including a
528    tweak to the request protocol (so if you used this patch in the past, be
529    sure to update your converter script to use newlines instead of null chars).
530
531  - Added [`--crtimes`](rsync.1#opt) (`-N`) option for preserving the file's
532    create time (I believe that this is macOS only at the moment).
533
534  - Added [`--mkpath`](rsync.1#opt) option to tell rsync that it should create a
535    non-existing path component of the destination arg.
536
537  - Added [`--stderr=errors|all|client`](rsync.1#opt) to replace the
538    `--msgs2stderr` and `--no-msgs2stderr` options (which are still accepted).
539    The default use of stderr was changed to be `--stderr=errors` where all the
540    processes that have stderr available output directly to stderr, which should
541    help error messages get to the user more quickly, especially when doing a
542    push (which includes local copying).  This also allows rsync to exit quickly
543    when a receiver failure occurs, since rsync doesn't need to try to keep the
544    connection alive long enough for the fatal error to go from the receiver to
545    the generator to the sender.  The old default can be requested via
546    `--stderr=client`.  Also changed is that a non-default stderr mode is
547    conveyed to the remote rsync (using the older option names) instead of
548    requiring the user to use [`--remote-option`](rsync.1#opt) (`-M`) to tell
549    the remote rsync what to do.
550
551  - Added the ability to specify "@netgroup" names to the [`hosts
552    allow`](rsyncd.conf.5#opt) and [`hosts deny`](rsyncd.conf.5#opt) daemon
553    parameters.  This is a finalized version of the netgroup-auth patch from the
554    patches repo.
555
556  - Rsync can now hard-link symlinks on FreeBSD due to it making use of the
557    linkat() function when it is available.
558
559  - Output file+line info on out-of-memory & overflow errors while also avoiding
560    the output of alternate build-dir path info that is not useful to the user.
561
562  - Change configure to know that Cygwin supports Linux xattrs.
563
564  - Improved the testsuite on FreeBSD & Cygwin.
565
566  - Added some compatibility code for HPE NonStop platforms.
567
568  - Improved the INSTALL.md info.
569
570  - Added a few more suffixes to the default skip-compress list.
571
572  - Improved configure's error handling to notify about several issues at once
573    instead of one by one (for the newest optional features).
574
575 ### INTERNAL:
576
577  - Use a simpler overflow check idiom in a few spots.
578
579  - Use a C99 Flexible Array for a trailing variable-size filename in a struct
580    (with a fallback to the old 1-char string kluge for older compilers).
581
582 ------------------------------------------------------------------------------
583
584 # NEWS for rsync 3.2.2 (4 Jul 2020)
585
586 ## Changes in this version:
587
588 ### BUG FIXES:
589
590  - Avoid a crash when a daemon module enables `transfer logging` without
591    setting a `log format` value.
592
593  - Fixed installing rsync-ssl script from an alternate build dir.
594
595  - Fixed the updating of configure.sh from an alternate build dir.
596
597  - Apple requires the asm function name to begin with an underscore.
598
599  - Avoid a test failure in the daemon test when `--atimes` is disabled.
600
601 ### ENHANCEMENTS:
602
603  - Allow the server side to restrict checksum & compression choices via the
604    same environment variables the client uses.  The env vars can be divided
605    into "client list & server list" by the "`&`" char or the same list can
606    apply to both.
607
608  - Simplify how the negotiation environment variables apply when interacting
609    with an older rsync and also when a list contains only invalid names.
610
611  - Do not allow a negotiated checksum or compression choice of "none" unless
612    the user authorized it via an environment variable or command-line option.
613
614  - Added the `--max-alloc=SIZE` option to be able to override the memory
615    allocator's sanity-check limit.  It defaults to 1G (as before) but the error
616    message when exceeding it specifically mentions the new option so that you
617    can differentiate an out-of-memory error from a failure of this limit.  It
618    also allows you to specify the value via the RSYNC_MAX_ALLOC environment
619    variable.
620
621  - Add the "open atime" daemon parameter to allow a daemon to always enable or
622    disable the use of O_NOATIME (the default is to let the user control it).
623
624  - The default systemd config was changed to remove the `ProtectHome=on`
625    setting since rsync is often used to serve files in /home and /root and this
626    seemed a bit too strict.  Feel free to use `systemctl edit rsync` to add
627    that restriction (or maybe `ProtectHome=read-only`), if you like.  See the
628    3.2.0 NEWS for the other restrictions that were added compared to 3.1.3.
629
630  - The memory allocation functions now automatically check for a failure and
631    die when out of memory.  This eliminated some caller-side check-and-die
632    code and added some missing sanity-checking of allocations.
633
634  - Put optimizations into their own list in the `--version` output.
635
636  - Improved the manpage a bit more.
637
638 ### PACKAGING RELATED:
639
640  - Prepared the checksum code for an upcoming xxHash release that provides new
641    XXH3 (64-bit) & XXH128 (128-bit) checksum routines.  These will not be
642    compiled into rsync until the xxhash v0.8.0 include files are installed on
643    the build host, and that release is a few weeks away at the time this was
644    written.  So, if it's now the future and you have packaged and installed
645    xxhash-0.8.0-devel, a fresh rebuild of rsync 3.2.2 will give you the new
646    checksum routines.  Just make sure that the new rsync package depends on
647    xxhash >= 0.8.0.
648
649 ### DEVELOPER RELATED:
650
651  - Moved the version number out of configure.ac into its own version.h file so
652    that we don't need to reconfigure just because the version number changes.
653
654  - Moved the daemon parameter list into daemon-parm.txt so that an awk script
655    can create the interrelated structs and accessors that loadparm.c needs.
656
657 ------------------------------------------------------------------------------
658
659 # NEWS for rsync 3.2.1 (22 Jun 2020)
660
661 ## Changes in this version:
662
663 ### BUG FIXES:
664
665  - Fixed a potential build issue with the MD5 assembly-language code by
666    removing some non-portable directives.
667
668  - Use the preprocessor with the asm file to ensure that if the code is
669    unneeded, it doesn't get built.
670
671  - Avoid the stack getting set to executable when including the asm code.
672
673  - Some improvements in the SIMD configure testing to try to avoid build
674    issues, such as avoiding a clang++ core dump when `-g` is combined with
675    `-O2`.  Note that clang++ is quite buggy in this area, and it does still
676    crash for some folks, so just use `--disable-simd` if you need to avoid
677    their buggy compiler (since the configure test is apparently not finding
678    all the compilers that will to crash and burn).
679
680  - Fixed an issue in the md2man script when building from an alternate dir.
681
682  - Disable `--atimes` on macOS (it apparently just ignores the atime change).
683
684 ### ENHANCEMENTS:
685
686  - The use of `--backup-dir=STR` now implies `--backup`.
687
688  - Added `--zl=NUM` as a short-hand for `--compress-level=NUM`.
689
690  - Added `--early-input=FILE` option that allows the client to send some
691    data to a daemon's (optional) "early exec" script on its stdin.
692
693  - Mention atimes in the capabilities list that `--version` outputs.
694
695  - Mention either "default protect-args" or "optional protect-args" in the
696    `--version` capabilities depending on how rsync was configured.
697
698  - Some info on optimizations is now elided from the `--version` capabilities
699    since they aren't really user-facing capabilities.  You can still see the
700    info (plus the status of a couple extra optimizations) by repeating the
701    `--version` option (e.g. `-VV`).
702
703  - Updated various URLs to be https instead of http.
704
705  - Some documentation improvements.
706
707 ### PACKAGING RELATED:
708
709  - If you had to use `--disable-simd` for 3.2.0, you might want to try removing
710    that and see if it will succeed or auto-disable.  Some buggy clang++
711    compilers are still not auto disabled, though.
712
713  - The MD5 asm code is now under its own configure flag (not shared with the
714    SIMD setting), so if you have any issues compiling it, re-run configure with
715    `--disable-asm`.
716
717  - Merged the OLDNEWS.md file into NEWS.md.
718
719 ------------------------------------------------------------------------------
720
721 # NEWS for rsync 3.2.0 (19 Jun 2020)
722
723 ## Changes in this version:
724
725 ### BUG FIXES:
726
727  - Avoid a potential out-of-bounds read in daemon mode if argc can be made to
728    become 0.
729
730  - Fix the default list of skip-compress files for non-daemon transfers.
731
732  - Fix xattr filter rules losing an 'x' attribute in a non-local transfer.
733
734  - Avoid an error when a check for a potential fuzzy file happens to reference
735    a directory.
736
737  - Make the atomic-rsync helper script have a more consistent error-exit.
738
739  - Make sure that a signal handler's use of exit_cleanup() calls `_exit()`
740    instead of exit().
741
742  - Various zlib fixes, including security fixes for CVE-2016-9843,
743    CVE-2016-9842, CVE-2016-9841, and CVE-2016-9840.
744
745  - Fixed an issue with `--remove-source-files` not removing a source symlink
746    when combined with `--copy-links`.
747
748  - Fixed a bug where the daemon would fail to write early fatal error messages
749    to the client, such as refused or unknown command-line options.
750
751  - Fixed the block-size validation logic when dealing with older protocols.
752
753  - Some rrsync fixes and enhancements to handle the latest options.
754
755  - Fixed a problem with the `--link-dest`|`--copy-dest` code when `--xattrs`
756    was specified along with multiple alternate-destination directories (it
757    could possibly choose a bad file match while trying to find a better xattr
758    match).
759
760  - Fixed a couple bugs in the handling of files with the `--sparse` option.
761
762  - Fixed a bug in the writing of the batch.sh file (w/`--write-batch`) when the
763    source & destination args were not last on the command-line.
764
765  - Avoid a hang when an overabundance of messages clogs up all the I/O buffers.
766
767  - Fixed a mismatch in the RSYNC_PID values put into the environment of
768    `pre-xfer exec` and a `post-xfer exec`.
769
770  - Fixed a crash in the `--iconv` code.
771
772  - Fixed a rare crash in the popt_unalias() code.
773
774 ### ENHANCEMENTS:
775
776  - The default systemd config was made stricter by default.  For instance,
777    `ProtectHome=on` (which hides content in /root and /home/USER dirs),
778    `ProtectSystem=full` (which makes /usr, /boot, & /etc dirs read-only), and
779    `PrivateDevices=on` (which hides devices).  You can override any of these
780    using the standard `systemctl edit rsync` and add one or more directives
781    under a `[Service]` heading (and restart the rsync service).
782
783  - Various checksum enhancements, including the optional use of openssl's MD4 &
784    MD5 checksum algorithms, some x86-64 optimizations for the rolling checksum,
785    some x86-64 optimizations for the (non-openssl) MD5 checksum, the addition
786    of xxHash checksum support, and a negotiation heuristic that ensures that it
787    is easier to add new checksum algorithms in the future.  The environment
788    variable `RSYNC_CHECKSUM_LIST` can be used to customize the preference order
789    of the negotiation, or use `--checksum-choice` (`--cc`) to force a choice.
790
791  - Various compression enhancements, including the addition of zstd and lz4
792    compression algorithms and a negotiation heuristic that picks the best
793    compression option supported by both sides.  The environment variable
794    `RSYNC_COMPRESS_LIST` can be used to customize the preference order of the
795    negotiation, or use `--compress-choice` (`--zc`) to force a choice.
796
797  - Added a `--debug=NSTR` option that outputs details of the new negotiation
798    strings (for checksums and compression).  The first level just outputs the
799    result of each negotiation on the client, level 2 outputs the values of the
800    strings that were sent to and received from the server, and level 3 outputs
801    all those values on the server side too (when the server was given the debug
802    option).
803
804  - The `--debug=OPTS` command-line option is no longer auto-forwarded to the
805    remote rsync which allows for the client and server to have different levels
806    of debug specified. This also allows for newer debug options to be
807    specified, such as using `--debug=NSTR` to see the negotiated hash result,
808    without having the command fail if the server version is too old to handle
809    that debug item. Use `-M--debug=OPTS` to send the options to the remote side.
810
811  - Added the `--atimes` option based on the long-standing patch (just with some
812    fixes that the patch has been needing).
813
814  - Added `--open-noatime` option to open files using `O_NOATIME`.
815
816  - Added the `--write-devices` option based on the long-standing patch.
817
818  - Added openssl & preliminary gnutls support to the rsync-ssl script, which is
819    now installed by default.  This was unified with the old stunnel-rsync
820    helper script to simplify packaging.  Note that the script accepts the use
821    of `--type=gnutls` for gnutls testing, but does not look for gnutls-cli on
822    the path yet.  The use of `--type=gnutls` will not work right until
823    gnutls-cli no longer drops data.
824
825  - Rsync was enhanced to set the `RSYNC_PORT` environment variable when running
826    a daemon-over-rsh script. Its value is the user-specified port number (set
827    via `--port` or an rsync:// URL) or 0 if the user didn't override the port.
828
829  - Added the `proxy protocol` daemon parameter that allows your rsyncd to know
830    the real remote IP when it is setup behind a proxy.
831
832  - Added negated matching to the daemon's `refuse options` setting by using
833    match strings that start with a `!` (such as `!compress*`).  This lets you
834    refuse all options except for a particular approved list, for example.  It
835    also lets rsync refuse certain options by default (such as `write-devices`)
836    while allowing the config to override that, as desired.
837
838  - Added the `early exec` daemon parameter that runs a script before the
839    transfer parameters are known, allowing some early setup based on module
840    name.
841
842  - Added status output in response to a signal (via both SIGINFO & SIGVTALRM).
843
844  - Added `--copy-as=USER` option to give some extra security to root-run rsync
845    commands into/from untrusted directories (such as backups and restores).
846
847  - When resuming the transfer of a file in the `--partial-dir`, rsync will now
848    update that partial file in-place instead of creating yet another tmp file
849    copy.  This requires both sender & receiver to be at least v3.2.0.
850
851  - Added support for `RSYNC_SHELL` & `RSYNC_NO_XFER_EXEC` environment variables
852    that affect the early, pre-xfer, and post-xfer exec rsync daemon parameters.
853
854  - Optimize the `--fuzzy --fuzzy` heuristic to avoid the fuzzy directory scan
855    until all other basis-file options are exhausted (such as `--link-dest`).
856
857  - Have the daemon log include the normal-exit sent/received stats when the
858    transfer exited with an error when possible (i.e. if it is the sender).
859
860  - The daemon now locks its pid file (when configured to use one) so that it
861    will not fail to start when the file exists but no daemon is running.
862
863  - Various manpage improvements, including some html representations (that
864    aren't installed by default).
865
866  - Made `-V` the short option for `--version` and improved its information.
867
868  - Pass the `-4` or `-6` option to the ssh command, making it easier to type
869    than `--rsh='ssh -4'` (or the `-6` equivalent).
870
871  - Added example config for rsyncd SSL proxy configs to rsyncd.conf.
872
873  - More errors messages now mention if the error is coming from the sender or
874    the receiver.
875
876 ### PACKAGING RELATED:
877
878  - Add installed bash script: /usr/bin/rsync-ssl
879
880  - Add installed manpage: /usr/man/man1/rsync-ssl.1
881
882  - Tweak auxiliary doc file names, such as: README.md, INSTALL.md, & NEWS.md.
883
884  - The rsync-ssl script wants to run openssl or stunnel4, so consider adding a
885    dependency for one of those options (though it's probably fine to just let
886    it complain about being unable to find the program and let the user decide
887    if they want to install one or the other).
888
889  - If you packaged rsync + rsync-ssl + rsync-ssl-daemon as separate packages,
890    the rsync-ssl package is now gone (rsync-ssl should be considered to be
891    mainstream now that Samba requires SSL for its rsync daemon).
892
893  - Add _build_ dependency for liblz4-dev, libxxhash-dev, libzstd-dev, and
894    libssl-dev.  These development libraries will give rsync extra compression
895    algorithms, extra checksum algorithms, and allow use of openssl's crypto
896    lib for (potentially) faster MD4/MD5 checksums.
897
898  - Add _build_ dependency for g++ or clang++ on x86_64 systems to enable the
899    SIMD checksum optimizations.
900
901  - Add _build_ dependency for _either_ python3-cmarkcfm or python3-commonmark
902    to allow for patching of manpages or building a git release.  This is not
903    required for a release-tar build, since it comes with pre-built manpages.
904    Note that cmarkcfm is faster than commonmark, but they generate the same
905    data.  The commonmark dependency is easiest to install since it's native
906    python, and can even be installed via `pip3 install --user commonmark` if
907    you want to just install it for the build user.
908
909  - Remove yodl _build_ dependency (if it was even listed before).
910
911 ### DEVELOPER RELATED:
912
913  - Silenced some annoying warnings about major() & minor() by improving an
914    autoconf include-file check.
915
916  - Converted the manpages from yodl to markdown. They are now processed via a
917    simple python3 script using the cmarkgfm **or** commonmark library.  This
918    should make it easier to package rsync, since yodl is rather obscure.
919
920  - Improved some configure checks to work better with strict C99 compilers.
921
922  - Some perl building/packaging scripts were recoded into awk and python3.
923
924  - Some defines in byteorder.h were changed into static inline functions that
925    will help to ensure that the args don't get evaluated multiple times on
926    "careful alignment" hosts.
927
928  - Some code typos were fixed (as pointed out by a Fossies run).
929
930 ------------------------------------------------------------------------------
931
932 # NEWS for rsync 3.1.3 (28 Jan 2018)
933
934 ## Changes in this version:
935
936 ### SECURITY FIXES:
937
938  - Fixed a buffer overrun in the protocol's handling of xattr names and ensure
939    that the received name is null terminated.
940
941  - Fix an issue with `--protect-args` where the user could specify the arg in the
942    protected-arg list and short-circuit some of the arg-sanitizing code.
943
944 ### BUG FIXES:
945
946  - Don't output about a new backup dir without appropriate info verbosity.
947
948  - Fixed some issues with the sort functions in the rsyncstats script (in the
949    support dir).
950
951  - Added a way to specify daemon config lists (e.g. users, groups, etc) that
952    contain spaces (see `auth users` in the latest rsyncd.conf manpage).
953
954  - If a backup fails (e.g. full disk) rsync exits with an error.
955
956  - Fixed a problem with a doubled `--fuzzy` option combined with `--link-dest`.
957
958  - Avoid invalid output in the summary if either the start or end time had an
959    error.
960
961  - We don't allow a popt alias to affect the `--daemon` or `--server` options.
962
963  - Fix daemon exclude code to disallow attribute changes in addition to
964    disallowing transfers.
965
966  - Don't force nanoseconds to match if a non-transferred, non-checksummed file
967    only passed the quick-check w/o comparing nanoseconds.
968
969 ### ENHANCEMENTS:
970
971  - Added the ability for rsync to compare nanosecond times in its file-check
972    comparisons, and added support nanosecond times on Mac OS X.
973
974  - Added a short-option (`-@`) for `--modify-window`.
975
976  - Added the `--checksum-choice=NAME[,NAME]` option to choose the checksum
977    algorithms.
978
979  - Added hashing of xattr names (with using `-X`) to improve the handling of
980    files with large numbers of xattrs.
981
982  - Added a way to filter xattr names using include/exclude/filter rules (see
983    the `--xattrs` option in the manpage for details).
984
985  - Added `daemon chroot|uid|gid` to the daemon config (in addition to the old
986    chroot|uid|gid settings that affect the daemon's transfer process).
987
988  - Added `syslog tag` to the daemon configuration.
989
990  - Some manpage improvements.
991
992 ### DEVELOPER RELATED:
993
994  - Tweak the `make` output when yodl isn't around to create the manpages.
995
996  - Changed an obsolete autoconf compile macro.
997
998  - Support newer yodl versions when converting manpages.
999
1000 ------------------------------------------------------------------------------
1001
1002 # NEWS for rsync 3.1.2 (21 Dec 2015)
1003
1004 ## Changes in this version:
1005
1006 ### SECURITY FIXES:
1007
1008  - Make sure that all transferred files use only path names from inside the
1009    transfer. This makes it impossible for a malicious sender to try to make the
1010    receiver use an unsafe destination path for a transferred file, such as a
1011    just-sent symlink.
1012
1013 ### BUG FIXES:
1014
1015  - Change the checksum seed order in the per-block checksums. This prevents
1016    someone from trying to create checksum blocks that match in sum but not
1017    content.
1018
1019  - Fixed a with the per-dir filter files (using `-FF`) that could trigger an
1020    assert failure.
1021
1022  - Only skip `set_modtime()` on a transferred file if the time is exactly
1023    right.
1024
1025  - Don't create an empty backup dir for a transferred file that doesn't exist
1026    yet.
1027
1028  - Fixed a bug where `--link-dest` and `--xattrs` could cause rsync to exit if
1029    a filename had a matching dir of the same name in the alt-dest area.
1030
1031  - Allow more than 32 group IDs per user in the daemon's gid=LIST config.
1032
1033  - Fix the logging of %b & %c via `--log-file` (daemon logging was already
1034    correct, as was `--out-format='%b/%c'`).
1035
1036  - Fix erroneous acceptance of `--info=5` & `--debug=5` (an empty flag name is
1037    not valid).
1038
1039 ### ENHANCEMENTS:
1040
1041  - Added `(DRY RUN)` info to the `--debug=exit` output line.
1042
1043  - Use usleep() for our msleep() function if it is available.
1044
1045  - Added a few extra long-option names to rrsync script, which will make
1046    BackupPC happier.
1047
1048  - Made configure choose to use Linux xattrs on NetBSD (rather than not
1049    supporting xattrs).
1050
1051  - Added `-wo` (write-only) option to rrsync support script.
1052
1053  - Misc. manpage tweaks.
1054
1055 ### DEVELOPER RELATED:
1056
1057  - Fixed a bug with the Makefile's use of `INSTALL_STRIP`.
1058
1059  - Improve a test in the suite that could get an erroneous timestamp error.
1060
1061  - Tweaks for newer versions of git in the packaging tools.
1062
1063  - Improved the m4 generation rules and some autoconf idioms.
1064
1065 ------------------------------------------------------------------------------
1066
1067 # NEWS for rsync 3.1.1 (22 Jun 2014)
1068
1069 ## Changes in this version:
1070
1071 ### BUG FIXES:
1072
1073  - If the receiver gets bogus filenames from the sender (an unexpected leading
1074    slash or a `..` infix dir), exit with an error. This prevents a malicious
1075    sender from trying to inject filenames that would affect an area outside the
1076    destination directories.
1077
1078  - Fixed a failure to remove the partial-transfer temp file when interrupted
1079    (and rsync is not saving the partial files).
1080
1081  - Changed the chown/group/xattr-set order to avoid losing some security-
1082    related xattr info (that would get cleared by a chown).
1083
1084  - Fixed a bug in the xattr-finding code that could make a non-root-run
1085    receiver not able to find some xattr numbers.
1086
1087  - Fixed a bug in the early daemon protocol where a timeout failed to be
1088    honored (e.g. if the remote side fails to send us the initial protocol
1089    greeting).
1090
1091  - Fixed unintended inclusion of commas in file numbers in the daemon log.
1092
1093  - We once again send the 'f' sub-flag (of `-e`) to the server side so it knows
1094    that we can handle incremental-recursion directory errors properly in older
1095    protocols.
1096
1097  - Fixed an issue with too-aggressive keep-alive messages causing a problem for
1098    older rsync versions early in the transfer.
1099
1100  - Fixed an incorrect message about backup-directory-creation when using
1101    `--dry-run` and the backup dir is not an absolute path.
1102
1103  - Fixed a bug where a failed deletion and/or a failed sender-side removal
1104    would not affect the exit code.
1105
1106  - Fixed a bug that caused a failure when combining `--delete-missing-args`
1107    with `--xattrs` and/or `--acls`.
1108
1109  - Fixed a strange `dir_depth` assertion error that was caused by empty-dir
1110    removals and/or duplicate files in the transfer.
1111
1112  - Fixed a problem with `--info=progress2`'s output stats where rsync would
1113    only update the stats at the end of each file's transfer. It now uses the
1114    data that is flowing for the current file, making the stats more accurate
1115    and less jumpy.
1116
1117  - Fixed an itemize bug that affected the combo of `--link-dest`, `-X`, and
1118    `-n`.
1119
1120  - Fixed a problem with delete messages not appearing in the log file when the
1121    user didn't use `--verbose`.
1122
1123  - Improve chunked xattr reading for OS X.
1124
1125  - Removed an attempted hard-link xattr optimization that was causing a
1126    transfer failure. This removal is flagged in the compatibility code, so if a
1127    better fix can be discovered, we have a way to flip it on again.
1128
1129  - Fixed a bug when the receiver is not configured to be able to hard link
1130    symlimks/devices/special-file items but the sender sent some of these items
1131    flagged as hard-linked.
1132
1133  - We now generate a better error if the buffer overflows in `do_mknod()`.
1134
1135  - Fixed a problem reading more than 16 ACLs on some OSes.
1136
1137  - Fixed the reading of the secrets file to avoid an infinite wait when the
1138    username is missing.
1139
1140  - Fixed a parsing problem in the `--usermap`/`--groupmap` options when using
1141    MIN-MAX numbers.
1142
1143  - Switched Cygwin back to using socketpair `pipes` to try to speed it up.
1144
1145  - Added knowledge of a few new options to rrsync.
1146
1147 ### ENHANCEMENTS:
1148
1149  - Tweaked the temp-file naming when `--temp-dir=DIR` is used: the temp-file
1150    names will not get a '.' prepended.
1151
1152  - Added support for a new-compression idiom that does not compress all the
1153    matching data in a transfer. This can help rsync to use less cpu when a
1154    transfer has a lot of matching data, and also makes rsync compatible with a
1155    non-bundled zlib. See the `--new-compress` and `--old-compress` options in
1156    the manpage.
1157
1158  - Added the rsync-no-vanished shell script. (See the support dir.)
1159
1160  - Made configure more prominently mention when we failed to find yodl (in case
1161    the user wants to be able to generate manpages from `*.yo` files).
1162
1163  - Have manpage mention how a daemon's max-verbosity setting affects info and
1164    debug options. Also added more clarification on backslash removals for
1165    excludes that contain wildcards.
1166
1167  - Have configure check if for the attr lib (for getxattr) for those systems
1168    that need to link against it explicitly.
1169
1170  - Change the early dir-creation logic to only use that idiom in an
1171    inc-recursive copy that is preserving directory times. e.g. using
1172    `--omit-dir-times` will avoid these early directories being created.
1173
1174  - Fix a bug in `cmp_time()` that would return a wrong result if the 2 times
1175    differed by an amount greater than what a `time_t` can hold.
1176
1177 ### DEVELOPER RELATED:
1178
1179  - We now include an example systemd file (in packaging/systemd).
1180
1181  - Tweaked configure to make sure that any intended use of the included popt
1182    and/or zlib code is put early in the CFLAGS.
1183
1184 ------------------------------------------------------------------------------
1185
1186 # NEWS for rsync 3.1.0 (28 Sep 2013)
1187
1188 ## Changes in this version:
1189
1190 ### PROTOCOL NUMBER:
1191
1192  - The protocol number was changed to 31.
1193
1194 ### OUTPUT CHANGES:
1195
1196  - Output numbers in 3-digit groups by default (e.g. 1,234,567). See the
1197    `--human-readable` option for a way to turn it off. See also the daemon's
1198    `log format` parameter and related command-line options (including
1199    `--out-format`) for a modifier that can be used to request digit-grouping or
1200    human-readable output in log escapes. (Note that log output is unchanged by
1201    default.)
1202
1203  - The `--list-only` option is now affected by the `--human-readable` setting.
1204    It will display digit groupings by default, and unit suffixes if higher
1205    levels of readability are requested. Also, the column width for the size
1206    output has increased from 11 to 14 characters when human readability is
1207    enabled. Use `--no-h` to get the old-style output and column size.
1208
1209  - The output of the `--progress` option has changed: the string `xfer` was
1210    shortened to `xfr`, and the string `to-check` was shortened to `to-chk`,
1211    both designed to make room for the (by default) wider display of file size
1212    numbers without making the total line-length longer. Also, when incremental
1213    recursion is enabled, the string `ir-chk` will be used instead of `to-chk`
1214    up until the incremental-recursion scan is done, letting you know that the
1215    value to check and the total value will still be increasing as new files are
1216    found.
1217
1218  - Enhanced the `--stats` output: 1) to mention how many files were created
1219    (protocol >= 28), 2) to mention how many files were deleted (a new line for
1220    protocol 31, but only output when `--delete` is in effect), and 3) to follow
1221    the file-count, created-count, and deleted-count with a subcount list that
1222    shows the counts by type. The wording of the transferred count has also
1223    changed so that it is clearer that it is only a count of regular files.
1224
1225 ### BUG FIXES:
1226
1227  - Fixed a bug in the iconv code when EINVAL or EILSEQ is returned with a full
1228    output buffer.
1229
1230  - Fixed some rare bugs in `--iconv` processing that might cause a multi-byte
1231    character to get translated incorrectly.
1232
1233  - Fixed a bogus `vanished file` error if some files were specified with `./`
1234    prefixes and others were not.
1235
1236  - Fixed a bug in `--sparse` where an extra gap could get inserted after a
1237    partial write.
1238
1239  - Changed the way `--progress` overwrites its prior output in order to make it
1240    nearly impossible for the progress to get overwritten by an error.
1241
1242  - Improved the propagation of abnormal-exit error messages. This should help
1243    the client side to receive errors from the server when it is exiting
1244    abnormally, and should also avoid dying with an `connection unexpectedly
1245    closed` exit when the closed connection is really expected.
1246
1247  - The sender now checks each file it plans to remove to ensure that it hasn't
1248    changed from the first stat's info. This helps to avoid losing file data
1249    when the user is not using the option in a safe manner.
1250
1251  - Fixed a data-duplication bug in the compress option that made compression
1252    less efficient. This improves protocol 31 onward, while behaving in a
1253    compatible (buggy) manner with older rsync protocols.
1254
1255  - When creating a temp-file, rsync is now a bit smarter about it dot-char
1256    choices, which can fix a problem on OS X with names that start with `..`.
1257
1258  - Rsync now sets a cleanup flag for `--inplace` and `--append` transfers that
1259    will flush the write buffer if the transfer aborts. This ensures that more
1260    received data gets written out to the disk on an aborted transfer (which is
1261    quite helpful on a slow, flaky connection).
1262
1263  - The reads that `map_ptr()` now does are aligned on 1K boundaries. This helps
1264    some filesystems and/or files that don't like unaligned reads.
1265
1266  - Fix an issue in the msleep() function if time jumps backwards.
1267
1268  - Fix daemon-server module-name splitting bug where an arg would get split
1269    even if `--protect-args` was used.
1270
1271 ### ENHANCEMENTS:
1272
1273  - Added the `--remote-option=OPT` (`-M OPT`) command-line option that is
1274    useful for things like sending a remote `--log-file=FILE` or `--fake-super`
1275    option.
1276
1277  - Added the `--info=FLAGS` and `--debug=FLAGS` options to allow finer-grained
1278    control over what is output. Added an extra type of `--progress` output
1279    using `--info=progress2`.
1280
1281  - The `--msgs2stderr` option can help with debugging rsync by allowing the
1282    debug messages to get output to stderr rather than travel via the socket
1283    protocol.
1284
1285  - Added the `--delete-missing-args` and `--ignore-missing-args` options to
1286    either delete or ignore user-specified files on the receiver that are
1287    missing on the sender (normally the absence of user-specified files
1288    generates an error).
1289
1290  - Added a `T` (terabyte) category to the `--human-readable` size suffixes.
1291
1292  - Added the `--usermap`/`--groupmap`/`--chown` options for manipulating file
1293    ownership during the copy.
1294
1295  - Added the `%C` escape to the log-output handling, which will output the MD5
1296    checksum of any transferred file, or all files if `--checksum` was specified
1297    (when protocol 30 or above is in effect).
1298
1299  - Added the `reverse lookup` parameter to the rsync daemon config file to
1300    allow reverse-DNS lookups to be disabled.
1301
1302  - Added a forward-DNS lookup for the daemon's hosts allow/deny config. Can be
1303    disabled via `forward lookup` parameter (defaults to enabled).
1304
1305  - Added a way for more than one group to be specified in the daemon's config
1306    file, including a way to specify that you want all of the specified user's
1307    groups without having to name them. Also changed the daemon to complain
1308    about an inability to set explicitly-specified uid/gid values, even when not
1309    run by a super-user.
1310
1311  - The daemon now tries to send the user the error messages from the pre-xfer
1312    exec script when it fails.
1313
1314  - Improved the use of alt-dest options into an existing hierarchy of files: If
1315    a match is found in an alt-dir, it takes precedence over an existing file.
1316    (We'll need to wait for a future version before attribute-changes on
1317    otherwise unchanged files are safe when using an existing hierarchy.)
1318
1319  - Added per-user authorization options and group-authorization support to the
1320    daemon's `auth users` parameter.
1321
1322  - Added a way to reference environment variables in a daemon's config file
1323    (using %VAR% references).
1324
1325  - When replacing a non-dir with a symlink/hard-link/device/special-file, the
1326    update should now be done in an atomic manner.
1327
1328  - Avoid re-sending xattr info for hard-linked files w/the same xattrs
1329    (protocol 31).
1330
1331  - The backup code was improved to use better logic maintaining the backup
1332    directory hierarchy. Also, when a file is being backed up, rsync tries to
1333    hard-link it into place so that the upcoming replacement of the destination
1334    file will be atomic (for the normal, non-inplace logic).
1335
1336  - Added the ability to synchronize nanosecond modified times.
1337
1338  - Added a few more default suffixes for the `dont compress` settings.
1339
1340  - Added the checking of the `RSYNC_PROTECT_ARGS` environment variable to allow
1341    the default for the `--protect-args` command-line option to be overridden.
1342
1343  - Added the `--preallocate` command-line option.
1344
1345  - Allow `--password-file=-` to read the password from stdin (filename `-`).
1346
1347  - Rsync now comes packaged with an rsync-ssl helper script that can be used to
1348    contact a remote rsync daemon using a piped-stunnel command.  It also
1349    includes an stunnel config file to run the server side to support ssl daemon
1350    connections. See the packaging/lsb/rsync.spec file for one way to package
1351    the resulting files. (Suggestions for how to make this even easier to
1352    install & use are welcomed.)
1353
1354  - Improved the speed of some `--inplace` updates when there are lots of
1355    identical checksum blocks that end up being unusable.
1356
1357  - Added the `--outbuf=N|L|B` option for choosing the output buffering.
1358
1359  - Repeating the `--fuzzy` option now causes the code to look for fuzzy matches
1360    inside alt-dest directories too.
1361
1362  - The `--chmod` option now supports numeric modes, e.g. `--chmod=644,D755`
1363
1364  - Added some Solaris xattr code.
1365
1366  - Made an rsync daemon (the listening process) exit with a 0 status when it
1367    was signaled to die. This helps launchd.
1368
1369  - Improved the `RSYNC_*` environment variables for the pre-xfer exec script:
1370    when a daemon is sent multiple request args, they are now joined into a
1371    single return value (separated by spaces) so that the `RSYNC_REQUEST`
1372    environment variable is accurate for any `pre-xfer exec`. The values in
1373    `RSYNC_ARG#` vars are no longer truncated at the `.` arg (prior to the
1374    request dirs/files), so that all the requested values are also listed
1375    (separately) in `RSYNC_ARG#` variables.
1376
1377 ### EXTRAS:
1378
1379  - Added an `instant-rsyncd` script to the support directory, which makes it
1380    easy to configure a simple rsync daemon in the current directory.
1381
1382  - Added the `mapfrom` and `mapto` scripts to the support directory, which
1383    makes it easier to do user/group mapping in a local transfer based on
1384    passwd/group files from another machine.
1385
1386  - There's a new, improved version of the lsh script in the support dir: it's
1387    written in perl and supports `-u` without resorting to using sudo (when run
1388    as root). The old shell version is now named lsh.sh.
1389
1390  - There is a helper script named rsync-slash-strip in the support directory
1391    for anyone that wants to change the way rsync handles args with trailing
1392    slashes. (e.g. arg/ would get stripped to arg while arg/. would turn into
1393    arg/).
1394
1395 ### INTERNAL:
1396
1397  - The I/O code was rewritten to be simpler and do bigger buffered reads over
1398    the socket. The I/O between the receiver and the generator was changed to be
1399    standard multiplexed-I/O (like that over the socket).
1400
1401  - The sender tries to use any dead time while the generator is looking for
1402    files to transfer in order to do sender-side directory scanning in a more
1403    parallel manner.
1404
1405  - A daemon can now inform a client about a daemon-configured timeout value so
1406    that the client can assist in the keep-alive activity (protocol 31).
1407
1408  - The filter code received some refactoring to make it more extendable, to
1409    read better, and do better sanity checking.
1410
1411  - Really big numbers are now output using our own big-num routine rather than
1412    casting them to a double and using a %.0f conversion.
1413
1414  - The `pool_alloc` library has received some minor improvements in alignment
1415    handling.
1416
1417  - Added `init_stat_x()` function to avoid duplication of acl/xattr init code.
1418
1419  - The included zlib was upgraded from 1.2.3 to 1.2.8.
1420
1421  - Rsync can now be compiled to use an unmodified zlib library instead of the
1422    tweaked one that is included with rsync. This will eventually become the
1423    default, at which point we'll start the countdown to removing the included
1424    zlib. Until then, feel free to configure using:
1425
1426    ./configure `--with-included-zlib=no`
1427
1428 ### DEVELOPER RELATED:
1429
1430  - Added more conditional debug output.
1431
1432  - Fixed some build issues for Android and Minix.
1433
1434 ------------------------------------------------------------------------------
1435
1436 # NEWS for rsync 3.0.9 (23 Sep 2011)
1437
1438 ## Changes in this version:
1439
1440 ### BUG FIXES:
1441
1442  - Fix a crash bug in checksum scanning when `--inplace` is used.
1443
1444  - Fix a hang if a hard-linked file cannot be opened by the sender (e.g.  if it
1445    has no read permission).
1446
1447  - Fix preservation of a symlink's system xattrs (e.g. selinux) on Linux.
1448
1449  - Fix a memory leak in the xattr code.
1450
1451  - Fixed a bug with `--delete-excluded` when a filter merge file has a rule
1452    that specifies a receiver-only side restriction.
1453
1454  - Fix a bug with the modifying of unwritable directories.
1455
1456  - Fix `--fake-super`'s interaction with `--link-dest` same-file comparisons.
1457
1458  - Fix the updating of the `curr_dir` buffer to avoid a duplicate slash.
1459
1460  - Fix the directory permissions on an implied dot-dir when using `--relative`
1461    (e.g. /outside/path/././send/path).
1462
1463  - Fixed some too-long sleeping instances when using `--bwlimit`.
1464
1465  - Fixed when symlink ownership difference-checking gets compiled into
1466    `unchanged_attrs()`.
1467
1468  - Improved the socket-error reporting when multiple protocols fail.
1469
1470  - Fixed a case where a socket error could reference just-freed memory.
1471
1472  - Failing to use a password file that was specified on the command-line is now
1473    a fatal error.
1474
1475  - Fix the non-root updating of directories that don't have the read and/or
1476    execute permission.
1477
1478  - Make daemon-excluded file errors more error-like.
1479
1480  - Fix a compilation issue on older C compilers (due to a misplaced var
1481    declaration).
1482
1483  - Make configure avoid finding socketpair on Cygwin.
1484
1485  - Avoid trying to reference `SO_BROADCAST` if the OS doesn't support it.
1486
1487  - Fix some issues with the post-processing of the manpages.
1488
1489  - Fixed the user home-dir handling in the lsh script. (See the support dir.)
1490
1491  - Some minor manpage improvements.
1492
1493 ------------------------------------------------------------------------------
1494
1495 # NEWS for rsync 3.0.8 (26 Mar 2011)
1496
1497 ## Changes in this version:
1498
1499 ### BUG FIXES:
1500
1501  - Fixed two buffer-overflow issues: one where a directory path that is exactly
1502    MAXPATHLEN was not handled correctly, and one handling a `--backup-dir` that
1503    is extra extra large.
1504
1505  - Fixed a data-corruption issue when preserving hard-links without preserving
1506    file ownership, and doing deletions either before or during the transfer
1507    (CVE-2011-1097). This fixes some assert errors in the hard-linking code, and
1508    some potential failed checksums (via `-c`) that should have matched.
1509
1510  - Fixed a potential crash when an rsync daemon has a filter/exclude list and
1511    the transfer is using ACLs or xattrs.
1512
1513  - Fixed a hang if a really large file is being processed by an rsync that
1514    can't handle 64-bit numbers. Rsync will now complain about the file being
1515    too big and skip it.
1516
1517  - For devices and special files, we now avoid gathering useless ACL and/or
1518    xattr information for files that aren't being copied. (The un-copied files
1519    are still put into the file list, but there's no need to gather data that is
1520    not going to be used.) This ensures that if the user uses `--no-D`, that
1521    rsync can't possibly complain about being unable to gather extended
1522    information from special files that are in the file list (but not in the
1523    transfer).
1524
1525  - Properly handle requesting remote filenames that start with a dash. This
1526    avoids a potential error where a filename could be interpreted as a (usually
1527    invalid) option.
1528
1529  - Fixed a bug in the comparing of upper-case letters in file suffixes for
1530    `--skip-compress`.
1531
1532  - If an rsync daemon has a module configured without a path setting, rsync
1533    will now disallow access to that module.
1534
1535  - If the destination arg is an empty string, it will be treated as a reference
1536    to the current directory (as 2.x used to do).
1537
1538  - If rsync was compiled with a newer time-setting function (such as lutimes),
1539    rsync will fall-back to an older function (such as utimes) on a system where
1540    the newer function is not around. This helps to make the rsync binary more
1541    portable in mixed-OS-release situations.
1542
1543  - Fixed a batch-file writing bug that would not write out the full set of
1544    compatibility flags that the transfer was using. This fixes a potential
1545    protocol problem for a batch file that contains a sender-side I/O error: it
1546    would have been sent in a way that the batch-reader wasn't expecting.
1547
1548  - Some improvements to the hard-linking code to ensure that device-number
1549    hashing is working right, and to supply more information if the hard-link
1550    code fails.
1551
1552  - The `--inplace` code was improved to not search for an impossible checksum
1553    position. The quadruple-verbose chunk[N] message will now mention when an
1554    inplace chunk was handled by a seek rather than a read+write.
1555
1556  - Improved ACL mask handling, e.g. for Solaris.
1557
1558  - Fixed a bug that prevented `--numeric-ids` from disabling the translation of
1559    user/group IDs for ACLs.
1560
1561  - Fixed an issue where an xattr and/or ACL transfer that used an alt-dest
1562    option (e.g. `--link-dest`) could output an error trying to itemize the
1563    changes against the alt-dest directory's xattr/ACL info but was instead
1564    trying to access the not-yet-existing new destination directory.
1565
1566  - Improved xattr system-error messages to mention the full path to the file.
1567
1568  - The `--link-dest` checking for identical symlinks now avoids considering
1569    attribute differences that cannot be changed on the receiver.
1570
1571  - Avoid trying to read/write xattrs on certain file types for certain OSes.
1572    Improved configure to set `NO_SYMLINK_XATTRS`, `NO_DEVICE_XATTRS`, and/or
1573    `NO_SPECIAL_XATTRS` defines in config.h.
1574
1575  - Improved the unsafe-symlink errors messages.
1576
1577  - Fixed a bug setting xattrs on new files that aren't user writable.
1578
1579  - Avoid re-setting xattrs on a hard-linked file w/the same xattrs.
1580
1581  - Fixed a bug with `--fake-super` when copying files and dirs that aren't user
1582    writable.
1583
1584  - Fixed a bug where a sparse file could have its last sparse block turned into
1585    a real block when rsync sets the file size (requires ftruncate).
1586
1587  - If a temp-file name is too long, rsync now avoids truncating the name in the
1588    middle of adjacent high-bit characters. This prevents a potential filename
1589    error if the filesystem doesn't allow a name to contain an invalid
1590    multi-byte sequence.
1591
1592  - If a muli-protocol socket connection fails (i.e., when contacting a daemon),
1593    we now report all the failures, not just the last one. This avoids losing a
1594    relevant error (e.g. an IPv4 connection-refused error) that happened before
1595    the final error (e.g. an IPv6 protocol-not-supported error).
1596
1597  - Generate a transfer error if we try to call chown with a `-1` for a uid or a
1598    gid (which is not settable).
1599
1600  - Fixed the working of `--force` when used with `--one-file-system`.
1601
1602  - Fix the popt arg parsing so that an option that doesn't take an arg will
1603    reject an attempt to supply one (can configure `--with-included-popt` if
1604    your system's popt library doesn't yet have this fix).
1605
1606  - A couple minor option tweaks to the rrsync script, and also some regex
1607    changes that make vim highlighting happier. (See the support dir.)
1608
1609  - Fixed some issues in the mnt-excl script. (See the support dir.)
1610
1611  - Various manpage improvements.
1612
1613 ### ENHANCEMENTS:
1614
1615  - Added `.hg/` to the default cvs excludes (see `-C` & `--cvs-exclude`).
1616
1617 ### DEVELOPER RELATED:
1618
1619  - Use lchmod() whenever it is available (not just on symlinks).
1620
1621  - A couple fixes to the `socketpair_tcp()` routine.
1622
1623  - Updated the helper scripts in the packaging subdirectory.
1624
1625  - Renamed configure.in to configure.ac.
1626
1627  - Fixed configure's checking for iconv routines for newer OS X versions.
1628
1629  - Fixed the testsuite/xattrs.test script on OS X.
1630
1631 ------------------------------------------------------------------------------
1632
1633 # NEWS for rsync 3.0.7 (31 Dec 2009)
1634
1635 ## Changes in this version:
1636
1637 ### BUG FIXES:
1638
1639  - Fixed a bogus free when using `--xattrs` with `--backup`.
1640
1641  - Avoid an error when `--dry-run` was trying to stat a prior hard-link file
1642    that hasn't really been created.
1643
1644  - Fixed a problem with `--compress` (`-z`) where the receiving side could
1645    return the error "`inflate (token) returned -5`".
1646
1647  - Fixed a bug where `--delete-during` could delete in a directory before it
1648    noticed that the sending side sent an I/O error for that directory (both
1649    sides of the transfer must be at least 3.0.7).
1650
1651  - Improved `--skip-compress`'s error handling of bad character-sets and got
1652    rid of a lingering debug fprintf().
1653
1654  - Fixed the daemon's conveyance of `io_error` value from the sender.
1655
1656  - An rsync daemon use seteuid() (when available) if it used setuid().
1657
1658  - Get the permissions right on a `--fake-super` transferred directory that
1659    needs more owner permissions to emulate root behavior.
1660
1661  - An absolute-path filter rule (i.e. with a '/' modifier) no longer loses its
1662    modifier when sending the filter rules to the remote rsync.
1663
1664  - Improved the "`--delete does not work without -r or -d`" message.
1665
1666  - Improved rsync's handling of `--timeout` to avoid a weird timeout case where
1667    the sender could timeout even though it has recently written data to the
1668    socket (but hasn't read data recently, due to the writing).
1669
1670  - Some misc manpage improvements.
1671
1672  - Fixed the chmod-temp-dir testsuite on a system without /var/tmp.
1673
1674  - Make sure that a timeout specified in the daemon's config is used as a
1675    maximum timeout value when the user also specifies a timeout.
1676
1677  - Improved the error-exit reporting when rsync gets an error trying to cleanup
1678    after an error: the initial error is reported.
1679
1680  - Improved configure's detection of IPv6 for Solaris and Cygwin.
1681
1682  - The AIX sysacls routines will now return ENOSYS if ENOTSUP is missing.
1683
1684  - Made our (only used if missing) getaddrinfo() routine use `inet_pton()`
1685    (which we also provide) instead of `inet_aton()`.
1686
1687  - The exit-related debug messages now mention the program's role so it is
1688    clear who output what message.
1689
1690 ### DEVELOPER RELATED:
1691
1692  - Got rid of type-punned compiler warnings output by newer gcc versions.
1693
1694  - The Makefile now ensures that proto.h will be rebuilt if config.h changes.
1695
1696  - The testsuite no longer uses `id -u`, so it works better on Solaris.
1697
1698 ------------------------------------------------------------------------------
1699
1700 # NEWS for rsync 3.0.6 (8 May 2009)
1701
1702 ## Changes in this version:
1703
1704 ### BUG FIXES:
1705
1706  - Fixed a `--read-batch` hang when rsync is reading a batch file that was
1707    created from an incremental-recursion transfer.
1708
1709  - Fixed the daemon's socket code to handle the simultaneous arrival of
1710    multiple connections.
1711
1712  - Fix `--safe-links`/`--copy-unsafe-links` to properly handle symlinks that
1713    have consecutive slashes in the value.
1714
1715  - Fixed the parsing of an `[IPv6_LITERAL_ADDR]` when a USER@ is prefixed.
1716
1717  - The sender now skips a (bogus) symlink that has a 0-length value, which
1718    avoids a transfer error in the receiver.
1719
1720  - Fixed a case where the sender could die with a tag-0 error if there was an
1721    I/O during the sending of the file list.
1722
1723  - Fixed the rrsync script to avoid a server-side problem when `-e` is at the
1724    start of the short options.
1725
1726  - Fixed a problem where a vanished directory could turn into an exit code 23
1727    instead of the proper exit code 24.
1728
1729  - Fixed the `--iconv` conversion of symlinks when doing a local copy.
1730
1731  - Fixed a problem where `--one-file-system` was not stopping deletions on the
1732    receiving side when a mount-point directory did not match a directory in the
1733    transfer.
1734
1735  - Fixed the dropping of an ACL mask when no named ACL values were present.
1736
1737  - Fixed an ACL/xattr corruption issue where the `--backup` option could cause
1738    rsync to associate the wrong ACL/xattr information with received files.
1739
1740  - Fixed the use of `--xattrs` with `--only-write-batch`.
1741
1742  - Fixed the use of `--dry-run` with `--read-batch`.
1743
1744  - Fixed configure's erroneous use of target.
1745
1746  - Fixed configure's `--disable-debug` option.
1747
1748  - Fixed a run-time issue for systems that can't find `iconv_open()` by adding
1749    the `--disable-iconv-open` configure option.
1750
1751  - Complain and die if the user tries to combine `--remove-source-files` (or
1752    the deprecated `--remove-sent-files`) with `--read-batch`.
1753
1754  - Fixed an failure transferring special files from Solaris to Linux.
1755
1756 ------------------------------------------------------------------------------
1757
1758 # NEWS for rsync 3.0.5 (28 Dec 2008)
1759
1760 ## Changes in this version:
1761
1762 ### BUG FIXES:
1763
1764  - Initialize xattr data in a couple spots in the hlink code, which avoids a
1765    crash when the xattr pointer's memory happens to start out non-zero.  Also
1766    fixed the itemizing of an alt-dest file's xattrs when hard-linking.
1767
1768  - Don't send a bogus `-` option to an older server if there were no short
1769    options specified.
1770
1771  - Fixed skipping of unneeded updates in a batch file when incremental
1772    recursion is active. Added a test for this. Made batch-mode handle `redo`
1773    files properly (and without hanging).
1774
1775  - Fix the %P logfile escape when the daemon logs from inside a chroot.
1776
1777  - Fixed the use of `-s` (`--protect-args`) when used with a remote source or
1778    destination that had an empty path (e.g. `host:`). Also fixed a problem when
1779    `-s` was used when accessing a daemon via a remote-shell.
1780
1781  - Fixed the use of a dot-dir path (e.g. foo/./bar) inside a `--files-from`
1782    file when the root of the transfer isn't the current directory.
1783
1784  - Fixed a bug with `-K --delete` removing symlinks to directories when
1785    incremental recursion is active.
1786
1787  - Fixed a hard to trigger hang when using `--remove-source-files`.
1788
1789  - Got rid of an annoying delay when accessing a daemon via a remote-shell.
1790
1791  - Properly ignore (superfluous) source args on a `--read-batch` command.
1792
1793  - Improved the manpage's description of the `*` wildcard to remove the
1794    confusing `non-empty` qualifier.
1795
1796  - Fixed reverse lookups in the compatibility-library version of getnameinfo().
1797
1798  - Fixed a bug when using `--sparse` on a sparse file that has over 2GB of
1799    consecutive sparse data.
1800
1801  - Avoid a hang when using at least 3 `--verbose` options on a transfer with a
1802    client sender (which includes local copying).
1803
1804  - Fixed a problem with `--delete-delay` reporting an error when it was ready
1805    to remove a directory that was now gone.
1806
1807  - Got rid of a bunch of `warn_unused_result` compiler warnings.
1808
1809  - If an ftruncate() on a received file fails, it now causes a partial-
1810    transfer warning.
1811
1812  - Allow a path with a leading `//` to be preserved (CYGWIN only).
1813
1814 ### ENHANCEMENTS:
1815
1816  - Made the atomic-rsync script able to perform a fully atomic update of the
1817    copied hierarchy when the destination is setup using a particular symlink
1818    idiom. (See the support dir.)
1819
1820 ------------------------------------------------------------------------------
1821
1822 # NEWS for rsync 3.0.4 (6 Sep 2008)
1823
1824 ## Changes in this version:
1825
1826 ### BUG FIXES:
1827
1828  - Fixed a bug in the hard-linking code where it would sometimes try to
1829    allocate 0 bytes of memory (which fails on some OSes, such as AIX).
1830
1831  - Fixed the hard-linking of files from a device that has a device number of 0
1832    (which seems to be a common device number on NetBSD).
1833
1834  - Fixed the handling of a `--partial-dir` that cannot be created. This
1835    particularly impacts the `--delay-updates` option (since the files cannot be
1836    delayed without a partial-dir), and was potentially destructive if the
1837    `--remove-source-files` was also specified.
1838
1839  - Fixed a couple issues in the `--fake-super` handling of xattrs when the
1840    destination files have root-level attributes (e.g. selinux values) that a
1841    non-root copy can't affect.
1842
1843  - Improved the keep-alive check in the generator to fire consistently in
1844    incremental-recursion mode when `--timeout` is enabled.
1845
1846  - The `--iconv` option now converts the content of a symlink too, instead of
1847    leaving it in the wrong character-set (requires 3.0.4 on both sides of the
1848    transfer).
1849
1850  - When using `--iconv`, if a filename fails to convert on the receiving side,
1851    this no longer makes deletions in the root-dir of the transfer fail silently
1852    (the user now gets a warning about deletions being disabled due to IO error
1853    as long as `--ignore-errors` was not specified).
1854
1855  - When using `--iconv`, if a server-side receiver can't convert a filename,
1856    the error message sent back to the client no longer mangles the name with
1857    the wrong charset conversion.
1858
1859  - Fixed a potential alignment issue in the IRIX ACL code when allocating the
1860    initial `struct acl` object. Also, cast mallocs to avoid warnings.
1861
1862  - Changed some errors that were going to stdout to go to stderr.
1863
1864  - Made `human_num()` and `human_dnum()` able to output a negative number
1865    (rather than outputting a cryptic string of punctuation).
1866
1867 ### ENHANCEMENTS:
1868
1869  - Rsync will avoid sending an `-e` option to the server if an older protocol
1870    is requested (and thus the option would not be useful). This lets the user
1871    specify the `--protocol=29` option to access an overly-restrictive server
1872    that is rejecting the protocol-30 use of `-e` to the server.
1873
1874  - Improved the message output for an `RERR_PARTIAL` exit.
1875
1876 ### DEVELOPER RELATED:
1877
1878  - The Makefile will not halt for just a timestamp change on the Makefile or
1879    the configure files, only for actual changes in content.
1880
1881  - Changed some commands in the testsuite's xattrs.test that called `rsync`
1882    instead of `$RSYNC`.
1883
1884  - Enhanced the release scripts to be able to handle a branch release and to do
1885    even more consistency checks on the files.
1886
1887 ------------------------------------------------------------------------------
1888
1889 # NEWS for rsync 3.0.3 (29 Jun 2008)
1890
1891 ## Changes in this version:
1892
1893 ### BUG FIXES:
1894
1895  - Fixed a wildcard matching problem in the daemon when a module has `use
1896    chroot` enabled.
1897
1898  - Fixed a crash bug in the hard-link code.
1899
1900  - Fixed the sending of xattr directory information when the code finds a
1901    `--link-dest` or `--copy-dest` directory with unchanged xattrs -- the
1902    destination directory now gets these unchanged xattrs properly applied.
1903
1904  - Fixed an xattr-sending glitch that could cause an `Internal abbrev` error.
1905
1906  - Fixed the combination of `--xattrs` and `--backup`.
1907
1908  - The generator no longer allows a '.' dir to be excluded by a daemon-exclude
1909    rule.
1910
1911  - Fixed deletion handling when copying a single, empty directory (with no
1912    files) to a differently named, non-existent directory.
1913
1914  - Fixed the conversion of spaces into dashes in the %M log escape.
1915
1916  - Fixed several places in the code that were not returning the right errno
1917    when a function failed.
1918
1919  - Fixed the backing up of a device or special file into a backup dir.
1920
1921  - Moved the setting of the socket options prior to the connect().
1922
1923  - If rsync exits in the middle of a `--progress` output, it now outputs a
1924    newline to help prevent the progress line from being overwritten.
1925
1926  - Fixed a problem with how a destination path with a trailing slash or a
1927    trailing dot-dir was compared against the daemon excludes.
1928
1929  - Fixed the sending of large (size > 16GB) files when talking to an older
1930    rsync (protocols < 30): we now use a compatible block size limit.
1931
1932  - If a file's length is so huge that we overflow a checksum buffer count (i.e.
1933    several hundred TB), warn the user and avoid sending an invalid checksum
1934    struct over the wire.
1935
1936  - If a source arg is excluded, `--relative` no longer adds the excluded arg's
1937    implied dirs to the transfer. This fix also made the exclude check happen in
1938    the better place in the sending code.
1939
1940  - Use the `overflow_exit()` function for overflows, not `out_of_memory()`.
1941
1942  - Improved the code to better handle a system that has only 32-bit file
1943    offsets.
1944
1945 ### ENHANCEMENTS:
1946
1947  - The rsyncd.conf manpage now consistently refers to the parameters in the
1948    daemon config file as `parameters`.
1949
1950  - The description of the `--inplace` option was improved.
1951
1952 ### EXTRAS:
1953
1954  - Added a new script in the support directory, deny-rsync, which allows an
1955    admin to (temporarily) replace the rsync command with a script that sends an
1956    error message to the remote client via the rsync protocol.
1957
1958 ### DEVELOPER RELATED:
1959
1960  - Fixed a testcase failure if the tests are run as root and made some
1961    compatibility improvements.
1962
1963  - Improved the daemon tests, including checking module comments, the listing
1964    of files, and the ensuring that daemon excludes can't affect a dot-dir arg.
1965
1966  - Improved some build rules for those that build in a separate directory from
1967    the source, including better install rules for the manpages, and the fixing
1968    of a proto.h-tstamp rule that could make the binaries get rebuild without
1969    cause.
1970
1971  - Improved the testsuite to work around a problem with some utilities (e.g.
1972    `cp -p` & `touch -r`) rounding sub-second timestamps.
1973
1974  - Ensure that the early patches don't cause any generated-file hunks to
1975    bleed-over into patches that follow.
1976
1977 ------------------------------------------------------------------------------
1978
1979 # NEWS for rsync 3.0.2 (8 Apr 2008)
1980
1981 ## Changes in this version:
1982
1983 ### BUG FIXES:
1984
1985  - Fixed a potential buffer overflow in the xattr code.
1986
1987 ### ENHANCEMENTS:
1988
1989  - None.
1990
1991 ### DEVELOPER RELATED:
1992
1993  - The RPM spec file was improved to install more useful files.
1994
1995  - A few developer-oriented scripts were moved from the support dir to the
1996    packaging dir.
1997
1998 ------------------------------------------------------------------------------
1999
2000 # NEWS for rsync 3.0.1 (3 Apr 2008)
2001
2002 ## Changes in this version:
2003
2004 ### NOTABLE CHANGES IN BEHAVIOR:
2005
2006  - Added the 'c'-flag to the itemizing of non-regular files so that the
2007    itemized output doesn't get hidden if there were no attribute changes, and
2008    also so that the itemizing of a `--copy-links` run will distinguish between
2009    copying an identical non-regular file and the creation of a revised version
2010    with a new value (e.g. a changed symlink referent, a new device number,
2011    etc.).
2012
2013 ### BUG FIXES:
2014
2015  - Fixed a crash bug when a single-use rsync daemon (via remote shell) was run
2016    without specifying a `--config=FILE` option.
2017
2018  - Fixed a crash when backing up a directory that has a default ACL.
2019
2020  - Fixed a bug in the handling of xattr values that could cause rsync to not
2021    think that a file's extended attributes are up-to-date.
2022
2023  - Fixed the working of `--fake-super` with `--link-dest` and `--xattrs`.
2024
2025  - Fixed a hang when combining `--dry-run` with `--remove-source-files`.
2026
2027  - Fixed a bug with `--iconv`'s handling of files that cannot be converted: a
2028    failed name can no longer cause a transfer failure.
2029
2030  - Fixed the building of the rounding.h file on systems that need custom
2031    CPPFLAGS to be used. Also improved the error reporting if the building of
2032    rounding.h fails.
2033
2034  - Fixed the use of the `--protect-args` (`-s`) option when talking to a
2035    daemon.
2036
2037  - Fixed the `--ignore-existing` option's protection of files on the receiver
2038    that are non-regular files on the sender (e.g. if a symlink or a dir on the
2039    sender is trying to replace a file on the receiver). The reverse protection
2040    (protecting a dir/symlink/device from being replaced by a file) was already
2041    working.
2042
2043  - Fixed an assert failure if `--hard-links` is combined with an option that
2044    can skip a file in a set of hard-linked files (i.e. `--ignore-existing`,
2045    `--append`, etc.), without skipping all the files in the set.
2046
2047  - Avoid setting the modify time on a directory that already has the right
2048    modify time set. This avoids tweaking the dir's ctime.
2049
2050  - Improved the daemon-exclude handling to do a better job of applying the
2051    exclude rules to path entries. It also sends the user an error just as if
2052    the files were actually missing (instead of silently ignoring the user's
2053    args), and avoids sending the user the filter-action messages for these
2054    non-user-initiated rules.
2055
2056  - Fixed some glitches with the dry-run code's missing-directory handling,
2057    including a problem when combined with `--fuzzy`.
2058
2059  - Fixed some glitches with the skipped-directory handling.
2060
2061  - Fixed the 'T'-flag itemizing of symlinks when `--time` isn't preserved.
2062
2063  - Fixed a glitch in the itemizing of permissions with the `-E` option.
2064
2065  - The `--append` option's restricting of transfers to those that add data no
2066    longer prevents the updating of non-content changes to otherwise up-to-date
2067    files (i.e. those with the same content but differing permissions,
2068    ownership, xattrs, etc.).
2069
2070  - Don't allow `--fake-super` to be specified with `-XX` (double `--xattrs`)
2071    because the options conflict. If a daemon has `fake super` enabled, it
2072    automatically downgrades a `-XX` request to `-X`.
2073
2074  - Fixed a couple bugs in the parsing of daemon-config excludes that could make
2075    a floating exclude rule get treated as matching an absolute path.
2076
2077  - A daemon doesn't try to auto-refuse the `iconv` option if iconv-support
2078    wasn't compiled in to the daemon (avoiding a warning in the logs).
2079
2080  - Fixed the inclusion of per-dir merge files from implied dirs.
2081
2082  - Fixed the rrsync script to work with the latest options that rsync sends,
2083    including its flag-specifying use of `-e` to the server. (See the support
2084    dir.)
2085
2086 ### ENHANCEMENTS:
2087
2088  - Added the `--old-dirs` (`--old-d`) option to make it easier for a user to
2089    ask for file-listings with older rsync versions (this is easier than having
2090    to type `-r --exclude='/*/*'` manually).
2091
2092  - When getting an error while asking an older rsync daemon for a file listing,
2093    rsync will try to notice if the error is a rejection of the `--dirs` (`-d`)
2094    option and let the user know how to work around the issue.
2095
2096  - Added a few more `--no-OPTION` overrides.
2097
2098  - Improved the documentation of the `--append` option.
2099
2100  - Improved the documentation of the filter/exclude/include daemon parameters.
2101
2102 ### INTERNAL:
2103
2104  - Fixed a couple minor bugs in the included popt library (ones which I sent to
2105    the official popt project for inclusion in the 1.14 release).
2106
2107  - Fixed a stat() call that should have been `do_stat()` so that the proper
2108    normal/64-bit stat() function gets called. (Was in an area that should not
2109    have caused problems, though.)
2110
2111  - Changed the file-glob code to do a directory scan without using the `glob`
2112    and `glob.h`. This lets us do the globbing with less memory churn, and also
2113    avoid adding daemon-excluded items to the returned args.
2114
2115 ### DEVELOPER RELATED:
2116
2117  - The configure script tries to get the user's compiler to not warn about
2118    unused function parameters if the build is not including one or more of the
2119    ACL/xattrs/iconv features.
2120
2121  - The configure script now has better checks for figuring out if the included
2122    popt code should be used or not.
2123
2124  - Fixed two testsuite glitches: avoid a failure if someone's `cd` command
2125    outputs the current directory when cd-ing to a relative path, and made the
2126    itemized test query how rsync was built to determine if it should expect
2127    hard-linked symlinks or not.
2128
2129  - Updated the testsuite to verify that various bug fixes remain fixed.
2130
2131  - The RPM spec file was updated to have: (1) comments for how to use the
2132    rsync-patch tar file, and (2) an /etc/xinetd.d/rsync file.
2133
2134  - Updated the build scripts to work with a revised FTP directory structure.
2135
2136 ------------------------------------------------------------------------------
2137
2138 # NEWS for rsync 3.0.0 (1 Mar 2008)
2139
2140 ## Changes in this version:
2141
2142 ### PROTOCOL NUMBER:
2143
2144  - The protocol number was changed to 30.
2145
2146 ### NOTABLE CHANGES IN BEHAVIOR:
2147
2148  - The handling of implied directories when using `--relative` has changed to
2149    send them as directories (e.g. no implied dir is ever sent as a symlink).
2150    This avoids unexpected behavior and should not adversely affect most people.
2151    If you're one of those rare individuals who relied upon having an implied
2152    dir be duplicated as a symlink, you should specify the transfer of the
2153    symlink and the transfer of the referent directory as separate args. (See
2154    also `--keep-dirlinks` and `--no-implied-dirs`.) Also, exclude rules no
2155    longer have a partial effect on implied dirs.
2156
2157  - Requesting a remote file-listing without specifying `-r` (`--recursive`) now
2158    sends the `-d` (`--dirs`) option to the remote rsync rather than sending
2159    `-r` along with an extra exclude of `/*/*`. If the remote rsync does not
2160    understand the `-d` option (i.e. it is 2.6.3 or older), you will need to
2161    either turn off `-d` (`--no-d`), or specify `-r --exclude='/*/*'` manually.
2162
2163  - In `--dry-run` mode, the last line of the verbose summary text is output
2164    with a "(DRY RUN)" suffix to help remind you that no updates were made.
2165    Similarly, `--only-write-batch` outputs `(BATCH ONLY)`.
2166
2167  - A writable rsync daemon with `use chroot` disabled now defaults to a
2168    symlink-munging behavior designed to make symlinks safer while also allowing
2169    absolute symlinks to be stored and retrieved. This also has the effect of
2170    making symlinks unusable while they're in the daemon's hierarchy. See the
2171    daemon's `munge symlinks` parameter for details.
2172
2173  - Starting up an extra copy of an rsync daemon will not clobber the pidfile
2174    for the running daemon -- if the pidfile exists, the new daemon will exit
2175    with an error. This means that your wrapper script that starts the rsync
2176    daemon should be made to handle lock-breaking (if you want any automatic
2177    breaking of locks to be done).
2178
2179 ### BUG FIXES:
2180
2181  - A daemon with `use chroot = no` and excluded items listed in the daemon
2182    config file now properly checks an absolute-path arg specified for these
2183    options: `--compare-dest`, `--link-dest`, `--copy-dest`, `--partial-dir`,
2184    `--backup-dir`, `--temp-dir`, and `--files-from`.
2185
2186  - A daemon can now be told to disable all user- and group-name translation on
2187    a per-module basis. This avoids a potential problem with a writable daemon
2188    module that has `use chroot` enabled -- if precautions weren't taken, a user
2189    could try to add a missing library and get rsync to use it. This makes rsync
2190    safer by default, and more configurable when id-translation is not desired.
2191    See the daemon's `numeric ids` parameter for full details.
2192
2193  - A chroot daemon can now indicate which part of its path should affect the
2194    chroot call, and which part should become an inside-chroot path for the
2195    module. This allows you to have outside-the-transfer paths (such as for
2196    libraries) even when you enable chroot protection. The idiom used in the
2197    rsyncd.conf file is: `path = /chroot/dirs/./dirs/inside`
2198
2199  - If a file's data arrived successfully on the receiving side but the rename
2200    of the temporary file to the destination file failed AND the
2201    `--remove-source-files` (or the deprecated `--remove-sent-files`) option was
2202    specified, rsync no longer erroneously removes the associated source file.
2203
2204  - Fixed the output of `-ii` when combined with one of the `--*-dest` options:
2205    it now itemizes all the items, not just the changed ones.
2206
2207  - Made the output of all file types consistent when using a `--*-dest` option.
2208    Prior versions would output too many creation events for matching items.
2209
2210  - The code that waits for a child pid now handles being interrupted by a
2211    signal. This fixes a problem with the pre-xfer exec function not being able
2212    to get the exit status from the script.
2213
2214  - A negated filter rule (i.e. with a '!' modifier) no longer loses the
2215    negation when sending the filter rules to the remote rsync.
2216
2217  - Fixed a problem with the `--out-format` (aka `--log-format`) option %f: it
2218    no longer outputs superfluous directory info for a non-daemon rsync.
2219
2220  - Fixed a problem with `-vv` (double `--verbose`) and `--stats` when `pushing`
2221    files (which includes local copies). Version 2.6.9 would complete the copy,
2222    but exit with an error when the receiver output its memory stats.
2223
2224  - If `--password-file` is used on a non-daemon transfer, rsync now complains
2225    and exits. This should help users figure out that they can't use this option
2226    to control a remote shell's password prompt.
2227
2228  - Make sure that directory permissions of a newly-created destination
2229    directory are handled right when `--perms` is left off.
2230
2231  - The itemized output of a newly-created destination directory is now output
2232    as a creation event, not a change event.
2233
2234  - Improved `--hard-link` so that more corner cases are handled correctly when
2235    combined with options such as `--link-dest` and/or `--ignore-existing`.
2236
2237  - The `--append` option no longer updates a file that has the same size.
2238
2239  - Fixed a bug when combining `--backup` and `--backup-dir` with `--inplace`:
2240    any missing backup directories are now created.
2241
2242  - Fixed a bug when using `--backup` and `--inplace` with `--whole-file` or
2243    `--read-batch`: backup files are actually created now.
2244
2245  - The daemon pidfile is checked and created sooner in the startup sequence.
2246
2247  - If a daemon module's `path` value is not an absolute pathname, the code now
2248    makes it absolute internally (making it work properly).
2249
2250  - Ensure that a temporary file always has owner-write permission while we are
2251    writing to it. This avoids problems with some network filesystems when
2252    transferring read-only files.
2253
2254  - Any errors output about password-file reading no longer cause an error at
2255    the end of the run about a partial transfer.
2256
2257  - The `--read-batch` option for protocol 30 now ensures that several more
2258    options are set correctly for the current batch file: `--iconv`, `--acls`,
2259    `--xattrs`, `--inplace`, `--append`, and `--append-verify`.
2260
2261  - Using `--only-write-batch` to a daemon receiver now works properly (older
2262    versions would update some files while writing the batch).
2263
2264  - Avoid outputting a "file has vanished" message when the file is a broken
2265    symlink and `--copy-unsafe-links` or `--copy-dirlinks` is used (the code
2266    already handled this for `--copy-links`).
2267
2268  - Fixed the combination of `--only-write-batch` and `--dry-run`.
2269
2270  - Fixed rsync's ability to remove files that are not writable by the file's
2271    owner when rsync is running as the same user.
2272
2273  - When transferring large files, the sender's hashtable of checksums is kept
2274    at a more reasonable state of fullness (no more than 80% full) so that the
2275    scanning of the hashtable will not bog down as the number of blocks
2276    increases.
2277
2278 ### ENHANCEMENTS:
2279
2280  - A new incremental-recursion algorithm is now used when rsync is talking to
2281    another 3.x version. This starts the transfer going more quickly (before all
2282    the files have been found), and requires much less memory.  See the
2283    `--recursive` option in the manpage for some restrictions.
2284
2285  - Lowered memory use in the non-incremental-recursion algorithm for typical
2286    option values (usually saving from 21-29 bytes per file).
2287
2288  - The default `--delete` algorithm is now `--delete-during` when talking to a
2289    3.x rsync. This is a faster scan than using `--delete-before` (which is the
2290    default when talking to older rsync versions), and is compatible with the
2291    new incremental recursion mode.
2292
2293  - Rsync now allows multiple remote-source args to be specified rather than
2294    having to rely on a special space-splitting side-effect of the remote-
2295    shell. Additional remote args must specify the same host or an empty one
2296    (e.g. empty: `:file1` or `::module/file2`). For example, this means that
2297    local use of brace expansion now works: `rsync -av host:dir/{f1,f2} .`
2298
2299  - Added the `--protect-args` (`-s`) option, that tells rsync to send most of
2300    the command-line args at the start of the transfer rather than as args to
2301    the remote-shell command. This protects them from space-splitting, and only
2302    interprets basic wildcard special shell characters (`*?[`).
2303
2304  - Added the `--delete-delay` option, which is a more efficient way to delete
2305    files at the end of the transfer without needing a separate delete pass.
2306
2307  - Added the `--acls` (`-A`) option to preserve Access Control Lists. This is
2308    an improved version of the prior patch that was available, and it even
2309    supports OS X ACLs. If you need to have backward compatibility with old,
2310    ACL-patched versions of rsync, apply the acls.diff file from the patches
2311    dir.
2312
2313  - Added the `--xattrs` (`-X`) option to preserve extended attributes. This is
2314    an improved version of the prior patch that was available, and it even
2315    supports OS X xattrs (which includes their resource fork data). If you need
2316    to have backward compatibility with old, xattr-patched versions of rsync,
2317    apply the xattrs.diff file from the patches dir.
2318
2319  - Added the `--fake-super` option that allows a non-super user to preserve all
2320    attributes of a file by using a special extended-attribute idiom.  It even
2321    supports the storing of foreign ACL data on your backup server.  There is
2322    also an analogous `fake super` parameter for an rsync daemon.
2323
2324  - Added the `--iconv` option, which allows rsync to convert filenames from one
2325    character-set to another during the transfer. The default is to make this
2326    feature available as long as your system has `iconv_open()`.  If compilation
2327    fails, specify `--disable-iconv` to configure, and then rebuild. If you want
2328    rsync to perform character-set conversions by default, you can specify
2329    `--enable-iconv=CONVERT_STRING` with the default value for the `--iconv`
2330    option that you wish to use. For example, `--enable-iconv=.` is a good
2331    choice. See the rsync manpage for an explanation of the `--iconv` option's
2332    settings.
2333
2334  - A new daemon config parameter, `charset`, lets you control the character-
2335    set that is used during an `--iconv` transfer to/from a daemon module. You
2336    can also set your daemon to refuse `no-iconv` if you want to force the
2337    client to use an `--iconv` transfer (requiring an rsync 3.x client).
2338
2339  - Added the `--skip-compress=LIST` option to override the default list of file
2340    suffixes that will not be compressed when using `--compress` (`-z`).
2341
2342  - The daemon's default for `dont compress` was extended to include: `*.7z`
2343    `*.mp[34]` `*.mov` `*.avi` `*.ogg` `*.jpg` `*.jpeg` and the name-matching routine was also
2344    optimized to run more quickly.
2345
2346  - The `--max-delete` option now outputs a warning if it skipped any file
2347    deletions, including a count of how many deletions were skipped. (Older
2348    versions just silently stopped deleting things.)
2349
2350  - You may specify `--max-delete=0` to a 3.0.0 client to request that it warn
2351    about extraneous files without deleting anything. If you're not sure what
2352    version the client is, you can use the less-obvious `--max-delete=-1`, as
2353    both old and new versions will treat that as the same request (though older
2354    versions don't warn).
2355
2356  - The `--hard-link` option now uses less memory on both the sending and
2357    receiving side for all protocol versions. For protocol 30, the use of a
2358    hashtable on the sending side allows us to more efficiently convey to the
2359    receiver what files are linked together. This reduces the amount of data
2360    sent over the socket by a considerable margin (rather than adding more
2361    data), and limits the in-memory storage of the device+inode information to
2362    just the sending side for the new protocol 30, or to the receiving side when
2363    speaking an older protocol (note that older rsync versions kept the
2364    device+inode information on both sides).
2365
2366  - The filter rules now support a perishable (`p`) modifier that marks rules
2367    that should not have an effect in a directory that is being deleted. e.g.
2368    `-f '-p .svn/'` would only affect `live` .svn directories.
2369
2370  - Rsync checks all the alternate-destination args for validity (e.g.
2371    `--link-dest`). This lets the user know when they specified a directory that
2372    does not exist.
2373
2374  - If we get an ENOSYS error setting the time on a symlink, we don't complain
2375    about it anymore (for those systems that even support the setting of the
2376    modify-time on a symlink).
2377
2378  - Protocol 30 now uses MD5 checksums instead of MD4.
2379
2380  - Changed the `--append` option to not checksum the existing data in the
2381    destination file, which speeds up file appending.
2382
2383  - Added the `--append-verify` option, which works like the older `--append`
2384    option (verifying the existing data in the destination file). For
2385    compatibility with older rsync versions, any use of `--append` that is
2386    talking protocol 29 or older will revert to the `--append-verify` method.
2387
2388  - Added the `--contimeout=SECONDS` option that lets the user specify a
2389    connection timeout for rsync daemon access.
2390
2391  - Documented and extended the support for the `RSYNC_CONNECT_PROG` variable
2392    that can be used to enhance the client side of a daemon connection.
2393
2394  - Improved the dashes and double-quotes in the nroff manpage output.
2395
2396  - Rsync now supports a lot more `--no-OPTION` override options.
2397
2398 ### INTERNAL:
2399
2400  - The file-list sorting algorithm now uses a sort that keeps any same-named
2401    items in the same order as they were specified. This allows rsync to always
2402    ensure that the first of the duplicates is the one that will be included in
2403    the copy. The new sort is also faster than the glibc version of qsort() and
2404    mergesort().
2405
2406  - Rsync now supports the transfer of 64-bit timestamps (`time_t` values).
2407
2408  - Made the file-deletion code use a little less stack when recursing through a
2409    directory hierarchy of extraneous files.
2410
2411  - Fixed a build problem with older (2.x) versions of gcc.
2412
2413  - Added some isType() functions that make dealing with signed characters
2414    easier without forcing variables via casts.
2415
2416  - Changed strcat/strcpy/sprintf function calls to use safer versions.
2417
2418  - Upgraded the included popt version to 1.10.2 and improved its use of
2419    string-handling functions.
2420
2421  - Added missing prototypes for compatibility functions from the lib dir.
2422
2423  - Configure determines if iconv() has a const arg, allowing us to avoid a
2424    compiler warning.
2425
2426  - Made the sending of some numbers more efficient for protocol 30.
2427
2428  - Make sure that a daemon process doesn't mind if the client was weird and
2429    omitted the `--server` option.
2430
2431  - There are more internal logging categories available in protocol 30 than the
2432    age-old FINFO and FERROR, including `FERROR_XFER` and FWARN. These new
2433    categories allow some errors and warnings to go to stderr without causing an
2434    erroneous end-of-run warning about some files not being able to be
2435    transferred.
2436
2437  - Improved the use of `const` on pointers.
2438
2439  - Improved J.W.'s `pool_alloc` routines to add a way of incrementally freeing
2440    older sections of a pool's memory.
2441
2442  - The getaddrinfo.c compatibility code in the `lib` dir was replaced with some
2443    new code (derived from samba, derived from PostgreSQL) that has a better
2444    license than the old code.
2445
2446 ### DEVELOPER RELATED:
2447
2448  - Rsync is now licensed under the GPLv3 or later.
2449
2450  - Rsync is now being maintained in a `git` repository instead of CVS (though
2451    the old CVS repository still exists for historical access).  Several
2452    maintenance scripts were updated to work with git.
2453
2454  - Generated files are no longer committed into the source repository. The
2455    autoconf and autoheader commands are now automatically run during the normal
2456    use of `configure` and `make`. The latest dev versions of all generated
2457    files can also be copied from the samba.org web site (see the prepare-source
2458    script's fetch option).
2459
2460  - The `patches` directory of diff files is now built from branches in the
2461    rsync git repository (branch patch/FOO creates file patches/FOO.diff).  This
2462    directory is now distributed in a separate separate tar file named
2463    rsync-patches-VERSION.tar.gz instead of the main rsync-VERSION.tar.gz.
2464
2465  - The proto.h file is now built using a simple perl script rather than a
2466    complex awk script, which proved to be more widely compatible.
2467
2468  - When running the tests, we now put our per-test temp dirs into a sub-
2469    directory named testtmp (which is created, if missing). This allows someone
2470    to symlink the testtmp directory to another filesystem (which is useful if
2471    the build dir's filesystem does not support ACLs and xattrs, but another
2472    filesystem does).
2473
2474  - Rsync now has a way of handling protocol-version changes during the
2475    development of a new protocol version. This causes any out-of-sync versions
2476    to speak an older protocol rather than fail in a cryptic manner.  This
2477    addition makes it safer to deploy a pre-release version that may interact
2478    with the public. This new exchange of sub-version info does not interfere
2479    with the `{MIN,MAX}_PROTOCOL_VERSION` checking algorithm (which does not
2480    have enough range to allow the main protocol number to be incremented for
2481    every minor tweak in that happens during development).
2482
2483  - The csprotocol.txt file was updated to mention the daemon protocol change in
2484    the 3.0.0 release.
2485
2486 ------------------------------------------------------------------------------
2487
2488 # NEWS for rsync 2.6.9 (6 Nov 2006)
2489
2490 ## Changes in this version:
2491
2492 ### BUG FIXES:
2493
2494  - If rsync is interrupted via a handled signal (such as SIGINT), it will once
2495    again clean-up its temp file from the destination dir.
2496
2497  - Fixed an overzealous sanitizing bug in the handling of the `--link-dest`,
2498    `--copy-dest`, and `--compare-dest` options to a daemon without chroot: if
2499    the copy's destination dir is deeper than the top of the module's path,
2500    these options now accept a safe number of parent-dir (../) references (since
2501    these options are relative to the destination dir). The old code incorrectly
2502    chopped off all `../` prefixes for these options, no matter how deep the
2503    destination directory was in the module's hierarchy.
2504
2505  - Fixed a bug where a deferred info/error/log message could get sent directly
2506    to the sender instead of being handled by rwrite() in the generator. This
2507    fixes an `unexpected tag 3` fatal error, and should also fix a potential
2508    problem where a deferred info/error message from the receiver might bypass
2509    the log file and get sent only to the client process. (These problems could
2510    only affect an rsync daemon that was receiving files.)
2511
2512  - Fixed a bug when `--inplace` was combined with a `--*-dest` option and we
2513    update a file's data using an alternate basis file. The code now notices
2514    that it needs to copy the matching data from the basis file instead of
2515    (wrongly) assuming that it was already present in the file.
2516
2517  - Fixed a bug where using `--dry-run` with a `--*-dest` option with a path
2518    relative to a directory that does not yet exist: the affected option gets
2519    its proper path value so that the output of the dry-run is right.
2520
2521  - Fixed a bug in the %f logfile escape when receiving files: the destination
2522    path is now included in the output (e.g. you can now tell when a user
2523    specifies a subdir inside a module).
2524
2525  - If the receiving side fails to create a directory, it will now skip trying
2526    to update everything that is inside that directory.
2527
2528  - If `--link-dest` is specified with `--checksum` but without `--times`, rsync
2529    will now allow a hard-link to be created to a matching link-dest file even
2530    when the file's modify-time doesn't match the server's file.
2531
2532  - The daemon now calls more timezone-using functions prior to doing a chroot.
2533    This should help some C libraries to generate proper timestamps from inside
2534    a chrooted daemon (and to not try to access /etc/timezone over and over
2535    again).
2536
2537  - Fixed a bug in the handling of an absolute `--partial-dir=ABS_PATH` option:
2538    it now deletes an alternate basis file from the partial-dir that was used to
2539    successfully update a destination file.
2540
2541  - Fixed a bug in the handling of `--delete-excluded` when using a per-dir
2542    merge file: the merge file is now honored on the receiving side, and only
2543    its unqualified include/exclude commands are ignored (just as is done for
2544    global include/excludes).
2545
2546  - Fixed a recent bug where `--delete` was not working when transferring from
2547    the root (/) of the filesystem with `--relative` enabled.
2548
2549  - Fixed a recent bug where an `--exclude='*'` could affect the root (/) of the
2550    filesystem with `--relative` enabled.
2551
2552  - When `--inplace` creates a file, it is now created with owner read/write
2553    permissions (0600) instead of no permissions at all. This avoids a problem
2554    continuing a transfer that was interrupted (since `--inplace` will not
2555    update a file that has no write permissions).
2556
2557  - If either `--remove-source-files` or `--remove-sent-files` is enabled and we
2558    are unable to remove the source file, rsync now outputs an error.
2559
2560  - Fixed a bug in the daemon's `incoming chmod` rule: newly-created directories
2561    no longer get the 'F' (file) rules applied to them.
2562
2563  - Fixed an infinite loop bug when a filter rule was rejected due to being
2564    overly long.
2565
2566  - When the server receives a `--partial-dir` option from the client, it no
2567    longer runs the client-side code that adds an assumed filter rule (since the
2568    client will be sending us the rules in the usual manner, and they may have
2569    chosen to override the auto-added rule).
2570
2571 ### ENHANCEMENTS:
2572
2573  - Added the `--log-file=FILE` and `--log-file-format=FORMAT` options. These
2574    can be used to tell any rsync to output what it is doing to a log file.
2575    They work with a client rsync, a non-daemon server rsync (see the manpage
2576    for instructions), and also allows the overriding of rsyncd.conf settings
2577    when starting a daemon.
2578
2579  - The `--log-format` option was renamed to be `--out-format` to avoid
2580    confusing it with affecting the log-file output. (The old option remains as
2581    an alias for the new to preserve backward compatibility.)
2582
2583  - Made `log file` and `syslog facility` settable on a per-module basis in the
2584    daemon's config file.
2585
2586  - Added the `--remove-source-files` option as a replacement for the (now
2587    deprecated) `--remove-sent-files` option. This new option removes all
2588    non-dirs from the source directories, even if the file was already
2589    up-to-date. This fixes a problem where interrupting an rsync that was using
2590    `--remove-sent-files` and restarting it could leave behind a file that the
2591    earlier rsync synchronized, but didn't get to remove.  (The deprecated
2592    `--remove-sent-files` is still understood for now, and still behaves in the
2593    same way as before.)
2594
2595  - Added the option `--no-motd` to suppress the message-of-the-day output from
2596    a daemon when doing a copy. (See the manpage for a caveat.)
2597
2598  - Added a new environment variable to the pre-/post-xfer exec commands (in the
2599    daemon's config file): `RSYNC_PID`. This value will be the same in both the
2600    pre- and post-xfer commands, so it can be used as a unique ID if the
2601    pre-xfer command wants to cache some arg/request info for the post-xfer
2602    command.
2603
2604 ### INTERNAL:
2605
2606  - Did a code audit using IBM's code-checker program and made several changes,
2607    including: replacing most of the strcpy() and sprintf() calls with
2608    strlcpy(), snprintf(), and memcpy(), adding a 0-value to an enum that had
2609    been intermingling a literal 0 with the defined enum values, silencing some
2610    uninitialized memory checks, marking some functions with a `noreturn`
2611    attribute, and changing an `if` that could never succeed on some platforms
2612    into a pre-processor directive that conditionally compiles the code.
2613
2614  - Fixed a potential bug in `f_name_cmp()` when both the args are a top-level
2615    `.` dir (which doesn't happen in normal operations).
2616
2617  - Changed `exit_cleanup()` so that it can never return instead of exit.  The
2618    old code might return if it found the `exit_cleanup()` function was being
2619    called recursively. The new code is segmented so that any recursive calls
2620    move on to the next step of the exit-processing.
2621
2622  - The macro WIFEXITED(stat) will now be defined if the OS didn't already
2623    define it.
2624
2625 ### DEVELOPER RELATED:
2626
2627  - The acls.diff and xattrs.diff patches have received a bunch of work to make
2628    them much closer to being acceptable in the main distribution.  The xattrs
2629    patch also has some preliminary Mac OS X and FreeBSD compatibility code that
2630    various system types to exchange extended file-attributes.
2631
2632  - A new diff in the patches dir, fake-root.diff, allows rsync to maintain a
2633    backup hierarchy with full owner, group, and device info without actually
2634    running as root. It does this using a special extended attribute, so it
2635    depends on xattrs.diff (which depends on acls.diff).
2636
2637  - The rsync.yo and rsyncd.conf.yo files have been updated to work better with
2638    the latest yodl 2.x releases.
2639
2640  - Updated config.guess and config.sub to their 2006-07-02 versions.
2641
2642  - Updated various files to include the latest FSF address and to have
2643    consistent opening comments.
2644
2645 ------------------------------------------------------------------------------
2646
2647 # NEWS for rsync 2.6.8 (22 Apr 2006)
2648
2649 ## Changes in this version:
2650
2651 ### BUG FIXES:
2652
2653  - Fixed a bug in the exclude code where an anchored exclude without any
2654    wildcards fails to match an absolute source arg, but only when `--relative`
2655    is in effect.
2656
2657  - Improved the I/O code for the generator to fix a potential hang when the
2658    receiver gets an EOF on the socket but the generator's select() call never
2659    indicates that the socket is writable for it to be notified about the EOF.
2660    (This can happen when using stunnel).
2661
2662  - Fixed a problem with the file-reading code where a failed read (such as that
2663    caused by a bad sector) would not advance the file's read-position beyond
2664    the failed read's data.
2665
2666  - Fixed a logging bug where the `log file` directive was not being honored in
2667    a single-use daemon (one spawned by a remote-shell connection or by init).
2668
2669  - If rsync cannot honor the `--delete` option, we output an error and exit
2670    instead of silently ignoring the option.
2671
2672  - Fixed a bug in the `--link-dest` code that prevented special files (such as
2673    fifos) from being linked.
2674
2675  - The ability to hard-link symlinks and special files is now determined at
2676    configure time instead of at runtime. This fixes a bug with `--link-dest`
2677    creating a hard-link to a symlink's referent on a BSD system.
2678
2679 ### ENHANCEMENTS:
2680
2681  - In daemon mode, if rsync fails to bind to the requested port, the error(s)
2682    returned by socket() and/or bind() are now logged.
2683
2684  - When we output a fatal error, we now output the version of rsync in the
2685    message.
2686
2687  - Improved the documentation for the `--owner` and `--group` options.
2688
2689  - The rsyncstats script in `support` has an improved line-parsing regex that
2690    is easier to read and also makes it to parse syslog-generated lines.
2691
2692  - A new script in `support`: file-attr-restore, can be used to restore the
2693    attributes of a file-set (the permissions, ownership, and group info) taken
2694    from the cached output of a `find ARG... -ls` command.
2695
2696 ### DEVELOPER RELATED:
2697
2698  - Removed the unused function `write_int_named()`, the unused variable
2699    `io_read_phase`, and the rarely used variable `io_write_phase`. This also
2700    elides the confusing 'phase "unknown"' part of one error message.
2701
2702  - Removed two unused configure checks and two related (also unused)
2703    compatibility functions.
2704
2705  - The xattrs.diff patch received a security fix that prevents a potential
2706    buffer overflow in the `receive_xattr()` code.
2707
2708  - The acls.diff patch has been improved quite a bit, with more to come.
2709
2710  - A new patch was added: log-file.diff. This contains an early version of a
2711    future option, `--log-file=FILE`, that will allow any rsync to log its
2712    actions to a file (something that only a daemon supports at present).
2713
2714 ------------------------------------------------------------------------------
2715
2716 # NEWS for rsync 2.6.7 (11 Mar 2006)
2717
2718 ## Changes in this version:
2719
2720 ### OUTPUT CHANGES:
2721
2722  - The letter 'D' in the itemized output was being used for both devices
2723    (character or block) as well as other special files (such as fifos and named
2724    sockets). This has changed to separate non-device special files under the
2725    'S' designation (e.g. `cS+++++++ path/fifo`). See also the `--specials`
2726    option, below.
2727
2728  - The way rsync escapes unreadable characters has changed. First, rsync now
2729    has support for recognizing valid multi-byte character sequences in your
2730    current locale, allowing it to escape fewer characters than before for a
2731    locale such as UTF-8. Second, it now uses an escape idiom of `\#123`, which
2732    is the literal string `\#` followed by exactly 3 octal digits. Rsync no
2733    longer doubles a backslash character in a filename (e.g. it used to output
2734    `foo\\bar` when copying `foo\bar`) -- now it only escapes a backslash that
2735    is followed by a hash-sign and 3 digits (0-9) (e.g. it will output
2736    `foo\#134#789` when copying `foo\#789`). See also the `--8-bit-output`
2737    (`-8`) option, mentioned below.
2738
2739    Script writers: the local rsync is the one that outputs escaped names, so if
2740    you need to support unescaping of filenames for older rsyncs, I'd suggest
2741    that you parse the output of `rsync --version` and only use the old
2742    unescaping rules for 2.6.5 and 2.6.6.
2743
2744 ### BUG FIXES:
2745
2746  - Fixed a really old bug that caused `--checksum` (`-c`) to checksum all the
2747    files encountered during the delete scan (ouch).
2748
2749  - Fixed a potential hang in a remote generator: when the receiver gets a
2750    read-error on the socket, it now signals the generator about this so that
2751    the generator does not try to send any of the terminating error messages to
2752    the client (avoiding a potential hang in some setups).
2753
2754  - Made hard-links work with symlinks and devices again.
2755
2756  - If the sender gets an early EOF reading a source file, we propagate this
2757    error to the receiver so that it can discard the file and try requesting it
2758    again (which is the existing behavior for other kinds of read errors).
2759
2760  - If a device-file/special-file changes permissions, rsync now updates the
2761    permissions without recreating the file.
2762
2763  - If the user specifies a remote-host for both the source and destination, we
2764    now output a syntax error rather than trying to open the destination
2765    hostspec as a filename.
2766
2767  - When `--inplace` creates a new destination file, rsync now creates it with
2768    permissions 0600 instead of 0000 -- this makes restarting possible when the
2769    transfer gets interrupted in the middle of sending a new file.
2770
2771  - Reject the combination of `--inplace` and `--sparse` since the sparse-output
2772    algorithm doesn't work when overwriting existing data.
2773
2774  - Fixed the directory name in the error that is output when `pop_dir()` fails.
2775
2776  - Really fixed the parsing of a `!` entry in .cvsignore files this time.
2777
2778  - If the generator gets a stat() error on a file, output it (this used to
2779    require at least `-vv` for the error to be seen).
2780
2781  - If waitpid() fails or the child rsync didn't exit cleanly, we now handle the
2782    exit status properly and generate a better error.
2783
2784  - Fixed some glitches in the double-verbose output when using `--copy-dest`,
2785    `--link-dest`, or `--compare-dest`. Also improved how the verbose output
2786    handles hard-links (within the transfer) that had an up-to-date alternate
2787    `dest` file, and copied files (via `--copy-dest`).
2788
2789  - Fixed the matching of the dont-compress items (e.g. `*.gz`) against files
2790    that have a path component containing a slash.
2791
2792  - If the code reading a filter/exclude file gets an EINTR error, rsync now
2793    clears the error flag on the file handle so it can keep on reading.
2794
2795  - If `--relative` is active, the sending side cleans up trailing `/` or `/.`
2796    suffixes to avoid triggering a bug in older rsync versions. Also, we now
2797    reject a `..` dir if it would be sent as a relative dir.
2798
2799  - If a non-directory is in the way of a directory and rsync is run with
2800    `--dry-run` and `--delete`, rsync no longer complains about not being able
2801    to opendir() the not-yet present directory.
2802
2803  - When `--list-only` is used and a non-existent local destination dir was also
2804    specified as a destination, rsync no longer generates a warning about being
2805    unable to create the missing directory.
2806
2807  - Fixed some problems with `--relative --no-implied-dirs` when the destination
2808    directory did not yet exist: we can now create a symlink or device when it
2809    is the first thing in the missing dir, and `--fuzzy` no longer complains
2810    about being unable to open the missing dir.
2811
2812  - Fixed a bug where the `--copy-links` option would not affect implied
2813    directories without `--copy-unsafe-links` (see `--relative`).
2814
2815  - Got rid of the need for `--force` to be used in some circumstances with
2816    `--delete-after` (making it consistent with
2817    `--delete-before`/`--delete-during`).
2818
2819  - Rsync now ignores the SIGXFSZ signal, just in case your OS sends this when a
2820    file is too large (rsync handles the write error).
2821
2822  - Fixed a bug in the Proxy-Authorization header's base64-encoded value: it was
2823    not properly padded with trailing '=' chars. This only affects a user that
2824    need to use a password-authenticated proxy for an outgoing daemon-rsync
2825    connection.
2826
2827  - If we're transferring an empty directory to a new name, rsync no longer
2828    forces `S_IWUSR` if it wasn't already set, nor does it accidentally leave it
2829    set.
2830
2831  - Fixed a bug in the debug output (`-vvvvv`) that could mention the wrong
2832    checksum for the current file offset.
2833
2834  - Rsync no longer allows a single directory to be copied over a non-directory
2835    destination arg.
2836
2837 ### ENHANCEMENTS:
2838
2839  - Added the `--append` option that makes rsync append data onto files that are
2840    longer on the source than the destination (this includes new files).
2841
2842  - Added the `--min-size=SIZE` option to exclude small files from the transfer.
2843
2844  - Added the `--compress-level` option to allow you to set how aggressive
2845    rsync's compression should be (this option implies `--compress`).
2846
2847  - Enhanced the parsing of the SIZE value for `--min-size` and `--max-size` to
2848    allow easy entry of multiples of 1000 (instead of just multiples of 1024)
2849    and off-by-one values too (e.g. `--max-size=8mb-1`).
2850
2851  - Added the `--8-bit-output` (`-8`) option, which tells rsync to avoid
2852    escaping high-bit characters that it thinks are unreadable in the current
2853    locale.
2854
2855  - The new option `--human-readable` (`-h`) changes the output of `--progress`,
2856    `--stats`, and the end-of-run summary to be easier to read. If repeated, the
2857    units become powers of 1024 instead of powers of 1000. (The old meaning of
2858    `-h`, as a shorthand for `--help`, still works as long as you just use it on
2859    its own, as in `rsync -h`.)
2860
2861  - If lutimes() and/or lchmod() are around, use them to allow the preservation
2862    of attributes on symlinks.
2863
2864  - The `--link-dest` option now affects symlinks and devices (when possible).
2865
2866  - Added two config items to the rsyncd.conf parsing: `pre-xfer exec` and
2867    `post-xfer exec`. These allow a command to be specified on a per-module
2868    basis that will be run before and/or after a daemon-mode transfer. (See the
2869    manpage for a list of the environment variables that are set with
2870    information about the transfer.)
2871
2872  - When using the `--relative` option, you can now insert a dot dir in the
2873    source path to indicate where the replication of the source dirs should
2874    start. For example, if you specify a source path of
2875    rsync://host/module/foo/bar/./baz/dir with `-R`, rsync will now only
2876    replicate the `baz/dir` part of the source path (note: a trailing dot dir is
2877    unaffected unless it also has a trailing slash).
2878
2879  - Added some new `--no-FOO` options that make it easier to override unwanted
2880    implied or default options. For example, `-a --no-o` (aka `--archive
2881    --no-owner`) can be used to turn off the preservation of file ownership that
2882    is implied by `-a`.
2883
2884  - Added the `--chmod=MODE` option that allows the destination permissions to
2885    be changed from the source permissions. E.g. `--chmod=g+w,o-rwx`
2886
2887  - Added the `incoming chmod` and `outgoing chmod` daemon options that allow a
2888    module to specify what permissions changes should be applied to all files
2889    copied to and from the daemon.
2890
2891  - Allow the `--temp-dir` option to be specified when starting a daemon, which
2892    sets the default temporary directory for incoming files.
2893
2894  - If `--delete` is combined with `--dirs` without `--recursive`, rsync will
2895    now delete in any directory whose content is being synchronized.
2896
2897  - If `--backup` is combined with `--delete` without `--backup-dir` (and
2898    without `--delete-excluded`), we add a `protect` filter-rule to ensure that
2899    files with the backup suffix are not deleted.
2900
2901  - The file-count stats that are output by `--progress` were improved to better
2902    indicate what the numbers mean. For instance, the output: `(xfer#5,
2903    to-check=8383/9999)` indicates that this was the fifth file to be
2904    transferred, and we still need to check 8383 more files out of a total of
2905    9999.
2906
2907  - The include/exclude code now allows a `dir/***` directive (with 3 trailing
2908    stars) to match both the dir itself as well as all the content below the dir
2909    (`dir/**` would not match the dir).
2910
2911  - Added the `--prune-empty-dirs` (`-m`) option that makes the receiving rsync
2912    discard empty chains of directories from the file-list. This makes it easier
2913    to selectively copy files from a source hierarchy and end up with just the
2914    directories needed to hold the resulting files.
2915
2916  - If the `--itemize-changes` (`-i`) option is repeated, rsync now includes
2917    unchanged files in the itemized output (similar to `-vv`, but without all
2918    the other verbose messages that can get in the way). Of course, the client
2919    must be version 2.6.7 for this to work, but the remote rsync only needs to
2920    be 2.6.7 if you're pushing files.
2921
2922  - Added the `--specials` option to tell rsync to copy non-device special files
2923    (which rsync now attempts even as a normal user). The `--devices` option now
2924    requests the copying of just devices (character and block).  The `-D` option
2925    still requests both (e.g. `--devices` and `--specials`), `-a` still implies
2926    `-D`, and non-root users still get a silent downgrade that omits device
2927    copying.
2928
2929  - Added the `--super` option to make the receiver always attempt super-user
2930    activities. This is useful for systems that allow things such as devices to
2931    be created or ownership to be set without being UID 0, and is also useful
2932    for someone who wants to ensure that errors will be output if the receiving
2933    rsync isn't being run as root.
2934
2935  - Added the `--sockopts` option for those few who want to customize the TCP
2936    options used to contact a daemon rsync.
2937
2938  - Added a way for the `--temp-dir` option to be combined with a partial-dir
2939    setting that lets rsync avoid non-atomic updates (for those times when
2940    `--temp-dir` is not being used because space is tight).
2941
2942  - A new support script, files-to-excludes, will transform a list of files into
2943    a set of include/exclude directives that will copy those files.
2944
2945  - A new option, `--executability` (`-E`) can be used to preserve just the
2946    execute bit on files, for those times when using the `--perms` option is not
2947    desired.
2948
2949  - The daemon now logs each connection and also each module-list request that
2950    it receives.
2951
2952  - New log-format options: %M (modtime), %U (uid), %G (gid), and %B (permission
2953    bits, e.g. `rwxr-xrwt`).
2954
2955  - The `--dry-run` option no longer forces the enabling of `--verbose`.
2956
2957  - The `--remove-sent-files` option now does a better job of incrementally
2958    removing the sent files on the sending side (older versions tended to clump
2959    up all the removals at the end).
2960
2961  - A daemon now supersedes its minimal SIGCHLD handler with the standard
2962    PID-remembering version after forking. This ensures that the generator can
2963    get the child-exit status from the receiver.
2964
2965  - Use of the `--bwlimit` option no longer interferes with the remote rsync
2966    sending error messages about invalid/refused options.
2967
2968  - Rsync no longer returns a usage error when used with one local source arg
2969    and no destination: this now implies the `--list-only` option, just like the
2970    comparable situation with a remote source arg.
2971
2972  - Added the `--copy-dirlinks` option, a more limited version of
2973    `--copy-links`.
2974
2975  - Various documentation improvements, including: a better synopsis, some
2976    improved examples, a better discussion of the presence and absence of
2977    `--perms` (including how it interacts with the new `--executability` and
2978    `--chmod` options), an extended discussion of `--temp-dir`, an improved
2979    discussion of `--partial-dir`, a better description of rsync's pattern
2980    matching characters, an improved `--no-implied-dirs` section, and the
2981    documenting of what the `--stats` option outputs.
2982
2983  - Various new and updated diffs in the patches dir, including: acls.diff,
2984    xattrs.diff, atimes.diff, detect-renamed.diff, and slp.diff.
2985
2986 ### INTERNAL:
2987
2988  - We now use sigaction() and sigprocmask() if possible, and fall back on
2989    signal() if not. Using sigprocmask() ensures that rsync enables all the
2990    signals that it needs, just in case it was started in a masked state.
2991
2992  - Some buffer sizes were expanded a bit, particularly on systems where
2993    MAXPATHLEN is overly small (e.g. Cygwin).
2994
2995  - If `io_printf()` tries to format more data than fits in the buffer, exit
2996    with an error instead of transmitting a truncated buffer.
2997
2998  - If a `va_copy` macro is defined, lib/snprintf.c will use it when defining
2999    the `VA_COPY` macro.
3000
3001  - Reduced the amount of stack memory needed for each level of directory
3002    recursion by nearly MAXPATHLEN bytes.
3003
3004  - The wildmatch function was extended to allow an array of strings to be
3005    supplied as the string to match. This allows the exclude code to do less
3006    string copying.
3007
3008  - Got rid of the `safe_fname()` function (and all the myriad calls) and
3009    replaced it with a new function in the log.c code that filters all the
3010    output going to the terminal.
3011
3012  - Unified the `f_name()` and the `f_name_to()` functions.
3013
3014  - Improved the hash-table code the sender uses to handle checksums to make it
3015    use slightly less memory and run just a little faster.
3016
3017 ### DEVELOPER RELATED:
3018
3019  - The diffs in the patches dir now require `patch -p1 <DIFF` instead of the
3020    previous `-p0`. Also, the version included in the release tar now affect
3021    generated files (e.g. configure, rsync.1, proto.h, etc.), so it is no longer
3022    necessary to run autoconf and/or yodl unless you're applying a patch that
3023    was checked out from CVS.
3024
3025  - Several diffs in the patches dir now use the proper `--enable-FOO` configure
3026    option instead of `--with-FOO` to turn on the inclusion of the newly patched
3027    feature.
3028
3029  - There is a new script, `prepare-source` than can be used to update the
3030    various generated files (proto.h, configure, etc.) even before configure has
3031    created the Makefile (this is mainly useful when patching the source with a
3032    patch that doesn't affect generated files).
3033
3034  - The testsuite now sets HOME so that it won't be affected by a file such as
3035    ~/.popt.
3036
3037 ------------------------------------------------------------------------------
3038
3039 # NEWS for rsync 2.6.6 (28 Jul 2005)
3040
3041 ## Changes in this version:
3042
3043 ### SECURITY FIXES:
3044
3045  - The zlib code was upgraded to version 1.2.3 in order to make it more secure.
3046    While the widely-publicized security problem in zlib 1.2.2 did not affect
3047    rsync, another security problem surfaced that affects rsync's zlib 1.1.4.
3048
3049 ### BUG FIXES:
3050
3051  - The setting of `flist->high` in `clean_flist()` was wrong for an empty list.
3052    This could cause `flist_find()` to crash in certain rare circumstances (e.g.
3053    if just the right directory setup was around when `--fuzzy` was combined
3054    with `--link-dest`).
3055
3056  - The outputting of hard-linked files when verbosity was > 1 was not right:
3057    (1) Without `-i` it would output the name of each hard-linked file as though
3058    it had been changed; it now outputs a `is hard linked` message for the file.
3059    (2) With `-i` it would output all dots for the unchanged attributes of a
3060    hard-link; it now changes those dots to spaces, as is done for other totally
3061    unchanged items.
3062
3063  - When backing up a changed symlink or device, get rid of any old backup item
3064    so that we don't get an `already exists` error.
3065
3066  - A couple places that were comparing a local and a remote modification-time
3067    were not honoring the `--modify-window` option.
3068
3069  - Fixed a bug where the 'p' (permissions) itemized-changes flag might get set
3070    too often (if some non-significant mode bits differed).
3071
3072  - Fixed a really old, minor bug that could cause rsync to warn about being
3073    unable to mkdir() a path that ends in `/.` because it just created the
3074    directory (required `--relative`, `--no-implied-dirs`, a source path that
3075    ended in either a trailing slash or a trailing `/.`, and a non-existing
3076    destination dir to tickle the bug in a recent version).
3077
3078 ### ENHANCEMENTS:
3079
3080  - Made the `max verbosity` setting in the rsyncd.conf file settable on a
3081    per-module basis (which now matches the documentation).
3082
3083  - The rrsync script has been upgraded to verify the args of options that take
3084    args (instead of rejecting any such options). It was also changed to try to
3085    be more secure and to fix a problem in the parsing of a pull operation that
3086    has multiple source args. (See the support dir.)
3087
3088  - Improved the documentation that explains the difference between a normal
3089    daemon transfer and a daemon-over remote-shell transfer.
3090
3091  - Some of the diffs supplied in the patches dir were fixed and/or improved.
3092
3093 ### BUILD CHANGES:
3094
3095  - Made configure define `NOBODY_USER` (currently hard-wired to `nobody`) and
3096    `NOBODY_GROUP` (set to either `nobody` or `nogroup` depending on what we
3097    find in the /etc/group file).
3098
3099  - Added a test to the test suite, itemized.test, that tests the output of `-i`
3100    (log-format w/%i) and some double-verbose messages.
3101
3102 ------------------------------------------------------------------------------
3103
3104 # NEWS for rsync 2.6.5 (1 Jun 2005)
3105
3106 ## Changes in this version:
3107
3108 ### OUTPUT CHANGES:
3109
3110  - Non-printable chars in filenames are now output using backslash-escaped
3111    characters rather than '?'s. Any non-printable character is output using 3
3112    digits of octal (e.g. `\n` -> `\012`), and a backslash is now output as
3113    `\\`. Rsync also uses your locale setting, which can make it treat fewer
3114    high-bit characters as non-printable.
3115
3116  - If rsync received an empty file-list when pulling files, it would output a
3117    `nothing to do` message and exit with a 0 (success) exit status, even if the
3118    remote rsync returned an error (it did not do this under the same conditions
3119    when pushing files). This was changed to make the pulling behavior the same
3120    as the pushing behavior: we now do the normal end-of-run outputting
3121    (depending on options) and exit with the appropriate exit status.
3122
3123 ### BUG FIXES:
3124
3125  - A crash bug was fixed when a daemon had its `path` set to `/`, did not have
3126    chroot enabled, and used some anchored excludes in the rsyncd.conf file.
3127
3128  - Fixed a bug in the transfer of a single file when `-H` is specified (rsync
3129    would either infinite loop or perhaps crash).
3130
3131  - Fixed a case where the generator might try (and fail) to tweak the
3132    write-permissions of a read-only directory in list-only mode (this only
3133    caused an annoying warning message).
3134
3135  - If `--compare-dest` or `--link-dest` uses a locally-copied file as the basis
3136    for an updated version, log this better when `--verbose` or `-i` is in
3137    effect.
3138
3139  - Fixed the accidental disabling of `--backup` during the `--delete-after`
3140    processing.
3141
3142  - Restored the ability to use the `--address` option in client mode (in
3143    addition to its use in daemon mode).
3144
3145  - Make sure that some temporary progress information from the delete
3146    processing does not get left on the screen when it is followed by a newline.
3147
3148  - When `--existing` skips a directory with extra verbosity, refer to it as a
3149    `directory`, not a `file`.
3150
3151  - When transferring a single file to a different-named file, any generator
3152    messages that are source-file related no longer refer to the file by the
3153    destination filename.
3154
3155  - Fixed a bug where hard-linking a group of files might fail if the generator
3156    hasn't created a needed destination directory yet.
3157
3158  - Fixed a bug where a hard-linked group of files that is newly-linked to a
3159    file in a `--link-dest` dir doesn't link the files from the rest of the
3160    cluster.
3161
3162  - When deleting files with the `--one-file-system` (`-x`) option set, rsync no
3163    longer tries to remove files from inside a mount-point on the receiving
3164    side. Also, we don't complain about being unable to remove the mount-point
3165    dir.
3166
3167  - Fixed a compatibility problem when using `--cvs-ignore` (`-C`) and sending
3168    files to an older rsync without using `--delete`.
3169
3170  - Make sure that a `- !` or `+ !` include/exclude pattern does not trigger the
3171    list-clearing action that is reserved for `!`.
3172
3173  - Avoid a timeout in the generator when the sender/receiver aren't handling
3174    the generator's checksum output quickly enough.
3175
3176  - Fixed the omission of some directories in the delete processing when
3177    `--relative` (`-R`) was combined with a source path that had a trailing
3178    slash.
3179
3180  - Fixed a case where rsync would erroneously delete some files and then
3181    re-transfer them when the options `--relative` (`-R`) and `--recursive`
3182    (`-r`) were both enabled (along with `--delete`) and a source path had a
3183    trailing slash.
3184
3185  - Make sure that `--max-size` doesn't affect a device or a symlink.
3186
3187  - Make sure that a system with a really small MAXPATHLEN does not cause the
3188    buffers in `readfd_unbuffered()` to be too small to receive normal messages.
3189    (This mainly affected Cygwin.)
3190
3191  - If a source pathname ends with a filename of `..`, treat it as if `../` had
3192    been specified (so that we don't copy files to the parent dir of the
3193    destination).
3194
3195  - If `--delete` is combined with a file-listing rsync command (i.e. no
3196    transfer is happening), avoid outputting a warning that we couldn't delete
3197    anything.
3198
3199  - If `--stats` is specified with `--delete-after`, ensure that all the
3200    `deleting` messages are output before the statistics.
3201
3202  - Improved one `if` in the deletion code that was only checking errno for
3203    ENOTEMPTY when it should have also been checking for EEXIST (for
3204    compatibility with OS variations).
3205
3206 ### ENHANCEMENTS:
3207
3208  - Added the `--only-write-batch=FILE` option that may be used (instead of
3209    `--write-batch=FILE`) to create a batch file without doing any actual
3210    updating of the destination. This allows you to divert all the file-updating
3211    data away from a slow data link (as long as you are pushing the data to the
3212    remote server when creating the batch).
3213
3214  - When the generator is taking a long time to fill up its output buffer (e.g.
3215    if the transferred files are few, small, or missing), it now periodically
3216    flushes the output buffer so that the sender/receiver can get started on the
3217    files sooner rather than later.
3218
3219  - Improved the keep-alive code to handle a long silence between the sender and
3220    the receiver that can occur when the sender is receiving the checksum data
3221    for a large file.
3222
3223  - Improved the auth-errors that are logged by the daemon to include some
3224    information on why the authorization failed: wrong user, password mismatch,
3225    etc. (The client-visible message is unchanged!)
3226
3227  - Improved the client's handling of an `@ERROR` from a daemon so that it does
3228    not complain about an unexpectedly closed socket (since we really did expect
3229    the socket to close).
3230
3231  - If the daemon can't open the log-file specified in rsyncd.conf, fall back to
3232    using syslog and log an appropriate warning. This is better than what was
3233    typically a totally silent (and fatal) failure (since a daemon is not
3234    usually run with the `--no-detach` option that was necessary to see the
3235    error on stderr).
3236
3237  - The manpages now consistently refer to an rsync daemon as a `daemon`
3238    instead of a `server` (to distinguish it from the server process in a
3239    non-daemon transfer).
3240
3241  - Made a small change to the rrsync script (restricted rsync -- in the support
3242    dir) to make a read-only server reject all `--remove-*` options when sending
3243    files (to future-proof it against the possibility of other similar options
3244    being added at some point).
3245
3246 ### INTERNAL:
3247
3248  - Rsync now calls `setlocale(LC_CTYPE, "")`. This enables isprint() to better
3249    discern which filename characters need to be escaped in messages (which
3250    should result in fewer escaped characters in some locales).
3251
3252  - Improved the naming of the log-file open/reopen/close functions.
3253
3254  - Removed some protocol-compatibility code that was only needed to help
3255    someone running a pre-release of 2.6.4.
3256
3257 ### BUILD CHANGES:
3258
3259  - Added configure option `--disable-locale` to disable any use of setlocale()
3260    in the binary.
3261
3262  - Fixed a bug in the `SUPPORT{,_HARD}_LINKS` #defines which prevented rsync
3263    from being built without symlink or hard-link support.
3264
3265  - Only #define `HAVE_REMSH` if it is going to be set to 1.
3266
3267  - Configure now disables the use of mkstemp() under HP-UX (since they refuse
3268    to fix its broken handling of large files).
3269
3270  - Configure now explicitly checks for the lseek64() function so that the code
3271    can use `HAVE_LSEEK64` instead of inferring lseek64()'s presence based on
3272    the presence of the `off64_t` type.
3273
3274  - Configure no longer mentions the change in the default remote-shell (from
3275    rsh to ssh) that occurred for the 2.6.0 release.
3276
3277  - Some minor enhancements to the test scripts.
3278
3279  - Added a few new `*.diff` files to the patches dir, including a patch that
3280    enables the optional copying of extended attributes.
3281
3282 ------------------------------------------------------------------------------
3283
3284 # NEWS for rsync 2.6.4 (30 March 2005)
3285
3286 ## Changes in this version:
3287
3288 ### PROTOCOL NUMBER:
3289
3290  - The protocol number was changed to 29.
3291
3292 ### OUTPUT CHANGES:
3293
3294  - When rsync deletes a directory and outputs a verbose message about it, it
3295    now appends a trailing slash to the name instead of (only sometimes)
3296    outputting a preceding "directory " string.
3297
3298  - The `--stats` output will contain file-list time-statistics if both sides
3299    are 2.6.4, or if the local side is 2.6.4 and the files are being pushed
3300    (since the stats come from the sending side).  (Requires protocol 29 for a
3301    pull.)
3302
3303  - The `%o` (operation) log-format escape now has a third value (besides `send`
3304    and `recv`): `del.` (with trailing dot to make it 4 chars).  This changes
3305    the way deletions are logged in the daemon's log file.
3306
3307  - When the `--log-format` option is combined with `--verbose`, rsync now
3308    avoids outputting the name of the file twice in most circumstances.  As long
3309    as the `--log-format` item does not refer to any post-transfer items (such
3310    as %b or %c), the `--log-format` message is output prior to the transfer, so
3311    `--verbose` is now the equivalent of a `--log-format` of '%n%L' (which
3312    outputs the name and any link info). If the log output must occur after the
3313    transfer to be complete, the only time the name is also output prior to the
3314    transfer is when `--progress` was specified (so that the name will precede
3315    the progress stats, and the full `--log-format` output will come after).
3316
3317  - Non-printable characters in filenames are replaced with a '?' to avoid
3318    corrupting the screen or generating empty lines in the output.
3319
3320 ### BUG FIXES:
3321
3322  - Restore the list-clearing behavior of `!` in a .cvsignore file (2.6.3 was
3323    only treating it as a special token in an rsync include/exclude file).
3324
3325  - The combination of `--verbose` and `--dry-run` now mentions the full list of
3326    changes that would be output without `--dry-run`.
3327
3328  - Avoid a mkdir warning when removing a directory in the destination that
3329    already exists in the `--backup-dir`.
3330
3331  - An OS that has a binary mode for its files (such as Cygwin) needed
3332    `setmode(fd, O_BINARY)` called on the temp-file we opened with mkstemp().
3333    (Fix derived from Cygwin's 2.6.3 rsync package.)
3334
3335  - Fixed a potential hang when verbosity is high, the client side is the
3336    sender, and the file-list is large.
3337
3338  - Fixed a potential protocol-corrupting bug where the generator could merge a
3339    message from the receiver into the middle of a multiplexed packet of data if
3340    only part of that data had been written out to the socket when the message
3341    from the generator arrived.
3342
3343  - We now check if the OS doesn't support using mknod() for creating FIFOs and
3344    sockets, and compile-in some compatibility code using mkfifo() and socket()
3345    when necessary.
3346
3347  - Fixed an off-by-one error in the handling of `--max-delete=N`. Also, if the
3348    `--max-delete` limit is exceeded during a run, we now output a warning about
3349    this at the end of the run and exit with a new error code (25).
3350
3351  - One place in the code wasn't checking if fork() failed.
3352
3353  - The `ignore nonreadable` daemon parameter used to erroneously affect
3354    readable symlinks that pointed to a non-existent file.
3355
3356  - If the OS does not have lchown() and a chown() of a symlink will affect the
3357    referent of a symlink (as it should), we no longer try to set the user and
3358    group of a symlink.
3359
3360  - The generator now properly runs the hard-link loop and the dir-time
3361    rewriting loop after we're sure that the redo phase is complete.
3362
3363  - When `--backup` was specified with `--partial-dir=DIR`, where DIR is a
3364    relative path, the backup code was erroneously trying to backup a file that
3365    was put into the partial-dir.
3366
3367  - If a file gets resent in a single transfer and the `--backup` option is
3368    enabled along with `--inplace`, rsync no longer performs a duplicate backup
3369    (it used to overwrite the first backup with the failed file).
3370
3371  - One call to `flush_write_file()` was not being checked for an error.
3372
3373  - The `--no-relative` option was not being sent from the client to a server
3374    sender.
3375
3376  - If an rsync daemon specified `dont compress = ...` for a file and the client
3377    tried to specify `--compress`, the libz code was not handling a compression
3378    level of 0 properly. This could cause a transfer failure if the block-size
3379    for a file was large enough (e.g. rsync might have exited with an error for
3380    large files).
3381
3382  - Fixed a bug that would sometimes surface when using `--compress` and sending
3383    a file with a block-size larger than 64K (either manually specified, or
3384    computed due to the file being really large). Prior versions of rsync would
3385    sometimes fail to decompress the data properly, and thus the transferred
3386    file would fail its verification.
3387
3388  - If a daemon can't open the specified log file (i.e. syslog is not being
3389    used), die without crashing. We also output an error about the failure on
3390    stderr (which will only be seen if `--no-detach` was specified) and exit
3391    with a new error code (6).
3392
3393  - A local transfer no longer duplicates all its include/exclude options (since
3394    the forked process already has a copy of the exclude list, there's no need
3395    to send them a set of duplicates).
3396
3397  - The output of the items that are being updated by the generator (dirs,
3398    symlinks, devices) is now intermingled in the proper order with the output
3399    from the items that the receiver is updating (regular files) when pulling.
3400    This misordering was particularly bad when `--progress` was specified.
3401    (Requires protocol 29.)
3402
3403  - When `--timeout` is specified, lulls that occur in the transfer while the
3404    generator is doing work that does not generate socket traffic (looking for
3405    changed files, deleting files, doing directory-time touch-ups, etc.) will
3406    cause a new keep-alive packet to be sent that should keep the transfer going
3407    as long as the generator continues to make progress. (Requires protocol 29.)
3408
3409  - The stat size of a device is not added to the total file size of the items
3410    in the transfer (the size might be undefined on some OSes).
3411
3412  - Fixed a problem with refused-option messages sometimes not making it back to
3413    the client side when a remote `--files-from` was in effect and the daemon
3414    was the receiver.
3415
3416  - The `--compare-dest` option was not updating a file that differed in (the
3417    preserved) attributes from the version in the compare-dest DIR.
3418
3419  - When rsync is copying files into a write-protected directory, fixed the
3420    change-report output for the directory so that we don't report an identical
3421    directory as changed.
3422
3423 ### ENHANCEMENTS:
3424
3425  - Rsync now supports popt's option aliases, which means that you can use
3426    /etc/popt and/or ~/.popt to create your own option aliases.
3427
3428  - Added the `--delete-during` (`--del`) option which will delete files from
3429    the receiving side incrementally as each directory in the transfer is being
3430    processed. This makes it more efficient than the default,
3431    before-the-transfer behavior, which is now also available as
3432    `--delete-before` (and is still the default `--delete-WHEN` option that will
3433    be chosen if `--delete` or `--delete-excluded` is specified without a
3434    `--delete-WHEN` choice). All the `--del*` options infer `--delete`, so an
3435    rsync daemon that refuses `delete` will still refuse to allow any
3436    file-deleting options (including the new `--remove-sent-files` option).
3437
3438  - All the `--delete-WHEN` options are now more memory efficient: Previously an
3439    duplicate set of file-list objects was created on the receiving side for the
3440    entire destination hierarchy. The new algorithm only creates one directory
3441    of objects at a time (for files inside the transfer).
3442
3443  - Added the `--copy-dest` option, which works like `--link-dest` except that
3444    it locally copies identical files instead of hard-linking them.
3445
3446  - Added support for specifying multiple `--compare-dest`, `--copy-dest`, or
3447    `--link-dest` options, but only of a single type. (Promoted from the patches
3448    dir and enhanced.) (Requires protocol 29.)
3449
3450  - Added the `--max-size` option. (Promoted from the patches dir.)
3451
3452  - The daemon-mode options are now separated from the normal rsync options so
3453    that they can't be mixed together. This makes it impossible to start a
3454    daemon that has improper default option values (which could cause problems
3455    when a client connects, such as hanging or crashing).
3456
3457  - The `--bwlimit` option may now be used in combination with `--daemon` to
3458    specify both a default value for the daemon side and a value that cannot be
3459    exceeded by a user-specified `--bwlimit` option.
3460
3461  - Added the `port` parameter to the rsyncd.conf file. (Promoted from the
3462    patches dir.) Also added `address`. The command-line options take precedence
3463    over a config-file option, as expected.
3464
3465  - In `_exit_cleanup()`: when we are exiting with a partially-received file, we
3466    now flush any data in the write-cache before closing the partial file.
3467
3468  - The `--inplace` support was enhanced to work with `--compare-dest`,
3469    `--link-dest`, and (the new) `--copy-dest` options. (Requires protocol 29.)
3470
3471  - Added the `--dirs` (`-d`) option for an easier way to copy directories
3472    without recursion. Any directories that are encountered are created on the
3473    destination. Specifying a directory with a trailing slash copies its
3474    immediate contents to the destination.
3475
3476  - The `--files-from` option now implies `--dirs` (`-d`).
3477
3478  - Added the `--list-only` option, which is mainly a way for the client to put
3479    the server into listing mode without needing to resort to any internal
3480    option kluges (e.g. the age-old use of `-r --exclude='/*/*'` for a
3481    non-recursive listing). This option is used automatically (behind the
3482    scenes) when a modern rsync speaks to a modern daemon, but may also be
3483    specified manually if you want to force the use of the `--list-only` option
3484    over a remote-shell connection.
3485
3486  - Added the `--omit-dir-times` (`-O`) option, which will avoid updating the
3487    modified time for directories when `--times` was specified. This option will
3488    avoid an extra pass through the file-list at the end of the transfer (to
3489    tweak all the directory times), which may provide an appreciable speedup for
3490    a really large transfer. (Promoted from the patches dir.)
3491
3492  - Added the `--filter` (`-f`) option and its helper option, `-F`. Filter rules
3493    are an extension to the existing include/exclude handling that also supports
3494    nested filter files as well as per-directory filter files (like .cvsignore,
3495    but with full filter-rule parsing).  This new option was chosen in order to
3496    ensure that all existing include/exclude processing remained 100% compatible
3497    with older versions. Protocol 29 is needed for full filter-rule support, but
3498    backward-compatible rules work with earlier protocol versions.  (Promoted
3499    from the patches dir and enhanced.)
3500
3501  - Added the `--delay-updates` option that puts all updated files into a
3502    temporary directory (by default `.~tmp~`, but settable via the
3503    `--partial-dir=DIR` option) until the end of the transfer. This makes the
3504    updates a little more atomic for a large transfer.
3505
3506  - If rsync is put into the background, any output from `--progress` is
3507    reduced.
3508
3509  - Documented the `max verbosity` setting for rsyncd.conf. (This setting was
3510    added a couple releases ago, but left undocumented.)
3511
3512  - The sender and the generator now double-check the file-list index they are
3513    given, and refuse to try to do a file transfer on a non-file index (since
3514    that would indicate that something had gone very wrong).
3515
3516  - Added the `--itemize-changes` (`-i`) option, which is a way to output a more
3517    detailed list of what files changed and in what way. The effect is the same
3518    as specifying a `--log-format` of `%i %n%L` (see both the rsync and
3519    rsyncd.conf manpages). Works with `--dry-run` too.
3520
3521  - Added the `--fuzzy` (`-y`) option, which attempts to find a basis file for a
3522    file that is being created from scratch. The current algorithm only looks in
3523    the destination directory for the created file, but it does attempt to find
3524    a match based on size/mod-time (in case the file was renamed with no other
3525    changes) as well as based on a fuzzy name-matching algorithm. This option
3526    requires protocol 29 because it needs the new file-sorting order. (Promoted
3527    from patches dir and enhanced.) (Requires protocol 29.)
3528
3529  - Added the `--remove-sent-files` option, which lets you move files between
3530    systems.
3531
3532  - The hostname in HOST:PATH or HOST::PATH may now be an IPv6 literal enclosed
3533    in '[' and ']' (e.g. `[::1]`). (We already allowed IPv6 literals in the
3534    rsync://HOST:PORT/PATH format.)
3535
3536  - When rsync recurses to build the file list, it no longer keeps open one or
3537    more directory handles from the dir's parent dirs.
3538
3539  - When building under windows, the default for `--daemon` is now to avoid
3540    detaching, requiring the new `--detach` option to force rsync to detach.
3541
3542  - The `--dry-run` option can now be combined with either `--write-batch` or
3543    `--read-batch`, allowing you to run a do-nothing test command to see what
3544    would happen without `--dry-run`.
3545
3546  - The daemon's `read only` config item now sets an internal `read_only`
3547    variable that makes extra sure that no write/delete calls on the read-only
3548    side can succeed.
3549
3550  - The log-format % escapes can now have a numeric field width in between the %
3551    and the escape letter (e.g. `%-40n %08p`).
3552
3553  - Improved the option descriptions in the `--help` text.
3554
3555 ### SUPPORT FILES:
3556
3557  - Added atomic-rsync to the support dir: a perl script that will transfer some
3558    files using rsync, and then move the updated files into place all at once at
3559    the end of the transfer. Only works when pulling, and uses `--link-dest` and
3560    a parallel hierarchy of files to effect its update.
3561
3562  - Added mnt-excl to the support dir: a perl script that takes the /proc/mounts
3563    file and translates it into a set of excludes that will exclude all mount
3564    points (even mapped mounts to the same disk). The excludes are made relative
3565    to the specified source dir and properly anchored.
3566
3567  - Added savetransfer.c to the support dir: a C program that can make a copy of
3568    all the data that flows over the wire. This lets you test for data
3569    corruption (by saving the data on both the sending side and the receiving
3570    side) and provides one way to debug a protocol error.
3571
3572  - Added rrsync to the support dir: this is an updated version of Joe Smith's
3573    restricted rsync perl script. This helps to ensure that only certain rsync
3574    commands can be run by an ssh invocation.
3575
3576 ### INTERNAL:
3577
3578  - Added better checking of the checksum-header values that come over the
3579    socket.
3580
3581  - Merged a variety of file-deleting functions into a single function so that
3582    it is easier to maintain.
3583
3584  - Improved the type of some variables (particularly blocksize vars) for
3585    consistency and proper size.
3586
3587  - Got rid of the uint64 type (which we didn't need).
3588
3589  - Use a slightly more compatible set of core #include directives.
3590
3591  - Defined int32 in a way that ensures that the build dies if we can't find a
3592    variable with at least 32 bits.
3593
3594 ### PROTOCOL DIFFERENCES FOR VERSION 29:
3595
3596  - A 16-bit flag-word is transmitted after every file-list index. This
3597    indicates what is changing between the sender and the receiver. The
3598    generator now transmits an index and a flag-word to indicate when dirs and
3599    symlinks have changed (instead of producing a message), which makes the
3600    outputting of the information more consistent and less prone to screen
3601    corruption (because the local receiver/sender is now outputting all the
3602    file-change info messages).
3603
3604  - If a file is being hard-linked, the `ITEM_XNAME_FOLLOWS` bit is enabled in
3605    the flag-word and the name of the file that was linked immediately follows
3606    in vstring format (see below).
3607
3608  - If a file is being transferred with an alternate-basis file, the
3609    `ITEM_BASIS_TYPE_FOLLOWS` bit is enabled in the flag-word and a single byte
3610    follows, indicating what type of basis file was chosen. If that indicates
3611    that a fuzzy-match was selected, the `ITEM_XNAME_FOLLOWS` bit is set in the
3612    flag-word and the name of the match in vstring format follows the basis
3613    byte. A vstring is a variable length string that has its size written prior
3614    to the string, and no terminating null.  If the string is from 1-127 bytes,
3615    the length is a single byte. If it is from 128-32767 bytes, the length is
3616    written as ((len >> 8) | 0x80) followed by (len % 0x100).
3617
3618  - The sending of exclude names is done using filter-rule syntax. This means
3619    that all names have a prefixed rule indicator, even excludes (which used to
3620    be sent as a bare pattern, when possible). The `-C` option will include the
3621    per-dir .cvsignore merge file in the list of filter rules so it is
3622    positioned correctly (unlike in some older transfer scenarios).
3623
3624  - Rsync sorts the filename list in a different way: it sorts the subdir names
3625    after the non-subdir names for each dir's contents, and it always puts a
3626    dir's contents immediately after the dir's name in the list. (Previously an
3627    item named `foo.txt` would sort in between directory `foo/` and `foo/bar`.)
3628
3629  - When talking to a protocol 29 rsync daemon, a list-only request is able to
3630    note this before the options are sent over the wire and the new
3631    `--list-only` option is included in the options.
3632
3633  - When the `--stats` bytes are sent over the wire (or stored in a batch), they
3634    now include two elapsed-time values: one for how long it took to build the
3635    file-list, and one for how long it took to send it over the wire (each
3636    expressed in thousandths of a second).
3637
3638  - When `--delete-excluded` is specified with some filter rules (AKA excludes),
3639    a client sender will now initiate a send of the rules to the receiver (older
3640    protocols used to omit the sending of excludes in this situation since there
3641    were no receiver-specific rules that survived `--delete-excluded` back
3642    then). Note that, as with all the filter-list sending, only items that are
3643    significant to the other side will actually be sent over the wire, so the
3644    filter-rule list that is sent in this scenario is often empty.
3645
3646  - An index equal to the file-list count is sent as a keep-alive packet from
3647    the generator to the sender, which then forwards it on to the receiver. This
3648    normally invalid index is only a valid keep-alive packet if the 16-bit
3649    flag-word that follows it contains a single bit (`ITEM_IS_NEW`, which is
3650    normally an illegal flag to appear alone).
3651
3652  - A protocol-29 batch file includes a bit for the setting of the `--dirs`
3653    option and for the setting of the `--compress` option. Also, the shell
3654    script created by `--write-batch` will use the `--filter` option instead of
3655    `--exclude-from` to capture any filter rules.
3656
3657 ### BUILD CHANGES:
3658
3659  - Handle an operating system that use mkdev() in place of makedev().
3660
3661  - Improved configure to better handle cross-compiling.
3662
3663 ------------------------------------------------------------------------------
3664
3665 # NEWS for rsync 2.6.3 (30 Sep 2004)
3666
3667 ## Changes in this version:
3668
3669 ### SECURITY FIXES:
3670
3671  - A bug in the `sanitize_path` routine (which affects a non-chrooted rsync
3672    daemon) could allow a user to craft a pathname that would get transformed
3673    into an absolute path for certain options (but not for file-transfer names).
3674    If you're running an rsync daemon with chroot disabled, **please upgrade**,
3675    ESPECIALLY if the user privs you run rsync under is anything above `nobody`.
3676
3677    OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
3678
3679  - Please note that the 2-line footer (output when verbose) now uses the term
3680    `sent` instead of `wrote` and `received` instead of `read`. If you are not
3681    parsing the numeric values out of this footer, a script would be better off
3682    using the empty line prior to the footer as the indicator that the verbose
3683    output is over.
3684
3685  - The output from the `--stats` option was similarly affected to change
3686    `written` to `sent` and `read` to `received`.
3687
3688  - Rsync ensures that a filename that contains a newline gets mentioned with
3689    each newline transformed into a question mark (which prevents a filename
3690    from causing an empty line to be output).
3691
3692  - The `backed up ...` message that is output when at least 2 `--verbose`
3693    options are specified is now the same both with and without the
3694    `--backup-dir` option.
3695
3696 ### BUG FIXES:
3697
3698  - Fixed a crash bug that might appear when `--delete` was used and multiple
3699    source directories were specified.
3700
3701  - Fixed a 32-bit truncation of the file length when generating the checksums.
3702
3703  - The `--backup` code no longer attempts to create some directories over and
3704    over again (generating warnings along the way).
3705
3706  - Fixed a bug in the reading of the secrets file (by the daemon) and the
3707    password file (by the client): the files no longer need to be terminated by
3708    a newline for their content to be read in.
3709
3710  - If a file has a read error on the sending side or the reconstructed data
3711    doesn't match the expected checksum (perhaps due to the basis file changing
3712    during the transfer), the receiver will no longer retain the resulting file
3713    unless the `--partial` option was specified.  (Note: for the read-error
3714    detection to work, neither side can be older than 2.6.3 -- older receivers
3715    will always retain the file, and older senders don't tell the receiver that
3716    the file had a read error.)
3717
3718  - If a file gets resent in a single transfer and the `--backup` option is
3719    enabled, rsync no longer performs a duplicate backup (it used to overwrite
3720    the original file in the backup area).
3721
3722  - Files specified in the daemon's `exclude` or `exclude from` config items are
3723    now excluded from being uploaded (assuming that the module allows uploading
3724    at all) in addition to the old download exclusion.
3725
3726  - Got rid of a potential hang in the receiver when near the end of a phase.
3727
3728  - When using `--backup` without a `--backup-dir`, rsync no longer preserves
3729    the modify time on directories. This avoids confusing NFS.
3730
3731  - When `--copy-links` (`-L`) is specified, we now output a separate error for
3732    a symlink that has no referent instead of claiming that a file `vanished`.
3733
3734  - The `--copy-links` (`-L`) option no longer has the side-effect of telling
3735    the receiving side to follow symlinks. See the `--keep-dirlinks` option
3736    (mentioned below) for a way to specify that behavior.
3737
3738  - Error messages from the daemon server's option-parsing (such as refused
3739    options) are now successfully transferred back to the client (the server
3740    used to fail to send the message because the socket wasn't in the right
3741    state for the message to get through).
3742
3743  - Most transfer errors that occur during a daemon transfer are now returned to
3744    the user in addition to being logged (some messages are intended to be
3745    daemon-only and are not affected by this).
3746
3747  - Fixed a bug in the daemon authentication code when using one of the
3748    batch-processing options.
3749
3750  - We try to work around some buggy IPv6 implementations that fail to implement
3751    `IPV6_V6ONLY`. This should fix the `address in use` error that some daemons
3752    get when running on an OS with a buggy IPv6 implementation. Also, if the new
3753    code gets this error, we might suggest that the user specify `--ipv4` or
3754    `--ipv6` (if we think it will help).
3755
3756  - When the remote rsync dies, make a better effort to recover any error
3757    messages it may have sent before dying (the local rsync used to just die
3758    with a socket-write error).
3759
3760  - When using `--delete` and a `--backup-dir` that contains files that are
3761    hard-linked to their destination equivalents, rsync now makes sure that
3762    removed files really get removed (avoids a really weird rename() behavior).
3763
3764  - Avoid a bogus run-time complaint about a lack of 64-bit integers when the
3765    int64 type is defined as an `off_t` and it actually has 64-bits.
3766
3767  - Added a configure check for open64() without mkstemp64() so that we can
3768    avoid using mkstemp() when such a combination is encountered.  This bypasses
3769    a problem writing out large temp files on OSes such as AIX and HP-UX.
3770
3771  - Fixed an age-old crash problem with `--read-batch` on a local copy (rsync
3772    was improperly assuming `--whole-file` for the local copy).
3773
3774  - When `--dry-run` (`-n`) is used and the destination directory does not
3775    exist, rsync now produces a correct report of files that would be sent
3776    instead of dying with a chdir() error.
3777
3778  - Fixed a bug that could cause a slow-to-connect rsync daemon to die with an
3779    error instead of waiting for the connection to finish.
3780
3781  - Fixed an ssh interaction that could cause output to be lost when the user
3782    chose to combine the output of rsync's stdout and stderr (e.g.  using the
3783    `2>&1`).
3784
3785  - Fixed an option-parsing bug when `--files-from` got passed to a daemon.
3786
3787 ### ENHANCEMENTS:
3788
3789  - Added the `--partial-dir=DIR` option that lets you specify where to
3790    (temporarily) put a partially transferred file (instead of overwriting the
3791    destination file). E.g. `--partial-dir=.rsync-partial` Also added support
3792    for the `RSYNC_PARTIAL_DIR` environment variable that, when found,
3793    transforms a regular `--partial` option (such as the convenient `-P` option)
3794    into one that also specifies a directory.
3795
3796  - Added `--keep-dirlinks` (`-K`), which allows you to symlink a directory onto
3797    another partition on the receiving side and have rsync treat it as matching
3798    a normal directory from the sender.
3799
3800  - Added the `--inplace` option that tells rsync to write each destination file
3801    without using a temporary file. The matching of existing data in the
3802    destination file can be severely limited by this, but there are also cases
3803    where this is more efficient (such as appending data).  Use only when needed
3804    (see the manpage for more details).
3805
3806  - Added the `write only` option for the daemon's config file.
3807
3808  - Added long-option names for `-4` and `-6` (namely `--ipv4` and `--ipv6`) and
3809    documented all these options in the manpage.
3810
3811  - Improved the handling of the `--bwlimit` option so that it's less bursty,
3812    more accurate, and works properly over a larger range of values.
3813
3814  - The rsync daemon-over-ssh code now looks for `SSH_CONNECTION` and
3815    `SSH2_CLIENT` in addition to `SSH_CLIENT` to figure out the IP address.
3816
3817  - Added the `--checksum-seed=N` option for advanced users.
3818
3819  - Batch writing/reading has a brand-new implementation that is simpler, fixes
3820    a few weird problems with the old code (such as no longer sprinkling the
3821    batch files into different dirs or even onto different systems), and is much
3822    less intrusive into the code (making it easier to maintain for the future).
3823    The new code generates just one data file instead of three, which makes it
3824    possible to read the batch on stdin via a remote shell. Also, the old
3825    requirement of forcing the same fixed checksum-seed for all batch processing
3826    has been removed.
3827
3828  - If an rsync daemon has a module set with `list = no` (which hides its
3829    presence in the list of available modules), a user that fails to
3830    authenticate gets the same `unknown module` error that they would get if the
3831    module were actually unknown (while still logging the real error to the
3832    daemon's log file). This prevents fishing for module names.
3833
3834  - The daemon's `refuse options` config item now allows you to match option
3835    names using wildcards and/or the single-letter option names.
3836
3837  - Each transferred file now gets its permissions and modified-time updated
3838    before the temp-file gets moved into place. Previously, the finished file
3839    would have a very brief window where its permissions disallowed all group
3840    and world access.
3841
3842  - Added the ability to parse a literal IPv6 address in an `rsync:` URL (e.g.
3843    rsync://[2001:638:500:101::21]:873/module/dir).
3844
3845  - The daemon's wildcard expanding code can now handle more than 1000 filenames
3846    (it's now limited by memory instead of having a hard-wired limit).
3847
3848 ### INTERNAL:
3849
3850  - Some cleanup in the exclude code has saved some per-exclude memory and made
3851    the code easier to maintain.
3852
3853  - Improved the argv-overflow checking for a remote command that has a lot of
3854    args.
3855
3856  - Use rsyserr() in the various places that were still calling rprintf() with
3857    strerror() as an arg.
3858
3859  - If an rsync daemon is listening on multiple sockets (to handle both IPv4 and
3860    IPv6 to a single port), we now close all the unneeded file handles after we
3861    accept a connection (we used to close just one of them).
3862
3863  - Optimized the handling of larger block sizes (rsync used to slow to a crawl
3864    if the block size got too large).
3865
3866  - Optimized away a loop in `hash_search()`.
3867
3868  - Some improvements to the `sanitize_path()` and `clean_fname()` functions
3869    makes them more efficient and produce better results (while still being
3870    compatible with the file-name cleaning that gets done on both sides when
3871    sending the file-list).
3872
3873  - Got rid of `alloc_sanitize_path()` after adding a destination-buffer arg to
3874    `sanitize_path()` made it possible to put all the former's functionality
3875    into the latter.
3876
3877  - The file-list that is output when at least 4 verbose options are specified
3878    reports the uid value on the sender even when rsync is not running as root
3879    (since we might be sending to a root receiver).
3880
3881 ### BUILD CHANGES:
3882
3883  - Added a `gen` target to rebuild most of the generated files, including
3884    configure, config.h.in, the manpages, and proto.h.
3885
3886  - If `make proto` doesn't find some changes in the prototypes, the proto.h
3887    file is left untouched (its time-stamp used to always be updated).
3888
3889  - The variable `$STRIP` (that is optionally set by the install-strip target's
3890    rule) was changed to `$INSTALL_STRIP` because some systems have `$STRIP`
3891    already set in the environment.
3892
3893  - Fixed a build problem when `SUPPORT_HARD_LINKS` isn't defined.
3894
3895  - When cross-compiling, the gettimeofday() function is now assumed to be a
3896    modern version that takes two-args (since we can't test it).
3897
3898 ### DEVELOPER RELATED:
3899
3900  - The scripts in the testsuite dir were cleaned up a bit and a few new tests
3901    added.
3902
3903  - Some new diffs were added to the patches dir, and some accepted ones were
3904    removed.
3905
3906 ------------------------------------------------------------------------------
3907
3908 # NEWS for rsync 2.6.2 (30 Apr 2004)
3909
3910 ## Changes in this version:
3911
3912 ### BUG FIXES:
3913
3914  - Fixed a major bug in the sorting of the filenames when `--relative` is used
3915    for some sources (just sources such as `/` and `/*` were affected). This fix
3916    ensures that we ask for the right file-list item when requesting changes
3917    from the sender.
3918
3919  - Rsync now checks the return value of the close() function to better report
3920    disk-full problems on an NFS file system.
3921
3922  - Restored the old daemon-server behavior of logging error messages rather
3923    than returning them to the user. (A better long-term fix will be sought in
3924    the future.)
3925
3926  - An obscure uninitialized-variable bug was fixed in the uid/gid code. (This
3927    bug probably had no ill effects.)
3928
3929 ### BUILD CHANGES:
3930
3931  - Got rid of the configure check for sys/sysctl.h (it wasn't used and was
3932    causing a problem on some systems). Also improved the
3933    broken-largefile-locking test to try to avoid failure due to an NFS
3934    build-dir.
3935
3936  - Fixed a compile problem on systems that don't define `AI_NUMERICHOST`.
3937
3938  - Fixed a compile problem in the popt source for compilers that don't support
3939    `__attribute__`.
3940
3941 ### DEVELOPER RELATED:
3942
3943  - Improved the testsuite's `merge` test to work on OSF1.
3944
3945  - Two new diffs were added to the patches dir.
3946
3947 ------------------------------------------------------------------------------
3948
3949 # NEWS for rsync 2.6.1 (26 Apr 2004)
3950
3951 ## Changes in this version:
3952
3953 ### PROTOCOL NUMBER:
3954
3955  - The protocol number was changed to 28.
3956
3957 ### SECURITY FIXES:
3958
3959  - Paths sent to an rsync daemon are more thoroughly sanitized when chroot is
3960    not used. If you're running a non-read-only rsync daemon with chroot
3961    disabled, **please upgrade**, ESPECIALLY if the user privs you run rsync
3962    under is anything above `nobody`.
3963
3964 ### ENHANCEMENTS:
3965
3966  - Lower memory use, more optimal transfer of data over the socket, and lower
3967    CPU usage (see the INTERNAL section for details).
3968
3969  - The `RSYNC_PROXY` environment variable can now contain a `USER:PASS@` prefix
3970    before the `HOST:PORT` information.  (Bardur Arantsson)
3971
3972  - The `--progress` output now mentions how far along in the transfer we are,
3973    including both a count of files transferred and a percentage of the total
3974    file-count that we've processed. It also shows better
3975    current-rate-of-transfer and remaining-transfer-time values.
3976
3977  - Documentation changes now attempt to describe some often misunderstood
3978    features more clearly.
3979
3980 ### BUG FIXES:
3981
3982  - When `-x` (`--one-file-system`) is combined with `-L` (`--copy-links`) or
3983    `--copy-unsafe-links,` no symlinked files are skipped, even if the referent
3984    file is on a different filesystem.
3985
3986  - The `--link-dest` code now works properly for a non-root user when (1) the
3987    UIDs of the source and destination differ and `-o` was specified, or (2)
3988    when the group of the source can't be used on the destination and `-g` was
3989    specified.
3990
3991  - Fixed a bug in the handling of `-H` (hard-links) that might cause the
3992    expanded PATH/NAME value of the current item to get overwritten (due to an
3993    expanded-name caching bug).
3994
3995  - We now reset the `new data has been sent` flag at the start of each file we
3996    send. This makes sure that an interrupted transfer with the `--partial`
3997    option set doesn't keep a shorter temp file than the current basis file when
3998    no new data has been transferred over the wire for that file.
3999
4000  - Fixed a byte-order problem in `--batch-mode` on big-endian machines.  (Jay
4001    Fenlason)
4002
4003  - When using `--cvs-exclude`, the exclude items we get from a per-directory's
4004    .cvsignore file once again only affect that one directory (not all following
4005    directories too). The items are also now properly word-split and parsed
4006    without any +/- prefix parsing.
4007
4008  - When specifying the USER@HOST: prefix for a file, the USER part can now
4009    contain an '@', if needed (i.e. the last '@' is used to find the HOST, not
4010    the first).
4011
4012  - Fixed some bugs in the handling of group IDs for non-root users: (1) It
4013    properly handles a group that the sender didn't have a name for (it would
4014    previously skip changing the group on any files in that group). (2) If
4015    `--numeric-ids` is used, rsync no longer attempts to set groups that the
4016    user doesn't have the permission to set.
4017
4018  - Fixed the `refuse options` setting in the rsyncd.conf file.
4019
4020  - Improved the `-x` (`--one-file-system`) flag's handling of any mount-point
4021    directories we encounter. It is both more optimal (in that it no longer does
4022    a useless scan of the contents of the mount-point dirs) and also fixes a
4023    bug where a remapped mount of the original filesystem could get discovered
4024    in a subdir we should be ignoring.
4025
4026  - Rsync no longer discards a double-slash at the start of a filename when
4027    trying to open the file. It also no longer constructs names that start with
4028    a double slash (unless the user supplied them).
4029
4030  - Path-specifying options to a daemon should now work the same with or without
4031    chroot turned on. Previously, such a option (such as `--link-dest`) would
4032    get its absolute path munged into a relative one if chroot was not on,
4033    making that setting fairly useless.  Rsync now transforms the path into one
4034    that is based on the module's base dir when chroot is not enabled.
4035
4036  - Fixed a compatibility problem interacting with older rsync versions that
4037    might send us an empty `--suffix` value without telling us that
4038    `--backup-dir` was specified.
4039
4040  - The `hosts allow` option for a daemon-over-remote-shell process now has
4041    improved support for IPv6 addresses and a fix for systems that have a length
4042    field in their socket structs.
4043
4044  - Fixed the ability to request an empty backup `--suffix` when sending files
4045    to an rsync daemon.
4046
4047  - Fixed an option-parsing bug when `--files-from` was sent to a server sender.
4048
4049 ### INTERNAL:
4050
4051  - Most of the I/O is now buffered, which results in a pretty large speedup
4052    when running under MS Windows. (Craig Barratt)
4053
4054  - Optimizations to the name-handling/comparing code have made some significant
4055    reductions in user-CPU time for large file sets.
4056
4057  - Some cleanup of the variable types make the code more consistent.
4058
4059  - Reduced memory requirements of hard link preservation.  (J.W. Schultz)
4060
4061  - Implemented a new algorithm for hard-link handling that speeds up the code
4062    significantly. (J.W. Schultz and Wayne Davison)
4063
4064  - The `--hard-link` option now uses the first existing file in the group of
4065    linked files as the basis for the transfer. This prevents the sub-optimal
4066    transfer of a file's data when a new hardlink is added on the sending side
4067    and it sorts alphabetically earlier in the list than the files that are
4068    already present on the receiving side.
4069
4070  - Dropped support for protocol versions less than 20 (2.3.0 released 15 Mar
4071    1999) and activated warnings for protocols less than 25 (2.5.0 released 23
4072    Aug 2001). (Wayne Davison and J.W. Schultz, severally)
4073
4074  - More optimal data transmission for `--hard-links` (protocol 28).
4075
4076  - More optimal data transmission for `--checksum` (protocol 28).
4077
4078  - Less memory is used when `--checksum` is specified.
4079
4080  - Less memory is used in the file list (a per-file savings).
4081
4082  - The generator is now better about not modifying the file list during the
4083    transfer in order to avoid a copy-on-write memory bifurcation (on systems
4084    where fork() uses shared memory).  Previously, rsync's shared memory would
4085    slowly become unshared, resulting in real memory usage nearly doubling on
4086    the receiving side by the end of the transfer. Now, as long as permissions
4087    are being preserved, the shared memory should remain that way for the entire
4088    transfer.
4089
4090  - Changed hardlink info and `file_struct` + strings to use allocation pools.
4091    This reduces memory use for large file-sets and permits freeing memory to
4092    the OS. (J.W. Schultz)
4093
4094  - The 2 pipes used between the receiver and generator processes (which are
4095    forked on the same machine) were reduced to 1 pipe and the protocol improved
4096    so that (1) it is now impossible to have the `redo` pipe fill up and hang
4097    rsync, and (2) trailing messages from the receiver don't get lost on their
4098    way through the generator over to the sender (which mainly affected
4099    hard-link messages and verbose `--stats` output).
4100
4101  - Improved the internal uid/gid code to be more portable and a little more
4102    optimized.
4103
4104  - The device numbers sent when using `--devices` are now sent as separate
4105    major/minor values with 32-bit accuracy (protocol 28).  Previously, the
4106    copied devices were sent as a single 32-bit number. This will make
4107    inter-operation of 64-bit binaries more compatible with their 32-bit
4108    brethren (with both ends of the connection are using protocol 28). Note that
4109    optimizations in the binary protocol for sending the device numbers often
4110    results in fewer bytes being used than before, even though more precision is
4111    now available.
4112
4113  - Some cleanup of the exclude/include structures and its code made things
4114    clearer (internally), simpler, and more efficient.
4115
4116  - The reading & writing of the file-list in batch-mode is now handled by the
4117    same code that sends & receives the list over the wire. This makes it much
4118    easier to maintain. (Note that the batch code is still considered to be
4119    experimental.)
4120
4121 ### BUILD CHANGES:
4122
4123  - The configure script now accepts `--with-rsyncd-conf=PATH` to override the
4124    default value of the /etc/rsyncd.conf file.
4125
4126  - Fixed configure bug when running `./configure --disable-ipv6`.
4127
4128  - Fixed compilation problem on Tru64 Unix (having to do with `sockaddr.sa_len`
4129    and `sockaddr.sin_len`).
4130
4131 ### DEVELOPER RELATED:
4132
4133  - Fixed `make test` bug when build dir is not the source dir.
4134
4135  - Added a couple extra diffs in the `patches` dir, removed the ones that got
4136    applied, and rebuilt the rest.
4137
4138 ------------------------------------------------------------------------------
4139
4140 # NEWS for rsync 2.6.0 (1 Jan 2004)
4141
4142 ## Changes in this version:
4143
4144 ### PROTOCOL NUMBER:
4145
4146  - The protocol number was changed to 27.  The maximum accepted protocol number
4147    was increased from 30 to 40.
4148
4149 ### ENHANCEMENTS:
4150
4151  - `ssh` is now the default remote shell for rsync. If you want to change this,
4152    configure like this: `./configure --with-rsh=rsh`.
4153
4154  - Added `--files-from`, `--no-relative`, `--no-implied-dirs`, and `--from0`.
4155    Note that `--from0` affects the line-ending character for all the files read
4156    by the `--*-from` options. (Wayne Davison)
4157
4158  - Length of csum2 is now per-file starting with protocol version
4159    27. (J.W. Schultz)
4160
4161  - Per-file dynamic block size is now sqrt(file length). The per-file checksum
4162    size is determined according to an algorithm provided by Donovan Baarda
4163    which reduces the probability of rsync algorithm corrupting data and falling
4164    back using the whole md4 checksums. (J.W. Schultz, Donovan Baarda)
4165
4166  - The `--stats` option no longer includes the (debug) malloc summary unless
4167    the verbose option was specified at least twice.
4168
4169  - Added a new error/warning code for when files vanish from the sending side.
4170    Made vanished source files not interfere with the file-deletion pass when
4171    `--delete-after` was specified.
4172
4173  - Various trailing-info sections are now preceded by a newline.
4174
4175 ### BUG FIXES:
4176
4177  - Fixed several exclude/include matching bugs when using wild-cards.  This has
4178    a several user-visible effects, all of which make the matching more
4179    consistent and intuitive. This should hopefully not cause anyone problems
4180    since it makes the matching work more like what people are expecting. (Wayne
4181    Davison)
4182
4183  - A pattern with a `**` no longer causes a `*` to match slashes.  For example,
4184    with `/*/foo/**`, `foo` must be 2 levels deep.  [If your string has BOTH `*`
4185    and `**` wildcards, changing the `*` wildcards to `**` will provide the old
4186    behavior in all versions.]
4187
4188  - `**/foo` now matches at the base of the transfer (like /foo does). [Use
4189    `/**/foo` to get the old behavior in all versions.]
4190
4191  - A non-anchored wildcard term floats to match beyond the base of the
4192    transfer. E.g. `CVS/R*` matches at the end of the path, just like the
4193    non-wildcard term `CVS/Root` does. [Use `/CVS/R*` to get the old behavior in
4194    all versions.]
4195
4196  - Including a `**` in the match term causes it to be matched against the
4197    entire path, not just the name portion, even if there aren't any interior
4198    slashes in the term. E.g. `foo**bar` would exclude `/path/foo-bar` (just
4199    like before) as well as `/foo-path/baz-bar` (unlike before). [Use `foo*bar`
4200    to get the old behavior in all versions.]
4201
4202  - The exclude list specified in the daemon's config file is now properly
4203    applied to the pulled items no matter how deep the user's file-args are in
4204    the source tree. (Wayne Davison)
4205
4206  - For protocol version >= 27, `mdfour_tail()` is called when the block size
4207    (including `checksum_seed`) is a multiple of 64.  Previously it was not
4208    called, giving the wrong MD4 checksum.  (Craig Barratt)
4209
4210  - For protocol version >= 27, a 64 bit bit counter is used in mdfour.c as
4211    required by the RFC. Previously only a 32 bit bit counter was used, causing
4212    incorrect MD4 file checksums for file sizes >= 512MB - 4. (Craig Barratt)
4213
4214  - Fixed a crash bug when interacting with older rsync versions and multiple
4215    files of the same name are destined for the same dir.  (Wayne Davison)
4216
4217  - Keep tmp names from overflowing MAXPATHLEN.
4218
4219  - Make `--link-dest` honor the absence of `-p`, `-o`, and `-g`.
4220
4221  - Made rsync treat a trailing slash in the destination in a more consistent
4222    manner.
4223
4224  - Fixed file I/O error detection. (John Van Essen)
4225
4226  - Fixed bogus `malformed address {hostname}` message in rsyncd log when
4227    checking IP address against hostnames from `hosts allow` and `hosts deny`
4228    parameters in config file.
4229
4230  - Print heap statistics when verbose >= 2 instead of when >= 1.
4231
4232  - Fixed a compression (`-z`) bug when syncing a mostly-matching file that
4233    contains already-compressed data. (Yasuoka Masahiko and Wayne Davison)
4234
4235  - Fixed a bug in the `--backup` code that could cause deleted files to not get
4236    backed up.
4237
4238  - When the backup code makes new directories, create them with mode 0700
4239    instead of 0755 (since the directory permissions in the backup tree are not
4240    yet copied from the main tree).
4241
4242  - Call setgroups() in a more portable manner.
4243
4244  - Improved file-related error messages to better indicate exactly what
4245    pathname failed. (Wayne Davison)
4246
4247  - Fixed some bugs in the handling of `--delete` and `--exclude` when using the
4248    `--relative` (`-R`) option. (Wayne Davison)
4249
4250  - Fixed bug that prevented regular files from replacing special files and
4251    caused a directory in `--link-dest` or `--compare-dest` to block the
4252    creation of a file with the same path. A directory still cannot be replaced
4253    by a regular file unless `--delete` specified. (J.W. Schultz)
4254
4255  - Detect and report when open or opendir succeed but read and readdir fail
4256    caused by network filesystem issues and truncated files. (David Norwood,
4257    Michael Brown, J.W. Schultz)
4258
4259  - Added a fix that should give ssh time to restore the tty settings if the
4260    user presses Ctrl-C at an ssh password prompt.
4261
4262 ### INTERNAL:
4263
4264  - Eliminated vestigial support for old versions that we stopped supporting.
4265    (J.W. Schultz)
4266
4267  - Simplified some of the option-parsing code. (Wayne Davison)
4268
4269  - Some cleanup made to the exclude code, as well as some new defines added to
4270    enhance readability. (Wayne Davison)
4271
4272  - Changed the protocol-version code so that it can interact at a lower
4273    protocol level than the maximum supported by both sides.  Added an
4274    undocumented option, `--protocol=N`, to force the value we advertise to the
4275    other side (primarily for testing purposes).  (Wayne Davison)
4276
4277 ------------------------------------------------------------------------------
4278
4279 # NEWS for rsync 2.5.7 (4 Dec 2003)
4280
4281 ## Changes in this version:
4282
4283 ### SECURITY FIXES:
4284
4285  - Fix buffer handling bugs. (Andrew Tridgell, Martin Pool, Paul Russell,
4286    Andrea Barisani)
4287
4288 ------------------------------------------------------------------------------
4289
4290 # NEWS for rsync 2.5.6, aka "the dwd-between-jobs release" (26 Jan 2003)
4291
4292 ## Changes in this version:
4293
4294 ### ENHANCEMENTS:
4295
4296  - The `--delete-after` option now implies `--delete`. (Wayne Davison)
4297
4298  - The `--suffix` option can now be used with `--backup-dir`. (Michael
4299    Zimmerman)
4300
4301  - Combining `::` syntax with the `--rsh`/`-e` option now uses the specified
4302    remote-shell as a transport to talk to a (newly-spawned) server-daemon. This
4303    allows someone to use daemon features, such as modules, over a secure
4304    protocol, such as ssh. (JD Paul)
4305
4306  - The rsync:// syntax for daemon connections is now accepted in the
4307    destination field.
4308
4309  - If the file name given to `--include-from` or `--exclude-from` is `-`, rsync
4310    will read from standard input. (J.W. Schultz)
4311
4312  - New option `--link-dest` which is like `--compare-dest` except that
4313    unchanged files are hard-linked in to the destination directory.  (J.W.
4314    Schultz)
4315
4316  - Don't report an error if an excluded file disappears during an rsync run.
4317    (Eugene Chupriyanov and Bo Kersey)
4318
4319  - Added .svn to `--cvs-exclude` list to support subversion. (Jon Middleton)
4320
4321  - Properly support IPv6 addresses in the rsyncd.conf `hosts allow` and `hosts
4322    deny` fields. (Hideaki Yoshifuji)
4323
4324  - Changed exclude file handling to permit DOS or MAC style line terminations.
4325    (J.W. Schultz)
4326
4327  - Ignore errors from chmod when `-p`/`-a`/`--preserve-perms` is not set.
4328    (Dave Dykstra)
4329
4330 ### BUG FIXES:
4331
4332  - Fix `forward name lookup failed` errors on AIX 4.3.3. (John L. Allen, Martin
4333    Pool)
4334
4335  - Generate each file's rolling-checksum data as we send it, not in a separate
4336    (memory-eating) pass before hand. This prevents timeout errors on really
4337    large files. (Stefan Nehlsen)
4338
4339  - Fix compilation on Tru64. (Albert Chin, Zoong Pham)
4340
4341  - Better handling of some client-server errors. (Martin Pool)
4342
4343  - Fixed a crash that would occur when sending a list of files that contains a
4344    duplicate name (if it sorts to the end of the file list) and using
4345    `--delete`. (Wayne Davison)
4346
4347  - Fixed the file-name duplicate-removal code when dealing with multiple dups
4348    in a row. (Wayne Davison)
4349
4350  - Fixed a bug that caused rsync to lose the exit status of its child processes
4351    and sometimes return an exit code of 0 instead of showing an error. (David
4352    R. Staples, Dave Dykstra)
4353
4354  - Fixed bug in `--copy-unsafe-links` that caused it to be completely broken.
4355    (Dave Dykstra)
4356
4357  - Prevent infinite recursion in cleanup code under certain circumstances.
4358    (Sviatoslav Sviridov and Marc Espie)
4359
4360  - Fixed a bug that prevented rsync from creating intervening directories when
4361    `--relative-paths`/`-R` is set. (Craig Barratt)
4362
4363  - Prevent `Connection reset by peer` messages from Cygwin. (Randy O'Meara)
4364
4365 ### INTERNAL:
4366
4367  - Many code cleanups and improved internal documentation. (Martin Pool, Nelson
4368    Beebe)
4369
4370  - Portability fixes. (Dave Dykstra and Wayne Davison)
4371
4372  - More test cases. (Martin Pool)
4373
4374  - Some test-case fixes. (Brian Poole, Wayne Davison)
4375
4376  - Updated included popt to the latest vendor drop, version 1.6.4.  (Jos
4377    Backus)
4378
4379  - Updated config.guess and config.sub to latest versions; this means rsync
4380    should build on more platforms. (Paul Green)
4381
4382 ------------------------------------------------------------------------------
4383
4384 # NEWS for rsync 2.5.5, aka Snowy River (2 Apr 2002)
4385
4386 ## Changes in this version:
4387
4388 ### ENHANCEMENTS:
4389
4390  - With `--progress`, when a transfer is complete show the time taken;
4391    otherwise show expected time to complete. (Cameron Simpson)
4392
4393  - Make `make install-strip` works properly, and `make install` accepts a
4394    DESTDIR variable for help in building binary packages.  (Peter
4395    Breitenlohner, Greg Louis)
4396
4397  - If configured with `--enable-maintainer-mode`, then on receipt of a fatal
4398    signal rsync will try to open an xterm running gdb, similarly to Samba's
4399    `panic action` or GNOME's bug-buddy.  (Martin Pool)
4400
4401 ### BUG FIXES:
4402
4403  - Fix situation where failure to fork (e.g. because out of process slots)
4404    would cause rsync to kill all processes owned by the current user. Yes,
4405    really! (Paul Haas, Martin Pool)
4406
4407  - Fix test suite on Solaris. (Jos Backus, Martin Pool)
4408
4409  - Fix minor memory leak in socket code. (Dave Dykstra, Martin Pool.)
4410
4411  - Fix `--whole-file` problem that caused it to be the default even for remote
4412    connections. (Martin Pool, Frank Schulz)
4413
4414  - Work around bug in Mac OS X mkdir(2), which cannot handle trailing slashes.
4415    <http://www.opensource.apple.com/bugs/X/BSD%20Kernel/2734739.html> (Martin
4416    Pool)
4417
4418  - Improved network error handling. (Greg A. Woods)
4419
4420 ------------------------------------------------------------------------------
4421
4422 # NEWS for rsync 2.5.4, aka "Imitation lizard skin" (13 Mar 2002)
4423
4424 ## Changes in this version:
4425
4426 ### BUG FIXES:
4427
4428  - Additional fix for zlib double-free bug. (Martin Pool, Andrew Tridgell) (CVE
4429    CAN-2002-0059)
4430
4431 ### ENHANCEMENTS:
4432
4433  - Merge in changes from zlib 1.1.3 to zlib 1.1.4. (Jos Backus) (Note that
4434    rsync still uses a custom version of zlib; you can not just link against a
4435    system library. See zlib/README.rsync)
4436
4437  - Additional test cases for `--compress`. (Martin Pool)
4438
4439 ------------------------------------------------------------------------------
4440
4441 # NEWS for rsync 2.5.3, aka "Happy 26" (11 Mar 2002)
4442
4443 ## Changes in this version:
4444
4445 ### SECURITY FIXES:
4446
4447  - Make sure that supplementary groups are removed from a server
4448    process after changing uid and gid. (Ethan Benson) (Debian bug
4449    #132272, CVE CAN-2002-0080)
4450
4451 ### BUG FIXES:
4452
4453  - Fix zlib double-free bug. (Owen Taylor, Mark J Cox) (CVE CAN-2002-0059)
4454
4455  - Fixed problem that in many cases caused the error message unexpected read
4456    size of 0 in `map_ptr` and resulted in the wrong data being copied.
4457
4458  - Fixed compilation errors on some systems caused by the use of `unsigned
4459    int64` in rsync.h.
4460
4461  - Fixed problem on systems such as Sunos4 that do not support realloc on a
4462    NULL pointer; error was 'out of memory in "flist_expand"'.
4463
4464  - Fix for rsync server processes hanging around after the client unexpectedly
4465    disconnects. (Colin Walters) (Debian bug #128632)
4466
4467  - Cope with BSD systems on which mkdir() will not accept a trailing slash.
4468
4469 ### ENHANCEMENTS:
4470
4471  - Merge in changes from zlib 1.1.2 to zlib 1.1.3. (Note that rsync still uses
4472    a custom version of zlib; you can not just link against a system library.
4473    See zlib/README.rsync)
4474
4475  - Command to initiate connections is only shown with `-vv`, rather than `-v`
4476    as in 2.5.2. Output from plain `-v` is more similar to what was historically
4477    used so as not to break scripts that try to parse the output.
4478
4479  - Added `--no-whole-file` and `--no-blocking-io` options (Dave Dykstra)
4480
4481  - Made the `--write-batch` and `--read-batch` options actually work and added
4482    documentation in the manpage (Jos Backus)
4483
4484  - If the daemon is unable to fork a child to accept a connection, print an
4485    error message. (Colin Walters)
4486
4487 ------------------------------------------------------------------------------
4488
4489 # NEWS for rsync 2.5.2 (26 Jan 2002)
4490
4491 ## Changes in this version:
4492
4493 ### SECURITY FIXES:
4494
4495  - Signedness security patch from Sebastian Krahmer <krahmer@suse.de> -- in
4496    some cases we were not sufficiently careful about reading integers from the
4497    network.
4498
4499 ### PROTOCOL NUMBER:
4500
4501  - The protocol number was changed to 26.
4502
4503 ### BUG FIXES:
4504
4505  - Fix possible string mangling in log files.
4506
4507  - Fix for setting local address of outgoing sockets.
4508
4509  - Better handling of hardlinks and devices on platforms with 64-bit `dev_t` or
4510    `ino_t`.
4511
4512  - Name resolution on machines supporting IPv6 is improved.
4513
4514  - Fix for device nodes. (dann frazier) (Debian #129135)
4515
4516 ### ENHANCEMENTS:
4517
4518  - With `-v`, rsync now shows the command used to initiate an ssh/rsh
4519    connection.
4520
4521  - `--statistics` now shows memory heap usage on platforms that support
4522    mallinfo().
4523
4524  - "The Ted T'so school of program optimization": make progress visible and
4525    people will think it's faster. (With `--progress`, rsync will show you how
4526    many files it has seen as it builds the `file_list`, giving some indication
4527    that it has not hung.)
4528
4529  - Improvements to batch mode support. This is still experimental but testing
4530    would be welcome. (Jos Backus)
4531
4532  - New `--ignore-existing` option, patch previously distributed with Vipul's
4533    Razor. (Debian #124286)
4534
4535 ------------------------------------------------------------------------------
4536
4537 # NEWS for rsync 2.5.1 (3 Jan 2002)
4538
4539 ## Changes in this version:
4540
4541 ### BUG FIXES:
4542
4543  - Fix for segfault in `--daemon` mode configuration parser. (Paul Mackerras)
4544
4545  - Correct `string<->address` parsing for both IPv4 and 6.  (YOSHIFUJI Hideaki,
4546    SUMIKAWA Munechika and Jun-ichiro `itojun` Hagino)
4547
4548  - Various fixes for IPv6 support. (Dave Dykstra)
4549
4550  - rsync.1 typo fix. (Matt Kraai)
4551
4552  - Test suite typo fixes. (Tom Schmidt)
4553
4554  - rsync.1 grammar and clarity improvements. (Edward Welbourne)
4555
4556  - Correction to ./configure tests for `inet_ntop`. (Jeff Garzik)
4557
4558 ### ENHANCEMENTS:
4559
4560  - `--progress` and `-P` now show estimated data transfer rate (in a multiple
4561    of bytes/s) and estimated time to completion. (Rik Faith)
4562
4563  - `--no-detach` option, required to run as a W32 service and also useful when
4564    running on Unix under daemontools, AIX's SRC, or a debugger. (Max Bowsher,
4565    Jos Backus)
4566
4567  - Clearer error messages for some conditions.
4568
4569 ------------------------------------------------------------------------------
4570
4571 # NEWS for rsync 2.5.0 (30 Nov 2001)
4572
4573 ## Changes in this version:
4574
4575 ### PROTOCOL NUMBER:
4576
4577  - The protocol number was changed to 25.
4578
4579 ### ANNOUNCEMENTS:
4580
4581  - Martin Pool <mbp@samba.org> is now a co-maintainer.
4582
4583 ### NEW FEATURES:
4584
4585  - Support for LSB-compliant packaging <http://www.linuxbase.org/>
4586
4587  - Shell wildcards are allowed in `auth users` lines.
4588
4589  - Merged UNC rsync+ patch to support creation of standalone patch sets. By
4590    Bert J. Dempsey and Debra Weiss, updated by Jos Backus.
4591    <http://www.ils.unc.edu/i2dsi/unc_rsync+.html>
4592
4593  - IPv6 support based on a patch from KAME.net, on systems including modern
4594    versions of Linux, Solaris, and HP-UX. Also includes IPv6 compatibility
4595    functions for old OSs by the Internet Software Consortium, Paul Vixie, the
4596    OpenSSH portability project, and OpenBSD.
4597
4598 ### ENHANCEMENTS:
4599
4600  - Include/exclude cluestick: with `-vv`, print out whether files are included
4601    or excluded and why.
4602
4603  - Many error messages have more friendly explanations and more details.
4604
4605  - Manual page improvements plus scanty protocol documentation.
4606
4607  - When running as `--daemon` in the background and using a `log file`
4608    rsyncd.conf directive, close the log file every time it is open when going
4609    to sleep on the socket. This allows the log file to get cleaned out by
4610    another process.
4611
4612  - Change to using libpopt rather than getopt for processing options. This
4613    makes the code cleaner and the behaviour more consistent across platforms.
4614    popt is included and built if not installed on the platform.
4615
4616  - More details in `--version`, including note about whether 64-bit files,
4617    symlinks and hardlinks are supported.
4618
4619  - MD4 code may use less CPU cycles.
4620
4621  - Use mkstemp on systems where it is secure. If we use mktemp, explain that we
4622    do it in a secure way.
4623
4624  - `--whole-file` is the default when source and target are on the local
4625    machine.
4626
4627 ### BUG FIXES:
4628
4629  - Fix for various bugs causing rsync to hang.
4630
4631  - Attempt to fix Large File Summit support on AIX.
4632
4633  - Attempt to fix error handling lockup bug.
4634
4635  - Give a non-0 exit code if **any** of the files we have been asked to
4636    transfer fail to transfer.
4637
4638  - For log messages containing ridiculously long strings that might overflow a
4639    buffer rsync no longer aborts, but rather prints an ellipsis at the end of
4640    the string. (Patch from Ed Santiago.)
4641
4642 ### PLATFORMS:
4643
4644  - Improved support for UNICOS (tested on Cray T3E and Cray SV1)
4645
4646  - autoconf2.52 (or later) is now required to rebuild the autoconf scripts. It
4647    is not required to simply build rsync.
4648
4649  - Platforms thought to work in this release:
4650
4651    - Cray SV1 UNICOS 10.0.0.8 cc
4652    - Debian Linux 2.2 UltraSparc gcc
4653    - Debian Linux testing/unstable ARM gcc
4654    - FreeBSD 3.3-RELEASE i386 cc
4655    - FreeBSD 4.1.1-RELEASE i386 cc
4656    - FreeBSD 4.3-STABLE i386 cc
4657    - HP PA-RISC HP-UX 10.20 gcc
4658    - HP PA-RISC HP-UX 11.11 cc
4659    - IRIX 6.5 MIPS cc
4660    - IRIX 6.5 MIPS gcc
4661    - Mac OS X PPC (`--disable-ipv6`) cc
4662    - NetBSD 1.5 i386 gcc
4663    - NetBSD Current i386 cc
4664    - OpenBSD 2.5 Sparc gcc
4665    - OpenBSD 2.9 i386 cc
4666    - OpenBSD Current i386 cc
4667    - RedHat 6.2 i386 gcc
4668    - RedHat 6.2 i386 insure++
4669    - RedHat 7.0 i386 gcc
4670    - RedHat 7.1 i386 (Kernel 2.4.10) gcc
4671    - Slackware 8.0 i686 (Kernel 2.4.10)
4672    - Solaris 8 UltraSparc cc
4673    - Solaris 8 UltraSparc gcc
4674    - Solaris 8 i386 gcc
4675    - SuSE 7.1 i386 gcc2.95.2
4676    - SuSE 7.1 ppc gcc2.95.2
4677    - i386-pc-sco3.2v5.0.5 cc
4678    - i386-pc-sco3.2v5.0.5 gcc
4679    - powerpc-ibm-aix4.3.3.0 cc
4680    - i686-unknown-sysv5UnixWare7.1.0 gcc
4681    - i686-unknown-sysv5UnixWare7.1.0 cc
4682
4683 ### TESTING:
4684
4685  - The existing test.sh script by Phil Hands has been merged into a
4686    test framework that works from both `make check` and the Samba
4687    build farm.
4688
4689 ------------------------------------------------------------------------------
4690
4691 ## Partial Protocol History
4692
4693 | RELEASE DATE | VER.   | DATE OF COMMIT\* | PROTOCOL    |
4694 |--------------|--------|------------------|-------------|
4695 | 20 Oct 2022  | 3.2.7  |                  | 31          |
4696 | 09 Sep 2022  | 3.2.6  |                  | 31          |
4697 | 14 Aug 2022  | 3.2.5  |                  | 31          |
4698 | 15 Apr 2022  | 3.2.4  |                  | 31          |
4699 | 06 Aug 2020  | 3.2.3  |                  | 31          |
4700 | 04 Jul 2020  | 3.2.2  |                  | 31          |
4701 | 22 Jun 2020  | 3.2.1  |                  | 31          |
4702 | 19 Jun 2020  | 3.2.0  |                  | 31          |
4703 | 28 Jan 2018  | 3.1.3  |                  | 31          |
4704 | 21 Dec 2015  | 3.1.2  |                  | 31          |
4705 | 22 Jun 2014  | 3.1.1  |                  | 31          |
4706 | 28 Sep 2013  | 3.1.0  | 31 Aug 2008      | 31          |
4707 | 23 Sep 2011  | 3.0.9  |                  | 30          |
4708 | 26 Mar 2011  | 3.0.8  |                  | 30          |
4709 | 31 Dec 2009  | 3.0.7  |                  | 30          |
4710 | 08 May 2009  | 3.0.6  |                  | 30          |
4711 | 28 Dec 2008  | 3.0.5  |                  | 30          |
4712 | 06 Sep 2008  | 3.0.4  |                  | 30          |
4713 | 29 Jun 2008  | 3.0.3  |                  | 30          |
4714 | 08 Apr 2008  | 3.0.2  |                  | 30          |
4715 | 03 Apr 2008  | 3.0.1  |                  | 30          |
4716 | 01 Mar 2008  | 3.0.0  | 11 Nov 2006      | 30          |
4717 | 06 Nov 2006  | 2.6.9  |                  | 29          |
4718 | 22 Apr 2006  | 2.6.8  |                  | 29          |
4719 | 11 Mar 2006  | 2.6.7  |                  | 29          |
4720 | 28 Jul 2005  | 2.6.6  |                  | 29          |
4721 | 01 Jun 2005  | 2.6.5  |                  | 29          |
4722 | 30 Mar 2005  | 2.6.4  | 17 Jan 2005      | 29          |
4723 | 30 Sep 2004  | 2.6.3  |                  | 28          |
4724 | 30 Apr 2004  | 2.6.2  |                  | 28          |
4725 | 26 Apr 2004  | 2.6.1  | 08 Jan 2004      | 28          |
4726 | 01 Jan 2004  | 2.6.0  | 10 Apr 2003      | 27 (MAX=40) |
4727 | 04 Dec 2003  | 2.5.7  |                  | 26          |
4728 | 26 Jan 2003  | 2.5.6  |                  | 26          |
4729 | 02 Apr 2002  | 2.5.5  |                  | 26          |
4730 | 13 Mar 2002  | 2.5.4  |                  | 26          |
4731 | 11 Mar 2002  | 2.5.3  |                  | 26          |
4732 | 26 Jan 2002  | 2.5.2  | 11 Jan 2002      | 26          |
4733 | 03 Jan 2002  | 2.5.1  |                  | 25          |
4734 | 30 Nov 2001  | 2.5.0  | 23 Aug 2001      | 25          |
4735 | 06 Sep 2000  | 2.4.6  |                  | 24          |
4736 | 19 Aug 2000  | 2.4.5  |                  | 24          |
4737 | 29 Jul 2000  | 2.4.4  |                  | 24          |
4738 | 09 Apr 2000  | 2.4.3  |                  | 24          |
4739 | 30 Mar 2000  | 2.4.2  |                  | 24          |
4740 | 30 Jan 2000  | 2.4.1  | 29 Jan 2000      | 24          |
4741 | 29 Jan 2000  | 2.4.0  | 28 Jan 2000      | 23          |
4742 | 25 Jan 2000  | 2.3.3  | 23 Jan 2000      | 22          |
4743 | 08 Nov 1999  | 2.3.2  | 26 Jun 1999      | 21          |
4744 | 06 Apr 1999  | 2.3.1  |                  | 20          |
4745 | 15 Mar 1999  | 2.3.0  | 15 Mar 1999      | 20          |
4746 | 25 Nov 1998  | 2.2.1  |                  | 19          |
4747 | 03 Nov 1998  | 2.2.0  |                  | 19          |
4748 | 09 Sep 1998  | 2.1.1  |                  | 19          |
4749 | 20 Jul 1998  | 2.1.0  |                  | 19          |
4750 | 17 Jul 1998  | 2.0.19 |                  | 19          |
4751 | 18 Jun 1998  | 2.0.17 |                  | 19          |
4752 | 01 Jun 1998  | 2.0.16 |                  | 19          |
4753 | 27 May 1998  | 2.0.13 | 27 May 1998      | 19          |
4754 | 26 May 1998  | 2.0.12 |                  | 18          |
4755 | 22 May 1998  | 2.0.11 |                  | 18          |
4756 | 18 May 1998  | 2.0.9  | 18 May 1998      | 18          |
4757 | 17 May 1998  | 2.0.8  |                  | 17          |
4758 | 15 May 1998  | 2.0.1  |                  | 17          |
4759 | 14 May 1998  | 2.0.0  |                  | 17          |
4760 | 17 Apr 1998  | 1.7.4  |                  | 17          |
4761 | 13 Apr 1998  | 1.7.3  |                  | 17          |
4762 | 05 Apr 1998  | 1.7.2  |                  | 17          |
4763 | 26 Mar 1998  | 1.7.1  |                  | 17          |
4764 | 26 Mar 1998  | 1.7.0  | 26 Mar 1998      | 17 (MAX=30) |
4765 | 13 Jan 1998  | 1.6.9  | 13 Jan 1998      | 15 (MAX=20) |
4766
4767 \* DATE OF COMMIT is the date the protocol change was committed to version
4768 control.
4769
4770 @USE_GFM_PARSER@