TDE personal information management applications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

sync.docbook 14KB

  1. <chapter id="synchronization">
  2. <title>Syncing your &handheld; with a PC</title>
  3. <para>
  4. This chapter describes the synchronization process
  5. that &kpilot; uses, focusing on the &kpilot; daemon functionality.
  6. You may sync your &handheld; using the <link linkend="builtin">internal
  7. viewers</link> and / or <link linkend="conduits">conduits</link>, depending
  8. on your personal preferences. Conduits allow external applications to interface
  9. with the data on your &handheld;.
  10. </para>
  11. <para>
  12. It is a good idea to make a <link linkend="backup">backup</link>
  13. of your &handheld; regularly. Other than making backups, it should rarely be
  14. necessary to do anything other than drop your &handheld; on the cradle and press
  15. the &HotSync; button. The &kpilot; daemon icon in the system tray will flash
  16. indicating that a sync is under way.
  17. </para>
  18. <screenshot>
  19. <screeninfo>&kpilot; Daemon Pop-Up Menu</screeninfo>
  20. <mediaobject>
  21. <imageobject><imagedata fileref="daemon-menu.png" format="PNG"/></imageobject>
  22. <textobject><phrase>&kpilot; daemon popup menu</phrase></textobject>
  23. <caption><para>&kpilot; daemon popup menu</para></caption>
  24. </mediaobject>
  25. </screenshot>
  26. <para>
  27. To which type of sync &kpilot; will perform next, you can use the main
  28. application
  29. <link linkend="menu-file">
  30. <menuchoice>
  31. <guimenu>File</guimenu>
  32. </menuchoice>
  33. menu</link>,
  34. or right click the &kpilot; daemon icon located in the system tray,
  35. and select one of the menu items under the
  36. <menuchoice>
  37. <guisubmenu>Next Sync</guisubmenu>
  38. </menuchoice>
  39. sub menu.
  40. <tip><para>
  41. If you hover over the &kpilot; daemon icon, a tooltip will appear showing you
  42. what the type of sync &kpilot; will perform next.
  43. </para></tip>
  44. </para>
  45. <para>
  46. In short, the sync types are:
  47. </para>
  48. <itemizedlist>
  49. <listitem><para>
  50. <guilabel>HotSync (once)</guilabel>: this option offers
  51. a nice balance between speed and data safety.
  52. </para></listitem>
  53. <listitem><para>
  54. <guilabel>FastSync (once)</guilabel>: only sync those
  55. databases that have conduits.
  56. </para></listitem>
  57. <listitem><para>
  58. <guilabel>FullSync (once)</guilabel>: the safest option, but
  59. takes the longest time to complete.
  60. </para></listitem>
  61. <listitem><para>
  62. <guilabel>Backup (once)</guilabel>: copy all the data from the &handheld; to the
  63. <acronym>PC</acronym>.
  64. </para></listitem>
  65. <listitem><para>
  66. <guilabel>Restore from Backup (once)</guilabel>: copy the data from a previous backup from the PC to the
  67. &handheld;, erasing the data previously held there.
  68. <warning><para>
  69. Use the restore functionality with care, as you can lose all the new
  70. data entered on the &handheld; since the last backup.
  71. </para></warning>
  72. </para>
  73. </listitem>
  74. <listitem>
  75. <para>
  76. <guilabel>Copy Handheld to PC (once)</guilabel>: run all conduits and
  77. sync all databases, but instead of merging the information from both sources,
  78. just copy the handheld data to the PC.
  79. <warning><para>Use with care, as this option erases the changes
  80. you made in your PC since the last sync.</para></warning>
  81. </para>
  82. </listitem>
  83. <listitem>
  84. <para>
  85. <guilabel>Copy PC to Handheld (once)</guilabel>: run all conduits and
  86. sync all databases, but instead of merging the information from both sources,
  87. just copy the PC data to the handheld.
  88. <warning><para>Use with care, as this option erases the changes
  89. you made in your handheld since the last sync.</para></warning>
  90. </para>
  91. </listitem>
  92. </itemizedlist>
  93. <para>
  94. Alternatively, you can change the default syncing behavior of &kpilot; by
  95. choosing the most suitable option in the <link linkend="page-hotsync">&HotSync;
  96. configure dialog</link>.
  97. <note><para>
  98. To configure the conduits or the sync process, you do not need to open the main
  99. &kpilot; application, as the
  100. <menuchoice>
  101. <guimenuitem>Configure KPilot...</guimenuitem>
  102. </menuchoice>
  103. menu item is available on the &kpilot; daemon popup menu as well.
  104. </para></note>
  105. </para>
  106. <sect1 id="backup">
  107. <title>Backing up your &handheld; data</title>
  108. <para>
  109. On every backup, &kpilot; stores a copy of all your &handheld; data under the
  110. <filename class="directory">$TDEHOME/share/apps/kpilot/DBBackup/User Name/</filename>
  111. folder, allowing you to restore that copy later, if needed. The
  112. <filename class="directory">$TDEHOME</filename> environment variable
  113. (typically <filename class="directory">/home/Login Name/.trinity/</filename>)
  114. points to the folder that contains your configuration and data for the &kde;
  115. applications.</para>
  116. <para>
  117. It is a good idea to backup your data often. To perform a backup, you can click
  118. the
  119. <menuchoice>
  120. <guisubmenu>Next Sync</guisubmenu>
  121. <guimenuitem>Backup</guimenuitem>
  122. </menuchoice>
  123. on the &kpilot; daemon icon popup menu or the
  124. <menuchoice>
  125. <guimenu>File</guimenu>
  126. <guimenuitem>Backup</guimenuitem>
  127. </menuchoice>
  128. menu item on the main &kpilot; application menu in order
  129. to make the next sync a backup. Then, just press the &HotSync; button.
  130. </para>
  131. </sect1>
  132. <sect1 id="restore">
  133. <title>Restoring Your &handheld; Data</title>
  134. <para>
  135. The restore operation consist of transferring all the data previously saved on
  136. the <acronym>PC</acronym> to the &handheld;, effectively erasing all the new
  137. data held by the device by returning it to a previous state.
  138. <warning><para>
  139. Use the restore functionality with care, as you can lose all the new
  140. data entered on the &handheld; since the last backup.
  141. </para></warning>
  142. </para>
  143. <para>
  144. The data saved on the last backup is located on the <filename class="directory">$TDEHOME/share/apps/kpilot/DBBackup/User Name/</filename>
  145. folder. The <filename class="directory">$TDEHOME</filename> environment variable
  146. (typically <filename class="directory">/home/Login Name/.trinity/</filename>)
  147. points to the folder that contains your configuration and data for the &kde;
  148. applications.</para>
  149. <para>
  150. The most common use for the restore functionality is to recover from a hardware
  151. or software failure on the device.
  152. The restore function can be accessed from the
  153. main &kpilot; application, and from the &kpilot; daemon. be careful, as
  154. restoring the data is not a common operation. In order
  155. to restore the data at the next sync, click the
  156. <menuchoice>
  157. <guimenu>File</guimenu>
  158. <guimenuitem>Restore</guimenuitem>
  159. </menuchoice>
  160. menu item, then press the &HotSync; button.
  161. </para>
  162. </sect1>
  163. <sect1 id="sync-s">
  164. <title>Selecting the Synchronization Type</title>
  165. <para>
  166. There are three ways to sync your &handheld;, <guilabel>HotSync</guilabel>,
  167. <guilabel>FastSync</guilabel> or <guilabel>FullSync</guilabel>.
  168. </para>
  169. <para>
  170. When you press the &HotSync; button on your &handheld;, &kpilot;'s will run the
  171. default sync operation (usually a <guilabel>HotSync</guilabel>). You can select
  172. the default sync operation in the <link linkend="page-hotsync">&HotSync;
  173. configure dialog</link>. Alternatively, you can click one of the sync options on
  174. the main &kpilot; application
  175. <menuchoice>
  176. <guimenu>File</guimenu>
  177. </menuchoice>
  178. menu or on the &kpilot; daemon popup
  179. <menuchoice>
  180. <guisubmenu>Next Sync</guisubmenu>
  181. </menuchoice>
  182. submenu.
  183. <important><para>
  184. Using the <link linkend="page-hotsync">&HotSync; configure dialog</link>
  185. is the only way to change the default sync operation.
  186. The main &kpilot; application
  187. <menuchoice>
  188. <guimenu>File</guimenu>
  189. </menuchoice>
  190. menu items or the &kpilot; daemon popup
  191. <menuchoice>
  192. <guisubmenu>Next Sync</guisubmenu>
  193. </menuchoice>
  194. submenu items change only the type of sync that will be performed <emphasis>next</emphasis>.
  195. </para></important>
  196. </para>
  197. <screenshot>
  198. <screeninfo>&kpilot; Daemon Pop-Up Menu</screeninfo>
  199. <mediaobject>
  200. <imageobject><imagedata fileref="daemon-menu.png" format="PNG"/></imageobject>
  201. <textobject><phrase>&kpilot; daemon popup menu</phrase></textobject>
  202. <caption><para>&kpilot; daemon popup menu</para></caption>
  203. </mediaobject>
  204. </screenshot>
  205. <para>
  206. For more information on the sync types, please refer to the descriptions
  207. available in <xref linkend="page-hotsync" />.
  208. </para>
  209. </sect1>
  210. <sect1 id="conduits">
  211. <title>Syncing your &handheld; Data Using Conduits</title>
  212. <para>
  213. Conduits are programs that interface your &handheld; data with
  214. <acronym>PC</acronym> applications or sync your &handheld; data with files
  215. that can be used by <acronym>PC</acronym> applications.
  216. </para>
  217. <para>
  218. Conduits can be set up by selecting
  219. <menuchoice>
  220. <guimenu>Settings</guimenu>
  221. <guimenuitem>Configure KPilot...</guimenuitem>
  222. </menuchoice>, or using the daemon pop up menu and clicking the
  223. <guimenuitem>Configure KPilot...</guimenuitem>
  224. menu item.
  225. </para>
  226. <screenshot>
  227. <screeninfo>&kpilot; Daemon Pop-Up Menu</screeninfo>
  228. <mediaobject>
  229. <imageobject><imagedata fileref="daemon-menu.png" format="PNG"/></imageobject>
  230. <textobject><phrase>&kpilot; daemon popup menu</phrase></textobject>
  231. <caption><para>&kpilot; daemon popup menu</para></caption>
  232. </mediaobject>
  233. </screenshot>
  234. <para>
  235. The <guilabel>Conduits</guilabel> tree in the configuration dialog
  236. collects all the installed conduits available.
  237. The conduits can be enabled and disabled
  238. by clicking on the check box to the left of the conduit's name.
  239. Conduits can have an extensive configuration of
  240. their own, and may be supplied by third parties.
  241. Most of the conduits require some initial configuration, so it is strongly
  242. recommended to check the
  243. <link linkend="config-conduits">section detailing the default conduits
  244. configuration</link> before using them.
  245. </para>
  246. <para>
  247. The default conduits are the following:
  248. </para>
  249. <variablelist>
  250. <varlistentry>
  251. <term><guilabel>KNotes / Memos</guilabel></term>
  252. <listitem><para>
  253. Synchronizes the Memo Pad application with &knotes;.
  254. <important><para>
  255. The conduit only synchronizes the Memo Pad data if &knotes; is running. If you
  256. want to enable this functionality, please remember to start &knotes; first, or
  257. check if it is already running (tip: look for the &knotes; icon in the system tray).
  258. </para></important>
  259. </para></listitem>
  260. </varlistentry>
  261. <varlistentry>
  262. <term><guilabel>Notepad</guilabel></term>
  263. <listitem>
  264. <para>
  265. Exports the free hand notes of the &handheld;'s Notepad application as pictures
  266. to the PC.
  267. </para>
  268. </listitem>
  269. </varlistentry>
  270. <varlistentry>
  271. <term><guilabel>Time Synchronization</guilabel></term>
  272. <listitem><para>
  273. Sets the &handheld;'s time to that of the desktop machine.
  274. Useful for keeping the clock of the &handheld; accurate.
  275. </para></listitem>
  276. </varlistentry>
  277. <varlistentry>
  278. <term><guilabel>Calendar (KOrganizer)</guilabel></term>
  279. <listitem><para>
  280. Synchronizes the Datebook application with &korganizer; or with a iCalendar file of
  281. your choice.
  282. </para></listitem>
  283. </varlistentry>
  284. <varlistentry>
  285. <term><guilabel>Palm DOC</guilabel></term>
  286. <listitem><para>
  287. Automatically converts, installs and sync text files in the &PalmPilot;
  288. DOC format, so you can read the text files with most DOC-capable
  289. applications on the &handheld;. There are many free or open source Palm
  290. DOC readers, and some Palm DOC editors for your handheld.</para>
  291. <para>
  292. Any plain text file can be easily converted. For instance, you can download and
  293. convert the public domain books provided by the <ulink url="">
  294. Gutenberg Project</ulink> and read them in your &handheld;.
  295. </para></listitem>
  296. </varlistentry>
  297. <varlistentry>
  298. <term><guilabel>Addressbook</guilabel></term>
  299. <listitem><para>
  300. Synchronizes the Address application with &kaddressbook; or with a vCard file of
  301. your choice.
  302. </para></listitem>
  303. </varlistentry>
  304. <varlistentry>
  305. <term><guilabel>System Information</guilabel></term>
  306. <listitem><para>
  307. Writes information about your &handheld;, (such as OS version,
  308. RAM available, and the list of databases) to a file. Useful mostly for
  309. debugging purposes.
  310. </para></listitem>
  311. </varlistentry>
  312. <varlistentry>
  313. <term><guilabel>ToDo's (KOrganizer)</guilabel></term>
  314. <listitem><para>
  315. Synchronizes the Todo list application with &korganizer; or with a iCalendar file of
  316. your choice.
  317. </para></listitem>
  318. </varlistentry>
  319. <varlistentry>
  320. <term><guilabel>MAL (AvantGo) Conduit</guilabel></term>
  321. <listitem><para>
  322. Synchronizes your &handheld; with the &AvantGo; server. The &AvantGo; server
  323. offers general content (news, guides, stock quotes, &etc;) in a format that is
  324. suitable for reading in a &handheld;. To use this conduit, you need to register, subscribe
  325. the channels you select and install the &AvantGo; software on your &handheld;.
  326. </para></listitem>
  327. </varlistentry>
  328. <varlistentry>
  329. <term><guilabel>Mail</guilabel></term>
  330. <listitem><para>
  331. Sends mail written on the &handheld; through &kmail;.
  332. There is no provision for receiving mail, however.
  333. </para></listitem>
  334. </varlistentry>
  335. <varlistentry>
  336. <term><guilabel>Perl</guilabel></term>
  337. <term><guilabel>Python</guilabel></term>
  338. <term><guilabel>NULL</guilabel></term>
  339. <listitem><para>
  340. These conduits are intended as a programming demonstration,
  341. and serve no practical purpose during a &HotSync;.
  342. They are not normally listed, but you may see them on some systems.
  343. </para></listitem>
  344. </varlistentry>
  345. </variablelist>
  346. <screenshot>
  347. <screeninfo>The Conduit Setup Dialog</screeninfo>
  348. <mediaobject>
  349. <imageobject><imagedata fileref="setup-conduit.png" format="PNG"/></imageobject>
  350. <textobject><phrase>The Conduit Setup Dialog</phrase></textobject>
  351. <caption><para>The Conduit Setup Dialog</para></caption>
  352. </mediaobject>
  353. </screenshot>
  354. </sect1>
  355. <sect1 id="conflicts">
  356. <title>Resolving Conflicts</title>
  357. <para>
  358. Data records can be changed both on the &handheld; and
  359. on the <acronym>PC</acronym>. If one record has incompatible changes
  360. in both the &handheld; and the <acronym>PC</acronym>, (such as
  361. changing a phone number in different ways on both sides),
  362. the conflicting change needs to be resolved so
  363. that both the &handheld; and the <acronym>PC</acronym> are in sync again.
  364. </para>
  365. <para>
  366. A popup dialog may appear, asking you how to resolve the
  367. conflict, or you may have a general rule to automatically handle these
  368. conflicts (depending on your <link linkend="page-hotsync">conflict resolution
  369. choice</link>). Note that you can define different resolution choices
  370. for different conduits in the <link linkend="config-conduits">conduits
  371. configuration dialog</link>.
  372. </para>
  373. </sect1>
  374. </chapter>