readme: add example for short form of --load

[deb_pkgs/autorandr.git] / README.md

diff --git a/README.md b/README.md
index 98b38731df0ca3feaa56baf64529ad57a705e619..764d347b3a26d1ca99d07a358e5431b02642d550 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,10 +1,13 @@
-# autorandr 
+# autorandr
+
 Automatically select a display configuration based on connected devices
 
 ## Branch information
 
 This is a compatible Python rewrite of
-[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). Contributions for bash-completion, fd.o/XDG autostart, Nitrogen, pm-utils, and systemd can be found under [contrib](contrib/).
+[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). Contributions
+for bash-completion, fd.o/XDG autostart, Nitrogen, pm-utils, and systemd can be
+found under [contrib](contrib/).
 
 The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr)
 tree is unmaintained, with lots of open pull requests and issues. I forked it
@@ -22,7 +25,7 @@ If you are interested in why there are two versions around, see
 [#8](https://github.com/phillipberndt/autorandr/issues/8) and
 especially
 [#12](https://github.com/phillipberndt/autorandr/issues/12)
-if you are unhappy with this version and would like to contibute to the bash
+if you are unhappy with this version and would like to contribute to the bash
 version.
 
 ## License information and authors
@@ -36,6 +39,7 @@ Contributors to this version of autorandr are:
 * andersonjacob
 * Alexander Wirt
 * Chris Dunder
+* Christoph Gysin
 * Daniel Hahler
 * Maciej Sitarz
 * Mathias Svensson
@@ -53,6 +57,7 @@ Contributors to this version of autorandr are:
 * Victor Häggqvist
 
 ## Installation/removal
+
 You can use the `autorandr.py` script as a stand-alone binary. If you'd like to
 install it as a system-wide application, there is a Makefile included that also
 places some configuration files in appropriate directories such that autorandr
@@ -81,7 +86,7 @@ If you prefer `pip` over your package manager, you can install autorandr with:
 
 or simply
 
-       sudo pip install autorandr
+    sudo pip install autorandr
 
 if you prefer to use a stable version.
 
@@ -104,12 +109,22 @@ Now autorandr can detect which hardware setup is active:
       mobile
       docked (detected)
 
-To automatically reload your setup, just append `--change` to the command line
+To automatically reload your setup:
+
+    $ autorandr --change
+
+To manually load a profile:
 
-To manually load a profile, you can use the `--load <profile>` option.
+    $ autorandr --load <profile>
+
+or simply:
+
+    $ autorandr <profile>
 
 autorandr tries to avoid reloading an identical configuration. To force the
-(re)configuration, apply `--force`.
+(re)configuration:
+
+    $ autorandr --load <profile> --force
 
 To prevent a profile from being loaded, place a script call _block_ in its
 directory. The script is evaluated before the screen setup is inspected, and