-
-
-
-
\ No newline at end of file
diff --git a/FreeFileSync/Build/Help/html/Macros.html b/FreeFileSync/Build/Help/html/Macros.html
deleted file mode 100644
index 6c4a0c4d..00000000
--- a/FreeFileSync/Build/Help/html/Macros.html
+++ /dev/null
@@ -1,240 +0,0 @@
-
-
-
-
-
- Macros
-
-
-
-
Macros
-
-
- All directory paths may contain macros that are expanded during
- synchronization. Begin and end of each macro are marked by a % character. In addition to special macros
- handling time and date, the operating system's environment variables may also be used.
-
- Note: Most macros listed here also have a variant for public folders, e.g.
- %csidl_MyMusic% has %csidl_PublicMusic%.
-
-
-
-
-
- Hint: You can add a great amount of flexibility to a ffs_batch configuration file
- by creating new temporary environment variables in a bat or cmd file that are evaluated by FreeFileSync at runtime:
-
-
-
-
Example:
-
- The FreeFileSync batch file C:\SyncJob.ffs_batch contains
- macro %MyVar% instead of an absolute target folder and is invoked by a cmd file:
-
-
-
-
set MyVar=C:\Target
- "C:\Program files\FreeFileSync\FreeFileSync.exe" C:\SyncJob.ffs_batch
-
::%MyVar% is resolved as C:\Target during synchronization
-
-
-
-
-
- Note
- Temporary environment variables created with the set command are only valid if the synchronization is started by calling the
- FreeFileSync executable directly. Using start /wait would create a new program context without these temporary variables.
-
-
-
\ No newline at end of file
diff --git a/FreeFileSync/Build/Help/html/RealtimeSync.html b/FreeFileSync/Build/Help/html/RealtimeSync.html
deleted file mode 100644
index fcbcc753..00000000
--- a/FreeFileSync/Build/Help/html/RealtimeSync.html
+++ /dev/null
@@ -1,121 +0,0 @@
-
-
-
-
-
- RealTimeSync - Automated Synchronization
-
-
-
-
-
- Automated Synchronization
-
-
-
- The primary purpose of RealTimeSync is to execute a command line each time it detects changes in one of the monitored directories
- or when a directory becomes available (e. g. insert of a USB-stick). Usually this command line will trigger a FreeFileSync batch job.
-
-
-
-
Example: Real time synchronization - in combination with FreeFileSync
-
- Start RealTimeSync.exe located in FreeFileSync's installation directory and
- enter all folders you want to monitor. Instead of doing this manually you can import a ffs_batch
- file via Menu → File → Open. This not only extracts all directories relevant for synchronization
- but also sets up the command line to execute the ffs_batch file each time changes are detected.
- Now press Start to begin monitoring.
-
-
-
-
-
-
-
- Note
-
-
The command should notblock progress. If you call a FreeFileSync batch job, make
- sure it does not show any popup windows. See notes in Command Line Usage.
-
-
-
RealTimeSync will skip showing the main dialog and begin monitoring immediately if
- you pass a ffs_real configuration file or a FreeFileSync ffs_batch file as first
- command line argument to RealTimeSync.exe. This helps you integrate RealTimeSync into your operating system's auto start:
-
RealTimeSync is not tied to starting FreeFileSync. It can also be used in other scenarios, like sending an email whenever a certain directory is modified.
-
-
-
-
-
-
Example: Automatic synchronization when a USB stick is inserted
-
- Save a ffs_batch configuration in the USB stick's root directory,
- e.g. H:\ and let FreeFileSync run it when the stick is mounted.
- But instead of hard coding the USB drive letter H:\ (which may change occasionally),
- refer to the USB stick via its volume name instead.
-
- Configure RealTimeSync as follows:
-
-
-
-
- "Backup" is the volume name of the USB stick in our example.
-
-
-
- Whenever directory H:\Data becomes available, RealTimeSync executes the command line which starts the batch job located
- on the stick. RealTimeSync will also trigger each time files are modified in H:\Data.
-
-
-
- Note
- The full path of the last changed file and the action that triggered the
- change notification (create, update or delete) are written
- to the environment variables %change_path% and %change_action%.
-
-
-
-
-
Example: Log names of changed files and directories (Windows)
-
-
- Show which file or directory has triggered a change. Enter command line:
-
- Note
- When RealTimeSync executes a Windows batch file (bat or cmd) a black console window is shown. You can hide it using the Visual Basic script
- HideConsole.vbs located in FreeFileSync's installation directory:
-
If multiple changes happen at the same time, only the path of the first file is written to variable %changed_file%.
-
While RealTimeSync is executing the command line, monitoring for changed files is deliberately inactive.
-
-
- The command line usually starts a synchronization task using FreeFileSync which naturally leads to additional file change notifications.
- Therefore the RealTimeSync change detection has to be deactivated to not go into an endless loop.
- On the other hand it is not likely that changes (other than those from FreeFileSync) happen in first place since RealTimeSync runs the command line only after a user-specified idle time has passed.
- This makes sure the monitored folders are not in heavy use. In any case, files changed during the execution of FreeFileSync will be synchronized the next time FreeFileSync runs.
-
-
-
\ No newline at end of file
diff --git a/FreeFileSync/Build/Help/html/Versioning.html b/FreeFileSync/Build/Help/html/Versioning.html
deleted file mode 100644
index e3ca9bbd..00000000
--- a/FreeFileSync/Build/Help/html/Versioning.html
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
-
-
-
- File Versioning
-
-
-
-
File Versioning
-
-
- When you need to preserve files that have been deleted or overwritten it's
- often sufficient to select Recycle bin in synchronization
- settings. However this is only available for local drives and offers
- little control on how to store and how long to keep the files.
- FreeFileSync therefore has an additional option, Versioning.
-
-
-
-
1. Keep only the most recent versions
-
-
- In synchronization settings set deletion handling to Versioning and naming convention to
- Replace. Deleted files will be moved to the specified folder
- without any decoration and will replace already existing older
- versions.
-
-
-
-
-
2. Keep all versions of old files
-
-
- Set deletion handling to Versioning
- and naming convention to Time stamp. FreeFileSync will move
- deleted files into the provided folder and add a time stamp to each
- file name. The structure of the synchronized folders is preserved so
- that old versions of a file can be conveniently accessed via a file
- browser.
-
-
-
- Example:
- A file Folder\File.txt was updated three times and old versions were moved to folder C:\Revisions
-
- With naming convention Replace
- it is possible to refine the granularity of versions to keep by adding Macros
- to the versioning folder path. For example you can save deleted files
- on a per sync session basis by adding the %timestamp% macro:
-
-
-
Example: Using the dynamically generated folder name C:\Revisions\%timestamp%
- This allows for a simple manual undo by moving the deleted files from the
- last synchronization session back to their original folders. Other
- macros like %date% or %weekday% can be used to reduce the granularity down
- to days and weeks.
-
-
-
\ No newline at end of file
diff --git a/FreeFileSync/Build/Help/html/base.css b/FreeFileSync/Build/Help/html/base.css
index f7fa42be..001b1ae9 100644
--- a/FreeFileSync/Build/Help/html/base.css
+++ b/FreeFileSync/Build/Help/html/base.css
@@ -23,10 +23,9 @@ ul
list-style: disc;
}
-table td
+ol
{
- padding: 0 20px 0 0;
- vertical-align: top;
+ margin: 0
}
table th
@@ -36,29 +35,26 @@ table th
border-bottom: 1px solid black;
}
-.bluebox
+table td
{
- width: 100%;
- border: 1px solid #000080;
- color:black;
- background: #ccccff;
+ padding: 0 20px 0 0;
+ vertical-align: top;
}
-.greybox
-{
- width: 100%;
- color:black;
- background: #e6e6e6;
-}
+.half-line { line-height: .5em; }
-.box-inner
+.bluebox
{
- padding: 6px 6px 6px 21px;
+ padding: 6px 15px;
+ background: #ccccff;
+ border: 1px solid #000080;
}
-.box-outer
+.greybox
{
- margin: 0 15px;
+ padding: 6px 15px;
+ background: #f8f8f8;
+ box-shadow: 1px 1px 4px #888;
}
.command-line
diff --git a/FreeFileSync/Build/Help/html/command-line.html b/FreeFileSync/Build/Help/html/command-line.html
index e7f89892..639079a7 100644
--- a/FreeFileSync/Build/Help/html/command-line.html
+++ b/FreeFileSync/Build/Help/html/command-line.html
@@ -14,36 +14,36 @@
To get a syntax overview, open the console, go to the directory where FreeFileSync is installed and type:
-
+
FreeFileSync.exe -h
-
-
+
1. Run a FreeFileSync batch job
+
+ In order to start synchronization in batch mode, supply the path of a ffs_batch configuration file as the first argument for FreeFileSync.exe:
+
-
In order to start synchronization in batch mode, supply the path of a ffs_batch configuration file as the first argument for FreeFileSync.exe:
-
-
+
FreeFileSync.exe "D:\Backup Projects.ffs_batch"
-
+
After synchronization one of the following status codes is returned:
-
+
Return Codes
0 - Synchronization completed successfully
1 - Synchronization completed with warnings
2 - Synchronization completed with errors
3 - Synchronization was aborted
-
+
You can evaluate these codes from a script (e.g. a cmd or bat file on Windows)
and check if synchronization completed successfully:
Instead of showing an error message you can also send an email notification (using a third party tool).
-
+
Attention
- Make sure your script is not blocked by a popup dialog. Consider the
- following options when setting up a FreeFileSync batch job:
-
+ If you are running the batch job unattended, make sure your script is not blocked showing a notification dialog. Consider the
+ following options when setting up the FreeFileSync batch job:
+
Enable checkbox Run minimized or have On completion automatically close the results dialog after synchronization.
Set error handling to Stop or Ignore.
-
-
+
2. Start a FreeFileSync GUI configuration
+
+ If you pass a ffs_gui file, FreeFileSync will start in GUI mode and immediately start comparison (but only if all directories exist):
+
-
If you pass a ffs_gui file, FreeFileSync will start in GUI mode and immediately start comparison (but only if all directories exist):
-
-
+
FreeFileSync.exe "D:\Manual Backup.ffs_gui"
-
-
+
3. Customize an existing configuration
-
You can replace the directories of a given ffs_gui or ffs_batch configuration file by using the -LeftDir
and -RightDir parameters:
When more than one configuration file is provided, FreeFileSync will merge
everything into a single configuration with multiple folder pairs and start in GUI mode:
+ By default FreeFileSync uses a single GlobalSettings.xml file containing options that apply to all synchronization tasks;
+ for examples see Expert Settings.
+ If you want FreeFileSync to use a different settings file instead you can specify the path via command line:
+