Action

Union Cases

Union CaseDescription
Address(string)
Signature: string

Bind address for outgoing socket to daemon

Append
Signature:

Append data onto shorter files

Archive
Signature:

Archive mode; same as -rlptgoD (no -H)

Backup
Signature:

Make backups (see --suffix & --backup-dir)

BackupDir(string)
Signature: string

Make backups into hierarchy based in DIR

BlockingIO
Signature:

Use blocking I/O for the remote shell

BlockSize(string)
Signature: string

Force a fixed checksum block-size

Bwlimit(string)
Signature: string

Limit I/O bandwidth; KBytes per second

Cache
Signature:

Disable fcntl(F_NOCACHE)

Checksum
Signature:

Skip based on checksum, not mod-time & size

Chmod(string)
Signature: string

Affect file and/or directory permissions

CompareDest(string)
Signature: string

Also compare destination files relative to DIR

Compress
Signature:

Compress file data during the transfer

CompressLevel(int)
Signature: int

Explicitly set compression level

CopyDest(string)
Signature: string

... and include copies of unchanged files

CopyDirLinks
Signature:

Transform symlink to a dir into referent dir

CopyLinks
Signature:

Transform symlink into referent file/dir

CopyUnsafeLinks
Signature:

Only "unsafe" symlinks are transformed

CvsExclude
Signature:

Auto-ignore files the same way CVS does

D
Signature:

Same as --devices --specials

Del
Signature:

An alias for --delete-during

DelayUpdates
Signature:

Put all updated files into place at transfer's end

Delete
Signature:

Delete extraneous files from destination dirs

DeleteAfter
Signature:

Receiver deletes after transfer, not before

DeleteBefore
Signature:

Receiver deletes before transfer (default)

DeleteDuring
Signature:

Receiver deletes during transfer, not before

DeleteExcluded
Signature:

Also delete excluded files from destination dirs

Devices
Signature:

Preserve device files (super-user only)

Dirs
Signature:

Transfer directories without recursing

DryRun
Signature:

Show what would have been transferred

Exclude(string)
Signature: string

Exclude files matching PATTERN

ExcludeFrom(string)
Signature: string

Read exclude patterns from FILE

Executability
Signature:

Preserve the file's executability

Existing
Signature:

Skip creating new files on receiver

ExtendedAttributes
Signature:

Copy extended attributes

F
Signature:

Same as --filter='dir-merge /.rsync-filter' repeated: --filter='- .rsync-filter'

FilesFrom(string)
Signature: string

Read list of source-file names from FILE

Filter(string)
Signature: string

Add a file-filtering RULE

Force
Signature:

Force deletion of directories even if not empty

From0
Signature:

All *-from/filter files are delimited by 0s

Fuzzy
Signature:

Find similar file for basis if no dest file

Group
Signature:

Preserve group

HardLinks
Signature:

Preserve hard links

HeightBitsOutput
Signature:

Leave high-bit chars unescaped in output

Help
Signature:

Show this help (-h works with no other options)

HumanReadable
Signature:

Output numbers in a human-readable format

IgnoreErrors
Signature:

Delete even if there are I/O errors

IgnoreExisting
Signature:

Skip updating files that already exist on receiver

IgnoreTimes
Signature:

Don't skip files that match in size and mod-time

Include(string)
Signature: string

Don't exclude files matching PATTERN

IncludeFrom(string)
Signature: string

Read include patterns from FILE

InPlace
Signature:

Update destination files in-place (SEE MAN PAGE)

Ipv4
Signature:

Prefer IPv4

Ipv6
Signature:

Prefer IPv6

ItemizeChanges
Signature:

Output a change-summary for all updates

KeepDirLinks
Signature:

Treat symlinked dir on receiver as dir

LinkDest(string)
Signature: string

Hardlink to files in DIR when unchanged

Links
Signature:

Copy symlinks as symlinks

ListOnly
Signature:

List the files instead of copying them

LogFile(string)
Signature: string

Log what we're doing to the specified FILE

LogFileFormat(string)
Signature: string

Log updates using the specified FMT

MaxDelete(int)
Signature: int

Don't delete more than NUM files

MaxSize(string)
Signature: string

Don't transfer any file larger than SIZE

MinSize(string)
Signature: string

Don't transfer any file smaller than SIZE

ModifyWindow(string)
Signature: string

Compare mod-times with reduced accuracy

NoImpliedDirs
Signature:

Don't send implied dirs with --relative

NoMotd
Signature:

Suppress daemon-mode MOTD (see manpage caveat)

NoOption(Action)
Signature: Action

Turn off an implied OPTION (e.g. --no-D) NoOption Verbose ==> --no-verbose

NumericIds
Signature:

Don't map uid/gid values by user/group name

OmitDirTimes
Signature:

Omit directories when preserving times

OneFileSystem
Signature:

Don't cross filesystem boundaries

OnlyWriteBatch(string)
Signature: string

Like --write-batch but w/o updating destination

OutFormat(string)
Signature: string

Output updates using the specified FORMAT

Owner
Signature:

Preserve owner (super-user only)

P
Signature:

Same as --partial --progress

Partial
Signature:

Keep partially transferred files

PartialDir(string)
Signature: string

Put a partially transferred file into DIR

PasswordFile(string)
Signature: string

Read password from FILE

Perms
Signature:

Preserve permissions

Port(int)
Signature: int

Specify double-colon alternate port number

Progress
Signature:

Show progress during transfer

Protocol(int)
Signature: int

Force an older protocol version to be used

PruneEmptyDirs
Signature:

Prune empty directory chains from the file-list

Quiet
Signature:

Suppress non-error messages

ReadBatch(string)
Signature: string

Read a batched update from FILE

Recursive
Signature:

Recurse into directories

Relative
Signature:

Use relative path names

RemoveSourceFiles
Signature:

Sender removes synchronized files (non-dirs)

Rsh(string)
Signature: string

Specify the remote shell to use

RsyncPath(string)
Signature: string

Specify the rsync to run on the remote machine

SafeLinks
Signature:

Ignore symlinks that point outside the source tree

SizeOnly
Signature:

Skip files that match in size

Sockopts(string)
Signature: string

Specify custom TCP options

Sparse
Signature:

Handle sparse files efficiently

Specials
Signature:

Preserve special files

Stats
Signature:

Give some file-transfer stats

Suffix(string)
Signature: string

Set backup suffix (default ~ w/o --backup-dir)

Super
Signature:

Receiver attempts super-user activities

TempDir(string)
Signature: string

Create temporary files in directory DIR

Timeout(int)
Signature: int

Set I/O timeout in seconds

Times
Signature:

Preserve times

Update
Signature:

Skip files that are newer on the receiver

Verbose
Signature:

Increase verbosity

Version
Signature:

Print version number

WholeFile
Signature:

Copy files whole (without rsync algorithm)

WriteBatch(string)
Signature: string

Write a batched update to FILE