-rw-r--r-- | bin/kdepim/SyncHowto.txt | 102 |
1 files changed, 28 insertions, 74 deletions
diff --git a/bin/kdepim/SyncHowto.txt b/bin/kdepim/SyncHowto.txt index b0473a1..a901616 100644 --- a/bin/kdepim/SyncHowto.txt +++ b/bin/kdepim/SyncHowto.txt | |||
@@ -1,90 +1,83 @@ | |||
1 | WARNING: | 1 | WARNING: |
2 | YOU MAY GET UNEXPECTED (I.E. WRONG) SYNCHRONIZATION RESULTS, | 2 | YOU MAY GET UNEXPECTED (I.E. WRONG) SYNCHRONIZATION RESULTS, IF YOU CHANGE AN EVENT ON THE FIRST DEVICE AND SYNC IMMEDIATELY FROM THE OTHER DEVICE WITH THIS DEVICE, IF THE CLOCKS OF THE TWO DEVICES HAVE TOO MUCH DIFFERENCE. |
3 | IF YOU CHANGE AN EVENT ON THE FIRST DEVICE AND SYNC IMMEDIATELY FROM | ||
4 | THE OTHER DEVICE WITH THIS DEVICE, IF THE CLOCKS OF THE TWO DEVICES | ||
5 | HAVE TOO MUCH DIFFERENCE. | ||
6 | 3 | ||
7 | In other words: Please make sure, that the clocks of the devices | 4 | In other words: Please make sure, that the clocks of the devices you want to sync have only a difference of some seconds! |
8 | you want to sync have only a difference of some seconds! | ||
9 | 5 | ||
10 | 6 | ||
11 | CONTENT: | 7 | CONTENT: |
12 | 8 | ||
13 | 0) How syncing works | 9 | 0) How syncing works |
14 | 1) Qick overview of settings | 10 | 1) Qick overview of settings |
15 | 2) Sync settings in sync dialog | 11 | 2) Sync settings in sync dialog |
16 | 3) Syncing background | 12 | 3) Syncing background |
17 | 4) Sync preferences | 13 | 4) Sync preferences |
18 | 5) How a filter works | 14 | 5) How a filter works |
19 | 6) Details about sync profile kinds | 15 | 6) Details about sync profile kinds |
20 | 16 | ||
21 | ************************************************************************* | 17 | ************************************************************************* |
22 | 0) How syncing works | 18 | 0) How syncing works |
23 | ************************************************************************* | 19 | ************************************************************************* |
24 | 20 | ||
25 | Note: | 21 | Note: |
26 | The recommended and easiest way to syncronize two devices where | 22 | The recommended and easiest way to syncronize two devices where KO/Pi, KA/Pi or PWM/Pi is installed, is the profile kind "Pi-Sync". |
27 | KO/Pi, KA/Pi or PWM/Pi is installed, is the profile kind "Pi-Sync". | ||
28 | Details about that in 6) b). | 23 | Details about that in 6) b). |
29 | 24 | ||
30 | In KDE-Pim/Pi you can synchronize ( sync ) your calendar/addressbook/ | 25 | In KDE-Pim/Pi you can synchronize ( sync ) your |
31 | passwordfile with another calendar/addressbook/passwordfile, | 26 | calendar/addressbook/passwordfile with another c |
32 | by syncing your (local) calendar/addressbook/passwordfile | 27 | alendar/addressbook/passwordfile, |
28 | by syncing your (local) | ||
29 | calendar/addressbook/passwordfile | ||
33 | with a (remote) file. | 30 | with a (remote) file. |
34 | This remote file may on your local filesystem | 31 | This remote file may on your local filesystem |
35 | or on another (remote) device. | 32 | or on another (remote) device. |
36 | 33 | ||
37 | If you want to sync with another remote device, you have to create | 34 | If you want to sync with another remote device, you have to create |
38 | a sync profile. | 35 | a sync profile. |
39 | You have two choices for choosing the profil kind: | 36 | You have two choices for choosing the profil kind: |
40 | I) You can choose profile kind "Remote file" and specify a | 37 | I) You can choose profile kind "Remote file" and specify a |
41 | command line download/upload command ( like scp, ftp, ...) to | 38 | command line download/upload command ( like scp, ftp, ...) to |
42 | a) download the remote file to your local machine to a temp file | 39 | a) download the remote file to your local machine to a temp file |
43 | b) sync with this temp file | 40 | b) sync with this temp file |
44 | c) upload the synced file to the remote device | 41 | c) upload the synced file to the remote device |
45 | II) If you want to sync with a device, where KO/Pi( or KA/Pi, PWM/Pi) is | 42 | II) If you want to sync with a device, where KO/Pi( or KA/Pi, PWM/Pi) is |
46 | installed, you can easily get the remote file via network | 43 | installed, you can easily get the remote file via network |
47 | with the build in file transfer feature: | 44 | with the build in file transfer feature: |
48 | Choose profile kind "Pi-Sync" and | 45 | Choose profile kind "Pi-Sync" and |
49 | a) Start KO/Pi,KA/Pi or PWM/Pi on remote device and | 46 | a) Start KO/Pi,KA/Pi or PWM/Pi on remote device and |
50 | enable "Pi-Sync" on remote device with password and port. | 47 | enable "Pi-Sync" on remote device with password and port. |
51 | b) Specify password, port and IP address in your profile. | 48 | b) Specify password, port and IP address in your profile. |
52 | 49 | ||
53 | 50 | ||
54 | You can sync with your mobile phone as well. | 51 | You can sync with your mobile phone as well. |
55 | Everything is explained in more details below. | 52 | Everything is explained in more details below. |
56 | 53 | ||
57 | NOTE: | 54 | NOTE: |
58 | If you do not use profile kind "Pi-Sync", | 55 | If you do not use profile kind "Pi-Sync", it is recommended to close a running KO/Pi (KA/Pi, PWM/Pi) on the remote device. |
59 | it is recommended to close | ||
60 | a running KO/Pi (KA/Pi, PWM/Pi) on the remote device. | ||
61 | (Note: KO/Pi(KA/Pi, PWM/Pi) running on Zaurus with | 56 | (Note: KO/Pi(KA/Pi, PWM/Pi) running on Zaurus with |
62 | FastLoad enabled will never be closed!) | 57 | FastLoad enabled will never be closed!) |
63 | After syncing with a running KO/Pi on the remote device, | 58 | After syncing with a running KO/Pi on the remote device, a "save" on the remote device will tell you that it needs to merge (sync). |
64 | a "save" on the remote device will tell you that it needs to merge (sync). | 59 | After merging (just a syncing with the changed file) you will get the new data showing in remote KO/Pi. |
65 | After merging (just a syncing with the changed file) | ||
66 | you will get the new data showing in remote KO/Pi. | ||
67 | 60 | ||
68 | ************************************************************************* | 61 | ************************************************************************* |
69 | 1) Qick overview of settings | 62 | 1) Qick overview of settings |
70 | ************************************************************************* | 63 | ************************************************************************* |
71 | 64 | ||
72 | a) Open sync settings dialog (Menu Synchronize - Configure...) | 65 | a) Open sync settings dialog (Menu Synchronize - Configure...) |
73 | b) Give your device a unique name. | 66 | b) Give your device a unique name. |
74 | (unique in the set of all devices you want to sync with). | 67 | (unique in the set of all devices you want to sync with). |
75 | If you have already configured another devive and created | 68 | If you have already configured another devive and created |
76 | there a sync profile to sync with this device, give your device | 69 | there a sync profile to sync with this device, give your device |
77 | the same name as this sync profile! The same name is important, | 70 | the same name as this sync profile! The same name is important, |
78 | because it makes it possible to sync first A->B | 71 | because it makes it possible to sync first A->B |
79 | (A local device, that performs the sync, B remote device) | 72 | (A local device, that performs the sync, B remote device) |
80 | and then B->A. Such that the B->A sync knows about the | 73 | and then B->A. Such that the B->A sync knows about the |
81 | already performed A->B sync. | 74 | already performed A->B sync. |
82 | That means: It is unimportant if you sync A->B or B->A, | 75 | That means: It is unimportant if you sync A->B or B->A, |
83 | the devices A and B will be synced properly. | 76 | the devices A and B will be synced properly. |
84 | c) Create a new sync profile and give it a unique name. | 77 | c) Create a new sync profile and give it a unique name. |
85 | (unique in the set of all sync profiles on this device). | 78 | (unique in the set of all sync profiles on this device). |
86 | If you want to sync with a device, where KO/Pi is already installed | 79 | If you want to sync with a device, where KO/Pi is already installed |
87 | and which has a given unique device name, use this device name as | 80 | and which has a given unique device name, use this device name as |
88 | your profile name ( refer to b) ). | 81 | your profile name ( refer to b) ). |
89 | d) Choose the profile kind of your syncing method: | 82 | d) Choose the profile kind of your syncing method: |
90 | (i) Local file or | 83 | (i) Local file or |
@@ -184,165 +177,126 @@ i) Apply filter when adding data to remote: | |||
184 | If there is an event in the local database which is not "public", but "private", | 177 | If there is an event in the local database which is not "public", but "private", |
185 | this event is not added to the remote database. | 178 | this event is not added to the remote database. |
186 | If there is an event in the local database and in the remote database which is | 179 | If there is an event in the local database and in the remote database which is |
187 | "private" (maybe added by someone else) then this event is synced and | 180 | "private" (maybe added by someone else) then this event is synced and |
188 | it is in the local database and in the remote database after syncing. | 181 | it is in the local database and in the remote database after syncing. |
189 | That means in particular you cannot remove an event from the remote | 182 | That means in particular you cannot remove an event from the remote |
190 | database but setting it to "private". | 183 | database but setting it to "private". |
191 | If you want to remove the event you can clone it, set it to private and delete the | 184 | If you want to remove the event you can clone it, set it to private and delete the |
192 | original event. Then the original event is deleted in the remote database after sync and | 185 | original event. Then the original event is deleted in the remote database after sync and |
193 | the cloned event is not added to the remote database, because it is private. | 186 | the cloned event is not added to the remote database, because it is private. |
194 | j) Write back (calendar) entries for time period only: | 187 | j) Write back (calendar) entries for time period only: |
195 | Check this to write back only calendar entries for a given time period. | 188 | Check this to write back only calendar entries for a given time period. |
196 | (Useful when syncing with mobile phones.) | 189 | (Useful when syncing with mobile phones.) |
197 | You can specify the date range in weeks for the weeks in the past to the weeks in the future. | 190 | You can specify the date range in weeks for the weeks in the past to the weeks in the future. |
198 | 191 | ||
199 | k) Profile kind: | 192 | k) Profile kind: |
200 | Details -> 6) | 193 | Details -> 6) |
201 | 194 | ||
202 | ************************************************************************* | 195 | ************************************************************************* |
203 | 3) Syncing background | 196 | 3) Syncing background |
204 | ************************************************************************* | 197 | ************************************************************************* |
205 | 198 | ||
206 | The same mentioned for calendars is valid for addressbooks as well. | 199 | The same mentioned for calendars is valid for addressbooks as well. |
207 | 200 | ||
208 | Synchronizing calendars ( i.e. files ) means, | 201 | Synchronizing calendars ( i.e. files ) means, to merge two calendars in a useful way. If the two calendars are completely different, there is no problem, the resulting calendar contains all data from the local and from the remote calendar. |
209 | to merge two calendars in a useful way. | 202 | |
210 | If the two calendars are completely different, | 203 | Problems will occur, if you have edited items from the local calendar on the remote machine. Then it could be, that items are in conflict. Two items are "in conflict", if they have the same unique ID (which get an item at time of creation and owns it until it is deleted ) and they both are modified after the last synchronization. |
211 | there is no problem, the resulting calendar contains | 204 | |
212 | all data from the local and from the remote calendar. | 205 | At first sync of two calendars there is no item deleted. If the calendars are synced before and there is an item, which is not edited after the last sync and is only available in one calendar, then this item is deleted in this calendar. |
213 | |||
214 | Problems will occur, if you have edited items | ||
215 | from the local calendar on the remote machine. | ||
216 | Then it could be, that items are in conflict. | ||
217 | Two items are "in conflict", if they have the | ||
218 | same unique ID (which get an item at time of | ||
219 | creation and owns it until it is deleted ) | ||
220 | and they both are modified after the last | ||
221 | synchronization. | ||
222 | |||
223 | At first sync of two calendars there is no item deleted. | ||
224 | If the calendars are synced before and there is an item, | ||
225 | which is not edited after the last sync and is only | ||
226 | available in one calendar, then this item is deleted | ||
227 | in this calendar. | ||
228 | 206 | ||
229 | But when was the last synchronization between two calendars? | 207 | But when was the last synchronization between two calendars? |
230 | 208 | ||
231 | To know that, KO/Pi creates at first syncing | 209 | To know that, KO/Pi creates at first syncing of two files an unique event "<profile name> - sync Event" on the remote and the local calendar. After syncing, the start time of this event is set to the time of syncing. The event is read only and the user may not change it. |
232 | of two files an unique event "<profile name> - sync Event" | ||
233 | on the remote and the local calendar. | ||
234 | After syncing, the start time of this event is set | ||
235 | to the time of syncing. | ||
236 | The event is read only and the user may not change it. | ||
237 | 210 | ||
238 | If two such files are synced, that both have an event | 211 | If two such files are synced, that both have an event "<profile name> - sync Event" and the events have the same start time, then deleted items on the one calendar are deleted on the other as well. |
239 | "<profile name> - sync Event" and the events have | ||
240 | the same start time, then deleted items on the one calendar | ||
241 | are deleted on the other as well. | ||
242 | 212 | ||
243 | 213 | ||
244 | ************************************************************************* | 214 | ************************************************************************* |
245 | 4) Sync preferences | 215 | 4) Sync preferences |
246 | ************************************************************************* | 216 | ************************************************************************* |
247 | 217 | ||
248 | Two items are "in conflict", if they have the same unique ID | 218 | Two items are "in conflict", if they have the same unique ID and they both are modified after the last synchronization. |
249 | and they both are modified after the last synchronization. | ||
250 | (Details -> 3) ). | 219 | (Details -> 3) ). |
251 | 220 | ||
252 | If an item is not modified after the last sync and | 221 | If an item is not modified after the last sync and it is not found in the other calendar, it is deleted. |
253 | it is not found in the other calendar, it is deleted. | ||
254 | 222 | ||
255 | On the first sync, there is no item deleted. | 223 | On the first sync, there is no item deleted. |
256 | 224 | ||
257 | SYNC PREFERENCES: | 225 | SYNC PREFERENCES: |
258 | -Take local entry on conflict: | 226 | -Take local entry on conflict: |
259 | Takes the local entry on conflict. | 227 | Takes the local entry on conflict. |
260 | If it is the first sync, | 228 | If it is the first sync, |
261 | "Ask for every entry" | 229 | "Ask for every entry" |
262 | is chosen automatically, | 230 | is chosen automatically, |
263 | if this is selected. | 231 | if this is selected. |
264 | 232 | ||
265 | -Take remote entry on conflict: | 233 | -Take remote entry on conflict: |
266 | Takes the remote entry on conflict. | 234 | Takes the remote entry on conflict. |
267 | If it is the first sync, | 235 | If it is the first sync, |
268 | "Ask for every entry" | 236 | "Ask for every entry" |
269 | is chosen automatically, | 237 | is chosen automatically, |
270 | if this is selected. | 238 | if this is selected. |
271 | 239 | ||
272 | -Take newest entry on conflict: | 240 | -Take newest entry on conflict: |
273 | This takes the newest entry on conflict. | 241 | This takes the newest entry on conflict. |
274 | May be the most useful syncing mode. | 242 | May be the most useful syncing mode. |
275 | 243 | ||
276 | -Ask for every entry on conflict: | 244 | -Ask for every entry on conflict: |
277 | Pops up an event viewer dialog and | 245 | Pops up an event viewer dialog and |
278 | shows the two conflicting entries there. | 246 | shows the two conflicting entries there. |
279 | The user can chose, which entry he would like to take. | 247 | The user can chose, which entry he would like to take. |
280 | The button for the newest entry | 248 | The button for the newest entry |
281 | is automatically set as default button. | 249 | is automatically set as default button. |
282 | The color for the newest entry is green. | 250 | The color for the newest entry is green. |
283 | 251 | ||
284 | -Force: Take local entry always: | 252 | -Force: Take local entry always: |
285 | Even if the calendars are already synced | 253 | Even if the calendars are already synced |
286 | there is no item deleted on local. | 254 | there is no item deleted on local. |
287 | 255 | ||
288 | -Force: Take remote entry always: | 256 | -Force: Take remote entry always: |
289 | Analogous to | 257 | Analogous to |
290 | "Force: Take local entry always" | 258 | "Force: Take local entry always" |
291 | 259 | ||
292 | ************************************************************************* | 260 | ************************************************************************* |
293 | 5) How a filter works | 261 | 5) How a filter works |
294 | ************************************************************************* | 262 | ************************************************************************* |
295 | 263 | ||
296 | A filter is a rule to decide if a particular item | 264 | A filter is a rule to decide if a particular item (calendar iten item or contact item) belongs to a set of items. |
297 | (calendar iten item or contact item) belongs to a set of items. | ||
298 | For example, you can specify a set as: | 265 | For example, you can specify a set as: |
299 | Only items, that belongs to that category. | 266 | Only items, that belongs to that category. |
300 | Or: Only items, that does not belong to that category. | 267 | Or: Only items, that does not belong to that category. |
301 | Or: Only items, that are public. | 268 | Or: Only items, that are public. |
302 | 269 | ||
303 | If you specify a filter in a syncing profile, you can set the | 270 | If you specify a filter in a syncing profile, you can set the rules of adding items to the local or remote database. |
304 | rules of adding items to the local or remote database. | ||
305 | 271 | ||
306 | Example: | 272 | Example: |
307 | You have a public calendar in your company, which contains all | 273 | You have a public calendar in your company, which contains all company relevant data. |
308 | company relevant data. | 274 | |
309 | 275 | You have different projects in the company and for project specific events is always set the project name as a category: | |
310 | You have different projects in the company and for project specific events | 276 | E.g. all events of the project PRO_ABC do have set the categorie PRO_ABC. But you are not interested in events of PRO_ABC, because you are not working on it. Then you can specify a filter: All, but not with categoroy PRO_ABC. When you specify this filter as an incoming filter for your sync profile, all events of the company are synced and added to your local calendar, but not the evenst of the project PRO_ABC. |
311 | is always set the project name as a category: | 277 | |
312 | E.g. all events of the project PRO_ABC do have set the categorie PRO_ABC. | 278 | You do not want that your private data can be seen in the public calendar of your company. Well, set the property to "private" for all your private data and specify an outgoing filter: Only " public" and "confidential". Then you can sync your personal calendar with the calendar of the company, but your private data is not added to the public calendar. |
313 | But you are not interested in events of PRO_ABC, because you are not working on it. | ||
314 | Then you can specify a filter: All, but not with categoroy PRO_ABC. | ||
315 | When you specify this filter as an incoming filter for your sync profile, | ||
316 | all events of the company are synced and added to your local calendar, but not | ||
317 | the evenst of the project PRO_ABC. | ||
318 | |||
319 | You do not want that your private data can be seen | ||
320 | in the public calendar of your company. | ||
321 | Well, set the property to "private" for all your private data | ||
322 | and specify an outgoing filter: Only " public" and "confidential". | ||
323 | Then you can sync your personal calendar with the calendar of the company, | ||
324 | but your private data is not added to the public calendar. | ||
325 | 279 | ||
326 | ************************************************************************* | 280 | ************************************************************************* |
327 | 6) Details about sync profile kinds | 281 | 6) Details about sync profile kinds |
328 | ************************************************************************* | 282 | ************************************************************************* |
329 | 283 | ||
330 | a) Local file | 284 | a) Local file |
331 | Please specify a local file you want to sync with. | 285 | Please specify a local file you want to sync with. |
332 | Note: If you are syncing a file, which is used by KA/Pi, please check the | 286 | Note: If you are syncing a file, which is used by KA/Pi, please check the |
333 | "Addressbook file (*.vcf) is used by KA/Pi". | 287 | "Addressbook file (*.vcf) is used by KA/Pi". |
334 | If you are syncing with a file from KAddressbook or another program, | 288 | If you are syncing with a file from KAddressbook or another program, |
335 | please uncheck "Addressbook file (*.vcf) is used by KA/Pi". | 289 | please uncheck "Addressbook file (*.vcf) is used by KA/Pi". |
336 | To set this properly is important! KA/Pi uses a "last modified" property, | 290 | To set this properly is important! KA/Pi uses a "last modified" property, |
337 | which is not supported by KAddressbook. | 291 | which is not supported by KAddressbook. |
338 | 292 | ||
339 | b) Pi-Sync (direct Kx/Pi to Kx/Pi sync) | 293 | b) Pi-Sync (direct Kx/Pi to Kx/Pi sync) |
340 | We mention here only KO/Pi, but the same is valid for KA/Pi. | 294 | We mention here only KO/Pi, but the same is valid for KA/Pi. |
341 | If you want to sync with a device, where KO/Pi is | 295 | If you want to sync with a device, where KO/Pi is |
342 | installed, you can easily get the remote file via network | 296 | installed, you can easily get the remote file via network |
343 | with the build in file transfer feature "Pi-Sync": | 297 | with the build in file transfer feature "Pi-Sync": |
344 | You have first to enable file transfer on the remote device: | 298 | You have first to enable file transfer on the remote device: |
345 | - Start KO/Pi on the remote device. | 299 | - Start KO/Pi on the remote device. |
346 | - Choose Menu Synchronize-Enable Pi-Sync. | 300 | - Choose Menu Synchronize-Enable Pi-Sync. |
347 | - Choose a port number, where KO/Pi should listen for | 301 | - Choose a port number, where KO/Pi should listen for |
348 | file sending requests. Valid port numbers are numbers | 302 | file sending requests. Valid port numbers are numbers |