Improved a sentence.
[rsync.git] / OLDNEWS
1 NEWS for rsync 2.6.9 (6 Nov 2006)
2 Protocol: 29 (unchanged)
3 Changes since 2.6.8:
4
5   BUG FIXES:
6
7     - If rsync is interrupted via a handled signal (such as SIGINT), it will
8       once again clean-up its temp file from the destination dir.
9
10     - Fixed an overzealous sanitizing bug in the handling of the --link-dest,
11       --copy-dest, and --compare-dest options to a daemon without chroot: if
12       the copy's destination dir is deeper than the top of the module's path,
13       these options now accept a safe number of parent-dir (../) references
14       (since these options are relative to the destination dir).  The old code
15       incorrectly chopped off all "../" prefixes for these options, no matter
16       how deep the destination directory was in the module's hierarchy.
17
18     - Fixed a bug where a deferred info/error/log message could get sent
19       directly to the sender instead of being handled by rwrite() in the
20       generator.  This fixes an "unexpected tag 3" fatal error, and should
21       also fix a potential problem where a deferred info/error message from
22       the receiver might bypass the log file and get sent only to the client
23       process.  (These problems could only affect an rsync daemon that was
24       receiving files.)
25
26     - Fixed a bug when --inplace was combined with a --*-dest option and we
27       update a file's data using an alternate basis file.  The code now
28       notices that it needs to copy the matching data from the basis file
29       instead of (wrongly) assuming that it was already present in the file.
30
31     - Fixed a bug where using --dry-run with a --*-dest option with a path
32       relative to a directory that does not yet exist:  the affected option
33       gets its proper path value so that the output of the dry-run is right.
34
35     - Fixed a bug in the %f logfile escape when receiving files: the
36       destination path is now included in the output (e.g. you can now tell
37       when a user specifies a subdir inside a module).
38
39     - If the receiving side fails to create a directory, it will now skip
40       trying to update everything that is inside that directory.
41
42     - If --link-dest is specified with --checksum but without --times, rsync
43       will now allow a hard-link to be created to a matching link-dest file
44       even when the file's modify-time doesn't match the server's file.
45
46     - The daemon now calls more timezone-using functions prior to doing a
47       chroot.  This should help some C libraries to generate proper timestamps
48       from inside a chrooted daemon (and to not try to access /etc/timezone
49       over and over again).
50
51     - Fixed a bug in the handling of an absolute --partial-dir=ABS_PATH option:
52       it now deletes an alternate basis file from the partial-dir that was used
53       to successfully update a destination file.
54
55     - Fixed a bug in the handling of --delete-excluded when using a per-dir
56       merge file:  the merge file is now honored on the receiving side, and
57       only its unqualified include/exclude commands are ignored (just as is
58       done for global include/excludes).
59
60     - Fixed a recent bug where --delete was not working when transferring from
61       the root (/) of the filesystem with --relative enabled.
62
63     - Fixed a recent bug where an --exclude='*' could affect the root (/) of
64       the filesystem with --relative enabled.
65
66     - When --inplace creates a file, it is now created with owner read/write
67       permissions (0600) instead of no permissions at all.  This avoids a
68       problem continuing a transfer that was interrupted (since --inplace
69       will not update a file that has no write permissions).
70
71     - If either --remove-source-files or --remove-sent-files is enabled and we
72       are unable to remove the source file, rsync now outputs an error.
73
74     - Fixed a bug in the daemon's "incoming chmod" rule:  newly-created
75       directories no longer get the 'F' (file) rules applied to them.
76
77     - Fixed an infinite loop bug when a filter rule was rejected due to being
78       overly long.
79
80     - When the server receives a --partial-dir option from the client, it no
81       longer runs the client-side code that adds an assumed filter rule (since
82       the client will be sending us the rules in the usual manner, and they
83       may have chosen to override the auto-added rule).
84
85   ENHANCEMENTS:
86
87     - Added the --log-file=FILE and --log-file-format=FORMAT options.  These
88       can be used to tell any rsync to output what it is doing to a log file.
89       They work with a client rsync, a non-daemon server rsync (see the man
90       page for instructions), and also allows the overriding of rsyncd.conf
91       settings when starting a daemon.
92
93     - The --log-format option was renamed to be --out-format to avoid confusing
94       it with affecting the log-file output.  (The old option remains as an
95       alias for the new to preserve backward compatibility.)
96
97     - Made "log file" and "syslog facility" settable on a per-module basis in
98       the daemon's config file.
99
100     - Added the --remove-source-files option as a replacement for the (now
101       deprecated) --remove-sent-files option.  This new option removes all
102       non-dirs from the source directories, even if the file was already
103       up-to-date.  This fixes a problem where interrupting an rsync that
104       was using --remove-sent-files and restarting it could leave behind
105       a file that the earlier rsync synchronized, but didn't get to remove.
106       (The deprecated --remove-sent-files is still understood for now, and
107       still behaves in the same way as before.)
108
109     - Added the option --no-motd to suppress the message-of-the-day output
110       from a daemon when doing a copy.  (See the manpage for a caveat.)
111
112     - Added a new environment variable to the pre-/post-xfer exec commands (in
113       the daemon's config file):  RSYNC_PID.  This value will be the same in
114       both the pre- and post-xfer commands, so it can be used as a unique ID
115       if the pre-xfer command wants to cache some arg/request info for the
116       post-xfer command.
117
118   INTERNAL:
119
120     - Did a code audit using IBM's code-checker program and made several
121       changes, including: replacing most of the strcpy() and sprintf()
122       calls with strlcpy(), snprintf(), and memcpy(), adding a 0-value to
123       an enum that had been intermingling a literal 0 with the defined enum
124       values, silencing some uninitialized memory checks, marking some
125       functions with a "noreturn" attribute, and changing an "if" that
126       could never succeed on some platforms into a pre-processor directive
127       that conditionally compiles the code.
128
129     - Fixed a potential bug in f_name_cmp() when both the args are a
130       top-level "." dir (which doesn't happen in normal operations).
131
132     - Changed exit_cleanup() so that it can never return instead of exit.
133       The old code might return if it found the exit_cleanup() function
134       was being called recursively.  The new code is segmented so that
135       any recursive calls move on to the next step of the exit-processing.
136
137     - The macro WIFEXITED(stat) will now be defined if the OS didn't already
138       define it.
139
140   DEVELOPER RELATED:
141
142     - The acls.diff and xattrs.diff patches have received a bunch of work to
143       make them much closer to being acceptable in the main distribution.
144       The xattrs patch also has some preliminary Mac OS X and FreeBSD
145       compatibility code that various system types to exchange extended
146       file-attributes.
147
148     - A new diff in the patches dir, fake-root.diff, allows rsync to
149       maintain a backup hierarchy with full owner, group, and device info
150       without actually running as root.  It does this using a special
151       extended attribute, so it depends on xattrs.diff (which depends on
152       acls.diff).
153
154     - The rsync.yo and rsyncd.conf.yo files have been updated to work
155       better with the latest yodl 2.x releases.
156
157     - Updated config.guess and config.sub to their 2006-07-02 versions.
158
159     - Updated various files to include the latest FSF address and to have
160       consistent opening comments.
161
162 \f
163 NEWS for rsync 2.6.8 (22 Apr 2006)
164 Protocol: 29 (unchanged)
165 Changes since 2.6.7:
166
167   BUG FIXES:
168
169     - Fixed a bug in the exclude code where an anchored exclude without any
170       wildcards fails to match an absolute source arg, but only when --relative
171       is in effect.
172
173     - Improved the I/O code for the generator to fix a potential hang when the
174       receiver gets an EOF on the socket but the generator's select() call
175       never indicates that the socket is writable for it to be notified about
176       the EOF.  (This can happen when using stunnel).
177
178     - Fixed a problem with the file-reading code where a failed read (such as
179       that caused by a bad sector) would not advance the file's read-position
180       beyond the failed read's data.
181
182     - Fixed a logging bug where the "log file" directive was not being honored
183       in a single-use daemon (one spawned by a remote-shell connection or by
184       init).
185
186     - If rsync cannot honor the --delete option, we output an error and exit
187       instead of silently ignoring the option.
188
189     - Fixed a bug in the --link-dest code that prevented special files (such as
190       fifos) from being linked.
191
192     - The ability to hard-link symlinks and special files is now determined at
193       configure time instead of at runtime.  This fixes a bug with --link-dest
194       creating a hard-link to a symlink's referent on a BSD system.
195
196   ENHANCEMENTS:
197
198     - In daemon mode, if rsync fails to bind to the requested port, the
199       error(s) returned by socket() and/or bind() are now logged.
200
201     - When we output a fatal error, we now output the version of rsync in the
202       message.
203
204     - Improved the documentation for the --owner and --group options.
205
206     - The rsyncstats script in "support" has an improved line-parsing regex
207       that is easier to read and also makes it to parse syslog-generated lines.
208
209     - A new script in "support": file-attr-restore, can be used to restore the
210       attributes of a file-set (the permissions, ownership, and group info)
211       taken from the cached output of a "find ARG... -ls" command.
212
213   DEVELOPER RELATED:
214
215     - Removed the unused function write_int_named(), the unused variable
216       io_read_phase, and the rarely used variable io_write_phase.  This also
217       elides the confusing 'phase "unknown"' part of one error message.
218
219     - Removed two unused configure checks and two related (also unused)
220       compatibility functions.
221
222     - The xattrs.diff patch received a security fix that prevents a potential
223       buffer overflow in the receive_xattr() code.
224
225     - The acls.diff patch has been improved quite a bit, with more to come.
226
227     - A new patch was added: log-file.diff.  This contains an early version of
228       a future option, --log-file=FILE, that will allow any rsync to log its
229       actions to a file (something that only a daemon supports at present).
230
231 \f
232 NEWS for rsync 2.6.7 (11 Mar 2006)
233 Protocol: 29 (unchanged)
234 Changes since 2.6.6:
235
236   OUTPUT CHANGES:
237
238     - The letter 'D' in the itemized output was being used for both devices
239       (character or block) as well as other special files (such as fifos and
240       named sockets).  This has changed to separate non-device special files
241       under the 'S' designation (e.g. "cS+++++++ path/fifo").  See also the
242       "--specials" option, below.
243
244     - The way rsync escapes unreadable characters has changed.  First, rsync
245       now has support for recognizing valid multibyte character sequences in
246       your current locale, allowing it to escape fewer characters than before
247       for a locale such as UTF-8.  Second, it now uses an escape idiom of
248       "\#123", which is the literal string "\#" followed by exactly 3 octal
249       digits.  Rsync no longer doubles a backslash character in a filename
250       (e.g. it used to output "foo\\bar" when copying "foo\bar") -- now it only
251       escapes a backslash that is followed by a hash-sign and 3 digits (0-9)
252       (e.g. it will output "foo\#134#789" when copying "foo\#789").  See also
253       the --8-bit-output (-8) option, mentioned below.
254
255       Script writers: the local rsync is the one that outputs escaped names,
256       so if you need to support unescaping of filenames for older rsyncs, I'd
257       suggest that you parse the output of "rsync --version" and only use the
258       old unescaping rules for 2.6.5 and 2.6.6.
259
260   BUG FIXES:
261
262     - Fixed a really old bug that caused --checksum (-c) to checksum all the
263       files encountered during the delete scan (ouch).
264
265     - Fixed a potential hang in a remote generator:  when the receiver gets a
266       read-error on the socket, it now signals the generator about this so that
267       the generator does not try to send any of the terminating error messages
268       to the client (avoiding a potential hang in some setups).
269
270     - Made hard-links work with symlinks and devices again.
271
272     - If the sender gets an early EOF reading a source file, we propagate this
273       error to the receiver so that it can discard the file and try requesting
274       it again (which is the existing behavior for other kinds of read errors).
275
276     - If a device-file/special-file changes permissions, rsync now updates the
277       permissions without recreating the file.
278
279     - If the user specifies a remote-host for both the source and destination,
280       we now output a syntax error rather than trying to open the destination
281       hostspec as a filename.
282
283     - When --inplace creates a new destination file, rsync now creates it with
284       permissions 0600 instead of 0000 -- this makes restarting possible when
285       the transfer gets interrupted in the middle of sending a new file.
286
287     - Reject the combination of --inplace and --sparse since the sparse-output
288       algorithm doesn't work when overwriting existing data.
289
290     - Fixed the directory name in the error that is output when pop_dir()
291       fails.
292
293     - Really fixed the parsing of a "!" entry in .cvsignore files this time.
294
295     - If the generator gets a stat() error on a file, output it (this used to
296       require at least -vv for the error to be seen).
297
298     - If waitpid() fails or the child rsync didn't exit cleanly, we now handle
299       the exit status properly and generate a better error.
300
301     - Fixed some glitches in the double-verbose output when using --copy-dest,
302       --link-dest, or --compare-dest.  Also improved how the verbose output
303       handles hard-links (within the transfer) that had an up-to-date alternate
304       "dest" file, and copied files (via --copy-dest).
305
306     - Fixed the matching of the dont-compress items (e.g. *.gz) against files
307       that have a path component containing a slash.
308
309     - If the code reading a filter/exclude file gets an EINTR error, rsync now
310       clears the error flag on the file handle so it can keep on reading.
311
312     - If --relative is active, the sending side cleans up trailing "/" or "/."
313       suffixes to avoid triggering a bug in older rsync versions.  Also, we now
314       reject a ".." dir if it would be sent as a relative dir.
315
316     - If a non-directory is in the way of a directory and rsync is run with
317       --dry-run and --delete, rsync no longer complains about not being able
318       to opendir() the not-yet present directory.
319
320     - When --list-only is used and a non-existent local destination dir was
321       also specified as a destination, rsync no longer generates a warning
322       about being unable to create the missing directory.
323
324     - Fixed some problems with --relative --no-implied-dirs when the
325       destination directory did not yet exist:  we can now create a symlink or
326       device when it is the first thing in the missing dir, and --fuzzy no
327       longer complains about being unable to open the missing dir.
328
329     - Fixed a bug where the --copy-links option would not affect implied
330       directories without --copy-unsafe-links (see --relative).
331
332     - Got rid of the need for --force to be used in some circumstances with
333       --delete-after (making it consistent with --delete-before/-during).
334
335     - Rsync now ignores the SIGXFSZ signal, just in case your OS sends this
336       when a file is too large (rsync handles the write error).
337
338     - Fixed a bug in the Proxy-Authorization header's base64-encoded value: it
339       was not properly padded with trailing '=' chars.  This only affects a
340       user that need to use a password-authenticated proxy for an outgoing
341       daemon-rsync connection.
342
343     - If we're transferring an empty directory to a new name, rsync no longer
344       forces S_IWUSR if it wasn't already set, nor does it accidentally leave
345       it set.
346
347     - Fixed a bug in the debug output (-vvvvv) that could mention the wrong
348       checksum for the current file offset.
349
350     - Rsync no longer allows a single directory to be copied over a non-
351       directory destination arg.
352
353   ENHANCEMENTS:
354
355     - Added the --append option that makes rsync append data onto files that
356       are longer on the source than the destination (this includes new files).
357
358     - Added the --min-size=SIZE option to exclude small files from the
359       transfer.
360
361     - Added the --compress-level option to allow you to set how aggressive
362       rsync's compression should be (this option implies --compress).
363
364     - Enhanced the parsing of the SIZE value for --min-size and --max-size to
365       allow easy entry of multiples of 1000 (instead of just multiples of 1024)
366       and off-by-one values too (e.g. --max-size=8mb-1).
367
368     - Added the --8-bit-output (-8) option, which tells rsync to avoid escaping
369       high-bit characters that it thinks are unreadable in the current locale.
370
371     - The new option --human-readable (-h) changes the output of --progress,
372       --stats, and the end-of-run summary to be easier to read.  If repeated,
373       the units become powers of 1024 instead of powers of 1000.  (The old
374       meaning of -h, as a shorthand for --help, still works as long as you
375       just use it on its own, as in "rsync -h".)
376
377     - If lutimes() and/or lchmod() are around, use them to allow the
378       preservation of attributes on symlinks.
379
380     - The --link-dest option now affects symlinks and devices (when possible).
381
382     - Added two config items to the rsyncd.conf parsing:  "pre-xfer exec" and
383       "post-xfer exec".  These allow a command to be specified on a per-module
384       basis that will be run before and/or after a daemon-mode transfer.  (See
385       the man page for a list of the environment variables that are set with
386       information about the transfer.)
387
388     - When using the --relative option, you can now insert a dot dir in
389       the source path to indicate where the replication of the source dirs
390       should start.  For example, if you specify a source path of
391       rsync://host/module/foo/bar/./baz/dir with -R, rsync will now only
392       replicate the "baz/dir" part of the source path (note: a trailing
393       dot dir is unaffected unless it also has a trailing slash).
394
395     - Added some new --no-FOO options that make it easier to override unwanted
396       implied or default options.  For example, "-a --no-o" (aka "--archive
397       --no-owner") can be used to turn off the preservation of file ownership
398       that is implied by -a.
399
400     - Added the --chmod=MODE option that allows the destination permissions to
401       be changed from the source permissions.  E.g. --chmod=g+w,o-rwx
402
403     - Added the "incoming chmod" and "outgoing chmod" daemon options that allow
404       a module to specify what permissions changes should be applied to all
405       files copied to and from the daemon.
406
407     - Allow the --temp-dir option to be specified when starting a daemon, which
408       sets the default temporary directory for incoming files.
409
410     - If --delete is combined with --dirs without --recursive, rsync will now
411       delete in any directory whose content is being synchronized.
412
413     - If --backup is combined with --delete without --backup-dir (and without
414       --delete-excluded), we add a "protect" filter-rule to ensure that files
415       with the backup suffix are not deleted.
416
417     - The file-count stats that are output by --progress were improved to
418       better indicate what the numbers mean.  For instance, the output:
419       "(xfer#5, to-check=8383/9999)" indicates that this was the fifth file
420       to be transferred, and we still need to check 8383 more files out of
421       a total of 9999.
422
423     - The include/exclude code now allows a dir/*** directive (with 3 trailing
424       stars) to match both the dir itself as well as all the content below the
425       dir (dir/** would not match the dir).
426
427     - Added the --prune-empty-dirs (-m) option that makes the receiving rsync
428       discard empty chains of directories from the file-list.  This makes it
429       easier to selectively copy files from a source hierarchy and end up with
430       just the directories needed to hold the resulting files.
431
432     - If the --itemize-changes (-i) option is repeated, rsync now includes
433       unchanged files in the itemized output (similar to -vv, but without all
434       the other verbose messages that can get in the way).  Of course, the
435       client must be version 2.6.7 for this to work, but the remote rsync only
436       needs to be 2.6.7 if you're pushing files.
437
438     - Added the --specials option to tell rsync to copy non-device special
439       files (which rsync now attempts even as a normal user).  The --devices
440       option now requests the copying of just devices (character and block).
441       The -D option still requests both (e.g. --devices and --specials), -a
442       still implies -D, and non-root users still get a silent downgrade that
443       omits device copying.
444
445     - Added the --super option to make the receiver always attempt super-user
446       activities.  This is useful for systems that allow things such as devices
447       to be created or ownership to be set without being UID 0, and is also
448       useful for someone who wants to ensure that errors will be output if the
449       receiving rsync isn't being run as root.
450
451     - Added the --sockopts option for those few who want to customize the TCP
452       options used to contact a daemon rsync.
453
454     - Added a way for the --temp-dir option to be combined with a partial-dir
455       setting that lets rsync avoid non-atomic updates (for those times when
456       --temp-dir is not being used because space is tight).
457
458     - A new support script, files-to-excludes, will transform a list of files
459       into a set of include/exclude directives that will copy those files.
460
461     - A new option, --executability (-E) can be used to preserve just the
462       execute bit on files, for those times when using the --perms option is
463       not desired.
464
465     - The daemon now logs each connection and also each module-list request
466       that it receives.
467
468     - New log-format options: %M (modtime), %U (uid), %G (gid), and %B
469       (permission bits, e.g. "rwxr-xrwt").
470
471     - The --dry-run option no longer forces the enabling of --verbose.
472
473     - The --remove-sent-files option now does a better job of incrementally
474       removing the sent files on the sending side (older versions tended to
475       clump up all the removals at the end).
476
477     - A daemon now supersedes its minimal SIGCHLD handler with the standard
478       PID-remembering version after forking.  This ensures that the generator
479       can get the child-exit status from the receiver.
480
481     - Use of the --bwlimit option no longer interferes with the remote rsync
482       sending error messages about invalid/refused options.
483
484     - Rsync no longer returns a usage error when used with one local source arg
485       and no destination: this now implies the --list-only option, just like
486       the comparable situation with a remote source arg.
487
488     - Added the --copy-dirlinks option, a more limited version of --copy-links.
489
490     - Various documentation improvements, including: a better synopsis, some
491       improved examples, a better discussion of the presence and absence of
492       --perms (including how it interacts with the new --executability and
493       --chmod options), an extended discussion of --temp-dir, an improved
494       discussion of --partial-dir, a better description of rsync's pattern
495       matching characters, an improved --no-implied-dirs section, and the
496       documenting of what the --stats option outputs.
497
498     - Various new and updated diffs in the patches dir, including: acls.diff,
499       xattrs.diff, atimes.diff, detect-renamed.diff, and slp.diff.
500
501   INTERNAL:
502
503     - We now use sigaction() and sigprocmask() if possible, and fall back on
504       signal() if not.  Using sigprocmask() ensures that rsync enables all the
505       signals that it needs, just in case it was started in a masked state.
506
507     - Some buffer sizes were expanded a bit, particularly on systems where
508       MAXPATHLEN is overly small (e.g. cygwin).
509
510     - If io_printf() tries to format more data than fits in the buffer, exit
511       with an error instead of transmitting a truncated buffer.
512
513     - If a va_copy macro is defined, lib/snprintf.c will use it when defining
514       the VA_COPY macro.
515
516     - Reduced the amount of stack memory needed for each level of directory
517       recursion by nearly MAXPATHLEN bytes.
518
519     - The wildmatch function was extended to allow an array of strings to be
520       supplied as the string to match.  This allows the exclude code to do less
521       string copying.
522
523     - Got rid of the safe_fname() function (and all the myriad calls) and
524       replaced it with a new function in the log.c code that filters all the
525       output going to the terminal.
526
527     - Unified the f_name() and the f_name_to() functions.
528
529     - Improved the hash-table code the sender uses to handle checksums to make
530       it use slightly less memory and run just a little faster.
531
532   DEVELOPER RELATED:
533
534     - The diffs in the patches dir now require "patch -p1 <DIFF" instead of
535       the previous -p0.  Also, the version included in the release tar now
536       affect generated files (e.g. configure, rsync.1, proto.h, etc.), so
537       it is no longer necessary to run autoconf and/or yodl unless you're
538       applying a patch that was checked out from CVS.
539
540     - Several diffs in the patches dir now use the proper --enable-FOO
541       configure option instead of --with-FOO to turn on the inclusion of
542       the newly patched feature.
543
544     - There is a new script, "prepare-source" than can be used to update the
545       various generated files (proto.h, configure, etc.) even before configure
546       has created the Makefile (this is mainly useful when patching the source
547       with a patch that doesn't affect generated files).
548
549     - The testsuite now sets HOME so that it won't be affected by a file such
550       as ~/.popt.
551
552 \f
553 NEWS for rsync 2.6.6 (28 Jul 2005)
554 Protocol: 29 (unchanged)
555 Changes since 2.6.5:
556
557   SECURITY FIXES:
558
559     - The zlib code was upgraded to version 1.2.3 in order to make it more
560       secure.  While the widely-publicized security problem in zlib 1.2.2 did
561       not affect rsync, another security problem surfaced that affects rsync's
562       zlib 1.1.4.
563
564   BUG FIXES:
565
566     - The setting of flist->high in clean_flist() was wrong for an empty list.
567       This could cause flist_find() to crash in certain rare circumstances
568       (e.g. if just the right directory setup was around when --fuzzy was
569       combined with --link-dest).
570
571     - The outputting of hard-linked files when verbosity was > 1 was not right:
572       (1) Without -i it would output the name of each hard-linked file as
573       though it had been changed; it now outputs a "is hard linked" message for
574       the file. (2) With -i it would output all dots for the unchanged
575       attributes of a hard-link; it now changes those dots to spaces, as is
576       done for other totally unchanged items.
577
578     - When backing up a changed symlink or device, get rid of any old backup
579       item so that we don't get an "already exists" error.
580
581     - A couple places that were comparing a local and a remote modification-
582       time were not honoring the --modify-window option.
583
584     - Fixed a bug where the 'p' (permissions) itemized-changes flag might get
585       set too often (if some non-significant mode bits differed).
586
587     - Fixed a really old, minor bug that could cause rsync to warn about being
588       unable to mkdir() a path that ends in "/." because it just created the
589       directory (required --relative, --no-implied-dirs, a source path that
590       ended in either a trailing slash or a trailing "/.", and a non-existing
591       destination dir to tickle the bug in a recent version).
592
593   ENHANCEMENTS:
594
595     - Made the "max verbosity" setting in the rsyncd.conf file settable on a
596       per-module basis (which now matches the documentation).
597
598     - The support/rrsync script has been upgraded to verify the args of options
599       that take args (instead of rejecting any such options).  The script was
600       also changed to try to be more secure and to fix a problem in the parsing
601       of a pull operation that has multiple sources.
602
603     - Improved the documentation that explains the difference between a
604       normal daemon transfer and a daemon-over remote-shell transfer.
605
606     - Some of the diffs supplied in the patches dir were fixed and/or
607       improved.
608
609   BUILD CHANGES:
610
611     - Made configure define NOBODY_USER (currently hard-wired to "nobody") and
612       NOBODY_GROUP (set to either "nobody" or "nogroup" depending on what we
613       find in the /etc/group file).
614
615     - Added a test to the test suite, itemized.test, that tests the output of
616       -i (log-format w/%i) and some double-verbose messages.
617
618 \f
619 NEWS for rsync 2.6.5 (1 Jun 2005)
620 Protocol: 29 (unchanged)
621 Changes since 2.6.4:
622
623   OUTPUT CHANGES:
624
625     - Non-printable chars in filenames are now output using backslash-
626       escaped characters rather than '?'s.  Any non-printable character is
627       output using 3 digits of octal (e.g. "\n" -> "\012"), and a backslash
628       is now output as "\\".  Rsync also uses your locale setting, which
629       can make it treat fewer high-bit characters as non-printable.
630
631     - If rsync received an empty file-list when pulling files, it would
632       output a "nothing to do" message and exit with a 0 (success) exit
633       status, even if the remote rsync returned an error (it did not do
634       this under the same conditions when pushing files).  This was changed
635       to make the pulling behavior the same as the pushing behavior:  we
636       now do the normal end-of-run outputting (depending on options) and
637       exit with the appropriate exit status.
638
639   BUG FIXES:
640
641     - A crash bug was fixed when a daemon had its "path" set to "/", did
642       not have chroot enabled, and used some anchored excludes in the
643       rsyncd.conf file.
644
645     - Fixed a bug in the transfer of a single file when -H is specified
646       (rsync would either infinite loop or perhaps crash).
647
648     - Fixed a case where the generator might try (and fail) to tweak the
649       write-permissions of a read-only directory in list-only mode (this
650       only caused an annoying warning message).
651
652     - If --compare-dest or --link-dest uses a locally-copied file as the
653       basis for an updated version, log this better when --verbose or -i
654       is in effect.
655
656     - Fixed the accidental disabling of --backup during the --delete-after
657       processing.
658
659     - Restored the ability to use the --address option in client mode (in
660       addition to its use in daemon mode).
661
662     - Make sure that some temporary progress information from the delete
663       processing does not get left on the screen when it is followed by a
664       newline.
665
666     - When --existing skips a directory with extra verbosity, refer to it
667       as a "directory", not a "file".
668
669     - When transferring a single file to a different-named file, any
670       generator messages that are source-file related no longer refer to
671       the file by the destination filename.
672
673     - Fixed a bug where hard-linking a group of files might fail if the
674       generator hasn't created a needed destination directory yet.
675
676     - Fixed a bug where a hard-linked group of files that is newly-linked
677       to a file in a --link-dest dir doesn't link the files from the rest
678       of the cluster.
679
680     - When deleting files with the --one-file-system (-x) option set, rsync
681       no longer tries to remove files from inside a mount-point on the
682       receiving side.  Also, we don't complain about being unable to remove
683       the mount-point dir.
684
685     - Fixed a compatibility problem when using --cvs-ignore (-C) and
686       sending files to an older rsync without using --delete.
687
688     - Make sure that a "- !" or "+ !" include/exclude pattern does not
689       trigger the list-clearing action that is reserved for "!".
690
691     - Avoid a timeout in the generator when the sender/receiver aren't
692       handling the generator's checksum output quickly enough.
693
694     - Fixed the omission of some directories in the delete processing when
695       --relative (-R) was combined with a source path that had a trailing
696       slash.
697
698     - Fixed a case where rsync would erroneously delete some files and then
699       re-transfer them when the options --relative (-R) and --recursive
700       (-r) were both enabled (along with --delete) and a source path had a
701       trailing slash.
702
703     - Make sure that --max-size doesn't affect a device or a symlink.
704
705     - Make sure that a system with a really small MAXPATHLEN does not cause
706       the buffers in readfd_unbuffered() to be too small to receive normal
707       messages.  (This mainly affected Cygwin.)
708
709     - If a source pathname ends with a filename of "..", treat it as if
710       "../" had been specified (so that we don't copy files to the parent
711       dir of the destination).
712
713     - If --delete is combined with a file-listing rsync command (i.e. no
714       transfer is happening), avoid outputting a warning that we couldn't
715       delete anything.
716
717     - If --stats is specified with --delete-after, ensure that all the
718       "deleting" messages are output before the statistics.
719
720     - Improved one "if" in the deletion code that was only checking errno
721       for ENOTEMPTY when it should have also been checking for EEXIST (for
722       compatibility with OS variations).
723
724   ENHANCEMENTS:
725
726     - Added the --only-write-batch=FILE option that may be used (instead
727       of --write-batch=FILE) to create a batch file without doing any
728       actual updating of the destination.  This allows you to divert all
729       the file-updating data away from a slow data link (as long as you
730       are pushing the data to the remote server when creating the batch).
731
732     - When the generator is taking a long time to fill up its output buffer
733       (e.g. if the transferred files are few, small, or missing), it now
734       periodically flushes the output buffer so that the sender/receiver
735       can get started on the files sooner rather than later.
736
737     - Improved the keep-alive code to handle a long silence between the
738       sender and the receiver that can occur when the sender is receiving
739       the checksum data for a large file.
740
741     - Improved the auth-errors that are logged by the daemon to include
742       some information on why the authorization failed:  wrong user,
743       password mismatch, etc.  (The client-visible message is unchanged!)
744
745     - Improved the client's handling of an "@ERROR" from a daemon so that
746       it does not complain about an unexpectedly closed socket (since we
747       really did expect the socket to close).
748
749     - If the daemon can't open the log-file specified in rsyncd.conf, fall
750       back to using syslog and log an appropriate warning.  This is better
751       than what was typically a totally silent (and fatal) failure (since a
752       daemon is not usually run with the --no-detach option that was
753       necessary to see the error on stderr).
754
755     - The man pages now consistently refer to an rsync daemon as a "daemon"
756       instead of a "server" (to distinguish it from the server process in a
757       non-daemon transfer).
758
759     - Made a small change to the rrsync script (restricted rsync -- in the
760       support dir) to make a read-only server reject all --remove-* options
761       when sending files (to future-proof it against the possibility of
762       other similar options being added at some point).
763
764   INTERNAL:
765
766     - Rsync now calls setlocale(LC_CTYPE, "").  This enables isprint() to
767       better discern which filename characters need to be escaped in
768       messages (which should result in fewer escaped characters in some
769       locales).
770
771     - Improved the naming of the log-file open/reopen/close functions.
772
773     - Removed some protocol-compatibility code that was only needed to help
774       someone running a pre-release of 2.6.4.
775
776   BUILD CHANGES:
777
778     - Added configure option "--disable-locale" to disable any use of
779       setlocale() in the binary.
780
781     - Fixed a bug in the SUPPORT{,_HARD}_LINKS #defines which prevented
782       rsync from being built without symlink or hard-link support.
783
784     - Only #define HAVE_REMSH if it is going to be set to 1.
785
786     - Configure now disables the use of mkstemp() under HP-UX (since they
787       refuse to fix its broken handling of large files).
788
789     - Configure now explicitly checks for the lseek64() function so that
790       the code can use HAVE_LSEEK64 instead of inferring lseek64()'s
791       presence based on the presence of the off64_t type.
792
793     - Configure no longer mentions the change in the default remote-shell
794       (from rsh to ssh) that occurred for the 2.6.0 release.
795
796     - Some minor enhancements to the test scripts.
797
798     - Added a few new *.diff files to the patches dir, including a patch
799       that enables the optional copying of extended attributes.
800
801 \f
802 NEWS for rsync 2.6.4 (30 March 2005)
803 Protocol: 29 (changed)
804 Changes since 2.6.3:
805
806   OUTPUT CHANGES:
807
808     - When rsync deletes a directory and outputs a verbose message about
809       it, it now appends a trailing slash to the name instead of (only
810       sometimes) outputting a preceding "directory " string.
811
812     - The --stats output will contain file-list time-statistics if both
813       sides are 2.6.4, or if the local side is 2.6.4 and the files are
814       being pushed (since the stats come from the sending side).
815       (Requires protocol 29 for a pull.)
816
817     - The "%o" (operation) log-format escape now has a third value (besides
818       "send" and "recv"):  "del." (with trailing dot to make it 4 chars).
819       This changes the way deletions are logged in the daemon's log file.
820
821     - When the --log-format option is combined with --verbose, rsync now
822       avoids outputting the name of the file twice in most circumstances.
823       As long as the --log-format item does not refer to any post-transfer
824       items (such as %b or %c), the --log-format message is output prior to
825       the transfer, so --verbose is now the equivalent of a --log-format of
826       '%n%L' (which outputs the name and any link info).  If the log output
827       must occur after the transfer to be complete, the only time the name
828       is also output prior to the transfer is when --progress was specified
829       (so that the name will precede the progress stats, and the full
830       --log-format output will come after).
831
832     - Non-printable characters in filenames are replaced with a '?' to
833       avoid corrupting the screen or generating empty lines in the output.
834   
835   BUG FIXES:
836
837     - Restore the list-clearing behavior of "!" in a .cvsignore file (2.6.3
838       was only treating it as a special token in an rsync include/exclude
839       file).
840
841     - The combination of --verbose and --dry-run now mentions the full list
842       of changes that would be output without --dry-run.
843
844     - Avoid a mkdir warning when removing a directory in the destination
845       that already exists in the --backup-dir.
846
847     - An OS that has a binary mode for its files (such as cygwin) needed
848       setmode(fd, O_BINARY) called on the temp-file we opened with
849       mkstemp().  (Fix derived from cygwin's 2.6.3 rsync package.)
850
851     - Fixed a potential hang when verbosity is high, the client side is
852       the sender, and the file-list is large.
853
854     - Fixed a potential protocol-corrupting bug where the generator could
855       merge a message from the receiver into the middle of a multiplexed
856       packet of data if only part of that data had been written out to the
857       socket when the message from the generator arrived.
858
859     - We now check if the OS doesn't support using mknod() for creating
860       FIFOs and sockets, and compile-in some compatibility code using
861       mkfifo() and socket() when necessary.
862
863     - Fixed an off-by-one error in the handling of --max-delete=N.  Also,
864       if the --max-delete limit is exceeded during a run, we now output a
865       warning about this at the end of the run and exit with a new error
866       code (25).
867
868     - One place in the code wasn't checking if fork() failed.
869
870     - The "ignore nonreadable" daemon parameter used to erroneously affect
871       readable symlinks that pointed to a non-existent file.
872
873     - If the OS does not have lchown() and a chown() of a symlink will
874       affect the referent of a symlink (as it should), we no longer try
875       to set the user and group of a symlink.
876
877     - The generator now properly runs the hard-link loop and the dir-time
878       rewriting loop after we're sure that the redo phase is complete.
879
880     - When --backup was specified with --partial-dir=DIR, where DIR is a
881       relative path, the backup code was erroneously trying to backup a
882       file that was put into the partial-dir.
883
884     - If a file gets resent in a single transfer and the --backup option is
885       enabled along with --inplace, rsync no longer performs a duplicate
886       backup (it used to overwrite the first backup with the failed file).
887
888     - One call to flush_write_file() was not being checked for an error.
889
890     - The --no-relative option was not being sent from the client to a
891       server sender.
892
893     - If an rsync daemon specified "dont compress = ..." for a file and the
894       client tried to specify --compress, the libz code was not handling a
895       compression level of 0 properly.  This could cause a transfer failure
896       if the block-size for a file was large enough (e.g. rsync might have
897       exited with an error for large files).
898
899     - Fixed a bug that would sometimes surface when using --compress and
900       sending a file with a block-size larger than 64K (either manually
901       specified, or computed due to the file being really large).  Prior
902       versions of rsync would sometimes fail to decompress the data
903       properly, and thus the transferred file would fail its verification.
904
905     - If a daemon can't open the specified log file (i.e. syslog is not
906       being used), die without crashing.  We also output an error about
907       the failure on stderr (which will only be seen if --no-detach was
908       specified) and exit with a new error code (6).
909
910     - A local transfer no longer duplicates all its include/exclude options
911       (since the forked process already has a copy of the exclude list,
912       there's no need to send them a set of duplicates).
913
914     - The output of the items that are being updated by the generator (dirs,
915       symlinks, devices) is now intermingled in the proper order with the
916       output from the items that the receiver is updating (regular files)
917       when pulling.  This misordering was particularly bad when --progress
918       was specified.  (Requires protocol 29.)
919
920     - When --timeout is specified, lulls that occur in the transfer while
921       the generator is doing work that does not generate socket traffic
922       (looking for changed files, deleting files, doing directory-time
923       touch-ups, etc.) will cause a new keep-alive packet to be sent that
924       should keep the transfer going as long as the generator continues to
925       make progress.  (Requires protocol 29.)
926
927     - The stat size of a device is not added to the total file size of the
928       items in the transfer (the size might be undefined on some OSes).
929
930     - Fixed a problem with refused-option messages sometimes not making it
931       back to the client side when a remote --files-from was in effect and
932       the daemon was the receiver.
933
934     - The --compare-dest option was not updating a file that differed in
935       (the preserved) attributes from the version in the compare-dest DIR.
936
937     - When rsync is copying files into a write-protected directory, fixed
938       the change-report output for the directory so that we don't report
939       an identical directory as changed.
940
941   ENHANCEMENTS:
942
943     - Rsync now supports popt's option aliases, which means that you can
944       use /etc/popt and/or ~/.popt to create your own option aliases.
945
946     - Added the --delete-during (--del) option which will delete files
947       from the receiving side incrementally as each directory in the
948       transfer is being processed.  This makes it more efficient than the
949       default, before-the-transfer behavior, which is now also available as
950       --delete-before (and is still the default --delete-WHEN option that
951       will be chosen if --delete or --delete-excluded is specified without
952       a --delete-WHEN choice).  All the --del* options infer --delete, so
953       an rsync daemon that refuses "delete" will still refuse to allow any
954       file-deleting options (including the new --remove-sent-files option).
955
956     - All the --delete-WHEN options are now more memory efficient:
957       Previously an duplicate set of file-list objects was created on the
958       receiving side for the entire destination hierarchy.  The new
959       algorithm only creates one directory of objects at a time (for files
960       inside the transfer).
961
962     - Added the --copy-dest option, which works like --link-dest except
963       that it locally copies identical files instead of hard-linking them.
964
965     - Added support for specifying multiple --compare-dest, --copy-dest, or
966       --link-dest options, but only of a single type. (Promoted from the
967       patches dir and enhanced.) (Requires protocol 29.)
968
969     - Added the --max-size option. (Promoted from the patches dir.)
970
971     - The daemon-mode options are now separated from the normal rsync
972       options so that they can't be mixed together.  This makes it
973       impossible to start a daemon that has improper default option values
974       (which could cause problems when a client connects, such as hanging
975       or crashing).
976
977     - The --bwlimit option may now be used in combination with --daemon
978       to specify both a default value for the daemon side and a value
979       that cannot be exceeded by a user-specified --bwlimit option.
980
981     - Added the "port" parameter to the rsyncd.conf file. (Promoted from
982       the patches dir.)  Also added "address".  The command-line options
983       take precedence over a config-file option, as expected.
984
985     - In _exit_cleanup(): when we are exiting with a partially-received
986       file, we now flush any data in the write-cache before closing the
987       partial file.
988
989     - The --inplace support was enhanced to work with --compare-dest,
990       --link-dest, and (the new) --copy-dest options. (Requires protocol
991       29.)
992
993     - Added the --dirs (-d) option for an easier way to copy directories
994       without recursion.  Any directories that are encountered are created
995       on the destination.  Specifying a directory with a trailing slash
996       copies its immediate contents to the destination.
997
998     - The --files-from option now implies --dirs (-d).
999
1000     - Added the --list-only option, which is mainly a way for the client to
1001       put the server into listing mode without needing to resort to any
1002       internal option kluges (e.g. the age-old use of "-r --exclude="/*/*"
1003       for a non-recursive listing).  This option is used automatically
1004       (behind the scenes) when a modern rsync speaks to a modern daemon,
1005       but may also be specified manually if you want to force the use of
1006       the --list-only option over a remote-shell connection.
1007
1008     - Added the --omit-dir-times (-O) option, which will avoid updating
1009       the modified time for directories when --times was specified.  This
1010       option will avoid an extra pass through the file-list at the end of
1011       the transfer (to tweak all the directory times), which may provide
1012       an appreciable speedup for a really large transfer. (Promoted from
1013       the patches dir.)
1014
1015     - Added the --filter (-f) option and its helper option, -F.  Filter
1016       rules are an extension to the existing include/exclude handling
1017       that also supports nested filter files as well as per-directory
1018       filter files (like .cvsignore, but with full filter-rule parsing).
1019       This new option was chosen in order to ensure that all existing
1020       include/exclude processing remained 100% compatible with older
1021       versions.  Protocol 29 is needed for full filter-rule support, but
1022       backward-compatible rules work with earlier protocol versions.
1023       (Promoted from the patches dir and enhanced.)
1024
1025     - Added the --delay-updates option that puts all updated files into
1026       a temporary directory (by default ".~tmp~", but settable via the
1027       --partial-dir=DIR option) until the end of the transfer.  This
1028       makes the updates a little more atomic for a large transfer.
1029
1030     - If rsync is put into the background, any output from --progress is
1031       reduced.
1032
1033     - Documented the "max verbosity" setting for rsyncd.conf.  (This
1034       setting was added a couple releases ago, but left undocumented.)
1035
1036     - The sender and the generator now double-check the file-list index
1037       they are given, and refuse to try to do a file transfer on a
1038       non-file index (since that would indicate that something had gone
1039       very wrong).
1040
1041     - Added the --itemize-changes (-i) option, which is a way to output a
1042       more detailed list of what files changed and in what way.  The effect
1043       is the same as specifying a --log-format of "%i %n%L" (see both the
1044       rsync and rsyncd.conf manpages).  Works with --dry-run too.
1045
1046     - Added the --fuzzy (-y) option, which attempts to find a basis file
1047       for a file that is being created from scratch.  The current algorithm
1048       only looks in the destination directory for the created file, but it
1049       does attempt to find a match based on size/mod-time (in case the file
1050       was renamed with no other changes) as well as based on a fuzzy
1051       name-matching algorithm.  This option requires protocol 29 because it
1052       needs the new file-sorting order.  (Promoted from patches dir and
1053       enhanced.) (Requires protocol 29.)
1054
1055     - Added the --remove-sent-files option, which lets you move files
1056       between systems.
1057
1058     - The hostname in HOST:PATH or HOST::PATH may now be an IPv6 literal
1059       enclosed in '[' and ']' (e.g. "[::1]").  (We already allowed IPv6
1060       literals in the rsync://HOST:PORT/PATH format.)
1061
1062     - When rsync recurses to build the file list, it no longer keeps open
1063       one or more directory handles from the dir's parent dirs.
1064
1065     - When building under windows, the default for --daemon is now to
1066       avoid detaching, requiring the new --detach option to force rsync
1067       to detach.
1068
1069     - The --dry-run option can now be combined with either --write-batch or
1070       --read-batch, allowing you to run a do-nothing test command to see
1071       what would happen without --dry-run.
1072
1073     - The daemon's "read only" config item now sets an internal read_only
1074       variable that makes extra sure that no write/delete calls on the
1075       read-only side can succeed.
1076
1077     - The log-format % escapes can now have a numeric field width in
1078       between the % and the escape letter (e.g. "%-40n %08p").
1079
1080     - Improved the option descriptions in the --help text.
1081
1082   SUPPORT FILES:
1083
1084     - Added atomic-rsync to the support dir: a perl script that will
1085       transfer some files using rsync, and then move the updated files into
1086       place all at once at the end of the transfer.  Only works when
1087       pulling, and uses --link-dest and a parallel hierarchy of files to
1088       effect its update.
1089
1090     - Added mnt-excl to the support dir: a perl script that takes the
1091       /proc/mounts file and translates it into a set of excludes that will
1092       exclude all mount points (even mapped mounts to the same disk).  The
1093       excludes are made relative to the specified source dir and properly
1094       anchored.
1095
1096     - Added savetransfer.c to the support dir: a C program that can make
1097       a copy of all the data that flows over the wire.  This lets you test
1098       for data corruption (by saving the data on both the sending side and
1099       the receiving side) and provides one way to debug a protocol error.
1100
1101     - Added rrsync to the support dir: this is an updated version of Joe
1102       Smith's restricted rsync perl script.  This helps to ensure that only
1103       certain rsync commands can be run by an ssh invocation.
1104
1105   INTERNAL:
1106
1107     - Added better checking of the checksum-header values that come over
1108       the socket.
1109
1110     - Merged a variety of file-deleting functions into a single function so
1111       that it is easier to maintain.
1112
1113     - Improved the type of some variables (particularly blocksize vars) for
1114       consistency and proper size.
1115
1116     - Got rid of the uint64 type (which we didn't need).
1117
1118     - Use a slightly more compatible set of core #include directives.
1119
1120     - Defined int32 in a way that ensures that the build dies if we can't
1121       find a variable with at least 32 bits.
1122
1123   PROTOCOL DIFFERENCES FOR VERSION 29:
1124
1125     - A 16-bit flag-word is transmitted after every file-list index.  This
1126       indicates what is changing between the sender and the receiver.  The
1127       generator now transmits an index and a flag-word to indicate when
1128       dirs and symlinks have changed (instead of producing a message),
1129       which makes the outputting of the information more consistent and
1130       less prone to screen corruption (because the local receiver/sender is
1131       now outputting all the file-change info messages).
1132
1133     - If a file is being hard-linked, the ITEM_XNAME_FOLLOWS bit is enabled
1134       in the flag-word and the name of the file that was linked immediately
1135       follows in vstring format (see below).
1136
1137     - If a file is being transferred with an alternate-basis file, the
1138       ITEM_BASIS_TYPE_FOLLOWS bit is enabled in the flag-word and a single
1139       byte follows, indicating what type of basis file was chosen.  If that
1140       indicates that a fuzzy-match was selected, the ITEM_XNAME_FOLLOWS bit
1141       is set in the flag-word and the name of the match in vstring format
1142       follows the basis byte.  A vstring is a variable length string that
1143       has its size written prior to the string, and no terminating null.
1144       If the string is from 1-127 bytes, the length is a single byte.  If
1145       it is from 128-32767 bytes, the length is written as ((len >> 8) |
1146       0x80) followed by (len % 0x100).
1147
1148     - The sending of exclude names is done using filter-rule syntax.  This
1149       means that all names have a prefixed rule indicator, even excludes
1150       (which used to be sent as a bare pattern, when possible).  The -C
1151       option will include the per-dir .cvsignore merge file in the list of
1152       filter rules so it is positioned correctly (unlike in some older
1153       transfer scenarios).
1154
1155     - Rsync sorts the filename list in a different way: it sorts the subdir
1156       names after the non-subdir names for each dir's contents, and it
1157       always puts a dir's contents immediately after the dir's name in the
1158       list.  (Previously an item named "foo.txt" would sort in between
1159       directory "foo/" and "foo/bar".)
1160
1161     - When talking to a protocol 29 rsync daemon, a list-only request
1162       is able to note this before the options are sent over the wire and
1163       the new --list-only option is included in the options.
1164
1165     - When the --stats bytes are sent over the wire (or stored in a batch),
1166       they now include two elapsed-time values: one for how long it took to
1167       build the file-list, and one for how long it took to send it over the
1168       wire (each expressed in thousandths of a second).
1169
1170     - When --delete-excluded is specified with some filter rules (AKA
1171       excludes), a client sender will now initiate a send of the rules to
1172       the receiver (older protocols used to omit the sending of excludes in
1173       this situation since there were no receiver-specific rules that
1174       survived --delete-excluded back then).  Note that, as with all the
1175       filter-list sending, only items that are significant to the other
1176       side will actually be sent over the wire, so the filter-rule list
1177       that is sent in this scenario is often empty.
1178
1179     - An index equal to the file-list count is sent as a keep-alive packet
1180       from the generator to the sender, which then forwards it on to the
1181       receiver.  This normally invalid index is only a valid keep-alive
1182       packet if the 16-bit flag-word that follows it contains a single bit
1183       (ITEM_IS_NEW, which is normally an illegal flag to appear alone).
1184
1185     - A protocol-29 batch file includes a bit for the setting of the --dirs
1186       option and for the setting of the --compress option.  Also, the shell
1187       script created by --write-batch will use the --filter option instead
1188       of --exclude-from to capture any filter rules.
1189
1190   BUILD CHANGES:
1191
1192     - Handle an operating system that use mkdev() in place of makedev().
1193
1194     - Improved configure to better handle cross-compiling.
1195
1196 \f
1197 NEWS for rsync 2.6.3 (30 Sep 2004)
1198 Protocol: 28 (unchanged)
1199 Changes since 2.6.2:
1200
1201   SECURITY FIXES:
1202
1203     - A bug in the sanitize_path routine (which affects a non-chrooted
1204       rsync daemon) could allow a user to craft a pathname that would get
1205       transformed into an absolute path for certain options (but not for
1206       file-transfer names).  If you're running an rsync daemon with chroot
1207       disabled, *please upgrade*, ESPECIALLY if the user privs you run
1208       rsync under is anything above "nobody".
1209
1210   OUTPUT CHANGES (ATTN: those using a script to parse the verbose output):
1211
1212     - Please note that the 2-line footer (output when verbose) now uses the
1213       term "sent" instead of "wrote" and "received" instead of "read".  If
1214       you are not parsing the numeric values out of this footer, a script
1215       would be better off using the empty line prior to the footer as the
1216       indicator that the verbose output is over.
1217       
1218     - The output from the --stats option was similarly affected to change
1219       "written" to "sent" and "read" to "received".
1220
1221     - Rsync ensures that a filename that contains a newline gets mentioned
1222       with each newline transformed into a question mark (which prevents a
1223       filename from causing an empty line to be output).
1224
1225     - The "backed up ..." message that is output when at least 2 --verbose
1226       options are specified is now the same both with and without the
1227       --backup-dir option.
1228
1229   BUG FIXES:
1230
1231     - Fixed a crash bug that might appear when --delete was used and
1232       multiple source directories were specified.
1233
1234     - Fixed a 32-bit truncation of the file length when generating the
1235       checksums.
1236
1237     - The --backup code no longer attempts to create some directories
1238       over and over again (generating warnings along the way).
1239
1240     - Fixed a bug in the reading of the secrets file (by the daemon) and
1241       the password file (by the client):  the files no longer need to be
1242       terminated by a newline for their content to be read in.
1243
1244     - If a file has a read error on the sending side or the reconstructed
1245       data doesn't match the expected checksum (perhaps due to the basis
1246       file changing during the transfer), the receiver will no longer
1247       retain the resulting file unless the --partial option was specified.
1248       (Note: for the read-error detection to work, neither side can be
1249       older than 2.6.3 -- older receivers will always retain the file, and
1250       older senders don't tell the receiver that the file had a read
1251       error.)
1252
1253     - If a file gets resent in a single transfer and the --backup option
1254       is enabled, rsync no longer performs a duplicate backup (it used to
1255       overwrite the original file in the backup area).
1256
1257     - Files specified in the daemon's "exclude" or "exclude from" config
1258       items are now excluded from being uploaded (assuming that the module
1259       allows uploading at all) in addition to the old download exclusion.
1260
1261     - Got rid of a potential hang in the receiver when near the end of a
1262       phase.
1263
1264     - When using --backup without a --backup-dir, rsync no longer preserves
1265       the modify time on directories.  This avoids confusing NFS.
1266
1267     - When --copy-links (-L) is specified, we now output a separate error
1268       for a symlink that has no referent instead of claiming that a file
1269       "vanished".
1270
1271     - The --copy-links (-L) option no longer has the side-effect of telling
1272       the receiving side to follow symlinks.  See the --keep-dirlinks
1273       option (mentioned below) for a way to specify that behavior.
1274
1275     - Error messages from the daemon server's option-parsing (such as
1276       refused options) are now successfully transferred back to the client
1277       (the server used to fail to send the message because the socket
1278       wasn't in the right state for the message to get through).
1279
1280     - Most transfer errors that occur during a daemon transfer are now
1281       returned to the user in addition to being logged (some messages are
1282       intended to be daemon-only and are not affected by this).
1283
1284     - Fixed a bug in the daemon authentication code when using one of the
1285       batch-processing options.
1286
1287     - We try to work around some buggy IPv6 implementations that fail to
1288       implement IPV6_V6ONLY.  This should fix the "address in use" error
1289       that some daemons get when running on an OS with a buggy IPv6
1290       implementation.  Also, if the new code gets this error, we might
1291       suggest that the user specify --ipv4 or --ipv6 (if we think it will
1292       help).
1293
1294     - When the remote rsync dies, make a better effort to recover any error
1295       messages it may have sent before dying (the local rsync used to just
1296       die with a socket-write error).
1297
1298     - When using --delete and a --backup-dir that contains files that are
1299       hard-linked to their destination equivalents, rsync now makes sure
1300       that removed files really get removed (avoids a really weird rename()
1301       behavior).
1302
1303     - Avoid a bogus run-time complaint about a lack of 64-bit integers when
1304       the int64 type is defined as an off_t and it actually has 64-bits.
1305
1306     - Added a configure check for open64() without mkstemp64() so that we
1307       can avoid using mkstemp() when such a combination is encountered.
1308       This bypasses a problem writing out large temp files on OSes such as
1309       AIX and HP-UX.
1310
1311     - Fixed an age-old crash problem with --read-batch on a local copy
1312       (rsync was improperly assuming --whole-file for the local copy).
1313
1314     - When --dry-run (-n) is used and the destination directory does not
1315       exist, rsync now produces a correct report of files that would be
1316       sent instead of dying with a chdir() error.
1317
1318     - Fixed a bug that could cause a slow-to-connect rsync daemon to die
1319       with an error instead of waiting for the connection to finish.
1320
1321     - Fixed an ssh interaction that could cause output to be lost when the
1322       user chose to combine the output of rsync's stdout and stderr (e.g.
1323       using the "2>&1").
1324
1325     - Fixed an option-parsing bug when --files-from got passed to a daemon.
1326
1327   ENHANCEMENTS:
1328
1329     - Added the --partial-dir=DIR option that lets you specify where to
1330       (temporarily) put a partially transferred file (instead of over-
1331       writing the destination file).  E.g.  --partial-dir=.rsync-partial
1332       Also added support for the RSYNC_PARTIAL_DIR environment variable
1333       that, when found, transforms a regular --partial option (such as
1334       the convenient -P option) into one that also specifies a directory.
1335
1336     - Added --keep-dirlinks (-K), which allows you to symlink a directory
1337       onto another partition on the receiving side and have rsync treat it
1338       as matching a normal directory from the sender.
1339
1340     - Added the --inplace option that tells rsync to write each destination
1341       file without using a temporary file.  The matching of existing data
1342       in the destination file can be severely limited by this, but there
1343       are also cases where this is more efficient (such as appending data).
1344       Use only when needed (see the man page for more details).
1345
1346     - Added the "write only" option for the daemon's config file.
1347
1348     - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
1349       and documented all these options in the man page.
1350
1351     - Improved the handling of the --bwlimit option so that it's less
1352       bursty, more accurate, and works properly over a larger range of
1353       values.
1354
1355     - The rsync daemon-over-ssh code now looks for SSH_CONNECTION and
1356       SSH2_CLIENT in addition to SSH_CLIENT to figure out the IP address.
1357
1358     - Added the --checksum-seed=N option for advanced users.
1359
1360     - Batch writing/reading has a brand-new implementation that is simpler,
1361       fixes a few weird problems with the old code (such as no longer
1362       sprinkling the batch files into different dirs or even onto different
1363       systems), and is much less intrusive into the code (making it easier
1364       to maintain for the future).  The new code generates just one data
1365       file instead of three, which makes it possible to read the batch on
1366       stdin via a remote shell.  Also, the old requirement of forcing the
1367       same fixed checksum-seed for all batch processing has been removed.
1368
1369     - If an rsync daemon has a module set with "list = no" (which hides its
1370       presence in the list of available modules), a user that fails to
1371       authenticate gets the same "unknown module" error that they would get
1372       if the module were actually unknown (while still logging the real
1373       error to the daemon's log file).  This prevents fishing for module
1374       names.
1375
1376     - The daemon's "refuse options" config item now allows you to match
1377       option names using wildcards and/or the single-letter option names.
1378
1379     - Each transferred file now gets its permissions and modified-time
1380       updated before the temp-file gets moved into place.  Previously, the
1381       finished file would have a very brief window where its permissions
1382       disallowed all group and world access.
1383
1384     - Added the ability to parse a literal IPv6 address in an "rsync:" URL
1385       (e.g. rsync://[2001:638:500:101::21]:873/module/dir).
1386
1387     - The daemon's wildcard expanding code can now handle more than 1000
1388       filenames (it's now limited by memory instead of having a hard-wired
1389       limit).
1390
1391   INTERNAL:
1392
1393     - Some cleanup in the exclude code has saved some per-exclude memory
1394       and made the code easier to maintain.
1395
1396     - Improved the argv-overflow checking for a remote command that has a
1397       lot of args.
1398
1399     - Use rsyserr() in the various places that were still calling rprintf()
1400       with strerror() as an arg.
1401
1402     - If an rsync daemon is listening on multiple sockets (to handle both
1403       IPv4 and IPv6 to a single port), we now close all the unneeded file
1404       handles after we accept a connection (we used to close just one of
1405       them).
1406
1407     - Optimized the handling of larger block sizes (rsync used to slow to a
1408       crawl if the block size got too large).
1409
1410     - Optimized away a loop in hash_search().
1411
1412     - Some improvements to the sanitize_path() and clean_fname() functions
1413       makes them more efficient and produce better results (while still
1414       being compatible with the file-name cleaning that gets done on both
1415       sides when sending the file-list).
1416
1417     - Got rid of alloc_sanitize_path() after adding a destination-buffer
1418       arg to sanitize_path() made it possible to put all the former's
1419       functionality into the latter.
1420
1421     - The file-list that is output when at least 4 verbose options are
1422       specified reports the uid value on the sender even when rsync is
1423       not running as root (since we might be sending to a root receiver).
1424
1425   BUILD CHANGES:
1426
1427     - Added a "gen" target to rebuild most of the generated files,
1428       including configure, config.h.in, the man pages, and proto.h.
1429
1430     - If "make proto" doesn't find some changes in the prototypes, the
1431       proto.h file is left untouched (its time-stamp used to always be
1432       updated).
1433
1434     - The variable $STRIP (that is optionally set by the install-strip
1435       target's rule) was changed to $INSTALL_STRIP because some systems
1436       have $STRIP already set in the environment.
1437
1438     - Fixed a build problem when SUPPORT_HARD_LINKS isn't defined.
1439
1440     - When cross-compiling, the gettimeofday() function is now assumed to
1441       be a modern version that takes two-args (since we can't test it).
1442
1443   DEVELOPER RELATED:
1444
1445     - The scripts in the testsuite dir were cleaned up a bit and a few
1446       new tests added.
1447
1448     - Some new diffs were added to the patches dir, and some accepted
1449       ones were removed.
1450
1451 \f
1452 NEWS for rsync 2.6.2 (30 Apr 2004)
1453 Protocol: 28 (unchanged)
1454 Changes since 2.6.1:
1455
1456   BUG FIXES:
1457
1458     - Fixed a major bug in the sorting of the filenames when --relative
1459       is used for some sources (just sources such as "/" and "/*" were
1460       affected).  This fix ensures that we ask for the right file-list
1461       item when requesting changes from the sender.
1462
1463     - Rsync now checks the return value of the close() function to
1464       better report disk-full problems on an NFS file system.
1465
1466     - Restored the old daemon-server behavior of logging error messages
1467       rather than returning them to the user.  (A better long-term fix
1468       will be sought in the future.)
1469
1470     - An obscure uninitialized-variable bug was fixed in the uid/gid
1471       code.  (This bug probably had no ill effects.)
1472
1473   BUILD CHANGES:
1474
1475     - Got rid of the configure check for sys/sysctl.h (it wasn't used
1476       and was causing a problem on some systems).  Also improved the
1477       broken-largefile-locking test to try to avoid failure due to an
1478       NFS build-dir.
1479
1480     - Fixed a compile problem on systems that don't define
1481       AI_NUMERICHOST.
1482
1483     - Fixed a compile problem in the popt source for compilers that
1484       don't support __attribute__.
1485
1486   DEVELOPER RELATED:
1487
1488     - Improved the testsuite's "merge" test to work on OSF1.
1489
1490     - Two new diffs were added to the patches dir.
1491
1492 \f
1493 NEWS for rsync 2.6.1 (26 Apr 2004)
1494 Protocol: 28 (changed)
1495 Changes since 2.6.0:
1496
1497   SECURITY FIXES:
1498
1499     - Paths sent to an rsync daemon are more thoroughly sanitized when
1500       chroot is not used.  If you're running a non-read-only rsync
1501       daemon with chroot disabled, *please upgrade*, ESPECIALLY if the
1502       user privs you run rsync under is anything above "nobody".
1503
1504   ENHANCEMENTS:
1505
1506     - Lower memory use, more optimal transfer of data over the socket,
1507       and lower CPU usage (see the INTERNAL section for details).
1508
1509     - The RSYNC_PROXY environment variable can now contain a
1510       "USER:PASS@" prefix before the "HOST:PORT" information.
1511       (Bardur Arantsson)
1512
1513     - The --progress output now mentions how far along in the transfer
1514       we are, including both a count of files transferred and a
1515       percentage of the total file-count that we've processed.  It also
1516       shows better current-rate-of-transfer and remaining-transfer-time
1517       values.
1518
1519     - Documentation changes now attempt to describe some often mis-
1520       understood features more clearly.
1521
1522   BUG FIXES:
1523
1524     - When -x (--one-file-system) is combined with -L (--copy-links) or
1525       --copy-unsafe-links, no symlinked files are skipped, even if the
1526       referent file is on a different filesystem.
1527
1528     - The --link-dest code now works properly for a non-root user when
1529       (1) the UIDs of the source and destination differ and -o was
1530       specified, or (2) when the group of the source can't be used on
1531       the destination and -g was specified.
1532
1533     - Fixed a bug in the handling of -H (hard-links) that might cause
1534       the expanded PATH/NAME value of the current item to get
1535       overwritten (due to an expanded-name caching bug).
1536       
1537     - We now reset the "new data has been sent" flag at the start of
1538       each file we send.  This makes sure that an interrupted transfer
1539       with the --partial option set doesn't keep a shorter temp file
1540       than the current basis file when no new data has been transferred
1541       over the wire for that file.
1542
1543     - Fixed a byte-order problem in --batch-mode on big-endian machines.
1544       (Jay Fenlason)
1545
1546     - When using --cvs-exclude, the exclude items we get from a
1547       per-directory's .cvsignore file once again only affect that one
1548       directory (not all following directories too).  The items are also
1549       now properly word-split and parsed without any +/- prefix parsing.
1550
1551     - When specifying the USER@HOST: prefix for a file, the USER part
1552       can now contain an '@', if needed (i.e. the last '@' is used to
1553       find the HOST, not the first).
1554
1555     - Fixed some bugs in the handling of group IDs for non-root users:
1556       (1) It properly handles a group that the sender didn't have a name
1557       for (it would previously skip changing the group on any files in
1558       that group).  (2) If --numeric-ids is used, rsync no longer
1559       attempts to set groups that the user doesn't have the permission
1560       to set.
1561
1562     - Fixed the "refuse options" setting in the rsyncd.conf file.
1563
1564     - Improved the -x (--one-file-system) flag's handling of any mount-
1565       point directories we encounter.  It is both more optimal (in that
1566       it no longer does a useless scan of the contents of the mount-
1567       point dirs) and also fixes a bug where a remapped mount of the
1568       original filesystem could get discovered in a subdir we should be
1569       ignoring.
1570
1571     - Rsync no longer discards a double-slash at the start of a filename
1572       when trying to open the file.  It also no longer constructs names
1573       that start with a double slash (unless the user supplied them).
1574
1575     - Path-specifying options to a daemon should now work the same with
1576       or without chroot turned on.  Previously, such a option (such as
1577       --link-dest) would get its absolute path munged into a relative
1578       one if chroot was not on, making that setting fairly useless.
1579       Rsync now transforms the path into one that is based on the
1580       module's base dir when chroot is not enabled.
1581
1582     - Fixed a compatibility problem interacting with older rsync
1583       versions that might send us an empty --suffix value without
1584       telling us that --backup-dir was specified.
1585
1586     - The "hosts allow" option for a daemon-over-remote-shell process
1587       now has improved support for IPv6 addresses and a fix for systems
1588       that have a length field in their socket structs.
1589
1590     - Fixed the ability to request an empty backup --suffix when sending
1591       files to an rsync daemon.
1592
1593     - Fixed an option-parsing bug when --files-from was sent to a server
1594       sender.
1595
1596   INTERNAL:
1597
1598     - Most of the I/O is now buffered, which results in a pretty large
1599       speedup when running under MS Windows.  (Craig Barratt)
1600
1601     - Optimizations to the name-handling/comparing code have made some
1602       significant reductions in user-CPU time for large file sets.
1603
1604     - Some cleanup of the variable types make the code more consistent.
1605
1606     - Reduced memory requirements of hard link preservation.
1607       (J.W. Schultz)
1608
1609     - Implemented a new algorithm for hard-link handling that speeds up
1610       the code significantly.  (J.W. Schultz and Wayne Davison)
1611
1612     - The --hard-link option now uses the first existing file in the
1613       group of linked files as the basis for the transfer.  This
1614       prevents the sub-optimal transfer of a file's data when a new
1615       hardlink is added on the sending side and it sorts alphabetically
1616       earlier in the list than the files that are already present on the
1617       receiving side.
1618
1619     - Dropped support for protocol versions less than 20 (2.3.0 released
1620       15 Mar 1999) and activated warnings for protocols less than 25
1621       (2.5.0 released 23 Aug 2001). (Wayne Davison and J.W. Schultz,
1622       severally)
1623
1624     - More optimal data transmission for --hard-links (protocol 28).
1625
1626     - More optimal data transmission for --checksum (protocol 28).
1627
1628     - Less memory is used when --checksum is specified.
1629
1630     - Less memory is used in the file list (a per-file savings).
1631
1632     - The generator is now better about not modifying the file list
1633       during the transfer in order to avoid a copy-on-write memory
1634       bifurcation (on systems where fork() uses shared memory).
1635       Previously, rsync's shared memory would slowly become unshared,
1636       resulting in real memory usage nearly doubling on the receiving
1637       side by the end of the transfer.  Now, as long as permissions
1638       are being preserved, the shared memory should remain that way
1639       for the entire transfer.
1640
1641     - Changed hardlink info and file_struct + strings to use allocation
1642       pools.  This reduces memory use for large file-sets and permits
1643       freeing memory to the OS.  (J.W. Schultz) 
1644
1645     - The 2 pipes used between the receiver and generator processes
1646       (which are forked on the same machine) were reduced to 1 pipe and
1647       the protocol improved so that (1) it is now impossible to have the
1648       "redo" pipe fill up and hang rsync, and (2) trailing messages from
1649       the receiver don't get lost on their way through the generator
1650       over to the sender (which mainly affected hard-link messages and
1651       verbose --stats output).
1652
1653     - Improved the internal uid/gid code to be more portable and a
1654       little more optimized.
1655
1656     - The device numbers sent when using --devices are now sent as
1657       separate major/minor values with 32-bit accuracy (protocol 28).
1658       Previously, the copied devices were sent as a single 32-bit
1659       number.  This will make inter-operation of 64-bit binaries more
1660       compatible with their 32-bit brethren (with both ends of the
1661       connection are using protocol 28).  Note that optimizations in the
1662       binary protocol for sending the device numbers often results in
1663       fewer bytes being used than before, even though more precision is
1664       now available.
1665
1666     - Some cleanup of the exclude/include structures and its code made
1667       things clearer (internally), simpler, and more efficient.
1668
1669     - The reading & writing of the file-list in batch-mode is now
1670       handled by the same code that sends & receives the list over the
1671       wire.  This makes it much easier to maintain.  (Note that the
1672       batch code is still considered to be experimental.)
1673
1674   BUILD CHANGES:
1675
1676     - The configure script now accepts --with-rsyncd-conf=PATH to
1677       override the default value of the /etc/rsyncd.conf file.
1678
1679     - Fixed configure bug when running "./configure --disable-ipv6".
1680
1681     - Fixed compilation problem on Tru64 Unix (having to do with
1682       sockaddr.sa_len and sockaddr.sin_len).
1683
1684   DEVELOPER RELATED:
1685
1686     - Fixed "make test" bug when build dir is not the source dir.
1687
1688     - Added a couple extra diffs in the "patches" dir, removed the ones
1689       that got applied, and rebuilt the rest.
1690
1691 \f
1692 NEWS for rsync 2.6.0 (1 Jan 2004)
1693 Protocol: 27 (changed)
1694 Changes since 2.5.7:
1695
1696   ENHANCEMENTS:
1697
1698     * "ssh" is now the default remote shell for rsync.  If you want to
1699       change this, configure like this:  "./configure --with-rsh=rsh".
1700
1701     * Added --files-from, --no-relative, --no-implied-dirs, and --from0.
1702       Note that --from0 affects the line-ending character for all the
1703       files read by the --*-from options. (Wayne Davison)
1704
1705     * Length of csum2 is now per-file starting with protocol version
1706       27. (J.W. Schultz)
1707
1708     * Per-file dynamic block size is now sqrt(file length).  The
1709       per-file checksum size is determined according to an algorithm
1710       provided by Donovan Baarda which reduces the probability of rsync
1711       algorithm corrupting data and falling back using the whole md4
1712       checksums. (J.W. Schultz, Donovan Baarda)
1713
1714     * The --stats option no longer includes the (debug) malloc summary
1715       unless the verbose option was specified at least twice.
1716
1717     * Added a new error/warning code for when files vanish from the
1718       sending side.  Made vanished source files not interfere with the
1719       file-deletion pass when --delete-after was specified.
1720
1721     * Various trailing-info sections are now preceded by a newline.
1722
1723   BUG FIXES:
1724
1725     * Fixed several exclude/include matching bugs when using wild-cards.
1726       This has a several user-visible effects, all of which make the
1727       matching more consistent and intuitive.  This should hopefully not
1728       cause anyone problems since it makes the matching work more like
1729       what people are expecting. (Wayne Davison)
1730
1731       - A pattern with a "**" no longer causes a "*" to match slashes.
1732         For example, with "/*/foo/**", "foo" must be 2 levels deep.
1733         [If your string has BOTH "*" and "**" wildcards, changing the
1734         "*" wildcards to "**" will provide the old behavior in all
1735         versions.]
1736
1737       - "**/foo" now matches at the base of the transfer (like /foo
1738         does).  [Use "/**/foo" to get the old behavior in all versions.]
1739
1740       - A non-anchored wildcard term floats to match beyond the base of
1741         the transfer.  E.g. "CVS/R*" matches at the end of the path,
1742         just like the non-wildcard term "CVS/Root" does. [Use "/CVS/R*"
1743         to get the old behavior in all versions.]
1744
1745       - Including a "**" in the match term causes it to be matched
1746         against the entire path, not just the name portion, even if
1747         there aren't any interior slashes in the term.  E.g. "foo**bar"
1748         would exclude "/path/foo-bar" (just like before) as well as
1749         "/foo-path/baz-bar" (unlike before).  [Use "foo*bar" to get the
1750         old behavior in all versions.]
1751
1752     * The exclude list specified in the daemon's config file is now
1753       properly applied to the pulled items no matter how deep the
1754       user's file-args are in the source tree.  (Wayne Davison)
1755
1756     * For protocol version >= 27, mdfour_tail() is called when the
1757       block size (including checksum_seed) is a multiple of 64.
1758       Previously it was not called, giving the wrong MD4 checksum.
1759       (Craig Barratt)
1760
1761     * For protocol version >= 27, a 64 bit bit counter is used in
1762       mdfour.c as required by the RFC.  Previously only a 32 bit bit
1763       counter was used, causing incorrect MD4 file checksums for
1764       file sizes >= 512MB - 4.  (Craig Barratt)
1765
1766     * Fixed a crash bug when interacting with older rsync versions and
1767       multiple files of the same name are destined for the same dir.
1768       (Wayne Davison)
1769
1770     * Keep tmp names from overflowing MAXPATHLEN.
1771
1772     * Make --link-dest honor the absence of -p, -o, and -g.
1773
1774     * Made rsync treat a trailing slash in the destination in a more
1775       consistent manner.
1776
1777     * Fixed file I/O error detection.  (John Van Essen)
1778
1779     * Fixed bogus "malformed address {hostname}" message in rsyncd log
1780       when checking IP address against hostnames from "hosts allow"
1781       and "hosts deny" parameters in config file.
1782
1783     * Print heap statistics when verbose >= 2 instead of when >= 1.
1784
1785     * Fixed a compression (-z) bug when syncing a mostly-matching file
1786       that contains already-compressed data.  (Yasuoka Masahiko and
1787       Wayne Davison)
1788
1789     * Fixed a bug in the --backup code that could cause deleted files
1790       to not get backed up.
1791
1792     * When the backup code makes new directories, create them with mode
1793       0700 instead of 0755 (since the directory permissions in the
1794       backup tree are not yet copied from the main tree).
1795
1796     * Call setgroups() in a more portable manner.
1797
1798     * Improved file-related error messages to better indicate exactly
1799       what pathname failed. (Wayne Davison)
1800
1801     * Fixed some bugs in the handling of --delete and --exclude when
1802       using the --relative (-R) option. (Wayne Davison)
1803
1804     * Fixed bug that prevented regular files from replacing
1805       special files and caused a directory in --link-dest or
1806       --compare-dest to block the creation of a file with the
1807       same path.  A directory still cannot be replaced by a
1808       regular file unless --delete specified.  (J.W. Schultz)
1809
1810     * Detect and report when open or opendir succeed but read and
1811       readdir fail caused by network filesystem issues and truncated
1812       files.  (David Norwood, Michael Brown, J.W. Schultz)
1813
1814     * Added a fix that should give ssh time to restore the tty settings
1815       if the user presses Ctrl-C at an ssh password prompt.
1816
1817   INTERNAL:
1818
1819     * Eliminated vestigial support for old versions that we stopped
1820       supporting. (J.W. Schultz)
1821
1822     * Simplified some of the option-parsing code. (Wayne Davison)
1823
1824     * Some cleanup made to the exclude code, as well as some new
1825       defines added to enhance readability. (Wayne Davison)
1826
1827     * Changed the protocol-version code so that it can interact at a
1828       lower protocol level than the maximum supported by both sides.
1829       Added an undocumented option, --protocol=N, to force the value
1830       we advertise to the other side (primarily for testing purposes).
1831       (Wayne Davison)
1832
1833 \f
1834 NEWS for rsync 2.5.7 (4 Dec 2003)
1835 Protocol: 26 (unchanged)
1836 Changes since 2.5.6:
1837
1838   SECURITY FIXES:
1839
1840     * Fix buffer handling bugs.  (Andrew Tridgell, Martin Pool, Paul
1841       Russell, Andrea Barisani)
1842
1843 \f
1844 NEWS for rsync 2.5.6, aka "the dwd-between-jobs release" (26 Jan 2003)
1845 Protocol: 26 (unchanged)
1846 Changes since 2.5.5:
1847
1848   ENHANCEMENTS:
1849
1850     * The --delete-after option now implies --delete.  (Wayne Davison)
1851
1852     * The --suffix option can now be used with --backup-dir.  (Michael
1853       Zimmerman)
1854
1855     * Combining "::" syntax with the --rsh/-e option now uses the
1856       specified remote-shell as a transport to talk to a (newly-spawned)
1857       server-daemon.  This allows someone to use daemon features, such
1858       as modules, over a secure protocol, such as ssh.  (JD Paul)
1859
1860     * The rsync:// syntax for daemon connections is now accepted in the
1861       destination field.
1862
1863     * If the file name given to --include-from or --exclude-from is "-",
1864       rsync will read from standard input.  (J.W. Schultz)
1865
1866     * New option --link-dest which is like --compare-dest except that
1867       unchanged files are hard-linked in to the destination directory.
1868       (J.W. Schultz)
1869
1870     * Don't report an error if an excluded file disappears during an
1871       rsync run.  (Eugene Chupriyanov and Bo Kersey)
1872
1873     * Added .svn to --cvs-exclude list to support subversion.  (Jon
1874       Middleton)
1875
1876     * Properly support IPv6 addresses in the rsyncd.conf "hosts allow"
1877       and "hosts deny" fields.  (Hideaki Yoshifuji)
1878
1879     * Changed exclude file handling to permit DOS or MAC style line
1880       terminations.  (J.W. Schultz)
1881
1882     * Ignore errors from chmod when -p/-a/--preserve-perms is not set.
1883       (Dave Dykstra)
1884
1885   BUG FIXES:
1886
1887     * Fix "forward name lookup failed" errors on AIX 4.3.3.  (John
1888       L. Allen, Martin Pool)
1889
1890     * Generate each file's rolling-checksum data as we send it, not
1891       in a separate (memory-eating) pass before hand.  This prevents
1892       timeout errors on really large files. (Stefan Nehlsen)
1893
1894     * Fix compilation on Tru64.  (Albert Chin, Zoong Pham)
1895
1896     * Better handling of some client-server errors.  (Martin Pool)
1897
1898     * Fixed a crash that would occur when sending a list of files that
1899       contains a duplicate name (if it sorts to the end of the file
1900       list) and using --delete.  (Wayne Davison)
1901
1902     * Fixed the file-name duplicate-removal code when dealing with multiple
1903       dups in a row. (Wayne Davison)
1904
1905     * Fixed a bug that caused rsync to lose the exit status of its child
1906       processes and sometimes return an exit code of 0 instead of showing
1907       an error.  (David R. Staples, Dave Dykstra)
1908
1909     * Fixed bug in --copy-unsafe-links that caused it to be completely
1910       broken.  (Dave Dykstra)
1911
1912     * Prevent infinite recursion in cleanup code under certain circumstances.
1913       (Sviatoslav Sviridov and Marc Espie)
1914
1915     * Fixed a bug that prevented rsync from creating intervening directories
1916       when --relative-paths/-R is set.  (Craig Barratt)
1917
1918     * Prevent "Connection reset by peer" messages from Cygwin. (Randy O'Meara)
1919
1920   INTERNAL:
1921
1922     * Many code cleanups and improved internal documentation.  (Martin
1923       Pool, Nelson Beebe)
1924
1925     * Portability fixes. (Dave Dykstra and Wayne Davison)
1926
1927     * More test cases.  (Martin Pool)
1928
1929     * Some test-case fixes.  (Brian Poole, Wayne Davison)
1930
1931     * Updated included popt to the latest vendor drop, version 1.6.4.
1932       (Jos Backus)
1933
1934     * Updated config.guess and config.sub to latest versions; this
1935       means rsync should build on more platforms.  (Paul Green)
1936
1937 \f
1938 NEWS for rsync 2.5.5, aka Snowy River (2 Apr 2002)
1939 Protocol: 26 (unchanged)
1940 Changes since 2.5.4:
1941
1942   ENHANCEMENTS:
1943
1944     * With --progress, when a transfer is complete show the time taken;
1945       otherwise show expected time to complete. (Cameron Simpson)
1946
1947     * Make "make install-strip" works properly, and "make install"
1948       accepts a DESTDIR variable for help in building binary packages.
1949       (Peter Breitenlohner, Greg Louis)
1950
1951     * If configured with --enable-maintainer-mode, then on receipt of
1952       a fatal signal rsync will try to open an xterm running gdb,
1953       similarly to Samba's "panic action" or GNOME's bug-buddy.
1954       (Martin Pool)
1955
1956
1957   BUG FIXES:
1958
1959     * Fix situation where failure to fork (e.g. because out of process
1960       slots) would cause rsync to kill all processes owned by the
1961       current user.  Yes, really!  (Paul Haas, Martin Pool)
1962
1963     * Fix test suite on Solaris.  (Jos Backus, Martin Pool)
1964
1965     * Fix minor memory leak in socket code.  (Dave Dykstra, Martin
1966       Pool.)
1967
1968     * Fix --whole-file problem that caused it to be the default even
1969       for remote connections.  (Martin Pool, Frank Schulz)
1970
1971     * Work around bug in Mac OS X mkdir(2), which cannot handle
1972       trailing slashes.
1973       <http://www.opensource.apple.com/bugs/X/BSD%20Kernel/2734739.html>
1974       (Martin Pool)
1975
1976     * Improved network error handling.  (Greg A. Woods)
1977
1978 \f
1979 NEWS for rsync 2.5.4, aka "Imitation lizard skin" (13 Mar 2002)
1980 Protocol: 26 (unchanged)
1981 Changes since 2.5.3:
1982
1983   BUG FIXES:
1984
1985     * Additional fix for zlib double-free bug.  (Martin Pool, Andrew
1986       Tridgell) (CVE CAN-2002-0059)
1987
1988   ENHANCEMENTS:
1989
1990     * Merge in changes from zlib 1.1.3 to zlib 1.1.4.  (Jos Backus)
1991       (Note that rsync still uses a custom version of zlib; you can
1992       not just link against a system library.  See zlib/README.rsync)
1993
1994     * Additional test cases for --compress.  (Martin Pool)
1995
1996 \f
1997 NEWS for rsync 2.5.3, aka "Happy 26" (11 Mar 2002)
1998 Protocol: 26 (unchanged)
1999 Changes since 2.5.2:
2000
2001   SECURITY FIXES:
2002
2003     * Make sure that supplementary groups are removed from a server
2004       process after changing uid and gid. (Ethan Benson) (Debian bug
2005       #132272, CVE CAN-2002-0080)
2006
2007   BUG FIXES:
2008
2009     * Fix zlib double-free bug.  (Owen Taylor, Mark J Cox) (CVE
2010       CAN-2002-0059)
2011
2012     * Fixed problem that in many cases caused the error message
2013         unexpected read size of 0 in map_ptr
2014       and resulted in the wrong data being copied.
2015
2016     * Fixed compilation errors on some systems caused by the use of
2017       "unsigned int64" in rsync.h.
2018
2019     * Fixed problem on systems such as Sunos4 that do not support realloc
2020       on a NULL pointer; error was "out of memory in flist_expand".
2021
2022     * Fix for rsync server processes hanging around after the client
2023       unexpectedly disconnects.  (Colin Walters) (Debian bug #128632)
2024
2025     * Cope with BSD systems on which mkdir() will not accept a trailing
2026       slash.
2027
2028   ENHANCEMENTS:
2029
2030     * Merge in changes from zlib 1.1.2 to zlib 1.1.3.  (Note that
2031       rsync still uses a custom version of zlib; you can not just link
2032       against a system library.  See zlib/README.rsync)
2033
2034     * Command to initiate connections is only shown with -vv, rather
2035       than -v as in 2.5.2.  Output from plain -v is more similar to
2036       what was historically used so as not to break scripts that try
2037       to parse the output.
2038
2039     * Added --no-whole-file and --no-blocking-io options (Dave Dykstra)
2040
2041     * Made the --write-batch and --read-batch options actually work
2042       and added documentation in the man page (Jos Backus)
2043
2044     * If the daemon is unable to fork a child to accept a connection,
2045       print an error message.  (Colin Walters)
2046
2047 \f
2048 NEWS for rsync 2.5.2 (26 Jan 2002)
2049 Protocol: 26 (changed)
2050 Changes since 2.5.1:
2051
2052   SECURITY FIXES:
2053
2054     * Signedness security patch from Sebastian Krahmer
2055       <krahmer@suse.de> -- in some cases we were not sufficiently
2056       careful about reading integers from the network.
2057
2058   BUG FIXES:
2059
2060     * Fix possible string mangling in log files.
2061
2062     * Fix for setting local address of outgoing sockets.
2063
2064     * Better handling of hardlinks and devices on platforms with
2065       64-bit dev_t or ino_t.
2066
2067     * Name resolution on machines supporting IPv6 is improved.
2068
2069     * Fix for device nodes.  (dann frazier)   (Debian #129135)
2070
2071   ENHANCEMENTS:
2072
2073     * With -v, rsync now shows the command used to initiate an ssh/rsh
2074       connection.
2075
2076     * --statistics now shows memory heap usage on platforms that
2077       support mallinfo().
2078
2079     * "The Ted T'so school of program optimization": make progress
2080       visible and people will think it's faster.  (With --progress,
2081       rsync will show you how many files it has seen as it builds the
2082       file_list, giving some indication that it has not hung.)
2083
2084     * Improvements to batch mode support.  This is still experimental
2085       but testing would be welcome.   (Jos Backus)
2086
2087     * New --ignore-existing option, patch previously distributed with
2088       Vipul's Razor.  (Debian #124286)
2089
2090 \f
2091 NEWS for rsync 2.5.1 (3 Jan 2002)
2092 Protocol: 25 (unchanged)
2093 Changes since 2.5.0:
2094
2095   BUG FIXES:
2096
2097     * Fix for segfault in --daemon mode configuration parser.  (Paul
2098       Mackerras)
2099
2100     * Correct string<->address parsing for both IPv4 and 6.
2101       (YOSHIFUJI Hideaki, SUMIKAWA Munechika and Jun-ichiro "itojun"
2102       Hagino)
2103
2104     * Various fixes for IPv6 support.  (Dave Dykstra)
2105
2106     * rsync.1 typo fix.  (Matt Kraai)
2107
2108     * Test suite typo fixes.  (Tom Schmidt)
2109
2110     * rsync.1 grammar and clarity improvements.  (Edward
2111       Welbourne)
2112
2113     * Correction to ./configure tests for inet_ntop.  (Jeff Garzik)
2114
2115   ENHANCEMENTS:
2116
2117     * --progress and -P now show estimated data transfer rate (in a
2118       multiple of bytes/s) and estimated time to completion.  (Rik
2119       Faith)
2120
2121     * --no-detach option, required to run as a W32 service and also
2122       useful when running on Unix under daemontools, AIX's SRC, or a
2123       debugger.  (Max Bowsher, Jos Backus)
2124
2125     * Clearer error messages for some conditions.
2126
2127 \f
2128 NEWS for rsync 2.5.0 (30 Nov 2001)
2129 Protocol: 25 (changed)
2130 Changes since 2.4.6:
2131
2132   ANNOUNCEMENTS
2133
2134     * Martin Pool <mbp@samba.org> is now a co-maintainer.
2135
2136   NEW FEATURES
2137
2138     * Support for LSB-compliant packaging <http://www.linuxbase.org/>
2139
2140     * Shell wildcards are allowed in "auth users" lines.
2141
2142     * Merged UNC rsync+ patch to support creation of standalone patch
2143       sets.  By Bert J. Dempsey and Debra Weiss, updated by Jos
2144       Backus.  <http://www.ils.unc.edu/i2dsi/unc_rsync+.html>
2145
2146     * IPv6 support based on a patch from KAME.net, on systems
2147       including modern versions of Linux, Solaris, and HP-UX.  Also
2148       includes IPv6 compatibility functions for old OSs by the
2149       Internet Software Consortium, Paul Vixie, the OpenSSH
2150       portability project, and OpenBSD.
2151
2152   ENHANCEMENTS
2153
2154     * Include/exclude cluestick: with -vv, print out whether files are
2155       included or excluded and why.
2156
2157     * Many error messages have more friendly explanations and more
2158       details.
2159
2160     * Manual page improvements plus scanty protocol documentation.
2161
2162     * When running as --daemon in the background and using a "log
2163       file" rsyncd.conf directive, close the log file every time it is
2164       open when going to sleep on the socket.  This allows the log
2165       file to get cleaned out by another process.
2166
2167     * Change to using libpopt rather than getopt for processing
2168       options.  This makes the code cleaner and the behaviour more
2169       consistent across platforms.  popt is included and built if not
2170       installed on the platform.
2171
2172     * More details in --version, including note about whether 64-bit
2173       files, symlinks and hardlinks are supported.
2174
2175     * MD4 code may use less CPU cycles.
2176
2177     * Use mkstemp on systems where it is secure.  If we use mktemp,
2178       explain that we do it in a secure way.
2179
2180     * --whole-file is the default when source and target are on the
2181         local machine.
2182
2183   BUG FIXES:
2184
2185     * Fix for various bugs causing rsync to hang.
2186
2187     * Attempt to fix Large File Summit support on AIX.
2188
2189     * Attempt to fix error handling lockup bug.
2190
2191     * Give a non-0 exit code if *any* of the files we have been asked
2192       to transfer fail to transfer.
2193
2194     * For log messages containing ridiculously long strings that might
2195       overflow a buffer rsync no longer aborts, but rather prints an
2196       ellipsis at the end of the string.  (Patch from Ed Santiago.)
2197
2198   PLATFORMS:
2199
2200     * Improved support for UNICOS (tested on Cray T3E and Cray SV1)
2201
2202     * autoconf2.52 (or later) is now required to rebuild the autoconf
2203       scripts.  It is not required to simply build rsync.
2204
2205     * Platforms thought to work in this release:
2206
2207                 Cray SV1 UNICOS 10.0.0.8 cc
2208                 Debian Linux 2.2 UltraSparc gcc
2209                 Debian Linux testing/unstable ARM gcc
2210                 FreeBSD 3.3-RELEASE i386 cc
2211                 FreeBSD 4.1.1-RELEASE i386 cc
2212                 FreeBSD 4.3-STABLE i386 cc
2213                 HP PA-RISC HP-UX 10.20 gcc
2214                 HP PA-RISC HP-UX 11.11 cc
2215                 IRIX 6.5 MIPS cc
2216                 IRIX 6.5 MIPS gcc
2217                 Mac OS X PPC (--disable-ipv6) cc
2218                 NetBSD 1.5 i386 gcc
2219                 NetBSD Current i386 cc
2220                 OpenBSD 2.5 Sparc gcc
2221                 OpenBSD 2.9 i386 cc
2222                 OpenBSD Current i386 cc
2223                 RedHat 6.2 i386 gcc
2224                 RedHat 6.2 i386 insure++
2225                 RedHat 7.0 i386 gcc
2226                 RedHat 7.1 i386 (Kernel 2.4.10) gcc
2227                 Slackware 8.0 i686 (Kernel 2.4.10)
2228                 Solaris 8 UltraSparc cc
2229                 Solaris 8 UltraSparc gcc
2230                 Solaris 8 i386 gcc
2231                 SuSE 7.1 i386 gcc2.95.2
2232                 SuSE 7.1 ppc gcc2.95.2
2233                 i386-pc-sco3.2v5.0.5 cc
2234                 i386-pc-sco3.2v5.0.5 gcc
2235                 powerpc-ibm-aix4.3.3.0 cc
2236                 i686-unknown-sysv5UnixWare7.1.0 gcc
2237                 i686-unknown-sysv5UnixWare7.1.0 cc
2238
2239   TESTING:
2240
2241     * The existing test.sh script by Phil Hands has been merged into a
2242       test framework that works from both "make check" and the Samba
2243       build farm.
2244 \f
2245 Partial Protocol History
2246         RELEASE DATE    VER.    DATE OF COMMIT* PROTOCOL
2247         ?? ??? 2007     3.0.0   11 Nov 2006     30
2248         06 Nov 2006     2.6.9                   29
2249         22 Apr 2006     2.6.8                   29
2250         11 Mar 2006     2.6.7                   29
2251         28 Jul 2005     2.6.6                   29
2252         01 Jun 2005     2.6.5                   29
2253         30 Mar 2005     2.6.4   17 Jan 2005     29
2254         30 Sep 2004     2.6.3                   28
2255         30 Apr 2004     2.6.2                   28
2256         26 Apr 2004     2.6.1   08 Jan 2004     28
2257         01 Jan 2004     2.6.0   10 Apr 2003     27 (MAX=40)
2258         04 Dec 2003     2.5.7                   26
2259         26 Jan 2003     2.5.6                   26
2260         02 Apr 2002     2.5.5                   26
2261         13 Mar 2002     2.5.4                   26
2262         11 Mar 2002     2.5.3                   26
2263         26 Jan 2002     2.5.2   11 Jan 2002     26
2264         03 Jan 2002     2.5.1                   25
2265         30 Nov 2001     2.5.0   23 Aug 2001     25
2266         06 Sep 2000     2.4.6                   24
2267         19 Aug 2000     2.4.5                   24
2268         29 Jul 2000     2.4.4                   24
2269         09 Apr 2000     2.4.3                   24
2270         30 Mar 2000     2.4.2                   24
2271         30 Jan 2000     2.4.1   29 Jan 2000     24
2272         29 Jan 2000     2.4.0   28 Jan 2000     23
2273         25 Jan 2000     2.3.3   23 Jan 2000     22
2274         08 Nov 1999     2.3.2   26 Jun 1999     21
2275         06 Apr 1999     2.3.1                   20
2276         15 Mar 1999     2.3.0   15 Mar 1999     20
2277         25 Nov 1998     2.2.1                   19
2278         03 Nov 1998     2.2.0                   19
2279         09 Sep 1998     2.1.1                   19
2280         20 Jul 1998     2.1.0                   19
2281         17 Jul 1998     2.0.19                  19
2282         18 Jun 1998     2.0.17                  19
2283         01 Jun 1998     2.0.16                  19
2284         27 May 1998     2.0.13  27 May 1998     19
2285         26 May 1998     2.0.12                  18
2286         22 May 1998     2.0.11                  18
2287         18 May 1998     2.0.9   18 May 1998     18
2288         17 May 1998     2.0.8                   17
2289         15 May 1998     2.0.1                   17
2290         14 May 1998     2.0.0                   17
2291         17 Apr 1998     1.7.4                   17
2292         13 Apr 1998     1.7.3                   17
2293         05 Apr 1998     1.7.2                   17
2294         26 Mar 1998     1.7.1                   17
2295         26 Mar 1998     1.7.0   26 Mar 1998     17 (MAX=30)
2296         13 Jan 1998     1.6.9   13 Jan 1998     15 (MAX=20)
2297
2298 * DATE OF COMMIT is the date the protocol change was committed to CVS.