From ff72e3482648af97539825489aa030ff36391813 Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Sun, 14 Dec 2014 17:57:13 -0300 Subject: [PATCH] Document XDG-Basedir compatibility. Document that it's possible to place the configuration file in and XDG-Basedir compliant location. --- README.rst | 4 +++- docs/tutorial.rst | 5 +++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 803716c..3d37709 100644 --- a/README.rst +++ b/README.rst @@ -21,7 +21,9 @@ Installation and usage ====================== If you already have it installed and want to quickly configure it, copy the -``example.cfg`` to ``~/.vdirsyncer/config`` and edit it. +``example.cfg`` to ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally +``~/.config/vdirsyncer/config``) +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 diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 584feb5..1011a23 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -34,8 +34,9 @@ Configuration planned. By default, *vdirsyncer* looks for its configuration file at -``~/.vdirsyncer/config``. You can use the ``VDIRSYNCER_CONFIG`` environment -variable to change this path. +``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally +``~/.config/vdirsyncer/config``) and ``~/.vdirsyncer/config``. You can use the +``VDIRSYNCER_CONFIG`` environment variable to change this path. The config file should start with a :ref:`general section `, where the only required parameter is ``status_path``. The following is a