FreeFileSync

https://freefilesync.org/manual.php
Admin
FreeFileSync is an open-source file synchronization software that compares and synchronizes folders,...
Tokens:25,877
Snippets:121
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start RealTimeSync on Windows Login

Source: https://freefilesync.org/manual.php/index_topic=rts-as-service

Instructions for setting up RealTimeSync to automatically start when a user logs into Windows. This involves creating a shortcut to the RealTimeSync executable and placing it in the Windows autostart folder.

```batch
Create a new shortcut.
Enter the RealTimeSync command line as the target.
Place the shortcut in the Windows autostart folder (accessible via 'shell:startup').
```

--------------------------------

### Example: File Content Comparison Tool

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Examples of how to start file content comparison tools like WinMerge (Windows), opendiff (macOS), and kompare (Ubuntu) using FreeFileSync macros.

```APIDOC
WinMerge (Windows):
  "C:\Program Files (x86)\WinMerge\WinMergeU.exe" "%local_path%" "%local_path2%"

opendiff (macOS, requires Xcode):
  opendiff "%local_path%" "%local_path2%"

kompare (Ubuntu, sudo apt install kompare):
  kompare "%local_path%" "%local_path2%"
```

--------------------------------

### FreeFileSync: Direct Comparison Start

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

Start the comparison process directly by double-clicking on a configuration in FreeFileSync. This bypasses the need for a separate compare action, streamlining the workflow.

```English
Start comparison directly by double-clicking on a configuration
```

--------------------------------

### Example: Open Command Prompt for Selected Item

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Command to open a new command prompt window at the directory of the selected item. Explains the use of 'start' and 'cmd.exe /k'.

```APIDOC
start cmd.exe /k cd /D "%parent_path%"

Note: FreeFileSync hides the console window, so 'start' opens a new window. 'cmd.exe /k' runs the following command without immediately exiting the console. 'cd' navigates to the directory, even if it's on a different volume (/D).
```

--------------------------------

### File Content Comparison Tools

Source: https://freefilesync.org/manual.php/index_topic=all

Examples of how to start external file comparison tools for comparing local files. This includes WinMerge for Windows, opendiff for macOS (requires Xcode), and kompare for Ubuntu.

```Windows
"C:\Program Files (x86)\WinMerge\WinMergeU.exe" "%local_path%" "%local_path2%"
```

```macOS
opendiff "%local_path%" "%local_path2%"
```

```Ubuntu
kompare "%local_path%" "%local_path2%"
```

--------------------------------

### FreeFileSync Main Dialog Overview

Source: https://freefilesync.org/manual.php/index_topic=freefilesync

An overview of the main dialog interface in FreeFileSync, detailing the function of each numbered element for managing comparisons and synchronizations.

```FreeFileSync
1. Change comparison settings
2. Start comparison
3. Include/exclude specific files
4. Change synchronization settings
5. Start synchronization
6. Add folder pairs
7. Select left and right folders
8. Save/load configuration
9. Tree overview panel
10. Synchronization preview
11. Select categories to show on grid
12. Synchronization statistics
```

--------------------------------

### FreeFileSync Main Dialog Overview

Source: https://freefilesync.org/manual.php/index

An overview of the key components and functionalities available in the main FreeFileSync dialog interface, aiding users in navigating and utilizing the software effectively.

```FreeFileSync
1. Change comparison settings
2. Start comparison
3. Include/exclude specific files
4. Change synchronization settings
5. Start synchronization
6. Add folder pairs
7. Select left and right folders
8. Save/load configuration
9. Tree overview panel
10. Synchronization preview
11. Select categories to show on grid
12. Synchronization statistics
```

--------------------------------

### Start RealTimeSync as a Windows Service

Source: https://freefilesync.org/manual.php/index_topic=rts-as-service

Steps to configure RealTimeSync to run as a background service that operates independently of logged-in users. This involves using the Windows Task Scheduler to execute the RealTimeSync command line at system startup and assigning the 'SYSTEM' user account.

```batch
Create a new task in Windows Task Scheduler.
Configure the task to execute the RealTimeSync command line at system startup.
Change the task's user account to 'SYSTEM'.
```

--------------------------------

### FreeFileSync Basic Usage

Source: https://freefilesync.org/manual.php/index_topic=freefilesync

Steps to perform a basic folder comparison and synchronization using FreeFileSync. This involves selecting folders, comparing them, choosing settings, and initiating synchronization.

