Synchronize on RsyncUI

New tasks

Tue, 11 Feb 2025 00:00:00 +0000

A task requires a minimum of a source directory and a destination directory. The destination can be a local attached disk or a remote server.

Always verify the result of a new task before executing. Select “Verify tasks” from the primary Sidebar menu.

Pressing the Enter key will advance to the next field. Pressing the Enter key will automatically add a new task after the last input. Tasks are saved to permanent storage after each entry.

Synchronize data

Mon, 10 Feb 2025 00:00:00 +0000

The Synchronize view runs all or selected tasks in a single operation via shortcut actions or toolbar functions.

For a single task, the first double-click initiates a --dry-run estimate; a second double-click executes the actual run.

Shortcut actions within the Synchronize view:

estimate - shortcut ⌘E estimates all or selected tasks
synchronize - shortcut ⌘R synchronizes all or selected tasks without estimation
- no progress bar during synchronization; a progress bar requires estimation first
abort - shortcut ⌘K aborts and halts any ongoing task

RsyncUI opens the Synchronize view at launch. Click the wand and stars (shortcut ⌘E) on the toolbar to estimate all tasks.

Update tasks

Sun, 09 Feb 2025 00:00:00 +0000

To update a task, select it and press the update button to write changes to storage.

Editing a task

Select the task in the task list. The Inspector opens on the right with tabs for Edit, Parameters, Log Records, and Verify Task. Make your changes in the relevant tab, then press the update button to save.

After changing any task parameter, always verify the task with a --dry-run before executing it. Select “Verify tasks” from the primary Sidebar menu.

Schedule

Thu, 30 Jan 2025 00:00:00 +0000

The schedule function is disabled by default. Please refer to the RsyncUI settings, Monitor and log section to enable it.

Schedules are saved automatically. RsyncUI loads tasks that are due. Tasks scheduled while the Mac was shut down are not loaded. If the Mac sleeps, missed tasks appear in the Schedule view. Missed tasks do not run automatically.

The scheduler uses the Timer library. According to Apple: “A timer that fires after a certain time interval has elapsed, sending a specified message to a target object.” The timer has a strong reference to the run loop on the main thread. If the app goes to sleep, so does the run loop. The timer is active only while RsyncUI is running.

Profiles

Mon, 11 Mar 2024 00:00:00 +0000

Tasks can be organized into profiles. A profile is a named directory where RsyncUI stores its files.

When you create a profile (for example, newprofile), RsyncUI creates a new directory at:

$HOME/.rsyncosx/<macserialnumber>/newprofile

where <macserialnumber> is your Mac’s serial number. All tasks and log files for that profile are stored within this directory.

Why use profiles?

Profiles are useful for separating unrelated sets of tasks — for example, one profile for work backups and another for personal photos. Switching profiles loads only the tasks for that profile, keeping the task list focused.

QuickTask

Mon, 11 Mar 2024 00:00:00 +0000

Use QuickTask to quickly copy or transfer files. QuickTask remembers the last task as defaults; you can clear them via the toolbar. QuickTask works only with remote servers and requires passwordless SSH login.

There are two types of quick tasks:

synchronize - synchronize local files to remote (push data)
syncremote - synchronize remote files to local (pull data)

Trailing Slash Options

Add - adds a trailing slash to both the source and destination
Do not add - does not add a trailing slash, or if added, removes it
Do not check - does not check for a trailing slash on either the source or destination

After entering data, the default task is a --dry-run task. Inspect the result before executing the actual run.

Restore data

Mon, 11 Mar 2024 00:00:00 +0000

RsyncUI restores only from remote servers. For local attached volumes, use Finder. Always restore to a temporary path to avoid overwriting your original data.

How to Restore Files

Filter files: Use the filter field to search for files or directories. The filter shows only filenames containing the search string.

Select files: Choose either a file or a directory to restore.
View the command: Toggle the command switch to see the actual restore command that will be executed.