README.md

   1 # autorandr
   2 Automatically select a display configuration based on connected devices
   3
   4 ## Branch information
   5
   6 This is a compatible Python rewrite of
   7 [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr).
   8
   9 The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr)
  10 tree is unmaintained, with lots of open pull requests and issues. I forked it
  11 and merged what I thought were the most important changes. If you are searching
  12 for that version, see the [`legacy` branch](https://github.com/phillipberndt/autorandr/tree/legacy).
  13 Note that the Python version is better suited for non-standard configurations,
  14 like if you use `--transform` or `--reflect`. If you use `auto-disper`, you
  15 have to use the bash version, as there is no disper support in the Python
  16 version (yet). Both versions use a compatible configuration file format, so
  17 you can, to some extent, switch between them.  I will maintain the `legacy`
  18 branch until @wertarbyte finds the time to maintain his branch again.
  19
  20 If you are interested in why there are two versions around, see
  21 [#7](https://github.com/phillipberndt/autorandr/issues/7),
  22 [#8](https://github.com/phillipberndt/autorandr/issues/8) and
  23 especially
  24 [#12](https://github.com/phillipberndt/autorandr/issues/12)
  25 if you are unhappy with this version and would like to contibute to the bash
  26 version.
  27
  28 ## License information and authors
  29
  30 autorandr is available under the terms of the GNU General Public License
  31 (version 3).
  32
  33 Contributors to this version of autorandr are:
  34
  35 * Alexander Wirt
  36 * Chris Dunder
  37 * Daniel Hahler
  38 * Maciej Sitarz
  39 * Mathias Svensson
  40 * Matthew R Johnson
  41 * Nazar Mokrynskyi
  42 * Phillip Berndt
  43 * Rasmus Wriedt Larsen
  44 * Stefan Tomanek
  45 * Timo Bingmann
  46 * Tomasz Bogdal
  47 * Victor Häggqvist
  48 * stormc
  49 * tachylatus
  50 * andersonjacob
  51 * Simon Wydooghe
  52
  53 ## Installation/removal
  54 You can use the `autorandr.py` script as a stand-alone binary. If you'd like to
  55 install it as a system-wide application, there is a Makefile included that also
  56 places some configuration files in appropriate directories such that autorandr
  57 is invoked automatically when a monitor is connected or removed, the system
  58 wakes up from suspend, or a user logs into an X11 session.
  59
  60 For Debian-based distributions (including Ubuntu) it is recommended to call
  61 `make deb` to obtain a package that can be installed and removed with `dpkg`.
  62
  63 On Arch Linux, there is [an aur package
  64 available](https://aur.archlinux.org/packages/autorandr-git/).
  65
  66 On other distributions you can install autorandr by calling `make install` and
  67 remove it by calling `make uninstall`. Run `make` without arguments to obtain a
  68 list of what exactly will be installed.
  69
  70 We appreciate packaging scripts for other distributions, please file a pull
  71 request if you write one.
  72
  73 If you prefer `pip` over your package manager, you can install autorandr with:
  74
  75     sudo pip install "git+http://github.com/phillipberndt/autorandr#egg=autorandr"
  76
  77 Automatically generated packages versions are available from the
  78 [openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr).
  79
  80 ## How to use
  81
  82 Save your current display configuration and setup with:
  83
  84     autorandr --save mobile
  85
  86 Connect an additional display, configure your setup and save it:
  87
  88     autorandr --save docked
  89
  90 Now autorandr can detect which hardware setup is active:
  91
  92     $ autorandr
  93       mobile
  94       docked (detected)
  95
  96 To automatically reload your setup, just append `--change` to the command line
  97
  98 To manually load a profile, you can use the `--load <profile>` option.
  99
 100 autorandr tries to avoid reloading an identical configuration. To force the
 101 (re)configuration, apply `--force`.
 102
 103 To prevent a profile from being loaded, place a script call _block_ in its
 104 directory. The script is evaluated before the screen setup is inspected, and
 105 in case of it returning a value of 0 the profile is skipped. This can be used
 106 to query the status of a docking station you are about to leave.
 107
 108 If no suitable profile can be identified, the current configuration is kept.
 109 To change this behaviour and switch to a fallback configuration, specify
 110 `--default <profile>`. The system-wide installation of autorandr by default
 111 calls autorandr with a parameter `--default default`. There are three special,
 112 virtual configurations called `horizontal`, `vertical` and `common`. They
 113 automatically generate a configuration that incorporates all screens
 114 connected to the computer. You can symlink `default` to one of these
 115 names in your configuration directory to have autorandr use any of them
 116 as the default configuration without you having to change the system-wide
 117 configuration.
 118
 119 Another script called `postswitch` can be placed in the directory
 120 `~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as
 121 well as in all profile directories: The scripts are executed after a mode
 122 switch has taken place and can notify window managers or other applications
 123 about it. The same holds for `preswitch`, which is executed before the switch
 124 takes place, and `postsave`, which is executed after a profile was
 125 stored/altered.
 126
 127 If you experience issues with xrandr being executed too early after connecting
 128 a new monitor, then you can create a script `predetect`, which will be executed
 129 before autorandr attempts to run xrandr. Place e.g. `sleep 1` into that file
 130 to make autorandr wait a second before running xrandr.
 131
 132 All scripts can also be placed in any of the `$XDG_CONFIG_DIRS`. In addition to
 133 the script names themselves, any executables in subdirectories named
 134 `script_name.d` (e.g. `postswitch.d`) are executed as well. In scripts, some of
 135 autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`.
 136 The most useful one is `$AUTORANDR_CURRENT_PROFILE`.
 137
 138 ## Changelog
 139
 140 **autorandr 1.1**
 141
 142 * *2017-06-07* Call systemctl with `--no-block` from udev rule (See #61)
 143 * *2017-01-20* New script hook, `predetect`
 144 * *2017-01-18* Accept comments (lines starting with `#`) in config/setup files
 145
 146 **autorandr 1.0**
 147
 148 * *2016-12-07* Tag the current code as version 1.0.0; see github issue #54
 149 * *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default