From 41a92528caab1f1a71c28e22c96c6f2f912a0f06 Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Mon, 15 Dec 2014 15:51:35 -0300 Subject: [PATCH] Update doc as per latest feedback. --- README.rst | 6 +++--- docs/tutorial.rst | 12 ++++++++---- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 3d37709..a28bf3d 100644 --- a/README.rst +++ b/README.rst @@ -21,14 +21,14 @@ Installation and usage ====================== If you already have it installed and want to quickly configure it, copy the -``example.cfg`` to ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally -``~/.config/vdirsyncer/config``) -and edit it. +``example.cfg`` to ``~/.vdirsyncer/config`` [1]_ and edit it. 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 ========= diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 1011a23..aae6a5f 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -33,10 +33,14 @@ Configuration - Take a look at the :doc:`problems` page if anything doesn't work like planned. -By default, *vdirsyncer* looks for its configuration file at -``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally -``~/.config/vdirsyncer/config``) and ``~/.vdirsyncer/config``. You can use the -``VDIRSYNCER_CONFIG`` environment variable to change this path. +By default, *vdirsyncer* looks for its configuration file in the following +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 + help keep your ``$HOME`` clean. The config file should start with a :ref:`general section `, where the only required parameter is ``status_path``. The following is a