Claytonia/TeamspeakStats
Claytonia
/
TeamspeakStats
mirror of https://github.com/Thor77/TeamspeakStats.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Import Config-table from README into docs

This commit is contained in:
Thor77 2016-11-01 22:14:15 +01:00
parent de7afd87e7
commit 1c4ee4d72d
1 changed files with 66 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
docs/source/config.rst
View File

@ -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 <htt |
| | ps://docs.pyth |
| | on.org/3/libra |
| | ry/glob.html>` |
| | __) |
+--------+----------------+
| output | Path to the |
| | location, |
| | where the |
| | generator will |
| | put the |
| | generated |
| | ``.html``-file |
+--------+----------------+
| idmap | Path to |
| | `IdentMap <htt |
| | p://teamspeaks |
| | tats.readthedo |
| | cs.io/en/lates |
| | t/identmap.htm |
| | l>`__ |
+--------+----------------+
| 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 <https:// |
| | docs.python.or |
| | g/3/library/da |
| | tetime.html#st |
| | rftime-strptim |
| | e-behavior>`__ |
| | ) |
+--------+----------------+