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

Document XDG-Basedir compatibility.

Browse source 
Document that it's possible to place the configuration file in and XDG-Basedir
compliant location.
This commit is contained in:
Hugo Osvaldo Barrera 2014-12-14 17:57:13 -03:00
parent 4c7042da56
commit ff72e34826
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.rst
View file

@ -21,7 +21,9 @@ 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 ``~/.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 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

5
docs/tutorial.rst
View file

@ -34,8 +34,9 @@ Configuration
planned. planned.
By default, *vdirsyncer* looks for its configuration file at By default, *vdirsyncer* looks for its configuration file at
``~/.vdirsyncer/config``. You can use the ``VDIRSYNCER_CONFIG`` environment ``$XDG_CONFIG_HOME/vdirsyncer/config`` (normally
variable to change this path. ``~/.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 <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