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

Add more stuff to the tutorial

Browse source 
Fix #136
This commit is contained in:
Markus Unterwaditzer 2014-11-20 18:02:12 +01:00
parent 4fd4e21cc6
commit 7d6c8b29ce
1 changed files with 17 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/tutorial.rst
View file

@ -19,9 +19,17 @@ Configuration
============= =============
.. note:: .. note::
The `example.cfg from the repository
<https://github.com/untitaker/vdirsyncer/blob/master/example.cfg>`_ - The `example.cfg from the repository
contains a very terse version of this. <https://github.com/untitaker/vdirsyncer/blob/master/example.cfg>`_
contains a very terse version of this.
- In this example we set up contacts synchronization, but calendar sync
works almost the same. Just swap ``type = carddav`` for ``type = caldav``
and ``fileext = .vcf`` for ``fileext = .ics``.
- Take a look at the :doc:`problems` page if anything doesn't work like
planned.
By default, *vdirsyncer* looks for its configuration file at By default, *vdirsyncer* looks for its configuration file at
``~/.vdirsyncer/config``. You can use the ``VDIRSYNCER_CONFIG`` environment ``~/.vdirsyncer/config``. You can use the ``VDIRSYNCER_CONFIG`` environment
@ -65,12 +73,17 @@ The following example synchronizes a single CardDAV-addressbook to
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, and your changes will be modify their content, add new ones and delete some [1]_, and your changes will be
synchronized to the CalDAV server after you run ``vdirsyncer sync`` again. For synchronized to the CalDAV server after you run ``vdirsyncer sync`` again. For
further reference, it uses the storages further reference, it uses the storages
:py:class:`vdirsyncer.storage.FilesystemStorage` and :py:class:`vdirsyncer.storage.FilesystemStorage` and
:py:class:`vdirsyncer.storage.CarddavStorage`. :py:class:`vdirsyncer.storage.CarddavStorage`.
.. [1] You'll want to :doc:`use a helper program for this <supported>`.
More Configuration
==================
But what if we want to synchronize multiple addressbooks from the same server? But what if we want to synchronize multiple addressbooks from the same server?
Of course we could create new pairs and storages for each addressbook, but that Of course we could create new pairs and storages for each addressbook, but that
is very tedious to do. Instead we will use a shortcut: is very tedious to do. Instead we will use a shortcut:
@ -105,6 +118,3 @@ Earlier we wrote that ``b = my_contacts_remote``, so when vdirsyncer encounters
the situation where an item changed on both sides, it will simply overwrite the the situation where an item changed on both sides, it will simply overwrite the
local item with the one from the server. Of course ``a wins`` is also a valid local item with the one from the server. Of course ``a wins`` is also a valid
value. value.
Calendar sync works almost the same. Just swap ``type = carddav`` for ``type =
caldav`` and ``fileext = .vcf`` for ``fileext = .ics``.