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 is 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 autorandr is available under the terms of the GNU General Public License
  15 (version 3).
  16
  17 Contributors to this version of autorandr are:
  18
  19 * Alexander Wirt
  20 * Chris Dunder
  21 * Maciej Sitarz
  22 * Matthew R Johnson
  23 * Phillip Berndt
  24 * Stefan Tomanek
  25 * Timo Bingmann
  26 * Tomasz Bogdal
  27 * stormc
  28 * tachylatus
  29
  30 ## How to use
  31
  32 Save your current display configuration and setup with:
  33 ```
  34 autorandr --save mobile
  35 ```
  36
  37 Connect an additional display, configure your setup and save it:
  38 ```
  39 autorandr --save docked
  40 ```
  41
  42 Now autorandr can detect which hardware setup is active:
  43 ```
  44  $ autorandr
  45    mobile
  46    docked (detected)
  47 ```
  48
  49 To automatically reload your setup, just append `--change` to the command line
  50
  51 To manually load a profile, you can use the `--load <profile>` option.
  52
  53 autorandr tries to avoid reloading an identical configuration. To force the
  54 (re)configuration, apply `--force`.
  55
  56 To prevent a profile from being loaded, place a script call _block_ in its
  57 directory. The script is evaluated before the screen setup is inspected, and
  58 in case of it returning a value of 0 the profile is skipped. This can be used
  59 to query the status of a docking station you are about to leave.
  60
  61 If no suitable profile can be identified, the current configuration is kept.
  62 To change this behaviour and switch to a fallback configuration, specify
  63 `--default <profile>`.
  64
  65 Another script called `postswitch` can be placed in the directory
  66 `~/.autorandr` as well as in all profile directories: The scripts are executed
  67 after a mode switch has taken place and can notify window managers or other
  68 applications about it.
  69
  70 While the script uses xrandr by default, calling it by the name `autodisper`
  71 or `auto-disper` forces it to use the [disper](http://willem.engen.nl/projects/disper/)
  72 utility, which is useful for controlling nvidia chipsets. The formats for
  73 fingerprinting the current setup and saving/loading the current configuration
  74 are adjusted accordingly.
  75
  76 To install autorandr call `make install`, define your setup and then call
  77 `make hotplug` to install hotplug scripts.
  78
  79 For Debian using auto-disper:
  80 To make the screen auto-configure when your computer wakes up,
  81 * Copy auto-disper into /usr/local/bin/
  82 * Copy pm-utils/40auto-disper into /etc/pm/sleep.d/
  83 * (Assuming gnome) Run gnome-keybinding-properties and ADD a shortcut,
  84   I called it "Run auto-disper", I set it to CTRL-F7, and the command is:
  85   `auto-disper -c --default default`
  86 * Create a default disper setting... eg for laptop: unplug all monitors,
  87   set up the screen nicely on the laptop display.
  88   Then run `auto-disper --save laptop`