sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-04-27 14:57:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tutorial reformatting

Browse source
This commit is contained in:
Markus Unterwaditzer 2015-12-31 16:26:24 +01:00
parent 8b57abaf44
commit 99f5e51ab6
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/tutorial.rst
View file

@ -62,13 +62,11 @@ might come.
In vdirsyncer, synchronization is always done between two storages. Such In vdirsyncer, synchronization is always done between two storages. Such
storages are defined in :ref:`storage sections <storage_config>`, and which storages are defined in :ref:`storage sections <storage_config>`, and which
pairs of storages should actually be synchronized is defined in :ref:`pair pairs of storages should actually be synchronized is defined in :ref:`pair
section <pair_config>`. section <pair_config>`. This format is copied from OfflineIMAP, where storages
are called repositories and pairs are called accounts.
This format is copied from OfflineIMAP, where storages are called The following example synchronizes ownCloud's
repositories and pairs are called accounts. default addressbook to ``~/.contacts/``::
The following example synchronizes a single CardDAV-addressbook to
``~/.contacts/``::
[pair my_contacts] [pair my_contacts]
a = my_contacts_local a = my_contacts_local
@ -85,6 +83,10 @@ The following example synchronizes a single CardDAV-addressbook to
username = bob username = bob
password = asdf password = asdf
.. note::
Configuration for other servers can be found at :ref:`supported-servers`.
After running ``vdirsyncer sync``, ``~/.contacts/`` will contain a bunch of After running ``vdirsyncer sync``, ``~/.contacts/`` will contain a bunch of
``.vcf`` files which all contain a contact in ``VCARD`` format each. You can ``.vcf`` files which all contain a contact in ``VCARD`` format each. You can
modify their content, add new ones and delete some [1]_, and your changes will be modify their content, add new ones and delete some [1]_, and your changes will be
@ -102,10 +104,10 @@ More Configuration
Conflict resolution Conflict resolution
------------------- -------------------
It almost seems like it could work. But what if the same item is changed on What if the same item is changed on both sides? What should vdirsyncer do? By
both sides? What should vdirsyncer do? By default, it will show an ugly error default, it will show an ugly error message, which is surely a way to avoid the
message, which is surely a way to avoid the problem. Another way to solve that problem. Another way to solve that ambiguity is to add another line to the
ambiguity is to add another line to the *pair* section:: *pair* section::
[pair my_contacts] [pair my_contacts]
... ...