X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=d08b78c4222cc4337ae24cb671ae358b13000eb3;hb=f171c8a5ad91dd586320d89c504c316d18f3d056;hp=d09b386bb355e760442b217e995c2520ae7e566d;hpb=71eab77f43c7015d5d1db5dffc576f310c86e2fe;p=deb_pkgs%2Fautorandr.git diff --git a/README.md b/README.md index d09b386..d08b78c 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,95 @@ -# autorandr - +# autorandr Automatically select a display configuration based on connected devices -Stefan Tomanek <[stefan.tomanek@wertarbyte.de](stefan.tomanek@wertarbyte.de)> +## Branch information + +This is a compatible Python rewrite of +[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). + +The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr) +tree is unmaintained, with lots of open pull requests and issues. I forked it +and merged what I thought were the most important changes. If you are searching +for that version, see the [`legacy` branch](https://github.com/phillipberndt/autorandr/tree/legacy). +Note that the Python version is better suited for non-standard configurations, +like if you use `--transform` or `--reflect`. If you use `auto-disper`, you +have to use the bash version, as there is no disper support in the Python +version (yet). Both versions use a compatible configuration file format, so +you can, to some extent, switch between them. I will maintain the `legacy` +branch until @wertarbyte finds the time to maintain his branch again. + +If you are interested in why there are two versions around, see +[#7](https://github.com/phillipberndt/autorandr/issues/7), +[#8](https://github.com/phillipberndt/autorandr/issues/8) and +especially +[#12](https://github.com/phillipberndt/autorandr/issues/12) +if you are unhappy with this version and would like to contibute to the bash +version. + +## License information and authors + +autorandr is available under the terms of the GNU General Public License +(version 3). + +Contributors to this version of autorandr are: + +* Alexander Wirt +* Chris Dunder +* Daniel Hahler +* Maciej Sitarz +* Mathias Svensson +* Matthew R Johnson +* Nazar Mokrynskyi +* Phillip Berndt +* Rasmus Wriedt Larsen +* Stefan Tomanek +* Timo Bingmann +* Tomasz Bogdal +* Victor Häggqvist +* stormc +* tachylatus +* andersonjacob +* Simon Wydooghe + +## Installation/removal +You can use the `autorandr.py` script as a stand-alone binary. If you'd like to +install it as a system-wide application, there is a Makefile included that also +places some configuration files in appropriate directories such that autorandr +is invoked automatically when a monitor is connected or removed, the system +wakes up from suspend, or a user logs into an X11 session. + +For Debian-based distributions (including Ubuntu) it is recommended to call +`make deb` to obtain a package that can be installed and removed with `dpkg`. + +On Arch Linux, there is [an aur package +available](https://aur.archlinux.org/packages/autorandr-git/). + +On other distributions you can install autorandr by calling `make install` and +remove it by calling `make uninstall`. Run `make` without arguments to obtain a +list of what exactly will be installed. + +We appreciate packaging scripts for other distributions, please file a pull +request if you write one. + +If you prefer `pip` over your package manager, you can install autorandr with: + + sudo pip install "git+http://github.com/phillipberndt/autorandr#egg=autorandr" + ## How to use Save your current display configuration and setup with: -``` -autorandr --save mobile -``` + + autorandr --save mobile Connect an additional display, configure your setup and save it: -``` -autorandr --save docked -``` + + autorandr --save docked Now autorandr can detect which hardware setup is active: -``` - $ autorandr - mobile - docked (detected) -``` + + $ autorandr + mobile + docked (detected) To automatically reload your setup, just append `--change` to the command line @@ -37,16 +105,40 @@ to query the status of a docking station you are about to leave. If no suitable profile can be identified, the current configuration is kept. To change this behaviour and switch to a fallback configuration, specify -`--default `. +`--default `. The system-wide installation of autorandr by default +calls autorandr with a parameter `--default default`. There are three special, +virtual configurations called `horizontal`, `vertical` and `common`. They +automatically generate a configuration that incorporates all screens +connected to the computer. You can symlink `default` to one of these +names in your configuration directory to have autorandr use any of them +as the default configuration without you having to change the system-wide +configuration. Another script called `postswitch` can be placed in the directory -`~/.autorandr` as well as in all profile directories: The scripts are executed -after a mode switch has taken place and can notify window managers or other -applications about it. +`~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as +well as in all profile directories: The scripts are executed after a mode +switch has taken place and can notify window managers or other applications +about it. The same holds for `preswitch`, which is executed before the switch +takes place, and `postsave`, which is executed after a profile was +stored/altered. + +If you experience issues with xrandr being executed too early after connecting +a new monitor, then you can create a script `predetect`, which will be executed +before autorandr attempts to run xrandr. Place e.g. `sleep 1` into that file +to make autorandr wait a second before running xrandr. + +All scripts can also be placed in any of the `$XDG_CONFIG_DIRS`. In addition to +the script names themselves, any executables in subdirectories named +`script_name.d` (e.g. `postswitch.d`) are executed as well. In scripts, some of +autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`. +The most useful one is `$AUTORANDR_CURRENT_PROFILE`. + +## Changelog + +* *2017-01-18* Accept comments (lines starting with `#`) in config/setup files +* *2017-01-20* New script hook, `predetect` +**autorandr 1.0** -While the script uses xrandr by default, calling it by the name `autodisper` -or `auto-disper` forces it to use the [disper](http://willem.engen.nl/projects/disper/) -utility, which is useful for controlling nvidia chipsets. The formats for -fingerprinting the current setup and saving/loading the current configuration -are adjusted accordingly. +* *2016-12-07* Tag the current code as version 1.0.0; see github issue #54 +* *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default