summaryrefslogtreecommitdiff
path: root/BUILD/Help/html/RealtimeSync.html
blob: e9eae9cf650f2314a711a7042960f03ad912ce29 (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
<!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="LibreOffice 4.0.4.2 (Windows)">
	<META NAME="CREATED" CONTENT="20091206;16574000">
	<META NAME="CHANGED" CONTENT="20130722;18255897">
	<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" }
	-->
	</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H3 CLASS="western" ALIGN=CENTER><IMG SRC="../img/RTS_logo.png" NAME="Grafik6" ALIGN=ABSMIDDLE WIDTH=269 HEIGHT=59 BORDER=0><FONT SIZE=4 STYLE="font-size: 16pt"><BR></FONT><FONT SIZE=3><I><SPAN STYLE="font-weight: normal">Automated Synchronization</SPAN></I></FONT></H3>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">
The primary purpose of RealtimeSync is to execute a command line each time a directory becomes 
available (e. g. insert of a USB-stick) <b>or</b> when it detects changes in one of the monitored directories. Usually this command line will trigger
a FreeFileSync batch job.</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">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 <B>Menu &rarr; Program &rarr; Open</B>. 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 <B>Start</B> to begin monitoring.</FONT></P>
<UL>
	<P STYLE="margin-bottom: 0cm"><IMG SRC="../img/RealtimeSync.png" NAME="Grafik3" ALIGN=MIDDLE BORDER=0></P>
</UL>
<BR>


<P STYLE="margin-left: 1.32cm; margin-bottom: 0cm"><SPAN ID="Rahmen2" DIR="LTR" STYLE="float: left; width: 80%; height: 0.04cm; border: 1px solid #000080; padding: 0.05cm; background: #ccccff">
	<P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">
	    <B>Note</B></FONT></P>
		<LI><P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">The
		command should </FONT><FONT FACE="Tahoma, sans-serif"><B>not</B></FONT>
		<FONT FACE="Tahoma, sans-serif"><B>block</B></FONT> <FONT FACE="Tahoma, sans-serif">progress. If you call a FreeFileSync batch job, make sure it does not show any popup
		windows. See notes in <A HREF="Command%20line.html">Command Line Usage</A>.</FONT><BR>&nbsp;</P>

		<LI><P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">
		RealtimeSync will skip showing the main dialog and begin monitoring immediately if you pass a ffs_real configuration file <B>or</B> 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:<BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<FONT FACE="Courier New, monospace">&quot;C:\Program Files\FreeFileSync\RealtimeSync.exe&quot; &quot;D:\Backup Projects.ffs_real&quot;</FONT><BR>
		&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<FONT FACE="Courier New, monospace">&quot;C:\Program Files\FreeFileSync\RealtimeSync.exe&quot; &quot;D:\Backup Projects.ffs_batch&quot;</FONT><BR>&nbsp;
		</FONT>
		</P>

		<LI><P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">
		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.</FONT></P>
</SPAN><BR CLEAR=LEFT>
</P>

<BR>
<BR>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Example:</B></FONT>
<FONT FACE="Tahoma, sans-serif">Automatic synchronization when a USB
stick is inserted</FONT></P>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">Save a
ffs_batch configuration in the USB stick's root directory, e.g. <FONT FACE="Courier New, monospace">H:\</FONT>, to let RealtimeSync call it when the stick is mounted. Configure RealtimeSync as follows:</FONT></P>
<UL>
	<P><IMG SRC="../img/WatchUsbInsert.png" NAME="Grafik2" ALIGN=BOTTOM  BORDER=0>
	<BR></P>
</UL>

<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">Whenever directory <FONT FACE="Courier New, monospace">H:\Data</FONT> 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 <FONT FACE="Courier New, monospace">H:\Data</FONT>.</FONT>
</P>
<BR>
<P STYLE="margin-left: 1.32cm; margin-bottom: 0cm"><SPAN ID="Rahmen2" DIR="LTR" STYLE="float: left; width: 80%; height: 0.04cm; border: 1px solid #000080; padding: 0.05cm; background: #ccccff">
	<P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm">	
	<FONT FACE="Tahoma, sans-serif">	
		<B>Note</B><BR>	
		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 <B>%change_path%</B> and <B>%change_action%</B>.
	</FONT>
	</P>
</SPAN><BR CLEAR=LEFT>
</P>
<BR>
<BR>
<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Example:</B>
Log names of changed files and directories (Windows)</FONT></P>

<P STYLE="margin-left: 1.32cm; margin-bottom: 0cm"><SPAN ID="Rahmen4" DIR="LTR" STYLE="float: left; width: 80%; height: 0.04cm; border: none; padding: 0cm; background: #e6e6e6">
	<P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm">
	
	<FONT FACE="Tahoma, sans-serif">Show which file or directory has triggered a change. Enter command
	line:</FONT><BR>
	
	<FONT FACE="Courier New, monospace">
	&nbsp;&nbsp;&nbsp;&nbsp;cmd /c echo %change_action%
	&quot;%change_path%&quot; &amp; pause<BR><BR>
	</FONT>
	
	<FONT FACE="Tahoma, sans-serif">Write a list of all changes to a log file:</FONT><BR>
	
	<FONT FACE="Courier New, monospace">
	&nbsp;&nbsp;&nbsp;&nbsp;cmd /c echo %change_action% &quot;%change_path%&quot; &gt;&gt; C:\log.txt
	</FONT>
	</P>
</SPAN><BR CLEAR=LEFT><BR>
</P>

<P STYLE="margin-left: 1.32cm; margin-bottom: 0cm"><SPAN ID="Rahmen5" DIR="LTR" STYLE="float: left; width: 80%; height: 0.04cm; border: 1px solid #000080; padding: 0.05cm; background: #ccccff">
	<P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm">
		<FONT FACE="Tahoma, sans-serif">
			<b>Note</b><br>
			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
			<FONT FACE="Courier New, monospace">HideConsole.vbs</FONT> located in FreeFileSync's installation directory:
		</FONT><br><br>
		
		<FONT FACE="Courier New, monospace">wscript &quot;C:\Program files\FreeFileSync\HideConsole.vbs&quot; C:\MyBatchFile.cmd</FONT>
	</P>
</SPAN><BR CLEAR=LEFT><BR>
</P>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
<P STYLE="margin-bottom: 0cm; text-decoration: none"><FONT FACE="Tahoma, sans-serif"><B>Limitations</B>:</FONT></P>
<UL>
	<LI><P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">If
	multiple changes happen at the same time, only the name of the first
	file is written to variable <b>%changed_file%</b>.</FONT></P>
	
	<LI><P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">While
	RealtimeSync is executing the command line, monitoring is inactive
	and changes occurring during this time are lost. </FONT>
	</P>
</UL>
<P STYLE="margin-bottom: 0cm"><BR>
</P>
</BODY>
</HTML>
bgstack15