diff --git a/Makefile.am b/Makefile.am index 03d2b7c..1a92b00 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,7 +2,7 @@ ## (C) 1997 Stephan Kulow ## Modified by Adriaan de Groot -SUBDIRS = lib kpilot conduits +SUBDIRS = lib kpilot conduits doc messages: $(EXTRACTRC) `find . -name "*.rc" -o -name "*.ui"` > rc.cpp diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..5c0b20e --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,3 @@ +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) diff --git a/doc/kpilot/CMakeLists.txt b/doc/kpilot/CMakeLists.txt new file mode 100644 index 0000000..a177bb4 --- /dev/null +++ b/doc/kpilot/CMakeLists.txt @@ -0,0 +1,12 @@ +################################################# +# +# (C) 2010-2011 Serghei Amelian +# serghei (DOT) amelian (AT) gmail.com +# +# Improvements and feedback are welcome +# +# This file is released under GPL >= 2 +# +################################################# + +tde_create_handbook( DESTINATION kpilot ) diff --git a/doc/kpilot/Makefile.am b/doc/kpilot/Makefile.am new file mode 100644 index 0000000..6792fc5 --- /dev/null +++ b/doc/kpilot/Makefile.am @@ -0,0 +1,2 @@ +KDE_DOCS = kpilot +KDE_LANG = en diff --git a/doc/kpilot/address-app.png b/doc/kpilot/address-app.png new file mode 100644 index 0000000..171b600 Binary files /dev/null and b/doc/kpilot/address-app.png differ diff --git a/doc/kpilot/conduit-knotes.png b/doc/kpilot/conduit-knotes.png new file mode 100644 index 0000000..723c8a6 Binary files /dev/null and b/doc/kpilot/conduit-knotes.png differ diff --git a/doc/kpilot/conduit-mal.png b/doc/kpilot/conduit-mal.png new file mode 100644 index 0000000..e722499 Binary files /dev/null and b/doc/kpilot/conduit-mal.png differ diff --git a/doc/kpilot/conduit-palmdoc.png b/doc/kpilot/conduit-palmdoc.png new file mode 100644 index 0000000..196961b Binary files /dev/null and b/doc/kpilot/conduit-palmdoc.png differ diff --git a/doc/kpilot/conduit-popmail-kmail.png b/doc/kpilot/conduit-popmail-kmail.png new file mode 100644 index 0000000..ad63b35 Binary files /dev/null and b/doc/kpilot/conduit-popmail-kmail.png differ diff --git a/doc/kpilot/conduit-sysinfo.png b/doc/kpilot/conduit-sysinfo.png new file mode 100644 index 0000000..57b4534 Binary files /dev/null and b/doc/kpilot/conduit-sysinfo.png differ diff --git a/doc/kpilot/conduit-vcal.png b/doc/kpilot/conduit-vcal.png new file mode 100644 index 0000000..13270cd Binary files /dev/null and b/doc/kpilot/conduit-vcal.png differ diff --git a/doc/kpilot/configuration.docbook b/doc/kpilot/configuration.docbook new file mode 100644 index 0000000..e0b8979 --- /dev/null +++ b/doc/kpilot/configuration.docbook @@ -0,0 +1,1783 @@ + +Configuring &kpilot; + + +Once &kpilot; is installed it needs to be +configured +to match your hardware. +The conduits +need to be configured as well. +After that you can use &kpilot; +to synchronize your &PalmPilot; with +your &kde; desktop or view +data from your &PalmPilot; with the +built-in viewers. + + + +When you run &kpilot; from either +the panel menu or from the command prompt for the first time +it will prompt you with +a dialog box to configure it. +This configuration dialog can be requested later +from the main application + +Settings +Configure &kpilot; + +menu, from the &kpilot; daemon popup menu + +Configure KPilot... + +menu item or by starting &kpilot; +from the shell +as follows: +$ kpilot + +In addition, if you upgrade &kpilot; and some new configuration +options require your attention, this setup dialog will reappear. + + + +Configuration Dialog + + +The configuration dialog +The configuration dialog + + + + + +&kpilot;'s configuration dialog is a large one. +This is because it contains not only the configuration of the +device for communicating with the &PalmPilot;, but also +the configuration of all the installed conduits. +Each group of configuration options +(general +and conduits) +will be discussed separately. +We will begin, however, by taking a look at the +configuration wizard, which should make most +of the +general group of configuration options superfluous. + + + +Using the Wizard + + +The configuration wizard helps you to set up &kpilot; to communicate +with the &PalmPilot; and to configure the conduits as a group. It's a great +start for new users, and you can always fine-tune your preferences later. + + + +In the Pilot Info dialog, type your User +Name. It +should match the one from the &PalmPilot;. Next, type the file name of +the Device you will use to connect the &PalmPilot; (The +connection can be through a serial port, USB port, infrared, Bluetooth, network +or the generic /dev/pilot device.) +Alternatively, click the +Automatically detect handheld and user name... +button and press the &HotSync; button on your &handheld;. The Wizard will try +to find the correct Device and +User Name. + + + +If the +Device does not have the right permissions, the wizard will +not be able to find it. Normal users must be able to read/write the correct +device. To resolve this issue, please refer to &kpilot; says Can't connect to +pilot +&FAQ; entry, or contact your system administrator. + + + + +The First Configuring Wizard Dialog + + +Configuring Wizard: The Pilot Info +Dialog +Configuring Wizard: The Pilot Info Dialog + + + + +Press the &HotSync; button of your &handheld; to probe for the +correct Device and User Name. + + + + +The Second Configuring Wizard Dialog + + +Configuring Wizard: The Autodetection +Dialog +Configuring Wizard: The Autodetection Dialog + + + + +&kpilot; has the ability to sync the data on your &handheld; with +applications or files on your PC. The programs that +perform these actions are called conduits. The sync dialog configures +all applicable &kpilot; conduits to sync with widely used +PIM suites. You can fine-tune these settings later, from the + +Settings +Configure &kpilot; + +menu. Please check the conduits +configuration +section of this document for more information. + + + +The Third Configuring Wizard Dialog + + +Configuring Wizard: The Sync Dialog +Configuring Wizard: The Sync Dialog + + + + + + + + +General Setup + + +The settings available in the &kpilot; configuration dialog +under the heading General Setup +give you detailed control over the operation of &kpilot;: +you can select a non-standard hardware device, +set special encodings for foreign-language &handheld;s, +and control how &kpilot; displays your data. There +are five items under the General Setup +heading. You may need to expand the General Setup +heading to see them. + + + +Items under General Setup + + +The items under General Setup +The items under General Setup + + + + + +Device Setup + + +This is a setup page that contains options describing +the &PalmPilot; hardware, you, the user +and how you want the various parts of &kpilot; +to be started. + + + +Device Page + + +The Device Page +The Device Page + + + + + + +Pilot device + + +The port that the cradle is connected to. +By default it is +set to /dev/pilot +which should be a symbolic link to the real port. +The port might be a serial port, in which case +/dev/pilot +should point to +something like +/dev/cuaa0 +(in &FreeBSD;) or +/dev/ttyS0 +(in &Linux;). +For &USB; devices, it can be more difficult to +determine where +/dev/pilot +should point. +It may be possible to configure your &USB; daemon +to set up the link automatically, so that +/dev/pilot +points to the right port no matter where you plug in your &PalmOS; device. + + + +Make sure the port has +the correct permissions. +It +must be read/write by all if &kpilot; is intended to be used by a +normal user! &kpilot; will complain if the permissions are wrong, but you +will need to fix the permissions by hand. This could be done by doing a +chmod 666 +device +as root where device is the correct port. + +To resolve this issue, please refer to &kpilot; says Can't connect to pilot + +&FAQ; entry, or contact your system administrator. + + + + +You can also use network sync (with pilot-link 0.11.5 and later) +by entering net:any as the +device name. + + + + + + +Speed + + +Indicate the speed of the serial +connection to the &PalmPilot;. +It has no meaning for &USB; devices. +For an older model &PalmPilot;, choose 9600. +Newer models may be able to handle speeds up to +the maximum listed, 115200. +You can experiment with the connection speed: the &PalmPilot; +manual suggests starting at a speed of 19200 and trying faster +speeds to see if they work. + + + + +Encoding + + +&PalmOS; devices are available in +many different languages. +If your device uses a different encoding than +ISO-latin1, you will need to select the +correct encoding from the list in order to +display special characters correctly. +If you can enter Russian in your &PalmPilot;, +select CP1251, for instance. + + + + + +Pilot user + + +The user name of the &PalmPilot;. By default this name is the same as +your log on name. When you sync with the &PalmPilot; &kpilot; will +check to see if this name matches the one on the &PalmPilot;. If they do +not, you are asked to pick which you will use. If you pick the local +name, the &PalmPilot; will be changed to match. +The Pilot User entry is also used to name the folder that +stores the information from the &PalmPilot;. This folder is created in the +$TDEHOME/share/apps/kpilot/DBBackup/ +folder, where the $TDEHOME environment +variable +(typically /home/Login Name/.trinity/) +points to the folder that contains your configuration and data for the &kde; +applications. + + + + + + + + + +HotSync Setup + + +This page contains settings with which you can instruct &kpilot; to perform +special kinds of &HotSync;, as well as direct how conflicts during a &HotSync; +should be resolved. A conflict happens when both the desktop application and the +&handheld; application change the same data. + + + +&kpilot; interfaces with your &handheld; in two ways: using the +the conduits and the internal viewers. Conduits are plug-in programs which +extend the synchronization capabilities of &kpilot;. &kpilot; stores separate copies of +the databases and records for conduits, while the internal viewers and backup +operation share the same copy. This distinction is important to choose your +update method depending on your usage. If you use mainly the conduits to sync +your &handheld; with external programs, you may choose as default +synchronization method any option that runs the conduits. However, if you use mainly the +internal viewers, you need to update copy of the databases as well in order to +view and edit the information from your &handheld;, so running the conduits only +is not sufficient. + + + +The &HotSync; setup page + + + + + +The &HotSync; Page + + +The &HotSync; setup page + + + + + + + +Default Sync + + + +Select the type of synchronization that will be performed by default. + + + + + + +HotSync: run all selected conduits, sync the databases +with a modified flag set, updating the modified records only. Performs a fast +backup, backing up only the databases that were modified. This option offers +a nice balance between speed and data safety. + + + + + +FastSync: Only synchronize those +databases that have conduits, and perform no backup of the data +on the &PalmPilot;, reducing greatly the time required for the sync +operation. This also means that if something goes wrong with your &PalmPilot;, +you may not be able to recover the databases. This is a classic +trade-off between speed and safety. + + + + + +FullSync: run all selected conduits, and sync all +databases, reading all records, and performing a full backup. It is the safest +option, but takes the longest time to complete, as it will merge all the records +from the &handheld; and your desktop. It is the &kpilot; equivalent of the Palm +SlowSync. + + + + + +Copy PC to handheld: run all conduits and sync all +databases, but instead of merging the information from both sources, copy the PC +data to the handheld. Use with care, as this option erases the changes +you made in your handheld since the last sync. + + + + + +Copy handheld to PC: run all conduits and sync all +databases, but instead of merging the information from both sources, copy the +handheld data to the PC. Use with care, as this option erases the +changes you made in your PC since the last sync. + + + +Remember, when &kpilot; does a &HotSync; and runs the conduits, +the databases in the internal viewers are not +updated. To update the internal viewers, use the FullSync or backup actions. + + + + + + + + + + + + +Do full backup when changing PCs + + +If you &HotSync; your &handheld; with multiple PCs, the flag +on the &handheld; that stores which +records have changed since the last &HotSync; may be inaccurate. It is +recommended to do a full sync when changing PCs. You can +disable the full sync by unchecking this box. + + + + + +Conflict Resolution + + +Data records can be changed both on the &handheld; and +on the PC. If one record has incompatible changes +in both the &handheld; and the PC, (such as +changing a phone number in different ways on both sides), +the conflicting change needs to be resolved so +that the &handheld; and the PC data are consistent again. +Choices for conflict resolution are: + + +Ask User: +pop up a dialog for the user to +choose how the conflict is to be resolved for +every conflict. + +Do Nothing: + leave the entries in an inconsistent state. +Future syncs may not notice the discrepancy. + +Handheld Overrides: +copy the values from the &handheld; to the PC, +discarding the changes on the PC. + +PC Overrides: +copy the values from the PC to the &handheld;, +discarding changes on the &handheld;. + +Values From Last Sync (if possible): +&kpilot; stores a backup copy of the information on your &handheld; depending on +the synchronization method you selected. If this information is available, use +neither +the values from the &handheld; nor the PC, but the values from +the last sync. + +Use Both Entries: +Create duplicate entries of the conflicting records on both the +PC and +&handheld;, one with the value from the PC, the other with +the value +from the &handheld;. + + + + + + + + + + + +Backup Setup + + +This page contains settings specific to the backup operation, which saves +a copy of the the &handheld; databases, allowing the user to +restore this information later. + + +In short, databases are all files stored in your &handheld;. A database +can be either a record database, which stores dynamic information created by the +user (for instance, the addresses or the todo information), or a resource +database, which tend to be static (for instance the applications). + + +Backup Page + + + + +The Backup Page +The Backup Page + + + + + +Databases + + +List databases that should not be synced or backed up. + + + +The values can be either database creator values, which are 4-letter strings +surrounded by square brackets (so for Handbase databases you fill in +[PmDB]), or database names, +which are strings without square brackets that may contain shell-style +wildcards. +See the FAQ +for a list of databases that should be listed +here (the default should be OK though). +Newer &PalmPilot; devices contain emulation code for +the older 68k processor; this means that they have a large +number of databases with names ending in +_a68k. +These do not need to be backed up nor synced, so you could +add *_a68k +to the list of databases to skip. + + + +No backup List here databases that should be excluded from +the backup operation. Some databases do not follow the standard database layout, +and trying to backup and restore them will result in information loss. You may +include here databases with volatile information, such as news or web pages, +that +often do not require to be backed up. + + + + +Not restored List here databases that should be excluded +from the restore operation, even if they were previously backed up. Databases +included here can be installed manually later, using the +File Installer. You may +include here databases with volatile information, such as news or web pages, +that +often do not require to be restored. + + + + + +Changing the contents of the No backup +or Not restored fields, in particular removing +the databases already listed there, can damage those databases +when you perform a &HotSync;. + + + + + + + +Run conduits during a backup + + +The backup typically updates the copy of the &handheld; databases. +Conduits are programs that extend the &kpilot; functionality. Running them +usually means synchronization the &handheld; to other PC +databases, +like the address book or the calender. Check this box to perform both operations +on +every backup. + + + + + + + + + + + +Internal Viewers Setup + +&kpilot; contains viewers for +presenting information from the &PalmPilot;. +These viewers present the databases available on +the &PalmPilot; in much the same way that the device +itself does. Not all databases have an application-specific +viewer, though you can use the generic database viewer for those. +The viewers page contains settings for the internal viewers in +&kpilot;. +These settings change the way in which the data is shown. + + + +Viewers Page + + +The Viewers Setup Page +The Viewers Setup Page + + + + + +Make internal viewers editable + +The internal viewers can be read only or editable. The editable mode allows you +to add new records, delete or edit the existing records and sync your +modifications back to the &handheld;. Check +this box to set the internal viewers to editable mode, uncheck to set them to +read +only mode. + +On some &kpilot; versions, it is not possible check this box, and therefore to +use the internal viewers as editors. + + + + + +Show private records + +In your &PalmPilot; you can mark some records as private. By +default, &kpilot; does not display these records on the screen. Check this box +if you want to see them. + + + + +Address Viewer + +Set there the options for the address internal viewer. + + + +Show as "Last, first" or +Show as "Company, last": the order and display of the +address records in the address internal viewer can be set to match the +&handheld;. Select the option that suits better your personal preferences. + + + +Use key field Check this box to combine entries with the +same last name. + + + + + + + + + + + + + + + +Startup and Exit Behavior Setup + + +This pages present options related to the startup and exit of &kpilot; and +&kpilot; daemon. + + + +While &kpilot; is the front-end for the internal viewers, configuration options +and logs, the sync operation is handled by the &kpilot; daemon. Even if &kpilot; +is not running you can &HotSync; if the daemon is. Therefore, if you want to +be able to sync your &handheld; at anytime, it is important to start the daemon +at login, or the opposite, if you want to be able to sync only when &kpilot; is +running, you have to stop the daemon on exit. The last option is especially +usefull if you have other applications that use the same port as &kpilot;. + + + + +Startup and Exit Page + + +The Startup and Exit Page +The Startup and Exit Page + + + + + + + +Startup Options + + + + + + + +Start daemon at login: +By checking this, a link to +the daemon is placed in your autostart folder +and will be started automatically. Note that this is not normally +needed if the daemon is docked in the panel. + + + + + + +Show daemon in panel: +Check this box to instruct the daemon to place a &kpilot; icon + + + + + + +in the system tray. This icon has a menu that can be brought up with +the right mouse button. Without this option, the daemon is not visible to the +user at all. + + + + + + + + + + + + +Exit Options + + + + + + + + +Quit after HotSync: When this option is enabled, both +&kpilot; and the &kpilot; daemon will exit after the &HotSync; operation has +completed, leaving the device port free for other tools. This may be needed on +systems where the &USB; daemon starts &kpilot; automatically. + + + + + + +Stop daemon on exit: Setting this option will cause the +daemon to exit when you quit &kpilot;, leaving the device port free for other +&PalmPilot;-synchronization tools such as malsync + + + + + + + + + + + + + +Conduits Setup + + +Conduits are programs that interface your &handheld; data with +PC applications or sync your &handheld; data with files +that can be used by PC applications. They can be +written by third parties, to interface your &PalmPilot; to any application +imaginable. + + + +&kpilot;'s configuration dialog allows you to select which conduits +to run during a &HotSync; and to configure those conduits. +A window similar to the following will be displayed: + + +The Conduit Setup Dialog + + + +The Conduit Setup Dialog + + +The Conduit Setup Dialog + + + + +Check the box to the left of the conduit name to make it active, uncheck to make +it inactive or click on the conduit name to configure it. + + + + + +KNotes / Memos + + +Synchronizes the Memo Pad application with &knotes;. + + + + + +Notepad + + +Exports the free hand notes of the &handheld;'s Notepad application as pictures +to the PC. + + + + + + +Time Synchronization + + +Sets the &handheld;'s time to that of the desktop machine. +Useful for keeping the clock of the &handheld; accurate. + + + + + +Calendar (KOrganizer) + + +Synchronizes the Datebook application with &korganizer; or with an +iCalendar file of +your choice. + + + + + +Palm DOC + + +Automatically converts and installs text files in the &PalmPilot; +DOC format, so you can read the text files with most DOC-capable +applications on the &handheld;. + + + + + +Addressbook + + +Synchronizes the Address application with &kaddressbook; or with a vCard file of +your choice. + + + + + +System Information + + +Writes information about your &handheld;, (such as OS version, +RAM available, and the list of databases) to a file. Useful mostly for +debugging purposes. + + + + + +ToDo's (KOrganizer) + + +Synchronizes the Todo list application with &korganizer; or with a iCalendar +file of +your choice. + + + + + +MAL (AvantGo) Conduit + + +Synchronizes your &handheld; with the &AvantGo; server. The &AvantGo; server +offers general content (news, guides, stock quotes, &etc;) in a format that is +suitable for reading in a &handheld;. To use this conduit, you need to register, +subscribe +the channels you select and install the &AvantGo; software on your &handheld;. + + + + +Mail + + +Sends mail written on the &handheld; through &kmail;. +There is no provision for receiving mail, however. + + + + + + + + +&knotes; Conduit Setup + + +The &knotes; Conduit is a partial replacement for the built-in memo application. It keeps the notes you write +with &knotes; synchronized with the memos you write on your &PalmPilot;. + + + +Setting up the &knotes; conduit is very simple. + + + +&knotes; Conduit Setup + + + + + +&knotes; Conduit Setup + + +&knotes; Conduit Setup + + + + + +In the General Tab there are two configuration options: + + + + +Delete KNote when Pilot memo is deleted + + +Uncheck this box if you wish to maintain the note on &knotes; even if the +correspondent memo was deleted on the &handheld; memo application. + + + + + +Suppress delete-confirmation in KNotes + + +If the Delete KNote when Pilot memo is deleted box is +checked, you may check this box to automatically delete the notes that +correspond to a deleted memo, without confirmation. + + + + + + + + +By default, the options delete knote and suppress +delete-confirmation are turned off, so that notes +will accumulate on your PC. + + + + + + + +Notepad Conduit Setup + + +The Notepad Conduit exports the free hand notes of the &handheld;'s Notepad +application as pictures to the desktop. To set the folder to which the pictures +should be exported, either enter it in the Output edit +box or select it clicking the file picker button. + + + + + +Time Synchronization Conduit Setup + + +The Time Synchronization Conduit syncs the &handheld;'s time to that of the +desktop +machine. It is useful for keeping the clock of the &handheld; accurate. There +are really no configuration options other that enabling and disabling the +conduit, as currently only one direction for the synchronization is enabled, +you can only Set the handheld time from the time on the PC, +and not Set the PC time from the time on the handheld. + + + + + +&PalmOS; Version 3.25 and 3.3 do not support setting the &handheld; system time. +For these systems, the conduit will be simply skipped. + + + + + + +Calendar Conduit Setup + + +This conduit will synchronize your &PalmPilot; with &korganizer; and &kontact; +or to an iCalendar file of your choice. In the latter case, the conduit will +need the filename of the calendar file (this will usually be a file that ends in +.ics) to sync with, of if it uses the +standard &korganizer; iCalendar file, it will be under the $TDEHOME/share/apps/korganizer/ folder, where the +$TDEHOME environment variable (typically +/home/user/.trinity/) points to the folder +that contains your configuration and data for the &kde; applications. + + + +The Calendar Conduit Setup Dialog + + + + + +Calendar Conduit Setup + + +Calendar Conduit Setup + + + + + +In the General page, you can set the calendar options. + + + + + +Calendar Destination + + +Choose between synchronizing with the Standard Calendar, +or in other words, the &korganizer; standard calendar or with a +Calendar file of your choice, that you must either +write in the Calendar file edit box or select using the +file picker. + + + + +You can use the calendar conduit with any application that accepts a file in +the iCalendar format as a resource. However, some applications, like Evolution, +do not handle the synchronization gracefully while they are open. As a rule of +thumb, quit these applications before synchronizing, otherwise you will lose +data. There is no need to take these precautions when syncing with &korganizer; +or &kontact;. + + + + + + +Store archived records in the KDE calendar + + +Check this box to save a copy of the archived records from your +&handheld; on the PC, in order to keep a history of +past appointments in you &kde; desktop as well. + + + + + + + +In the Conflicts page, you can set the calendar options, +overriding &kpilot;'s general settings for conflict resolution when you are +using this conduit. For a detailed description of the different conflict +resolution possibilities available, please refer to the HotSync Setup section of this handbook. + + + + + + +Palm DOC Conduit Setup + + +The Palm DOC conduit converts text files in your PC from and +to +databases in Palm DOC format in the &PalmPilot;. You can use any Palm DOC reader +to view these files on your &PalmPilot;. + + + +Palm DOC Conduit Setup + + +Palm DOC Conduit Setup +Palm DOC Conduit Setup + + + + +After changing the Palm DOC conduit configuration, you have to restart &kpilot; +to let the changes you made take effect. + + + +In the General page, you can set the location of the text +documents in your computer and the direction of the synchronization. + + + + + +Text files: + +Type on the text box or use the file picker to select the location of the folder +that the Palm DOC conduit uses a as the place for the text files it will sync +with the &handheld;. There, you may place the text documents you want install or +synchronize to the PDA, and find the text documents created +from Palm DOC +databases in your &handheld;. + +The file name has to end in .txt for the +conduit to recognize it as text. If the file is not recognized as text, it will +be ignored by the conduit. Also, the text has to be in an encoding that is +compatible with your &handheld; encoding. Therefore, if the text file has +characters that are not being correctly recognized by the Palm DOC reader in +your &handheld;, try opening the file a text editor, like &kwrite;, and saving +it in an compatible text encoding using the Save As.. +dialog, or set the encoding in the PC -> Handheld tab. + + + + + + +Local copy: + +If you want to save a copy of the Palm DOC databases from your &handheld; in +your computer, check the Local copy: box and +type on the text box or use the file picker to select the location of the folder +where these databases will be saved. + + + + +Synchronization Mode + +The Palm DOC conduit has the ability to sync from and to the &handheld;, +automatically converting the text files to Palm DOC databases and vice versa. +The Sync only PC to PDA option will convert all text files +located in the folder you selected above to Palm DOC databases and install them +in your &handheld;. +The Sync only PDA to PC option will convert all Palm DOC +databases from your &handheld; to files and install them in the +folder you selected above. Finally, The Sync all option +allows the synchronization to work in both directions. + + +When both the text file and the Palm DOC database are modified, you cannot merge +the modifications, you have to choose one of the versions, losing the changes +in one of them. + + + + + + + +In the PC -> Handheld page, you can configure the Palm DOC +compression and bookmarks settings to use when converting from text files to +Palm DOC databases. + + + + + +Compress + +Palm DOC documents can be compressed, saving considerable amounts +of available memory in your &handheld;. Most Palm DOC readers support +compressed documents, but if you use a reader or editor that is not compatible +with compression (for instance, the Sied editor), you will not be able to read +or edit the compressed Palm DOC documents created by this conduit. +Therefore, check this box to save &handheld; memory, but uncheck it if you have +compatibility problems with compressed Palm DOC in your favorite editor or +reader. + + + + +Convert bookmarks + +The Palm DOC format has a provision for bookmark records. Bookmarks allow you to +easily jump to selected parts of the document, making browsing long documents +easier. Check this box to allow the Palm DOC conduit to create bookmark records. +To create them, the conduit has to know the location in the text and the name of +the bookmark. There are three supported ways to let the conduit know the +location and name of the bookmark: from inline tags in the text, from tags at +the end of the text and from a .bmk bookmark +file. To make the creation of bookmarks effective, you have to check at least +one of these boxes below. + + + + +Inline tags in text + +Convert tags in the format <* BookmarkName *> +located inside the text to Palm DOC bookmarks, where the location of the +tag in the text will be converted to the bookmark location and the +BookmarkName text inside the tag will be converted to +the name of the bookmark in the Palm DOC format. The tag will be removed from +the resulting Palm DOC document, leaving the text clean. +This is a very easy and intuitive way to create bookmarks +in your Palm DOC documents. + + + + +Tags at end of text + +Convert tags in the format <BookmarkName> +located in the end of the text to Palm DOC bookmarks. Whenever the +BookmarkName text appears in the text, the conduit +will generate a the bookmark in the resulting Palm DOC document pointing to it. +The tag will then be removed from the resulting Palm DOC document, leaving the +text clean. This is a simple way to create repetitive bookmarks, like one for +each Chapter in your Palm DOC documents. + + + + +Regular expressions in .bmk file + +This is the most complex but the most powerful way to create bookmarks. +The method involves using regular expressions (QRegExp) in a file +TextName.bmk, where TextName.txt is +the filename of the text, to search the text for bookmarks. See the + +documentation +for an in-depth description of the bmk file format. + + + + +Encoding + +Set here the encoding of your &handheld;. &kpilot; will convert the text +document to this encoding when exporting the file to the &handheld;. + + + + + + +In the Handheld -> PC page, you can configure bookmarks +settings to use when converting from Palm DOC databases to text files. + + + + + +Convert Bookmarks + + +The Palm DOC format has a provision for bookmark records. Bookmarks allow you to +easily jump to selected parts of the document, making browsing long documents +easier. The Palm DOC conduit can convert Palm DOC +bookmark records to a format that is readable in your computer, either as +a separate file or as tags in the middle of the text file. Select +Do not convert bookmarks if you want to ignore the Palm DOC +bookmarks, resulting in a text that is clean from bookmark tags. + + +The Convert into .bm file options also result in a clean +text file, as the bookmarks are converted to a separate file in the bmk format, +as described here. The file is saved with a .bm +extension to avoid conflicts with .bmk files +created previously. + +Finally, the Convert as inline tags option creates +inline tags inside the resulting text file form <* +BookmarkName *> placing each tag in the place that +was previously referenced by the bookmark, and using the bookmark name as the +BookmarkName text inside the tag. Now you You can +edit the bookmark name, move it or delete it and convert back to Palm DOC, as +you wish. + + + + + +Do not convert, if text unchanged (only +bookmarks) + + +If you check this box, only changes in the text will trigger conversions from +Palm DOC to text files. In other words, changes in the bookmarks only will not +result in updates for the text files in your computer. + + + + + + + +In the Conflicts page, you can configure how the conduit +deals with files that changed both in the computer and the &handheld;. + + + + + +Conflict Resolution + +The Palm DOC conduit does not feature merging the modifications when a text is +changed both in the &handheld; and in the computer. Therefore, the choice is +between working with the files out of sync, or discarding the changes in one of +them. The No resolution option will avoid synchronizing +texts with conflicts, the PDA overrides option will +overwrite the computer text file version in case of conflict, +the PC overrides will do the same, but the other way +around, +and the Ask the user option will bring a dialog to let the +user decide on a file by file, case by case basis. + + + + +Always show resolution dialog, even when there are no +conflicts + +This option will always bring the conflict resolution dialog, even if there is +no conflicts to solve. The advantage is that you can keep track of all the files +that are being covered by the conduit. + + + + + + + + + + +&kaddressbook; Conduit Setup + + +This conduit will synchronize your &PalmPilot; with the &kde; address book or to +a vCard file of your choice. In the latter case, the conduit will need the +filename of the +vCard file (this will usually be a file that ends in .vcf) to sync with, of if it uses the standard +&kde; address book file, it will be under the +$TDEHOME/share/apps/tdeabc/ +folder, where the $TDEHOME environment +variable (typically /home/Login Name/.trinity/) +points to the folder that contains your configuration and data for the &kde; +applications. + + + +The &kaddressbook; Conduit Setup Dialog + + +&kaddressbook; Conduit Setup +&kaddressbook; Conduit Setup + + + + +In the General page, you can set the general address sync +options. + + + + + +Sync Destination + +Choose between synchronizing with the Standard address book, +or in other words, the &kde; standard address book or with a +vCard file of your choice, that you must either +write in the vCard file edit box or select using the +file picker. + + +You can use the address book conduit with any application that accepts a file in +the vCard format as a resource. However, some applications may not handle +the synchronization gracefully while they are open. As a rule of thumb, +quit these applications before synchronizing, otherwise you may lose data. +There is no need to take these precautions when syncing with the &kde; address +book. + + + + + +Store archived records in the KDE address book + +The &handheld; offers an option to archive deleted addresses in your desktop. +If that option is selected, check this box to keep the deleted addresses from +your &handheld; in your PC address book. These addresses will +be no longer synchronized with your handheld. + + + + + + +In the Conflicts page, you can set the address book conduit +options, overriding &kpilot;'s general settings for conflict resolution when +you are using this conduit. For a detailed description of the different conflict +resolution possibilities available, please refer to the +HotSync Setup section of this handbook. + + + +In the Fields page, you can set the conduit options for +synchronizing the &handheld; address fields that do not have a direct +counterpart in the &kde; address book. + + + + + +Handheld other phone: + +The Other field in the &handheld; address application can be +used for many things (for instance storing a secondary email address). It is +not clear how to classify this field in &kde;. Depending on your usage, select +in +the dropdown the field from the computer that will be synchronized with the +Other field from your &handheld;. + + + + +Handheld street address: + +While the Address field in the &handheld; address +application is the only default option for storing an street address, the &kde; +street address field can be a home address or a business address. The preferred +address will have precedence over other addresses, and the conduit will try to +set +this status by default. Either the home or business street address will be used +to +store the &handheld; street address. Select in the dropdown the option that +suits better your needs. For instance, if you use this field mainly for business +addresses, select Preferred, then Business Address. If not, +select Preferred, then Home Address. + + + + +Handheld fax: + +While the Fax field in the &handheld; address +application is the only default option for storing a fax number, the &kde; +address book can store a home fax or a business fax number. Select in the +dropdown the option that suits better your needs. For instance, if you use this +field mainly for business faxes, select Business Fax. If +not, +select Home Fax. + + + + + + +In the Custom Fields page, you can set the conduit options +for +dealing with the Custom fields from your &handheld; address +application. Since there are no natural correspondence between these fields and +other &kde; address book fields, you can set them as you like. You can use them +to store a URL, a IM Address, +the Birthdate of your contact or the obvious: +Store as Costume Field. + + + +If you select to store birthdays, remember to use a date format that is +consistent with the settings in the Date format dropdown, +so that the conduit can correctly identify the date from the record and vice +versa. Possible placeholders are: %d for the day, %m for the month, %y for the +two-digit year, %Y for the four-digit year. For example, %d.%m.%Y would +generate a date like 27.3.1952, while %m/%d/%y would write the same date as +03/27/52. + + + + + + +System Information Conduit Setup + + +This conduit generates a page with your &handheld; information. Some info about +your &kde;, &kpilot; and Pilot-Link version is included as well. The available +output formats are &HTML;, text or custom template. The conduit +output and in special, the debug output section of the output may help the +developers track down bugs. + + + + +The System Information Conduit Setup Dialog + + +System Information Conduit Setup +System Information Conduit Setup + + + + +In the General page, you can set the output location and +format. + + + + + +Output File + +Write in the edit box or use the file picker to select the location and file +name of the output file where the &handheld; system information will be written. + + + + +Type of Output + +Choose between HTML, Text file (plain +text), +or a selectable Custom template. To create a custom +template, you can +use the default template as a reference. + + + + + + +In the Parts Included page, you can set which parts will be +included in the output, one by one, by checking or unchecking them in the +Output Type list. + + + + + + +Todo Conduit Setup + + +This conduit will synchronize your &PalmPilot; To Do List application with +&korganizer; and &kontact;, or to an iCalendar file of your choice. +The configuration dialog looks and behaves exactly the same as the configuration +dialog for the Calendar Conduit. The only +difference is that instead of synchronizing the Calendar, you will be syncing +the To Do List. + + + +The Calendar Conduit Setup Dialog + + +Calendar Conduit Setup +Calendar Conduit Setup + + + + + + +MAL (AvantGo) Conduit Setup + + +The MAL (&AvantGo;) Conduit synchronizes your &handheld; with the &AvantGo; +server. +This conduit is based on +Jason Day's +libmal. +The &AvantGo; server offers general content (news, guides, stock quotes, &etc;) +in a format that is suitable for reading in a &handheld;. To use this conduit, +you need to register to a service provider, for instance, +AvantGo.com, subscribe +the channels you select and install the &AvantGo; software on your &handheld;, +and configure the software on your handheld to find the MAL server. + + + +The installation software for the &handheld; client is usually only available +for &Microsoft; &Windows;, if you +do not have access to a windows computer, you can try installing the databases +available in the MalSync +Homepage, +with different versions, one for PalmOS 5 and other for +older PalmOSs. + + + +To configure the software on your handheld to find the MAL server, open the +AGConnect application in your &handheld;, click Settings... +and enter your MAL server address, the User Name and +Password you got while registering. The +&AvantGo; server address is +sync.avantgo.com, and its port is +80. On some installations, you should use the MobileLink +instead of the AGConnect application on your &handheld;. + + + +The MAL (AvantGo) Conduit Setup Dialog + + +MAL (AvantGo) Conduit Setup +MAL (AvantGo) Conduit Setup + + + + +In the General page, you can set the synchronization +frequency options. It can be set for Every Sync, +Once per Hour, Once a Day, +Once a Week or Once a Month. +The conduit only runs when you hit &HotSync; on your &handheld;, so +Once per Hour, for instance, really means that +&kpilot; will only try to synchronize with the MAL servers if it is more than an +hour since the last MAL sync. + + + +The MAL conduit can work through a proxy server. In the +Proxy +page, you can set the proxy settings. + + + + + +Proxy Type + +If you connect the Internet directly, select No proxy, +requiring no further configuration. But if you use a HTTP +proxy +or a SOCKS proxy, select it, to enable the rest of the +dialog and to make the conduit use it to connect the MAL server. + + + + +Server Information + +Write in the Server Name dropdown box the address of the +proxy server to use, in the form foo.bar.com, not +http://foo.bar.com or +http://foo.bar.com:8080. + + +Check the box Custom port: if your proxy uses a non +standard +port, and enter the correct port number. + + +In the No proxy for edit box, you may enter the list of MAL +servers that do not need the use of a proxy, separated by commas. For instance, +localhost,lan. + + +If your proxy require authentication, enter your User name +and Password in the respective edit boxes. + + + + + + +In the MAL Server page, you can set the MAL server +address and settings. Currently, you can only configure this settings using +the &handheld; MobileLink or AGConnect applications, so this page is +disabled. + + + + +Mail Conduit Setup + + +This conduit allows you to send mail using a transport. +The configuration of the Mail Conduit is fairly simple. + + +Setting up the Mail Conduit + + +The Mail Conduit Setup Dialog +The Mail Conduit Conduit Setup Dialog + + + +There are two tabs in the setup dialog for the Mail Conduit, +one for Sending mail and one for the credits of the mail conduit. + + + +Depending on which send method you choose, +different fields will be activated in the remainder of the +tab, allowing you to enter the necessary information. +Currently, the only method available is Using KMail, +which has a very simple configuration. + + + +Your email address can be entered in the Email +Address: field. This is the email address that goes in the +From: line in outgoing mail. If you enter a file name in +the Signature File field then that file will be +appended to each outgoing mail as a signature. + + + +When sending mail through &kmail;, &kpilot; automatically places it in +your &kmail; outbox. &kmail; saves mail in the outbox until you request +that those pieces of mail are really sent. + + + + + + \ No newline at end of file diff --git a/doc/kpilot/daemon-menu.png b/doc/kpilot/daemon-menu.png new file mode 100644 index 0000000..4e7018d Binary files /dev/null and b/doc/kpilot/daemon-menu.png differ diff --git a/doc/kpilot/db-app.png b/doc/kpilot/db-app.png new file mode 100644 index 0000000..f55842a Binary files /dev/null and b/doc/kpilot/db-app.png differ diff --git a/doc/kpilot/faq.docbook b/doc/kpilot/faq.docbook new file mode 100644 index 0000000..cbc9196 --- /dev/null +++ b/doc/kpilot/faq.docbook @@ -0,0 +1,386 @@ + +&FAQ; + + +&kpilot; Startup Problems + + + + + + +What do I put after ? + + + + +Nothing. Most versions of &kpilot; don't even have +a option, and will complain if you use it. +For those versions that do have it, +use a value between 1 and 4, which will control the +amount of debugging printed (a little). +Using a value of 1 will print a fairly complete call trace +without the really-boring functions, while 4 will include every trivial +function in all of &kpilot;. + + + + + + + + +&kpilot; says Can't connect to pilot + + + + +This can have various causes. Check that: + + + + The pilot device (usually /dev/pilot) exists and points to the + serial port the &PalmPilot; is actually connected to. + + + To link the &PalmPilot; device to the correct serial port, you can + either fill in + /dev/ttySn + in the Pilot Device field in the setup dialog or (preferably) link + /dev/pilot to + /dev/ttySn + with the following command (as root): + + ln + + /dev/ttySn + /dev/pilot + Here /dev/ttySn + is the name + of the serial port; replace n + with the correct number (usually 0 or 1). + + + + + Check that you have permission to read and write to the serial port. + The permissions for the serial port should be such that you can write to + it. This is most easily done by running the following (as root): + + chmod + + /dev/ttySn + + + + + + Try starting the daemon by hand before starting &kpilot;. + + + + + (For &Linux-Mandrake; 7 systems) Check the system security level: + settings higher than 3 prevent some forms of inter-process + communication which are necessary for &kpilot; to + operate correctly. + + + + (&Linux-Mandrake; security information + courtesy of Jay Summett) + To set your +MSEC +(Mandrake SECurity) + settings to not block the + &kpilot; socket (for connections to localhost) you can + login as root and + type + + /etc/security/msec/init.sh + + + Which will set your +MSEC + level to 3 (regular security). + For more information about the various security levels, &etc;, see: + + the +Mandrake +reference guide. + + + + + + + + + + + + +Database Questions + + +This section answers questions commonly asked about +particular databases and how they +interact with &kpilot;. + + + + + + + +Databases become corrupted after a sync, +what should I do? + + + + +Certain databases (from third-party software manufacturers) +appear not to follow the standard database layout. +If you can find out what the creator id of the database is, +you can add it to either the +Backup Only: list or the +Skip list in the +settings dialog. + + + +The following table shows which databases should be skipped +or backed-up only: + +Databases needing Special Treatment + + +DatabaseCreator IDAction + + + + Launcher (the &PalmPilot;'s main menu) + lnch + Backup Only: + + + Arranger + Arng + Backup Only: + + + (unknown) + PmDB + Backup Only: + + + AvantGo + avgo + Skip (Mostly because there's no point in backing up the + news articles that AvantGo gives you) + + + + +
+ + + + + + + +Is there a conduit for &Netscape; Calendar? + + + + +No, there isn't. +Neither are there plans to include support or write a +conduit for &Netscape; Calendar. + + + + + + + + + + + +Special HotSync Questions + + + +This section lists questions about HotSync methods that differ +from the usual direct serial link method. + + + + + + + +How do I do an infrared (IR) HotSync? + + + + +First of all your &PalmPilot; has to actually support +IR HotSyncs. This can be achieved through various +means: &PalmOS; 3.3 and higher include support for it; there is an +IR enhancements package for older &PalmOS; versions; +IrLink from IsComplete apparently has the +same capabilities. Check out the PalmOne web pages for more information. + + + +Assuming your &PalmPilot; now has PC HotSync support +and it is setup to do IR HotSyncs (in the HotSync +preferences on the &PalmPilot;), we can turn our attention to the +PC you will be synchronization with. It needs an +IR port. For laptops, this is trivial, desktop +PCs may require some extra hardware. + + + +Your &Linux; kernel will need to support IR and the IRCOMM protocol. +For stock +&RedHat; +systems, the following command should +setup IR support (as root): + +# modprobe + + +Other distributions should follow the IR-HOWTO. +Once IR support in the kernel has been activated, +you need to make devices for the IR ports. +The IR-HOWTO suggests (as root): + +# mknod + 60 64 +# chmod + /dev/ircomm0 + +Next we need to start some daemons for IR services: + +# irattach + +# irmanager + 0 + +Here /dev/ttySn +is the serial port +the IR port is using. n could be 0, 1, or some other +number depending on your hardware setup. +Follow the instructions in the IR-HOWTO for assistance +(for desktop machines, it's usually a setting in the BIOS). + + + +Once you've gotten this far, just make /dev/pilot +point to /dev/ircomm0 +and you're ready! + + + +The IR-HOWTO and other useful information on using IR may +be found at +http://mobilix.org/howtos.html +and +http://mobilix.org/software/irda/. + + + + + + +Can I do a &HotSync; with my (USB) +&Handspring; &Visor;? + + + + +Yes, you can. +I don't have definitive information, but postings on the +&kpilot; mailing-list have stated that you can point /dev/pilot +to the USB device and everything will work fine. + + + + + +Is there any support for remote HotSyncs? + + + +No, not yet. +Maybe later. + + + + + + + + + + +&kpilot;'s &DCOP; interface + + + + + +What does &kpilot; use &DCOP; for? + + +The daemon and &kpilot; communicate using &DCOP; +for several purposes: logging messages, changing the &HotSync; +type, and exchanging configuration information. + + + + +Which &DCOP; interfaces are there? + + +The daemon has two important interfaces: +LogIface +and +KPilotDaemonIface +. +The LogIface +interface is used to record messages in the sync log +on the &handheld;, and is rarely used. +The KPilotDaemonIface +is the more important &DCOP; interface, +and is used to control the kind of &HotSync; that +&kpilot; will do. + + + + +How can I tell the daemon to perform a specific kind of &HotSync;? + +There are three &DCOP; functions that control what kind +of &HotSync; +the daemon will do next: + + + + + + + + + diff --git a/doc/kpilot/file-app.png b/doc/kpilot/file-app.png new file mode 100644 index 0000000..16e8d40 Binary files /dev/null and b/doc/kpilot/file-app.png differ diff --git a/doc/kpilot/index.docbook b/doc/kpilot/index.docbook new file mode 100644 index 0000000..e787e5a --- /dev/null +++ b/doc/kpilot/index.docbook @@ -0,0 +1,280 @@ + + + + +USB"> +Palm OS'> +PalmOne'> +Sony'> +Clie"> +FreeBSD'> +AvantGo'> + + + + + + + +]> + + + + + + +&kpilot; User's Guide + + + + Carlos + Leonhard + Woelz + +
carloswoelz@imap-mail.com
+ + + + Adriaan + de + Groot + +
groot@kde.org
+ + + + Dan + Pilone + + + + + +1999 +2000 +2001 +2002 +2003 +2004 +Adriaan de Groot + + + +2004 +2005 +Carlos Woelz + + + +&FDLNotice; + +2004-06-27 +&kpilotver; + + + +&kpilot; &kpilotver; is the &kde; version of the Desktop &HotSync; software for +&PalmOne; handhelds, the &ThreeCom; &PalmPilot; and other &PalmOS; devices. + + + + +KDE +KPilot +tdepim +palm pilot +synchronization + + + + + +Introduction + + +&kpilot; &kpilotver; is an application that synchronizes your &PalmPilot; or +similar device (like the &Handspring; &Visor;, the &Sony; &Clie; or other +&PalmOS; devices) with your &kde; desktop, much like the Palm Desktop &HotSync; +software does for &Windows;. &kpilot; can back-up, restore, and &HotSync; your +&PalmPilot;. It can synchronize the built-in applications with their &kde; +counterparts. It also features additional conduits for third-party software. + + + +There is a web page for &kpilot;: the Official &kpilot; Home Page. The KDE-PIM website also offers useful information +on the subject of PIM in general. &kpilot; shares the +tdepim-users mailing list, tdepim-users@kde.org. See the mailing lists page for more +information on subscribing and unsubscribing from the list. + + + + + +Trademarks + +&kpilot; describes synchronization operations +with &PalmOS; devices, and it uses the word &HotSync; +to name those synchronization operations, +while recognizing that &HotSync; is a trademark of +Palm, Inc. Holders of other trademarks, such as +&Handspring; &Visor;, &Sony; &Clie;, and +the Palm, Inc. trademarks &PalmPilot; and +Zire +are recognized as well. + + + + + + +Overview of &kpilot; + + +&kpilot; consists of two parts: the &kpilot; daemon, which sits +in the system tray and handles the actual communication with +the &handheld;, and the normal &kpilot; program, which lets +you configure the daemon and view the databases on your +&handheld;. In normal operation, you will not need to use &kpilot; +itself very much, since the daemon handles communication unobtrusively +and synchronizes your data to &kde; applications like &korganizer; +and &knotes;. &kpilot; is integrated into &kontact; as well. + + + +It is vital to configure &kpilot; before use. At the very least, +you need to tell it which hardware device to use to communicate with +your &handheld;. +Configuration settings are described at length in +the section on configuring &kpilot;. +For the impatient, the configuration wizard +can set up most things for you. + + + +Once &kpilot; is configured, you should make a backup of your &handheld; first. That is to be on the +safe side. Once that is done, you can just leave the &kpilot; daemon running in +the system tray, and all you need to do is press the &HotSync; button, and +changes in the &handheld; data and the &kde; applications will be synchronized, so that the information matches +again on both the &handheld; and the desktop. + + + +If you want to examine the +data stored on your &handheld;, the built in viewers can be used. This allows you to view +memos, addresses, &etc;. There is a generic hexadecimal database viewer for +advanced use. + + + +Finally, &kpilot; can be used to install +new programs and databases on your &handheld;. + + + + + + +&configuring-kpilot; +&using-kpilot; +&synchronization; +&kpilot-faq; + + + + +Credits and License + + +&kpilot; +Program copyright 1998-2000 by &Dan.Pilone; +&Dan.Pilone.mail; + + +Contributors: + +Adriaan de Groot groot@kde.org + +&Preston.Brown; pbrown@redhat.com + +VCal and Todo Conduits by: Herwin Jan Steehouwer, +Kenneth Albanowski, &Michael.Kropfberger; + +Popmail Conduit overhaul: Marko Grönroos + +&kaddressbook; Conduit: Greg Stern + +Patches by: +Jörn Ahrens, +Robert Ambrose, +Jörg Habenicht, +Philipp Hullmann, +Dag Nygren, +Scott Presnell, +Heiko Purnhagen, +Chuck Robey +and +Jay Summet + + + + + +Documentation copyright 2000,2001 Adriaan de Groot groot@kde.org. +Documentation copyright 2004,2005 Carlos Leonhard Woelz +carloswoelz@imap-mail.com + + + +&underFDL; +&underGPL; + + +&documentation.index; + + + diff --git a/doc/kpilot/main-app.png b/doc/kpilot/main-app.png new file mode 100644 index 0000000..8eb613b Binary files /dev/null and b/doc/kpilot/main-app.png differ diff --git a/doc/kpilot/memo-app.png b/doc/kpilot/memo-app.png new file mode 100644 index 0000000..8c0b4a6 Binary files /dev/null and b/doc/kpilot/memo-app.png differ diff --git a/doc/kpilot/setup-address.png b/doc/kpilot/setup-address.png new file mode 100644 index 0000000..958225c Binary files /dev/null and b/doc/kpilot/setup-address.png differ diff --git a/doc/kpilot/setup-conduit.png b/doc/kpilot/setup-conduit.png new file mode 100644 index 0000000..3c4fed2 Binary files /dev/null and b/doc/kpilot/setup-conduit.png differ diff --git a/doc/kpilot/setup-dbspecial.png b/doc/kpilot/setup-dbspecial.png new file mode 100644 index 0000000..9ea5a6a Binary files /dev/null and b/doc/kpilot/setup-dbspecial.png differ diff --git a/doc/kpilot/setup-general.png b/doc/kpilot/setup-general.png new file mode 100644 index 0000000..e79d71e Binary files /dev/null and b/doc/kpilot/setup-general.png differ diff --git a/doc/kpilot/setup-hotsync.png b/doc/kpilot/setup-hotsync.png new file mode 100644 index 0000000..75b5358 Binary files /dev/null and b/doc/kpilot/setup-hotsync.png differ diff --git a/doc/kpilot/setup-items.png b/doc/kpilot/setup-items.png new file mode 100644 index 0000000..f730a9c Binary files /dev/null and b/doc/kpilot/setup-items.png differ diff --git a/doc/kpilot/setup-startup-exit.png b/doc/kpilot/setup-startup-exit.png new file mode 100644 index 0000000..0d8b8a7 Binary files /dev/null and b/doc/kpilot/setup-startup-exit.png differ diff --git a/doc/kpilot/setup-tabs.png b/doc/kpilot/setup-tabs.png new file mode 100644 index 0000000..87e6ef2 Binary files /dev/null and b/doc/kpilot/setup-tabs.png differ diff --git a/doc/kpilot/setup-viewer.png b/doc/kpilot/setup-viewer.png new file mode 100644 index 0000000..96bee4a Binary files /dev/null and b/doc/kpilot/setup-viewer.png differ diff --git a/doc/kpilot/sidebar.png b/doc/kpilot/sidebar.png new file mode 100644 index 0000000..6c178ed Binary files /dev/null and b/doc/kpilot/sidebar.png differ diff --git a/doc/kpilot/sync.docbook b/doc/kpilot/sync.docbook new file mode 100644 index 0000000..4df681a --- /dev/null +++ b/doc/kpilot/sync.docbook @@ -0,0 +1,450 @@ + +Syncing your &handheld; with a PC + + +This chapter describes the synchronization process +that &kpilot; uses, focusing on the &kpilot; daemon functionality. +You may sync your &handheld; using the internal +viewers and / or conduits, depending +on your personal preferences. Conduits allow external applications to interface +with the data on your &handheld;. + + + +It is a good idea to make a backup +of your &handheld; regularly. Other than making backups, it should rarely be +necessary to do anything other than drop your &handheld; on the cradle and press +the &HotSync; button. The &kpilot; daemon icon in the system tray will flash +indicating that a sync is under way. + + + + +&kpilot; Daemon Pop-Up Menu + + +&kpilot; daemon popup menu +&kpilot; daemon popup menu + + + + + +To which type of sync &kpilot; will perform next, you can use the main +application + + +File + +menu, +or right click the &kpilot; daemon icon located in the system tray, +and select one of the menu items under the + +Next Sync + +sub menu. + +If you hover over the &kpilot; daemon icon, a tooltip will appear showing you +what the type of sync &kpilot; will perform next. + + + + + + + +In short, the sync types are: + + + + + +HotSync (once): this option offers +a nice balance between speed and data safety. + + + +FastSync (once): only sync those +databases that have conduits. + + + +FullSync (once): the safest option, but +takes the longest time to complete. + + + +Backup (once): copy all the data from the &handheld; to the +PC. + + + +Restore from Backup (once): copy the data from a previous backup from the PC to the +&handheld;, erasing the data previously held there. + + +Use the restore functionality with care, as you can lose all the new +data entered on the &handheld; since the last backup. + + + + + + +Copy Handheld to PC (once): run all conduits and +sync all databases, but instead of merging the information from both sources, +just copy the handheld data to the PC. +Use with care, as this option erases the changes +you made in your PC since the last sync. + + + + + +Copy PC to Handheld (once): run all conduits and +sync all databases, but instead of merging the information from both sources, +just copy the PC data to the handheld. +Use with care, as this option erases the changes +you made in your handheld since the last sync. + + + + + + + +Alternatively, you can change the default syncing behavior of &kpilot; by +choosing the most suitable option in the &HotSync; +configure dialog. + + +To configure the conduits or the sync process, you do not need to open the main +&kpilot; application, as the + +Configure KPilot... + +menu item is available on the &kpilot; daemon popup menu as well. + + + + + +Backing up your &handheld; data + + +On every backup, &kpilot; stores a copy of all your &handheld; data under the +$TDEHOME/share/apps/kpilot/DBBackup/User Name/ +folder, allowing you to restore that copy later, if needed. The +$TDEHOME environment variable +(typically /home/Login Name/.trinity/) +points to the folder that contains your configuration and data for the &kde; +applications. + + +It is a good idea to backup your data often. To perform a backup, you can click +the + +Next Sync +Backup + +on the &kpilot; daemon icon popup menu or the + +File +Backup + +menu item on the main &kpilot; application menu in order +to make the next sync a backup. Then, just press the &HotSync; button. + + + + + +Restoring Your &handheld; Data + + +The restore operation consist of transferring all the data previously saved on +the PC to the &handheld;, effectively erasing all the new +data held by the device by returning it to a previous state. + +Use the restore functionality with care, as you can lose all the new +data entered on the &handheld; since the last backup. + + + + +The data saved on the last backup is located on the $TDEHOME/share/apps/kpilot/DBBackup/User Name/ +folder. The $TDEHOME environment variable +(typically /home/Login Name/.trinity/) +points to the folder that contains your configuration and data for the &kde; +applications. + + +The most common use for the restore functionality is to recover from a hardware +or software failure on the device. +The restore function can be accessed from the +main &kpilot; application, and from the &kpilot; daemon. be careful, as +restoring the data is not a common operation. In order +to restore the data at the next sync, click the + +File +Restore + +menu item, then press the &HotSync; button. + + + + + + +Selecting the Synchronization Type + + +There are three ways to sync your &handheld;, HotSync, +FastSync or FullSync. + + + +When you press the &HotSync; button on your &handheld;, &kpilot;'s will run the +default sync operation (usually a HotSync). You can select +the default sync operation in the &HotSync; +configure dialog. Alternatively, you can click one of the sync options on +the main &kpilot; application + +File + +menu or on the &kpilot; daemon popup + +Next Sync + +submenu. + + +Using the &HotSync; configure dialog +is the only way to change the default sync operation. +The main &kpilot; application + +File + +menu items or the &kpilot; daemon popup + +Next Sync + +submenu items change only the type of sync that will be performed next. + + + + +&kpilot; Daemon Pop-Up Menu + + +&kpilot; daemon popup menu +&kpilot; daemon popup menu + + + + + +For more information on the sync types, please refer to the descriptions +available in . + + + + + + +Syncing your &handheld; Data Using Conduits + + +Conduits are programs that interface your &handheld; data with +PC applications or sync your &handheld; data with files +that can be used by PC applications. + + + +Conduits can be set up by selecting + +Settings +Configure KPilot... +, or using the daemon pop up menu and clicking the +Configure KPilot... +menu item. + + + +&kpilot; Daemon Pop-Up Menu + + +&kpilot; daemon popup menu +&kpilot; daemon popup menu + + + + +The Conduits tree in the configuration dialog +collects all the installed conduits available. +The conduits can be enabled and disabled +by clicking on the check box to the left of the conduit's name. +Conduits can have an extensive configuration of +their own, and may be supplied by third parties. +Most of the conduits require some initial configuration, so it is strongly +recommended to check the +section detailing the default conduits +configuration before using them. + + + + +The default conduits are the following: + + + + + + +KNotes / Memos + +Synchronizes the Memo Pad application with &knotes;. + + +The conduit only synchronizes the Memo Pad data if &knotes; is running. If you +want to enable this functionality, please remember to start &knotes; first, or +check if it is already running (tip: look for the &knotes; icon in the system tray). + + + + + + + +Notepad + + +Exports the free hand notes of the &handheld;'s Notepad application as pictures +to the PC. + + + + + + +Time Synchronization + +Sets the &handheld;'s time to that of the desktop machine. +Useful for keeping the clock of the &handheld; accurate. + + + + +Calendar (KOrganizer) + +Synchronizes the Datebook application with &korganizer; or with a iCalendar file of +your choice. + + + + +Palm DOC + +Automatically converts, installs and sync text files in the &PalmPilot; +DOC format, so you can read the text files with most DOC-capable +applications on the &handheld;. There are many free or open source Palm +DOC readers, and some Palm DOC editors for your handheld. + +Any plain text file can be easily converted. For instance, you can download and +convert the public domain books provided by the +Gutenberg Project and read them in your &handheld;. + + + + +Addressbook + +Synchronizes the Address application with &kaddressbook; or with a vCard file of +your choice. + + + + +System Information + +Writes information about your &handheld;, (such as OS version, +RAM available, and the list of databases) to a file. Useful mostly for +debugging purposes. + + + + +ToDo's (KOrganizer) + +Synchronizes the Todo list application with &korganizer; or with a iCalendar file of +your choice. + + + + +MAL (AvantGo) Conduit + +Synchronizes your &handheld; with the &AvantGo; server. The &AvantGo; server +offers general content (news, guides, stock quotes, &etc;) in a format that is +suitable for reading in a &handheld;. To use this conduit, you need to register, subscribe +the channels you select and install the &AvantGo; software on your &handheld;. + + + + + +Mail + +Sends mail written on the &handheld; through &kmail;. +There is no provision for receiving mail, however. + + + + +Perl +Python +NULL + +These conduits are intended as a programming demonstration, +and serve no practical purpose during a &HotSync;. +They are not normally listed, but you may see them on some systems. + + + + + + +The Conduit Setup Dialog + + +The Conduit Setup Dialog +The Conduit Setup Dialog + + + + + + + +Resolving Conflicts + + +Data records can be changed both on the &handheld; and +on the PC. If one record has incompatible changes +in both the &handheld; and the PC, (such as +changing a phone number in different ways on both sides), +the conflicting change needs to be resolved so +that both the &handheld; and the PC are in sync again. + + + +A popup dialog may appear, asking you how to resolve the +conflict, or you may have a general rule to automatically handle these +conflicts (depending on your conflict resolution +choice). Note that you can define different resolution choices +for different conduits in the conduits +configuration dialog. + + + + diff --git a/doc/kpilot/todo-app.png b/doc/kpilot/todo-app.png new file mode 100644 index 0000000..7b54185 Binary files /dev/null and b/doc/kpilot/todo-app.png differ diff --git a/doc/kpilot/toolbar_backup.png b/doc/kpilot/toolbar_backup.png new file mode 100644 index 0000000..d1ab921 Binary files /dev/null and b/doc/kpilot/toolbar_backup.png differ diff --git a/doc/kpilot/toolbar_hotsync.png b/doc/kpilot/toolbar_hotsync.png new file mode 100644 index 0000000..11eceb4 Binary files /dev/null and b/doc/kpilot/toolbar_hotsync.png differ diff --git a/doc/kpilot/usage.docbook b/doc/kpilot/usage.docbook new file mode 100644 index 0000000..803da4b --- /dev/null +++ b/doc/kpilot/usage.docbook @@ -0,0 +1,648 @@ + +Using &kpilot; Data Viewers and Main Window Interface + + +This chapter describes the usage of &kpilot;'s main window; as a viewer +application for data on the &handheld;, and its menu structure. +The main window of &kpilot; also contains +the &HotSync;-log, which can be useful when +debugging problems. + + + +&kpilot; starts up with a splash screen, and then switches to showing the +&HotSync;-log, as shown here. + + + +The Main Window + + +&kpilot; Main Window + + +The Main Window +The Main Window + + + + +The main window contains the application menu, which we will deal with here. + + + +The file menu contains the synchronization menu items. Note +that these items do not start the sync process, they only select what the new +sync will be. To really start it, you must press the HotSync button on your +&PalmPilot;'s cradle (or on the &handheld; itself, when there is no cradle). + + + +It is not possible to cancel a sync operation once the request has been made. + + + +For more information regarding the synchronization functionality, please check the +Synchronization Chapter of this handbook, +where you can find detailed descriptions of the synchronization methods +and options offered by &kpilot;. + + + + + + + +File +HotSync + + + + +Make the next sync a &HotSync;. For more information, please check the + Syncing your &handheld; data section of this +handbook. + + + + + + + +File +FastSync + + + + +(not available with all installations) +Make the next sync a FastSync. For more information, please check the +Syncing your &handheld; data section of this +handbook. + + + + + + + +File +FullSync + + + + +(not available with all installations) +Make the next sync a FullSync. For more information, please check the + Syncing your &handheld; data section of this +handbook. + + + + + + + +File +Backup + + + + +Make the next sync a full backup of your &PalmPilot; data. This action can take +several minutes. For more information, please check the + Backing up your &handheld; data section of this +handbook. + + + +The first thing you should do after starting &kpilot; for +the first time is make a full backup. + + + + + + + + +File +Restore + + + + +This copies all the data from a previous backup on your +PC to your &PalmPilot;, +replacing whatever data was there. +Use this if your &PalmPilot; suffers some from software or hardware failure +(or is replaced by a new one). For more information, please check the + Restoring your &handheld; data section of this +handbook. + + + +Doing a restore will erase all data on the &PalmPilot; +before restoring the information from your +PC! + + + + + + + + +File +Copy Handheld to PC + + + + +This runs all conduits and syncs all databases, but instead of merging the +information from both sources, it will copy the handheld data to the PC. +Use with care, as this option erases the changes +you made in your PC since the last sync. + + + + + + +File +Copy PC to Handheld + + + + +This runs all conduits and syncs all databases, but instead of merging the +information from both sources, it will copy the PC data to the handheld. +Use with care, as this option erases the changes +you made in your handheld since the last sync. + + + + + + + + + +File +Quit + + + + +Quits &kpilot;, closing the main window and stopping the +daemon if that +configuration option +is enabled. + + + + + + + +The Settings menu allows you to configure &kpilot; main +interface and fine-tune the synchronization process with the &handheld;. + + + + + + +Settings +Show Statusbar + + + + +Click this menu item to toggle &kpilot;'s status bar on and off, or in other +words, to show it if hidden, or to hide it if shown. + + + + + + + +Settings +Show Toolbar + + + + +Click this menu item to toggle &kpilot;'s toolbar on and off, or in other +words, to show it if hidden, or to hide it if shown. + + + + + + + + +Settings +Configure Shortcuts... + + + + +Displays &kpilot;'s shortcut configuration dialog, allowing you change or create +key bindings, which are associations between actions (for example, opening +&kpilot;'s configuration dialog) and keys or key combinations (for instance, +Ctrl + Shift + a). + + + + + + + + +Settings +Configure Toolbars... + + + + +Displays &kpilot;'s toolbar configuration dialog. This dialog lists all actions +available for use on the toolbar, and the actions currently displayed, allowing +you to add or remove actions, and move the actions which already are on the +toolbar. + + + + + + + + +Settings +Configure KPilot... + + + + +Displays &kpilot;'s configuration dialog, allowing you to match your hardware +with the configuration, so that &kpilot; can talk with your &handheld;, to +configure the way &kpilot; synchronizes your &PalmPilot; with your +desktop applications (through conduits) and the way it shows the data from your &PalmPilot; in the +built-in viewers. The +Configuring &kpilot; chapter of this handbook offers detailed information +about these configuration options. + + + + + + + +Settings +Configuration Wizard... + + + + +Displays &kpilot;'s configuration wizard dialog. The +configuration wizard helps you to set up +&kpilot; to communicate with the &PalmPilot; and to configure the conduits as +a group. It's a great start for new users, and you can always fine-tune your +preferences later, using the configure +dialog. + + + + + + + + + + + + +Built-in Applications + + + +To select one of the Built in applications, just click its icon on &kpilot;'s +sidebar. + + + +KPilot's Sidebar + + +KPilot's Sidebar +KPilot's Sidebar + + + + + +Selecting one of the built-in applications +will cause that application to appear in &kpilot;'s main +window. +You may use the viewer applications to edit the information, by enabling +this option in the database viewer's +configuration dialog. The ability to view and edit private records is +configurable too. + + +Any changes you make to the &PalmPilot; databases with +the built-in applications (such as deleting a memo) +do not take effect on the &PalmPilot; until the next HotSync. + + + +If the Make internal viewers editable option is +not enabled, the changes in the viewers are not synchronized with your +&handheld;, and will be lost. In recent versions of &kpilot; it is not possible +enable this option, and therefore, to edit the databases with the viewers. + + + + +The Todo Viewer + + +The todo application allows you to view the tasks from your &PalmPilot;, +add new tasks and edit or delete existing ones. The changes you made +are applied to the &handheld; the next time you &HotSync;. + + + +Todo Viewer Application + + +The Todo Viewer Application +The Todo Viewer Application + + + + +The todo application has a drop down box +for the memo categories defined in the &PalmPilot;. +In the screenshot, category All is selected. +Underneath the drop down box is a list of todo entries, with a check box +indicating if they are completed or not. You can click the check box to toggle +the todo item between completed and not completed status. Clicking on one of the +todo items in the list will display its details in the text box labelled +Todo info: to the right. + + + +If you have the Make internal viewers editable option +enabled in the viewers configuration page you +can use the buttons Edit Record..., +New Record... and Delete Record +to edit the todo data from your &handheld;, and sync the data in the next +&HotSync;. + + + + +The Edit Record... button opens a dialog where you can +edit the details of the currently selected todo item, including description, +priority and end date. Click the New Record... button to +open the same dialog, but instead of editing the current selected record, a new +todo will be added to the list. And finally, click the +Delete Record button to remove the selected todo record +from the list. + + + + + +The Address Viewer + +The address viewer lets you view, create, delete and edit addresses +from the &PalmPilot;, and synchronize changes back. The addresses can be +sorted and viewed in the "Last, first" or "Company, +last" format, depending on your +viewers configuration. + + + +The Address Viewer Application + + +The Address Viewer Application +The Address Viewer Application + + + + + +The address application resembles the todo application; +the drop down box, buttons, list and text area function exactly +the same, allowing you to select, view and edit an address +as on the &PalmPilot;. + + + +The Edit Record... dialog allows you to edit the +Last Name, First Name, +Company, &etc; fields, just as if you where using your +&handheld;. Click the New Record... button to +open the same dialog, but instead of editing the current selected record, a new +address will be added to the list. Click the +Delete Record button to remove the selected address +from the list. + + + + + + + + + +The Memo Viewer + + +The memo application allows you to view the memos on your &PalmPilot;, +export them to text files, import new ones to be installed the next +time you &HotSync;, or edit existing ones. + + + +Memo Viewer Application + + +The Memo Viewer Application +The Memo Viewer Application + + + + +The memo application has a drop down box +for the memo categories defined in the &PalmPilot;. +Here category All is selected. +Underneath the drop down box is a list of memo titles. +These are the first lines of the memos, just like +in the &PalmPilot; memo application. +Clicking on one of the memo titles in the list +box will display it in the text box labelled +Memo Text: to the right. + + + +When a memo is selected, you can use the buttons +Export Memo... and +Delete Memo +to export the selected memo to a file +or to delete the selected memo. +Exporting a memo requires +you to give a filename; the memo +is written to that file. +Take care not to overwrite existing files with this action. +Deleting a memo does not affect the &PalmPilot; +until the next &HotSync;. + + + +The +Import Memo... +button allows you to read a text file and +add it — as a memo — to the &PalmPilot;. +Importing a memo does not take effect until +the next &HotSync;. + + + + + + + + + +The Generic DB Viewer + + +In short, databases are all files stored in your &handheld;. A database +can be either a record database, which stores dynamic information created by the +user (for instance, the addresses or the todo information), or a resource +database, which tend to be static (for instance the applications). + + + +The Generic DB Viewer is a tool to view and analyze databases stored on +your handheld, especially record databases. It helps a lot creating new conduits +and to debug existing ones. + + +While it is possible use the database viewer to edit, add and delete records, you +should really know what you are doing, otherwise you may damage your data. Use +the viewer applications or conduits to edit your &handheld; data instead, in a +normal usage scenario. + + + + + + + +The Generic DB Viewer + + +The Generic DB Viewer +The Generic DB Viewer + + + + + + + +The File Installer + +Just hit the +Add File... button to add a file to the +Files to Install: list. These files will +be installed on your &PalmPilot; during the next &HotSync; if +Sync Files +is checked in the conduits section of the +configuration dialog. +If you choose not to +install these files on the &PalmPilot;, just hit +Clear List +to remove any pending files. + + + +If you are using the &HotSync; Daemon you may drag and +drop files or &URL;s +onto the docked icon on the toolbar. The file installer application also +supports dragging and dropping into the Files to Install:area. +Provided Sync Files is checked in the +settings dialog they +will be installed the next time you HotSync. + + + +An internal copy of the +file is kept, so you can even drag and drop &URL;s from +&konqueror;! + + + + +The File Installer + + +The File Installer +The File Installer + + + + + + + + diff --git a/doc/kpilot/wizard-conduits.png b/doc/kpilot/wizard-conduits.png new file mode 100644 index 0000000..c0e248b Binary files /dev/null and b/doc/kpilot/wizard-conduits.png differ diff --git a/doc/kpilot/wizard-connection.png b/doc/kpilot/wizard-connection.png new file mode 100644 index 0000000..a72a6b5 Binary files /dev/null and b/doc/kpilot/wizard-connection.png differ diff --git a/doc/kpilot/wizard-general.png b/doc/kpilot/wizard-general.png new file mode 100644 index 0000000..2a2d3d9 Binary files /dev/null and b/doc/kpilot/wizard-general.png differ