From 9b0af43a427d3f30d88b6d8cd021d48d1cf670b9 Mon Sep 17 00:00:00 2001 From: Quantum Date: Sun, 18 Sep 2022 22:41:12 -0400 Subject: [PATCH] [doc] usage: improve ini syntax documentation This uses syntax highlighting for the config file and also documents the ; comment character. --- doc/usage.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/usage.rst b/doc/usage.rst index 4dd77b72..658fc401 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -112,7 +112,9 @@ the system-wide configuration. When first launched, the Looking-Glass client will create the folder ``$XDG_CONFIG_HOME/looking-glass/`` if it does not yet exist. -The format of config files is the commonly known INI format, for example:: +The format of config files is the commonly known INI format, for example: + +.. code-block:: ini [win] fullScreen=yes @@ -120,6 +122,8 @@ The format of config files is the commonly known INI format, for example:: [egl] nvGain=1 + ; this is a comment + Command line arguments will override any options loaded from config files.