summaryrefslogtreecommitdiffstats
path: root/doc/kpilot/usage.docbook
blob: 803da4ba5c3eda1d42fac887c801960362fb7115 (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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
<chapter id="using-kpilot">
<title>Using &kpilot; Data Viewers and Main Window Interface</title>

<para>
This chapter describes the usage of &kpilot;'s main window; as a viewer
application for data on the &handheld;, and  its menu structure.
The main window of &kpilot; also contains
the &HotSync;-log, which can be useful when
debugging problems.
</para>

<para>
&kpilot; starts up with a splash screen, and then switches to showing the
&HotSync;-log, as shown <link linkend="main-app">here</link>.
</para>

<sect1 id="main">
<title>The Main Window</title>

<screenshot id="main-app">
<screeninfo>&kpilot; Main Window</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="main-app.png" format="PNG"/></imageobject>
<textobject><phrase>The Main Window</phrase></textobject>
<caption><para>The Main Window</para></caption>
</mediaobject>
</screenshot>

<para>
The main window contains the application menu, which we will deal with here.
</para>

<para>
The <guimenu>file</guimenu> menu contains the synchronization menu items. Note
that these items do not start the sync process, they only select what the new
sync will be. To really start it, you must press the HotSync button on your
&PalmPilot;'s cradle (or on the &handheld; itself, when there is no cradle).
</para>
<note>
<para>
It is not possible to cancel a sync operation once the request has been made.
</para>
</note>
<para>
For more information regarding the synchronization functionality, please check the
<link linkend="synchronization">Synchronization Chapter</link> of this handbook,
where you can find detailed descriptions of the synchronization methods
and options offered by &kpilot;.
</para>

<variablelist id="menu-file">

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>HotSync</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Make the next sync a &HotSync;. For more information, please check the
<link linkend="sync-s"> Syncing your &handheld; data</link> section of this
handbook.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>FastSync</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
(not available with all installations)
Make the next sync a FastSync. For more information, please check the
<link linkend="sync-s">Syncing your &handheld; data</link> section of this
handbook.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>FullSync</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
(not available with all installations)
Make the next sync a FullSync. For more information, please check the
<link linkend="sync-s"> Syncing your &handheld; data</link> section of this
handbook.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Backup</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Make the next sync a full backup of your &PalmPilot; data. This action can take
several minutes. For more information, please check the
<link linkend="backup"> Backing up your &handheld; data</link> section of this
handbook.
</para>
<tip>
<para>
The first thing you should do after starting &kpilot; for
the first time is make a full backup.
</para>
</tip>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Restore</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This copies all the data from a previous backup on your
<acronym>PC</acronym> to your &PalmPilot;,
replacing whatever data was there.
Use this if your &PalmPilot; suffers some from software or hardware failure
(or is replaced by a new one). For more information, please check the
<link linkend="restore"> Restoring your &handheld; data</link> section of this
handbook.
</para>
<warning>
<para>
Doing a restore will erase all data on the &PalmPilot;
before restoring the information from your
<acronym>PC</acronym>!</para>
</warning>
</listitem>
</varlistentry>


<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Copy Handheld to PC</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This runs all conduits and syncs all databases, but instead of merging the
information from both sources, it will copy the handheld data to the PC.
<emphasis>Use with care, as this option erases the changes
you made in your PC since the last sync</emphasis>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Copy PC to Handheld</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This runs all conduits and syncs all databases, but instead of merging the
information from both sources, it will copy the PC data to the handheld.
<emphasis>Use with care, as this option erases the changes
you made in your handheld since the last sync</emphasis>.</para>
</listitem>
</varlistentry>


<!--
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>List Only</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
The next sync will only list the databases on your &handheld;, no exchange of
data will be performed.
</para>
</listitem>
</varlistentry>
-->

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Quits &kpilot;, closing the main window and stopping the
daemon if that
<link linkend="stopdaemononexit">configuration option</link>
is enabled.
</para>
</listitem>
</varlistentry>
</variablelist>


<para>
The <guimenu>Settings</guimenu> menu allows you to configure &kpilot; main
interface and fine-tune the synchronization process with the &handheld;.
</para>

<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Statusbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Click this menu item to toggle &kpilot;'s status bar on and off, or in other
words, to show it if hidden, or to hide it if shown.  
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Click this menu item to toggle &kpilot;'s toolbar on and off, or in other
words, to show it if hidden, or to hide it if shown.  
</para>
</listitem>
</varlistentry>


<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Displays &kpilot;'s shortcut configuration dialog, allowing you change or create
key bindings, which are associations between actions (for example, opening
&kpilot;'s configuration dialog) and keys or key combinations (for instance,
Ctrl + Shift + a).
</para>
</listitem>
</varlistentry>


<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Displays &kpilot;'s toolbar configuration dialog. This dialog lists all actions
available for use on the toolbar, and the actions currently displayed, allowing
you to add or remove actions, and move the actions which already are on the
toolbar.
</para>
</listitem>
</varlistentry>


<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure KPilot...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Displays &kpilot;'s configuration dialog, allowing you to match your hardware
with the configuration, so that &kpilot; can talk with your &handheld;, to
configure the way &kpilot; synchronizes your &PalmPilot; with your
desktop applications (through conduits) and the way it shows the data from your &PalmPilot; in the
<link linkend="builtin">built-in viewers</link>. The <link linkend="configure">
Configuring &kpilot;</link> chapter of this handbook offers detailed information
about these configuration options.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configuration Wizard...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Displays &kpilot;'s configuration wizard dialog. The
<link linkend="configwizard">configuration wizard</link> helps you to set up
&kpilot; to communicate with the &PalmPilot; and to configure the conduits as
a group. It's a great start for new users, and you can always fine-tune your
preferences later, using the <link linkend="configure">configure
dialog</link>.
</para>
</listitem>
</varlistentry>


</variablelist>


</sect1>

<sect1 id="builtin">
<title>
Built-in Applications
</title>

<para>
To select one of the Built in applications, just click its icon on &kpilot;'s
sidebar.
</para>

<screenshot>
<screeninfo>KPilot's Sidebar</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="sidebar.png" format="PNG"/></imageobject>
<textobject><phrase>KPilot's Sidebar</phrase></textobject>
<caption><para>KPilot's Sidebar</para></caption>
</mediaobject>
</screenshot>


<para>
Selecting one of the built-in applications
will cause that application to appear in &kpilot;'s main
window.
You may use the viewer applications to edit the information, by enabling
this option in the <link linkend="page-viewers">database viewer's
configuration dialog</link>. The ability to view and edit private records is
configurable too.</para>

<para>
Any changes you make to the &PalmPilot; databases with
the built-in applications (such as deleting a memo)
do not take effect on the &PalmPilot; until the next HotSync.
</para>

<important><para>
If the <guilabel>Make internal viewers editable</guilabel> option is
not enabled, the changes in the viewers are not synchronized with your
&handheld;, and will be lost. In recent versions of &kpilot; it is not possible
enable this option, and therefore, to edit the databases with the viewers.
</para></important>

<sect2 id="todo-app">

<title>The Todo Viewer</title>

<para>
The todo application allows you to view the tasks from your &PalmPilot;,
add new tasks and edit or delete existing ones. The changes you made
are applied to the &handheld; the next time you &HotSync;.
</para>

<screenshot>
<screeninfo>Todo Viewer Application</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="todo-app.png" format="PNG"/></imageobject>
<textobject><phrase>The Todo Viewer Application</phrase></textobject>
<caption><para>The Todo Viewer Application</para></caption>
</mediaobject>
</screenshot>

<para>
The todo application has a drop down box
for the memo categories defined in the &PalmPilot;.
In the screenshot, category <quote>All</quote> is selected.
Underneath the drop down box is a list of todo entries, with a check box
indicating if they are completed or not. You can click the check box to toggle
the todo item between completed and not completed status. Clicking on one of the
todo items in the list will display its details in the text box labelled
<guilabel>Todo info:</guilabel> to the right.
</para>

<para>
If you have the <guilabel>Make internal viewers editable</guilabel> option
enabled in the <link linkend="page-viewers">viewers configuration page</link> you
can use the buttons <guibutton>Edit Record...</guibutton>,
<guibutton>New Record...</guibutton> and <guibutton>Delete Record</guibutton>
to edit the todo data from your &handheld;, and sync the data in the next
&HotSync;.</para>

<!--
<note><para>
If you create new todo and decide that
you do not want to have it on the &PalmPilot;
you must perform a &HotSync; (copying the todo
to the &PalmPilot;) and then delete the todo record
from the &PalmPilot; or the viewer, and &HotSync; again. It is not possible to
delete newly-added records from the built-in applications.
</para></note>
-->

<para>
The <guibutton>Edit Record...</guibutton> button opens a dialog where you can 
edit the details of the currently selected todo item, including description,
priority and end date. Click the <guibutton>New Record...</guibutton> button to
open the same dialog, but instead of editing the current selected record, a new
todo will be added to the list. And finally, click the
<guibutton>Delete Record</guibutton> button to remove the selected todo record
from the list.
</para>

</sect2>

<sect2 id="address-app">
<title>The Address Viewer</title>
<para>
The address viewer lets you view, create, delete and edit addresses
from the &PalmPilot;, and synchronize changes back. The addresses can be 
sorted and viewed in the <guilabel>"Last, first"</guilabel> or <guilabel>"Company,
last"</guilabel> format, depending on your
<link linkend="page-viewers">viewers configuration.</link>
</para>

<screenshot>
<screeninfo>The Address Viewer Application</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="address-app.png" format="PNG"/></imageobject>
<textobject><phrase>The Address Viewer Application</phrase></textobject>
<caption><para>The Address Viewer Application</para></caption>
</mediaobject>
</screenshot>


<para>
The address application resembles the todo application;
the drop down box, buttons, list and text area function exactly
the same, allowing you to select, view and edit an address
as on the &PalmPilot;.
</para>

<para>
The <guibutton>Edit Record...</guibutton> dialog allows you to edit the
<guilabel>Last Name</guilabel>, <guilabel>First Name</guilabel>,
<guilabel>Company</guilabel>, &etc; fields, just as if you where using your
&handheld;.  Click the <guibutton>New Record...</guibutton> button to
open the same dialog, but instead of editing the current selected record, a new
address will be added to the list. Click the
<guibutton>Delete Record</guibutton> button to remove the selected address
from the list.

<!--
<note><para>
If you create new address and decide that
you do not want to have it on the &PalmPilot;
you must perform a &HotSync; (copying the address
to the &PalmPilot;) and then delete the address record
from the &PalmPilot; or the viewer, and &HotSync; again. It is not possible to
delete newly-added records from the built-in applications.
</para></note>
-->

</para>
</sect2>


<sect2 id="memo-app">

<title>The Memo Viewer</title>

<para>
The memo application allows you to view the memos on your &PalmPilot;,
export them to text files, import new ones to be installed the next
time you &HotSync;, or edit existing ones.
</para>

<screenshot>
<screeninfo>Memo Viewer Application</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="memo-app.png" format="PNG"/></imageobject>
<textobject><phrase>The Memo Viewer Application</phrase></textobject>
<caption><para>The Memo Viewer Application</para></caption>
</mediaobject>
</screenshot>

<para>
The memo application has a drop down box
for the memo categories defined in the &PalmPilot;.
Here category <quote>All</quote> is selected.
Underneath the drop down box is a list of memo titles.
These are the first lines of the memos, just like
in the &PalmPilot; memo application.
Clicking on one of the memo titles in the list
box will display it in the text box labelled
<guilabel>Memo Text:</guilabel> to the right.
</para>

<para>
When a memo is selected, you can use the buttons
<guibutton>Export Memo...</guibutton> and
<guibutton>Delete Memo</guibutton>
to export the selected memo to a file
or to delete the selected memo.
Exporting a memo requires
you to give a filename; the memo
is written to that file.
Take care not to overwrite existing files with this action.
Deleting a memo does not affect the &PalmPilot;
until the next &HotSync;.
</para>

<para>
The
<guibutton>Import Memo...</guibutton>
button allows you to read a text file and
add it &mdash; as a memo &mdash; to the &PalmPilot;.
Importing a memo does not take effect until
the next &HotSync;.

<!--
<note><para>
If you import a memo and decide that
you do not want to have it on the &PalmPilot;
you must perform a &HotSync; (copying the memo
to the &PalmPilot;) and then delete the memo record
from the &PalmPilot; or the viewer, and &HotSync; again. It is not possible to
delete newly-added records from the built-in applications.
</para></note>
-->

</para>


</sect2>

<sect2 id="db-app">
<title>The Generic DB Viewer</title>

<para>
In short, databases are all files stored in your &handheld;. A database
can be either a record database, which stores dynamic information created by the
user (for instance, the addresses or the todo information), or a resource
database, which tend to be static (for instance the applications).
</para>

<para>
The Generic DB Viewer is a tool to view and analyze databases stored on
your handheld, especially record databases. It helps a lot creating new conduits
and to debug existing ones.

<warning><para>
While it is possible use the database viewer to edit, add and delete records, you
should really know what you are doing, otherwise you may damage your data. Use
the viewer applications or conduits to edit your &handheld; data instead, in a
normal usage scenario.
</para></warning>

</para>



<screenshot>
<screeninfo>The Generic DB Viewer</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="db-app.png" format="PNG"/></imageobject>
<textobject><phrase>The Generic DB Viewer</phrase></textobject>
<caption><para>The Generic DB Viewer</para></caption>
</mediaobject>
</screenshot>

</sect2>


<sect2 id="installer-app">
<title>The File Installer</title>
<para>
Just hit the
<guibutton>Add File...</guibutton> button to add a file to the
<guilabel>Files to Install:</guilabel> list. These files will
be installed on your &PalmPilot; during the next &HotSync; if
<guilabel>Sync Files</guilabel>
is checked in the conduits section of the
<link linkend="configure">configuration dialog</link>.
If you choose not to
install these files on the &PalmPilot;, just hit
<guibutton>Clear List</guibutton>
to remove any pending files.
</para>

<para>
If you are using the &HotSync; Daemon you may drag and
drop files or &URL;s
onto the docked icon on the toolbar. The file installer application also
supports dragging and dropping into the <guilabel>Files to Install:</guilabel>area.
Provided <guilabel>Sync Files</guilabel> is checked in the
<link linkend="page-general">settings dialog</link> they
will be installed the next time you HotSync.
</para>

<tip>
<para>An internal copy of the
file is kept, so you can even drag and drop &URL;s from
&konqueror;!
</para>
</tip>

<screenshot>
<screeninfo>The File Installer</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="file-app.png" format="PNG"/></imageobject>
<textobject><phrase>The File Installer</phrase></textobject>
<caption><para>The File Installer</para></caption>
</mediaobject>
</screenshot>

</sect2>
</sect1>

</chapter>