```FreeFileSync
1. Choose left and right folders.
2. Compare them.
3. Select synchronization settings.
4. Press Synchronize to begin synchronization.
```

--------------------------------

### Start FreeFileSync GUI Configuration

Source: https://freefilesync.org/manual.php/index_topic=all

Launches FreeFileSync in GUI mode with a specified configuration file, initiating comparison if directories exist.

```bash
FreeFileSync "D:\Manual Backup.ffs_gui"
```

--------------------------------

### FreeFileSync Filter Syntax Examples

Source: https://freefilesync.org/manual.php/index_topic=all

Examples of filter phrases used in FreeFileSync for matching files and folders relative to the selected pair. Supports wildcards and multiple entries.

```FreeFileSync Filter
Description | Filter phrase
---|---
Single file (or folder) C:\Source**\file.txt | \file.txt
Single folder C:\Source**\SubFolder | \SubFolder\
All files (and folders) named **thumbs.db** | *\thumbs.db
All files (and folders) starting with the **Z** character | *\z*
All ***.tmp** files (and folders) in C:\Source\**SubFolder | \SubFolder\*.tmp
Files and folders containing **temp** in their path | *temp*
Multiple entries (separated by vertical bar) | *.tmp | *.doc | *.bak
All **sub** folders of the folder pair | *\
Files/folders **inside sub** folders of the folder pair | ?*\?*
All files (**but not folders**) | *:
```

--------------------------------

### RealTimeSync Command Line Usage

Source: https://freefilesync.org/manual.php/index_topic=realtimesync

Demonstrates how to start RealTimeSync with a configuration file or a batch file. It also explains how to integrate RealTimeSync into the operating system's auto-start.

```Command Line
"C:\Program Files\FreeFileSync\RealTimeSync.exe" "D:\Backup Projects.ffs_real"
```

```Command Line
"C:\Program Files\FreeFileSync\RealTimeSync.exe" "D:\MyProject.ffs_batch"
```

--------------------------------

### Starting RealTimeSync with Configuration

Source: https://freefilesync.org/manual.php/index_topic=all

Shows how to launch RealTimeSync with a specific configuration file, enabling it to start monitoring immediately without displaying the main dialog. This is useful for integrating RealTimeSync into the operating system's auto-start mechanisms.

```Batch
"C:\\Program Files\\FreeFileSync\\RealTimeSync.exe" "D:\\Backup Projects.ffs_real"
```

--------------------------------

### Start FreeFileSync GUI Configuration

Source: https://freefilesync.org/manual.php/index_topic=command-line

Launches FreeFileSync in graphical user interface (GUI) mode, immediately starting the comparison process for the specified ffs_gui configuration file, provided all directories exist.

```APIDOC
FreeFileSync "D:\Manual Backup.ffs_gui"
```

--------------------------------

### FreeFileSync Filter Examples: Match Items

Source: https://freefilesync.org/manual.php/index_topic=exclude-files

Provides examples of filter phrases for matching specific files and folders within a folder pair in FreeFileSync. These examples demonstrate various wildcard usages and path specifications.

```FreeFileSync Filter Examples
Description | Filter phrase
---|---
Single file (or folder) C:\Source**\file.txt | \file.txt
Single folder C:\Source**\SubFolder | \SubFolder\
All files (and folders) named thumbs.db | *\thumbs.db
All files (and folders) starting with the Z character | *\z*
All ***.tmp files (and folders) in C:\Source\SubFolder | \SubFolder\\*.tmp
Files and folders containing temp in their path | *temp*
Multiple entries (separated by vertical bar) | *.tmp | *.doc | *.bak
All sub folders of the folder pair | *\
Files/folders inside sub folders of the folder pair | ?*\?*
All files (but not folders) | *:
```

--------------------------------

### Example: Preview Files with Quick Look on macOS

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Command to preview a selected file using the Quick Look feature on macOS.

```APIDOC
qlmanage -p "%local_path%"
```

--------------------------------

### FreeFileSync Basic Usage

Source: https://freefilesync.org/manual.php/index

The fundamental steps to perform a file synchronization using FreeFileSync. This involves selecting folders, comparing their contents, configuring synchronization settings, and initiating the synchronization process.

```FreeFileSync
1. Choose left and right folders.
2. Compare them.
3. Select synchronization settings.
4. Press Synchronize to begin synchronization.
```

--------------------------------

### FreeFileSync Command Line Overview

