README.md

   1 # autorandr
   2
   3 Automatically select a display configuration based on connected devices
   4
   5 ## Branch information
   6
   7 This is a compatible Python rewrite of
   8 [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). Contributions
   9 for bash-completion, fd.o/XDG autostart, Nitrogen, pm-utils, and systemd can be
  10 found under [contrib](contrib/).
  11
  12 The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr)
  13 tree is unmaintained, with lots of open pull requests and issues. I forked it
  14 and merged what I thought were the most important changes. If you are searching
  15 for that version, see the [`legacy` branch](https://github.com/phillipberndt/autorandr/tree/legacy).
  16 Note that the Python version is better suited for non-standard configurations,
  17 like if you use `--transform` or `--reflect`. If you use `auto-disper`, you
  18 have to use the bash version, as there is no disper support in the Python
  19 version (yet). Both versions use a compatible configuration file format, so
  20 you can, to some extent, switch between them.  I will maintain the `legacy`
  21 branch until @wertarbyte finds the time to maintain his branch again.
  22
  23 If you are interested in why there are two versions around, see
  24 [#7](https://github.com/phillipberndt/autorandr/issues/7),
  25 [#8](https://github.com/phillipberndt/autorandr/issues/8) and
  26 especially
  27 [#12](https://github.com/phillipberndt/autorandr/issues/12)
  28 if you are unhappy with this version and would like to contribute to the bash
  29 version.
  30
  31 ## License information and authors
  32
  33 autorandr is available under the terms of the GNU General Public License
  34 (version 3).
  35
  36 Contributors to this version of autorandr are:
  37
  38 * Adrián López
  39 * andersonjacob
  40 * Alexander Wirt
  41 * Chris Dunder
  42 * Daniel Hahler
  43 * Maciej Sitarz
  44 * Mathias Svensson
  45 * Matthew R Johnson
  46 * Nazar Mokrynskyi
  47 * Phillip Berndt
  48 * Rasmus Wriedt Larsen
  49 * Simon Wydooghe
  50 * Stefan Tomanek
  51 * stormc
  52 * tachylatus
  53 * Timo Bingmann
  54 * Timo Kaufmann
  55 * Tomasz Bogdal
  56 * Victor Häggqvist
  57
  58 ## Installation/removal
  59
  60 You can use the `autorandr.py` script as a stand-alone binary. If you'd like to
  61 install it as a system-wide application, there is a Makefile included that also
  62 places some configuration files in appropriate directories such that autorandr
  63 is invoked automatically when a monitor is connected or removed, the system
  64 wakes up from suspend, or a user logs into an X11 session.
  65
  66 For Debian-based distributions (including Ubuntu) it is recommended to call
  67 `make deb` to obtain a package that can be installed and removed with `dpkg`.
  68
  69 On Arch Linux, there is [an aur package
  70 available](https://aur.archlinux.org/packages/autorandr-git/).
  71
  72 autorandr is also packaged in the [nix package manager](https://nixos.org/nix/)
  73 repositories.
  74
  75 On other distributions you can install autorandr by calling `make install` and
  76 remove it by calling `make uninstall`. Run `make` without arguments to obtain a
  77 list of what exactly will be installed.
  78
  79 We appreciate packaging scripts for other distributions, please file a pull
  80 request if you write one.
  81
  82 If you prefer `pip` over your package manager, you can install autorandr with:
  83
  84     sudo pip install "git+http://github.com/phillipberndt/autorandr#egg=autorandr"
  85
  86 or simply
  87
  88     sudo pip install autorandr
  89
  90 if you prefer to use a stable version.
  91
  92 Automatically generated packages versions are available from the
  93 [openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr).
  94
  95 ## How to use
  96
  97 Save your current display configuration and setup with:
  98
  99     autorandr --save mobile
 100
 101 Connect an additional display, configure your setup and save it:
 102
 103     autorandr --save docked
 104
 105 Now autorandr can detect which hardware setup is active:
 106
 107     $ autorandr
 108       mobile
 109       docked (detected)
 110
 111 To automatically reload your setup:
 112
 113     $ autorandr --change
 114
 115 To manually load a profile:
 116
 117     $ autorandr --load <profile>
 118
 119 autorandr tries to avoid reloading an identical configuration. To force the
 120 (re)configuration:
 121
 122     $ autorandr --load <profile> --force
 123
 124 To prevent a profile from being loaded, place a script call _block_ in its
 125 directory. The script is evaluated before the screen setup is inspected, and
 126 in case of it returning a value of 0 the profile is skipped. This can be used
 127 to query the status of a docking station you are about to leave.
 128
 129 If no suitable profile can be identified, the current configuration is kept.
 130 To change this behaviour and switch to a fallback configuration, specify
 131 `--default <profile>`. The system-wide installation of autorandr by default
 132 calls autorandr with a parameter `--default default`. There are three special,
 133 virtual configurations called `horizontal`, `vertical` and `common`. They
 134 automatically generate a configuration that incorporates all screens
 135 connected to the computer. You can symlink `default` to one of these
 136 names in your configuration directory to have autorandr use any of them
 137 as the default configuration without you having to change the system-wide
 138 configuration.
 139
 140 ## Hook scripts
 141
 142 Three more scripts can be placed in the configuration directory (as
 143 (as defined by the [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html),
 144 usually `~/.config/autorandr` or `~/.autorandr` if you have an old installation
 145 for user configuration and `/etc/xdg/autorandr` for system wide configuration):
 146
 147 - `postswitch` is executed *after* a mode switch has taken place. This can be
 148   used to notify window managers or other applications about the switch.
 149 - `preswitch` is executed *before* a mode switch takes place.
 150 - `postsave` is executed after a profile was stored or altered.
 151 - `predetect` is executed before autorandr attempts to run xrandr.
 152
 153 These scripts must be executable and can be placed directly in the configuration
 154 directory, where they will always be executed, or in the profile subdirectories,
 155 where they will only be executed on changes regarding that specific profile.
 156
 157 Instead (or in addition) to these scripts, you can also place as many executable
 158 files as you like in subdirectories called `script_name.d` (e.g. `postswitch.d`).
 159
 160 If a script with the same name occurs multiple times, user configuration
 161 takes precedence over system configuration (as specified by the
 162 [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html))
 163 and profile configuration over general configuration.
 164
 165 As a concrete example, suppose you have the files
 166
 167 - `/etc/xdg/autorandr/postswitch`
 168 - `~/.config/autorandr/postswitch`
 169 - `~/.config/autorandr/postswitch.d/notify-herbstluftwm`
 170 - `~/.config/autorandr/docked/postswitch`
 171
 172 and switch from `mobile` to `docked`. Then
 173 `~/.config/autorandr/docked/postswitch` is executed, since the profile specific
 174 configuration takes precedence, and
 175 `~/.config/autorandr/postswitch.d/notify-herbstluftwm` is executed, since
 176 it has a unique name.
 177
 178 If you switch back from `docked` to `mobile`, `~/.config/autorandr/postswitch`
 179 is executed instead of the `mobile` specific `postswitch`.
 180
 181 In these scripts, some of autorandr's state is exposed as environment variables
 182 prefixed with `AUTORANDR_`. The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
 183
 184 If you experience issues with xrandr being executed too early after connecting
 185 a new monitor, then you can use a `predetect` script to delay the execution.
 186 Write e.g. `sleep 1` into that file to make autorandr wait a second before
 187 running `xrandr`.
 188
 189 ## Changelog
 190
 191 **autorandr 1.2**
 192
 193 * *2017-07-16* Skip `--panning` unless it is required (See #72)
 194 * *2017-10-13* Add `clone-largest` virtual profile
 195
 196 **autorandr 1.1**
 197
 198 * *2017-06-07* Call systemctl with `--no-block` from udev rule (See #61)
 199 * *2017-01-20* New script hook, `predetect`
 200 * *2017-01-18* Accept comments (lines starting with `#`) in config/setup files
 201
 202 **autorandr 1.0**
 203
 204 * *2016-12-07* Tag the current code as version 1.0.0; see github issue #54
 205 * *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default