[Opensync-commits] r6037 - plugins/opie-sync

[<svn...@op...>]

Author: paule
Date: Thu Feb 11 01:53:31 2010
New Revision: 6037
URL: http://www.opensync.org/changeset/6037

Log:
opie-sync: update README for current status

Modified:
   plugins/opie-sync/README

Modified: plugins/opie-sync/README
==============================================================================
--- plugins/opie-sync/README	Thu Feb 11 01:52:36 2010	(r6036)
+++ plugins/opie-sync/README	Thu Feb 11 01:53:31 2010	(r6037)
@@ -1,15 +1,15 @@
 Opie Plugin for OpenSync README
 ===============================
 
-This OpenSync plugin is intended to allow synchronisation with the Opie 
+This OpenSync plugin is intended to enable synchronisation with the Opie
 handheld environment (http://opie.handhelds.org). In theory it should also 
 support some versions of Qtopia as found on the Sharp Zaurus, but no testing 
 of this has been done.
 
 This plugin is a work in progress but should be able to sync contacts, 
-calendar events and todo list entries, minus a few fields, as well as support
-for syncing notes. However, use is entirely at your own risk - back up your 
-data on both sides first!
+calendar events, todo list entries, and notes. Support for the new
+synchronisation features in Opie 1.2.5 is included. However, use is entirely
+at your own risk - back up your data on both sides first!
 
 If you'd like to help, please try the plugin and send any questions to the 
 opensync users list (ope...@li...) - although please 
@@ -21,11 +21,12 @@
 Requirements
 ------------
 
+ * A device running Opie 1.2.0 or later (however, the latest version
+   available is recommended)
  * Connection: the plugin assumes you have a working network connection
    set up between the device and the machine you are running OpenSync on. 
    This could be ethernet over USB, PPP over serial, wifi, bluetooth etc. - 
    as long as an IP network is available the transport is not important.
- 
  * The OpenSync xmlformat plugin (now split out from the core) is required.
  * libcurl, libxml2, glib-2.0
  * OpenSSH for scp connections (optional)
@@ -46,12 +47,13 @@
   Port
     TCP port on the device to use for file transfers. Default is 4242 (which
     Opie's built-in FTP server listens on). See also the ConnType option 
-    below.
+    below. Normally this should not be changed.
 
 Authentication
 
   Username
-    User name to log into the device as (default root).
+    User name to log into the device as (default is root, and this will
+    almost always be the value here unless you are testing on a PC).
 
 Advanced Options
 
@@ -66,9 +68,10 @@
   ConnType
     Type of connection to use:
       ftp  - use FTP (default). Uses Opie's built-in FTP server to transfer
-             data without encryption.
+             data without encryption. For Opie 1.2.5 this is the only option.
       scp  - use scp/ssh commands to transfer data securely. Note: this will 
-             require you to set up key-based ssh authentication.
+             require you to set up key-based ssh authentication. *** See
+             Todo List below ***
   
   BackupDir
     (Optional) If you want the files from your device backed up prior to every 
@@ -93,7 +96,7 @@
   Only one of these note resources can be enabled at once.
 
 
-Additional options for debugging purposes only:
+Additional options (for debugging purposes only!):
 
   ConnType
     An additional value for this option exists:
@@ -162,12 +165,17 @@
   If you have not done so you need to set up SSH public key authentication
   between the device running Opie and the machine running OpenSync. There is
   no way for a password to be passed to scp so key-based authentication must
-  be used.
+  be used. *** See Todo list below ***
 
 
 Todo list
 ---------
 
+Secure syncing not supported on 1.2.5
+
+  The new synchronisation method in Opie 1.2.5 does not support exchange of
+  data using encryption.
+
 Missing fields on contacts
 
   "Gender" and "Children" fields from the Opie side are not currently handled