syncml-obex-client(1)

1syncml-obex-client(1)                libs                syncml-obex-client(1)
2
3
4

NAME

6       syncml-obex-client - simple obex client built on libsyncml
7

SYNTAX

9       syncml-obex-client [option]
10       syncml-obex-client --sync <type> <path>
11

DESCRIPTION

13       Simple obex client built on libsyncml
14       syncml-obex-client  is  not  a  real synchronization tool. It is rather
15       used for testing.  The tool will list all entries that the device wants
16       to sync and is also capable of adding items to the device.
17

USAGE

19       First you should connect your device with the usb cable.
20       Then make sure that the lsusb command lists your device.
21       Now we can enumerate the interface available on your device. To do this
22       type (as root!):
23
24              syncml-obex-client -u
25
26       This should generate some output like this:
27
28              Found 2 USB OBEX interfaces
29              Interface 0:
30                      Manufacturer: Nokia
31                      Product: Nokia 6680
32                      Interface description: SYNCML-SYNC
33              Interface 1:
34                      Manufacturer: Nokia
35                      Product: Nokia 6680
36                      Interface description: PC Suite Services
37
38       It is important  that  you  have  an  interface  with  the  description
39       "SYNCML-SYNC".   This is the interface we are going to use. Now you can
40       run the first "sync" against the device.
41

OPTIONS

43       --sync <type> <path> Emulate a database of the given type on the url.
44
45       --slow-sync <type> <path> Emulate a database of the given type  on  the
46       url and use slow-sync
47
48              type should be a IANA registered mimetype or your own type.
49              Common types are:
50
51              - "text/x-vcard" for contacts,
52              - "text/x-vcalendar" for events,
53              - "text/plain" for notes and
54              - "text/x-vMessage" for SMS
55
56              path  is the local name of the database. You can choose anything
57              there.
58
59       [-u <id>]  Connect to the given usb interface number
60              If you don't specify an id, all  available  interfaces  will  be
61              listed.
62
63       [-b <addr> <channel>]  Connect to the given bluetooth device
64
65       [--identifier <name>]  Use the given identifier in the initial alert.
66              Some  devices  require a special string here. Nokias for example
67              require "PC Suite".
68
69       [--version <version>]  Set the given version. version can be "1.0",
70              "1.1" or "1.2"  (The default is "1.1")
71
72       --add <type> <path>  Add the file given in path to the  device  as  the
73       given type
74
75              type should be a IANA registered mimetype or your own type.
76              Common types are:
77
78              - "text/x-vcard" for contacts,
79              - "text/x-vcalendar" for events,
80              - "text/plain" for notes and
81              - "text/x-vMessage" for SMS
82
83              path  to the file to add. The file has to be a VCard, VCalendar,
84              etc.
85
86       [--wbxml] Use wbxml (WAP Binary XML) instead of plain xml
87
88       [--recvLimit <limit>] Limit the size of the receiving  buffer  to  this
89       size (Needed for some phones)
90
91       [--maxObjSize <limit>] The maximum size of a object that we can receive
92       (Needed for some phones)
93
94       [--useStringTable] Use wbxml string tables (Improves transmission size,
95       but not supported by some phones)
96
97       [--dumpinfo] Print info about the phone at the end which can be sent to
98       the developers
99

EXAMPLES

101       If you want to display the contacts for example you could type:
102
103              syncml-obex-client -u 0 --identifier "PC Suite"  --sync  text/x-
104              vcard Contacts
105
106       The  number  after  -u has to be the interface number of "SYNCML-SYNC".
107       With the identifier you can tell the tool to identify itself  as  some‐
108       thing  different  (like the Nokia PC Suite in the example).  The --sync
109       options states that you want to sync vcards and that your  local  data‐
110       base is named "Contacts".  This example would send syncml as plain xml.
111       Another example:
112
113              syncml-obex-client  -u  0 --identifier "PC Suite" --sync text/x-
114              vcard Contacts --sync text/x-vcalendar Calendar --wbxml
115
116       This would enable the usage of wap binary xml and get the contacts  and
117       the calendar entries (This example works for a Nokia 6680).
118

TROUBLESHOOTING

120       If it does not work try the following:
121        - Run the syncml-obex-client commands as root.
122        - Play with the identifier string
123        -  Switch between xml and wbxml using the --wbxml switch (Most devices
124       use wbxml)
125        - Change the name of the database ("Contacts" and  "Calendar"  in  the
126       example)
127        -  Phones  (and parts of phones) crash quite often. You should restart
128       your phone if everything fails and see if that helps
129

ENVIRONMENT VARIABLES

131       When you want to provide trace files please turn on tracing like this:
132
133       export SYNCML_TRACE=/path/to/log/dir
134       export SYNCML_LOG = /path/to/log/dir
135
136       Run the tool again with tracing enabled to get a trace (2 files in  the
137       log directory).
138

AUTHORS

143       This  manual  page  was  written  for  the  Debian GNU/Linux project by
144       Matthias Jahn <jahn.matthias@freenet.de>.  But it may be used by  other
145       distributions.
146
147       syncml-obex-client was written by Armin Bauer and the OpenSync project
148
149
150
151Armin Bauer <armin.bauer@desscon.com>0.4.1               syncml-obex-client(1)