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 * Christophe-Marie Duquesne
  45 * Daniel Hahler
  46 * Maciej Sitarz
  47 * Mathias Svensson
  48 * Matthew R Johnson
  49 * Nazar Mokrynskyi
  50 * Phillip Berndt
  51 * Rasmus Wriedt Larsen
  52 * Simon Wydooghe
  53 * Stefan Tomanek
  54 * stormc
  55 * tachylatus
  56 * Timo Bingmann
  57 * Timo Kaufmann
  58 * Tomasz Bogdal
  59 * Victor Häggqvist
  60 * Jan-Oliver Kaiser
  61
  62 ## Installation/removal
  63
  64 You can use the `autorandr.py` script as a stand-alone binary. If you'd like to
  65 install it as a system-wide application, there is a Makefile included that also
  66 places some configuration files in appropriate directories such that autorandr
  67 is invoked automatically when a monitor is connected or removed, the system
  68 wakes up from suspend, or a user logs into an X11 session. Run `make install`
  69 as root to install it.
  70
  71 If you prefer to have a system wide install managed by your package manager,
  72 you can
  73
  74 * Use the [official Arch package](https://www.archlinux.org/packages/community/any/autorandr/).
  75 * Use the [official Debian package](https://packages.debian.org/sid/x11/autorandr) on sid
  76 * Use the [ebuild from zugaina](https://gpo.zugaina.org/x11-misc/autorandr) on Gentoo.
  77 * Use the
  78   [nix package](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/autorandr.nix)
  79   on NixOS.
  80 * Use the [SlackBuild](https://slackbuilds.org/repository/14.2/desktop/autorandr/) on Slackware.
  81 * Use the automated nightlies generated by the
  82   [openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr)
  83   for various distributions (RPM and DEB based).
  84 * Use the [X binary package system](https://wiki.voidlinux.eu/XBPS)' on Void Linux
  85 * Build a .deb-file from the source tree using `make deb`.
  86 * Build a .rpm-file from the source tree using `make rpm`.
  87
  88 We appreciate packaging scripts for other distributions, please file a pull
  89 request if you write one.
  90
  91 If you prefer `pip` over your package manager, you can install autorandr with:
  92
  93     sudo pip install "git+http://github.com/phillipberndt/autorandr#egg=autorandr"
  94
  95 or simply
  96
  97     sudo pip install autorandr
  98
  99 if you prefer to use a stable version.
 100
 101 ## How to use
 102
 103 Save your current display configuration and setup with:
 104
 105     autorandr --save mobile
 106
 107 Connect an additional display, configure your setup and save it:
 108
 109     autorandr --save docked
 110
 111 Now autorandr can detect which hardware setup is active:
 112
 113     $ autorandr
 114       mobile
 115       docked (detected)
 116
 117 To automatically reload your setup:
 118
 119     $ autorandr --change
 120
 121 To manually load a profile:
 122
 123     $ autorandr --load <profile>
 124
 125 or simply:
 126
 127     $ autorandr <profile>
 128
 129 autorandr tries to avoid reloading an identical configuration. To force the
 130 (re)configuration:
 131
 132     $ autorandr --load <profile> --force
 133
 134 To prevent a profile from being loaded, place a script call _block_ in its
 135 directory. The script is evaluated before the screen setup is inspected, and
 136 in case of it returning a value of 0 the profile is skipped. This can be used
 137 to query the status of a docking station you are about to leave.
 138
 139 If no suitable profile can be identified, the current configuration is kept.
 140 To change this behaviour and switch to a fallback configuration, specify
 141 `--default <profile>`. The system-wide installation of autorandr by default
 142 calls autorandr with a parameter `--default default`. There are three special,
 143 virtual configurations called `horizontal`, `vertical` and `common`. They
 144 automatically generate a configuration that incorporates all screens
 145 connected to the computer. You can symlink `default` to one of these
 146 names in your configuration directory to have autorandr use any of them
 147 as the default configuration without you having to change the system-wide
 148 configuration.
 149
 150 You can store default values for any option in an INI-file located at
 151 `~/.config/autorandr/settings.ini`. In a `config` section, you may place any
 152 default values in the form `option-name=option-argument`.
 153
 154 A common and effective use of this is to specify default `skip-options`, for
 155 instance skipping the `gamma` setting if using
 156 [`redshift`](https://github.com/jonls/redshift) as a daemon.  To implement
 157 the equivalent of `--skip-options gamma`, your `settings.ini` file should look
 158 like this:
 159
 160 ```
 161 [config]
 162 skip-options=gamma
 163 ```
 164
 165 ## Advanced usage
 166
 167 ### Hook scripts
 168
 169 Three more scripts can be placed in the configuration directory
 170 (as defined by the [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html),
 171 usually `~/.config/autorandr` or `~/.autorandr` if you have an old installation
 172 for user configuration and `/etc/xdg/autorandr` for system wide configuration):
 173
 174 - `postswitch` is executed *after* a mode switch has taken place. This can be
 175   used to notify window managers or other applications about the switch.
 176 - `preswitch` is executed *before* a mode switch takes place.
 177 - `postsave` is executed after a profile was stored or altered.
 178 - `predetect` is executed before autorandr attempts to run xrandr.
 179
 180 These scripts must be executable and can be placed directly in the configuration
 181 directory, where they will always be executed, or in the profile subdirectories,
 182 where they will only be executed on changes regarding that specific profile.
 183
 184 Instead (or in addition) to these scripts, you can also place as many executable
 185 files as you like in subdirectories called `script_name.d` (e.g. `postswitch.d`).
 186
 187 If a script with the same name occurs multiple times, user configuration
 188 takes precedence over system configuration (as specified by the
 189 [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html))
 190 and profile configuration over general configuration.
 191
 192 As a concrete example, suppose you have the files
 193
 194 - `/etc/xdg/autorandr/postswitch`
 195 - `~/.config/autorandr/postswitch`
 196 - `~/.config/autorandr/postswitch.d/notify-herbstluftwm`
 197 - `~/.config/autorandr/docked/postswitch`
 198
 199 and switch from `mobile` to `docked`. Then
 200 `~/.config/autorandr/docked/postswitch` is executed, since the profile specific
 201 configuration takes precedence, and
 202 `~/.config/autorandr/postswitch.d/notify-herbstluftwm` is executed, since
 203 it has a unique name.
 204
 205 If you switch back from `docked` to `mobile`, `~/.config/autorandr/postswitch`
 206 is executed instead of the `docked` specific `postswitch`.
 207
 208 If you experience issues with xrandr being executed too early after connecting
 209 a new monitor, then you can use a `predetect` script to delay the execution.
 210 Write e.g. `sleep 1` into that file to make autorandr wait a second before
 211 running `xrandr`.
 212
 213 #### Variables
 214
 215 Some of autorandr's state is exposed as environment variables
 216 prefixed with `AUTORANDR_`, such as:
 217 - `AUTORANDR_CURRENT_PROFILE`
 218 - `AUTORANDR_CURRENT_PROFILES`
 219 - `AUTORANDR_PROFILE_FOLDER`
 220 - `AUTORANDR_MONITORS`
 221
 222 with the intention that they can be used within the hook scripts.
 223
 224 For instance, you might display which profile has just been activated by
 225 including the following in a `postswitch` script:
 226 ```sh
 227 notify-send -i display "Display profile" "$AUTORANDR_CURRENT_PROFILE"
 228 ```
 229
 230 The one kink is that during `preswitch`, `AUTORANDR_CURRENT_PROFILE` is
 231 reporting the *upcoming* profile rather than the *current* one.
 232
 233 ### Wildcard EDID matching
 234
 235 The EDID strings in the `~/.config/autorandr/*/setup` files may contain an
 236 asterisk to enable wildcard matching: Such EDIDs are matched against connected
 237 monitors using the usual file name globbing rules. This can be used to create
 238 profiles matching multiple (or any) monitors.
 239
 240 ### udev triggers with NVidia cards
 241
 242 In order for `udev` to detect `drm` events from the native NVidia driver, the
 243 kernel parameter `nvidia-drm.modeset` must be set to 1. For example, add a file
 244 `/etc/modprobe.d/nvidia-drm-modeset.conf`:
 245
 246 ```
 247 options nvidia_drm modeset=1
 248 ```
 249
 250 ## Changelog
 251
 252 **autorandr 1.12**
 253 * *2021-12-16* Switch default interpreter to Python 3
 254
 255 **autorandr 1.11**
 256 * *2020-05-23* Handle empty sys.executable
 257 * *2020-06-08* Fix Python 2 compatibility
 258 * *2020-10-06* Set group membership of users in batch mode
 259
 260 **autorandr 1.10.1**
 261 * *2020-05-04* Revert making the launcher the default (fixes #195)
 262
 263 **autorandr 1.10**
 264 * *2020-04-23* Fix hook script execution order to match description from readme
 265 * *2020-04-11* Handle negative gamma values (fixes #188)
 266 * *2020-04-11* Sort approximate matches in detected profiles by quality of match
 267 * *2020-01-31* Handle non-ASCII environment variables (fixes #180)
 268 * *2019-12-31* Fix output positioning if the top-left output is not the first
 269 * *2019-12-31* Accept negative gamma values (and interpret them as 0)
 270 * *2019-12-31* Prefer the X11 launcher over systemd/udev configuration
 271
 272 **autorandr 1.9**
 273
 274 * *2019-11-10* Count closed lids as disconnected outputs
 275 * *2019-10-05* Do not overwrite existing configurations without `--force`
 276 * *2019-08-16* Accept modes that don't match the WWWxHHH pattern
 277 * *2019-03-22* Improve bash autocompletion
 278 * *2019-03-21* Store CRTC values in configurations
 279 * *2019-03-24* Fix handling of recently disconnected outputs (See #128 and #143)
 280
 281 **autorandr 1.8.1**
 282
 283 * *2019-03-18* Removed mandb call from Makefile
 284
 285 **autorandr 1.8**
 286
 287 * *2019-02-17* Add an X11 daemon that runs autorandr when a display connects (by @rliou92, #127)
 288 * *2019-02-17* Replace width=0 check with disconnected to detect disconnected monitors (by @joseph-jones, #139)
 289 * *2019-02-17* Fix handling of empty padding (by @jschwab, #138)
 290 * *2019-02-17* Add a man page (by @somers-all-the-time, #133)
 291
 292 **autorandr 1.7**
 293
 294 * *2018-09-25* Fix FB size computation with rotated screens (by @Janno, #117)
 295
 296 **autorandr 1.6**
 297
 298 * *2018-04-19* Bugfix: Do not load default profile unless --change is set
 299 * *2018-04-30* Added a `AUTORANDR_MONITORS` variable to hooks (by @bricewge, #106)
 300 * *2018-06-29* Fix detection of current configuration if extra monitors are active
 301 * *2018-07-11* Bugfix in the latest change: Correctly handle "off" minitors when comparing
 302 * *2018-07-19* Do not kill spawned user processes from systemd unit
 303 * *2018-07-20* Correctly handle "off" monitors when comparing -- fixup for another bug.
 304
 305 **autorandr 1.5**
 306
 307 * *2018-01-03* Add --version
 308 * *2018-01-04* Fixed vertical/horizontal/clone-largest virtual profiles
 309 * *2018-03-07* Output all non-error messages to stdout instead of stderr
 310 * *2018-03-25* Add --detected and --current to filter the profile list output
 311 * *2018-03-25* Allow wildcard matching in EDIDs
 312
 313 **autorandr 1.4**
 314
 315 * *2017-12-22* Fixed broken virtual profile support
 316 * *2017-12-14* Added support for a settings file
 317 * *2017-12-14* Added a virtual profile `off`, which disables all screens
 318
 319 **autorandr 1.3**
 320
 321 * *2017-11-13* Add a short form for `--load`
 322 * *2017-11-21* Fix environment stealing in `--batch` mode (See #87)
 323
 324 **autorandr 1.2**
 325
 326 * *2017-07-16* Skip `--panning` unless it is required (See #72)
 327 * *2017-10-13* Add `clone-largest` virtual profile
 328
 329 **autorandr 1.1**
 330
 331 * *2017-06-07* Call systemctl with `--no-block` from udev rule (See #61)
 332 * *2017-01-20* New script hook, `predetect`
 333 * *2017-01-18* Accept comments (lines starting with `#`) in config/setup files
 334
 335 **autorandr 1.0**
 336
 337 * *2016-12-07* Tag the current code as version 1.0.0; see github issue #54
 338 * *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default