opensync-plugin-0.4x/README

   1
   2 *****************************************************************************
   3 *  CAUTION: This is alpha software.  Please make complete backups of your   *
   4 *           Blackberry device before experimenting.  While the author has   *
   5 *           had good success with this software, that is no guarantee that  *
   6 *           you will.  Please make backups.                                 *
   7 *****************************************************************************
   8
   9 Development note: this plugin is in flux, not only from pure development,
  10         but also because the OpenSync libraries themselves are getting
  11         close to releasing version 0.4x, which changes some internals
  12         from 0.22.  This plugin is currently based on 0.4x, but that may
  13         change in the future.
  14
  15 Introduction:
  16 -------------
  17 This directory contains a plugin for the OpenSync framework, which can
  18 be used to synchronize between handhelds and desktop management software,
  19 such as Evolution and Mozilla Sunbird.
  20
  21 Please note that this plugin has the potential to not only change the
  22 data in your Blackberry handheld, but also, through sending sync ADD,
  23 MODIFY and DELETE changes, can change the data in your address book
  24 and calendar in your desktop software of choice.  As this plugin is
  25 in development, please exercise caution, and make backups of your
  26 Blackberry (see the ../gui directory) *and* backups of your desktop
  27 software's data.
  28
  29
  30 You can find more information on the OpenSync framework, as well
  31 as tarballs for the version 0.4x library and plugins when they become
  32 available, at the following website:
  33
  34         http://www.opensync.org/
  35
  36
  37
  38 Library Dependencies:
  39 ---------------------
  40
  41 You will need the following packages installed on your system, including
  42 any dev or devel packages that come along with them.
  43
  44         pkg-config              Used by the configure scripts
  45         cmake 2.4.4             Used to build OpenSync
  46         libopensync-0.4x        OpenSync framework library
  47         sqlite                  Required by OpenSync
  48         glib2                   Required by OpenSync
  49         libxml2                 Required by OpenSync
  50         libbarry 0.x            In the same tarball as this code.
  51         libusb                  Required by libbarry
  52
  53 In addition to libopensync, you will need a plugin for your desktop
  54 software of choice, or for other handheld devices, such as the Palm.
  55 Please see the OpenSync website for a list of available plugins.
  56
  57 If you've installed Barry or OpenSync in a non-standard spot, use something
  58 like the following:
  59
  60         export PKG_CONFIG_PATH="/home/cdfrey/Barry/lib/pkgconfig:/home/cdfrey/software/lib/pkgconfig"
  61         ./configure --prefix=/home/cdfrey/Barry
  62
  63
  64
  65 Opensync 0.3x/0.4x build and test environment:
  66 ----------------------------------------------
  67
  68 The opensync 0.3x/0.4x build tree is still a moving target.  To test this
  69 plugin, with, for example, Evolution, you will need the following SVN repos:
  70
  71         libopensync
  72                 http://svn.opensync.org/trunk
  73
  74         vformat plugin
  75                 http://svn.opensync.org/format-plugins/vformat
  76
  77         xmlformat plugin
  78                 http://svn.opensync.org/format-plugins/xmlformat/trunk
  79
  80         file-sync plugin (needed for plain format)
  81                 http://svn.opensync.org/plugins/file-sync
  82
  83         evolution plugin
  84                 http://svn.opensync.org/plugins/evolution2
  85
  86         osynctool (command line)
  87                 http://svn.opensync.org/osynctool/trunk
  88
  89 Using cmake, compile them in the above listed order, using the following
  90 set of commands:
  91
  92         mkdir build
  93         cd build
  94         cmake -DCMAKE_INSTALL_PREFIX=/home/cdfrey/rootdir ..
  95         make
  96         make install
  97
  98 Build the Barry plugin:
  99
 100         cd opensync-plugin-0.4x
 101         export PKG_CONFIG_PATH=/home/cdfrey/rootdir/lib/pkgconfig
 102         ./configure --prefix=/home/cdfrey/rootdir
 103         make
 104         make install
 105
 106 Then setup your syncing target and sync:
 107
 108         cd /home/cdfrey/rootdir/bin
 109         evolution --force-shutdown
 110         ./osynctool --delgroup EvoBarry
 111         ./osynctool --addgroup EvoBarry
 112         evolution --force-shutdown
 113         ./osynctool --addmember EvoBarry evo2-sync
 114         ./osynctool --addmember EvoBarry barry-sync
 115         evolution --force-shutdown
 116         ./osynctool --configure EvoBarry 1
 117         ./osynctool --configure EvoBarry 2
 118         evolution --force-shutdown
 119         ./osynctool --discover EvoBarry
 120         evolution --force-shutdown
 121         ./osynctool --showgroup EvoBarry
 122         evolution --force-shutdown
 123         ./osynctool --sync EvoBarry
 124
 125 As you can see, the evolution plugin is rather picky about running alone,
 126 so be liberal with the force-shutdown commands. :-)
 127
 128 Please report any bugs you find to the Barry mailing list.
 129
 130 Thanks!
 131
 132 January 2009
 133