mirror of
https://github.com/samsonjs/vdirsyncer.git
synced 2026-03-25 08:55:50 +00:00
Update doc as per latest feedback.
This commit is contained in:
parent
ff72e34826
commit
41a92528ca
2 changed files with 11 additions and 7 deletions
|
|
@ -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
|
||||
<https://vdirsyncer.readthedocs.org/en/latest/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
|
||||
=========
|
||||
|
||||
|
|
|
|||
|
|
@ -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 <general_config>`,
|
||||
where the only required parameter is ``status_path``. The following is a
|
||||
|
|
|
|||
Loading…
Reference in a new issue