Supported Rsync command options

This table shows rsync commands supported with NetStorage. Rsync may offer additional options, but they're not supported.

Rsync accepts both long (double-dash + word “--option”) and short (single-dash + letter “-o”) options, but some options only have a long variant, not a short. If an option can be specified in more than one way, the choices are comma-separated. If the option takes a parameter, the parameter is only listed after the long variant, even though it must also be specified for the short. When specifying a parameter, you can either use the form --option=<param> or replace the = with a whitespace.

Key

  • ObjectStore: ObjectStore storage group.
  • Yes: The option is supported.
  • No: The option is not supported.
Option 1 Description2 ObjectStore
-v, --verbose increase verbosity Yes
--info=FLAGS fine-grained informational verbosity Yes
--debug=FLAGS fine-grained debug verbosity Yes
--msgs2stderr special output handling for debugging Yes
-q, --quiet suppress non-error messages Yes
--no-motd suppress daemon-mode MOTD (see manpage caveat) Yes
-c, --checksum skip based on checksum, not mod-time &amp; size Yes
-a, --archive archive mode; equals -rlptgoD (no support for -H,,-A,,-X) Yes
--no-OPTION turn off an implied OPTION (e.g. --no-D) Yes
-r, --recursive recurse into directories Yes
-R, --relative use relative path names Yes
--no-relative Used to cancel an implied --relative No
--no-implied-dirs don't send implied dirs with --relative Yes
-b, --backup make backups (see --suffix &amp; --backup-dir) Yes
--backup-dir=DIR make backups into hierarchy based in DIR Yes
--suffix=SUFFIX set backup suffix (default %s w/o --backup-dir) Yes
-u, --update skip files that are newer on the receiver Yes
-d, --dirs transfer directories without recursing Yes
-l, --links copy symlinks as symlinks Yes
-L, --copy-links transform symlink into referent file/dir Yes
--copy-unsafe-links only "unsafe" symlinks are transformed Yes
--safe-links ignore symlinks that point outside the source tree Yes
-k, --copy-dirlinks transform symlink to a dir into referent dir Yes
-K, --keep-dirlinks treat symlinked dir on receiver as dir Yes
-p, --perms preserve permissions No
-E, --executability preserve the file's executability Yes
-o, --owner preserve owner (super-user only) No
-t, --times preserve modification times Yes
-O, --omit-dir-times omit directories from --times Yes
-J, --omit-link-times omit symlinks from --times Yes
-S, --sparse handle sparse files efficiently No
-n, --dry-run perform a trial run with no changes made Yes
-W, --whole-file copy files whole (without delta-xfer algorithm) Yes
--no-whole-file always use incremental Rsync algorithm No
-x, --one-file-system don't cross filesystem boundaries Yes
-B, --block-size=SIZE force a fixed checksum block-size Yes
-e, --rsh=COMMAND specify the remote shell to use Yes
--rsync-path=PROGRAM specify the Rsync to run on the remote machine No
--existing skip creating new files on receiver Yes
--ignore-existing skip updating files that already exist on receiver Yes
--remove-sent-files sender removes files that are sent (non-dirs) No
--remove-source-files sender removes synchronized files if they exist or are copied to remote end (non-dirs) Yes
--del an alias for --delete-during Yes
--delete delete extraneous files from destination dirs Yes
--delete-before receiver deletes before transfer, not during Yes
--delete-during receiver deletes during the transfer Yes
--delete-delay find deletions during, delete after Yes
--delete-after receiver deletes after transfer, not during Yes
--delete-excluded also delete excluded files from destination dirs Yes
--ignore-missing-args ignore missing source args without error Yes
--delete-missing-args delete missing source args from destination Yes
--ignore-errors delete even if there are I/O errors Yes
--force force deletion of directories even if not empty Yes
--max-delete=NUM don't delete more than NUM files Yes
--max-size=SIZE don't transfer any file larger than SIZE Yes
--min-size=SIZE don't transfer any file smaller than SIZE Yes
-m, --prune-empty-dirs prune empty directory chains from the file-list Yes
--timeout=SECONDS set I/O timeout in seconds Yes
--contimeout=SECONDS set daemon connection timeout in seconds Yes
-I, --ignore-times don't skip files that match in size and mod-time Yes
--size-only skip files that match in size Yes
-T, --temp-dir=DIR create temporary files in directory DIR Yes
-y, --fuzzy find similar file for basis if no dest file Yes
--compare-dest=DIR also compare destination files relative to DIR Yes
--copy-dest=DIR ... and include copies of unchanged files Yes
--link-dest=DIR hardlink to files in DIR when unchanged Yes
-z, --compress compress file data during the transfer Yes
--compress-level=NUM explicitly set compression level Yes
--skip-compress=LIST skip compressing files with a suffix in LIST Yes
-C, --cvs-exclude auto-ignore files the same way CVS does Yes
-f, --filter=RULE add a file-filtering RULE Yes
-F same as --filter='dir-merge /.rsync-filter' Yes
--exclude=PATTERN exclude files matching PATTERN Yes
--exclude-from=FILE read exclude patterns from FILE Yes
--include=PATTERN don't exclude files matching PATTERN Yes
--include-from=FILE read include patterns from FILE Yes
--files-from=FILE read list of source-file names from FILE Yes
-0, --from0 all *-from/filter files are delimited by 0s Yes
--address=ADDRESS bind address for outgoing socket to daemon No
--port=PORT specify double-colon alternate port number No
--sockopts=OPTIONS specify custom TCP options Yes
--blocking-io use blocking I/O for the remote shell No
--outbuf=N|L|B set output buffering to None, Line, or Block Yes
--stats give some file-transfer stats Yes
-8, --8-bit-output leave high-bit chars unescaped in output Yes
-h, --human-readable output numbers in a human-readable format Yes
--progress show progress during transfer Yes
-i, --itemize-changes output a change-summary for all updates Yes
-M, --remote-option=OPTION send OPTION to the remote side only Yes
--out-format=FORMAT output updates using the specified FORMAT Yes
--log-file=FILE log what we're doing to the specified FILE Yes
--log-file-format=FMT log updates using the specified FMT Yes
--password-file=FILE read daemon-access password from FILE Yes
--list-only list the files instead of copying them Yes
--bwlimit=RATE limit socket I/O bandwidth Yes
--write-batch=FILE write a batched update to FILE Yes
--only-write-batch=FILE like --write-batch but w/o updating destination Yes
--read-batch=FILE read a batched update from FILE Yes
--protocol=NUM force an older protocol version to be used Yes
--checksum-seed=NUM set block/file checksum seed (advanced) Yes
--version print version number Yes
(-h) --help show this help (-h is --help only if used alone) Yes
1 The order of options displayed in this table mimics what is shown on samba.org's page.
2 This is the basic description offered for the option when the -h option is used. samba.org offers a more robust description on their website.