X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=6b90d4d0cb7c7b094b682901d5a6436314514385;hb=47b2764a9fb56b4573941901a84d606c66efd8b4;hp=3fddb457b7984ed1afe18524232f668df2329aec;hpb=8ba69c653c453a08bc12964956e73e49170ba44b;p=deb_pkgs%2Fautorandr.git diff --git a/README.md b/README.md index 3fddb45..6b90d4d 100644 --- a/README.md +++ b/README.md @@ -51,30 +51,45 @@ Contributors to this version of autorandr are: * Simon Wydooghe ## Installation/removal -For Debian-based distributives (including Ubuntu) it is recommended to call `make deb` to obtain a package that can be installed and removed with `dpkg`. +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. -On other distributives you can install autorandr by calling `make install` and remove it by calling `make uninstall`. +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`. -If you can contribute packaging script for other distributives, we will appreciate it. +On Arch Linux, there is [an aur package +available](https://aur.archlinux.org/packages/autorandr-git/). -## How to use +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. -Save your current display configuration and setup with: +We appreciate packaging scripts for other distributions, please file a pull +request if you write one. + +On any distribution with `pip` installed you can install it with: ``` -autorandr --save mobile +sudo pip install -e git+http://github.com/phillipberndt/autorandr#egg=autorandr ``` +## How to use + +Save your current display configuration and setup with: + + 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 @@ -90,7 +105,14 @@ 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 `~/.config/autorandr` (or `~/.autorandr` if you have an old installation) as @@ -106,7 +128,6 @@ the script names themselves, any executables in subdirectories named autorandr's state is exposed as environment variables prefixed with `AUTORANDR_`. The most useful one is `$AUTORANDR_CURRENT_PROFILE`. -## Apply configuration on login -With recent versions of autorandr you typically do not need to add autorandr to `~/.xprofile`, since an autostart configuration file will be installed at `/etc/xdg/autostart/autorandr.desktop` by the makefile. It will select an appropriate profile automatically. +## Changelog -If you need to customize this behaviour, you can always disable or modify it by placing an alternative desktop file with the same name in `~/.config/autostart` or by using a GUI configuration tool for autostart like `gnome-session-properties`. +* *2016-10-03* Install a desktop file to `/etc/xdg/autostart` by default