FAKE - F# Make - A DSL for build tasks and more FAKE
6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

Rsync.Action Type

Union cases

Union case Description

Address string

Full Usage: Address string

Parameters:
    Item : string

Bind address for outgoing socket to daemon

Item : string

Append

Full Usage: Append

Append data onto shorter files

Archive

Full Usage: Archive

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

Backup

Full Usage: Backup

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

BackupDir string

Full Usage: BackupDir string

Parameters:
    Item : string

Make backups into hierarchy based in DIR

Item : string

BlockSize string

Full Usage: BlockSize string

Parameters:
    Item : string

Force a fixed checksum block-size

Item : string

BlockingIO

Full Usage: BlockingIO

Use blocking I/O for the remote shell

Bwlimit string

Full Usage: Bwlimit string

Parameters:
    Item : string

Limit I/O bandwidth; KBytes per second

Item : string

Cache

Full Usage: Cache

Disable fcntl(F_NOCACHE)

Checksum

Full Usage: Checksum

Skip based on checksum, not mod-time & size

Chmod string

Full Usage: Chmod string

Parameters:
    Item : string

Affect file and/or directory permissions

Item : string

CompareDest string

Full Usage: CompareDest string

Parameters:
    Item : string

Also compare destination files relative to DIR

Item : string

Compress

Full Usage: Compress

Compress file data during the transfer

CompressLevel int

Full Usage: CompressLevel int

Parameters:
    Item : int

Explicitly set compression level

Item : int

CopyDest string

Full Usage: CopyDest string

Parameters:
    Item : string

... and include copies of unchanged files

Item : string

CopyDirLinks

Full Usage: CopyDirLinks

Transform symlink to a dir into referent dir

CopyLinks

Full Usage: CopyLinks

Transform symlink into referent file/dir

CopyUnsafeLinks

Full Usage: CopyUnsafeLinks

Only "unsafe" symlinks are transformed

CvsExclude

Full Usage: CvsExclude

Auto-ignore files the same way CVS does

D

Full Usage: D

Same as --devices --specials

Del

Full Usage: Del

An alias for --delete-during

DelayUpdates

Full Usage: DelayUpdates

Put all updated files into place at transfer's end

Delete

Full Usage: Delete

Delete extraneous files from destination dirs

DeleteAfter

Full Usage: DeleteAfter

Receiver deletes after transfer, not before

DeleteBefore

Full Usage: DeleteBefore

Receiver deletes before transfer (default)

DeleteDuring

Full Usage: DeleteDuring

Receiver deletes during transfer, not before

DeleteExcluded

Full Usage: DeleteExcluded

Also delete excluded files from destination dirs

Devices

Full Usage: Devices

Preserve device files (super-user only)

Dirs

Full Usage: Dirs

Transfer directories without recursing

DryRun

Full Usage: DryRun

Show what would have been transferred

Exclude string

Full Usage: Exclude string

Parameters:
    Item : string

Exclude files matching PATTERN

Item : string

ExcludeFrom string

Full Usage: ExcludeFrom string

Parameters:
    Item : string

Read exclude patterns from FILE

Item : string

Executability

Full Usage: Executability

Preserve the file's executability

Existing

Full Usage: Existing

Skip creating new files on receiver

ExtendedAttributes

Full Usage: ExtendedAttributes

Copy extended attributes

F

Full Usage: F

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

FilesFrom string

Full Usage: FilesFrom string

Parameters:
    Item : string

Read list of source-file names from FILE

Item : string

Filter string

Full Usage: Filter string

Parameters:
    Item : string

Add a file-filtering RULE

Item : string

Force

Full Usage: Force

Force deletion of directories even if not empty

From0

Full Usage: From0

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

Fuzzy

Full Usage: Fuzzy

Find similar file for basis if no dest file

Group

Full Usage: Group

Preserve group

HardLinks

Full Usage: HardLinks

Preserve hard links

HeightBitsOutput

Full Usage: HeightBitsOutput

Leave high-bit chars unescaped in output

Help

Full Usage: Help

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

HumanReadable

Full Usage: HumanReadable

Output numbers in a human-readable format

IgnoreErrors

Full Usage: IgnoreErrors

Delete even if there are I/O errors

IgnoreExisting

Full Usage: IgnoreExisting

Skip updating files that already exist on receiver

IgnoreTimes

Full Usage: IgnoreTimes

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

InPlace

Full Usage: InPlace

Update destination files in-place (SEE MAN PAGE)

Include string

Full Usage: Include string

Parameters:
    Item : string

Don't exclude files matching PATTERN

Item : string

IncludeFrom string

Full Usage: IncludeFrom string

Parameters:
    Item : string

Read include patterns from FILE

Item : string

Ipv4

Full Usage: Ipv4

Prefer IPv4

Ipv6

Full Usage: Ipv6

Prefer IPv6

ItemizeChanges

