diff --git a/README.rst b/README.rst index cbc99a0..fd2fabd 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. -.. [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. diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 2efaf31..c4ec51b 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -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 `, where the only required parameter is ``status_path``. The following is a minimal example::