X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=999f353ceca200629b7ce82493925abba53bf65a;hb=c060377e8e9fd0a13e159820f9a950597fa51482;hp=bdaf638e7baeeb5e84d19fd68cdae5389b0193f7;hpb=cbb5662fe9799c90eeb67321ed77bd8b99bf376f;p=deb_pkgs%2Fautorandr.git diff --git a/README.md b/README.md index bdaf638..999f353 100644 --- a/README.md +++ b/README.md @@ -62,20 +62,22 @@ 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/). - -autorandr is also packaged in the [nix package manager](https://nixos.org/nix/) -repositories. - -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. +wakes up from suspend, or a user logs into an X11 session. Run `make install` +as root to install it. + +If you prefer to have a system wide install managed by your package manager, +you can + +* Use the [aur package](https://aur.archlinux.org/packages/autorandr-git/) on Arch +* Use the [official Debian package](https://packages.debian.org/sid/x11/autorandr) on sid +* Use the [ebuild from zugaina](https://gpo.zugaina.org/x11-misc/autorandr) on Gentoo. +* Use the + [nix package](https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/autorandr.nix) + on NixOS. +* Use the automated nightlies generated by the + [openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr) + for various distributions (RPM and DEB based). +* Build a .deb-file from the source tree using `make deb`. We appreciate packaging scripts for other distributions, please file a pull request if you write one. @@ -90,9 +92,6 @@ or simply if you prefer to use a stable version. -Automatically generated packages versions are available from the -[openSUSE build service](https://build.opensuse.org/package/show/home:phillipberndt/autorandr). - ## How to use Save your current display configuration and setup with: @@ -142,7 +141,13 @@ 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. -## Hook scripts +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. + +## Advanced usage + +### Hook scripts Three more scripts can be placed in the configuration directory (as (as defined by the [XDG spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html), @@ -191,8 +196,29 @@ a new monitor, then you can use a `predetect` script to delay the execution. Write e.g. `sleep 1` into that file to make autorandr wait a second before running `xrandr`. +### Wildcard EDID matching + +The EDID strings in the `~/.config/autorandr/*/setup` files may contain an +asterisk to enable wildcard matching: Such EDIDs are matched against connected +monitors using the usual file name globbing rules. This can be used to create +profiles matching multiple (or any) monitors. + ## Changelog +**autorandr 1.5** + +* *2018-01-03* Add --version +* *2018-01-04* Fixed vertical/horizontal/clone-largest virtual profiles +* *2018-03-07* Output all non-error messages to stdout instead of stderr +* *2018-03-25* Add --detected and --current to filter the profile list output +* *2018-03-25* Allow wildcard matching in EDIDs + +**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`