Source: https://freefilesync.org/manual.php/index_topic=command-line

Provides a general overview of FreeFileSync's command line capabilities. To access the syntax overview, navigate to the installation directory in the console and execute the help command.

```APIDOC
FreeFileSync -h
FreeFileSync --help
```

--------------------------------

### Run RealTimeSync Command Line

Source: https://freefilesync.org/manual.php/index_topic=rts-as-service

This is the general command line format for executing RealTimeSync. It requires the path to the RealTimeSync executable and the configuration file ('.ffs_real' or '.ffs_batch').

```bash
"<FreeFileSync installation folder>\RealTimeSync.exe" <path to *.ffs_real or *.ffs_batch file>"
```

```bash
"C:\Program Files\FreeFileSync\RealTimeSync.exe" "D:\Backup Projects.ffs_real"
```

--------------------------------

### SFTP/FTP Connection Configuration

Source: https://freefilesync.org/manual.php/index_topic=ftp-setup

FreeFileSync supports native synchronization with SFTP and FTP. Users can configure connection and channel counts to improve performance when reading large folder hierarchies over high-latency connections. It's advised to start with low numbers and test combinations for optimal speed, restarting FreeFileSync before measuring performance.

```APIDOC
SFTP/FTP Setup:
  - Enter login information in the cloud folder selection dialog.

Performance Tuning:
  - Increase connection and channel count for faster folder reading on high-latency connections.
  - Formula: Folder reading time reduced by N x M with N connections and M channels.
  - Example: 10 connections with 2 channels each can yield 20x faster folder reading.

Considerations:
  - Additional connections/channels take time; too many can slow down small folder scans.
  - SFTP servers have limits on connections/channels; exceeding them may cause server unresponsiveness.
  - Extra SFTP channels are primarily used during folder reading, not synchronization.
  - Enable compression for slow connections with uncompressed data; disable if connection is fast or data is compressed to avoid CPU overhead.

Advice:
  - Start with low numbers and test combinations.
  - Restart FreeFileSync before measuring SFTP speed due to connection reuse.
```

--------------------------------

### FreeFileSync Batch File Macro Example

Source: https://freefilesync.org/manual.php/index_topic=macros

Example of how to use temporary environment variables in a batch file to dynamically set target folders for FreeFileSync synchronization.

```batch
set MyVar=C:\Target
"C:\Program files\FreeFileSync\FreeFileSync.exe" C:\SyncJob.ffs_batch
```

--------------------------------

### Logging Changed Files and Directories (Windows)

Source: https://freefilesync.org/manual.php/index_topic=realtimesync

Example of how to log file and directory changes using environment variables provided by RealTimeSync on Windows.

```Batch
echo %change_action% %change_path% >> %csidl_Desktop%\log.txt
```

--------------------------------

### FreeFileSync Filter Example: Complex Rules with Exceptions

Source: https://freefilesync.org/manual.php/index_topic=exclude-files

Illustrates how to handle complex filter requirements in FreeFileSync by using two folder pairs with different local filters to manage exceptions.

```FreeFileSync Filter Examples
Exclude a sub folder except for *.txt files by using two folder pairs:
C:\Source <—> D:\Target local exclude filter: \SubFolder\
C:\Source <—> D:\Target local include filter: \SubFolder\\*.txt
```

--------------------------------

### SFTP and FTP Setup in FreeFileSync

Source: https://freefilesync.org/manual.php/index_topic=all

Details how to set up SFTP and FTP synchronization in FreeFileSync by entering login information. Addresses issues with file modification times by suggesting 'Compare by File Size' or two-way sync.

```English
Feature: SFTP and FTP Synchronization
Setup:
Enter login information in the cloud folder selection dialog.
Workaround for modification time issues:
- Compare by File Size
- Two-way sync with newer dates copied back from the server.
```

--------------------------------

### Open Command Prompt for Selected Item

Source: https://freefilesync.org/manual.php/index_topic=all

Command to open a new command prompt window at the directory of the selected item. Explains the use of 'start cmd.exe /k cd /D'.

```Windows
start cmd.exe /k cd /D "%parent_path%"
```

--------------------------------

### Merge Multiple FreeFileSync Configurations

Source: https://freefilesync.org/manual.php/index_topic=all

Combines multiple FreeFileSync configuration files into a single session, creating multiple folder pairs and starting in GUI mode.

```bash
FreeFileSync "D:\Manual Backup.ffs_gui" "D:\Backup Projects.ffs_batch"
```

