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