Tweaked a comment.
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 32b4931..99ebc70 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -4,9 +4,27 @@ Changes since 2.6.6:
 
   OUTPUT CHANGES:
 
-    - The itemized output now uses 'S' for a special file instead of
-      clumping them together with the 'D' for devices.  The number of
-      characters is also different (to remove an unused field).
+    - The letter 'D' in the itemized output was being used for both devices
+      (character or block) as well as other special files (such as fifos and
+      named sockets).  This has changed to separate non-device special files
+      under the 'S' designation (e.g. "cS+++++++ path/fifo").  See also the
+      "--specials" option, below.
+
+    - The way rsync escapes unreadable characters has changed.  First, rsync
+      now has support for recognizing valid multibyte character sequences in
+      your current locale, allowing it to escape fewer characters than before
+      for a locale such as UTF-8.  Second, it now uses an escape idiom of
+      "\#123", which is the literal string "\#" followed by exactly 3 octal
+      digits.  Rsync no longer doubles a backslash character in a filename
+      (e.g. it used to output "foo\\bar" when copying "foo\bar") -- now it only
+      escapes a backslash that is followed by a hash-sign and 3 digits (0-9)
+      (e.g. it will output "foo\#134#789" when copying "foo\#789").  See also
+      the --8-bit-output (-8) option, mentioned below.
+
+      Script writers: the local rsync is the one that outputs escaped names,
+      so if you need to support unescaping of filenames for older rsyncs, I'd
+      suggest that you parse the output of "rsync --version" and only use the
+      old unescaping rules for 2.6.5 and 2.6.6.
 
   BUG FIXES:
 
@@ -50,7 +68,9 @@ Changes since 2.6.6:
       the exit status properly and generate a better error.
 
     - Fixed some glitches in the double-verbose output when using --copy-dest,
-      --link-dest, or --compare-dest.
+      --link-dest, or --compare-dest.  Also improved how the verbose output
+      handles hard-links (within the transfer) that had an up-to-date alternate
+      "dest" file, and copied files (via --copy-dest).
 
     - Fixed the matching of the dont-compress items (e.g. *.gz) against files
       that have a path component containing a slash.
@@ -69,12 +89,10 @@ Changes since 2.6.6:
     - Got rid of the need for --force to be used in some circumstances with
       --delete-after (making it consistent with --delete-before/-during).
 
-  ENHANCEMENTS:
+    - Rsync now ignores the SIGXFSZ signal, just in case your OS sends this
+      when a file is too large (rsync handles the write error).
 
-    - Added the --specials option to tell rsync to copy special files (and does
-      not require root).  The --devices option now affects just character and
-      block devices (which now matches the documentation).  The -D option still
-      requests both --devices and --specials, and -a still implies -D.
+  ENHANCEMENTS:
 
     - Added the --append option that makes rsync append data onto files that
       are longer on the source than the destination (this includes new files).
@@ -89,21 +107,24 @@ Changes since 2.6.6:
       allow easy entry of multiples of 1000 (instead of just multiples of 1024)
       and off-by-one values too (e.g. --max-size=8mb-1).
 
-    - The options --human-readable (-h) and --si change the output of the
-      --stats and the end-of-run summary to be easier to read.
+    - Added the --8-bit-output (-8) option, which tells rsync to avoid escaping
+      high-bit characters that it thinks are unreadable in the current locale.
+
+    - The new option --human-readable (-h) changes the output of --progress,
+      --stats, and the end-of-run summary to be easier to read.  If repeated,
+      the units become powers of 1024 instead of powers of 1000.  (The old
+      meaning of -h, as a shorthand for --help, still works as long as you
+      just use it on its own, as in "rsync -h".)
 
     - If lutimes() and/or lchmod() are around, use them to allow the
       preservation of attributes on symlinks.
 
     - The --link-dest option now affects symlinks and devices (when possible).
 
-    - Improved the output of hard-linked and copied files when using
-      --link-dest, --copy-dest, or --compare-dest.
-
     - Added two config items to the rsyncd.conf parsing:  "pre-xfer exec" and
       "post-xfer exec".  These allow a command to be specified on a per-module
       basis that will be run before and/or after a daemon-mode transfer.  (See
-      the manpage for a list of the environment variables that are set with
+      the man page for a list of the environment variables that are set with
       information about the transfer.)
 
     - When using the --relative option, you can now insert a dot dir in
@@ -156,7 +177,14 @@ Changes since 2.6.6:
       client must be version 2.6.7 for this to work, but the remote rsync only
       needs to be 2.6.7 if you're pushing files.
 
-    - Added the --super option to make the receiver always attempt super- user
+    - Added the --specials option to tell rsync to copy non-device special
+      files (which rsync now attempts even as a normal user).  The --devices
+      option now requests the copying of just devices (character and block).
+      The -D option still requests both (e.g. --devices and --specials), -a
+      still implies -D, and non-root users still get a silent downgrade that
+      omits device copying.
+
+    - Added the --super option to make the receiver always attempt super-user
       activities.  This is useful for systems that allow things such as devices
       to be created or ownership to be set without being UID 0, and is also
       useful for someone who wants to ensure that errors will be output if the
@@ -181,9 +209,18 @@ Changes since 2.6.6:
     - New log-format options: %M (modtime), %U (uid), %G (gid), and %B
       (permission bits, e.g. "rwxr-xrwt").
 
-    - Some minor documentation improvements.
+    - The --dry-run option no longer forces the enabling of --verbose.
+
+    - Various documentation improvements, including: a better synopsis, some
+      improved examples, a better discussion of the presence and absence of
+      --perms (including how it interacts with the new --executability and
+      --chmod options), an extended discussion of --temp-dir, an improved
+      discussion of --partial-dir, a better description of rsync's pattern
+      matching characters, and the documenting of what the various items in
+      the --stats output mean.
 
-    - Updated some diffs in the patches dir.
+    - Various new and updated diffs in the patches dir, including: acls.diff,
+      xattrs.diff, atimes.diff, detect-renamed.diff, and slp.diff.
 
   INTERNAL: