Mention the new output-escaping idiom and the multibyte support.
[rsync/rsync.git] / NEWS
1 NEWS for rsync 2.6.7 (UNRELEASED)
2 Protocol: 29 (unchanged)
3 Changes since 2.6.6:
4
5   OUTPUT CHANGES:
6
7     - The itemized output now uses 'S' for a special file instead of
8       clumping them together with the 'D' for devices.  The number of
9       characters is also different (to remove an unused field).
10
11     - The way rsync escapes unreadable characters has changed.  First, rsync
12       now has support for recognizing valid multibyte character sequences in
13       your current locale, allowing it to escape fewer characters than before
14       for a locale such as UTF-8.  Second, it now uses an escape idiom of
15       "\#123", which is the literal string "\#" followed by exactly 3 octal
16       digits.  Rsync no longer doubles a backslash character in a filename
17       (e.g. it used to output "foo\\bar" when copying "foo\bar") -- now it only
18       escapes a backslash that is followed by a hash-sign and 3 digits (0-9)
19       (e.g. it will output "foo\#134#789" when copying "foo\#789").
20
21       Script writers: the local rsync is the one that outputs escaped names,
22       so if you need to support unescaping of filenames for older rsyncs, I'd
23       suggest that you parse the output of "rsync --version" and only use the
24       old unescaping rules for 2.6.5 and 2.6.6.
25
26   BUG FIXES:
27
28     - Fixed a really old bug that caused --checksum (-c) to checksum all the
29       files encountered during the delete scan (ouch).
30
31     - Fixed a potential hang in a remote generator:  when the receiver gets a
32       read-error on the socket, it now signals the generator about this so that
33       the generator does not try to send any of the terminating error messages
34       to the client (avoiding a potential hang in some setups).
35
36     - Made hard-links work with symlinks and devices again.
37
38     - If the sender gets an early EOF reading a source file, we propagate this
39       error to the receiver so that it can discard the file and try requesting
40       it again (which is the existing behavior for other kinds of read errors).
41
42     - If a device-file/special-file changes permissions, rsync now updates the
43       permissions without recreating the file.
44
45     - If the user specifies a remote-host for both the source and destination,
46       we now output a syntax error rather than trying to open the destination
47       hostspec as a filename.
48
49     - When --inplace creates a new destination file, rsync now creates it with
50       permissions 0600 instead of 0000 -- this makes restarting possible when
51       the transfer gets interrupted in the middle of sending a new file.
52
53     - Reject the combination of --inplace and --sparse since the sparse-output
54       algorithm doesn't work when overwriting existing data.
55
56     - Fixed the directory name in the error that is output when pop_dir()
57       fails.
58
59     - Really fixed the parsing of a "!" entry in .cvsignore files this time.
60
61     - If the generator gets a stat() error on a file, output it (this used to
62       require at least -vv for the error to be seen).
63
64     - If waitpid() fails or the child rsync didn't exit cleanly, we now handle
65       the exit status properly and generate a better error.
66
67     - Fixed some glitches in the double-verbose output when using --copy-dest,
68       --link-dest, or --compare-dest.
69
70     - Fixed the matching of the dont-compress items (e.g. *.gz) against files
71       that have a path component containing a slash.
72
73     - If code reading a filter/exclude file an EINTR error, rsync now clears
74       the error flag on the file handle so it can keep on reading.
75
76     - If --relative is active, the sending side cleans up trailing "/" or "/."
77       suffixes to avoid triggering a bug in older rsync versions.  Also, we now
78       reject a ".." dir if it would be sent as a relative dir.
79
80     - If a non-directory is in the way of a directory and rsync is run with
81       --dry-run and --delete, rsync no longer complains about not being able
82       to opendir() the not-yet present directory.
83
84     - Got rid of the need for --force to be used in some circumstances with
85       --delete-after (making it consistent with --delete-before/-during).
86
87   ENHANCEMENTS:
88
89     - Added the --specials option to tell rsync to copy special files (and does
90       not require root).  The --devices option now affects just character and
91       block devices (which now matches the documentation).  The -D option still
92       requests both --devices and --specials, and -a still implies -D.
93
94     - Added the --append option that makes rsync append data onto files that
95       are longer on the source than the destination (this includes new files).
96
97     - Added the --min-size=SIZE option to exclude small files from the
98       transfer.
99
100     - Added the --compress-level option to allow you to set how aggressive
101       rsync's compression should be (this option implies --compress).
102
103     - Enhanced the parsing of the SIZE value for --min-size and --max-size to
104       allow easy entry of multiples of 1000 (instead of just multiples of 1024)
105       and off-by-one values too (e.g. --max-size=8mb-1).
106
107     - The options --human-readable (-h) and --si change the output of the
108       --stats and the end-of-run summary to be easier to read.
109
110     - If lutimes() and/or lchmod() are around, use them to allow the
111       preservation of attributes on symlinks.
112
113     - The --link-dest option now affects symlinks and devices (when possible).
114
115     - Improved the output of hard-linked and copied files when using
116       --link-dest, --copy-dest, or --compare-dest.
117
118     - Added two config items to the rsyncd.conf parsing:  "pre-xfer exec" and
119       "post-xfer exec".  These allow a command to be specified on a per-module
120       basis that will be run before and/or after a daemon-mode transfer.  (See
121       the manpage for a list of the environment variables that are set with
122       information about the transfer.)
123
124     - When using the --relative option, you can now insert a dot dir in
125       the source path to indicate where the replication of the source dirs
126       should start.  For example, if you specify a source path of
127       rsync://host/module/foo/bar/./baz/dir with -R, rsync will now only
128       replicate the "baz/dir" part of the source path (note: a trailing
129       dot dir is unaffected unless it also has a trailing slash).
130
131     - Added some new --no-FOO options that make it easier to override unwanted
132       implied or default options.  For example, "-a --no-o" (aka "--archive
133       --no-owner") can be used to turn off the preservation of file ownership
134       that is implied by -a.
135
136     - Added the --chmod=MODE option that allows the destination permissions to
137       be changed from the source permissions.  E.g. --chmod=g+w,o-rwx
138
139     - Added the "incoming chmod" and "outgoing chmod" daemon options that allow
140       a module to specify what permissions changes should be applied to all
141       files copied to and from the daemon.
142
143     - Allow the --temp-dir option to be specified when starting a daemon, which
144       sets the default temporary directory for incoming files.
145
146     - If --delete is combined with --dirs without --recursive, rsync will now
147       delete in any directory whose content is being synchronized.
148
149     - If --backup is combined with --delete without --backup-dir (and without
150       --delete-excluded), we add a "protect" filter-rule to ensure that files
151       with the backup suffix are not deleted.
152
153     - The file-count stats that are output by --progress were improved to
154       better indicate what the numbers mean.  For instance, the output:
155       "(xfer#5, to-check=8383/9999)" indicates that this was the fifth file
156       to be transferred, and we still need to check 8383 more files out of
157       a total of 9999.
158
159     - The include/exclude code now allows a dir/*** directive (with 3 trailing
160       stars) to match both the dir itself as well as all the content below the
161       dir (dir/** would not match the dir).
162
163     - Added the --prune-empty-dirs (-m) option that makes the receiving rsync
164       discard empty chains of directories from the file-list.  This makes it
165       easier to selectively copy files from a source hierarchy and end up with
166       just the directories needed to hold the resulting files.
167
168     - If the --itemize-changes (-i) option is repeated, rsync now includes
169       unchanged files in the itemized output (similar to -vv, but without all
170       the other verbose messages that can get in the way).  Of course, the
171       client must be version 2.6.7 for this to work, but the remote rsync only
172       needs to be 2.6.7 if you're pushing files.
173
174     - Added the --super option to make the receiver always attempt super- user
175       activities.  This is useful for systems that allow things such as devices
176       to be created or ownership to be set without being UID 0, and is also
177       useful for someone who wants to ensure that errors will be output if the
178       receiving rsync isn't being run as root.
179
180     - Added the --sockopts option for those few who want to customize the TCP
181       options used to contact a daemon rsync.
182
183     - Added a way for the --temp-dir option to be combined with a partial-dir
184       setting that lets rsync avoid non-atomic updates (for those times when
185       --temp-dir is not being used because space is tight).
186
187     - A new support script, files-to-excludes, will transform a list of files
188       into a set of include/exclude directives that will copy those files.
189
190     - A new option, --executability (-E) can be used to preserve just the
191       execute bit on files, for those times when using the --perms option is
192       not desired.
193
194     - The daemon now logs each module-list request it receives.
195
196     - New log-format options: %M (modtime), %U (uid), %G (gid), and %B
197       (permission bits, e.g. "rwxr-xrwt").
198
199     - Some minor documentation improvements.
200
201     - Updated some diffs in the patches dir.
202
203   INTERNAL:
204
205     - We now use sigaction() and sigprocmask() if possible, and fall back on
206       signal() if not.  Using sigprocmask() ensures that rsync enables all the
207       signals that it needs, just in case it was started in a masked state.
208
209     - Some buffer sizes were expanded a bit, particularly on systems where
210       MAXPATHLEN is overly small (e.g. cygwin).
211
212     - If io_printf() tries to format more data than fits in the buffer, exit
213       with an error instead of transmitting a truncated buffer.
214
215     - If a va_copy macro is defined, lib/snprintf.c will use it when defining
216       the VA_COPY macro.
217
218     - Reduced the amount of stack memory needed for each level of directory
219       recursion by nearly MAXPATHLEN bytes.
220
221     - The wildmatch function was extended to allow an array of strings to be
222       supplied as the string to match.  This allows the exclude code to do less
223       string copying.
224
225     - Got rid of the safe_fname() function (and all the myriad calls) and
226       replaced it with a new function in the log.c code that filters all the
227       output going to the terminal.
228
229     - Unified the f_name() and the f_name_to() functions.
230
231   DEVELOPER RELATED:
232
233     - The diffs in the patches dir now require "patch -p1 <DIFF" instead of
234       the previous -p0.  Also, the version included in the release tar now
235       affect generated files (e.g. configure, rsync.1, proto.h, etc.), so
236       it is no longer necessary to run autoconf and/or yodl unless you're
237       applying a patch that was checked out from CVS.
238
239     - Several diffs in the patches dir now use the proper --enable-FOO
240       configure option instead of --with-FOO to turn on the inclusion of
241       the newly patched feature.
242
243     - There is a new script, "prepare-source" than can be used to update the
244       various generated files (proto.h, configure, etc.) even before configure
245       has created the Makefile (this is mainly useful when patching the source
246       with a patch that doesn't affect generated files).
247
248     - The testsuite now sets HOME so that it won't be affected by a file such
249       as ~/.popt.