Name

adams.flow.source.RSync

Synopsis

Supports synchronization using rsync.
In case of an error, the stderr output is forwarded, otherwise stdout output.

Additional information

Flow input/output:
- output: java.lang.String

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	RSync

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

  
  
• stopFlowOnError
  

  If set to true, the flow execution at this level gets stopped in case this actor encounters an error; the error gets propagated; useful for critical actors.

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• source
  

  The local or remote source path (path or [user@]host:path)

  command-line	-source <java.lang.String>
  default

  
  
• destination
  

  The local or remote destination path (path or [user@]host:path)

  command-line	-destination <java.lang.String>
  default

  
  
• outputCommandline
  

  output the command-line generated for the rsync binary

  command-line	-outputCommandline <boolean>
  default	false

  
  
• verbose
  

  increase verbosity

  command-line	-verbose <boolean>
  default	false

  
  
• info
  

  fine-grained informational verbosity

  command-line	-info <java.lang.String>
  default

  
  
• debug
  

  fine-grained debug verbosity

  command-line	-debug <java.lang.String>
  default

  
  
• msgs2stderr
  

  special output handling for debugging

  command-line	-msgs2stderr <boolean>
  default	false

  
  
• quiet
  

  suppress non-error messages

  command-line	-quiet <boolean>
  default	false

  
  
• noMotd
  

  suppress daemon-mode MOTD

  command-line	-no_motd <boolean>
  default	false

  
  
• checksum
  

  skip based on checksum, not mod-time & size

  command-line	-checksum <boolean>
  default	false

  
  
• archive
  

  archive mode; equals -rlptgoD (no -H,-A,-X)

  command-line	-archive <boolean>
  default	false

  
  
• recursive
  

  recurse into directories

  command-line	-recursive <boolean>
  default	false

  
  
• relative
  

  use relative path names

  command-line	-relative <boolean>
  default	false

  
  
• noImpliedDirs
  

  use relative path names

  command-line	-no_implied_dirs <boolean>
  default	false

  
  
• backup
  

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

  command-line	-backup <boolean>
  default	false

  
  
• backupDir
  

  make backups into hierarchy based in DIR

  command-line	-backup_dir <java.lang.String>
  default

  
  
• suffix
  

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

  command-line	-suffix <java.lang.String>
  default

  
  
• update
  

  skip files that are newer on the receiver

  command-line	-update <boolean>
  default	false

  
  
• inplace
  

  update destination files in-place

  command-line	-inplace <boolean>
  default	false

  
  
• append
  

  append data onto shorter files

  command-line	-append <boolean>
  default	false

  
  
• appendVerify
  

  like --append, but with old data in file checksum

  command-line	-append_verify <boolean>
  default	false

  
  
• dirs
  

  transfer directories without recursing

  command-line	-dirs <boolean>
  default	false

  
  
• links
  

  copy symlinks as symlinks

  command-line	-links <boolean>
  default	false

  
  
• copyLinks
  

  transform symlink into referent file/dir

  command-line	-copy_links <boolean>
  default	false

  
  
• copyUnsafeLinks
  

  only "unsafe" symlinks are transformed

  command-line	-copy_unsafe_links <boolean>
  default	false

  
  
• safeLinks
  

  ignore symlinks that point outside the source tree

  command-line	-safe_links <boolean>
  default	false

  
  
• mungeLinks
  

  munge symlinks to make them safer (but unusable)

  command-line	-munge_links <boolean>
  default	false

  
  
• copyDirlinks
  

  transform symlink to a dir into referent dir

  command-line	-copy_dirlinks <boolean>
  default	false

  
  
• keepDirlinks
  

  treat symlinked dir on receiver as dir

  command-line	-keep_dirlinks <boolean>
  default	false

  
  
• hardLinks
  

  preserve hard links

  command-line	-hard_links <boolean>
  default	false

  
  
• perms
  

  preserve permissions

  command-line	-perms <boolean>
  default	false

  
  
• executability
  

  preserve the file's executability

  command-line	-executability <boolean>
  default	false

  
  
• chmod
  

  affect file and/or directory permissions

  command-line	-chmod <java.lang.String>
  default

  
  
• xattrs
  

  preserve extended attributes

  command-line	-xattrs <boolean>
  default	false

  
  
• owner
  

  preserve owner (super-user only)

  command-line	-owner <boolean>
  default	false

  
  
• group
  

  preserve group

  command-line	-group <boolean>
  default	false

  
  
• devices
  

  preserve device files (super-user only)

  command-line	-devices <boolean>
  default	false

  
  
• specials
  

  preserve special files

  command-line	-specials <boolean>
  default	false

  
  
• times
  

  preserve modification times

  command-line	-times <boolean>
  default	false

  
  
• omitDirTimes
  

  omit directories from --times

  command-line	-omit_dir_times <boolean>
  default	false

  
  
• omitLinkTimes
  

  omit symlinks from --times

  command-line	-omit_link_times <boolean>
  default	false

  
  
