diff --git a/docs/source/config.rst b/docs/source/config.rst index edebed0..6af9149 100644 --- a/docs/source/config.rst +++ b/docs/source/config.rst @@ -1,2 +1,68 @@ Config ****** +The configfile is using the .ini-format. +Currently all settings are read from the ``[General]``-section. + ++--------+----------------+ +| Key | Description | ++========+================+ +| log | Path to | +| | TS3Server-logf | +| | ile(s) | +| | (supports | +| | `globbing ` | +| | __) | ++--------+----------------+ +| output | Path to the | +| | location, | +| | where the | +| | generator will | +| | put the | +| | generated | +| | ``.html``-file | ++--------+----------------+ +| idmap | Path to | +| | `IdentMap `__ | ++--------+----------------+ +| debug | debug mode | ++--------+----------------+ +| online | Add timedelta | +| dc | from | +| | last-connect | +| | until now to | +| | onlinetime for | +| | connected | +| | clients | ++--------+----------------+ +| templa | Path to a | +| te | custom | +| | template file | +| | (relative from | +| | ``tsstats/`` | +| | or absolute) | ++--------+----------------+ +| dateti | Format of | +| meform | date/time-valu | +| at | es | +| | used for | +| | render-timesta | +| | mp | +| | and last | +| | online (using | +| | `datetime.strf | +| | time `__ | +| | ) | ++--------+----------------+