diff options
Diffstat (limited to 'BUILD/Help/html/RealtimeSync.html')
| -rw-r--r-- | BUILD/Help/html/RealtimeSync.html | 166 |
1 files changed, 80 insertions, 86 deletions
diff --git a/BUILD/Help/html/RealtimeSync.html b/BUILD/Help/html/RealtimeSync.html index d765c818..e9eae9cf 100644 --- a/BUILD/Help/html/RealtimeSync.html +++ b/BUILD/Help/html/RealtimeSync.html @@ -22,117 +22,110 @@ </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">RealtimeSync -is a small tool which executes a command line each time it detects -changes in one of the monitored directories </FONT><SPAN STYLE="font-variant: normal"><FONT FACE="Tahoma, sans-serif"><SPAN STYLE="font-style: normal"><B>or</B></SPAN></FONT></SPAN> -<FONT FACE="Tahoma, sans-serif">a directory becomes available (e. g. -insert of a USB-stick). Usually this command line will simply trigger +<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. -Then specify all folders that shall be monitored. Instead of doing -this manually you can import a </FONT><FONT FACE="Courier New, monospace">*.ffs_batch</FONT> -<FONT FACE="Tahoma, sans-serif">file via </FONT><SPAN STYLE="font-variant: normal"><FONT FACE="Tahoma, sans-serif"><SPAN STYLE="font-style: normal"><B>Menu -→ Program → Open</B></SPAN></FONT></SPAN><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 </FONT><SPAN STYLE="font-variant: normal"><FONT FACE="Tahoma, sans-serif"><SPAN STYLE="font-style: normal"><B>Start</B></SPAN></FONT></SPAN> -<FONT FACE="Tahoma, sans-serif">to begin monitoring.</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 → Program → 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 WIDTH=461 HEIGHT=388 BORDER=0></P> + <P STYLE="margin-bottom: 0cm"><IMG SRC="../img/RealtimeSync.png" NAME="Grafik3" ALIGN=MIDDLE BORDER=0></P> </UL> -<P STYLE="margin-bottom: 0cm"><BR> -</P> -<SPAN ID="Rahmen1" 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> +<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. - Make sure the FreeFileSync batch job does not show any popup - dialogs. See notes in <A HREF="Batch%20scripting.html">Batch - Scripting</A>.</FONT><SPAN STYLE="text-decoration: none"><FONT FACE="Tahoma, sans-serif"><BR> </FONT></SPAN></P> + <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> </P> - <LI><P ALIGN=LEFT STYLE="margin-left: 0.79cm; 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>) - <B>or</B> a FreeFileSync batch file (<FONT FACE="Courier New, monospace">*.ffs_batch</FONT>) - as first command line argument to RealtimeSync.exe. This can be - integrated into the operating system's auto start - facility:<BR> <FONT FACE="Courier New, monospace">"C:\Program - Files\FreeFileSync\RealtimeSync.exe" "</FONT><FONT FACE="Courier New, monospace">D</FONT><FONT FACE="Courier New, monospace">:\</FONT><FONT FACE="Courier New, monospace">Backup - Projects</FONT><FONT FACE="Courier New, monospace">.ffs_real"<BR></FONT> <FONT FACE="Courier New, monospace">"C:\Program - Files\FreeFileSync\RealtimeSync.exe" "</FONT><FONT FACE="Courier New, monospace">D</FONT><FONT FACE="Courier New, monospace">:\</FONT><FONT FACE="Courier New, monospace">Backup - Projects</FONT><FONT FACE="Courier New, monospace">.ffs_batch"</FONT><BR> </FONT></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> + <FONT FACE="Courier New, monospace">"C:\Program Files\FreeFileSync\RealtimeSync.exe" "D:\Backup Projects.ffs_real"</FONT><BR> + <FONT FACE="Courier New, monospace">"C:\Program Files\FreeFileSync\RealtimeSync.exe" "D:\Backup Projects.ffs_batch"</FONT><BR> + </FONT> + </P> - <LI><P ALIGN=LEFT STYLE="margin-left: 0.79cm; 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> -</SPAN><BR CLEAR=LEFT><BR> - -<P STYLE="margin-bottom: 0cm"><BR> + <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 USB +<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 into the USB stick's root directory and have -it called when the stick is mounted. Then configure RealtimeSync as -shown in the following:</FONT></P> +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 WIDTH=437 HEIGHT=362 BORDER=0></P> + <P><IMG SRC="../img/WatchUsbInsert.png" NAME="Grafik2" ALIGN=BOTTOM BORDER=0> + <BR></P> </UL> -<P STYLE="margin-bottom: 0cm"><BR> -</P> -<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif">Whenever -directory "</FONT><FONT FACE="Courier New, monospace">H:\Data</FONT><FONT FACE="Tahoma, sans-serif">" -becomes available, the command line executes and starts the batch job -on the stick. Additionally it also starts the batch job each time -files are modified in "</FONT><FONT FACE="Courier New, monospace">H:\Data</FONT><FONT FACE="Tahoma, sans-serif">". -</FONT> -</P> -<P STYLE="margin-bottom: 0cm"><BR> + +<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<BR></B></FONT><FONT FACE="Tahoma, sans-serif">The - full path of the last changed file and the action that triggered the - change notification (create, update or delete) are </FONT><SPAN STYLE="text-decoration: none"><FONT FACE="Tahoma, sans-serif">written - to the environment variables </FONT></SPAN><SPAN STYLE="text-decoration: none"><FONT FACE="Courier New, monospace"><B>%change_path%</B></FONT></SPAN><SPAN STYLE="text-decoration: none"> - </SPAN><SPAN STYLE="text-decoration: none"><FONT FACE="Tahoma, sans-serif">and - </FONT></SPAN><SPAN STYLE="text-decoration: none"><FONT FACE="Courier New, monospace"><B>%change_action%</B></FONT></SPAN><SPAN STYLE="text-decoration: none"><FONT FACE="Courier New, monospace">.</FONT></SPAN></P> -</SPAN><BR CLEAR=LEFT><BR> + <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> -<P STYLE="margin-bottom: 0cm"><FONT FACE="Tahoma, sans-serif"><B>Example:</B></FONT> -<FONT FACE="Tahoma, sans-serif">Show names of changed files or -directories. (Windows)</FONT></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="Courier New, monospace"><FONT FACE="Tahoma, sans-serif">Show - which file or directory has triggered a change. Enter command - line:</FONT><BR> cmd /c echo %change_action% - "%change_path%" & pause<BR><BR><FONT FACE="Tahoma, sans-serif">Write - a list of all changes to a logfile:</FONT><BR> cmd - /c echo %change_action% "%change_path%" >> - c:\log.txt</FONT></P> + <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"> + cmd /c echo %change_action% + "%change_path%" & 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"> + cmd /c echo %change_action% "%change_path%" >> 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<BR></B></FONT><FONT FACE="Tahoma, sans-serif">During - execution of a Windows Batch file (*.bat/*.cmd) a black console - window is shown. You can hide it using the Visual Basic script - "HideConsole.vbs" located in FreeFileSync's installation - directory:</FONT></P> - <P ALIGN=LEFT STYLE="margin-left: 0.79cm; margin-bottom: 0cm"><FONT FACE="Courier New, monospace"><B>wscript - "C:\Program files\FreeFileSync\HideConsole.vbs" - C:\MyBatchFile.cmd</B></FONT></P> + <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 "C:\Program files\FreeFileSync\HideConsole.vbs" C:\MyBatchFile.cmd</FONT> + </P> </SPAN><BR CLEAR=LEFT><BR> </P> <P STYLE="margin-bottom: 0cm"><BR> @@ -141,7 +134,8 @@ directories. (Windows)</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 "changed_file".</FONT></P> + 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> |