Full Usage: ItemizeChanges

Output a change-summary for all updates

KeepDirLinks

Full Usage: KeepDirLinks

Treat symlinked dir on receiver as dir

LinkDest string

Full Usage: LinkDest string

Parameters:
    Item : string

Hardlink to files in DIR when unchanged

Item : string

Links

Full Usage: Links

Copy symlinks as symlinks

ListOnly

Full Usage: ListOnly

List the files instead of copying them

LogFile string

Full Usage: LogFile string

Parameters:
    Item : string

Log what we're doing to the specified FILE

Item : string

LogFileFormat string

Full Usage: LogFileFormat string

Parameters:
    Item : string

Log updates using the specified FMT

Item : string

MaxDelete int

Full Usage: MaxDelete int

Parameters:
    Item : int

Don't delete more than NUM files

Item : int

MaxSize string

Full Usage: MaxSize string

Parameters:
    Item : string

Don't transfer any file larger than SIZE

Item : string

MinSize string

Full Usage: MinSize string

Parameters:
    Item : string

Don't transfer any file smaller than SIZE

Item : string

ModifyWindow string

Full Usage: ModifyWindow string

Parameters:
    Item : string

Compare mod-times with reduced accuracy

Item : string

NoImpliedDirs

Full Usage: NoImpliedDirs

Don't send implied dirs with --relative

NoMotd

Full Usage: NoMotd

Suppress daemon-mode MOTD (see manpage caveat)

NoOption Action

Full Usage: NoOption Action

Parameters:

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

Item : Action

NumericIds

Full Usage: NumericIds

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

OmitDirTimes

Full Usage: OmitDirTimes

Omit directories when preserving times

OneFileSystem

Full Usage: OneFileSystem

Don't cross filesystem boundaries

OnlyWriteBatch string

Full Usage: OnlyWriteBatch string

Parameters:
    Item : string

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

Item : string

OutFormat string

Full Usage: OutFormat string

Parameters:
    Item : string

Output updates using the specified FORMAT

Item : string

Owner

Full Usage: Owner

Preserve owner (super-user only)

P

Full Usage: P

Same as --partial --progress

Partial

Full Usage: Partial

Keep partially transferred files

PartialDir string

Full Usage: PartialDir string

Parameters:
    Item : string

Put a partially transferred file into DIR

Item : string

PasswordFile string

Full Usage: PasswordFile string

Parameters:
    Item : string

Read password from FILE

Item : string

Perms

Full Usage: Perms

Preserve permissions

Port int

Full Usage: Port int

Parameters:
    Item : int

Specify double-colon alternate port number

Item : int

Progress

Full Usage: Progress

Show progress during transfer

Protocol int

Full Usage: Protocol int

Parameters:
    Item : int

Force an older protocol version to be used

Item : int

PruneEmptyDirs

Full Usage: PruneEmptyDirs

Prune empty directory chains from the file-list

Quiet

Full Usage: Quiet

Suppress non-error messages

ReadBatch string

Full Usage: ReadBatch string

Parameters:
    Item : string

Read a batched update from FILE

Item : string

Recursive

Full Usage: Recursive

Recurse into directories

Relative

Full Usage: Relative

Use relative path names

RemoveSourceFiles

Full Usage: RemoveSourceFiles

Sender removes synchronized files (non-dirs)

Rsh string

Full Usage: Rsh string

Parameters:
    Item : string

Specify the remote shell to use

Item : string

RsyncPath string

Full Usage: RsyncPath string

Parameters:
    Item : string

Specify the rsync to run on the remote machine

Item : string

SafeLinks

Full Usage: SafeLinks

Ignore symlinks that point outside the source tree

SizeOnly

Full Usage: SizeOnly

Skip files that match in size

Sockopts string

Full Usage: Sockopts string

Parameters:
    Item : string

Specify custom TCP options

Item : string

Sparse

Full Usage: Sparse

Handle sparse files efficiently

Specials

Full Usage: Specials

Preserve special files

Stats

Full Usage: Stats

Give some file-transfer stats

Suffix string

Full Usage: Suffix string

Parameters:
    Item : string

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

Item : string

Super

Full Usage: Super

Receiver attempts super-user activities

TempDir string

Full Usage: TempDir string

Parameters:
    Item : string

Create temporary files in directory DIR

Item : string

Timeout int

Full Usage: Timeout int

Parameters:
    Item : int

Set I/O timeout in seconds

Item : int

Times

Full Usage: Times

Preserve times

Update

Full Usage: Update

Skip files that are newer on the receiver

Verbose

Full Usage: Verbose

Increase verbosity

Version

Full Usage: Version

Print version number

WholeFile

Full Usage: WholeFile

Copy files whole (without rsync algorithm)

WriteBatch string

Full Usage: WriteBatch string

Parameters:
    Item : string

Write a batched update to FILE

Item : string