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

Update doc as per latest feedback.

Browse source
This commit is contained in:
Hugo Osvaldo Barrera 2014-12-15 15:51:35 -03:00
parent ff72e34826
commit 41a92528ca
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.rst
View file

@ -21,14 +21,14 @@ Installation and usage
====================== ======================
If you already have it installed and want to quickly configure it, copy the If you already have it installed and want to quickly configure it, copy the
``example.cfg`` to ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally ``example.cfg`` to ``~/.vdirsyncer/config`` [1]_ and edit it.
``~/.config/vdirsyncer/config``)
and edit it.
If that method doesn't work for you or you want a deeper understanding of what If that method doesn't work for you or you want a deeper understanding of what
you just did, check out `the tutorial you just did, check out `the tutorial
<https://vdirsyncer.readthedocs.org/en/latest/tutorial.html>`_. <https://vdirsyncer.readthedocs.org/en/latest/tutorial.html>`_.
.. [1] The configuration file can also be placed in ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally ``~/.config/vdirsyncer/config``) for XDG-Basedir spec compliance.
Donations Donations
========= =========

12
docs/tutorial.rst
View file

@ -33,10 +33,14 @@ Configuration
- Take a look at the :doc:`problems` page if anything doesn't work like - Take a look at the :doc:`problems` page if anything doesn't work like
planned. planned.
By default, *vdirsyncer* looks for its configuration file at By default, *vdirsyncer* looks for its configuration file in the following
``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally locations:
``~/.config/vdirsyncer/config``) and ``~/.vdirsyncer/config``. You can use the
``VDIRSYNCER_CONFIG`` environment variable to change this path. - The file pointed to by the ``VDIRSYNCER_CONFIG`` environment variable.
- ``~/.vdirsyncer/config``.
- ``$XDG_CONFIG_HOME/vdirsyncer/config``, which is normally
``~/.config/vdirsyncer/config``. This is XDG-Basedir compliant, and should
help keep your ``$HOME`` clean.
The config file should start with a :ref:`general section <general_config>`, The config file should start with a :ref:`general section <general_config>`,
where the only required parameter is ``status_path``. The following is a where the only required parameter is ``status_path``. The following is a