summaryrefslogtreecommitdiffstats
path: root/doc/kandy/index.docbook
blob: 834df10ba1fb74ef0fccf6207ef57f585d1f83b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&kandy;">
  <!ENTITY package "tdepim">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>

<book lang="&language;">
<bookinfo>
<title>The &kandy; Handbook</title>
<authorgroup>
<author>
<firstname>Cornelius</firstname>
<surname>Schumacher</surname>
<affiliation>
<address><email>schumacher@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<date>2002-02-05</date>
<releaseinfo>0.03.00</releaseinfo>
<abstract>
<para>&kandy; is an application for synchronizing the data on a mobile phone
with the data on the desktop.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>tdepim</keyword>
<keyword>kandy</keyword>
<keyword>synchronizing</keyword>
<keyword>phone</keyword>
</keywordset>
</bookinfo>

<chapter id="using-kandy">
<title>Using &kandy;</title>

<sect1 id="terminal">
<title>The Terminal Window</title>

<para>The terminal window provides a low-level interface for controlling
the mobile phone via <command>AT</command> modem commands. You can type
in commands in the upper middle field: the lower-middle fields show
the direct response of the mobile phone; the right side of the main
window shows the processed output.</para>

<para> On the left side you have the list of available commands; you
can execute them by double-clicking on them or by pressing the
<guibutton>Execute</guibutton> button. The modem response output
fields show what happens.  If you have typed in a new command you can
add it to the list of available commands by pressing the
<guibutton>Add</guibutton> button; a dialog will pop up to allow you
select a name and parameters for the command.</para>

<para>The command list is saved to an &XML; file by selecting
<guimenuitem>Save</guimenuitem> from the menu or by pressing the
corresponding toolbar button. You can load an existing file by selecting
<guimenuitem>Open</guimenuitem> from the menu.</para> 

</sect1>

<sect1 id="mobilegui">
<title>Mobile Interface Window</title>

<para>By choosing <guimenuitem>Mobile GUI</guimenuitem> from the
<guimenu>Show</guimenu> menu of the terminal window you open the
Interface Window for your mobile phone. This shows a comprehensive view
of the status and data present on the phone including the
phonebook. There are twos list of phonebook data: one representing the
&kde; address book; the other representing the data on the
phone.</para>

<para>You can read the phone books by pressing the
<guibutton>Read</guibutton> button right under the corresponding
list. By pressing the <guibutton>Write</guibutton> button you write back
the data shown in the list to the corresponding phonebook. By pressing
<guibutton>Save to File</guibutton> you can store the mobile phonebook
as list of comma-separated values to disk.  After loading the phonebook
data using the <guibutton>Read</guibutton> buttons you can merge the
phonebooks by pressing the <guibutton>Merge</guibutton> button: this
will put data only present in one of the phonebooks into the other and
vice versa; if conflicts occur during this process, a dialog pops
up.</para>

<para>The <guibutton>Sync</guibutton> button performs all the actions
needed for syncing the phonebooks. It reads the data from the &kde;
addressbook and the mobile phone, does the merge and writes it
back.</para>

</sect1>

<sect1 id="configuring">
<title>Configuring &kandy;</title>

<para>By selecting the entry <guimenuitem>Configure Kandy</guimenuitem>
from the menu you get the preferences dialog of &kandy;. You can set the
name of the serial device where your mobile is connected in this
dialog; examples for the name of the serial device under &Linux; are
<filename class="devicefile">/dev/ttyS0</filename> for the first and
<filename class="devicefile">/dev/ttyS1</filename> for the second serial
interface of your computer. You can also set which windows are opened
by default when starting &kandy;.</para>

</sect1>

</chapter>

<chapter id="menu-ref">
<title>Menu Reference</title>

<sect1>
<title><guimenu>File</guimenu> menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">
&Ctrl;<keycap>Q</keycap>
</keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Exit</action> &kandy;.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="show-menu">
<title><guimenu>Show</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Show</guimenu>
<guimenuitem>Terminal</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open the terminal window</action>, where you can interact
with your phone via <command>AT</command> commands.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="modem-menu">
<title><guimenu>Modem</guimenu> menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Modem</guimenu>
<guimenuitem>Connect</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Connect to your phone.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Modem</guimenu>
<guimenuitem>Disconnect</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Disconnect from your phone.</action></para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="settings-menu">
<title><guimenu>Settings</guimenu> menu</title>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Toggle whether the toolbar should be displayed.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenu>Show Statusbar</guimenu>
</menuchoice>
</term>
<listitem>
<para><action>Toggle whether the statusbar should be displayed.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open a standard dialog to modify shortcut
keybindings.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open a standard dialog to modify the icons on the
toolbar.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Kandy...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Opens a dialog where you can customize the
application.</action>;  this is described further in the <xref
linkend="configuring"/> section.</para>
</listitem>
</varlistentry>

</variablelist>
</sect1>

<sect1 id="help-menu">
<title><guimenu>Help</guimenu> menu</title>

&help.menu.documentation;

</sect1>

</chapter>

<chapter id="credits">
<title>Credits and Licenses</title>

<para>&kandy; copyright 2001 Cornelius Schumacher
<email>schumacher@kde.org</email>.</para>

<para>Documentation by Cornelius Schumacher, with additions by Lauri
Watts <email>lauri@kde.org</email>.</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underGPL;
&underFDL;

</chapter>

<appendix id="installation">
<title>Installation</title>

<sect1 id="getting-kandy">
<title>How to obtain &kandy;</title>

&install.intro.documentation;

</sect1>

<sect1 id="kandy-requirements">
<title>Requirements</title>

<para>You will need to have the tdelibs package installed in order to
successfully compile the tdepim package that contains &kandy;.  The
tdelibs package may be found at the same location as the tdepim
package.</para>

<para>The &kaddressbook; is part of the tdebase package.  This can also
be found at the same location as the tdepim package.</para>

</sect1>

<sect1 id="compilation">
<title>Compilation and Installation</title>

&install.compile.documentation;

<para>Compiling and installing the required tdelibs package follows the
same process.  If you encounter any problems compiling or installing
&kandy;, help may be obtained from the <ulink
url="http://www.kde.org/mailinglists.html">&kde; mailing lists </ulink>
or from the Usenet newsgroup: comp.windows.x.kde.</para>
</sect1>
</appendix>

<appendix id="developer-info">
<title>Developer Information</title>

<sect1 id="dcop">
<title><acronym>DCOP</acronym> Interface</title>

<para>&kandy; provides a <acronym>DCOP</acronym> interface
<interfacename>KandyIface</interfacename> with the following functions:
<function>syncPhonebook()</function> syncs the mobile phone book book
with the &kde; address book. This is equivalent to pressing the
<guibutton>Sync</guibutton> button in the Mobile Interface
Window. <function>exit()</function> closes &kandy;.</para>

</sect1>

</appendix>

</book>

<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:

// vim:ts=2:sw=2:tw=78:noet
-->