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

Hopefully explain better what vdirs are

Browse source
This commit is contained in:
Markus Unterwaditzer 2015-06-14 14:28:24 +02:00
parent 11929d8b34
commit d9a888abda
3 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/vdir.rst
View file

@ -5,6 +5,11 @@ The Vdir Storage Format
This document describes a standard for storing calendars and contacts on a This document describes a standard for storing calendars and contacts on a
filesystem, with the main goal of being easy to implement. filesystem, with the main goal of being easy to implement.
Vdirsyncer synchronizes to vdirs via
:py:class:`vdirsyncer.storage.filesystem.FilesystemStorage`. Each vdir
(basically just a directory with some files in it) represents a calendar or
addressbook.
Basic Structure Basic Structure
=============== ===============

6
docs/when.rst
View file

@ -7,9 +7,9 @@ When do I need Vdirsyncer?
Why not Dropbox? (or anything like it) Why not Dropbox? (or anything like it)
====================================== ======================================
Since vdirs are just a bunch of files, it is obvious to try *file Since :doc:`vdirs <vdir>` are just a bunch of files, it is obvious to try
synchronization* for synchronizing your data between multiple computers, such *file synchronization* for synchronizing your data between multiple computers,
as: such as:
* `Syncthing <https://syncthing.net/>`_ * `Syncthing <https://syncthing.net/>`_
* `Dropbox <https://dropbox.com/>`_ or one of the gajillion services like it * `Dropbox <https://dropbox.com/>`_ or one of the gajillion services like it

5
vdirsyncer/storage/singlefile.py
View file

@ -37,8 +37,9 @@ class SingleFileStorage(Storage):
.. note:: .. note::
This storage is very slow, and that is unlikely to change. You should This storage is very slow, and that is unlikely to change. You should
consider using :py:class:`vdirsyncer.storage.FilesystemStorage` if it consider using
fits your usecase. :py:class:`vdirsyncer.storage.filesystem.FilesystemStorage` if it fits
your usecase.
:param path: The filepath to the file to be written to. :param path: The filepath to the file to be written to.
:param encoding: Which encoding the file should use. Defaults to UTF-8. :param encoding: Which encoding the file should use. Defaults to UTF-8.