--------------------------------

### Logging Changed Files and Directories (Linux/macOS)

Source: https://freefilesync.org/manual.php/index_topic=realtimesync

Example of how to log file and directory changes using environment variables provided by RealTimeSync on Linux and macOS.

```Shell
echo $change_action $change_path >> ~/Desktop/log.txt
```

--------------------------------

### FreeFileSync: Direct Synchronization Start

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

Initiate synchronization directly in FreeFileSync without needing to click 'Compare' first. This shortcut speeds up the synchronization process when the comparison results are already known or not required.

```English
Start synchronization directly without clicking on compare first
```

--------------------------------

### Pass List of Selected Files to Script

Source: https://freefilesync.org/manual.php/index_topic=all

Example of how to pass a list of selected file paths as command-line arguments to a script. Notes the importance of quoting paths with spaces.

```Windows
C:\my-script.cmd "%local_path**s** %"
```

--------------------------------

### Example: Copy Item Path to Clipboard

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Command to copy the full path of the selected item to the clipboard, serving as an alternative to CTRL + C.

```APIDOC
echo %item_path%| clip
```

--------------------------------

### Scheduling FreeFileSync Batch Jobs on Windows

Source: https://freefilesync.org/manual.php/index_topic=all

Detailed guide on using Windows Task Scheduler to run FreeFileSync batch jobs. Covers setting the program, arguments, and handling paths with spaces.

```Windows
taskschd.msc

Program/script: FreeFileSync.exe
Add arguments: "D:\Backup Projects.ffs_batch"

Note: Use quotation marks around paths with spaces.
```

--------------------------------

### FreeFileSync Filter Example: Exclude Empty Folders

Source: https://freefilesync.org/manual.php/index_topic=exclude-files

Explains how to exclude empty folders in FreeFileSync by setting the include filter to match all files, preventing the creation of empty directories during synchronization.

```FreeFileSync Filter Examples
Set *: as include filter to match all files, but not folders. During synchronization some excluded folders will still be created if needed, but only if they contain at least one non-excluded item, that is, when they are not empty.
```

--------------------------------

### Example: Pass Selected Files to Script

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Command to pass a list of selected file paths as command line arguments to a batch script.

```APIDOC
C:\my-script.cmd "%local_paths%"
```

--------------------------------

### Starting RealTimeSync with Batch File

Source: https://freefilesync.org/manual.php/index_topic=all

Demonstrates launching RealTimeSync by passing an ffs_batch file as the first argument. RealTimeSync will automatically convert this into an ffs_real configuration, applying default settings such as a 10-second idle time before executing the command.

```Batch
"C:\\Program Files\\FreeFileSync\\RealTimeSync.exe" "D:\\MySyncJob.ffs_batch"
```

--------------------------------

### Example: Show File in Windows Explorer

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Command to display the selected file in Windows Explorer. Includes a note on handling exit codes for FreeFileSync error reporting.

```APIDOC
explorer.exe /select, "%local_path%" & exit 0

Note: Explorer.exe does not set an exit code, but FreeFileSync will show an error message if it does not find exit code = 0 ("Success"). To mitigate, append (&) command exit 0 to set the exit code explicitly.
```

--------------------------------

### Example: Write File Paths to Text File

Source: https://freefilesync.org/manual.php/index_topic=external-applications

Command to append the full paths of selected items to a text file named 'file_list.txt' on the desktop.

```APIDOC
echo %item_path% >> %csidl_Desktop%\file_list.txt
```

--------------------------------

### RealTimeSync Configuration Example

Source: https://freefilesync.org/manual.php/index_topic=all

Demonstrates how to configure RealTimeSync to automatically synchronize when a USB stick is inserted. It highlights using the volume name to avoid issues with changing drive letters and specifies the directories to monitor and the command to execute.

```APIDOC
RealTimeSync Configuration:
  - Monitor Directory: "_\Data"
  - Command Line: "C:\\Program Files\\FreeFileSync\\FreeFileSync.exe" "/minimize" "/silent" "D:\\Backup Projects.ffs_batch"
  - Trigger: "When directory becomes available"
```

--------------------------------

### Linux/macOS Cron Job Setup for FreeFileSync

Source: https://freefilesync.org/manual.php/index_topic=schedule-batch-jobs

This snippet demonstrates how to set up a cron job to execute a FreeFileSync batch job. It includes the path to the FreeFileSync executable and the batch job file, along with macOS-specific executable location.

