Document --skip-compress.

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index c2ecd06..74cbe9f 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -336,8 +336,8 @@ to the detailed description below for a complete description.  verb(
      --devices               preserve device files (super-user only)
      --specials              preserve special files
  -D                          same as --devices --specials
      --devices               preserve device files (super-user only)
      --specials              preserve special files
  -D                          same as --devices --specials

- -t, --times                 preserve times
- -O, --omit-dir-times        omit directories when preserving times
+ -t, --times                 preserve modification times
+ -O, --omit-dir-times        omit directories from --times

      --super                 receiver attempts super-user activities
      --fake-super            store/recover privileged attrs using xattrs
  -S, --sparse                handle sparse files efficiently
      --super                 receiver attempts super-user activities
      --fake-super            store/recover privileged attrs using xattrs
  -S, --sparse                handle sparse files efficiently


@@ -378,6 +378,7 @@ to the detailed description below for a complete description.  verb(
      --link-dest=DIR         hardlink to files in DIR when unchanged
  -z, --compress              compress file data during the transfer
      --compress-level=NUM    explicitly set compression level
      --link-dest=DIR         hardlink to files in DIR when unchanged
  -z, --compress              compress file data during the transfer
      --compress-level=NUM    explicitly set compression level

+     --skip-compress=LIST    skip compressing files with suffix in LIST

  -C, --cvs-exclude           auto-ignore files in the same way CVS does
  -f, --filter=RULE           add a file-filtering RULE
  -F                          same as --filter='dir-merge /.rsync-filter'
  -C, --cvs-exclude           auto-ignore files in the same way CVS does
  -f, --filter=RULE           add a file-filtering RULE
  -F                          same as --filter='dir-merge /.rsync-filter'


@@ -664,7 +665,7 @@ if no -bf(-backup-dir) was specified, otherwise it is an empty string.
 
 dit(bf(-u, --update)) This forces rsync to skip any files which exist on
 the destination and have a modified time that is newer than the source
 
 dit(bf(-u, --update)) This forces rsync to skip any files which exist on
 the destination and have a modified time that is newer than the source

-file.  (If an existing destination file has a modify time equal to the
+file.  (If an existing destination file has a modification time equal to the

 source file's, it will be updated if the sizes are different.)
 
 In the current implementation of bf(--update), a difference of file format
 source file's, it will be updated if the sizes are different.)
 
 In the current implementation of bf(--update), a difference of file format


@@ -993,12 +994,20 @@ dit(bf(--existing, --ignore-non-existing)) This tells rsync to skip
 creating files (including directories) that do not exist
 yet on the destination.  If this option is
 combined with the bf(--ignore-existing) option, no files will be updated
 creating files (including directories) that do not exist
 yet on the destination.  If this option is
 combined with the bf(--ignore-existing) option, no files will be updated

-(which can be useful if all you want to do is to delete extraneous files).
+(which can be useful if all you want to do is delete extraneous files).

 
 dit(bf(--ignore-existing)) This tells rsync to skip updating files that
 already exist on the destination (this does em(not) ignore existing
 directories, or nothing would get done).  See also bf(--existing).
 
 
 dit(bf(--ignore-existing)) This tells rsync to skip updating files that
 already exist on the destination (this does em(not) ignore existing
 directories, or nothing would get done).  See also bf(--existing).
 

+This option can be useful for those doing backups using the bf(--link-dest)
+option when they need to continue a backup run that got interrupted.  Since
+a bf(--link-dest) run is copied into a new directory hierarchy (when it is
+used properly), using bf(--ignore existing) will ensure that the
+already-handled files don't get tweaked (which avoids a change in
+permissions on the hard-linked files).  This does mean that this option
+is only looking at the existing files in the destination hierarchy itself.
+

 dit(bf(--remove-source-files)) This tells rsync to remove from the sending
 side the files (meaning non-directories) that are a part of the transfer
 and have been successfully duplicated on the receiving side.
 dit(bf(--remove-source-files)) This tells rsync to remove from the sending
 side the files (meaning non-directories) that are a part of the transfer
 and have been successfully duplicated on the receiving side.


@@ -1430,10 +1439,40 @@ be achieved by using a compressing remote shell or a compressing transport
 because it takes advantage of the implicit information in the matching data
 blocks that are not explicitly sent over the connection.
 
 because it takes advantage of the implicit information in the matching data
 blocks that are not explicitly sent over the connection.
 

+See the bf(--skip-compress) option for the default list of file suffixes
+that will not be compressed.
+

 dit(bf(--compress-level=NUM)) Explicitly set the compression level to use
 (see bf(--compress)) instead of letting it default.  If NUM is non-zero,
 the bf(--compress) option is implied.
 
 dit(bf(--compress-level=NUM)) Explicitly set the compression level to use
 (see bf(--compress)) instead of letting it default.  If NUM is non-zero,
 the bf(--compress) option is implied.
 

+dit(bf(--skip-compress=LIST)) Override the list of file suffixes that will
+not be compressed.  The bf(LIST) should be one or more file suffixes
+(without the dot) separated by slashes (/).
+
+You may specify an empty string to indicate that no file should be skipped.
+
+Simple character-class matching is supported: each must consist of a list
+of letters inside the square brackets (e.g. no special classes, such as
+"[:alpha:]", are supported).
+
+The characters asterisk (*) and question-mark (?) have no special meaning.
+
+Here's an example that specifies 6 suffixes to skip (since 1 of the 5 rules
+matches 2 suffixes):
+
+verb(    --skip-compress=gz/jpg/mp[34]/7z/bz2)
+
+The default list of suffixes that will not be compressed is this (several
+of these are newly added for 3.0.0):
+
+verb(    gz/zip/z/rpm/deb/iso/bz2/t[gb]z/7z/mp[34]/mov/avi/ogg/jpg/jpeg)
+
+This list will be replaced by your bf(--skip-compress) list in all but one
+situation: a copy from a daemon rsync will add your skipped suffixes to
+its list of non-compressing files (and its list may be configured to a
+different default).
+

 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
 and user IDs rather than using user and group names and mapping them
 at both ends.
 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
 and user IDs rather than using user and group names and mapping them
 at both ends.


@@ -1529,7 +1568,7 @@ quote(itemization(
   by the file transfer.
   it() A bf(t) means the modification time is different and is being updated
   to the sender's value (requires bf(--times)).  An alternate value of bf(T)
   by the file transfer.
   it() A bf(t) means the modification time is different and is being updated
   to the sender's value (requires bf(--times)).  An alternate value of bf(T)

-  means that the time will be set to the transfer time, which happens
+  means that the modification time will be set to the transfer time, which happens

   anytime a symlink is transferred, or when a regular file or device is
   transferred without bf(--times).
   it() A bf(p) means the permissions are different and are being updated to
   anytime a symlink is transferred, or when a regular file or device is
   transferred without bf(--times).
   it() A bf(p) means the permissions are different and are being updated to