From 39ea6b05875164b4e9b2293b61fb29fba1d6a661 Mon Sep 17 00:00:00 2001 From: Jonathan Rubenstein Date: Sat, 25 Dec 2021 20:50:26 +0200 Subject: [PATCH] [doc] install: Config file loading polish --- doc/install.rst | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/install.rst b/doc/install.rst index 972c3058..fc44b7a3 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -289,21 +289,23 @@ Examples: Configuration Files ~~~~~~~~~~~~~~~~~~~ -By default, the application will look for and load the config files in -the following locations and order: +By default, Looking Glass will load config files from +the following locations: - /etc/looking-glass-client.ini - ~/.looking-glass-client.ini - $XDG_CONFIG_HOME/looking-glass/client.ini (usually ~/.config/looking-glass/client.ini) -Config options are merged from all files. Same options appearing in more -than one file will be overridden by the latest loaded one (E.g. an option -appearing in ~/.config/looking-glass/client.ini will override the same -option appearing in ~/.looking-glass-client.ini). When first launched, -the Looking-Glass client will create the folder $XDG_CONFIG_HOME/looking-glass/ -if it does not yet exist. +All config files are loaded in order. Duplicate entries override earlier ones. +This means you can set a system-wide configuration in +``/etc/looking-glass-client.ini``, and override specific options for just +your user in ``~/.looking-glass-client.ini``, which is overlayed on top of +the system-wide configuration. -The format of this file is the commonly known INI format, for example:: +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:: [win] fullScreen=yes @@ -311,7 +313,7 @@ The format of this file is the commonly known INI format, for example:: [egl] nvGain=1 -Command line arguments will override any options loaded from the config +Command line arguments will override any options loaded from config files. .. _client_overlay_mode: