[vhffs-dev] [1562] Improved documentation for VHFFS FS-sync

[subversion@xxxxxxxxxxxxx]

Revision: 1562
Author:   beuss
Date:     2010-03-15 10:07:09 +0100 (Mon, 15 Mar 2010)
Log Message:
-----------
Improved documentation for VHFFS FS-sync

Modified Paths:
--------------
    trunk/vhffs-fssync/HOWTOCOMPILEANDRUN

Modified: trunk/vhffs-fssync/HOWTOCOMPILEANDRUN
===================================================================
--- trunk/vhffs-fssync/HOWTOCOMPILEANDRUN	2010-03-14 18:45:23 UTC (rev 1561)
+++ trunk/vhffs-fssync/HOWTOCOMPILEANDRUN	2010-03-15 09:07:09 UTC (rev 1562)
@@ -1,4 +1,20 @@
-gcc -ggdb -Wall -Werror -o vhffsfssync_master `pkg-config --cflags --libs glib-2.0` vhffsfssync_master.c
-gcc -ggdb -Wall -Werror -o vhffsfssync_slave `pkg-config --cflags --libs glib-2.0` vhffsfssync_slave.c
-gcc -DCHECK -ggdb -Wall -Werror -o vhffsfssync_check `pkg-config --cflags --libs glib-2.0` vhffsfssync_slave.c
+Compile
+-------
 
+You'll need Glib 2 development packages (libglib2.0-dev on Debian) and inotify support.
+
+gcc [-ggdb] -Wall -Werror -o vhffsfssync_master `pkg-config --cflags --libs glib-2.0` vhffsfssync_master.c
+gcc [-ggdb] -Wall -Werror -o vhffsfssync_slave `pkg-config --cflags --libs glib-2.0` vhffsfssync_slave.c
+gcc -DCHECK [-ggdb] -Wall -Werror -o vhffsfssync_check `pkg-config --cflags --libs glib-2.0` vhffsfssync_slave.c
+
+Run
+---
+
+You'll need Glib 2 packages (libglib2.0-0 on lenny).
+Your two boxes should be time synced using NTP.
+
+On master (as root): ./vhffsfssync_master [--foreground] [--bind=IP] [--port=PORT] DIRTOSYNC
+Defaults are all IP and port 4567
+
+On slave (as root): ./vhffsfssync_slave [--foreground] [--limit-rate=kB/s] MASTER_IP[:PORT] DESTDIR
+