```bash
/opt/FreeFileSync/FreeFileSync "/home/zenju/Backup Projects.ffs_batch"

```

```bash
/Applications/FreeFileSync.app/Contents/MacOS/FreeFileSync "/home/zenju/Backup Projects.ffs_batch"

```

--------------------------------

### Logging Changed Files (Windows)

Source: https://freefilesync.org/manual.php/index_topic=all

A command-line example for Windows that logs file changes detected by RealTimeSync. It uses environment variables %change_action% and %change_path% to record the type of change and the affected file path into a log file on the desktop.

```Batch
echo %change_action% %change_path% >> %csidl_Desktop%\\log.txt
```

--------------------------------

### Logging Changed Files (Linux/macOS)

Source: https://freefilesync.org/manual.php/index_topic=all

A command-line example for Linux and macOS that logs file changes detected by RealTimeSync. It utilizes environment variables $change_action and $change_path to append the change type and file path to a log file in the user's desktop directory.

```Shell
echo $change_action $change_path >> ~/Desktop/log.txt
```

--------------------------------

### FreeFileSync Tips and Tricks

Source: https://freefilesync.org/manual.php/index_topic=all

A collection of useful tips and tricks for using FreeFileSync more efficiently, including context menu operations, batch configuration, drag-and-drop usage, and view filter saving.

```English
Tips & Tricks:
- Change settings with right-click context menu.
- Select multiple configurations.
- Start comparison by double-clicking.
- Run partial synchronization on selected files.
- Synchronize multiple folder pairs with different configurations.
- Start synchronization directly.
- Move windows by clicking and holding free areas.
- Open batch configurations via Windows Explorer context menu.
- Drag and drop folders from Windows Explorer.
- Copy selected files to an alternate folder.
- Use volume names instead of drive letters.
- Show thumbnail icons via column header context menu.
- Save current view filter selection as default.
- Remove local settings from folder pairs.
- Remove obsolete paths using mouse hover and Delete key.
- Select time span for files via date column context menu.
- Confirm dialogs by double-clicking variants.
- Rename multiple files simultaneously (context menu or F2).
```

--------------------------------

### FreeFileSync: Multi-Configuration Selection

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

This tip explains how to select multiple configurations simultaneously within FreeFileSync, allowing for more efficient management and application of different synchronization settings.

```English
Select multiple configurations at a time
```

--------------------------------

### Command Line Tool for Volume GUIDs

Source: https://freefilesync.org/manual.php/index_topic=variable-drive-letters

The 'mountvol' command-line tool can be used to list all volume GUIDs for mounted drives on the system, which is helpful for identifying the unique identifier for a specific drive partition.

```APIDOC
mountvol
```

--------------------------------

### FreeFileSync Command Line Help

Source: https://freefilesync.org/manual.php/index_topic=all

Displays the syntax overview for FreeFileSync command line usage.

```bash
FreeFileSync -h
FreeFileSync --help
```

--------------------------------

### SFTP/FTP Comparison Workaround

Source: https://freefilesync.org/manual.php/index_topic=ftp-setup

If an SFTP server modifies file modification times to the current time, FreeFileSync suggests using 'Compare by File Size' as a workaround. Alternatively, a two-way synchronization setup can copy newer files back from the server.

```APIDOC
Workaround for Modification Time Issues:
  - If SFTP server sets file modification times to current time:
    - Option 1: Use 'Compare by File Size'.
    - Option 2: Set up 'Two way' synchronization and copy newer files back from the server.
```

--------------------------------

### FreeFileSync Variable Drive Letter Options

Source: https://freefilesync.org/manual.php/index_topic=variable-drive-letters

FreeFileSync offers two methods to ensure consistent synchronization targets despite changing drive letters: using volume names or volume GUIDs. Volume names are user-defined labels for drives, while volume GUIDs are system-assigned unique identifiers.

```APIDOC
Option 1: Specify a path by using a unique volume name.
Example: [Backup-Disk]\folder

Option 2: Refer to a disk volume by its unique GUID.
Example: \\?\Volume{01234567-89ab-cdef-0123-456789abcdef}\folder
```

--------------------------------

### Configure SFTP for Best Performance

Source: https://freefilesync.org/manual.php/index_topic=all

Provides guidance on optimizing SFTP performance by increasing connection and channel counts. Discusses the trade-offs, server limits, and the impact of compression.