• super_
  

  receiver attempts super-user activities

  command-line	-super_ <boolean>
  default	false

  
  
• fakeSuper
  

  store/recover privileged attrs using xattrs

  command-line	-fake_super <boolean>
  default	false

  
  
• sparse
  

  handle sparse files efficiently

  command-line	-sparse <boolean>
  default	false

  
  
• preallocate
  

  allocate dest files before writing them

  command-line	-preallocate <boolean>
  default	false

  
  
• dryRun
  

  perform a trial run with no changes made

  command-line	-dry_run <boolean>
  default	false

  
  
• wholeFile
  

  copy files whole (without delta-xfer algorithm)

  command-line	-whole_file <boolean>
  default	false

  
  
• oneFileSystem
  

  don't cross filesystem boundaries

  command-line	-one_file_system <boolean>
  default	false

  
  
• blockSize
  

  force a fixed checksum block-size

  command-line	-block_size <java.lang.String>
  default

  
  
• rsh
  

  specify the remote shell to use

  command-line	-rsh <java.lang.String>
  default

  
  
• rsyncPath
  

  specify the rsync to run on the remote machine

  command-line	-rsync_path <java.lang.String>
  default

  
  
• existing
  

  skip creating new files on receiver

  command-line	-existing <boolean>
  default	false

  
  
• ignoreExisting
  

  skip updating files that already exist on receiver

  command-line	-ignore_existing <boolean>
  default	false

  
  
• removeSourceFiles
  

  sender removes synchronized files (non-dirs)

  command-line	-remove_source_files <boolean>
  default	false

  
  
• delete
  

  delete extraneous files from destination dirs

  command-line	-delete <boolean>
  default	false

  
  
• deleteBefore
  

  receiver deletes before transfer, not during

  command-line	-delete_before <boolean>
  default	false

  
  
• deleteDuring
  

  receiver deletes during the transfer

  command-line	-delete_during <boolean>
  default	false

  
  
• deleteDelay
  

  find deletions during, delete after

  command-line	-delete_delay <boolean>
  default	false

  
  
• deleteAfter
  

  receiver deletes after transfer, not during

  command-line	-delete_after <boolean>
  default	false

  
  
• deleteExcluded
  

  also delete excluded files from destination dirs

  command-line	-delete_excluded <boolean>
  default	false

  
  
• ignoreMissingArgs
  

  ignore missing source args without error

  command-line	-ignore_missing_args <boolean>
  default	false

  
  
• deleteMissingArgs
  

  delete missing source args from destination

  command-line	-delete_missing_args <boolean>
  default	false

  
  
• ignoreErrors
  

  delete even if there are I/O errors

  command-line	-ignore_errors <boolean>
  default	false

  
  
• force
  

  force deletion of directories even if not empty

  command-line	-force <boolean>
  default	false

  
  
• maxDelete
  

  don't delete more than NUM files

  command-line	-max_delete <int>
  default	-1

  
  
• maxSize
  

  don't transfer any file larger than SIZE

  command-line	-max_size <java.lang.String>
  default

  
  
• minSize
  

  don't transfer any file smaller than SIZE

  command-line	-min_size <java.lang.String>
  default

  
  
• partial
  

  keep partially transferred files

  command-line	-partial <boolean>
  default	false

  
  
• partialDir
  

  put a partially transferred file into DIR

  command-line	-partial_dir <java.lang.String>
  default

  
  
• delayUpdates
  

  put all updated files into place at transfer's end

  command-line	-delay_updates <boolean>
  default	false

  
  
• pruneEmptyDirs
  

  prune empty directory chains from the file-list

  command-line	-prune_empty_dirs <boolean>
  default	false

  
  
• numericIds
  

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

  command-line	-numeric_ids <boolean>
  default	false

  
  
• usermap
  

  custom username mapping

  command-line	-usermap <java.lang.String>
  default

  
  
• groupmap
  

  custom groupname mapping

  command-line	-groupmap <java.lang.String>
  default

  
  
• chown
  

  simple username/groupname mapping

  command-line	-chown <java.lang.String>
  default

  
  
• timeout
  

  set I/O timeout in seconds

  command-line	-timeout <int>
  default	-1

  
  
• contimeout
  

  set daemon connection timeout in seconds

  command-line	-contimeout <int>
  default	-1

  
  
• ignoreTimes
  

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

  command-line	-ignore_times <boolean>
  default	false

  
  
• remoteOption
  

  send OPTION to the remote side only

  command-line	-remote_option <java.lang.String>
  default

  
  
• sizeOnly
  

  skip files that match in size

  command-line	-size_only <boolean>
  default	false

  
  
• modifyWindow
  

  compare mod-times with reduced accuracy

  command-line	-modify_window <int>
  default	-1

  
  
• tempDir
  

  create temporary files in directory DIR

  command-line	-temp_dir <java.lang.String>
  default

  
  
• fuzzy
  

  find similar file for basis if no dest file

  command-line	-fuzzy <boolean>
  default	false

  
  
