summaryrefslogtreecommitdiff
path: root/BUILD/Help/html/advanced/RealtimeSync.html
blob: 7fb599e89fb1fa70843ebd371651fdb1db633b59 (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
	<TITLE></TITLE>
	<META NAME="GENERATOR" CONTENT="OpenOffice.org 3.2  (Win32)">
	<META NAME="CREATED" CONTENT="20091206;16574000">
	<META NAME="CHANGED" CONTENT="20110405;14185900">
	<META NAME="Info 1" CONTENT="">
	<META NAME="Info 2" CONTENT="">
	<META NAME="Info 3" CONTENT="">
	<META NAME="Info 4" CONTENT="">
	<STYLE TYPE="text/css">
	<!--
		@page { margin: 2cm }
		P { margin-bottom: 0.21cm }
		H3 { margin-bottom: 0.21cm }
		H3.western { font-family: "Arial", sans-serif }
		H3.cjk { font-family: "MS Mincho" }
		H3.ctl { font-family: "Mangal" }
		A:link { so-language: zxx }
	-->
	</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H3 CLASS="western"><FONT FACE="Tahoma, sans-serif">RealtimeSync</FONT></H3>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">RealtimeSync's
primary function is to trigger synchronization immediately after
files in a source directory have changed. However its implementation
is much more flexible to cover an even broader range of use: A list
of directories provided by the user is monitored for changes.
Whenever a file within these directories or sub directories is
modified OR the directory becomes available (e. g. insert of a
USB-stick), RealtimeSync responds by executing the user-specified
command line.</FONT></P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Example:</B></FONT>
<FONT FACE="Tahoma, sans-serif">(Real time synchronization - in
combination with FreeFileSync)</FONT></P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">First
start up RealtimeSync.exe located in FreeFileSync's installation
directory. Then specify all directories that shall be monitored.
Instead of doing this manually you can simply import a </FONT><FONT FACE="Courier New, monospace">*.ffs_batch</FONT>
<FONT FACE="Tahoma, sans-serif">file via </FONT><FONT FACE="Tahoma, sans-serif"><I>Menu
-&gt; File -&gt; Load configuration</I></FONT><FONT FACE="Tahoma, sans-serif">.
This not only extracts all directories relevant for synchronization
but also sets up the command-line to execute the </FONT><FONT FACE="Courier New, monospace">*.ffs_batch</FONT>
<FONT FACE="Tahoma, sans-serif">file each time changes are detected.
Now press &quot;</FONT><FONT FACE="Tahoma, sans-serif"><I>Start</I></FONT><FONT FACE="Tahoma, sans-serif">&quot;
to begin monitoring.</FONT></P>
<UL>
	<P STYLE="margin-bottom: 0cm"><IMG SRC="rts23.png" NAME="Grafik3" ALIGN=MIDDLE WIDTH=503 HEIGHT=429 BORDER=0></P>
</UL>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<UL>
	<P><SPAN ID="Rahmen3" DIR="LTR" STYLE="float: left; width: 80%; height: 0.14cm; border: 1px solid #000080; padding: 0.05cm; background: #ccccff">
		<UL>
			<P ALIGN=LEFT STYLE="margin-right: 0.98cm; margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Note:</B></FONT></P>
			<LI><P ALIGN=LEFT STYLE="margin-right: 0.98cm; margin-bottom: 0cm">
			<FONT FACE="Tahoma, sans-serif">The command-line must <B>NOT</B>
			<B>block</B> the progress. If a FreeFileSync batch file is called
			make sure it is operating in &quot;silent-mode&quot; and &quot;error
			handling&rdquo; is set to &quot;ignore errors&quot; or &quot;exit
			instantly<U>&quot;</U>.</FONT></P>
			<LI><P ALIGN=LEFT STYLE="margin-right: 0.98cm; margin-bottom: 0cm">
			<FONT FACE="Tahoma, sans-serif">The settings dialog can be skipped
			by passing a RealtimeSync configuration file (<FONT FACE="Courier New, monospace">*.ffs_real</FONT>)
			OR a FreeFileSync batch file (<FONT FACE="Courier New, monospace">*.ffs_batch</FONT>)
			as first command-line argument to RealtimeSync.exe. This allows
			for integration with the operating system's auto start facility.</FONT></P>
			<LI><P ALIGN=LEFT STYLE="margin-right: 0.98cm; margin-bottom: 0cm">
			<FONT FACE="Tahoma, sans-serif">Using RealtimeSync is not
			restricted to starting FreeFileSync. It can also be used in other
			scenarios, like sending an email whenever a certain directory is
			modified.</FONT></P>
			<LI><P ALIGN=LEFT STYLE="margin-right: 0.98cm; margin-bottom: 0cm">
			<FONT FACE="Tahoma, sans-serif">If you schedule a Windows batch
			file (.bat, .cmd), see notes in <A HREF="Batch%20Scripting.html">Batch
			Scripting</A>.</FONT></P>
		</UL>
	</SPAN><BR CLEAR=LEFT>
	</P>
</UL>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<UL>
	<P><SPAN ID="Rahmen2" DIR="LTR" STYLE="float: left; width: 80%; height: 0.14cm; border: none; padding: 0cm; background: #e6e6e6">
		<P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-right: 0.98cm; margin-bottom: 0cm">
		<FONT FACE="Courier New, monospace">&quot;C:\Program
		Files\FreeFileSync\RealtimeSync.exe&quot;
		&quot;C:\MyConfig.ffs_real&quot;<BR>&quot;C:\Program
		Files\FreeFileSync\RealtimeSync.exe&quot; &quot;C:\SyncJob.ffs_batch&quot;</FONT></P>
	</SPAN><BR CLEAR=LEFT>
	</P>
</UL>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Example:</B></FONT>
<FONT FACE="Tahoma, sans-serif">(Automatic synchronization when USB
stick is inserted)</FONT></P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">Assume
you have multiple USB sticks that contain data you want to
automatically synchronize whenever you insert one of the sticks into
the PC. Save the relevant configuration on each USB stick's root
directory to have it called when the stick is mounted. Then configure
RealtimeSync analog to the following:</FONT></P>
<UL>
	<P><IMG SRC="rts.png" NAME="Grafik2" ALIGN=BOTTOM WIDTH=462 HEIGHT=411 BORDER=0></P>
</UL>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">Whenever
directory &quot;</FONT><FONT FACE="Courier New, monospace">H:\Data</FONT><FONT FACE="Tahoma, sans-serif">&quot;
becomes available, the command-line executes and starts the batch job
whose configuration is located on the stick. Furthermore it also
starts the batch job each time files are modified in &quot;</FONT><FONT FACE="Courier New, monospace">H:\Data</FONT><FONT FACE="Tahoma, sans-serif">&quot;.
</FONT>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Example:</B></FONT>
<FONT FACE="Tahoma, sans-serif">(Calling a custom .cmd or .bat file)</FONT></P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">For
additional convenience it may be nice if the batch job remains silent
if synchronization completes successfully, otherwise shows
FreeFileSync's GUI dialog when errors occurred. Therefore create two
configurations, one silent-mode batch to be called by default and one
<FONT FACE="Courier New, monospace">*.ffs_gui</FONT> to be called
when former fails. Then replace the command-line to simply execute a
batch file similar to this one:</FONT></P>
<UL>
	<P><SPAN ID="Rahmen1" DIR="LTR" STYLE="float: left; width: 80%; height: 0.14cm; border: none; padding: 0cm; background: #e6e6e6">
		<P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-right: 0.98cm; margin-bottom: 0cm">
		<FONT COLOR="#808080"><FONT FACE="Courier New, monospace"><I><B>::first
		check whether USB-stick contains a sync-configuration at all</B></I></FONT></FONT><FONT FACE="Courier New, monospace"><BR>@if
		exist &quot;H:\Silent_Config.ffs_batch&quot; (<BR></FONT><FONT COLOR="#808080">&nbsp;&nbsp;</FONT><FONT COLOR="#808080"><FONT FACE="Courier New, monospace"><I><B>::configuration
		found, now execute the synchronization batch job</B></I></FONT></FONT><FONT FACE="Courier New, monospace"><BR></FONT><FONT COLOR="#808080">&nbsp;&nbsp;</FONT><FONT FACE="Courier New, monospace">&quot;C:\Program
		Files\FreeFileSync\FreeFileSync.exe&quot;
		&quot;H:\Silent_Config.ffs_batch&quot;<BR></FONT><FONT COLOR="#808080">&nbsp;&nbsp;</FONT><FONT FACE="Courier New, monospace">@if
		not errorlevel 0 (<BR></FONT><FONT COLOR="#808080">&nbsp;&nbsp;&nbsp;&nbsp;</FONT><FONT COLOR="#808080"><FONT FACE="Courier New, monospace"><I><B>::if
		something went wrong, start FreeFileSync in GUI
		mode</B></I></FONT></FONT><FONT FACE="Courier New, monospace"><BR></FONT><FONT COLOR="#808080">&nbsp;&nbsp;&nbsp;&nbsp;</FONT><FONT FACE="Courier New, monospace">&quot;C:\Program
		Files\FreeFileSync\FreeFileSync.exe&quot;
		&quot;H:\GUI_Config.ffs_gui&quot;<BR></FONT><FONT COLOR="#808080">&nbsp;&nbsp;</FONT><FONT FACE="Courier New, monospace">)<BR>)</FONT></P>
	</SPAN><BR CLEAR=LEFT>
	</P>
</UL>
</BODY>
</HTML>
bgstack15