```English
Feature: SFTP Performance Optimization
Configuration:
- Increase connection count
- Increase channel count
Performance Gain: N connections x M channels = N*M times faster folder reading.
Considerations:
- Additional connections/channels take time to create.
- Too many connections/channels can slow down small folder scans.
- SFTP servers have connection/channel limits.
- Additional channels are used during folder reading, not synchronization.
Compression:
- Enable for slow connections with uncompressed data.
- Disable for fast connections or already compressed data to avoid CPU overhead.
```

--------------------------------

### FreeFileSync: Explorer Context Menu Integration

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

Open batch configurations for editing directly from the Windows Explorer context menu when using FreeFileSync. This integrates the software more seamlessly into the operating system.

```English
Open a batch configuration for edit via the Windows Explorer context menu
```

--------------------------------

### FreeFileSync Expert Settings Explained

Source: https://freefilesync.org/manual.php/index_topic=expert-settings

This section explains the purpose and functionality of key expert settings in FreeFileSync's GlobalSettings.xml. It covers FileTimeTolerance, RunWithBackgroundPriority, LockDirectoriesDuringSync, and VerifyCopiedFiles.

```APIDOC
FileTimeTolerance:
  Description: By default, file modification times are allowed to have a 2-second difference to be considered equal. This is necessary for file systems like FAT/FAT32 that store file times with only 2-second precision.
  Parameter: Seconds (integer) - The allowed time difference in seconds.

RunWithBackgroundPriority:
  Description: Lowers FreeFileSync's file access priority to reduce slowdown for other applications accessing the same data, at the cost of slower synchronization speed.
  Parameter: Enabled (boolean) - Set to true to enable background priority.

LockDirectoriesDuringSync:
  Description: Prevents multiple FreeFileSync instances from reading/writing the same files simultaneously by using lock files (sync.ffs_lock). Ensures only one synchronization runs against a folder at a time, queuing others. Useful for network synchronization with multiple users.
  Parameter: Enabled (boolean) - Set to true to enable directory locking.

VerifyCopiedFiles:
  Description: If active, FreeFileSync performs a binary comparison of source and target files after copying to report verification errors. This can double file copy times and does not guarantee data integrity before copying or account for corruption hidden by buffers.
  Parameter: Enabled (boolean) - Set to true to enable binary file verification.
```

--------------------------------

### FreeFileSync Symbolic Link Handling

Source: https://freefilesync.org/manual.php/index_topic=all

Explains how FreeFileSync handles symbolic links (symlinks, soft links), including options to include them during directory scanning. It details the 'Follow' and 'As link' handling methods and lists various items FreeFileSync considers symbolic links.

```APIDOC
Symbolic Link Handling Options:
1. Follow:
   - Treat symbolic links as the object they point to.
   - Links to directories are traversed like ordinary directories.
   - Target of the link is copied during synchronization.
2. As link:
   - Include the symbolic link object directly.
   - Links to directories are not traversed.
   - The link object itself is copied during synchronization.

Items considered 'symbolic links' by FreeFileSync:
- File system symbolic links
- Volume mount points (NTFS)
- Junction points (NTFS)
- WSL symlinks
- Google Drive shortcuts

Note:
- Windows: Copying symbolic links requires FreeFileSync to be started with administrator rights.
```

--------------------------------

### Cron Job Output Redirection for Troubleshooting

Source: https://freefilesync.org/manual.php/index_topic=schedule-batch-jobs

This example demonstrates how to redirect both standard output and error streams of a cron job to a log file, aiding in troubleshooting by capturing execution details and errors.

```bash
/opt/FreeFileSync/FreeFileSync "/home/zenju/Backup Projects.ffs_batch" >> /home/zenju/Desktop/cron_log.txt 2>&1

```

--------------------------------

### FreeFileSync Symbolic Link Handling

Source: https://freefilesync.org/manual.php/index_topic=comparison-settings

Describes how FreeFileSync handles symbolic links (symlinks, soft links, volume mount points, junction points, WSL symlinks, Google Drive shortcuts). Users can choose to 'Follow' links or treat them 'As link'.

```APIDOC
Symbolic Link Handling:

Options:
1. Follow:
   - Treat symbolic links like the objects they point to.
   - Links pointing to directories are traversed.
   - Target of each link is copied during synchronization.

2. As link:
   - Include the symbolic link object directly.
   - Links pointing to directories are not traversed.
   - Link object itself is copied during synchronization.

Notes:
- FreeFileSync considers file system symbolic links, volume mount points (NTFS), junction points (NTFS), WSL symlinks, and Google Drive shortcuts as symbolic links.
- On Windows, copying symbolic links requires FreeFileSync to be started with administrator rights.
```