• compareDest
  

  also compare destination files relative to DIR

  command-line	-compare_dest <adams.core.base.BaseString> [-compare_dest ...]
  default

  
  
• copyDest
  

  ... and include copies of unchanged files

  command-line	-copy_dest <adams.core.base.BaseString> [-copy_dest ...]
  default

  
  
• linkDest
  

  hardlink to files in DIR when unchanged

  command-line	-link_dest <adams.core.base.BaseString> [-link_dest ...]
  default

  
  
• compress
  

  compress file data during the transfer

  command-line	-compress <boolean>
  default	false

  
  
• compressLevel
  

  explicitly set compression level

  command-line	-compress_level <int>
  default	-1

  
  
• skipCompress
  

  skip compressing files with a suffix in LIST

  command-line	-skip_compress <java.lang.String>
  default

  
  
• cvsExclude
  

  auto-ignore files the same way CVS does

  command-line	-cvs_exclude <boolean>
  default	false

  
  
• filter
  

  add a file-filtering RULE

  command-line	-filter <adams.core.base.BaseString> [-filter ...]
  default

  
  
• exclude
  

  exclude files matching PATTERN

  command-line	-exclude <adams.core.base.BaseString> [-exclude ...]
  default

  
  
• excludeFrom
  

  read exclude patterns from FILE

  command-line	-exclude_from <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• include
  

  include files matching PATTERN

  command-line	-include <adams.core.base.BaseString> [-include ...]
  default

  
  
• includeFrom
  

  read include patterns from FILE

  command-line	-include_from <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• filesFrom
  

  read list of source-file names from FILE

  command-line	-files_from <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• from0
  

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

  command-line	-from0 <boolean>
  default	false

  
  
• protectArgs
  

  no space-splitting; only wildcard special-chars

  command-line	-protect_args <boolean>
  default	false

  
  
• address
  

  bind address for outgoing socket to daemon

  command-line	-address <java.lang.String>
  default

  
  
• port
  

  specify double-colon alternate port number

  command-line	-port <int>
  default	-1

  
  
• sockopts
  

  specify custom TCP options

  command-line	-sockopts <java.lang.String>
  default

  
  
• blockingIO
  

  use blocking I/O for the remote shell

  command-line	-blocking_io <boolean>
  default	false

  
  
• stats
  

  give some file-transfer stats

  command-line	-stats <boolean>
  default	false

  
  
• eightBitOutput
  

  leave high-bit chars unescaped in output

  command-line	-eight_bit_output <boolean>
  default	false

  
  
• humanReadable
  

  output numbers in a human-readable format

  command-line	-human_readable <boolean>
  default	false

  
  
• progress
  

  show progress during transfer

  command-line	-progress <boolean>
  default	false

  
  
• itemizeChanges
  

  output a change-summary for all updates

  command-line	-itemize_changes <boolean>
  default	false

  
  
• outFormat
  

  output updates using the specified FORMAT

  command-line	-out_format <java.lang.String>
  default

  
  
• logFile
  

  log what we're doing to the specified FILE

  command-line	-log_file <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• logFileFormat
  

  log updates using the specified FMT

  command-line	-log_file_format <java.lang.String>
  default

  
  
• passwordFile
  

  read daemon-access password from FILE

  command-line	-password_file <java.lang.String>
  default

  
  
• listOnly
  

  list the files instead of copying them

  command-line	-list_only <boolean>
  default	false

  
  
• bwlimit
  

  limit socket I/O bandwidth

  command-line	-bwlimit <java.lang.String>
  default

  
  
• outbuf
  

  set output buffering to None, Line, or Block (N|L|B)

  command-line	-outbuf <java.lang.String>
  default

  
  
• writeBatch
  

  write a batched update to FILE

  command-line	-write_batch <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• onlyWriteBatch
  

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

  command-line	-only_write_batch <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• readBatch
  

  read a batched update from FILE

  command-line	-read_batch <adams.core.io.PlaceholderFile>
  default	${CWD}

  
  
• protocol
  

  force an older protocol version to be used

  command-line	-protocol <int>
  default	-1

  
  
• iconv
  

  request charset conversion of filenames

  command-line	-iconv <java.lang.String>
  default

  
  
• checksumSeed
  

  set block/file checksum seed (advanced)

  command-line	-checksum_seed <int>
  default	-1

  
  
• ipv4
  

  prefer IPv4

  command-line	-ipv4 <boolean>
  default	false

  
  
• ipv6
  

  prefer IPv6

  command-line	-ipv6 <boolean>
  default	false

  
  
• version
  

  print version number

  command-line	-version <boolean>
  default	false

  
  
• maxTime
  

  time out in seconds, stopping rsync process once exceeded, ignored if less than 1

  command-line	-max_time <int>
  default	-1
  minimum	-1

  
  
• prefixStdOut
  

  The (optional) prefix to use for output from stdout.

  command-line	-prefix-stdout <java.lang.String>
  default

  
  
• prefixStdErr
  

  The (optional) prefix to use for output from stderr.

  command-line	-prefix-stderr <java.lang.String>
  default