~ubuntu-branches/ubuntu/karmic/opensync/karmic

« back to all changes in this revision

Viewing changes to docs/example-plugin/README

  • Committer: Bazaar Package Importer
  • Author(s): Robert Collins
  • Date: 2005-12-18 00:59:13 UTC
  • Revision ID: james.westby@ubuntu.com-20051218005913-8keii9amu8dfkfnp
Tags: upstream-0.18
ImportĀ upstreamĀ versionĀ 0.18

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Hi,
 
2
 
 
3
so you are interested in writing a plugin for the
 
4
OpenSync synchronization framework... Great! :)
 
5
 
 
6
Here is what you have to do:
 
7
 
 
8
Edit the files
 
9
 
 
10
AUTHORS
 
11
INSTALL
 
12
LICENSE
 
13
 
 
14
and fill in the required information. Then edit:
 
15
 
 
16
configure.in
 
17
 
 
18
and add any checks etc that you need for you plugin
 
19
to function.
 
20
 
 
21
Then go to src/ and edit:
 
22
 
 
23
Makefile.am
 
24
 
 
25
there to suit your needs. Afterwards take a look at the example
 
26
source files of the plugin
 
27
 
 
28
plugin.c
 
29
plugin.h
 
30
 
 
31
and start writing the functions you need to connect, read and write
 
32
etc to your device.
 
33
 
 
34
Then edit the default config file which must be the same name
 
35
as your plugin:
 
36
 
 
37
plugin
 
38
 
 
39
if you need to write a format plugin take a look at
 
40
 
 
41
format.c
 
42
 
 
43
Before running ./configure the first time you need to run
 
44
./autogen.sh once.
 
45
 
 
46
If you need help, feel free to ask on the opensync mailing lists:
 
47
http://sourceforge.net/projects/opensync and go to "Lists"
 
48
 
 
49
or ask on our irc channel:
 
50
server: irc.freenode.org
 
51
channel: #opensync