--------------------------------

### Cron Scheduling Intervals

Source: https://freefilesync.org/manual.php/index_topic=schedule-batch-jobs

Examples of cron syntax for scheduling tasks at different intervals: every hour, every day at a specific time, and custom intervals with time ranges and days of the week.

```cron
# Run every hour
0 * * * *

```

```cron
# Run daily at 17:00
0 17 * * *

```

```cron
# Run every 10 minutes from 9:00 to 17:00 on Monday and Friday
*/10 9-17 * * mon,fri

```

--------------------------------

### Preview Files using Quick Look on macOS

Source: https://freefilesync.org/manual.php/index_topic=all

Command to preview a file using the Quick Look functionality on macOS.

```macOS
qlmanage -p "%local_path%"
```

--------------------------------

### Configuring FreeFileSync Batch Jobs

Source: https://freefilesync.org/manual.php/index_topic=all

Steps to create and configure FreeFileSync batch jobs for automated synchronization. Includes options for minimizing the progress dialog, auto-closing, and error handling.

```FreeFileSync
Menu → File → Save as a batch job...

Enable: Run minimized
Enable: Auto-Close

Handle errors: Ignore errors OR Cancel
```

--------------------------------

### FreeFileSync: Drag and Drop Folder Pairs

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

Populate folder pairs in FreeFileSync by dragging and dropping two folders at a time from Windows Explorer. This simplifies the process of setting up synchronization tasks.

```English
Drag and drop two folders at a time from Windows Explorer to fill a folder pair in one go
```

--------------------------------

### Use Custom GlobalSettings.xml

Source: https://freefilesync.org/manual.php/index_topic=all

Specifies a different GlobalSettings.xml file for FreeFileSync to use, overriding the default settings.

```bash
FreeFileSync "D:\Different GlobalSettings.xml"
```

--------------------------------

### FreeFileSync GlobalSettings.xml Configuration

Source: https://freefilesync.org/manual.php/index_topic=expert-settings

This snippet shows the structure of the GlobalSettings.xml file used for FreeFileSync's expert settings. It includes parameters for file time tolerance, background priority, directory locking, and file verification.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<FreeFileSync XmlType="GLOBAL">
<General>
<FileTimeTolerance Seconds="2"/>
<RunWithBackgroundPriority Enabled="false"/>
<LockDirectoriesDuringSync Enabled="true"/>
<VerifyCopiedFiles Enabled="false"/>
</General>
</FreeFileSync>
```

--------------------------------

### External Application Launch Commands

Source: https://freefilesync.org/manual.php/index_topic=all

These commands demonstrate how to configure FreeFileSync to open external applications for file browsing or other actions. They include platform-specific commands for Windows, macOS, and Linux, utilizing local path macros.

```Shell
Windows: explorer.exe /select, "%local_path%" & exit 0
```

```Shell
macOS: open -R "%local_path%"
```

```Shell
Linux: xdg-open "$(dirname "%local_path%")"
```

--------------------------------

### FreeFileSync Global Settings Configuration

Source: https://freefilesync.org/manual.php/index_topic=all

This XML snippet shows expert settings for FreeFileSync that can be manually configured in the GlobalSettings.xml file. These settings control file time tolerance, background priority, directory locking, and file verification during synchronization.

```XML
<?xml version="1.0" encoding="UTF-8"?>
<FreeFileSync XmlType="GLOBAL">
<General>
<FileTimeTolerance Seconds="2"/>
<RunWithBackgroundPriority Enabled="false"/>
<LockDirectoriesDuringSync Enabled="true"/>
<VerifyCopiedFiles Enabled="false"/>
</General>
</FreeFileSync>
```

--------------------------------

### Handling Variable Drive Letters in FreeFileSync

Source: https://freefilesync.org/manual.php/index_topic=all

FreeFileSync offers two primary methods to manage external drives that may receive different drive letters on each connection. You can use unique volume names or unique GUIDs to ensure your synchronization paths remain consistent.

```FreeFileSync Configuration
Option 1: Use Volume Name
Specify a path using a unique volume name instead of a drive letter.
Example: [Backup-Disk]\folder replaces E:\folder if the volume name of the USB stick in drive E:\ is "Backup-Disk".

