README.md

   1 # autorandr
   2
   3 Automatically select a display configuration based on connected devices
   4
   5 Stefan Tomanek <[stefan.tomanek@wertarbyte.de](stefan.tomanek@wertarbyte.de)>
   6
   7 ## How to use
   8
   9 Save your current display configuration and setup with:
  10 ```
  11 autorandr --save mobile
  12 ```
  13
  14 Connect an additional display, configure your setup and save it:
  15 ```
  16 autorandr --save docked
  17 ```
  18
  19 Now autorandr can detect which hardware setup is active:
  20 ```
  21  $ autorandr
  22    mobile
  23    docked (detected)
  24 ```
  25
  26 To automatically reload your setup, just append `--change` to the command line
  27
  28 To manually load a profile, you can use the `--load <profile>` option.
  29
  30 autorandr tries to avoid reloading an identical configuration. To force the
  31 (re)configuration, apply `--force`.
  32
  33 To prevent a profile from being loaded, place a script call _block_ in its
  34 directory. The script is evaluated before the screen setup is inspected, and
  35 in case of it returning a value of 0 the profile is skipped. This can be used
  36 to query the status of a docking station you are about to leave.
  37
  38 If no suitable profile can be identified, the current configuration is kept.
  39 To change this behaviour and switch to a fallback configuration, specify
  40 `--default <profile>`.
  41
  42 Another script called `postswitch` can be placed in the directory
  43 `~/.autorandr` as well as in all profile directories: The scripts are executed
  44 after a mode switch has taken place and can notify window managers or other
  45 applications about it.
  46
  47
  48 While the script uses xrandr by default, calling it by the name `autodisper`
  49 or `auto-disper` forces it to use the [disper](http://willem.engen.nl/projects/disper/)
  50 utility, which is useful for controlling nvidia chipsets. The formats for
  51 fingerprinting the current setup and saving/loading the current configuration
  52 are adjusted accordingly.