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 ## autorandr vs. autorandr.py
  31
  32 The two files `autorandr` and `autorandr.py` are two independent versions of
  33 autorandr. For now, both are here, but I might move one of both versions into
  34 its own branch or repository someday. See [bug #7](https://github.com/phillipberndt/autorandr/issues/7)
  35 for details on why there are two versions around.
  36
  37 The two versions are compatible with respect to the profile format and command
  38 line parameters, but
  39
  40 * the *Python version* does not support auto-disper
  41 * the *bash version* does not support changes in available adapters and slightly esoteric configurations (like transformations and reflections)
  42
  43 Active development in this repository is likely to occur preferably in the
  44 Python version.
  45
  46 ## How to use
  47
  48 Save your current display configuration and setup with:
  49 ```
  50 autorandr --save mobile
  51 ```
  52
  53 Connect an additional display, configure your setup and save it:
  54 ```
  55 autorandr --save docked
  56 ```
  57
  58 Now autorandr can detect which hardware setup is active:
  59 ```
  60  $ autorandr
  61    mobile
  62    docked (detected)
  63 ```
  64
  65 To automatically reload your setup, just append `--change` to the command line
  66
  67 To manually load a profile, you can use the `--load <profile>` option.
  68
  69 autorandr tries to avoid reloading an identical configuration. To force the
  70 (re)configuration, apply `--force`.
  71
  72 To prevent a profile from being loaded, place a script call _block_ in its
  73 directory. The script is evaluated before the screen setup is inspected, and
  74 in case of it returning a value of 0 the profile is skipped. This can be used
  75 to query the status of a docking station you are about to leave.
  76
  77 If no suitable profile can be identified, the current configuration is kept.
  78 To change this behaviour and switch to a fallback configuration, specify
  79 `--default <profile>`.
  80
  81 Another script called `postswitch` can be placed in the directory
  82 `~/.autorandr` as well as in all profile directories: The scripts are executed
  83 after a mode switch has taken place and can notify window managers or other
  84 applications about it.
  85
  86 While the script uses xrandr by default, calling it by the name `autodisper`
  87 or `auto-disper` forces it to use the [disper](http://willem.engen.nl/projects/disper/)
  88 utility, which is useful for controlling nvidia chipsets. The formats for
  89 fingerprinting the current setup and saving/loading the current configuration
  90 are adjusted accordingly.
  91
  92 To install autorandr call `make install`, define your setup and then call
  93 `make hotplug` to install hotplug scripts.
  94
  95 For Debian using auto-disper:
  96 To make the screen auto-configure when your computer wakes up,
  97 * Copy auto-disper into /usr/local/bin/
  98 * Copy pm-utils/40auto-disper into /etc/pm/sleep.d/
  99 * (Assuming gnome) Run gnome-keybinding-properties and ADD a shortcut,
 100   I called it "Run auto-disper", I set it to CTRL-F7, and the command is:
 101   `auto-disper -c --default default`
 102 * Create a default disper setting... eg for laptop: unplug all monitors,
 103   set up the screen nicely on the laptop display.
 104   Then run `auto-disper --save laptop`