Tweaked the mention of --human-readable.
[rsync/rsync.git] / NEWS
diff --git a/NEWS b/NEWS
index 699ebd3..b5633fb 100644 (file)
--- a/NEWS
+++ b/NEWS
-NEWS for rsync 2.6.3 (UNRELEASED)
-Protocol: 28 (unchanged)
-Changes since 2.6.2:
+NEWS for rsync 2.6.7 (UNRELEASED)
+Protocol: 29 (unchanged)
+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 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:
 
-    - Fixed a crash bug that might appear when --delete was used and
-      multiple source directories were specified.
+    - Fixed a really old bug that caused --checksum (-c) to checksum all the
+      files encountered during the delete scan (ouch).
 
-    - The --backup code no longer attempts to create some directories
-      over and over again (generating warnings along the way).
+    - Fixed a potential hang in a remote generator:  when the receiver gets a
+      read-error on the socket, it now signals the generator about this so that
+      the generator does not try to send any of the terminating error messages
+      to the client (avoiding a potential hang in some setups).
 
-    - Fixed a bug in the reading of the password file (by the daemon)
-      and the secrets file (by the client):  the files no longer need to
-      be terminated by a newline for their content to be read in.
+    - Made hard-links work with symlinks and devices again.
 
-    - If a file has a read error on the sending side, the receiver will
-      no longer keep the resulting file unless the --partial option was
-      specified.
+    - If the sender gets an early EOF reading a source file, we propagate this
+      error to the receiver so that it can discard the file and try requesting
+      it again (which is the existing behavior for other kinds of read errors).
 
-    - Fixed an age-old crash problem with --read-batch on a local copy
-      (rsync was improperly assuming --whole-file for the local copy).
+    - If a device-file/special-file changes permissions, rsync now updates the
+      permissions without recreating the file.
 
-  ENHANCEMENTS:
-
-    - Added long-option names for -4 and -6 (namely --ipv4 and --ipv6)
-      and documented all these options in the man page.
+    - If the user specifies a remote-host for both the source and destination,
+      we now output a syntax error rather than trying to open the destination
+      hostspec as a filename.
 
-  INTERNAL:
+    - When --inplace creates a new destination file, rsync now creates it with
+      permissions 0600 instead of 0000 -- this makes restarting possible when
+      the transfer gets interrupted in the middle of sending a new file.
 
-    - Some cleanup in the exclude code has saved some memory and made
-      things easier to maintain.
+    - Reject the combination of --inplace and --sparse since the sparse-output
+      algorithm doesn't work when overwriting existing data.
 
-    - Use rsyserr() in the various places that were still calling
-      rprintf() with strerror() as an arg.
+    - Fixed the directory name in the error that is output when pop_dir()
+      fails.
 
-  BUILD CHANGES:
+    - Really fixed the parsing of a "!" entry in .cvsignore files this time.
 
-    - Added a "gen" target to rebuild most of the various generated
-      files, including configure, config.h.in, the man pages, and
-      proto.h.
+    - If the generator gets a stat() error on a file, output it (this used to
+      require at least -vv for the error to be seen).
 
-    - The timestamp of the proto.h file is unaltered by "make proto"
-      if the contents don't change.
+    - If waitpid() fails or the child rsync didn't exit cleanly, we now handle
+      the exit status properly and generate a better error.
 
-  DEVELOPER RELATED:
+    - Fixed some glitches in the double-verbose output when using --copy-dest,
+      --link-dest, or --compare-dest.
 
-    - The scripts in the testsuite dir were cleaned up a bit.
+    - Fixed the matching of the dont-compress items (e.g. *.gz) against files
+      that have a path component containing a slash.
 
-NEWS for rsync 2.6.2 (30 Apr 2004)
-Protocol: 28 (unchanged)
-Changes since 2.6.1:
+    - If code reading a filter/exclude file an EINTR error, rsync now clears
+      the error flag on the file handle so it can keep on reading.
 
