[doc] usage: improve ini syntax documentation

This uses syntax highlighting for the config file and also documents
the ; comment character.
This commit is contained in:
Quantum 2022-09-18 22:41:12 -04:00 committed by Geoffrey McRae
parent 0f1eb0fa7f
commit 9b0af43a42

View File

@ -112,7 +112,9 @@ the system-wide configuration.
When first launched, the Looking-Glass client will create the folder When first launched, the Looking-Glass client will create the folder
``$XDG_CONFIG_HOME/looking-glass/`` if it does not yet exist. ``$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] [win]
fullScreen=yes fullScreen=yes
@ -120,6 +122,8 @@ The format of config files is the commonly known INI format, for example::
[egl] [egl]
nvGain=1 nvGain=1
; this is a comment
Command line arguments will override any options loaded from config Command line arguments will override any options loaded from config
files. files.