X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=7268c427ae64a06918c28ad636e747429cb7a82d;hb=a8a35eb2228e8329793d3b3ea61ef7b74a0d08e2;hp=98b38731df0ca3feaa56baf64529ad57a705e619;hpb=0822f3111634fcd09c37f613a973be0e0dec4d85;p=deb_pkgs%2Fautorandr.git diff --git a/README.md b/README.md index 98b3873..7268c42 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ -# autorandr +# autorandr + Automatically select a display configuration based on connected devices ## Branch information This is a compatible Python rewrite of -[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). Contributions for bash-completion, fd.o/XDG autostart, Nitrogen, pm-utils, and systemd can be found under [contrib](contrib/). +[wertarbyte/autorandr](https://github.com/wertarbyte/autorandr). Contributions +for bash-completion, fd.o/XDG autostart, Nitrogen, pm-utils, and systemd can be +found under [contrib](contrib/). The original [wertarbyte/autorandr](https://github.com/wertarbyte/autorandr) tree is unmaintained, with lots of open pull requests and issues. I forked it @@ -22,7 +25,7 @@ If you are interested in why there are two versions around, see [#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 +if you are unhappy with this version and would like to contribute to the bash version. ## License information and authors @@ -36,6 +39,7 @@ Contributors to this version of autorandr are: * andersonjacob * Alexander Wirt * Chris Dunder +* Christoph Gysin * Daniel Hahler * Maciej Sitarz * Mathias Svensson @@ -53,6 +57,7 @@ Contributors to this version of autorandr are: * Victor Häggqvist ## 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 @@ -81,7 +86,7 @@ If you prefer `pip` over your package manager, you can install autorandr with: or simply - sudo pip install autorandr + sudo pip install autorandr if you prefer to use a stable version. @@ -104,12 +109,22 @@ Now autorandr can detect which hardware setup is active: mobile docked (detected) -To automatically reload your setup, just append `--change` to the command line +To automatically reload your setup: + + $ autorandr --change + +To manually load a profile: + + $ autorandr --load + +or simply: -To manually load a profile, you can use the `--load ` option. + $ autorandr autorandr tries to avoid reloading an identical configuration. To force the -(re)configuration, apply `--force`. +(re)configuration: + + $ autorandr --load --force To prevent a profile from being loaded, place a script call _block_ in its directory. The script is evaluated before the screen setup is inspected, and @@ -127,6 +142,10 @@ 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. +You can store default values for any option in an INI-file in +`~/.config/autorandr/settings.ini` in a section `config`. The most useful +candidate for doing that is `skip-options`, if you need it. + ## Hook scripts Three more scripts can be placed in the configuration directory (as @@ -178,6 +197,17 @@ running `xrandr`. ## Changelog +**autorandr 1.4** + +* *2017-12-22* Fixed broken virtual profile support +* *2017-12-14* Added support for a settings file +* *2017-12-14* Added a virtual profile `off`, which disables all screens + +**autorandr 1.3** + +* *2017-11-13* Add a short form for `--load` +* *2017-11-21* Fix environment stealing in `--batch` mode (See #87) + **autorandr 1.2** * *2017-07-16* Skip `--panning` unless it is required (See #72)