erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc (config): fixed documentation about configuration file possible paths + minor corrections.

Browse source
This commit is contained in:
Goffi 2020-04-14 20:26:47 +02:00
commit 4bb69e971d
2 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/configuration.rst
View file

@ -8,12 +8,12 @@ Salut à Toi main configuration is set in a file named ``sat.conf`` (which may b
by a ``.`` if you want to hide it on suitable platforms). It is a common file used both by
backend and all frontends (and even related project like SàT Pubsub).
This file can located in the following paths (in order of parsing):
This file can be located in the following paths (in order of parsing):
- ``/etc``
- ``~`` (``$HOME`` or your home directory)
- the directory where you are launching the backend or frontend from
- XDG directory for configuration (most of time it is
``~/.config/sat/sat.conf``)
``~/.config/sat/``)
- the parent directory of SàT installation path
If several configurations files are found, they are merged. In case of conflict, the
option parsed last is the one used (in other words: if you have an option set in
@ -23,8 +23,8 @@ will be used because it is parsed after ``/etc``).
Format
======
``sat.conf`` is a using the `INI`_ file format as understood by Python's
`SafeConfigParser`_ (meaning that you can use interpolation).
``sat.conf`` is using the `INI`_ file format as understood by Python's `SafeConfigParser`_
(meaning that you can use interpolation).
The ``DEFAULT`` section is used for global options, this is where you specify where are
your media.

8
doc/overview.rst
View file

@ -44,10 +44,10 @@ default, on suitable platforms, to the corresponding `XDG directory`_, which is
time ``~/.local/share/sat``. In this directory, you'll find the main database in the
``sat.db`` file, which is a `SQLite`_ database.
The backend is run and stopped with the ``sat`` binary. Running it without argument launch
the backend in the background, with ``sat fg`` you run it in the foreground (you'll see
log directly and can stop the backend with ``Ctrl + c``). The ``sat status`` commands help
you discover if the backend is running or stopped.
The backend is run and stopped with the ``sat`` executable. Running it without argument
launch the backend in the background, with ``sat fg`` you run it in the foreground (you'll
see log directly and can stop the backend with ``Ctrl + c``). The ``sat status`` commands
help you discover if the backend is running or stopped.
.. _XDG directory: https://www.freedesktop.org/wiki/Software/xdg-user-dirs/
.. _SQLite: https://sqlite.org