Updated packaging for new 0.0.2 release.
[qwerkisync] / qtc_packaging / debian_fremantle / README
1 The Debian Package qwerkisync
2 -----------------------------
3
4 This package will import and export your communications data to and from files.
5
6 It's alpha-quality. Understand this. That said, I use it and haven't had major
7 problems with it yet.
8
9 It will create backups of your communications database files each time it is
10 used. These are located in the usual backups folder should you ever need to
11 recover them manually. It will cycle these backups, keeping at most the last 3.
12
13 Currently, it supports SMS message import/export to/from VMG files as well as
14 voice call logs in a CSV representation of the tables in the Symbian event log
15 database as described at teh end of this file. I plan to add MMS, and chat log
16 support. I also plan to add support for mutiple formats for each of these in
17 time (i.e. Android-compatible formats). It also currently preserves
18 SMS-transported data such as clender events and configuration data. these will
19 show in the rtcom-messaging-ui as contact cards as that's the only attachment it
20 expect SMSes to have. They have ot be stored however to ensure the export is the
21 same as the import.
22
23 The backends it currently supports are Maemo5's rtcom-eventlogger for all event
24 types other than MMS and it will (hopefully!) shortly support Fmms on Maemo5 for
25 MMSs.
26
27 In the long-term, I plan to add MMS support to the normal rtcom-eventlogger (and
28 fork Fmms to use this instead) and will add support for this format to the
29 program.
30
31 ...in the long-long future I'd like to reimplement the rtcom-messaging-ui
32 component so that's another closed-source package to tick off the freedom list,
33 obviously adding support for the new events I'll be adding.
34
35 Symbian Event Log Format
36 ------------------------
37
38 A Symbian event log is a bianry database in their own special format. AFAIK, no
39 easy open code exists to work with these as the libraries are part of the
40 Symbian SDK. Using a tool known as "DBShell" obtained from:
41 http://sites.google.com/site/garawaa/
42 ...you can load these files and export the data within as a CSV. The tool is
43 very buggy though.
44
45 You will want to export the "event" table to a CSV file (can have any filename).
46 In order for Qwerkisync to process the file it must contain the following
47 required headers:
48 "EType", "ETime", "Remote", "Direction", "Status", "Duration", "Number", "Data"
49
50 You will also need to export the "string" table as "string.csv" in the same
51 folder as the events CSV.
52
53 An export of your current data should give you a good example to work from.
54
55  -- Jamie Thompson <maemo@jamie-thompson.co.uk>  Thu, 13 Oct 2011 02:00:00 +0100