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