Option 2: Use Volume GUID
Refer to a disk volume by its unique GUID.
Example: \\?\Volume{01234567-89ab-cdef-0123-456789abcdef}\folder
To find volume GUIDs, run the 'mountvol' command line tool.
```

--------------------------------

### FreeFileSync: Window Movement

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

Move FreeFileSync windows by clicking on a free area within the window and holding the mouse button. This provides an alternative method for window management.

```English
Move a window by clicking on a free area and holding the mouse button
```

--------------------------------

### FreeFileSync Comparison Variants Explained

Source: https://freefilesync.org/manual.php/index_topic=all

Details the three primary comparison variants in FreeFileSync: 'File time and size', 'File content', and 'File size'. Each variant is explained with its criteria for file equality, use cases, and the resulting file categories (e.g., left only, right only, equal, different date/content/size).

```APIDOC
Comparison Variant: File time and size
Criteria: Modification time and file size must match.
Use Case: Synchronizing files with a backup location.
Categories:
  - File exists on one side only (left only, right only)
  - File exists on both sides:
    - Different date (left newer, right newer)
    - Same date (equal, conflict - same date, different size)

Comparison Variant: File content
Criteria: Files must have identical content (bit-wise identical).
Use Case: Consistency checks, fallback for unreliable modification times (e.g., some mobile phones, legacy FTP servers).
Limitations: Slowest variant.
Categories:
  - File exists on one side only (left only, right only)
  - File exists on both sides (equal, different content)

Comparison Variant: File size
Criteria: Files must have the same file size.
Use Case: When modification times are unavailable or unreliable (e.g., MTP, FTP), and content comparison is too slow.
Limitations: Files with the same size may have different content.
Categories:
  - File exists on one side only (left only, right only)
  - File exists on both sides (equal, different size)
```

--------------------------------

### Run FreeFileSync Batch Job

Source: https://freefilesync.org/manual.php/index_topic=all

Executes a FreeFileSync synchronization task using a specified batch configuration file.

```bash
FreeFileSync "D:\Backup Projects.ffs_batch"
```

--------------------------------

### Show File in Windows Explorer

Source: https://freefilesync.org/manual.php/index_topic=all

Command to open Windows Explorer and select a specific file. Includes a note on handling exit codes for FreeFileSync.

```Windows
explorer.exe /select, "%local_path%" & exit 0
```

--------------------------------

### Scheduling RealTimeSync as a Windows Service

Source: https://freefilesync.org/manual.php/index_topic=all

Instructions for setting up RealTimeSync to run automatically as a background service on Windows using the Task Scheduler. This ensures monitoring is active even when no user is logged in.

```Windows
taskschd.msc
```

--------------------------------

### RealTimeSync Command Line Usage

Source: https://freefilesync.org/manual.php/index_topic=all

The basic command line structure for RealTimeSync to monitor and synchronize files. It requires the path to the RealTimeSync executable and a .ffs_real or .ffs_batch file.

```Batch
"C:\Program Files\FreeFileSync\RealTimeSync.exe" "D:\Backup Projects.ffs_real"
```

--------------------------------

### Scheduling FreeFileSync Batch Jobs on Linux

Source: https://freefilesync.org/manual.php/index_topic=all

Information on scheduling FreeFileSync batch jobs using Linux Cron Jobs.

```Linux
Cron Job
```

--------------------------------

### FreeFileSync Advanced Filter Configuration

Source: https://freefilesync.org/manual.php/index_topic=all

Demonstrates using two folder pairs with different local filters to achieve complex exclusion rules, such as excluding a subfolder except for specific file types.

```FreeFileSync Filter
C:\Source <—> D:\Target local **exclude** filter: \SubFolder\
C:\Source <—> D:\Target local **include** filter: \SubFolder\*.txt
```

--------------------------------

### FreeFileSync: Multiple Folder Pair Synchronization

Source: https://freefilesync.org/manual.php/index_topic=tips-and-tricks

Synchronize multiple folder pairs simultaneously in FreeFileSync, each with its own distinct configuration. This enables complex synchronization tasks to be managed efficiently.

```English
Synchronize multiple folder pairs at a time with different configurations
```

--------------------------------

### Scheduling FreeFileSync Batch Jobs on macOS

Source: https://freefilesync.org/manual.php/index_topic=all

Information on scheduling FreeFileSync batch jobs using macOS Automator and Calendar.

```macOS
Automator
Calendar
```
Tokens:
Raw