Introduce --batch option to autorandr: Run autorandr for each user with an X11 session

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index 150de3f7a110485dd7712b458acf179969a19744..1bda138ac9b5f09f66e9819afa07c10fe738e7b0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,15 +34,20 @@ Contributors to this version of autorandr are:
 
 * Alexander Wirt
 * Chris Dunder
+* Daniel Hahler
 * Maciej Sitarz
+* Mathias Svensson
 * Matthew R Johnson
 * Phillip Berndt
 * Rasmus Wriedt Larsen
 * Stefan Tomanek
 * Timo Bingmann
 * Tomasz Bogdal
+* Victor Häggqvist
 * stormc
 * tachylatus
+* andersonjacob
+* Simon Wydooghe
 
 ## How to use
 
@@ -80,9 +85,17 @@ To change this behaviour and switch to a fallback configuration, specify
 `--default <profile>`.
 
 Another script called `postswitch` can be placed in the directory
-`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as well as in all profile directories: The scripts are executed
-after a mode switch has taken place and can notify window managers or other
-applications about it.
-
-To install autorandr call `make install`, define your setup and then call
-`make hotplug` to install hotplug scripts.
+`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as
+well as in all profile directories: The scripts are executed after a mode
+switch has taken place and can notify window managers or other applications
+about it. The same holds for `preswitch`, which is executed before the switch
+takes place, and `postsave`, which is executed after a profile was
+stored/altered.
+
+All scripts can also be placed in any of the `$XDG_CONFIG_DIRS`. In addition to
+the script names themselves, any executables in subdirectories named
+`script_name.d` (e.g. `postswitch.d`) are executed as well. In scripts, some of
+autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`.
+The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
+
+To install autorandr call `make install`.