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.

configuration.docbook 58KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783
  1. <chapter id="configure">
  2. <title>Configuring &kpilot;</title>
  3. <para>
  4. Once &kpilot; is installed it needs to be
  5. configured
  6. to match your hardware.
  7. The <link linkend="config-conduits">conduits</link>
  8. need to be configured as well.
  9. After that you can use &kpilot;
  10. to synchronize your &PalmPilot; with
  11. your &kde; desktop or view
  12. data from your &PalmPilot; with the
  13. <link linkend="builtin">built-in viewers</link>.
  14. </para>
  15. <para>
  16. When you run &kpilot; from either
  17. the panel menu or from the command prompt for the first time
  18. it will prompt you with
  19. a dialog box to configure it.
  20. This configuration dialog can be requested later
  21. from the main application
  22. <menuchoice>
  23. <guimenu>Settings</guimenu>
  24. <guimenuitem>Configure &kpilot;</guimenuitem>
  25. </menuchoice>
  26. menu, from the &kpilot; daemon popup menu
  27. <menuchoice>
  28. <guimenuitem>Configure KPilot...</guimenuitem>
  29. </menuchoice>
  30. menu item or by starting &kpilot;
  31. from the shell
  32. as follows:
  33. <screen width="40"><prompt>$ </prompt> <userinput><command>kpilot</command><option>--setup</option></userinput>
  34. </screen>
  35. In addition, if you upgrade &kpilot; and some new configuration
  36. options require your attention, this setup dialog will reappear.
  37. </para>
  38. <screenshot>
  39. <screeninfo>Configuration Dialog</screeninfo>
  40. <mediaobject>
  41. <imageobject><imagedata fileref="setup-tabs.png" format="PNG"/></imageobject>
  42. <textobject><phrase>The configuration dialog</phrase></textobject>
  43. <caption><para>The configuration dialog</para></caption>
  44. </mediaobject>
  45. </screenshot>
  46. <para>
  47. &kpilot;'s configuration dialog is a large one.
  48. This is because it contains not only the configuration of the
  49. device for communicating with the &PalmPilot;, but also
  50. the configuration of all the installed conduits.
  51. Each group of configuration options
  52. (<link linkend="general-setup">general</link>
  53. and <link linkend="config-conduits">conduits</link>)
  54. will be discussed separately.
  55. We will begin, however, by taking a look at the
  56. <link linkend="configwizard">configuration wizard</link>, which should make most
  57. of the
  58. general group of configuration options superfluous.
  59. </para>
  60. <sect1 id="configwizard">
  61. <title>Using the Wizard</title>
  62. <para>
  63. The configuration wizard helps you to set up &kpilot; to communicate
  64. with the &PalmPilot; and to configure the conduits as a group. It's a great
  65. start for new users, and you can always fine-tune your preferences later.
  66. </para>
  67. <para>
  68. In the <guilabel>Pilot Info</guilabel> dialog, type your <guilabel>User
  69. Name</guilabel>. It
  70. should match the one from the &PalmPilot;. Next, type the file name of
  71. the <guilabel>Device</guilabel> you will use to connect the &PalmPilot; (The
  72. connection can be through a serial port, USB port, infrared, Bluetooth, network
  73. or the generic <filename class="devicefile">/dev/pilot</filename> device.)
  74. Alternatively, click the
  75. <guibutton>Automatically detect handheld and user name...</guibutton>
  76. button and press the &HotSync; button on your &handheld;. The Wizard will try
  77. to find the correct <guilabel>Device</guilabel> and
  78. <guilabel>User Name</guilabel>.
  79. </para>
  80. <important><para>
  81. If the
  82. <guilabel>Device</guilabel> does not have the right permissions, the wizard will
  83. not be able to find it. Normal users must be able to read/write the correct
  84. device. To resolve this issue, please refer to <link
  85. linkend="faq-connection"><quote>&kpilot; says <errorname>Can't connect to
  86. pilot</errorname></quote>
  87. &FAQ; entry</link>, or contact your system administrator.
  88. </para></important>
  89. <screenshot>
  90. <screeninfo>The First Configuring Wizard Dialog</screeninfo>
  91. <mediaobject>
  92. <imageobject><imagedata fileref="wizard-general.png"
  93. format="PNG"/></imageobject>
  94. <textobject><phrase>Configuring Wizard: The Pilot Info
  95. Dialog</phrase></textobject>
  96. <caption><para>Configuring Wizard: The Pilot Info Dialog</para></caption>
  97. </mediaobject>
  98. </screenshot>
  99. <para>
  100. Press the &HotSync; button of your &handheld; to probe for the
  101. correct <guilabel>Device</guilabel> and <guilabel>User Name</guilabel>.
  102. </para>
  103. <screenshot>
  104. <screeninfo>The Second Configuring Wizard Dialog</screeninfo>
  105. <mediaobject>
  106. <imageobject><imagedata fileref="wizard-connection.png"
  107. format="PNG"/></imageobject>
  108. <textobject><phrase>Configuring Wizard: The Autodetection
  109. Dialog</phrase></textobject>
  110. <caption><para>Configuring Wizard: The Autodetection Dialog</para></caption>
  111. </mediaobject>
  112. </screenshot>
  113. <para>
  114. &kpilot; has the ability to sync the data on your &handheld; with
  115. applications or files on your <acronym>PC</acronym>. The programs that
  116. perform these actions are called conduits. The sync dialog configures
  117. all applicable &kpilot; conduits to sync with widely used
  118. <acronym>PIM</acronym> suites. You can fine-tune these settings later, from the
  119. <menuchoice>
  120. <guimenu>Settings</guimenu>
  121. <guimenuitem>Configure &kpilot;</guimenuitem>
  122. </menuchoice>
  123. menu. Please check the <link linkend="config-conduits">conduits
  124. configuration</link>
  125. section of this document for more information.
  126. </para>
  127. <screenshot>
  128. <screeninfo>The Third Configuring Wizard Dialog</screeninfo>
  129. <mediaobject>
  130. <imageobject><imagedata fileref="wizard-conduits.png"
  131. format="PNG"/></imageobject>
  132. <textobject><phrase>Configuring Wizard: The Sync Dialog</phrase></textobject>
  133. <caption><para>Configuring Wizard: The Sync Dialog</para></caption>
  134. </mediaobject>
  135. </screenshot>
  136. </sect1>
  137. <sect1 id="general-setup">
  138. <title>General Setup</title>
  139. <para>
  140. The settings available in the &kpilot; configuration dialog
  141. under the heading <guilabel>General Setup</guilabel>
  142. give you detailed control over the operation of &kpilot;:
  143. you can select a non-standard hardware device,
  144. set special encodings for foreign-language &handheld;s,
  145. and control how &kpilot; displays your data. There
  146. are five items under the <guilabel>General Setup</guilabel>
  147. heading. You may need to expand the <guilabel>General Setup</guilabel>
  148. heading to see them.
  149. </para>
  150. <screenshot>
  151. <screeninfo>Items under General Setup</screeninfo>
  152. <mediaobject>
  153. <imageobject><imagedata fileref="setup-items.png" format="PNG"/></imageobject>
  154. <textobject><phrase>The items under General Setup</phrase></textobject>
  155. <caption><para>The items under General Setup</para></caption>
  156. </mediaobject>
  157. </screenshot>
  158. <sect2 id="page-general">
  159. <title>Device Setup</title>
  160. <para>
  161. This is a setup page that contains options describing
  162. the &PalmPilot; hardware, you, the user
  163. and how you want the various parts of &kpilot;
  164. to be started.
  165. </para>
  166. <screenshot>
  167. <screeninfo>Device Page</screeninfo>
  168. <mediaobject>
  169. <imageobject><imagedata fileref="setup-general.png" format="PNG"/></imageobject>
  170. <textobject><phrase>The Device Page</phrase></textobject>
  171. <caption><para>The Device Page</para></caption>
  172. </mediaobject>
  173. </screenshot>
  174. <variablelist>
  175. <varlistentry>
  176. <term><guilabel>Pilot device</guilabel></term>
  177. <listitem>
  178. <para>
  179. The port that the cradle is connected to.
  180. By default it is
  181. set to <filename class="devicefile">/dev/pilot</filename>
  182. which should be a symbolic link to the real port.
  183. The port might be a serial port, in which case
  184. <filename class="devicefile">/dev/pilot</filename>
  185. should point to
  186. something like
  187. <filename class="devicefile">/dev/cuaa0</filename>
  188. (in &FreeBSD;) or
  189. <filename class="devicefile">/dev/ttyS0</filename>
  190. (in &Linux;).
  191. For &USB; devices, it can be more difficult to
  192. determine where
  193. <filename class="devicefile">/dev/pilot</filename>
  194. should point.
  195. It may be possible to configure your &USB; daemon
  196. to set up the link automatically, so that
  197. <filename class="devicefile">/dev/pilot</filename>
  198. points to the right port no matter where you plug in your &PalmOS; device.
  199. </para>
  200. <para>
  201. <emphasis>Make sure the port has
  202. the correct permissions.</emphasis>
  203. It
  204. must be read/write by all if &kpilot; is intended to be used by a
  205. normal user! &kpilot; will complain if the permissions are wrong, but you
  206. will need to fix the permissions by hand. This could be done by doing a
  207. <userinput><command>chmod</command> <parameter>666</parameter>
  208. <replaceable>device</replaceable></userinput>
  209. as root where <replaceable>device</replaceable> is the correct port.
  210. To resolve this issue, please refer to <link
  211. linkend="faq-connection"><quote>&kpilot; says <errorname>Can't connect to pilot
  212. </errorname></quote>
  213. &FAQ; entry</link>, or contact your system administrator.
  214. </para>
  215. <para>
  216. You can also use network sync (with pilot-link 0.11.5 and later)
  217. by entering <userinput>net:any</userinput> as the
  218. device name.
  219. </para>
  220. </listitem>
  221. </varlistentry>
  222. <varlistentry>
  223. <term><guilabel>Speed</guilabel></term>
  224. <listitem>
  225. <para>
  226. Indicate the speed of the <emphasis>serial</emphasis>
  227. connection to the &PalmPilot;.
  228. It has no meaning for &USB; devices.
  229. For an older model &PalmPilot;, choose 9600.
  230. Newer models may be able to handle speeds up to
  231. the maximum listed, 115200.
  232. You can experiment with the connection speed: the &PalmPilot;
  233. manual suggests starting at a speed of 19200 and trying faster
  234. speeds to see if they work.
  235. </para>
  236. </listitem>
  237. </varlistentry>
  238. <varlistentry><term><guilabel>Encoding</guilabel></term>
  239. <listitem>
  240. <para>
  241. &PalmOS; devices are available in
  242. many different languages.
  243. If your device uses a different encoding than
  244. ISO-latin1, you will need to select the
  245. correct encoding from the list in order to
  246. display special characters correctly.
  247. If you can enter Russian in your &PalmPilot;,
  248. select CP1251, for instance.
  249. </para>
  250. </listitem>
  251. </varlistentry>
  252. <varlistentry>
  253. <term><guilabel>Pilot user</guilabel></term>
  254. <listitem>
  255. <para>
  256. The user name of the &PalmPilot;. By default this name is the same as
  257. your log on name. When you sync with the &PalmPilot; &kpilot; will
  258. check to see if this name matches the one on the &PalmPilot;. If they do
  259. not, you are asked to pick which you will use. If you pick the local
  260. name, the &PalmPilot; will be changed to match.
  261. The <guilabel>Pilot User</guilabel> entry is also used to name the folder that
  262. stores the information from the &PalmPilot;. This folder is created in the
  263. <filename class="directory">$TDEHOME/share/apps/kpilot/DBBackup/</filename>
  264. folder, where the <filename class="directory">$TDEHOME</filename> environment
  265. variable
  266. (typically <filename class="directory">/home/Login Name/.trinity/</filename>)
  267. points to the folder that contains your configuration and data for the &kde;
  268. applications.
  269. </para>
  270. </listitem>
  271. </varlistentry>
  272. </variablelist>
  273. </sect2>
  274. <sect2 id="page-hotsync">
  275. <title>HotSync Setup</title>
  276. <para>
  277. This page contains settings with which you can instruct &kpilot; to perform
  278. special kinds of &HotSync;, as well as direct how conflicts during a &HotSync;
  279. should be resolved. A conflict happens when both the desktop application and the
  280. &handheld; application change the same data.
  281. </para>
  282. <para>
  283. &kpilot; interfaces with your &handheld; in two ways: using the
  284. the conduits and the internal viewers. Conduits are plug-in programs which
  285. extend the synchronization capabilities of &kpilot;. &kpilot; stores separate copies of
  286. the databases and records for conduits, while the internal viewers and backup
  287. operation share the same copy. This distinction is important to choose your
  288. update method depending on your usage. If you use mainly the conduits to sync
  289. your &handheld; with external programs, you may choose as default
  290. synchronization method any option that runs the conduits. However, if you use mainly the
  291. internal viewers, you need to update copy of the databases as well in order to
  292. view and edit the information from your &handheld;, so running the conduits only
  293. is not sufficient.
  294. </para>
  295. <screenshot>
  296. <screeninfo>The &HotSync; setup page</screeninfo>
  297. <mediaobject>
  298. <imageobject>
  299. <imagedata fileref="setup-hotsync.png" format="PNG"/>
  300. </imageobject>
  301. <textobject>
  302. <phrase>The &HotSync; Page</phrase>
  303. </textobject>
  304. <caption>
  305. <para>The &HotSync; setup page</para></caption>
  306. </mediaobject>
  307. </screenshot>
  308. <variablelist>
  309. <varlistentry>
  310. <term><guilabel>Default Sync</guilabel></term>
  311. <listitem>
  312. <para>
  313. Select the type of synchronization that will be performed by default.
  314. </para>
  315. <itemizedlist>
  316. <listitem>
  317. <para>
  318. <guilabel>HotSync</guilabel>: run all selected conduits, sync the databases
  319. with a modified flag set, updating the modified records only. Performs a fast
  320. backup, backing up only the databases that were modified. This option offers
  321. a nice balance between speed and data safety.
  322. </para>
  323. </listitem>
  324. <listitem>
  325. <para>
  326. <guilabel>FastSync</guilabel>: Only synchronize those
  327. databases that have conduits, and perform no backup of the data
  328. on the &PalmPilot;, reducing greatly the time required for the sync
  329. operation. This also means that if something goes wrong with your &PalmPilot;,
  330. you may not be able to recover the databases. This is a classic
  331. trade-off between speed and safety.
  332. </para>
  333. </listitem>
  334. <listitem>
  335. <para>
  336. <guilabel>FullSync</guilabel>: run all selected conduits, and sync all
  337. databases, reading all records, and performing a full backup. It is the safest
  338. option, but takes the longest time to complete, as it will merge all the records
  339. from the &handheld; and your desktop. It is the &kpilot; equivalent of the Palm
  340. SlowSync.
  341. </para>
  342. </listitem>
  343. <listitem>
  344. <para>
  345. <guilabel>Copy PC to handheld</guilabel>: run all conduits and sync all
  346. databases, but instead of merging the information from both sources, copy the PC
  347. data to the handheld. <emphasis>Use with care, as this option erases the changes
  348. you made in your handheld since the last sync</emphasis>.
  349. </para>
  350. </listitem>
  351. <listitem>
  352. <para>
  353. <guilabel>Copy handheld to PC</guilabel>: run all conduits and sync all
  354. databases, but instead of merging the information from both sources, copy the
  355. handheld data to the PC. <emphasis>Use with care, as this option erases the
  356. changes you made in your PC since the last sync</emphasis>.
  357. </para>
  358. <warning>
  359. <para>
  360. Remember, when &kpilot; does a &HotSync; and runs the conduits,
  361. the databases in the internal viewers are <emphasis>not</emphasis>
  362. updated. To update the internal viewers, use the FullSync or backup actions.
  363. </para>
  364. </warning>
  365. </listitem>
  366. </itemizedlist>
  367. </listitem>
  368. </varlistentry>
  369. <varlistentry>
  370. <term><guilabel>Do full backup when changing PCs</guilabel></term>
  371. <listitem>
  372. <para>
  373. If you &HotSync; your &handheld; with multiple <acronym>PC</acronym>s, the flag
  374. on the &handheld; that stores which
  375. records have changed since the last &HotSync; may be inaccurate. It is
  376. recommended to do a full sync when changing <acronym>PC</acronym>s. You can
  377. disable the full sync by unchecking this box.
  378. </para>
  379. </listitem>
  380. </varlistentry>
  381. <!--
  382. <varlistentry>
  383. <term><guilabel>Do not sync when screen saver is active</guilabel></term>
  384. <listitem>
  385. <para>
  386. This is a security feature that prevents the &handheld; from synchronization
  387. while the PC screen saver is active. This prevents other people from
  388. stealing your data through the &handheld; cradle while your PC is
  389. unattended. The feature only works with the &kde; screen savers, though,
  390. and you will need to disable it to use &kpilot; in non-&kde; environments.
  391. </para>
  392. </listitem>
  393. </varlistentry>
  394. -->
  395. <varlistentry>
  396. <term><guilabel>Conflict Resolution</guilabel></term>
  397. <listitem>
  398. <para>
  399. Data records can be changed both on the &handheld; and
  400. on the <acronym>PC</acronym>. If one record has incompatible changes
  401. in both the &handheld; and the <acronym>PC</acronym>, (such as
  402. changing a phone number in different ways on both sides),
  403. the conflicting change needs to be resolved so
  404. that the &handheld; and the <acronym>PC</acronym> data are consistent again.
  405. Choices for conflict resolution are:
  406. </para>
  407. <itemizedlist>
  408. <listitem><para><guilabel>Ask User</guilabel>:
  409. pop up a dialog for the user to
  410. choose how the conflict is to be resolved for
  411. every conflict.
  412. </para></listitem>
  413. <listitem><para><guilabel>Do Nothing</guilabel>:
  414. leave the entries in an inconsistent state.
  415. Future syncs may not notice the discrepancy.
  416. </para></listitem>
  417. <listitem><para><guilabel>Handheld Overrides</guilabel>:
  418. copy the values from the &handheld; to the <acronym>PC</acronym>,
  419. discarding the changes on the <acronym>PC</acronym>.
  420. </para></listitem>
  421. <listitem><para><guilabel>PC Overrides</guilabel>:
  422. copy the values from the <acronym>PC</acronym> to the &handheld;,
  423. discarding changes on the &handheld;.
  424. </para></listitem>
  425. <listitem><para><guilabel>Values From Last Sync (if possible)</guilabel>:
  426. &kpilot; stores a backup copy of the information on your &handheld; depending on
  427. the synchronization method you selected. If this information is available, use
  428. neither
  429. the values from the &handheld; nor the PC, but the values from
  430. the last sync.
  431. </para></listitem>
  432. <listitem><para><guilabel>Use Both Entries</guilabel>:
  433. Create duplicate entries of the conflicting records on both the
  434. <acronym>PC</acronym> and
  435. &handheld;, one with the value from the <acronym>PC</acronym>, the other with
  436. the value
  437. from the &handheld;.
  438. </para></listitem>
  439. </itemizedlist>
  440. </listitem>
  441. </varlistentry>
  442. </variablelist>
  443. </sect2>
  444. <sect2 id="page-backup">
  445. <title>Backup Setup</title>
  446. <para>
  447. This page contains settings specific to the backup operation, which saves
  448. a copy of the the &handheld; databases, allowing the user to
  449. restore this information later.
  450. </para>
  451. <para>In short, databases are all files stored in your &handheld;. A database
  452. can be either a record database, which stores dynamic information created by the
  453. user (for instance, the addresses or the todo information), or a resource
  454. database, which tend to be static (for instance the applications).</para>
  455. <screenshot>
  456. <screeninfo>Backup Page</screeninfo>
  457. <mediaobject>
  458. <imageobject>
  459. <imagedata fileref="setup-dbspecial.png" format="PNG"/>
  460. </imageobject>
  461. <textobject><phrase>The Backup Page</phrase></textobject>
  462. <caption><para>The Backup Page</para></caption>
  463. </mediaobject>
  464. </screenshot>
  465. <variablelist>
  466. <varlistentry>
  467. <term><guilabel>Databases</guilabel></term>
  468. <listitem>
  469. <para>
  470. List databases that should not be synced or backed up.
  471. </para>
  472. <para>
  473. The values can be either database creator values, which are 4-letter strings
  474. surrounded by square brackets (so for Handbase databases you fill in
  475. <userinput>&#91;PmDB&#93;</userinput>), or database names,
  476. which are strings without square brackets that may contain shell-style
  477. wildcards.
  478. See the <link linkend="dbskip">FAQ</link>
  479. for a list of databases that should be listed
  480. here (the default should be OK though).
  481. Newer &PalmPilot; devices contain emulation code for
  482. the older 68k processor; this means that they have a large
  483. number of databases with names ending in
  484. <literal role="extension">_a68k</literal>.
  485. These do not need to be backed up nor synced, so you could
  486. add <userinput>*_a68k</userinput>
  487. to the list of databases to skip.
  488. <itemizedlist>
  489. <listitem><para>
  490. <guilabel>No backup</guilabel> List here databases that should be excluded from
  491. the backup operation. Some databases do not follow the standard database layout,
  492. and trying to backup and restore them will result in information loss. You may
  493. include here databases with volatile information, such as news or web pages,
  494. that
  495. often do not require to be backed up.
  496. </para>
  497. </listitem>
  498. <listitem><para>
  499. <guilabel>Not restored</guilabel> List here databases that should be excluded
  500. from the restore operation, even if they were previously backed up. Databases
  501. included here can be installed manually later, using the
  502. <guilabel>File Installer</guilabel>. You may
  503. include here databases with volatile information, such as news or web pages,
  504. that
  505. often do not require to be restored.
  506. </para></listitem>
  507. </itemizedlist>
  508. <warning>
  509. <para>
  510. Changing the contents of the <guilabel>No backup</guilabel>
  511. or <guilabel>Not restored</guilabel> fields, in particular removing
  512. the databases already listed there, can damage those databases
  513. when you perform a &HotSync;.
  514. </para>
  515. </warning>
  516. </para></listitem>
  517. </varlistentry>
  518. <varlistentry>
  519. <term><guilabel>Run conduits during a backup</guilabel></term>
  520. <listitem>
  521. <para>
  522. The backup typically updates the copy of the &handheld; databases.
  523. Conduits are programs that extend the &kpilot; functionality. Running them
  524. usually means synchronization the &handheld; to other <acronym>PC</acronym>
  525. databases,
  526. like the address book or the calender. Check this box to perform both operations
  527. on
  528. every backup.
  529. </para>
  530. </listitem>
  531. </varlistentry>
  532. </variablelist>
  533. </sect2>
  534. <sect2 id="page-viewers">
  535. <title>Internal Viewers Setup</title>
  536. <para>
  537. &kpilot; contains <quote>viewers</quote> for
  538. presenting information from the &PalmPilot;.
  539. These viewers present the databases available on
  540. the &PalmPilot; in much the same way that the device
  541. itself does. Not all databases have an application-specific
  542. viewer, though you can use the generic database viewer for those.
  543. The viewers page contains settings for the internal viewers in
  544. &kpilot;.
  545. These settings change the way in which the data is shown.
  546. </para>
  547. <screenshot>
  548. <screeninfo>Viewers Page</screeninfo>
  549. <mediaobject>
  550. <imageobject><imagedata fileref="setup-viewer.png" format="PNG"/></imageobject>
  551. <textobject><phrase>The Viewers Setup Page</phrase></textobject>
  552. <caption><para>The Viewers Setup Page</para></caption>
  553. </mediaobject>
  554. </screenshot>
  555. <variablelist>
  556. <varlistentry>
  557. <term><guilabel>Make internal viewers editable</guilabel></term>
  558. <listitem><para>
  559. The internal viewers can be read only or editable. The editable mode allows you
  560. to add new records, delete or edit the existing records and sync your
  561. modifications back to the &handheld;. Check
  562. this box to set the internal viewers to editable mode, uncheck to set them to
  563. read
  564. only mode.</para>
  565. <warning><para>
  566. On some &kpilot; versions, it is not possible check this box, and therefore to
  567. use the internal viewers as editors.
  568. </para></warning>
  569. </listitem>
  570. </varlistentry>
  571. <varlistentry>
  572. <term><guilabel>Show private records</guilabel></term>
  573. <listitem><para>
  574. In your &PalmPilot; you can mark some records as <quote>private</quote>. By
  575. default, &kpilot; does not display these records on the screen. Check this box
  576. if you want to see them.
  577. </para></listitem>
  578. </varlistentry>
  579. <varlistentry>
  580. <term><guilabel>Address Viewer</guilabel></term>
  581. <listitem><para>
  582. Set there the options for the address internal viewer.
  583. <itemizedlist>
  584. <listitem><para>
  585. <guilabel>Show as "Last, first"</guilabel> or
  586. <guilabel>Show as "Company, last"</guilabel>: the order and display of the
  587. address records in the address internal viewer can be set to match the
  588. &handheld;. Select the option that suits better your personal preferences.
  589. </para></listitem>
  590. <listitem><para>
  591. <guilabel>Use key field</guilabel> Check this box to combine entries with the
  592. same last name.
  593. </para></listitem>
  594. </itemizedlist>
  595. </para></listitem>
  596. </varlistentry>
  597. </variablelist>
  598. </sect2>
  599. <sect2 id="page-startup-exit">
  600. <title>Startup and Exit Behavior Setup</title>
  601. <para>
  602. This pages present options related to the startup and exit of &kpilot; and
  603. &kpilot; daemon.
  604. </para>
  605. <para>
  606. While &kpilot; is the front-end for the internal viewers, configuration options
  607. and logs, the sync operation is handled by the &kpilot; daemon. Even if &kpilot;
  608. is not running you can &HotSync; if the daemon is. Therefore, if you want to
  609. be able to sync your &handheld; at anytime, it is important to start the daemon
  610. at login, or the opposite, if you want to be able to sync only when &kpilot; is
  611. running, you have to stop the daemon on exit. The last option is especially
  612. usefull if you have other applications that use the same port as &kpilot;.
  613. </para>
  614. <screenshot>
  615. <screeninfo>Startup and Exit Page</screeninfo>
  616. <mediaobject>
  617. <imageobject><imagedata fileref="setup-startup-exit.png"
  618. format="PNG"/></imageobject>
  619. <textobject><phrase>The Startup and Exit Page</phrase></textobject>
  620. <caption><para>The Startup and Exit Page</para></caption>
  621. </mediaobject>
  622. </screenshot>
  623. <variablelist>
  624. <varlistentry>
  625. <term><guilabel>Startup Options</guilabel></term>
  626. <listitem>
  627. <para>
  628. <itemizedlist>
  629. <listitem>
  630. <para>
  631. <guilabel>Start daemon at login</guilabel>:
  632. By checking this, a link to
  633. the daemon is placed in your autostart folder
  634. and will be started automatically. Note that this is not normally
  635. needed if the daemon is docked in the panel.
  636. <!-- TODO: broken functionality -->
  637. </para>
  638. </listitem>
  639. <listitem>
  640. <para>
  641. <guilabel>Show daemon in panel</guilabel>:
  642. Check this box to instruct the daemon to place a &kpilot; icon
  643. <guiicon>
  644. <inlinemediaobject>
  645. <imageobject><imagedata fileref="kpilot.png" format="PNG"/>
  646. </imageobject>
  647. </inlinemediaobject>
  648. </guiicon>
  649. in the system tray. This icon has a menu that can be brought up with
  650. the right mouse button. Without this option, the daemon is not visible to the
  651. user at all.
  652. </para>
  653. </listitem>
  654. </itemizedlist>
  655. </para>
  656. </listitem>
  657. </varlistentry>
  658. <varlistentry>
  659. <term>
  660. <guilabel>Exit Options</guilabel>
  661. </term>
  662. <listitem>
  663. <para>
  664. <itemizedlist>
  665. <listitem>
  666. <para>
  667. <guilabel>Quit after HotSync</guilabel>: When this option is enabled, both
  668. &kpilot; and the &kpilot; daemon will exit after the &HotSync; operation has
  669. completed, leaving the device port free for other tools. This may be needed on
  670. systems where the &USB; daemon starts &kpilot; automatically.
  671. </para>
  672. </listitem>
  673. <listitem>
  674. <para>
  675. <anchor id="stopdaemononexit"/>
  676. <guilabel>Stop daemon on exit</guilabel>: Setting this option will cause the
  677. daemon to exit when you quit &kpilot;, leaving the device port free for other
  678. &PalmPilot;-synchronization tools such as <application>malsync</application>
  679. </para>
  680. </listitem>
  681. </itemizedlist>
  682. </para>
  683. </listitem>
  684. </varlistentry>
  685. </variablelist>
  686. </sect2>
  687. </sect1>
  688. <sect1 id="config-conduits">
  689. <title>Conduits Setup</title>
  690. <para>
  691. Conduits are programs that interface your &handheld; data with
  692. <acronym>PC</acronym> applications or sync your &handheld; data with files
  693. that can be used by <acronym>PC</acronym> applications. They can be
  694. written by third parties, to interface your &PalmPilot; to any application
  695. imaginable.
  696. </para>
  697. <para>
  698. &kpilot;'s configuration dialog allows you to select which conduits
  699. to run during a &HotSync; and to configure those conduits.
  700. A window similar to the following will be displayed:
  701. </para>
  702. <screenshot>
  703. <screeninfo>The Conduit Setup Dialog</screeninfo>
  704. <mediaobject>
  705. <imageobject><imagedata fileref="setup-conduit.png" format="PNG"/></imageobject>
  706. <textobject>
  707. <phrase>The Conduit Setup Dialog</phrase>
  708. </textobject>
  709. <caption>
  710. <para>The Conduit Setup Dialog</para>
  711. </caption>
  712. </mediaobject>
  713. </screenshot>
  714. <para>
  715. Check the box to the left of the conduit name to make it active, uncheck to make
  716. it inactive or click on the conduit name to configure it.
  717. </para>
  718. <variablelist>
  719. <varlistentry>
  720. <term><guilabel>KNotes / Memos</guilabel></term>
  721. <listitem>
  722. <para>
  723. Synchronizes the Memo Pad application with &knotes;.
  724. </para>
  725. </listitem>
  726. </varlistentry>
  727. <varlistentry>
  728. <term><guilabel>Notepad</guilabel></term>
  729. <listitem>
  730. <para>
  731. Exports the free hand notes of the &handheld;'s Notepad application as pictures
  732. to the PC.
  733. </para>
  734. </listitem>
  735. </varlistentry>
  736. <varlistentry>
  737. <term><guilabel>Time Synchronization</guilabel></term>
  738. <listitem>
  739. <para>
  740. Sets the &handheld;'s time to that of the desktop machine.
  741. Useful for keeping the clock of the &handheld; accurate.
  742. </para>
  743. </listitem>
  744. </varlistentry>
  745. <varlistentry>
  746. <term><guilabel>Calendar (KOrganizer)</guilabel></term>
  747. <listitem>
  748. <para>
  749. Synchronizes the Datebook application with &korganizer; or with an
  750. iCalendar file of
  751. your choice.
  752. </para>
  753. </listitem>
  754. </varlistentry>
  755. <varlistentry>
  756. <term><guilabel>Palm DOC</guilabel></term>
  757. <listitem>
  758. <para>
  759. Automatically converts and installs text files in the &PalmPilot;
  760. DOC format, so you can read the text files with most DOC-capable
  761. applications on the &handheld;.
  762. </para>
  763. </listitem>
  764. </varlistentry>
  765. <varlistentry>
  766. <term><guilabel>Addressbook</guilabel></term>
  767. <listitem>
  768. <para>
  769. Synchronizes the Address application with &kaddressbook; or with a vCard file of
  770. your choice.
  771. </para>
  772. </listitem>
  773. </varlistentry>
  774. <varlistentry>
  775. <term><guilabel>System Information</guilabel></term>
  776. <listitem>
  777. <para>
  778. Writes information about your &handheld;, (such as OS version,
  779. RAM available, and the list of databases) to a file. Useful mostly for
  780. debugging purposes.
  781. </para>
  782. </listitem>
  783. </varlistentry>
  784. <varlistentry>
  785. <term><guilabel>ToDo's (KOrganizer)</guilabel></term>
  786. <listitem>
  787. <para>
  788. Synchronizes the Todo list application with &korganizer; or with a iCalendar
  789. file of
  790. your choice.
  791. </para>
  792. </listitem>
  793. </varlistentry>
  794. <varlistentry>
  795. <term><guilabel>MAL (AvantGo) Conduit</guilabel></term>
  796. <listitem>
  797. <para>
  798. Synchronizes your &handheld; with the &AvantGo; server. The &AvantGo; server
  799. offers general content (news, guides, stock quotes, &etc;) in a format that is
  800. suitable for reading in a &handheld;. To use this conduit, you need to register,
  801. subscribe
  802. the channels you select and install the &AvantGo; software on your &handheld;.
  803. </para></listitem>
  804. </varlistentry>
  805. <varlistentry>
  806. <term><guilabel>Mail</guilabel></term>
  807. <listitem>
  808. <para>
  809. Sends mail written on the &handheld; through &kmail;.
  810. There is no provision for receiving mail, however.
  811. </para>
  812. </listitem>
  813. </varlistentry>
  814. </variablelist>
  815. <sect2 id="conduit-knotes">
  816. <title>&knotes; Conduit Setup</title>
  817. <para>
  818. The &knotes; Conduit is a partial replacement for the built-in <link
  819. linkend="builtin">memo application</link>. It keeps the notes you write
  820. with &knotes; synchronized with the memos you write on your &PalmPilot;.
  821. </para>
  822. <para>
  823. Setting up the &knotes; conduit is very simple.
  824. </para>
  825. <screenshot>
  826. <screeninfo>&knotes; Conduit Setup</screeninfo>
  827. <mediaobject>
  828. <imageobject>
  829. <imagedata fileref="conduit-knotes.png" format="PNG"/>
  830. </imageobject>
  831. <textobject>
  832. <phrase>&knotes; Conduit Setup</phrase>
  833. </textobject>
  834. <caption>
  835. <para>&knotes; Conduit Setup</para>
  836. </caption>
  837. </mediaobject>
  838. </screenshot>
  839. <para>
  840. In the <guilabel>General</guilabel> Tab there are two configuration options:
  841. <variablelist>
  842. <varlistentry>
  843. <term><guilabel>Delete KNote when Pilot memo is deleted</guilabel></term>
  844. <listitem>
  845. <para>
  846. Uncheck this box if you wish to maintain the note on &knotes; even if the
  847. correspondent memo was deleted on the &handheld; memo application.
  848. </para>
  849. </listitem>
  850. </varlistentry>
  851. <varlistentry>
  852. <term><guilabel>Suppress delete-confirmation in KNotes</guilabel></term>
  853. <listitem>
  854. <para>
  855. If the <guilabel>Delete KNote when Pilot memo is deleted</guilabel> box is
  856. checked, you may check this box to automatically delete the notes that
  857. correspond to a deleted memo, without confirmation.
  858. </para>
  859. </listitem>
  860. </varlistentry>
  861. </variablelist>
  862. <note>
  863. <para>
  864. By default, the options <quote>delete knote</quote> and <quote>suppress
  865. delete-confirmation</quote> are turned <emphasis>off</emphasis>, so that notes
  866. will accumulate on your PC.
  867. </para>
  868. </note>
  869. </para>
  870. </sect2>
  871. <sect2 id="notepad-cond">
  872. <title>Notepad Conduit Setup</title>
  873. <para>
  874. The Notepad Conduit exports the free hand notes of the &handheld;'s Notepad
  875. application as pictures to the desktop. To set the folder to which the pictures
  876. should be exported, either enter it in the <guilabel>Output</guilabel> edit
  877. box or select it clicking the file picker button.
  878. </para>
  879. </sect2>
  880. <sect2 id="time-cond">
  881. <title>Time Synchronization Conduit Setup</title>
  882. <para>
  883. The Time Synchronization Conduit syncs the &handheld;'s time to that of the
  884. desktop
  885. machine. It is useful for keeping the clock of the &handheld; accurate. There
  886. are really no configuration options other that enabling and disabling the
  887. conduit, as currently only one direction for the synchronization is enabled,
  888. you can only <guilabel>Set the handheld time from the time on the PC</guilabel>,
  889. and not <guilabel>Set the PC time from the time on the handheld</guilabel>.
  890. </para>
  891. <note>
  892. <para>
  893. &PalmOS; Version 3.25 and 3.3 do not support setting the &handheld; system time.
  894. For these systems, the conduit will be simply skipped.
  895. </para>
  896. </note>
  897. </sect2>
  898. <sect2 id="vcal-cond">
  899. <title>Calendar Conduit Setup</title>
  900. <para>
  901. This conduit will synchronize your &PalmPilot; with &korganizer; and &kontact;
  902. or to an iCalendar file of your choice. In the latter case, the conduit will
  903. need the filename of the calendar file (this will usually be a file that ends in
  904. <literal role="extension">.ics</literal>) to sync with, of if it uses the
  905. standard &korganizer; iCalendar file, it will be under the <filename
  906. class="directory">$TDEHOME/share/apps/korganizer/</filename> folder, where the
  907. <filename class="directory">$TDEHOME</filename> environment variable (typically
  908. <filename class="directory">/home/user/.trinity/</filename>) points to the folder
  909. that contains your configuration and data for the &kde; applications.
  910. </para>
  911. <screenshot>
  912. <screeninfo>The Calendar Conduit Setup Dialog</screeninfo>
  913. <mediaobject>
  914. <imageobject>
  915. <imagedata fileref="conduit-vcal.png" format="PNG"/>
  916. </imageobject>
  917. <textobject>
  918. <phrase>Calendar Conduit Setup</phrase>
  919. </textobject>
  920. <caption>
  921. <para>Calendar Conduit Setup</para>
  922. </caption>
  923. </mediaobject>
  924. </screenshot>
  925. <para>
  926. In the <guilabel>General</guilabel> page, you can set the calendar options.
  927. </para>
  928. <variablelist>
  929. <varlistentry>
  930. <term><guilabel>Calendar Destination</guilabel></term>
  931. <listitem>
  932. <para>
  933. Choose between synchronizing with the <guilabel>Standard Calendar</guilabel>,
  934. or in other words, the &korganizer; standard calendar or with a
  935. <guilabel>Calendar file</guilabel> of your choice, that you must either
  936. write in the <guilabel>Calendar file</guilabel> edit box or select using the
  937. file picker.
  938. </para>
  939. <warning>
  940. <para>
  941. You can use the calendar conduit with any application that accepts a file in
  942. the iCalendar format as a resource. However, some applications, like Evolution,
  943. do not handle the synchronization gracefully while they are open. As a rule of
  944. thumb, quit these applications before synchronizing, otherwise you will lose
  945. data. There is no need to take these precautions when syncing with &korganizer;
  946. or &kontact;.
  947. </para>
  948. </warning>
  949. </listitem>
  950. </varlistentry>
  951. <varlistentry>
  952. <term><guilabel>Store archived records in the KDE calendar</guilabel></term>
  953. <listitem>
  954. <para>
  955. Check this box to save a copy of the archived records from your
  956. &handheld; on the <acronym>PC</acronym>, in order to keep a history of
  957. past appointments in you &kde; desktop as well.
  958. </para>
  959. </listitem>
  960. </varlistentry>
  961. </variablelist>
  962. <para>
  963. In the <guilabel>Conflicts</guilabel> page, you can set the calendar options,
  964. overriding &kpilot;'s general settings for conflict resolution when you are
  965. using this conduit. For a detailed description of the different conflict
  966. resolution possibilities available, please refer to the <link
  967. linkend="page-hotsync">HotSync Setup section</link> of this handbook.
  968. </para>
  969. </sect2>
  970. <sect2 id="conduit-palmdoc">
  971. <title>Palm DOC Conduit Setup</title>
  972. <para>
  973. The Palm DOC conduit converts text files in your <acronym>PC</acronym> from and
  974. to
  975. databases in Palm DOC format in the &PalmPilot;. You can use any Palm DOC reader
  976. to view these files on your &PalmPilot;.
  977. </para>
  978. <screenshot>
  979. <screeninfo>Palm DOC Conduit Setup</screeninfo>
  980. <mediaobject>
  981. <imageobject><imagedata fileref="conduit-palmdoc.png"
  982. format="PNG"/></imageobject>
  983. <textobject><phrase>Palm DOC Conduit Setup</phrase></textobject>
  984. <caption><para>Palm DOC Conduit Setup</para></caption>
  985. </mediaobject>
  986. </screenshot>
  987. <important><para>
  988. After changing the Palm DOC conduit configuration, you have to restart &kpilot;
  989. to let the changes you made take effect.
  990. </para></important>
  991. <para>
  992. In the <guilabel>General</guilabel> page, you can set the location of the text
  993. documents in your computer and the direction of the synchronization.
  994. </para>
  995. <variablelist>
  996. <varlistentry>
  997. <term><guilabel>Text files:</guilabel></term>
  998. <listitem><para>
  999. Type on the text box or use the file picker to select the location of the folder
  1000. that the Palm DOC conduit uses a as the place for the text files it will sync
  1001. with the &handheld;. There, you may place the text documents you want install or
  1002. synchronize to the <acronym>PDA</acronym>, and find the text documents created
  1003. from Palm DOC
  1004. databases in your &handheld;.
  1005. <important><para>
  1006. The file name has to end in <literal role="extension">.txt</literal> for the
  1007. conduit to recognize it as text. If the file is not recognized as text, it will
  1008. be ignored by the conduit. Also, the text has to be in an encoding that is
  1009. compatible with your &handheld; encoding. Therefore, if the text file has
  1010. characters that are not being correctly recognized by the Palm DOC reader in
  1011. your &handheld;, try opening the file a text editor, like &kwrite;, and saving
  1012. it in an compatible text encoding using the <guilabel>Save As..</guilabel>
  1013. dialog, or set the encoding in the <guilabel>PC -> Handheld</guilabel> tab.
  1014. </para></important>
  1015. </para>
  1016. </listitem>
  1017. </varlistentry>
  1018. <varlistentry>
  1019. <term><guilabel>Local copy:</guilabel></term>
  1020. <listitem><para>
  1021. If you want to save a copy of the Palm DOC databases from your &handheld; in
  1022. your computer, check the <guilabel>Local copy:</guilabel> box and
  1023. type on the text box or use the file picker to select the location of the folder
  1024. where these databases will be saved.
  1025. </para></listitem>
  1026. </varlistentry>
  1027. <varlistentry>
  1028. <term><guilabel>Synchronization Mode</guilabel></term>
  1029. <listitem><para>
  1030. The Palm DOC conduit has the ability to sync from and to the &handheld;,
  1031. automatically converting the text files to Palm DOC databases and vice versa.
  1032. The <guilabel>Sync only PC to PDA</guilabel> option will convert all text files
  1033. located in the folder you selected above to Palm DOC databases and install them
  1034. in your &handheld;.
  1035. The <guilabel>Sync only PDA to PC</guilabel> option will convert all Palm DOC
  1036. databases from your &handheld; to files and install them in the
  1037. folder you selected above. Finally, The <guilabel>Sync all</guilabel> option
  1038. allows the synchronization to work in both directions.
  1039. <note><para>
  1040. When both the text file and the Palm DOC database are modified, you cannot merge
  1041. the modifications, you have to choose one of the versions, losing the changes
  1042. in one of them.
  1043. </para></note>
  1044. </para></listitem>
  1045. </varlistentry>
  1046. </variablelist>
  1047. <para>
  1048. In the <guilabel>PC -> Handheld</guilabel> page, you can configure the Palm DOC
  1049. compression and bookmarks settings to use when converting from text files to
  1050. Palm DOC databases.
  1051. </para>
  1052. <variablelist>
  1053. <varlistentry>
  1054. <term><guilabel>Compress</guilabel></term>
  1055. <listitem><para>
  1056. Palm DOC documents can be compressed, saving considerable amounts
  1057. of available memory in your &handheld;. Most Palm DOC readers support
  1058. compressed documents, but if you use a reader or editor that is not compatible
  1059. with compression (for instance, the Sied editor), you will not be able to read
  1060. or edit the compressed Palm DOC documents created by this conduit.
  1061. Therefore, check this box to save &handheld; memory, but uncheck it if you have
  1062. compatibility problems with compressed Palm DOC in your favorite editor or
  1063. reader.
  1064. </para></listitem>
  1065. </varlistentry>
  1066. <varlistentry>
  1067. <term><guilabel>Convert bookmarks</guilabel></term>
  1068. <listitem><para>
  1069. The Palm DOC format has a provision for bookmark records. Bookmarks allow you to
  1070. easily jump to selected parts of the document, making browsing long documents
  1071. easier. Check this box to allow the Palm DOC conduit to create bookmark records.
  1072. To create them, the conduit has to know the location in the text and the name of
  1073. the bookmark. There are three supported ways to let the conduit know the
  1074. location and name of the bookmark: from inline tags in the text, from tags at
  1075. the end of the text and from a <literal role="extension">.bmk</literal> bookmark
  1076. file. To make the creation of bookmarks effective, you have to check at least
  1077. one of these boxes below.
  1078. </para></listitem>
  1079. </varlistentry>
  1080. <varlistentry>
  1081. <term><guilabel>Inline tags in text</guilabel></term>
  1082. <listitem><para>
  1083. Convert tags in the format &lt;* <replaceable>BookmarkName</replaceable> *&gt;
  1084. located inside the text to Palm DOC bookmarks, where the location of the
  1085. tag in the text will be converted to the bookmark location and the
  1086. <replaceable>BookmarkName</replaceable> text inside the tag will be converted to
  1087. the name of the bookmark in the Palm DOC format. The tag will be removed from
  1088. the resulting Palm DOC document, leaving the text clean.
  1089. This is a very easy and intuitive way to create bookmarks
  1090. in your Palm DOC documents.
  1091. </para></listitem>
  1092. </varlistentry>
  1093. <varlistentry>
  1094. <term><guilabel>Tags at end of text</guilabel></term>
  1095. <listitem><para>
  1096. Convert tags in the format &lt;<replaceable>BookmarkName</replaceable>&gt;
  1097. located in the end of the text to Palm DOC bookmarks. Whenever the
  1098. <replaceable>BookmarkName</replaceable> text appears in the text, the conduit
  1099. will generate a the bookmark in the resulting Palm DOC document pointing to it.
  1100. The tag will then be removed from the resulting Palm DOC document, leaving the
  1101. text clean. This is a simple way to create repetitive bookmarks, like one for
  1102. each <quote>Chapter</quote> in your Palm DOC documents.
  1103. </para></listitem>
  1104. </varlistentry>
  1105. <varlistentry>
  1106. <term><guilabel>Regular expressions in .bmk file</guilabel></term>
  1107. <listitem><para>
  1108. This is the most complex but the most powerful way to create bookmarks.
  1109. The method involves using regular expressions (QRegExp) in a file
  1110. <filename>TextName.bmk</filename>, where <filename>TextName.txt</filename> is
  1111. the filename of the text, to search the text for bookmarks. See the
  1112. <ulink
  1113. url="http://reinhold.kainhofer.com/Linux/KPilot/bmkSpecification.txt">
  1114. documentation</ulink>
  1115. for an in-depth description of the bmk file format.
  1116. </para></listitem>
  1117. </varlistentry>
  1118. <varlistentry>
  1119. <term><guilabel>Encoding</guilabel></term>
  1120. <listitem><para>
  1121. Set here the encoding of your &handheld;. &kpilot; will convert the text
  1122. document to this encoding when exporting the file to the &handheld;.
  1123. </para></listitem>
  1124. </varlistentry>
  1125. </variablelist>
  1126. <para>
  1127. In the <guilabel>Handheld -> PC</guilabel> page, you can configure bookmarks
  1128. settings to use when converting from Palm DOC databases to text files.
  1129. </para>
  1130. <variablelist>
  1131. <varlistentry>
  1132. <term><guilabel>Convert Bookmarks</guilabel></term>
  1133. <listitem>
  1134. <para>
  1135. The Palm DOC format has a provision for bookmark records. Bookmarks allow you to
  1136. easily jump to selected parts of the document, making browsing long documents
  1137. easier. The Palm DOC conduit can convert Palm DOC
  1138. bookmark records to a format that is readable in your computer, either as
  1139. a separate file or as tags in the middle of the text file. Select
  1140. <guilabel>Do not convert bookmarks</guilabel> if you want to ignore the Palm DOC
  1141. bookmarks, resulting in a text that is clean from bookmark tags.</para>
  1142. <para>
  1143. The <guilabel>Convert into .bm file</guilabel> options also result in a clean
  1144. text file, as the bookmarks are converted to a separate file in the bmk format,
  1145. as described <ulink
  1146. url="http://reinhold.kainhofer.com/Linux/KPilot/bmkSpecification.txt">here</ulink>. The file is saved with a <literal role="extension">.bm</literal>
  1147. extension to avoid conflicts with <literal role="extension">.bmk</literal> files
  1148. created previously.</para>
  1149. <para>Finally, the <guilabel>Convert as inline tags</guilabel> option creates
  1150. inline tags inside the resulting text file form &lt;*
  1151. <replaceable>BookmarkName</replaceable> *&gt; placing each tag in the place that
  1152. was previously referenced by the bookmark, and using the bookmark name as the
  1153. <replaceable>BookmarkName</replaceable> text inside the tag. Now you You can
  1154. edit the bookmark name, move it or delete it and convert back to Palm DOC, as
  1155. you wish.
  1156. </para>
  1157. </listitem>
  1158. </varlistentry>
  1159. <varlistentry>
  1160. <term><guilabel>Do not convert, if text unchanged (only
  1161. bookmarks)</guilabel></term>
  1162. <listitem>
  1163. <para>
  1164. If you check this box, only changes in the text will trigger conversions from
  1165. Palm DOC to text files. In other words, changes in the bookmarks only will not
  1166. result in updates for the text files in your computer.
  1167. </para>
  1168. </listitem>
  1169. </varlistentry>
  1170. </variablelist>
  1171. <para>
  1172. In the <guilabel>Conflicts</guilabel> page, you can configure how the conduit
  1173. deals with files that changed both in the computer and the &handheld;.
  1174. </para>
  1175. <variablelist>
  1176. <varlistentry>
  1177. <term><guilabel>Conflict Resolution</guilabel></term>
  1178. <listitem><para>
  1179. The Palm DOC conduit does not feature merging the modifications when a text is
  1180. changed both in the &handheld; and in the computer. Therefore, the choice is
  1181. between working with the files out of sync, or discarding the changes in one of
  1182. them. The <guilabel>No resolution</guilabel> option will avoid synchronizing
  1183. texts with conflicts, the <guilabel>PDA overrides</guilabel> option will
  1184. overwrite the computer text file version in case of conflict,
  1185. the <guilabel>PC overrides</guilabel> will do the same, but the other way
  1186. around,
  1187. and the <guilabel>Ask the user</guilabel> option will bring a dialog to let the
  1188. user decide on a file by file, case by case basis.
  1189. </para></listitem>
  1190. </varlistentry>
  1191. <varlistentry>
  1192. <term><guilabel>Always show resolution dialog, even when there are no
  1193. conflicts</guilabel></term>
  1194. <listitem><para>
  1195. This option will always bring the conflict resolution dialog, even if there is
  1196. no conflicts to solve. The advantage is that you can keep track of all the files
  1197. that are being covered by the conduit.
  1198. </para></listitem>
  1199. </varlistentry>
  1200. </variablelist>
  1201. </sect2>
  1202. <sect2 id="conduit-kaddressbook">
  1203. <title>&kaddressbook; Conduit Setup</title>
  1204. <para>
  1205. This conduit will synchronize your &PalmPilot; with the &kde; address book or to
  1206. a vCard file of your choice. In the latter case, the conduit will need the
  1207. filename of the
  1208. vCard file (this will usually be a file that ends in <literal
  1209. role="extension">.vcf</literal>) to sync with, of if it uses the standard
  1210. &kde; address book file, it will be under the
  1211. <filename class="directory">$TDEHOME/share/apps/tdeabc/</filename>
  1212. folder, where the <filename class="directory">$TDEHOME</filename> environment
  1213. variable (typically <filename class="directory">/home/Login Name/.trinity/</filename>)
  1214. points to the folder that contains your configuration and data for the &kde;
  1215. applications.
  1216. </para>
  1217. <screenshot>
  1218. <screeninfo>The &kaddressbook; Conduit Setup Dialog</screeninfo>
  1219. <mediaobject>
  1220. <imageobject><imagedata fileref="setup-address.png" format="PNG"/></imageobject>
  1221. <textobject><phrase>&kaddressbook; Conduit Setup</phrase></textobject>
  1222. <caption><para>&kaddressbook; Conduit Setup</para></caption>
  1223. </mediaobject>
  1224. </screenshot>
  1225. <para>
  1226. In the <guilabel>General</guilabel> page, you can set the general address sync
  1227. options.
  1228. </para>
  1229. <variablelist>
  1230. <varlistentry>
  1231. <term><guilabel>Sync Destination</guilabel></term>
  1232. <listitem><para>
  1233. Choose between synchronizing with the <guilabel>Standard address book</guilabel>,
  1234. or in other words, the &kde; standard address book or with a
  1235. <guilabel>vCard file</guilabel> of your choice, that you must either
  1236. write in the <guilabel>vCard file</guilabel> edit box or select using the
  1237. file picker.
  1238. </para>
  1239. <warning><para>
  1240. You can use the address book conduit with any application that accepts a file in
  1241. the vCard format as a resource. However, some applications may not handle
  1242. the synchronization gracefully while they are open. As a rule of thumb,
  1243. quit these applications before synchronizing, otherwise you may lose data.
  1244. There is no need to take these precautions when syncing with the &kde; address
  1245. book.
  1246. </para></warning>
  1247. </listitem>
  1248. </varlistentry>
  1249. <varlistentry>
  1250. <term><guilabel>Store archived records in the KDE address book</guilabel></term>
  1251. <listitem><para>
  1252. The &handheld; offers an option to archive deleted addresses in your desktop.
  1253. If that option is selected, check this box to keep the deleted addresses from
  1254. your &handheld; in your <acronym>PC</acronym> address book. These addresses will
  1255. be no longer synchronized with your handheld.
  1256. </para></listitem>
  1257. </varlistentry>
  1258. </variablelist>
  1259. <para>
  1260. In the <guilabel>Conflicts</guilabel> page, you can set the address book conduit
  1261. options, overriding &kpilot;'s general settings for conflict resolution when
  1262. you are using this conduit. For a detailed description of the different conflict
  1263. resolution possibilities available, please refer to the
  1264. <link linkend="page-hotsync">HotSync Setup section</link> of this handbook.
  1265. </para>
  1266. <para>
  1267. In the <guilabel>Fields</guilabel> page, you can set the conduit options for
  1268. synchronizing the &handheld; address fields that do not have a direct
  1269. counterpart in the &kde; address book.
  1270. </para>
  1271. <variablelist>
  1272. <varlistentry>
  1273. <term><guilabel>Handheld other phone:</guilabel></term>
  1274. <listitem><para>
  1275. The <quote>Other</quote> field in the &handheld; address application can be
  1276. used for many things (for instance storing a secondary email address). It is
  1277. not clear how to classify this field in &kde;. Depending on your usage, select
  1278. in
  1279. the dropdown the field from the computer that will be synchronized with the
  1280. <quote>Other</quote> field from your &handheld;.
  1281. </para></listitem>
  1282. </varlistentry>
  1283. <varlistentry>
  1284. <term><guilabel>Handheld street address:</guilabel></term>
  1285. <listitem><para>
  1286. While the <quote>Address</quote> field in the &handheld; address
  1287. application is the only default option for storing an street address, the &kde;
  1288. street address field can be a home address or a business address. The preferred
  1289. address will have precedence over other addresses, and the conduit will try to
  1290. set
  1291. this status by default. Either the home or business street address will be used
  1292. to
  1293. store the &handheld; street address. Select in the dropdown the option that
  1294. suits better your needs. For instance, if you use this field mainly for business
  1295. addresses, select <guilabel>Preferred, then Business Address</guilabel>. If not,
  1296. select <guilabel>Preferred, then Home Address</guilabel>.
  1297. </para></listitem>
  1298. </varlistentry>
  1299. <varlistentry>
  1300. <term><guilabel>Handheld fax:</guilabel></term>
  1301. <listitem><para>
  1302. While the <quote>Fax</quote> field in the &handheld; address
  1303. application is the only default option for storing a fax number, the &kde;
  1304. address book can store a home fax or a business fax number. Select in the
  1305. dropdown the option that suits better your needs. For instance, if you use this
  1306. field mainly for business faxes, select <guilabel>Business Fax</guilabel>. If
  1307. not,
  1308. select <guilabel>Home Fax</guilabel>.
  1309. </para></listitem>
  1310. </varlistentry>
  1311. </variablelist>
  1312. <para>
  1313. In the <guilabel>Custom Fields</guilabel> page, you can set the conduit options
  1314. for
  1315. dealing with the <quote>Custom</quote> fields from your &handheld; address
  1316. application. Since there are no natural correspondence between these fields and
  1317. other &kde; address book fields, you can set them as you like. You can use them
  1318. to store a <guilabel>URL</guilabel>, a <guilabel>IM Address</guilabel>,
  1319. the <guilabel>Birthdate</guilabel> of your contact or the obvious:
  1320. <guilabel>Store as Costume Field</guilabel>.
  1321. </para>
  1322. <para>
  1323. If you select to store birthdays, remember to use a date format that is
  1324. consistent with the settings in the <guilabel>Date format</guilabel> dropdown,
  1325. so that the conduit can correctly identify the date from the record and vice
  1326. versa. Possible placeholders are: %d for the day, %m for the month, %y for the
  1327. two-digit year, %Y for the four-digit year. For example, %d.%m.%Y would
  1328. generate a date like 27.3.1952, while %m/%d/%y would write the same date as
  1329. 03/27/52.
  1330. </para>
  1331. </sect2>
  1332. <sect2 id="sysinfo-cond">
  1333. <title>System Information Conduit Setup</title>
  1334. <para>
  1335. This conduit generates a page with your &handheld; information. Some info about
  1336. your &kde;, &kpilot; and Pilot-Link version is included as well. The available
  1337. output formats are &HTML;, text or custom template. The conduit
  1338. output and in special, the debug output section of the output may help the
  1339. developers track down bugs.
  1340. </para>
  1341. <screenshot>
  1342. <screeninfo>The System Information Conduit Setup Dialog</screeninfo>
  1343. <mediaobject>
  1344. <imageobject><imagedata fileref="conduit-sysinfo.png"
  1345. format="PNG"/></imageobject>
  1346. <textobject><phrase>System Information Conduit Setup</phrase></textobject>
  1347. <caption><para>System Information Conduit Setup</para></caption>
  1348. </mediaobject>
  1349. </screenshot>
  1350. <para>
  1351. In the <guilabel>General</guilabel> page, you can set the output location and
  1352. format.
  1353. </para>
  1354. <variablelist>
  1355. <varlistentry>
  1356. <term><guilabel>Output File</guilabel></term>
  1357. <listitem><para>
  1358. Write in the edit box or use the file picker to select the location and file
  1359. name of the output file where the &handheld; system information will be written.
  1360. </para></listitem>
  1361. </varlistentry>
  1362. <varlistentry>
  1363. <term><guilabel>Type of Output</guilabel></term>
  1364. <listitem><para>
  1365. Choose between <guilabel>HTML</guilabel>, <guilabel>Text file</guilabel> (plain
  1366. text),
  1367. or a selectable <guilabel>Custom template</guilabel>. To create a custom
  1368. template, you can
  1369. use the default template as a reference.
  1370. </para></listitem>
  1371. </varlistentry>
  1372. </variablelist>
  1373. <para>
  1374. In the <guilabel>Parts Included</guilabel> page, you can set which parts will be
  1375. included in the output, one by one, by checking or unchecking them in the
  1376. <guilabel>Output Type</guilabel> list.
  1377. </para>
  1378. </sect2>
  1379. <sect2 id="todo-cond">
  1380. <title>Todo Conduit Setup</title>
  1381. <para>
  1382. This conduit will synchronize your &PalmPilot; To Do List application with
  1383. &korganizer; and &kontact;, or to an iCalendar file of your choice.
  1384. The configuration dialog looks and behaves exactly the same as the configuration
  1385. dialog for the <link linkend="vcal-cond">Calendar Conduit</link>. The only
  1386. difference is that instead of synchronizing the Calendar, you will be syncing
  1387. the To Do List.
  1388. </para>
  1389. <screenshot>
  1390. <screeninfo>The Calendar Conduit Setup Dialog</screeninfo>
  1391. <mediaobject>
  1392. <imageobject><imagedata fileref="conduit-vcal.png" format="PNG"/></imageobject>
  1393. <textobject><phrase>Calendar Conduit Setup</phrase></textobject>
  1394. <caption><para>Calendar Conduit Setup</para></caption>
  1395. </mediaobject>
  1396. </screenshot>
  1397. </sect2>
  1398. <sect2 id="mal-cond">
  1399. <title>MAL (AvantGo) Conduit Setup</title>
  1400. <para>
  1401. The MAL (&AvantGo;) Conduit synchronizes your &handheld; with the &AvantGo;
  1402. server.
  1403. This conduit is based on
  1404. <ulink url="http://jasonday.home.att.net/code/libmal/libmal.html">Jason Day's
  1405. libmal</ulink>.
  1406. The &AvantGo; server offers general content (news, guides, stock quotes, &etc;)
  1407. in a format that is suitable for reading in a &handheld;. To use this conduit,
  1408. you need to register to a service provider, for instance,
  1409. <ulink url="http://www.avantgo.com">AvantGo.com</ulink>, subscribe
  1410. the channels you select and install the &AvantGo; software on your &handheld;,
  1411. and configure the software on your handheld to find the MAL server.
  1412. </para>
  1413. <para>
  1414. The installation software for the &handheld; client is usually only available
  1415. for &Microsoft; &Windows;, if you
  1416. do not have access to a windows computer, you can try installing the databases
  1417. available in the <ulink url="http://www.tomw.org/malsync/">MalSync
  1418. Homepage</ulink>,
  1419. with different versions, one for <trademark>PalmOS</trademark> 5 and other for
  1420. older <trademark>PalmOS</trademark>s.
  1421. </para>
  1422. <para>
  1423. To configure the software on your handheld to find the MAL server, open the
  1424. AGConnect application in your &handheld;, click <guilabel>Settings...</guilabel>
  1425. and enter your MAL server address, the <guilabel>User Name</guilabel> and
  1426. <guilabel>Password</guilabel> you got while registering. The
  1427. &AvantGo; server address is
  1428. <userinput>sync.avantgo.com</userinput>, and its port is
  1429. <userinput>80</userinput>. On some installations, you should use the MobileLink
  1430. instead of the AGConnect application on your &handheld;.
  1431. </para>
  1432. <screenshot>
  1433. <screeninfo>The MAL (AvantGo) Conduit Setup Dialog</screeninfo>
  1434. <mediaobject>
  1435. <imageobject><imagedata fileref="conduit-mal.png" format="PNG"/></imageobject>
  1436. <textobject><phrase>MAL (AvantGo) Conduit Setup</phrase></textobject>
  1437. <caption><para>MAL (AvantGo) Conduit Setup</para></caption>
  1438. </mediaobject>
  1439. </screenshot>
  1440. <para>
  1441. In the <guilabel>General</guilabel> page, you can set the synchronization
  1442. frequency options. It can be set for <guilabel>Every Sync</guilabel>,
  1443. <guilabel>Once per Hour</guilabel>, <guilabel>Once a Day</guilabel>,
  1444. <guilabel>Once a Week</guilabel> or <guilabel>Once a Month</guilabel>.
  1445. The conduit only runs when you hit &HotSync; on your &handheld;, so
  1446. <guilabel>Once per Hour</guilabel>, for instance, really means that
  1447. &kpilot; will only try to synchronize with the MAL servers if it is more than an
  1448. hour since the last MAL sync.
  1449. </para>
  1450. <para>
  1451. The MAL conduit can work through a proxy server. In the
  1452. <guilabel>Proxy</guilabel>
  1453. page, you can set the proxy settings.
  1454. </para>
  1455. <variablelist>
  1456. <varlistentry>
  1457. <term><guilabel>Proxy Type</guilabel></term>
  1458. <listitem><para>
  1459. If you connect the Internet directly, select <guilabel>No proxy</guilabel>,
  1460. requiring no further configuration. But if you use a <guilabel>HTTP
  1461. proxy</guilabel>
  1462. or a <guilabel>SOCKS proxy</guilabel>, select it, to enable the rest of the
  1463. dialog and to make the conduit use it to connect the MAL server.
  1464. </para></listitem>
  1465. </varlistentry>
  1466. <varlistentry>
  1467. <term><guilabel>Server Information</guilabel></term>
  1468. <listitem><para>
  1469. Write in the <guilabel>Server Name</guilabel> dropdown box the address of the
  1470. proxy server to use, in the form <userinput>foo.bar.com</userinput>, not
  1471. <userinput>http://foo.bar.com</userinput> or
  1472. <userinput>http://foo.bar.com:8080</userinput>.
  1473. </para>
  1474. <para>
  1475. Check the box <guilabel>Custom port:</guilabel> if your proxy uses a non
  1476. standard
  1477. port, and enter the correct port number.
  1478. </para>
  1479. <para>
  1480. In the <guilabel>No proxy for</guilabel> edit box, you may enter the list of MAL
  1481. servers that do not need the use of a proxy, separated by commas. For instance,
  1482. <userinput>localhost,lan</userinput>.
  1483. </para>
  1484. <para>
  1485. If your proxy require authentication, enter your <guilabel>User name</guilabel>
  1486. and <guilabel>Password</guilabel> in the respective edit boxes.
  1487. </para>
  1488. </listitem>
  1489. </varlistentry>
  1490. </variablelist>
  1491. <para>In the <guilabel>MAL Server</guilabel> page, you can set the MAL server
  1492. address and settings. Currently, you can only configure this settings using
  1493. the &handheld; MobileLink or AGConnect applications, so this page is
  1494. disabled.</para>
  1495. </sect2>
  1496. <sect2 id="popmail-cond">
  1497. <title>Mail Conduit Setup</title>
  1498. <para>
  1499. This conduit allows you to send mail using a transport.
  1500. The configuration of the Mail Conduit is fairly simple.
  1501. </para>
  1502. <screenshot>
  1503. <screeninfo>Setting up the Mail Conduit</screeninfo>
  1504. <mediaobject>
  1505. <imageobject><imagedata fileref="conduit-popmail-kmail.png"
  1506. format="PNG"/></imageobject>
  1507. <textobject><phrase>The Mail Conduit Setup Dialog</phrase></textobject>
  1508. <caption><para>The Mail Conduit Conduit Setup Dialog</para></caption>
  1509. </mediaobject>
  1510. </screenshot>
  1511. <para>
  1512. There are two tabs in the setup dialog for the Mail Conduit,
  1513. one for Sending mail and one for the credits of the mail conduit.
  1514. </para>
  1515. <para>
  1516. Depending on which send method you choose,
  1517. different fields will be activated in the remainder of the
  1518. tab, allowing you to enter the necessary information.
  1519. Currently, the only method available is <guilabel>Using KMail</guilabel>,
  1520. which has a very simple configuration.
  1521. </para>
  1522. <para>
  1523. Your email address can be entered in the <guilabel>Email
  1524. Address:</guilabel> field. This is the email address that goes in the
  1525. <quote>From:</quote> line in outgoing mail. If you enter a file name in
  1526. the <guilabel>Signature File</guilabel> field then that file will be
  1527. appended to each outgoing mail as a signature.
  1528. </para>
  1529. <para>
  1530. When sending mail through &kmail;, &kpilot; automatically places it in
  1531. your &kmail; outbox. &kmail; saves mail in the outbox until you request
  1532. that those pieces of mail are <emphasis>really</emphasis> sent.
  1533. </para>
  1534. </sect2>
  1535. </sect1>
  1536. </chapter>