utils/TerraSync/README.txt

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