-  BUG FIXES:
+    - If --relative is active, the sending side cleans up trailing "/" or "/."
+      suffixes to avoid triggering a bug in older rsync versions.  Also, we now
+      reject a ".." dir if it would be sent as a relative dir.
 
-    - Fixed a major bug in the sorting of the filenames when --relative
-      is used for some sources (just sources such as "/" and "/*" were
-      affected).  This fix ensures that we ask for the right file-list
-      item when requesting changes from the sender.
+    - If a non-directory is in the way of a directory and rsync is run with
+      --dry-run and --delete, rsync no longer complains about not being able
+      to opendir() the not-yet present directory.
 
-    - Rsync now checks the return value of the close() function to
-      better report disk-full problems on an NFS file system.
+    - Got rid of the need for --force to be used in some circumstances with
+      --delete-after (making it consistent with --delete-before/-during).
 
-    - Restored the old daemon-server behavior of logging error messages
-      rather than returning them to the user.  (A better long-term fix
-      will be sought in the future.)
+  ENHANCEMENTS:
 
-    - An obscure uninitialized-variable bug was fixed in the uid/gid
-      code.  (This bug probably had no ill effects.)
+    - 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.
 
-  BUILD CHANGES:
+    - Added the --append option that makes rsync append data onto files that
+      are longer on the source than the destination (this includes new files).
 
-    - Got rid of the configure check for sys/sysctl.h (it wasn't used
-      and was causing a problem on some systems).  Also improved the
-      broken-largefile-locking test to try to avoid failure due to an
-      NFS build-dir.
+    - Added the --min-size=SIZE option to exclude small files from the
+      transfer.
 
-    - Fixed a compile problem on systems that don't define
-      AI_NUMERICHOST.
+    - Added the --compress-level option to allow you to set how aggressive
+      rsync's compression should be (this option implies --compress).
 
-    - Fixed a compile problem in the popt source for compilers that
-      don't support __attribute__.
+    - Enhanced the parsing of the SIZE value for --min-size and --max-size to
+      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).
 
-  DEVELOPER RELATED:
+    - 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.
 
-    - Improved the testsuite's "merge" test to work on OSF1.
+    - 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.
 
-    - Two new diffs were added to the patches dir.
+    - If lutimes() and/or lchmod() are around, use them to allow the
+      preservation of attributes on symlinks.
 
-\f
-NEWS for rsync 2.6.1 (26 Apr 2004)
-Protocol: 28 (changed)
-Changes since 2.6.0:
+    - The --link-dest option now affects symlinks and devices (when possible).
 
-  SECURITY FIXES:
+    - Improved the output of hard-linked and copied files when using
+      --link-dest, --copy-dest, or --compare-dest.
 
-    - Paths sent to an rsync daemon are more thoroughly sanitized when
-      chroot is not used.  If you're running a non-read-only rsync
-      daemon with chroot disabled, *please upgrade*, ESPECIALLY if the
-      user privs you run rsync under is anything above "nobody".
+    - 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
+      information about the transfer.)
 
-  ENHANCEMENTS:
+    - When using the --relative option, you can now insert a dot dir in
+      the source path to indicate where the replication of the source dirs
+      should start.  For example, if you specify a source path of
+      rsync://host/module/foo/bar/./baz/dir with -R, rsync will now only
+      replicate the "baz/dir" part of the source path (note: a trailing
+      dot dir is unaffected unless it also has a trailing slash).
 
