Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make the README nicer and more readable #19

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Make the README nicer and more readable #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3401494
Rename README -> README.md. Use markdown for README.md.
mtahmed May 12, 2013
71eab77
Make the README.md a bit cleaner.
mtahmed May 12, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions README → README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
Tool: "autorandr"
# autorandr

Automatically select a display configuration based on connected devices

Stefan Tomanek <[email protected]>
Stefan Tomanek <[[email protected]]([email protected])>

How to use:
## 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)
```

To automatically reload your setup, just append --change to the command line
To automatically reload your setup, just append `--change` to the command line

To manually load a profile, you can use the --load <profile> option.
To manually load a profile, you can use the `--load <profile>` option.

autorandr tries to avoid reloading an identical configuration. To force the
(re)configuration, apply --force.
(re)configuration, apply `--force`.

To prevent a profile from being loaded, place a script call "block" in its
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
in case of it returning a value of 0 the profile is skipped. This can be used
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 <profile>
`--default <profile>`.

Another script called "postswitch "can be placed in the directory
~/.autorandr as well as in all profile directories: The scripts are executed
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.


While the script uses xrandr by default, calling it by the name "autodisper"
or "auto-disper" forces it to use the "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.

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.