README.md

   1 # autorandr
   2
   3 Automatically select a display configuration based on connected devices
   4
   5 ## Branch information
   6
   7 The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr)
   8 tree seems unmaintained, with lots of open pull requests and issues. I forked
   9 it and merged what I thought were the most important changes. I will maintain
  10 this branch until @wertarbyte finds the time to maintain his branch again.
  11
  12 ## License information and authors
  13
  14 Stefan Tomanek came up with and wrote the initial version of autorandr. He
  15 currently does not maintain it, and did not express his opinion concerning an
  16 OSS license in two independent requests. To resolve the licensing issue, all
  17 non-trivial code in this fork has been reimplemented by various authors that
  18 have agreed to release their code under the terms of the GNU General Public
  19 License (version 3).
  20
  21 This license will apply to versions of autorandr from this fork that are
  22 committed after issue #7 has been resolved, and versions derived from that one.
  23 **In particular, wertarbyte's original repository is still not OSS, and the current
  24 version in this repository is neither.**
  25
  26 Contributors to this version of autorandr are:
  27
  28 * Alexander Wirt
  29 * Chris Dunder
  30 * Maciej Sitarz
  31 * Matthew R Johnson
  32 * Phillip Berndt
  33 * Timo Bingmann
  34 * Tomasz Bogdal
  35 * stormc
  36 * tachylatus
  37
  38 ## How to use
  39
  40 Save your current display configuration and setup with:
  41 ```
  42 autorandr --save mobile
  43 ```
  44
  45 Connect an additional display, configure your setup and save it:
  46 ```
  47 autorandr --save docked
  48 ```
  49
  50 Now autorandr can detect which hardware setup is active:
  51 ```
  52  $ autorandr
  53    mobile
  54    docked (detected)
  55 ```
  56
  57 To automatically reload your setup, just append `--change` to the command line
  58
  59 To manually load a profile, you can use the `--load <profile>` option.
  60
  61 autorandr tries to avoid reloading an identical configuration. To force the
  62 (re)configuration, apply `--force`.
  63
  64 To prevent a profile from being loaded, place a script call _block_ in its
  65 directory. The script is evaluated before the screen setup is inspected, and
  66 in case of it returning a value of 0 the profile is skipped. This can be used
  67 to query the status of a docking station you are about to leave.
  68
  69 If no suitable profile can be identified, the current configuration is kept.
  70 To change this behaviour and switch to a fallback configuration, specify
  71 `--default <profile>`.
  72
  73 Another script called `postswitch` can be placed in the directory
  74 `~/.autorandr` as well as in all profile directories: The scripts are executed
  75 after a mode switch has taken place and can notify window managers or other
  76 applications about it.
  77
  78 While the script uses xrandr by default, calling it by the name `autodisper`
  79 or `auto-disper` forces it to use the [disper](http://willem.engen.nl/projects/disper/)
  80 utility, which is useful for controlling nvidia chipsets. The formats for
  81 fingerprinting the current setup and saving/loading the current configuration
  82 are adjusted accordingly.
  83
  84 To install autorandr call `make install`, define your setup and then call
  85 `make hotplug` to install hotplug scripts.
  86
  87 For Debian using auto-disper:
  88 To make the screen auto-configure when your computer wakes up,
  89 * Copy auto-disper into /usr/local/bin/
  90 * Copy pm-utils/40auto-disper into /etc/pm/sleep.d/
  91 * (Assuming gnome) Run gnome-keybinding-properties and ADD a shortcut,
  92   I called it "Run auto-disper", I set it to CTRL-F7, and the command is:
  93   `auto-disper -c --default default`
  94 * Create a default disper setting... eg for laptop: unplug all monitors,
  95   set up the screen nicely on the laptop display.
  96   Then run `auto-disper --save laptop`