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