kanshi(1)

πŸ’– kanshi(1) β€” the General Commands Manual glow-up πŸ’–

okay bestie, sit down, we're talking about kanshi, and she is that girl. this is section 1 of the general commands manual, so she's a whole command, not a config file. iykyk. πŸŽ€


✨ NAME ✨

kanshi β€” dynamic output configuration. that's it, that's the whole vibe. she configures your outputs. dynamically. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

kanshi [options...]

literally just run her, optionally with some flags. simple as. ⭐


🌸 OPTIONS 🌸

  • -h, --help β€” pops up the help message and dips. the "wait what does this do" button. 🫢
  • -c, --config <config> β€” tells her exactly which config file to use, instead of letting her go find her own. picky queen behavior, we respect it. πŸ’œ
  • -l, --listen-fd <fd> β€” listen on the file descriptor you hand her, for IPC. she's on speaking terms with other processes, no cap. πŸ”₯

πŸ‘‘ DESCRIPTION πŸ‘‘

so here's the tea: kanshi is a Wayland daemon that automatically configures outputs. she just... does it. while you're living your life. main character energy, honestly. ✨

she's configured with a list of output profiles. each profile contains a set of outputs. a profile will be automatically activated if all the specified outputs are currently connected. and a profile contains configuration for each output. so it's like: profiles ➑️ sets of outputs ➑️ per-output config. nesting, but make it fashion. πŸŽ€

and here's the part where she's lowkey reactive in the best way: if kanshi receives a SIGHUP signal, she will reread her config file. like, she just refreshes herself. iconic. 🌈


🧚 CONFIGURATION 🧚

kanshi reads her configuration from $XDG_CONFIG_HOME/kanshi/config. if $XDG_CONFIG_HOME is unset, it defaults to ~/.config. so like, your home directory is doing the heavy lifting. πŸ’–

an error is raised if no configuration file is found. she's not gonna guess, bestie. no config, no service. 😭

for the info on what actually goes inside the configuration file format, go read kanshi(5). sibling lore. πŸ’œ


πŸ’œ AUTHORS πŸ’œ

maintained by Simon Ser <contact@emersion.fr>, who is assisted by other open-source contributors β€” a whole squad, fr fr. for more information about kanshi development, see <https://gitlab.freedesktop.org/emersion/kanshi>. 🫢


🌟 SEE ALSO 🌟


and that's the page, babes. this one's dated 2026-01-24 and belongs to the kanshi(1) era of the general commands manual. go configure something cute. periodt. πŸ’…βœ¨πŸŽ€

πŸ“¦ where this page comes from