]> git.donarmstrong.com Git - deb_pkgs/autorandr.git/commitdiff
Elaborate on settings.ini usage and format
authorKyle Kneitinger <kyle@kneit.in>
Wed, 9 Dec 2020 20:08:32 +0000 (12:08 -0800)
committerPhillip Berndt <phillip.berndt@googlemail.com>
Thu, 16 Dec 2021 08:27:59 +0000 (09:27 +0100)
README.md

index daa6b3883b17e6a7cc78e56e2ca8517bbdb1139f..6c6a4a66f09b0bd53d81d6b5b0a572a19cfc18ec 100644 (file)
--- a/README.md
+++ b/README.md
@@ -147,9 +147,20 @@ names in your configuration directory to have autorandr use any of them
 as the default configuration without you having to change the system-wide
 configuration.
 
-You can store default values for any option in an INI-file in
-`~/.config/autorandr/settings.ini` in a section `config`. The most useful
-candidate for doing that is `skip-options`, if you need it.
+You can store default values for any option in an INI-file located at
+`~/.config/autorandr/settings.ini`. In a `config` section, you may place any
+default values in the form `option-name=option-argument`.
+
+A common and effective use of this is to specify default `skip-options`, for
+instance skipping the `gamma` setting if using
+[`redshift`](https://github.com/jonls/redshift) as a daemon.  To implement
+the equivalent of `--skip-options gamma`, your `settings.ini` file should look
+like this:
+
+```
+[config]
+skip-options=gamma
+```
 
 ## Advanced usage