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 fdfb54712d3c77d4515aadd5e809dc6e5b41f5e3..1bda138ac9b5f09f66e9819afa07c10fe738e7b0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -36,6 +36,7 @@ Contributors to this version of autorandr are:
 * Chris Dunder
 * Daniel Hahler
 * Maciej Sitarz
+* Mathias Svensson
 * Matthew R Johnson
 * Phillip Berndt
 * Rasmus Wriedt Larsen
@@ -46,6 +47,7 @@ Contributors to this version of autorandr are:
 * stormc
 * tachylatus
 * andersonjacob
+* Simon Wydooghe
 
 ## How to use
 
@@ -83,8 +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.
+`~/.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`.