~emersion/kanshi

Dynamic display configuration
readme: finish migration to SourceHut
635d988a — Oğuz Ersen 26 days ago
man: fix wrong section headers
92a5a327 — Érico Nogueira a month ago
Add CI step to test build without varlink.

clone

read-only
https://git.sr.ht/~emersion/kanshi
read/write
git@git.sr.ht:~emersion/kanshi

You can also use your local clone with git send-email.

#kanshi

kanshi allows you to define output profiles that are automatically enabled and disabled on hotplug. For instance, this can be used to turn a laptop's internal screen off when docked.

This is a Wayland equivalent for tools like autorandr. kanshi can be used on Wayland compositors supporting the wlr-output-management protocol.

Join the IRC channel: #emersion on Libera Chat.

#Building

Dependencies:

  • wayland-client
  • scdoc (optional, for man pages)
  • libvarlink (optional, for remote control functionality)
meson build
ninja -C build

#Usage

mkdir -p ~/.config/kanshi && touch ~/.config/kanshi/config
kanshi

#Configuration file

Each output profile is delimited by brackets. It contains several output directives (whose syntax is similar to sway-output(5)). A profile will be enabled if all of the listed outputs are connected.

profile {
	output LVDS-1 disable
	output "Some Company ASDF 4242" mode 1600x900 position 0,0
}

profile {
	output LVDS-1 enable scale 2
}

#Contributing

The upstream repository can be found on SourceHut. Open tickets on the SourceHut tracker, send patches on the mailing list.

#License

MIT