Getting Started

• 1: Important
• 2: Limitations
• 3: Getting started

1 - Important

Before using RsyncUI, review these key notes.

The interface may feel challenging if you are new to the rsync command-line tool. RsyncUI focuses on making rsync easier to use, not on teaching every rsync concept.

Not a backup tool for everyone

RsyncUI specializes in synchronization and file management. The command-line tool rsync performs the actual work. If you need a full system backup tool that creates complete disk images, RsyncUI is not the right fit.

Delete parameter

The --delete parameter keeps the destination in exact sync with the source. When a file is removed from the source, rsync removes it from the destination. With --delete disabled, the destination will accumulate files removed from the source.

Know whether --delete is on or off before you run; it controls whether the destination mirrors the source.

Add and remove the delete parameter

Select Parameters tab within the Tasks menu, select the task, and toggle Add –delete parameter (ON means included). After toggling, remember to update the task.

• if ON, the –delete parameter is included
• if OFF, the –delete parameter is removed

Always verify new task

Before running a new task, perform a --dry-run and inspect the result. If you set an empty source and --delete is enabled, rsync will delete all files in the destination.

Temporary halt tasks

You can temporarily halt a task. In the Synchronize view, right-click a task to halt it; the task keeps its type when resumed. Halted tasks display a red stop sign in the action column.

Two options to save updates to data

These options apply to the data synchronized by RsyncUI. By enabling either of these options, you can save changes to data, such as deletions or updates, prior to a synchronization task.

2 - Limitations

There are a few limitations to keep in mind. None will corrupt data, but they may interrupt synchronization.

Long running tasks and sleep

When the Mac sleeps, RsyncUI tasks stop. An active rsync process does not prevent the Mac from sleeping. If sleep occurs during synchronization, rsync will likely error and stop. Restart the task in RsyncUI; rsync will resume from where it left off.

If this happens, RsyncUI will not log the run because it only logs after receiving a termination signal from rsync.

The above will also be true if you are using the Calendar function.

The Schedule

A note about scheduling: the scheduler relies on the Timer library. See Schedule for details.

The scheduler automates chosen tasks while RsyncUI is running and you are logged in. If the Mac sleeps and a scheduled task is missed, it will be listed in the Schedule view after the Mac wakes.

Aborting Tasks

RsyncUI launches the rsync command-line tool and monitors it.

You can abort a task at any time. Allow the abort to complete before starting another task; otherwise RsyncUI may become unresponsive.

3 - Getting started

New users should read Important first, then see Latest version of rsync for installation guidance.

Concealing Actions

Concealing actions reduces menu clutter and keeps focus on common tasks.

Use ⌘S or the Task main menu to show or hide Charts, Quick task, log view, and other options that are hidden by default. The primary Sidebar menu is also context-sensitive.

New Tasks and Verification

RsyncUI can synchronize data to:

• local attached disk
• remote servers on the Internet or local LAN
  • require passwordless login by ssh-key

Local attached disk

To sync to a local attached disk, connect the disk, add source and destination, and you are ready for your first task.

Remote server and passwordless login

To sync to a remote server (internet or LAN), set up passwordless SSH. With SSH keys in place, add source, destination, login id, and server name and you can synchronize. Without passwordless login, additional setup is required.

Verify tasks

Select the task and press the play button on the toolbar. Executing the play button includes the –dry-run parameter for rsync, which is an estimation run.

Aborting tasks

RsyncUI executes the command-line tool rsync and monitors progress and termination.

You can abort a task at any time. Allow the abort to complete and cleanup to finish before starting another task; otherwise the app may become unresponsive.

Errors in tagging data

Sometimes you may get the error:

There are errors in tagging data
for synchronize ID XXXX
Most likely number of rows
> 20 lines and no data to synchronize

The message confirms that all data appears synchronized. RsyncUI bases this on rsync summary output. If there are more than ~20 lines yet no data tagged for sync, the message reminds you to double-check. To verify, run the task without an estimate.

Version 3.x of rsync:

Version openrsync:

The Sidebar Menu options

Three Sidebar menu options depend on task properties. If any task meets the requirement, the option appears.

• Snapshot: available only for snapshot tasks
  • requires rsync 3.x
• Restore: available for synchronize and snapshot tasks where the destination is on a remote server
  • also available for openrsync, but only for synchronize tasks
• Verify remote: available for synchronize tasks where the destination is on a remote server
  • requires rsync 3.x