summaryrefslogtreecommitdiff
path: root/BUILD/Readme.txt
blob: 20576738b242526d9c0697c190d81c988b8c8fd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
FreeFileSync v2.3
-----------------

---------
| Usage |
---------

1. Choose left and right directories and "Compare" them.
2. Select synchronization settings and press "Synchronize..." to begin synchronization.


----------------
| Key Features |
----------------

1. Compare files (bytewise or by date) and synchronize them.
2. No limitations: An arbitrary number of files can be synchronized.
3. Unicode support.
4. Network support.
5. Full support for Windows/Linux Symbolic Links and Windows Junction Points.
6. Lean & easily accessible UI: Highly optimized for speed and huge sets of data.
7. Algorithms coded in C++ completely.
8. Progress indicators are updated only every 100ms for optimal performance!
9. Subfolders are also synchronized, including empty folders.
10. Support for multiple folder pairs
11. Create Batch Jobs for automated synchronization with or without GUI.
12. Focus on usability:
	- Only necessary functionality on UI: no overloaded menus or icon jungle.
	- Select folders via drag & drop.
	- Last configuration and screen settings are saved automatically.
	- Maintain and load different configurations by drag&drop, load-button or during startup.
	- Double-click to show file in explorer. (Windows only)
	- Copy & paste support to export file-lists.
	- Delete superfluous/temporary files directly on main grid.
	- Right-click context menu.
	- Status information and error reporting
	- Sort file-lists by name, size or date.
	- Display statistical data: total filesizes, amount of bytes that will be transfered with the current settings.
13. Support for filesizes larger than 4 GB.
14. Option to move files to Recycle Bin instead of deleting/overwriting them.
15. Automatically ignore directories "\RECYCLER" and "\System Volume Information" when comparing and sync'ing. (Windows only)
16. Localized versions for many languages are available.
17. Delete before copy: Avoid disc space shortages with large sync-operations.
18. Based on wxWidgets framework => Portable to many operating systems.
19. Filter functionality to include/exclude files from synchronization (without re-compare!).
20. Include/exclude specific files from synchronization manually.
21. Create sync jobs via GUI to synchronize automatically (can be scheduled or executed directly).
22. Handle daylight saving time changes on FAT/FAT32 volumes correctly.
23. Portable version (.zip) available.
24. No Windows registry entries for portable version.
25. Support for \\?\ path prefix for unrestricted path length. (Windows only)
26. Check for updates from within FreeFileSync automatically.
27. Copy locked files using Windows Volume Shadow Copy. (Windows only)
28. Load file icons asynchronously for maximum display performance.


-------------------
| Advanced topics |
-------------------

1.) Synchronize in Batch Mode and send error notification via email:

- Create a FreeFileSync batch file using "silent mode".
- Set error handling to "Exit with Returncode < 0" or "ignore errors" to avoid having a popup stop the program flow.
  In case errors occur FreeFileSync will abort with a returncode < 0 which can be checked via the ERRORLEVEL command.
- Create a *.cmd or *.bat file and specify the location of FreeFileSync.exe and pass the name of the FreeFileSync batch file as first argument; e.g.:

	C:\Program Files\FreeFileSync\FreeFileSync.exe C:\SyncJob.ffs_batch
	IF NOT ERRORLEVEL 0 echo An error occurred! && pause

- Instead of displaying "An error occurred!" you can specify any other command like sending an email notification (using a third party tool).


2.)	Schedule Batch Job in Windows Task Planner

- Create a FreeFileSync batch file. (E.g. C:\SyncJob.ffs_batch)
- Create a new task in Windows Task planner for FreeFileSync.exe.
- Modify the task and adapt the execute-command specifying the path to the batch file; e.g.:
		
		C:\Program Files\FreeFileSync\FreeFileSync.exe C:\SyncJob.ffs_batch

		
3.) Drag & drop support

FreeFileSync has a big focus on usability. Therefore drag & drop is supported in various situations:

You can: - drag & drop any directory onto the main window to set the directory for comparison
         - drag & drop any file onto the main window to set the directory for comparison
         - drag & drop *.ffs_gui files onto the main window to load the configuration contained
         - drag & drop *.ffs_batch files onto the main window to display and edit the batch configuration
         - drag & drop *.ffs_batch files onto the batch dialog to display and edit the batch configuration

		 
4.) Exclude all subfolders from synchronization

If you want to synchronize all files from the base synchronization directories only, simply set up a filter like this:

	Include: *
	Exclude: *\
	
This will exclude all objects within the two directories that end with a "\" character, which is interpreted as the end of a directory name,


5.) Synchronize with FTP

FreeFileSync does not support FTP directly. But the FTP functionality can be easily activated by mapping the FTP webspace to a drive letter:

Example: Use the free utility NetDrive (http://www.netdrive.net/)
- Add a "New Site" and specify site name, site URL, drive letter, account and password.
- Use the newly created drive as if it were a regular hard disk.
- Note: Most FTP drives set a file's timestamp to current time when synchronizing. As a workaround you can try a "compare by filesize", see below.


6.) Start external application on double-click

FreeFileSync's default is to show files in the operating system's standard file browser on each double-click e.g. by invoking "explorer /select, %name" on Windows.
If some other application shall be started instead, just navigate to "Menu -> Advanced -> Global settings: External Applications" and replace the command string:

Examples:	- Start associated application:		cmd /c start "" "%name" 				
			- Start visual difference tool:		C:\Program Files\WinMerge\WinMergeU.exe "%name" "%nameCo"
(Don't forget to use quotation marks if file names contain spaces!)

	
7. Synchronize USB sticks with variable drive letter

USB sticks often have different volume names assigned to them when plugged into two distinct computers. In order to handle this flexibility FreeFileSync is able to process directory names relative to the current working directory. Thus the following workflow is possible:
	
	- Replace the absolute USB directory name (variable) in your configuration by a relative one: E.g. "E:\SyncDir" -> "\SyncDir"
	- Save and copy synchronization settings to the USB stick: "E:\settings.ffs_gui"
	- Start FreeFileSync by double-clicking on "E:\settings.ffs_gui"

=> Working directory automatically is set to "E:\" by the operating system so that "\SyncDir" is interpreted as "E:\SyncDir". Now start synchronization as usual.


8. Start RealtimeSync via commandline

RealtimeSync can be used to load a configuration file and start processing immediately without additional user intervention. Just pass the name of a configuration file as 
first commandline argument.

Example: C:\Program Files\FreeFileSync\RealtimeSync.exe MyConfig.ffs_real


9. Compare by filesize

Sometimes you might want to compare both sides by filesize only, ignoring the last modification timestamp. Here is how you can do this: Open your *.ffs_gui configuration file
and change the XML node <FileTimeTolerance> to some sufficiently large value. Now changed files will be detected as a conflict (same date, different filesize) and a default
synchronization direction for conflics can be used.



---------
| Links |
---------

FreeFileSync on SourceForge: 
http://sourceforge.net/projects/freefilesync/


------------
| Contact  |
------------

For feedback, suggestions or bug-reports you can write an email to:
zhnmju123 [at] gmx [dot] de

or report directly to:
http://sourceforge.net/projects/freefilesync/


Have fun!
-ZenJu
bgstack15