sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-03-25 08:55:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clean up XDG-basedir refs

Browse source
This commit is contained in:
Markus Unterwaditzer 2015-01-19 21:44:52 +01:00
parent 868a099310
commit 3b04762653
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.rst
View file

@ -27,8 +27,6 @@ If that method doesn't work for you or you want a deeper understanding of what
you just did, check out `the tutorial
<https://vdirsyncer.readthedocs.org/en/stable/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
=========
@ -37,3 +35,6 @@ Donations
.. image:: https://api.flattr.com/button/flattr-badge-large.png
:target: https://flattr.com/submit/auto?user_id=untitaker&url=https%3A%2F%2Fgithub.com%2Funtitaker%2Fvdirsyncer
.. [1] Or ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally
``~/.config/vdirsyncer/config``) for XDG-Basedir spec compliance.

4
docs/tutorial.rst
View file

@ -39,9 +39,11 @@ locations:
- 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
``~/.config/vdirsyncer/config``. This is XDG-Basedir_ compliant, and should
help keep your ``$HOME`` clean.
.. _XDG-Basedir: http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html#variables
The config file should start with a :ref:`general section <general_config>`,
where the only required parameter is ``status_path``. The following is a
minimal example::