utils/TerraSync/README.txt

   1 TerraSync
   2 =========
   3
   4 Usage:
   5
   6     terrasync -p <port> [ -R ] [ -s <rsync_source> ] -d <dest>
   7     terrasync -p <port>   -S   [ -s <svn_source> ] -d <dest>
   8
   9 Example:
  10
  11     $ fgfs --atlas=socket,out,1,localhost,5500,udp --fg-scenery=/usr/local/FlightGear/data/scenery:/data1/Scenery-0.9.2
  12     $ nice terrasync -p 5500 -d /data1/Scenery-0.9.2
  13
  14 Requirements:
  15
  16     - rsync util installed in your path.
  17 or      - svn util installed in your path
  18
  19 NOTE!!!!  Do not run terrasync against the default
  20 $FG_ROOT/data/Scenery/ directory.  I recommend creating a separate
  21 scenery directory and specifying both in your ~/.fgfsrc file or via
  22 the command line.
  23
  24 TerraSync is a utility that is intended to run as a light weight
  25 background process.  It's purpose is to monitor the position of a
  26 FlightGear flight and pre-fetch scenery tiles from a remote server
  27 based on the current FlightGear position.
  28
  29 This allows you to do a base install of FlightGear with no add on
  30 scenery.  Now just go and fly anywhere.  Scenery is fetched "just in
  31 time" and accumulated on your HD so it is already there next time you
  32 fly.  You can fly anywhere and essentially just the scenery you need
  33 is auto-installed as you fly.
  34
  35 Terrasync runs as a separate process and expects the --atlas=port
  36 format to be sent from fgfs.  The fgfs output tells the terrasync util
  37 where FlightGear is currently flying.  Terrasync will then issue the
  38 appropriate commands to rsync the surrounding areas to your local
  39 scenery directory.  The user need to choose a port for
  40 FlightGear->TerraSync communication and then specify the server
  41 location and destation scenery tree.
  42
  43 As you fly, terrasync will periodically refresh and pull any new
  44 scenery tiles that you need for your position from the server.
  45
  46 This also works if the scenery on the scenery server is updated.
  47 Rsync ( or svn ) will pull any missing files, or any newly updated files.
  48
  49 There is a chicken/egg problem when you first start up in a brand new
  50 area.  FlightGear is expecting the scenery to be there *now* but it
  51 may not have been fetched yet.  I suppose without making a more
  52 complex protocol, the user will need to be aware of this.  For now I
  53 suggest exiting FlightGear after terrasync gets caught up, and
  54 restarting FlightGear.  The second time FlightGear starts up
  55 everything should be good.
  56
  57 Final notes:
  58
  59 I have set up the scenery server at
  60 scenery.flightgear.org::Scenery-0.9.2.  This is the latest 0.9.2 build
  61 of the world.
  62
  63 Note to self:
  64
  65 nice ./terrasync -p 5500 -s baron.flightgear.org:/stage/fgfs05/curt/Scenery-1.0 -d /stage/catalina3/Scenery-1.0/