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 * Brice Waegeneire
  42 * Chris Dunder
  43 * Christoph Gysin
  44 * Daniel Hahler
  45 * Maciej Sitarz
  46 * Mathias Svensson
  47 * Matthew R Johnson
  48 * Nazar Mokrynskyi
  49 * Phillip Berndt
  50 * Rasmus Wriedt Larsen
  51 * Simon Wydooghe
  52 * Stefan Tomanek
  53 * stormc
  54 * tachylatus
  55 * Timo Bingmann
  56 * Timo Kaufmann
  57 * Tomasz Bogdal
  58 * Victor Häggqvist
  59
  60 ## Installation/removal
  61
  62 You can use the `autorandr.py` script as a stand-alone binary. If you'd like to
  63 install it as a system-wide application, there is a Makefile included that also
  64 places some configuration files in appropriate directories such that autorandr
  65 is invoked automatically when a monitor is connected or removed, the system
  66 wakes up from suspend, or a user logs into an X11 session. Run `make install`
  67 as root to install it.
  68
  69 If you prefer to have a system wide install managed by your package manager,
  70 you can
  71
  72 * Use the [aur package](https://aur.archlinux.org/packages/autorandr-git/) on Arch
  73 * Use the [official Debian package](https://packages.debian.org/sid/x11/autorandr) on sid
  74 * Use the [ebuild from zugaina](https://gpo.zugaina.org/x11-misc/autorandr) on Gentoo.
  75 * Use the
  76   [nix package](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/autorandr.nix)
  77   on NixOS.
  78 * Use the automated nightlies generated by the
  79   [openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr)
  80   for various distributions (RPM and DEB based).
  81 * Build a .deb-file from the source tree using `make deb`.
  82
  83 We appreciate packaging scripts for other distributions, please file a pull
  84 request if you write one.
  85
  86 If you prefer `pip` over your package manager, you can install autorandr with:
  87
  88     sudo pip install "git+http://github.com/phillipberndt/autorandr#egg=autorandr"
  89
  90 or simply
  91
  92     sudo pip install autorandr
  93
  94 if you prefer to use a stable version.
  95
  96 ## How to use
  97
  98 Save your current display configuration and setup with:
  99
 100     autorandr --save mobile
 101
 102 Connect an additional display, configure your setup and save it:
 103
 104     autorandr --save docked
 105
 106 Now autorandr can detect which hardware setup is active:
 107
 108     $ autorandr
 109       mobile
 110       docked (detected)
 111
 112 To automatically reload your setup:
 113
 114     $ autorandr --change
 115
 116 To manually load a profile:
 117
 118     $ autorandr --load <profile>
 119
 120 or simply:
 121
 122     $ autorandr <profile>
 123
 124 autorandr tries to avoid reloading an identical configuration. To force the
 125 (re)configuration:
 126
 127     $ autorandr --load <profile> --force
 128
 129 To prevent a profile from being loaded, place a script call _block_ in its
 130 directory. The script is evaluated before the screen setup is inspected, and
 131 in case of it returning a value of 0 the profile is skipped. This can be used
 132 to query the status of a docking station you are about to leave.
 133
 134 If no suitable profile can be identified, the current configuration is kept.
 135 To change this behaviour and switch to a fallback configuration, specify
 136 `--default <profile>`. The system-wide installation of autorandr by default
 137 calls autorandr with a parameter `--default default`. There are three special,
 138 virtual configurations called `horizontal`, `vertical` and `common`. They
 139 automatically generate a configuration that incorporates all screens
 140 connected to the computer. You can symlink `default` to one of these
 141 names in your configuration directory to have autorandr use any of them
 142 as the default configuration without you having to change the system-wide
 143 configuration.
 144
 145 You can store default values for any option in an INI-file in
 146 `~/.config/autorandr/settings.ini` in a section `config`. The most useful
 147 candidate for doing that is `skip-options`, if you need it.
 148
 149 ## Advanced usage
 150
 151 ### Hook scripts
 152
 153 Three more scripts can be placed in the configuration directory (as
 154 (as defined by the [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html),
 155 usually `~/.config/autorandr` or `~/.autorandr` if you have an old installation
 156 for user configuration and `/etc/xdg/autorandr` for system wide configuration):
 157
 158 - `postswitch` is executed *after* a mode switch has taken place. This can be
 159   used to notify window managers or other applications about the switch.
 160 - `preswitch` is executed *before* a mode switch takes place.
 161 - `postsave` is executed after a profile was stored or altered.
 162 - `predetect` is executed before autorandr attempts to run xrandr.
 163
 164 These scripts must be executable and can be placed directly in the configuration
 165 directory, where they will always be executed, or in the profile subdirectories,
 166 where they will only be executed on changes regarding that specific profile.
 167
 168 Instead (or in addition) to these scripts, you can also place as many executable
 169 files as you like in subdirectories called `script_name.d` (e.g. `postswitch.d`).
 170
 171 If a script with the same name occurs multiple times, user configuration
 172 takes precedence over system configuration (as specified by the
 173 [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html))
 174 and profile configuration over general configuration.
 175
 176 As a concrete example, suppose you have the files
 177
 178 - `/etc/xdg/autorandr/postswitch`
 179 - `~/.config/autorandr/postswitch`
 180 - `~/.config/autorandr/postswitch.d/notify-herbstluftwm`
 181 - `~/.config/autorandr/docked/postswitch`
 182
 183 and switch from `mobile` to `docked`. Then
 184 `~/.config/autorandr/docked/postswitch` is executed, since the profile specific
 185 configuration takes precedence, and
 186 `~/.config/autorandr/postswitch.d/notify-herbstluftwm` is executed, since
 187 it has a unique name.
 188
 189 If you switch back from `docked` to `mobile`, `~/.config/autorandr/postswitch`
 190 is executed instead of the `mobile` specific `postswitch`.
 191
 192 In these scripts, some of autorandr's state is exposed as environment variables
 193 prefixed with `AUTORANDR_`, such as:
 194 - `AUTORANDR_CURRENT_PROFILE`
 195 - `AUTORANDR_CURRENT_PROFILES`
 196 - `AUTORANDR_PROFILE_FOLDER`
 197 - `AUTORANDR_MONITORS`
 198
 199 If you experience issues with xrandr being executed too early after connecting
 200 a new monitor, then you can use a `predetect` script to delay the execution.
 201 Write e.g. `sleep 1` into that file to make autorandr wait a second before
 202 running `xrandr`.
 203
 204 ### Wildcard EDID matching
 205
 206 The EDID strings in the `~/.config/autorandr/*/setup` files may contain an
 207 asterisk to enable wildcard matching: Such EDIDs are matched against connected
 208 monitors using the usual file name globbing rules. This can be used to create
 209 profiles matching multiple (or any) monitors.
 210
 211 ## Changelog
 212
 213 * *2018-04-19* Bugfix: Do not load default profile unless --change is set
 214 * *2018-04-30* Added a `AUTORANDR_MONITORS` variable to hooks (by @bricewge, #106)
 215 * *2018-06-29* Fix detection of current configuration if extra monitors are active
 216 * *2018-07-11* Bugfix in the latest change: Correctly handle "off" minitors when comparing
 217
 218 **autorandr 1.5**
 219
 220 * *2018-01-03* Add --version
 221 * *2018-01-04* Fixed vertical/horizontal/clone-largest virtual profiles
 222 * *2018-03-07* Output all non-error messages to stdout instead of stderr
 223 * *2018-03-25* Add --detected and --current to filter the profile list output
 224 * *2018-03-25* Allow wildcard matching in EDIDs
 225
 226 **autorandr 1.4**
 227
 228 * *2017-12-22* Fixed broken virtual profile support
 229 * *2017-12-14* Added support for a settings file
 230 * *2017-12-14* Added a virtual profile `off`, which disables all screens
 231
 232 **autorandr 1.3**
 233
 234 * *2017-11-13* Add a short form for `--load`
 235 * *2017-11-21* Fix environment stealing in `--batch` mode (See #87)
 236
 237 **autorandr 1.2**
 238
 239 * *2017-07-16* Skip `--panning` unless it is required (See #72)
 240 * *2017-10-13* Add `clone-largest` virtual profile
 241
 242 **autorandr 1.1**
 243
 244 * *2017-06-07* Call systemctl with `--no-block` from udev rule (See #61)
 245 * *2017-01-20* New script hook, `predetect`
 246 * *2017-01-18* Accept comments (lines starting with `#`) in config/setup files
 247
 248 **autorandr 1.0**
 249
 250 * *2016-12-07* Tag the current code as version 1.0.0; see github issue #54
 251 * *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default