-    - Lower memory use, more optimal transfer of data over the socket,
-      and lower CPU usage (see the INTERNAL section for details).
+    - Added some new --no-FOO options that make it easier to override unwanted
+      implied or default options.  For example, "-a --no-o" (aka "--archive
+      --no-owner") can be used to turn off the preservation of file ownership
+      that is implied by -a.
 
-    - The RSYNC_PROXY environment variable can now contain a
-      "USER:PASS@" prefix before the "HOST:PORT" information.
-      (Bardur Arantsson)
+    - Added the --chmod=MODE option that allows the destination permissions to
+      be changed from the source permissions.  E.g. --chmod=g+w,o-rwx
 
-    - The --progress output now mentions how far along in the transfer
-      we are, including both a count of files transferred and a
-      percentage of the total file-count that we've processed.  It also
-      shows better current-rate-of-transfer and remaining-transfer-time
-      values.
+    - Added the "incoming chmod" and "outgoing chmod" daemon options that allow
+      a module to specify what permissions changes should be applied to all
+      files copied to and from the daemon.
 
-    - Documentation changes now attempt to describe some often mis-
-      understood features more clearly.
+    - Allow the --temp-dir option to be specified when starting a daemon, which
+      sets the default temporary directory for incoming files.
 
-  BUG FIXES:
+    - If --delete is combined with --dirs without --recursive, rsync will now
+      delete in any directory whose content is being synchronized.
 
-    - When -x (--one-file-system) is combined with -L (--copy-links) or
-      --copy-unsafe-links, no symlinked files are skipped, even if the
-      referent file is on a different filesystem.
-
-    - The --link-dest code now works properly for a non-root user when
-      (1) the UIDs of the source and destination differ and -o was
-      specified, or (2) when the group of the source can't be used on
-      the destination and -g was specified.
-
-    - Fixed a bug in the handling of -H (hard-links) that might cause
-      the expanded PATH/NAME value of the current item to get
-      overwritten (due to an expanded-name caching bug).
-      
-    - We now reset the "new data has been sent" flag at the start of
-      each file we send.  This makes sure that an interrupted transfer
-      with the --partial option set doesn't keep a shorter temp file
-      than the current basis file when no new data has been transfered
-      over the wire for that file.
-
-    - Fixed a byte-order problem in --batch-mode on big-endian machines.
-      (Jay Fenlason)
-
-    - When using --cvs-exclude, the exclude items we get from a
-      per-directory's .cvsignore file once again only affect that one
-      directory (not all following directories too).  The items are also
-      now properly word-split and parsed without any +/- prefix parsing.
-
-    - When specifying the USER@HOST: prefix for a file, the USER part
-      can now contain an '@', if needed (i.e. the last '@' is used to
-      find the HOST, not the first).
-
-    - Fixed some bugs in the handling of group IDs for non-root users:
-      (1) It properly handles a group that the sender didn't have a name
-      for (it would previously skip changing the group on any files in
-      that group).  (2) If --numeric-ids is used, rsync no longer
-      attempts to set groups that the user doesn't have the permission
-      to set.
-
-    - Fixed the "refuse options" setting in the rsyncd.conf file.
-
-    - Improved the -x (--one-file-system) flag's handling of any mount-
-      point directories we encounter.  It is both more optimal (in that
-      it no longer does a useless scan of the contents of the mount-
-      point dirs) and also fixes a bug where a remapped mount of the
-      original filesystem could get discovered in a subdir we should be
-      ignoring.
-
-    - Rsync no longer discards a double-slash at the start of a filename
-      when trying to open the file.  It also no longer constructs names
-      that start with a double slash (unless the user supplied them).
-
-    - Path-specifying options to a daemon should now work the same with
-      or without chroot turned on.  Previously, such a option (such as
-      --link-dest) would get its absolute path munged into a relative
-      one if chroot was not on, making that setting fairly useless.
-      Rsync now transforms the path into one that is based on the
-      module's base dir when chroot is not enabled.
-
-    - Fixed a compatibility problem interacting with older rsync
-      versions that might send us an empty --suffix value without
-      telling us that --backup-dir was specified.
-
-    - The "hosts allow" option for a daemon-over-remote-shell process
-      now has improved support for IPv6 addresses and a fix for systems
-      that have a length field in their socket structs.
-
-    - Fixed the ability to request an empty backup --suffix when sending
-      files to an rsync daemon.
+    - If --backup is combined with --delete without --backup-dir (and without
+      --delete-excluded), we add a "protect" filter-rule to ensure that files
+      with the backup suffix are not deleted.
 
-  INTERNAL:
+    - The file-count stats that are output by --progress were improved to
+      better indicate what the numbers mean.  For instance, the output:
+      "(xfer#5, to-check=8383/9999)" indicates that this was the fifth file
+      to be transferred, and we still need to check 8383 more files out of
+      a total of 9999.
 
-    - Most of the I/O is now buffered, which results in a pretty large
-      speedup when running under MS Windows.  (Craig Barratt)
+    - The include/exclude code now allows a dir/*** directive (with 3 trailing
+      stars) to match both the dir itself as well as all the content below the
+      dir (dir/** would not match the dir).
 
-    - Optimizations to the name-handling/comparing code have made some
-      significant reductions in user-CPU time for large file sets.
+    - Added the --prune-empty-dirs (-m) option that makes the receiving rsync
+      discard empty chains of directories from the file-list.  This makes it
+      easier to selectively copy files from a source hierarchy and end up with
+      just the directories needed to hold the resulting files.
 
-    - Some cleanup of the variable types make the code more consistent.
+    - If the --itemize-changes (-i) option is repeated, rsync now includes
+      unchanged files in the itemized output (similar to -vv, but without all
+      the other verbose messages that can get in the way).  Of course, the
+      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.
 
-    - Reduced memory requirements of hard link preservation.
-      (J.W. Schultz)
+    - 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
+      receiving rsync isn't being run as root.
 
-    - Implemented a new algorithm for hard-link handling that speeds up
-      the code significantly.  (J.W. Schultz and Wayne Davison)
+    - Added the --sockopts option for those few who want to customize the TCP
+      options used to contact a daemon rsync.
 
-    - The --hard-link option now uses the first existing file in the
-      group of linked files as the basis for the transfer.  This
-      prevents the sub-optimal transfer of a file's data when a new
-      hardlink is added on the sending side and it sorts alphabetically
-      earlier in the list than the files that are already present on the
-      receiving side.
+    - Added a way for the --temp-dir option to be combined with a partial-dir
+      setting that lets rsync avoid non-atomic updates (for those times when
+      --temp-dir is not being used because space is tight).
 
-    - Dropped support for protocol versions less than 20 (2.3.0 released
-      15 Mar 1999) and activated warnings for protocols less than 25
-      (2.5.0 released 23 Aug 2001). (Wayne Davison and J.W. Schultz,
-      severally)
+    - A new support script, files-to-excludes, will transform a list of files
+      into a set of include/exclude directives that will copy those files.
 
-    - More optimal data transmission for --hard-links (protocol 28).
+    - A new option, --executability (-E) can be used to preserve just the
+      execute bit on files, for those times when using the --perms option is
+      not desired.
 
-    - More optimal data transmission for --checksum (protocol 28).
+    - The daemon now logs each module-list request it receives.
 
-    - Less memory is used when --checksum is specified.
+    - New log-format options: %M (modtime), %U (uid), %G (gid), and %B
+      (permission bits, e.g. "rwxr-xrwt").
 
-    - Less memory is used in the file list (a per-file savings).
+    - The --dry-run option no longer forces the enabling of --verbose.
 
-    - The generator is now better about not modifying the file list
-      during the transfer in order to avoid a copy-on-write memory
-      bifurcation (on systems where fork() uses shared memory).
-      Previously, rsync's shared memory would slowly become unshared,
-      resulting in real memory usage nearly doubling on the receiving
-      side by the end of the transfer.  Now, as long as permissions
-      are being preserved, the shared memory should remain that way
-      for the entire transfer.
+    - Some minor documentation improvements.
 
-    - Changed hardlink info and file_struct + strings to use allocation
-      pools.  This reduces memory use for large file-sets and permits
-      freeing memory to the OS.  (J.W. Schultz) 
+    - Updated some diffs in the patches dir.
 
-    - The 2 pipes used between the receiver and generator processes
-      (which are forked on the same machine) were reduced to 1 pipe and
-      the protocol improved so that (1) it is now impossible to have the
-      "redo" pipe fill up and hang rsync, and (2) trailing messages from
-      the receiver don't get lost on their way through the generator
-      over to the sender (which mainly affected hard-link messages and
-      verbose --stats output).
+  INTERNAL:
 
-    - Improved the internal uid/gid code to be more portable and a
-      little more optimized.
+    - We now use sigaction() and sigprocmask() if possible, and fall back on
+      signal() if not.  Using sigprocmask() ensures that rsync enables all the
+      signals that it needs, just in case it was started in a masked state.
 
-    - The device numbers sent when using --devices are now sent as
-      separate major/minor values with 32-bit accuracy (protocol 28).
-      Previously, the copied devices were sent as a single 32-bit
-      number.  This will make inter-operation of 64-bit binaries more
-      compatible with their 32-bit brethren (with both ends of the
-      connection are using protocol 28).  Note that optimizations in the
-      binary protocol for sending the device numbers often results in
-      fewer bytes being used than before, even though more precision is
-      now available.
+    - Some buffer sizes were expanded a bit, particularly on systems where
+      MAXPATHLEN is overly small (e.g. cygwin).
 
-    - Some cleanup of the exclude/include structures and its code made
-      things clearer (internally), simpler, and more efficient.
+    - If io_printf() tries to format more data than fits in the buffer, exit
+      with an error instead of transmitting a truncated buffer.
 
-    - The reading & writing of the file-list in batch-mode is now
-      handled by the same code that sends & receives the list over the
-      wire.  This makes it much easier to maintain.  (Note that the
-      batch code is still considered to be experimental.)
+    - If a va_copy macro is defined, lib/snprintf.c will use it when defining
+      the VA_COPY macro.
 
-  BUILD CHANGES:
+    - Reduced the amount of stack memory needed for each level of directory
+      recursion by nearly MAXPATHLEN bytes.
 
-    - The configure script now accepts --with-rsyncd-conf=PATH to
-      override the default value of the /etc/rsyncd.conf file.
+    - The wildmatch function was extended to allow an array of strings to be
+      supplied as the string to match.  This allows the exclude code to do less
+      string copying.
 
-    - Fixed configure bug when running "./configure --disable-ipv6".
+    - Got rid of the safe_fname() function (and all the myriad calls) and
+      replaced it with a new function in the log.c code that filters all the
+      output going to the terminal.
 
-    - Fixed compilation problem on Tru64 Unix (having to do with
-      sockaddr.sa_len and sockaddr.sin_len).
+    - Unified the f_name() and the f_name_to() functions.
 
   DEVELOPER RELATED:
 
-    - Fixed "make test" bug when build dir is not the source dir.
+    - The diffs in the patches dir now require "patch -p1 <DIFF" instead of
+      the previous -p0.  Also, the version included in the release tar now
+      affect generated files (e.g. configure, rsync.1, proto.h, etc.), so
+      it is no longer necessary to run autoconf and/or yodl unless you're
+      applying a patch that was checked out from CVS.
+
+    - Several diffs in the patches dir now use the proper --enable-FOO
+      configure option instead of --with-FOO to turn on the inclusion of
+      the newly patched feature.
 
-    - Added a couple extra diffs in the "patches" dir, removed the ones
-      that got applied, and rebuilt the rest.
+    - There is a new script, "prepare-source" than can be used to update the
+      various generated files (proto.h, configure, etc.) even before configure
+      has created the Makefile (this is mainly useful when patching the source
+      with a patch that doesn't affect generated files).
 
+    - The testsuite now sets HOME so that it won't be affected by a file such
+      as ~/.popt.